wycheproof/doc/types.md

Test vector types

Version: 0.7

AeadTestGroup

A test group for authenticated encryption with additional data.

Fields in AeadTestGroup are:

name	type	desc	enum
ivSize	int	The IV size in bits. All IV

: : : sizes are multiple of 8 : :

 :                        : bits.                       :            :

| keySize | int | the keySize in bits | |

| tagSize | int | The expected size of the | |

 :                        : tag in bits. This is the    :            :

 :                        : size that should be used to :            :

 :                        : initialize instance of the  :            :

 :                        : cipher. The actual tag in   :            :

 :                        : the test vector may have a  :            :

 :                        : different size. Such a test :            :

 :                        : vector is always invalid    :            :

 :                        : and an implementation is    :            :

 :                        : expected to reject such     :            :

 :                        : tags. All tag sizes are     :            :

 :                        : multiples of 8 bits.        :            :

| type | str | the type of the test | 'AeadTest' | | tests | List of AeadTestVector | a list of test vectors | |

AeadTestVector

A test vector for authenticated encryption with additional data.

Fields additional to the fields in TestVector are:

name	type	desc
key	HexBytes	the key
iv	HexBytes	the nonce
aad	HexBytes	additional authenticated data
msg	HexBytes	the plaintext
ct	HexBytes	the ciphertext (without iv and tag)
tag	HexBytes	The authenticatian tag. Most encryption append the tag

: : : to the ciphertext. Encryption results in the :

 :          : concatenation ct || tag and decryption expects ct ||   :

 :          : tag as input. There are however some exceptions. For   :

 :          : example AEAD-AES-SIV-CMAC (RFC 5297) computes a        :

 :          : synthetic IV (SIV), which is used to initialize the    :

 :          : counter for AES. The typical encoding here is to       :

 :          : prepend the SIV. I.e. implementations would expect     :

 :          : ciphertext of the form tag || ct or iv || tag || ct.   :

Used in AeadTestGroup.

AsnSignatureTestVector

A test vector with an ASN.1 encoded public key signature. For example, ECDSA and DSA signatures are a pair of integers (r,s). These integers can be encoded in different ways. A popular encoding is to represent the integers as an ASN Sequence. The expectation is that any library generates only DER encoded signatures. Some libraries are also strict in the sense that only DER encoded signautes are accepted. Other libraries accept some signatures where the pair (r,s) uses an alternative BER encoding assuming of course that the encoded (r,s) is valid.

Fields additional to the fields in TestVector are:

name	type	desc
msg	HexBytes	The message to sign
sig	Asn	An ASN encoded signature for msg

Used in DsaTestGroup, EcdsaTestGroup.

DaeadTestGroup

Fields in DaeadTestGroup are:

name	type	desc	enum
keySize	int	the keySize in bits
type	str	the type of the test	'DaeadTest'
tests	List of DaeadTestVector	a list of test vectors

DaeadTestVector

A test vector used for authenticated deterministic encryption with additional data.

Fields additional to the fields in TestVector are:

name	type	desc
key	HexBytes	the key
aad	HexBytes	additional authenticated data
msg	HexBytes	the plaintext
ct	HexBytes	the ciphertext including tag

Used in DaeadTestGroup.

DsaPrivateKey

A DSA private key. This implementation of DSA must only be used for testing rsp. for generating test vectors. It has not been checked for flaws and in some cases may even avoid necessary checks so that it can be used for flawed test vectors.

name	type	desc	enum
g	BigInt	the generator of the multiplicative

: : : subgroup : : | keySize | int | the key size in bits | | | p | BigInt | the modulus p | | | q | BigInt | the order of the generator g | | | type | str | the key type | 'DsaPrivateKey' | | x | BigInt | the private key value | | | y | BigInt | the public key value | |

DsaPublicKey

The public key for DSA.

name	type	desc	enum
g	BigInt	the generator of the multiplicative

: : : subgroup : : | keySize | int | the key size in bits | | | p | BigInt | the modulus p | | | q | BigInt | the order of the generator g | | | type | str | the key type | 'DsaPublicKey' | | y | BigInt | the public key value | |

DsaTestGroup

Fields in DsaTestGroup are:

name	type	desc	enum
key	DsaPublicKey	unenocded DSA public key
keyDer	Der	DER encoded public key
keyPem	Pem	Pem encoded public key
sha	str	the hash function used for

