blob: 812df28a0d9c65a1461e26cf5de0b2b890db7389 [file] [log] [blame]
Alex Stapletonc5fffd32014-03-18 15:29:00 +00001Test vectors
Paul Kehrer1681a692014-02-11 23:43:51 -06002============
3
4Testing the correctness of the primitives implemented in each ``cryptography``
Alex Stapletona39a3192014-03-14 20:03:12 +00005backend requires trusted test vectors. Where possible these vectors are
6obtained from official sources such as `NIST`_ or `IETF`_ RFCs. When this is
7not possible ``cryptography`` has chosen to create a set of custom vectors
8using an official vector file as input to verify consistency between
9implemented backends.
10
11Vectors are kept in the `cryptography_vectors` package rather than within our
12main test suite.
Paul Kehrer1681a692014-02-11 23:43:51 -060013
14Sources
15-------
16
Alex Stapletonc5fffd32014-03-18 15:29:00 +000017Asymmetric ciphers
Paul Kehrer1681a692014-02-11 23:43:51 -060018~~~~~~~~~~~~~~~~~~
19
Alex Stapletonabec8a12014-02-22 16:33:24 +000020* RSA PKCS #1 from the RSA FTP site (ftp://ftp.rsasecurity.com/pub/pkcs/pkcs-1/
Paul Kehrer1681a692014-02-11 23:43:51 -060021 and ftp://ftp.rsa.com/pub/rsalabs/tmp/).
Paul Kehrer7f0039c2014-03-03 22:32:11 -040022* RSA FIPS 186-2 and PKCS1 v1.5 vulnerability test vectors from `NIST CAVP`_.
Alex Stapleton07c6a392014-04-02 11:05:30 +010023* FIPS 186-2 and FIPS 186-3 DSA test vectors from `NIST CAVP`_.
24* FIPS 186-2 and FIPS 186-3 ECDSA test vectors from `NIST CAVP`_.
Simo Sorce83e563e2015-05-06 10:56:31 -040025* DH and ECDH and ECDH+KDF(17.4) test vectors from `NIST CAVP`_.
Alex Stapleton833a8ea2014-04-02 14:50:56 +010026* Ed25519 test vectors from the `Ed25519 website_`.
Alex Stapletone7da0ab2014-03-02 14:04:33 +000027* OpenSSL PEM RSA serialization vectors from the `OpenSSL example key`_ and
28 `GnuTLS key parsing tests`_.
29* OpenSSL PEM DSA serialization vectors from the `GnuTLS example keys`_.
Alex Stapletonabec8a12014-02-22 16:33:24 +000030* PKCS #8 PEM serialization vectors from
31
Paul Kehrerb525adf2014-09-29 15:18:23 -050032 * GnuTLS: `enc-rsa-pkcs8.pem`_, `enc2-rsa-pkcs8.pem`_,
Alex Gaynor899c3ac2014-11-18 18:45:24 -080033 `unenc-rsa-pkcs8.pem`_, `pkcs12_s2k_pem.c`_. The contents of
34 `enc2-rsa-pkcs8.pem`_ was re-encrypted using a stronger PKCS#8 cipher.
Alex Stapletonabec8a12014-02-22 16:33:24 +000035 * `Botan's ECC private keys`_.
Paul Kehrerb07a0c92015-03-02 13:21:27 -060036* `asymmetric/public/PKCS1/dsa.pub.pem`_ is a PKCS1 DSA public key from the
37 Ruby test suite.
38
Paul Kehrer1681a692014-02-11 23:43:51 -060039
Alex Stapletone0afa5d2015-05-03 18:14:20 +010040Custom asymmetric vectors
Paul Kehrerebc26502014-11-26 19:18:56 -100041~~~~~~~~~~~~~~~~~~~~~~~~~
42
Alex Stapletone0afa5d2015-05-03 18:14:20 +010043.. toctree::
44 :maxdepth: 1
45
46 custom-vectors/secp256k1
Paul Kehrer30792992016-06-02 15:11:03 -070047 custom-vectors/rsa-oaep-sha2
Alex Stapletone0afa5d2015-05-03 18:14:20 +010048
Paul Kehrer10831a02015-01-03 18:45:04 -060049* ``asymmetric/PEM_Serialization/ec_private_key.pem`` and
50 ``asymmetric/DER_Serialization/ec_private_key.der`` - Contains an Elliptic
Paul Kehrer0498d4c2015-01-01 22:29:12 -060051 Curve key generated by OpenSSL from the curve ``secp256r1``.
Paul Kehrer10831a02015-01-03 18:45:04 -060052* ``asymmetric/PEM_Serialization/ec_private_key_encrypted.pem`` and
53 ``asymmetric/DER_Serialization/ec_private_key_encrypted.der``- Contains the
Paul Kehrer0498d4c2015-01-01 22:29:12 -060054 same Elliptic Curve key as ``ec_private_key.pem``, except that it is
55 encrypted with AES-128 with the password "123456".
Paul Kehrer10831a02015-01-03 18:45:04 -060056* ``asymmetric/PEM_Serialization/ec_public_key.pem`` and
57 ``asymmetric/DER_Serialization/ec_public_key.der``- Contains the public key
Paul Kehrer0498d4c2015-01-01 22:29:12 -060058 corresponding to ``ec_private_key.pem``, generated using OpenSSL.
59* ``asymmetric/PEM_Serialization/rsa_private_key.pem`` - Contains an RSA 2048
60 bit key generated using OpenSSL, protected by the secret "123456" with DES3
61 encryption.
Paul Kehrer10831a02015-01-03 18:45:04 -060062* ``asymmetric/PEM_Serialization/rsa_public_key.pem`` and
63 ``asymmetric/DER_Serialization/rsa_public_key.der``- Contains an RSA 2048
Paul Kehrer0498d4c2015-01-01 22:29:12 -060064 bit public generated using OpenSSL from ``rsa_private_key.pem``.
65* ``asymmetric/PEM_Serialization/dsaparam.pem`` - Contains 2048-bit DSA
66 parameters generated using OpenSSL; contains no keys.
67* ``asymmetric/PEM_Serialization/dsa_private_key.pem`` - Contains a DSA 2048
68 bit key generated using OpenSSL from the parameters in ``dsaparam.pem``,
69 protected by the secret "123456" with DES3 encryption.
Paul Kehrer10831a02015-01-03 18:45:04 -060070* ``asymmetric/PEM_Serialization/dsa_public_key.pem`` and
71 ``asymmetric/DER_Serialization/dsa_public_key.der`` - Contains a DSA 2048 bit
Paul Kehrer0498d4c2015-01-01 22:29:12 -060072 key generated using OpenSSL from ``dsa_private_key.pem``.
Paul Kehrer4b8abc32015-01-06 14:46:15 +000073* ``asymmetric/PKCS8/unenc-dsa-pkcs8.pem`` and
Paul Kehrer10831a02015-01-03 18:45:04 -060074 ``asymmetric/DER_Serialization/unenc-dsa-pkcs8.der`` - Contains a DSA 1024
Paul Kehrera36661e2015-01-04 07:57:40 -060075 bit key generated using OpenSSL.
Paul Kehrer4b8abc32015-01-06 14:46:15 +000076* ``asymmetric/PKCS8/unenc-dsa-pkcs8.pub.pem`` and
Paul Kehrer10831a02015-01-03 18:45:04 -060077 ``asymmetric/DER_Serialization/unenc-dsa-pkcs8.pub.der`` - Contains a DSA
Paul Kehrera673dcc2015-01-03 23:26:01 -060078 2048 bit public key generated using OpenSSL from ``unenc-dsa-pkcs8.pem``.
Paul Kehrer10831a02015-01-03 18:45:04 -060079* DER conversions of the `GnuTLS example keys`_ for DSA as well as the
80 `OpenSSL example key`_ for RSA.
81* DER conversions of `enc-rsa-pkcs8.pem`_, `enc2-rsa-pkcs8.pem`_, and
82 `unenc-rsa-pkcs8.pem`_.
Paul Kehrer6d977422015-03-02 19:38:34 -060083* ``asymmetric/public/PKCS1/rsa.pub.pem`` and
84 ``asymmetric/public/PKCS1/rsa.pub.der`` are PKCS1 conversions of the public
85 key from ``asymmetric/PKCS8/unenc-rsa-pkcs8.pem`` using PEM and DER encoding.
Paul Kehrerebc26502014-11-26 19:18:56 -100086
Alex Stapletone0afa5d2015-05-03 18:14:20 +010087
Alex Stapleton91ca3432015-04-12 20:06:39 +010088Key exchange
89~~~~~~~~~~~~
90
91* ``vectors/cryptography_vectors/asymmetric/DH/RFC5114.txt`` contains
92 Diffie-Hellman examples from appendix A.1, A.2 and A.3 of :rfc:`5114`.
93
Aviv Palivoda495f21a2016-11-25 18:51:28 +020094* ``vectors/cryptography_vectors/asymmetric/DH/vec.txt`` contains
95 Diffie-Hellman examples from `botan`_.
96
97* ``vectors/cryptography_vectors/asymmetric/DH/bad_exchange.txt`` contains
98 Diffie-Hellman vector pairs that were generated using OpenSSL
99 DH_generate_parameters_ex and DH_generate_key.
100
Aviv Palivoda6723a122017-02-07 15:24:56 +0200101* ``vectors/cryptography_vectors/asymmetric/DH/dhp.pem``,
102 ``vectors/cryptography_vectors/asymmetric/DH/dhkey.pem`` and
103 ``vectors/cryptography_vectors/asymmetric/DH/dhpub.pem`` contains
104 Diffie-Hellman parameters and key respectively. The keys were
105 generated using OpenSSL following `DHKE`_ guide.
106 ``vectors/cryptography_vectors/asymmetric/DH/dhkey.txt`` contains
107 all parameter in text.
108 ``vectors/cryptography_vectors/asymmetric/DH/dhp.der``,
109 ``vectors/cryptography_vectors/asymmetric/DH/dhkey.der`` and
110 ``vectors/cryptography_vectors/asymmetric/DH/dhpub.der`` contains
111 are the above parameters and keys in DER format.
112
113
Paul Kehrerbab4e392014-11-24 11:48:17 -1000114X.509
115~~~~~
116
117* PKITS test suite from `NIST PKI Testing`_.
Paul Kehrerebc26502014-11-26 19:18:56 -1000118* ``v1_cert.pem`` from the OpenSSL source tree (`testx509.pem`_).
119* ``ecdsa_root.pem`` - `DigiCert Global Root G3`_, a ``secp384r1`` ECDSA root
120 certificate.
Paul Kehrerb01622d2015-02-13 11:59:15 -0600121* ``verisign-md2-root.pem`` - A legacy Verisign public root signed using the
Paul Kehrer2b6ba0c2015-02-14 18:58:20 -0600122 MD2 algorithm. This is a PEM conversion of the `root data`_ in the NSS source
123 tree.
Paul Kehrere0eafaa2015-03-20 22:33:37 -0500124* ``cryptography.io.pem`` - A leaf certificate issued by RapidSSL for the
125 cryptography website.
Paul Kehrer4113d5b2015-08-05 17:42:43 +0100126* ``rapidssl_sha256_ca_g3.pem`` - The intermediate CA that issued the
127 ``cryptography.io.pem`` certificate.
Paul Kehrere651b7f2015-06-23 08:31:15 -0500128* ``wildcard_san.pem`` - A leaf certificate issued by a public CA for
129 ``langui.sh`` that contains wildcard entries in the SAN extension.
Paul Kehrer0ed3d912015-07-04 16:48:08 -0500130* ``san_edipartyname.der`` - A DSA certificate from a `Mozilla bug`_
131 containing a SAN extension with an ``ediPartyName`` general name.
132* ``san_x400address.der`` - A DSA certificate from a `Mozilla bug`_ containing
133 a SAN extension with an ``x400Address`` general name.
Alex Gaynor0ab8e9e2016-02-26 12:29:56 -0500134* ``department-of-state-root.pem`` - The intermediary CA for the Department of
135 State, issued by the United States Federal Government's Common Policy CA.
136 Notably has a ``critical`` policy constraints extensions.
Paul Kehrerd3c21ca2016-03-11 23:38:00 -0400137* ``e-trust.ru.der`` - A certificate from a `Russian CA`_ signed using the GOST
138 cipher and containing numerous unusual encodings such as NUMERICSTRING in
139 the subject DN.
Paul Kehrerf6f238e2016-11-11 10:41:31 -0800140* ``alternate-rsa-sha1-oid.pem`` - A certificate from an
141 `unknown signature OID`_ Mozilla bug that uses an alternate signature OID for
142 RSA with SHA1.
Paul Kehrerebc26502014-11-26 19:18:56 -1000143
144Custom X.509 Vectors
145~~~~~~~~~~~~~~~~~~~~
146
147* ``invalid_version.pem`` - Contains an RSA 2048 bit certificate with the
148 X.509 version field set to ``0x7``.
149* ``post2000utctime.pem`` - Contains an RSA 2048 bit certificate with the
150 ``notBefore`` and ``notAfter`` fields encoded as post-2000 ``UTCTime``.
Paul Kehrera850c612014-12-12 14:21:18 -0600151* ``dsa_selfsigned_ca.pem`` - Contains a DSA self-signed CA certificate
152 generated using OpenSSL.
Paul Kehrerd317bae2014-12-12 11:42:31 -0600153* ``ec_no_named_curve.pem`` - Contains an ECDSA certificate that does not have
154 an embedded OID defining the curve.
Paul Kehrer22217202015-01-17 21:26:28 -0600155* ``all_supported_names.pem`` - An RSA 2048 bit certificate generated using
156 OpenSSL that contains a subject and issuer that have two of each supported
157 attribute type from :rfc:`5280`.
Paul Kehrer1207d152015-01-17 21:31:42 -0600158* ``unsupported_subject_name.pem`` - An RSA 2048 bit self-signed CA certificate
159 generated using OpenSSL that contains the unsupported "initials" name.
Paul Kehrer6392b4b2015-01-17 22:20:01 -0600160* ``utf8_common_name.pem`` - An RSA 2048 bit self-signed CA certificate
161 generated using OpenSSL that contains a UTF8String common name with the value
162 "We heart UTF8!â„¢".
Paul Kehrere0eafaa2015-03-20 22:33:37 -0500163* ``two_basic_constraints.pem`` - An RSA 2048 bit self-signed certificate
164 containing two basic constraints extensions.
165* ``basic_constraints_not_critical.pem`` - An RSA 2048 bit self-signed
166 certificate containing a basic constraints extension that is not marked as
167 critical.
Paul Kehrerd1ed6732015-03-25 00:17:36 -0500168* ``bc_path_length_zero.pem`` - An RSA 2048 bit self-signed
169 certificate containing a basic constraints extension with a path length of
170 zero.
Paul Kehrerb2e6c832015-03-27 22:19:13 -0500171* ``unsupported_extension.pem`` - An RSA 2048 bit self-signed certificate
172 containing an unsupported extension type. The OID was encoded as
173 "1.2.3.4" with an ``extnValue`` of "value".
Paul Kehrer249d9be2015-12-30 09:52:56 -0600174* ``unsupported_extension_2.pem`` - A ``secp256r1`` certificate
175 containing two unsupported extensions. The OIDs are ``1.3.6.1.4.1.41482.2``
176 with an ``extnValue`` of ``1.3.6.1.4.1.41482.1.2`` and
177 ``1.3.6.1.4.1.45724.2.1.1`` with an ``extnValue`` of ``\x03\x02\x040``
Paul Kehrerf5ac6c62015-03-27 23:27:00 -0500178* ``unsupported_extension_critical.pem`` - An RSA 2048 bit self-signed
179 certificate containing an unsupported extension type marked critical. The OID
180 was encoded as "1.2.3.4" with an ``extnValue`` of "value".
Paul Kehrer2e3c7092015-03-27 10:24:05 -0500181* ``san_email_dns_ip_dirname_uri.pem`` - An RSA 2048 bit self-signed
182 certificate containing a subject alternative name extension with the
183 following general names: ``rfc822Name``, ``dNSName``, ``iPAddress``,
184 ``directoryName``, and ``uniformResourceIdentifier``.
Dominic Chen87bb9572015-10-09 00:23:07 -0400185* ``san_empty_hostname.pem`` - An RSA 2048 bit self-signed certificate
186 containing a subject alternative extension with an empty ``dNSName``
187 general name.
Paul Kehrer2e3c7092015-03-27 10:24:05 -0500188* ``san_other_name.pem`` - An RSA 2048 bit self-signed certificate containing
189 a subject alternative name extension with the ``otherName`` general name.
190* ``san_registered_id.pem`` - An RSA 1024 bit certificate containing a
191 subject alternative name extension with the ``registeredID`` general name.
Paul Kehrerc88bce52015-04-02 19:32:45 -0500192* ``all_key_usages.pem`` - An RSA 2048 bit self-signed certificate containing
193 a key usage extension with all nine purposes set to true.
Paul Kehrer986e5fa2015-05-01 23:24:10 -0500194* ``extended_key_usage.pem`` - An RSA 2048 bit self-signed certificate
195 containing an extended key usage extension with eight usages.
Paul Kehrer542f4e52015-04-20 14:57:32 -0500196* ``san_idna_names.pem`` - An RSA 2048 bit self-signed certificate containing
197 a subject alternative name extension with ``rfc822Name``, ``dNSName``, and
198 ``uniformResourceIdentifier`` general names with IDNA (:rfc:`5895`) encoding.
Paul Kehrer3f0522f2015-06-26 18:46:19 -0500199* ``san_wildcard_idna.pem`` - An RSA 2048 bit self-signed certificate
200 containing a subject alternative name extension with a ``dNSName`` general
201 name with a wildcard IDNA (:rfc:`5895`) domain.
Paul Kehrerd0a66e72015-05-15 08:50:50 -0700202* ``san_idna2003_dnsname.pem`` - An RSA 2048 bit self-signed certificate
203 containing a subject alternative name extension with an IDNA 2003
204 (:rfc:`3490`) ``dNSName``.
Paul Kehrer542f4e52015-04-20 14:57:32 -0500205* ``san_rfc822_names.pem`` - An RSA 2048 bit self-signed certificate containing
206 a subject alternative name extension with various ``rfc822Name`` values.
Paul Kehrer60163d72015-04-29 21:23:14 -0500207* ``san_rfc822_idna.pem`` - An RSA 2048 bit self-signed certificate containing
208 a subject alternative name extension with an IDNA ``rfc822Name``.
Paul Kehrer542f4e52015-04-20 14:57:32 -0500209* ``san_uri_with_port.pem`` - An RSA 2048 bit self-signed certificate
210 containing a subject alternative name extension with various
211 ``uniformResourceIdentifier`` values.
Paul Kehrerfbc62192015-04-29 21:37:42 -0500212* ``san_ipaddr.pem`` - An RSA 2048 bit self-signed certificate containing a
213 subject alternative name extension with an ``iPAddress`` value.
214* ``san_dirname.pem`` - An RSA 2048 bit self-signed certificate containing a
215 subject alternative name extension with a ``directoryName`` value.
Paul Kehrer67a62c82015-05-01 23:15:58 -0500216* ``inhibit_any_policy_5.pem`` - An RSA 2048 bit self-signed certificate
217 containing an inhibit any policy extension with the value 5.
218* ``inhibit_any_policy_negative.pem`` - An RSA 2048 bit self-signed certificate
219 containing an inhibit any policy extension with the value -1.
Paul Kehrerb0deb442015-05-03 10:53:45 -0500220* ``authority_key_identifier.pem`` - An RSA 2048 bit self-signed certificate
221 containing an authority key identifier extension with key identifier,
222 authority certificate issuer, and authority certificate serial number fields.
Paul Kehrer0d52e2a2015-05-03 11:17:12 -0500223* ``authority_key_identifier_no_keyid.pem`` - An RSA 2048 bit self-signed
224 certificate containing an authority key identifier extension with authority
225 certificate issuer and authority certificate serial number fields.
Paul Kehrer64c82e02015-05-04 17:38:52 -0500226* ``aia_ocsp_ca_issuers.pem`` - An RSA 2048 bit self-signed certificate
227 containing an authority information access extension with two OCSP and one
228 CA issuers entry.
229* ``aia_ocsp.pem`` - An RSA 2048 bit self-signed certificate
230 containing an authority information access extension with an OCSP entry.
231* ``aia_ca_issuers.pem`` - An RSA 2048 bit self-signed certificate
232 containing an authority information access extension with a CA issuers entry.
Dominic Chen87bb9572015-10-09 00:23:07 -0400233* ``cdp_empty_hostname.pem`` - An RSA 2048 bit self-signed certificate
234 containing a CRL distribution point extension with ``fullName`` URI without
235 a hostname.
Paul Kehrer28d54212015-05-10 14:58:21 -0500236* ``cdp_fullname_reasons_crl_issuer.pem`` - An RSA 1024 bit certificate
237 containing a CRL distribution points extension with ``fullName``,
238 ``cRLIssuer``, and ``reasons`` data.
239* ``cdp_crl_issuer.pem`` - An RSA 1024 bit certificate containing a CRL
240 distribution points extension with ``cRLIssuer`` data.
Paul Kehrer208d6782015-05-12 23:09:13 -0500241* ``cdp_all_reasons.pem`` - An RSA 1024 bit certificate containing a CRL
242 distribution points extension with all ``reasons`` bits set.
243* ``cdp_reason_aa_compromise.pem`` - An RSA 1024 bit certificate containing a
244 CRL distribution points extension with the ``AACompromise`` ``reasons`` bit
245 set.
Paul Kehrercf1109d2015-06-17 22:40:06 -0600246* ``nc_permitted_excluded.pem`` - An RSA 2048 bit self-signed certificate
247 containing a name constraints extension with both permitted and excluded
Paul Kehrer7155c982015-06-29 07:53:54 -0500248 elements. Contains ``IPv4`` and ``IPv6`` addresses with network mask as well
249 as ``dNSName`` with a leading period.
250* ``nc_permitted_excluded_2.pem`` - An RSA 2048 bit self-signed certificate
251 containing a name constraints extension with both permitted and excluded
252 elements. Unlike ``nc_permitted_excluded.pem``, the general names do not
253 contain any name constraints specific values.
Paul Kehrercf1109d2015-06-17 22:40:06 -0600254* ``nc_permitted.pem`` - An RSA 2048 bit self-signed certificate containing a
255 name constraints extension with permitted elements.
Paul Kehrer7155c982015-06-29 07:53:54 -0500256* ``nc_permitted_2.pem`` - An RSA 2048 bit self-signed certificate containing a
257 name constraints extension with permitted elements that do not contain any
258 name constraints specific values.
Paul Kehrercf1109d2015-06-17 22:40:06 -0600259* ``nc_excluded.pem`` - An RSA 2048 bit self-signed certificate containing a
260 name constraints extension with excluded elements.
Paul Kehrer5d3f7b72015-06-28 00:39:21 -0500261* ``nc_invalid_ip_netmask.pem`` - An RSA 2048 bit self-signed certificate
262 containing a name constraints extension with a permitted element that has an
263 ``IPv6`` IP and an invalid network mask.
Paul Kehrer8f458ab2015-07-01 21:17:17 -0500264* ``nc_single_ip_netmask.pem`` - An RSA 2048 bit self-signed certificate
265 containing a name constraints extension with a permitted element that has two
266 IPs with ``/32`` and ``/128`` network masks.
Paul Kehrercdfe0f92015-05-11 20:00:29 -0500267* ``cp_user_notice_with_notice_reference.pem`` - An RSA 2048 bit self-signed
268 certificate containing a certificate policies extension with a
269 notice reference in the user notice.
270* ``cp_user_notice_with_explicit_text.pem`` - An RSA 2048 bit self-signed
271 certificate containing a certificate policies extension with explicit
272 text and no notice reference.
273* ``cp_cps_uri.pem`` - An RSA 2048 bit self-signed certificate containing a
274 certificate policies extension with a CPS URI and no user notice.
Paul Kehrer5ac41542015-05-12 16:04:52 -0500275* ``cp_user_notice_no_explicit_text.pem`` - An RSA 2048 bit self-signed
276 certificate containing a certificate policies extension with a user notice
277 with no explicit text.
Paul Kehrer0f984362015-08-01 20:45:08 +0100278* ``cp_invalid.pem`` - An RSA 2048 bit self-signed certificate containing a
279 certificate policies extension with invalid data.
Paul Kehrer769e7f22015-06-17 22:28:29 -0600280* ``ian_uri.pem`` - An RSA 2048 bit certificate containing an issuer
281 alternative name extension with a ``URI`` general name.
Paul Kehrerd59b07c2015-06-07 18:51:50 -0500282* ``ocsp_nocheck.pem`` - An RSA 2048 bit self-signed certificate containing
283 an ``OCSPNoCheck`` extension.
Paul Kehrer77335622015-06-17 21:52:32 -0600284* ``pc_inhibit_require.pem`` - An RSA 2048 bit self-signed certificate
285 containing a policy constraints extension with both inhibit policy mapping
286 and require explicit policy elements.
287* ``pc_inhibit.pem`` - An RSA 2048 bit self-signed certificate containing a
288 policy constraints extension with an inhibit policy mapping element.
289* ``pc_require.pem`` - An RSA 2048 bit self-signed certificate containing a
290 policy constraints extension with a require explicit policy element.
Alex Gaynor96605fc2015-10-10 09:03:07 -0400291* ``unsupported_subject_public_key_info.pem`` - A certificate whose public key
292 is an unknown OID (``1.3.6.1.4.1.8432.1.1.2``).
Paul Kehrer4a6e2de2016-02-27 10:31:17 -0600293* ``policy_constraints_explicit.pem`` - A self-signed certificate containing
294 a ``policyConstraints`` extension with a ``requireExplicitPolicy`` value.
Paul Kehrerff2167a2015-02-24 10:45:41 -0600295
296Custom X.509 Request Vectors
297~~~~~~~~~~~~~~~~~~~~~~~~~~~~
298
Paul Kehrer89e4c952015-03-30 15:15:00 -0500299* ``dsa_sha1.pem`` and ``dsa_sha1.der`` - Contain a certificate request using
300 1024-bit DSA parameters and SHA1 generated using OpenSSL.
301* ``rsa_md4.pem`` and ``rsa_md4.der`` - Contain a certificate request using
302 2048 bit RSA and MD4 generated using OpenSSL.
303* ``rsa_sha1.pem`` and ``rsa_sha1.der`` - Contain a certificate request using
304 2048 bit RSA and SHA1 generated using OpenSSL.
305* ``rsa_sha256.pem`` and ``rsa_sha256.der`` - Contain a certificate request
306 using 2048 bit RSA and SHA256 generated using OpenSSL.
307* ``ec_sha256.pem`` and ``ec_sha256.der`` - Contain a certificate request
308 using EC (``secp384r1``) and SHA256 generated using OpenSSL.
Paul Kehrer0c518be2015-03-30 21:10:51 -0500309* ``san_rsa_sha1.pem`` and ``san_rsa_sha1.der`` - Contain a certificate
310 request using RSA and SHA1 with a subject alternative name extension
311 generated using OpenSSL.
Andre Caron2b54fb02015-05-16 10:20:51 -0400312* ``two_basic_constraints.pem`` - A certificate signing request
Joern Heissler1bd77e22016-01-13 22:51:37 +0100313 for an RSA 2048 bit key containing two basic constraints extensions.
Andre Caron2b54fb02015-05-16 10:20:51 -0400314* ``unsupported_extension.pem`` - A certificate signing request
Andre Caron6cfe79b2015-05-16 08:41:52 -0400315 for an RSA 2048 bit key containing containing an unsupported
316 extension type. The OID was encoded as "1.2.3.4" with an
317 ``extnValue`` of "value".
Andre Caron2b54fb02015-05-16 10:20:51 -0400318* ``unsupported_extension_critical.pem`` - A certificate signing
Andre Caron6cfe79b2015-05-16 08:41:52 -0400319 request for an RSA 2048 bit key containing containing an unsupported
320 extension type marked critical. The OID was encoded as "1.2.3.4"
321 with an ``extnValue`` of "value".
Joern Heissler1bd77e22016-01-13 22:51:37 +0100322* ``basic_constraints.pem`` - A certificate signing request for an RSA
Andre Caronc97ca7e2015-05-16 22:16:44 -0400323 2048 bit key containing a basic constraints extension marked as
324 critical.
Joern Heissler1bd77e22016-01-13 22:51:37 +0100325* ``invalid_signature.pem`` - A certificate signing request for an RSA
326 1024 bit key containing an invalid signature with correct padding.
Paul Kehrerbab4e392014-11-24 11:48:17 -1000327
Erik Trauschke0150e3d2015-05-29 13:11:22 -0700328Custom X.509 Certificate Revocation List Vectors
329~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
330
331* ``crl_all_reasons.pem`` - Contains a CRL with 12 revoked certificates, whose
332 serials match their list position. It includes one revocation without
Erik Trauschke70d31382015-05-29 14:29:28 -0700333 any entry extensions, 10 revocations with every supported reason code and one
Erik Trauschke0150e3d2015-05-29 13:11:22 -0700334 revocation with an unsupported, non-critical entry extension with the OID
335 value set to "1.2.3.4".
336* ``crl_dup_entry_ext.pem`` - Contains a CRL with one revocation which has a
337 duplicate entry extension.
338* ``crl_md2_unknown_crit_entry_ext.pem`` - Contains a CRL with one revocation
339 which contains an unsupported critical entry extension with the OID value set
340 to "1.2.3.4". The CRL uses an unsupported MD2 signature algorithm.
341* ``crl_unsupported_reason.pem`` - Contains a CRL with one revocation which has
342 an unsupported reason code.
Erik Trauschkea6c82592015-10-15 21:10:20 -0700343* ``crl_inval_cert_issuer_entry_ext.pem`` - Contains a CRL with one revocation
344 which has one entry extension for certificate issuer with an empty value.
Paul Kehrer9543a332015-12-20 18:48:24 -0600345* ``crl_empty.pem`` - Contains a CRL with no revoked certificates.
Paul Kehrer93df8b72015-12-22 17:16:13 -0600346* ``crl_ian_aia_aki.pem`` - Contains a CRL with ``IssuerAlternativeName``,
347 ``AuthorityInformationAccess``, ``AuthorityKeyIdentifier`` and ``CRLNumber``
348 extensions.
Erik Trauschke0150e3d2015-05-29 13:11:22 -0700349
Paul Kehrer1681a692014-02-11 23:43:51 -0600350Hashes
351~~~~~~
352
353* MD5 from :rfc:`1321`.
354* RIPEMD160 from the `RIPEMD website`_.
355* SHA1 from `NIST CAVP`_.
356* SHA2 (224, 256, 384, 512) from `NIST CAVP`_.
357* Whirlpool from the `Whirlpool website`_.
Terry Chia7e6afe82016-04-09 22:04:12 +0800358* Blake2s and Blake2b from OpenSSL `test/evptests.txt`_.
Paul Kehrer1681a692014-02-11 23:43:51 -0600359
360HMAC
361~~~~
362
363* HMAC-MD5 from :rfc:`2202`.
364* HMAC-SHA1 from :rfc:`2202`.
365* HMAC-RIPEMD160 from :rfc:`2286`.
366* HMAC-SHA2 (224, 256, 384, 512) from :rfc:`4231`.
367
Alex Stapletonc5fffd32014-03-18 15:29:00 +0000368Key derivation functions
Paul Kehrer1681a692014-02-11 23:43:51 -0600369~~~~~~~~~~~~~~~~~~~~~~~~
370
371* HKDF (SHA1, SHA256) from :rfc:`5869`.
372* PBKDF2 (HMAC-SHA1) from :rfc:`6070`.
Alex Gaynor75e72ea2014-03-01 12:18:27 -0800373* scrypt from the `draft RFC`_.
Simo Sorcee69da952015-09-15 11:16:56 -0400374* X9.63 KDF from `NIST CAVP`_.
Jared Messengerfac4d642016-03-14 14:27:09 -0700375* SP 800-108 Counter Mode KDF (HMAC-SHA1, HMAC-SHA224, HMAC-SHA256,
376 HMAC-SHA384, HMAC-SHA512) from `NIST CAVP`_.
Paul Kehrer1681a692014-02-11 23:43:51 -0600377
Paul Kehrer16430f92015-03-15 09:06:25 -0500378Key wrapping
379~~~~~~~~~~~~
380
381* AES key wrap (AESKW) and 3DES key wrap test vectors from `NIST CAVP`_.
382
Paul Kehrer1681a692014-02-11 23:43:51 -0600383Recipes
384~~~~~~~
385
386* Fernet from its `specification repository`_.
387
Alex Stapletonc5fffd32014-03-18 15:29:00 +0000388Symmetric ciphers
Paul Kehrer1681a692014-02-11 23:43:51 -0600389~~~~~~~~~~~~~~~~~
390
Paul Kehrere547d8f2014-02-15 21:37:52 -0600391* AES (CBC, CFB, ECB, GCM, OFB) from `NIST CAVP`_.
392* AES CTR from :rfc:`3686`.
Paul Kehrer1681a692014-02-11 23:43:51 -0600393* 3DES (CBC, CFB, ECB, OFB) from `NIST CAVP`_.
Ehren Krete23c0b72015-11-28 02:40:33 -0800394* ARC4 (KEY-LENGTH: 40, 56, 64, 80, 128, 192, 256) from :rfc:`6229`.
395* ARC4 (KEY-LENGTH: 160) generated by this project.
396 See: :doc:`/development/custom-vectors/arc4`
Paul Kehrer1681a692014-02-11 23:43:51 -0600397* Blowfish (CBC, CFB, ECB, OFB) from `Bruce Schneier's vectors`_.
398* Camellia (ECB) from NTT's `Camellia page`_ as linked by `CRYPTREC`_.
399* Camellia (CBC, CFB, OFB) from `OpenSSL's test vectors`_.
400* CAST5 (ECB) from :rfc:`2144`.
Paul Kehrercf6ffb52014-02-12 16:17:04 -0600401* CAST5 (CBC, CFB, OFB) generated by this project.
402 See: :doc:`/development/custom-vectors/cast5`
Paul Kehrerb09622c2014-02-16 19:32:04 -0600403* IDEA (ECB) from the `NESSIE IDEA vectors`_ created by `NESSIE`_.
404* IDEA (CBC, CFB, OFB) generated by this project.
405 See: :doc:`/development/custom-vectors/idea`
Paul Kehrer1d0f9732014-04-08 08:44:25 -0500406* SEED (ECB) from :rfc:`4269`.
Paul Kehrerf0e12ac2014-04-08 08:59:40 -0500407* SEED (CBC) from :rfc:`4196`.
Paul Kehrer6d8f9b02014-04-08 09:17:02 -0500408* SEED (CFB, OFB) generated by this project.
409 See: :doc:`/development/custom-vectors/seed`
Paul Kehrer1681a692014-02-11 23:43:51 -0600410
Alex Stapletonc5fffd32014-03-18 15:29:00 +0000411Two factor authentication
Ayrx933dd682014-02-18 23:26:11 +0800412~~~~~~~~~~~~~~~~~~~~~~~~~
413
414* HOTP from :rfc:`4226`
Alex Gaynor75e72ea2014-03-01 12:18:27 -0800415* TOTP from :rfc:`6238` (Note that an `errata`_ for the test vectors in RFC
416 6238 exists)
Ayrx933dd682014-02-18 23:26:11 +0800417
Ayrx1d6b77b2014-04-10 23:11:03 +0800418CMAC
419~~~~
420
Ayrxfa52e6a2014-04-14 22:26:21 +0800421* AES-128, AES-192, AES-256, 3DES from `NIST SP-800-38B`_
Ayrx1d6b77b2014-04-10 23:11:03 +0800422
Alex Stapletonc5fffd32014-03-18 15:29:00 +0000423Creating test vectors
Paul Kehrercf6ffb52014-02-12 16:17:04 -0600424---------------------
425
426When official vectors are unavailable ``cryptography`` may choose to build
Paul Kehrer9f7ad192014-09-24 21:54:39 -0500427its own using existing vectors as source material.
michael-hart59f72192014-09-24 11:31:20 +0100428
Paul Kehrerebc26502014-11-26 19:18:56 -1000429Custom Symmetric Vectors
430~~~~~~~~~~~~~~~~~~~~~~~~
Paul Kehrercf6ffb52014-02-12 16:17:04 -0600431
432.. toctree::
433 :maxdepth: 1
434
Ehren Kret6c83cc62015-11-28 03:24:15 -0800435 custom-vectors/arc4
Paul Kehrercf6ffb52014-02-12 16:17:04 -0600436 custom-vectors/cast5
Paul Kehrerb09622c2014-02-16 19:32:04 -0600437 custom-vectors/idea
Paul Kehrer6d8f9b02014-04-08 09:17:02 -0500438 custom-vectors/seed
Paul Kehrercf6ffb52014-02-12 16:17:04 -0600439
440If official test vectors appear in the future the custom generated vectors
441should be discarded.
442
443Any vectors generated by this method must also be prefixed with the following
444header format (substituting the correct information):
445
446.. code-block:: python
447
448 # CAST5 CBC vectors built for https://github.com/pyca/cryptography
449 # Derived from the AESVS MMT test data for CBC
450 # Verified against the CommonCrypto and Go crypto packages
451 # Key Length : 128
452
Alex Gaynore51236d2016-11-06 10:13:35 -0500453.. _`NIST`: https://www.nist.gov/
Paul Kehrer1681a692014-02-11 23:43:51 -0600454.. _`IETF`: https://www.ietf.org/
455.. _`NIST CAVP`: http://csrc.nist.gov/groups/STM/cavp/
456.. _`Bruce Schneier's vectors`: https://www.schneier.com/code/vectors.txt
Alex Gaynor4566cb92015-10-02 06:40:05 -0700457.. _`Camellia page`: https://info.isl.ntt.co.jp/crypt/eng/camellia/
Alex Gaynor6422d832016-03-06 21:40:57 -0500458.. _`CRYPTREC`: https://www.cryptrec.go.jp
Paul Kehrer1681a692014-02-11 23:43:51 -0600459.. _`OpenSSL's test vectors`: https://github.com/openssl/openssl/blob/97cf1f6c2854a3a955fd7dd3a1f113deba00c9ef/crypto/evp/evptests.txt#L232
Alex Gaynor9a59ad82017-02-23 05:38:41 -0500460.. _`RIPEMD website`: https://homes.esat.kuleuven.be/~bosselae/ripemd160.html
Paul Kehrer1681a692014-02-11 23:43:51 -0600461.. _`Whirlpool website`: http://www.larc.usp.br/~pbarreto/WhirlpoolPage.html
Alex Gaynor75e72ea2014-03-01 12:18:27 -0800462.. _`draft RFC`: https://tools.ietf.org/html/draft-josefsson-scrypt-kdf-01
Paul Kehrer1681a692014-02-11 23:43:51 -0600463.. _`Specification repository`: https://github.com/fernet/spec
Alex Gaynor3197ab52015-10-02 06:33:11 -0700464.. _`errata`: https://www.rfc-editor.org/errata_search.php?rfc=6238
Paul Kehrer5e9a8a32015-03-02 13:25:45 -0600465.. _`OpenSSL example key`: https://github.com/openssl/openssl/blob/d02b48c63a58ea4367a0e905979f140b7d090f86/test/testrsa.pem
Paul Kehrerdac86a92015-03-06 08:36:07 -0600466.. _`GnuTLS key parsing tests`: https://gitlab.com/gnutls/gnutls/commit/f16ef39ef0303b02d7fa590a37820440c466ce8d
467.. _`enc-rsa-pkcs8.pem`: https://gitlab.com/gnutls/gnutls/blob/f8d943b38bf74eaaa11d396112daf43cb8aa82ae/tests/pkcs8-decode/encpkcs8.pem
468.. _`enc2-rsa-pkcs8.pem`: https://gitlab.com/gnutls/gnutls/blob/f8d943b38bf74eaaa11d396112daf43cb8aa82ae/tests/pkcs8-decode/enc2pkcs8.pem
469.. _`unenc-rsa-pkcs8.pem`: https://gitlab.com/gnutls/gnutls/blob/f8d943b38bf74eaaa11d396112daf43cb8aa82ae/tests/pkcs8-decode/unencpkcs8.pem
470.. _`pkcs12_s2k_pem.c`: https://gitlab.com/gnutls/gnutls/blob/f8d943b38bf74eaaa11d396112daf43cb8aa82ae/tests/pkcs12_s2k_pem.c
Alex Stapletonabec8a12014-02-22 16:33:24 +0000471.. _`Botan's ECC private keys`: https://github.com/randombit/botan/tree/4917f26a2b154e841cd27c1bcecdd41d2bdeb6ce/src/tests/data/ecc
Alex Gaynor3efbf492015-03-09 07:13:22 -0400472.. _`GnuTLS example keys`: https://gitlab.com/gnutls/gnutls/commit/ad2061deafdd7db78fd405f9d143b0a7c579da7b
Paul Kehrerb09622c2014-02-16 19:32:04 -0600473.. _`NESSIE IDEA vectors`: https://www.cosic.esat.kuleuven.be/nessie/testvectors/bc/idea/Idea-128-64.verified.test-vectors
474.. _`NESSIE`: https://en.wikipedia.org/wiki/NESSIE
Alex Gaynor9a59ad82017-02-23 05:38:41 -0500475.. _`Ed25519 website`: https://ed25519.cr.yp.to/software.html
Ayrx40afce02014-04-13 19:17:52 +0800476.. _`NIST SP-800-38B`: http://csrc.nist.gov/publications/nistpubs/800-38B/Updated_CMAC_Examples.pdf
Paul Kehrerbab4e392014-11-24 11:48:17 -1000477.. _`NIST PKI Testing`: http://csrc.nist.gov/groups/ST/crypto_apps_infra/pki/pkitesting.html
Paul Kehrerebc26502014-11-26 19:18:56 -1000478.. _`testx509.pem`: https://github.com/openssl/openssl/blob/master/test/testx509.pem
479.. _`DigiCert Global Root G3`: http://cacerts.digicert.com/DigiCertGlobalRootG3.crt
Paul Kehrer2b6ba0c2015-02-14 18:58:20 -0600480.. _`root data`: https://hg.mozilla.org/projects/nss/file/25b2922cc564/security/nss/lib/ckfw/builtins/certdata.txt#l2053
Paul Kehrerb07a0c92015-03-02 13:21:27 -0600481.. _`asymmetric/public/PKCS1/dsa.pub.pem`: https://github.com/ruby/ruby/blob/4ccb387f3bc436a08fc6d72c4931994f5de95110/test/openssl/test_pkey_dsa.rb#L53
Paul Kehrer0ed3d912015-07-04 16:48:08 -0500482.. _`Mozilla bug`: https://bugzilla.mozilla.org/show_bug.cgi?id=233586
Alex Gaynor43774542016-04-09 10:51:09 -0400483.. _`Russian CA`: https://e-trust.gosuslugi.ru/MainCA
Terry Chia7e6afe82016-04-09 22:04:12 +0800484.. _`test/evptests.txt`: https://github.com/openssl/openssl/blob/2d0b44126763f989a4cbffbffe9d0c7518158bb7/test/evptests.txt
Paul Kehrerf6f238e2016-11-11 10:41:31 -0800485.. _`unknown signature OID`: https://bugzilla.mozilla.org/show_bug.cgi?id=405966
Aviv Palivoda495f21a2016-11-25 18:51:28 +0200486.. _`botan`: https://github.com/randombit/botan/blob/57789bdfc55061002b2727d0b32587612829a37c/src/tests/data/pubkey/dh.vec
Aviv Palivoda6723a122017-02-07 15:24:56 +0200487.. _`DHKE`: https://sandilands.info/sgordon/diffie-hellman-secret-key-exchange-with-openssl