: : : DSA : :

| type | str | the type of the test | 'DsaVerify' |

| tests | List of | a list of test vectors | |

 : AsnSignatureTestVector :                            :             :

EcPointTestGroup

Fields in EcPointTestGroup are:

name	type	desc	enum
curve	str	the name of the

: : : elliptic curve : :

| encoding | str | the encoding used | 'compressed', |

 :                   :                      : 'uncompressed' :

| type | str | the type of the test | 'EcPointTest' |

| tests | List of | a list of test | |

 : EcPointTestVector : vectors              :                :

EcPointTestVector

Fields additional to the fields in TestVector are:

name	type	desc
encoded	HexBytes	X509 encoded point on the curve
x	BigInt	x-coordinate of the point
y	BigInt	y-coordiante of the point

Used in EcPointTestGroup.

EcPublicKey

An EC public key. The EC public key can specify the underlying curve parameters in two ways. (1) as a named curve (2) as a structure containing the curve parameters generator, order and cofactor.

name	type	desc	enum
curve	typing.Union[ecutil.EcUnnamedGroup, ecutil.EcNamedGroup]	the EC group used by this public key
keySize	int	the key size in bits
type	str	the key type	'EcPublicKey'
uncompressed	HexBytes	X509 encoded public key point in hexadecimal format
wx	BigInt	the x-coordinate of the public key point
wy	BigInt	the y-coordinate of the public key point

EcPublicKeyOnNamedCurve

An EC public key. This data type allows only named curves to specify the underlying EC parameters.

name	type	desc	enum
curve	EcNamedGroup	the EC group used by this

: : : public key : :

| keySize | int | the key size in bits | |

| type | str | the key type | 'EcPublicKey' |

| uncompressed | HexBytes | X509 encoded public key point | |

     :              : in hexadecimal format          :               :

| wx | BigInt | the x-coordinate of the public | |

     :              : key point                      :               :

| wy | BigInt | the y-coordinate of the public | |

     :              : key point                      :               :

EcPublicKeyTestGroup

Fields in EcPublicKeyTestGroup are:

name	type	desc	enum
encoding	str	the encoding of the	'asn', 'pem',

: : : encoded keys : 'webcrypto' :

| type | str | the type of the | 'EcPublicKeyVerify' |

 :                       : test                :                     :

| tests | List of | a list of test | |

 : EcPublicKeyTestVector : vectors             :                     :

EcPublicKeyTestVector

Draft version for test vectors that test importing of EC public keys. The test vectors contain modified EC public keys. The goal of the test is to recognize if importing the EC public keys notices inconsistencies and bad formatting.

Fields additional to the fields in TestVector are:

name	type	desc
encoded	Asn	Encoded EC public key over a prime order field
p	BigInt	The order of underlying field
n	BigInt	The order of the generator
a	BigInt	The value a of the Weierstrass equation
b	BigInt	The value b of the Weierstrass equation
gx	BigInt	x-coordinate of the generator
gy	BigInt	y-coordinate of the generator
h	int	[optional] the cofactor
wx	BigInt	x-coordinate of the public point
wy	BigInt	y-coordinate of the public point

Used in EcPublicKeyTestGroup.

EcUnnamedGroup

An unamed EC group

name	type	desc	enum
a	BigInt	coefficient a of the elliptic

: : : curve equation : :

| b | BigInt | coefficient b of the elliptic | |

 :          : curve equation                    :                   :

| gx | BigInt | the x-coordinate of the generator | |

| gy | BigInt | the y-coordinate of the generator | |

| h | int | the cofactor | |

| n | BigInt | the order of the generator | |

| p | BigInt | the order of the underlying field | |

| type | str | an unnamed EC group over a prime | 'PrimeOrderCurve' |

 :          : field in Weierstrass form         :                   :

EcdhEcpointTestGroup

Fields in EcdhEcpointTestGroup are:

name	type	desc	enum
curve	str	the curve of the

: : : private key : :

| encoding | str | the encoding of the | 'ecpoint' |

 :                       : public key           :                   :

| type | str | the type of the test | 'EcdhEcpointTest' |

| tests | List of | a list of test | |

 : EcdhEcpointTestVector : vectors              :                   :

EcdhEcpointTestVector

Fields additional to the fields in TestVector are:

name	type	desc	format	ref
public	Asn	ASN encoded public	OCTET STRING	X9.62, Section

: : : point : : 4.3.6 :

| private | BigInt | The private | | |

 :          : exponent           :              :                :

| shared | HexBytes | The shared secret | | |

 :          : key                :              :                :

Used in EcdhEcpointTestGroup.

EcdhPemTestGroup

Fields in EcdhPemTestGroup are:

name	type	desc	enum
curve	str	the curve of the private key
encoding	str	the encoding of the public	'pem'

: : : key : :

| type | str | the type of the test | 'EcdhPemTest' |

| tests | List of | a list of test vectors | |

 : EcdhPemTestVector :                              :               :

EcdhPemTestVector

Fields additional to the fields in TestVector are:

name	type	desc
public	Pem	Pem encoded public key
private	BigInt	the private key
shared	HexBytes	The shared secret key

Used in EcdhPemTestGroup.

EcdhTestGroup

Fields in EcdhTestGroup are:

name	type	desc	enum
curve	str	the curve of the private key
encoding	str	the encoding of the public key	'asn'
type	str	the type of the test	'EcdhTest'
tests	List of EcdhTestVector	a list of test vectors

EcdhTestVector

Fields additional to the fields in TestVector are:

name	type	desc
public	Asn	X509 encoded public key. The encoding of the public

: : : key contains the type of the public key, the curve and :

 :          : possibly the curve parameters. The test vectors        :

 :          : contain cases where these fields do not match the      :

 :          : curve in the testGroup.                                :

| private | BigInt | the private key |

| shared | HexBytes | The shared secret key. Some invalid test vectors |

 :          : contain a shared secret, which is computed using the   :

 :          : curve of the private key. This allows to distinguish   :

 :          : between implementations ignoring public key info and   :

 :          : implementations using the curve of the public key.     :

Used in EcdhTestGroup.

EcdhWebcryptoTestGroup

Fields in EcdhWebcryptoTestGroup are:

name	type	desc	enum
curve	str	the curve of the

: : : private key : :

| encoding | str | the encoding of | 'webcrypto' |

 :                         : the public key   :                     :

| type | str | the type of the | 'EcdhWebcryptoTest' |

 :                         : test             :                     :

| tests | List of | a list of test | |

 : EcdhWebcryptoTestVector : vectors          :                     :

EcdhWebcryptoTestVector

Fields additional to the fields in TestVector are:

name	type	desc
public	Json	Public key in webcrypto format
private	Json	Private key in webcrypto format
shared	HexBytes	The shared secret key

Used in EcdhWebcryptoTestGroup.

EcdsaP1363TestGroup

A test group for ECDSA signatures using IEEE P1363 encoding. The test vectors in this group are meant for signature verification. The test group contains the same public key for the signatures in multiple representations. The public keys are valid with the sole exception that they may use short keys and weak hash functions such as SHA-1.

Fields in EcdsaP1363TestGroup are:

name	type	desc	enum
jwk	Json	[optional] the public

: : : key in webcrypto : :

 :                     : format                 :                    :

| key | EcPublicKey | unenocded EC public | |

 :                     : key                    :                    :

| keyDer | Der | DER encoded public key | |

| keyPem | Pem | Pem encoded public key | |

| sha | str | the hash function used | |

 :                     : for ECDSA              :                    :

| type | str | the type of the test | 'EcdsaP1363Verify' |

| tests | List of | a list of test vectors | |

 : SignatureTestVector :                        :                    :

EcdsaTestGroup

A test group for ECDSA signatures. The test vectors in this group are meant for signature verification. The test group contains the same public key for the signatures in multiple representations. The public keys are valid with the sole exception that they may use short keys and weak hash functions such as SHA-1.

Fields in EcdsaTestGroup are:

name	type	desc	enum
key	EcPublicKey	unenocded EC public key
keyDer	Der	DER encoded public key
keyPem	Pem	Pem encoded public key
sha	str	the hash function used

: : : for ECDSA : :

| type | str | the type of the test | 'EcdsaVerify' |

| tests | List of | a list of test vectors | |

 : AsnSignatureTestVector :                         :               :

EddsaTestGroup

Fields in EddsaTestGroup are:

name	type	desc	since	ref	enum
jwk	Json	the private key in webcrypto format	0.7	RFC 8037 Section 2
key	Json	unencoded key pair
keyDer	Asn	Asn encoded public key
keyPem	Pem	Pem encoded public key
type	str	the type of the test			'EddsaVerify'
tests	List of SignatureTestVector	a list of test vectors

HkdfTestGroup

A test group for key derivation functions that take 4 arguments (ikm, salt, info, size) as input.

Fields in HkdfTestGroup are:

name	type	desc	enum
keySize	int	the size of the ikm in bits
type	str	the type of the test	'HkdfTest'
tests	List of HkdfTestVector	a list of test vectors

HkdfTestVector

A test vector for HKDF (or any other key derivation function with input ikm, salt, info, size

Fields additional to the fields in TestVector are:

name	type	desc
ikm	HexBytes	the key (input key material)
salt	HexBytes	the salt for the key derivation
info	HexBytes	additional information used in the key derivation
size	int	the size of the output in bytes
okm	HexBytes	the generated bytes (output key material)

Used in HkdfTestGroup.

IndCpaTestGroup

Fields in IndCpaTestGroup are:

name	type	desc	enum
ivSize	int	the IV size in bits
keySize	int	the keySize in bits
tagSize	int	the expected size of the tag in

: : : bits : :

| type | str | the type of the test | 'IndCpaTest' |

| tests | List of | a list of test vectors | |

 : IndCpaTestVector :                                 :              :

IndCpaTestVector

A test vector that is used for symmetric primitives that are indistinguishable under chosen plaintext attacks. These primitives are without an integrity check and hence without additional authenticated data. For example AES using cipher block chaining (CBC) is tested using this format.

Fields additional to the fields in TestVector are:

name	type	desc
key	HexBytes	the key
iv	HexBytes	the initialization vector
msg	HexBytes	the plaintext
ct	HexBytes	the raw ciphertext (without IV)

Used in IndCpaTestGroup.

KeywrapTestGroup

Fields in KeywrapTestGroup are:

name	type	desc	enum
keySize	int	the keySize in bits
type	str	the type of the test	'KeywrapTest'
tests	List of KeywrapTestVector	a list of test vectors

KeywrapTestVector

A test vector for key wrap primitives. Key wrap primitives are typically symmetric encryptions that were specifically desigend for encrypting key material. In some cases the input size is restricted to typical key sizes e.g. a multiple of 8 bytes. The encryption may assume that the wrapped bytes have high entropy. Hence some of the key wrap primitives are deterministic.

Fields additional to the fields in TestVector are:

name	type	desc
key	HexBytes	the wrapping key
msg	HexBytes	the key bytes to wrap
ct	HexBytes	the wrapped key

Used in KeywrapTestGroup.

MacTestGroup

Fields in MacTestGroup are:

name	type	desc	enum
keySize	int	the keySize in bits
tagSize	int	the expected size of the tag

: : : in bits : : | type | str | the type of the test | 'MacTest' | | tests | List of MacTestVector | a list of test vectors | |

MacTestVector

A test vector for message authentication codes (MAC).

Fields additional to the fields in TestVector are:

name	type	desc
key	HexBytes	the key
msg	HexBytes	the plaintext
tag	HexBytes	the authentication tag

Used in MacTestGroup.

RsaKeyTestGroup

Fields in RsaKeyTestGroup are:

name	type	desc	enum
encoding	str	The encoding of the public key	'asn', 'pem'

: : : in the test vectors. asn : :

 :                  : implies PKCS8 encoded public    :              :

 :                  : keys. pem implies a PEM encoded :              :

 :                  : public key (compatible with     :              :

 :                  : OpenSSL.                        :              :

| private | Json | the private key | |

| type | str | the type of the test | 'RsaKeyTest' |

| tests | List of | a list of test vectors | |

 : RsaKeyTestVector :                                 :              :

RsaKeyTestVector

Fields additional to the fields in TestVector are:

name	type	desc
public	HexBytes	the encoded public key

Used in RsaKeyTestGroup.

RsaesOaepTestGroup

Fields in RsaesOaepTestGroup are:

name	type	desc	enum
d	BigInt	The private

: : : exponent : :

| e | BigInt | The public | |

        :                     : exponent        :                    :

| mgf | str | the message | |

        :                     : generating      :                    :

        :                     : function (e.g.  :                    :

        :                     : MGF1)           :                    :

| mgfSha | str | The hash | |

        :                     : function used   :                    :

        :                     : for the message :                    :

        :                     : generating      :                    :

        :                     : function.       :                    :

| n | BigInt | The modulus of | |

        :                     : the key         :                    :

| privateKeyPem | Pem | Pem encoded | |

        :                     : private key     :                    :

| privateKeyPkcs8 | Der | Pkcs 8 encoded | |

        :                     : private key.    :                    :

| sha | str | The hash | |

        :                     : function for    :                    :

        :                     : hashing the     :                    :

        :                     : label.          :                    :

| type | str | the type of the | 'RsaesOaepDecrypt' |

        :                     : test            :                    :

| tests | List of | a list of test | |

        : RsaesOaepTestVector : vectors         :                    :

RsaesOaepTestVector

Fields additional to the fields in TestVector are:

name	type	desc
msg	HexBytes	The encrypted message
ct	HexBytes	An encryption of msg
label	HexBytes	The label used for the encryption

Used in RsaesOaepTestGroup.

RsassaPkcs1GenTestGroup

Fields in RsassaPkcs1GenTestGroup are:

name	type	desc	ref	since	enum
d	BigInt	The private exponent
e	BigInt	The public exponent
keyAsn	Der	DER encoding of the sequence [n, e]
keyDer	Der	DER encoding of the public key
keyJwk	Json	[Optional] Private key in JWK format	RFC 7517	0.7
keyPem	Pem	Pem encoded public key
keySize	int	the size of the modulus in bits
n	BigInt	The modulus of the key
privateKeyDer	Der	DER encoding of the private key
privateKeyJwk	Json	[Optional] Private key in JWK format	RFC 7517	0.7
privateKeyPem	Pem	Pem encoded private key
sha	str	the hash function used for the message
type	str	the type of the test			'RsassaPkcs1Generate'
tests	List of SignatureTestVector	a list of test vectors

RsassaPkcs1TestGroup

Fields in RsassaPkcs1TestGroup are:

name	type	desc	ref	since	enum
d	BigInt	The private exponent
e	BigInt	The public exponent
keyAsn	Der	ASN encoding of the sequence [n, e]
keyDer	Der	ASN encoding of the public key
keyJwk	Json	The public key in JWK format. The key is missing if the signature algorithm for the given hash is not defined.	RFC 7517	0.7
keyPem	Pem	Pem encoded public key
keySize	int	the size of the modulus in bits
n	BigInt	The modulus of the key
sha	str	the hash function used for the message
type	str	the type of the test			'RsassaPkcs1Verify'
tests	List of SignatureTestVector	a list of test vectors

RsassaPssTestGroup

Fields in RsassaPssTestGroup are:

name	type	desc	enum
d	BigInt	The private exponent
e	BigInt	The public exponent
keyAsn	Der	ASN encoding of the

: : : sequence [n, e] : :

| keyDer | Der | ASN encoding of the | |

 :                     : public key              :                   :

| keyPem | Pem | Pem encoded public key | |

| keySize | int | the size of the modulus | |

 :                     : in bits                 :                   :

| mgf | str | the message generating | |

 :                     : function (e.g. MGF1)    :                   :

| mgfSha | str | The hash function used | |

 :                     : for the message         :                   :

 :                     : generating function.    :                   :

| n | BigInt | The modulus of the key | |

| sha | str | The hash function for | |

 :                     : hasing the message.     :                   :

| type | str | the type of the test | 'RsassaPssVerify' |

| tests | List of | a list of test vectors | |

 : RsassaPssTestVector :                         :                   :

RsassaPssTestVector

Fields additional to the fields in TestVector are:

name	type	desc
msg	HexBytes	The message to sign
sig	HexBytes	a signature for msg

Used in RsassaPssTestGroup.

SignatureTestVector

A test vector with a public key signature. This structure is used for public key signatures where the primitive specifies the encoding as an array of bytes (e.g. P1363 encoded ECDSA signatures.) Public key signatures with additional formatting (e.g. ASN.1 encoded ECDSA signatures) have their separate types.

Fields additional to the fields in TestVector are:

name	type	desc
msg	HexBytes	The message to sign
sig	HexBytes	A signature for msg

Used in EcdsaP1363TestGroup, EddsaTestGroup, RsassaPkcs1GenTestGroup, RsassaPkcs1TestGroup.

Test

The root type of each JSON file with tests. Each file contains one ore more test groups. Each test group contains one ore more test vectors. All test vectors in the same file have the same type and test the same cryptographic primitive.

name	type	desc	since
algorithm	str	The primitive

: : : tested in the test : :

         :          : file. This is       :           :

         :          : mainly a brief      :           :

         :          : description of the  :           :

         :          : algorithm used. So  :           :

         :          : far there is no     :           :

         :          : formal definition   :           :

         :          : of this field and   :           :

         :          : its description may :           :

         :          : change.             :           :

| generatorVersion | str | The version of the | |

         :          : test vectors. The   :           :

         :          : version number has  :           :

         :          : the format          :           :

         :          : major.minor (or     :           :

         :          : major.minor[release :           :

         :          : candidate]). The    :           :

         :          : plan is to change   :           :

         :          : the format of the   :           :

         :          : test vectors in     :           :

         :          : major versions      :           :

         :          : only, once version  :           :

         :          : 1.0 has been        :           :

         :          : reached.            :           :

         :          : Conversely, version :           :

         :          : 1.0 will be         :           :

         :          : published once we   :           :

         :          : think the format    :           :

         :          : for the test        :           :

         :          : vectors are         :           :

         :          : sufficiently        :           :

         :          : stable.             :           :

| header | List | additional | |

         :          : documentation       :           :

| notes | JSON | A description of | |

         :          : the labels used in  :           :

         :          : the test vectors.   :           :

         :          : Some test vectors   :           :

         :          : contain labels that :           :

         :          : formally describe   :           :

         :          : the test vector. It :           :

         :          : can be helpful to   :           :

         :          : make test more      :           :

         :          : precise. For        :           :

         :          : example libraries   :           :

         :          : differ in whether   :           :

         :          : they accept ASN     :           :

         :          : encodings different :           :

         :          : from DER. Hence     :           :

         :          : many of the test    :           :

         :          : vectors with        :           :

         :          : alternative BER     :           :

         :          : encoding are rated  :           :

         :          : as acceptable.      :           :

         :          : Labels allow to     :           :

         :          : decide whether      :           :

         :          : tests with          :           :

         :          : alternatve BER      :           :

         :          : encoding should be  :           :

         :          : rejected or         :           :

         :          : accepted when       :           :

         :          : testing a           :           :

         :          : particular library. :           :

| numberOfTests | int | The number of test | |

         :          : vectors in this     :           :

         :          : test. Each test     :           :

         :          : vector has a unique :           :

         :          : tcId in the range 1 :           :

         :          : .. tcId.            :           :

| schema | str | The filename of the | 0.7 |

         :          : JSON schema that    :           :

         :          : defines the format  :           :

         :          : of the test vectors :           :

         :          : in this file. If    :           :

         :          : the format of the   :           :

         :          : test vectors        :           :

         :          : changes then a new  :           :

         :          : schema will be      :           :

         :          : generate, so that   :           :

         :          : comparing the name  :           :

         :          : of the schema with  :           :

         :          : an expected name    :           :

         :          : can be used to      :           :

         :          : check for           :           :

         :          : compatibility       :           :

         :          : between test        :           :

         :          : vectors and test    :           :

         :          : code.               :           :

| testGroups | List | a list of test | |

         :          : groups              :           :

TestGroup

A test group contains a list of test vectors of the same type. The test group describes parameters that are common for all the test vectors. Often some parameters are given in multiple formats to simplify testing. For example, asymmetric private key are typically given in a raw format, PKCS #8 encoded and in PEM format. All fields in a test group are corretly formatted. Incorrectly formatted inputs are always in the test vectors. The list below describes the fields that are common to all test groups.

Fields in TestGroup are:

name	type	desc
tests	List	a list of test vectors
type	str	the type of the test

TestVector

name	type	desc	enum
comment	str	A brief description of

: : : the test case : :

| flags | List | A list of flags for a | |

 :          : test case. Flags are      :                     :

 :          : described in the header   :                     :

 :          : of the test file.         :                     :

| result | str | The test result. The | 'valid', 'invalid', |

 :          : value determines whether  : 'acceptable'        :

 :          : the test case is valid,   :                     :

 :          : invalid or undefined. The :                     :

 :          : value "acceptable" is     :                     :

 :          : typically used for legacy :                     :

 :          : cases, weak parameters    :                     :

 :          : (such as key sizes not    :                     :

 :          : reaching 112-bit          :                     :

 :          : security) or BER encoding :                     :

 :          : that are frequent.        :                     :

 :          : Eventually, all test      :                     :

 :          : vectors with "result" \:  :                     :

 :          : "acceptable" will have    :                     :

 :          : flags describing the      :                     :

 :          : reason and allowing       :                     :

 :          : testers to decide how to  :                     :

 :          : treat these test vectors. :                     :

| tcId | int | A unique identifier of | |

 :          : the test case in a test   :                     :

 :          : file. The identifiers are :                     :

 :          : continuous integers. The  :                     :

 :          : identifiers of test       :                     :

 :          : vectors change between    :                     :

 :          : versions of the test      :                     :

 :          : file. Hence, the triple   :                     :

 :          : (filename, version, tcId) :                     :

 :          : uniquely identifies a     :                     :

 :          : test vector.              :                     :

XdhAsnTestGroup

Fields in XdhAsnTestGroup are:

name	type	desc	enum
curve	str	The name of the curve. If test

: : : vectors encode the curve as : :

 :                  : part of the public and private  :              :

 :                  : key then this field describes   :              :

 :                  : the curve of the private key.   :              :

 :                  : Test vectors with such encoding :              :

 :                  : can contain distinct curves.    :              :

 :                  : Such test vectors are of course :              :

 :                  : invalid and an attempt to       :              :

 :                  : compute a shared secret is      :              :

 :                  : expected to fail.               :              :

| type | str | the type of the test | 'XdhAsnComp' |

| tests | List of | a list of test vectors | |

 : XdhAsnTestVector :                                 :              :

XdhAsnTestVector

A test vector for a key exchange using XDH. Public and private keys are ASN encoded.

Fields additional to the fields in TestVector are:

name	type	desc
public	Asn	X.509 encoded the public key
private	Der	PKCS #8 encoded private key
shared	HexBytes	the shared secret

Used in XdhAsnTestGroup.

XdhJwkTestGroup

Fields in XdhJwkTestGroup are:

name	type	desc	enum
curve	str	The name of the curve. If test

: : : vectors encode the curve as : :

 :                  : part of the public and private  :              :

 :                  : key then this field describes   :              :

 :                  : the curve of the private key.   :              :

 :                  : Test vectors with such encoding :              :

 :                  : can contain distinct curves.    :              :

 :                  : Such test vectors are of course :              :

 :                  : invalid and an attempt to       :              :

 :                  : compute a shared secret is      :              :

 :                  : expected to fail.               :              :

| type | str | the type of the test | 'XdhJwkComp' |

| tests | List of | a list of test vectors | |

 : XdhJwkTestVector :                                 :              :

XdhJwkTestVector

A test vector for a key exchange using XDH. XDH is a Diffie-Hellman key exchange defined in RFC 7748. Both public and private key in this test vector are using the jwk format.

Fields additional to the fields in TestVector are:

name	type	desc	ref
public	JSON	the public key in jwk format	RFC 8037
private	JSON	the private key in jwk format	RFC 8037
shared	HexBytes	the shared secret

Used in XdhJwkTestGroup.

XdhTestGroup

Fields in XdhTestGroup are:

name	type	desc	enum
curve	str	The name of the curve. If

: : : test vectors encode the curve : :

 :                       : as part of the public and     :           :

 :                       : private key then this field   :           :

 :                       : describes the curve of the    :           :

 :                       : private key. Test vectors     :           :

 :                       : with such encoding can        :           :

 :                       : contain distinct curves. Such :           :

 :                       : test vectors are of course    :           :

 :                       : invalid and an attempt to     :           :

 :                       : compute a shared secret is    :           :

 :                       : expected to fail.             :           :

| type | str | the type of the test | 'XdhComp' | | tests | List of XdhTestVector | a list of test vectors | |

XdhTestVector

A test vector for a key exchange using XDH. XDH is a Diffie-Hellman key exchange defined in RFC 7748. Both public and private key in this test vector are just raw bytes. That is valid public keys and valid private keys are 32 bytes each for X25519 and 56 bytes for X448.

Fields additional to the fields in TestVector are:

name	type	desc
public	HexBytes	the raw bytes of the public key
private	HexBytes	the raw bytes of private key
shared	HexBytes	the shared secret

Used in XdhTestGroup.