| Paul Kehrer | 1681a69 | 2014-02-11 23:43:51 -0600 | [diff] [blame] | 1 | Test Vectors |
| 2 | ============ |
| 3 | |
| 4 | Testing the correctness of the primitives implemented in each ``cryptography`` |
| 5 | backend requires trusted test vectors. Where possible these vectors are obtained |
| 6 | from official sources such as `NIST`_ or `IETF`_ RFCs. When this is not possible |
| 7 | ``cryptography`` has chosen to create a set of custom vectors using an official |
| 8 | vector file as input to verify consistency between implemented backends. |
| 9 | |
| 10 | Sources |
| 11 | ------- |
| 12 | |
| 13 | Asymmetric Ciphers |
| 14 | ~~~~~~~~~~~~~~~~~~ |
| 15 | |
| 16 | * RSA PKCS1 from the RSA FTP site (ftp://ftp.rsasecurity.com/pub/pkcs/pkcs-1/ |
| 17 | and ftp://ftp.rsa.com/pub/rsalabs/tmp/). |
| 18 | |
| 19 | Hashes |
| 20 | ~~~~~~ |
| 21 | |
| 22 | * MD5 from :rfc:`1321`. |
| 23 | * RIPEMD160 from the `RIPEMD website`_. |
| 24 | * SHA1 from `NIST CAVP`_. |
| 25 | * SHA2 (224, 256, 384, 512) from `NIST CAVP`_. |
| 26 | * Whirlpool from the `Whirlpool website`_. |
| 27 | |
| 28 | HMAC |
| 29 | ~~~~ |
| 30 | |
| 31 | * HMAC-MD5 from :rfc:`2202`. |
| 32 | * HMAC-SHA1 from :rfc:`2202`. |
| 33 | * HMAC-RIPEMD160 from :rfc:`2286`. |
| 34 | * HMAC-SHA2 (224, 256, 384, 512) from :rfc:`4231`. |
| 35 | |
| 36 | Key Derivation Functions |
| 37 | ~~~~~~~~~~~~~~~~~~~~~~~~ |
| 38 | |
| 39 | * HKDF (SHA1, SHA256) from :rfc:`5869`. |
| 40 | * PBKDF2 (HMAC-SHA1) from :rfc:`6070`. |
| 41 | |
| 42 | Recipes |
| 43 | ~~~~~~~ |
| 44 | |
| 45 | * Fernet from its `specification repository`_. |
| 46 | |
| 47 | Symmetric Ciphers |
| 48 | ~~~~~~~~~~~~~~~~~ |
| 49 | |
| Paul Kehrer | e547d8f | 2014-02-15 21:37:52 -0600 | [diff] [blame] | 50 | * AES (CBC, CFB, ECB, GCM, OFB) from `NIST CAVP`_. |
| 51 | * AES CTR from :rfc:`3686`. |
| Paul Kehrer | 1681a69 | 2014-02-11 23:43:51 -0600 | [diff] [blame] | 52 | * 3DES (CBC, CFB, ECB, OFB) from `NIST CAVP`_. |
| 53 | * ARC4 from :rfc:`6229`. |
| 54 | * Blowfish (CBC, CFB, ECB, OFB) from `Bruce Schneier's vectors`_. |
| 55 | * Camellia (ECB) from NTT's `Camellia page`_ as linked by `CRYPTREC`_. |
| 56 | * Camellia (CBC, CFB, OFB) from `OpenSSL's test vectors`_. |
| 57 | * CAST5 (ECB) from :rfc:`2144`. |
| Paul Kehrer | cf6ffb5 | 2014-02-12 16:17:04 -0600 | [diff] [blame] | 58 | * CAST5 (CBC, CFB, OFB) generated by this project. |
| 59 | See: :doc:`/development/custom-vectors/cast5` |
| Paul Kehrer | 1681a69 | 2014-02-11 23:43:51 -0600 | [diff] [blame] | 60 | |
| Ayrx | 933dd68 | 2014-02-18 23:26:11 +0800 | [diff] [blame^] | 61 | Two Factor Authentication |
| 62 | ~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 63 | |
| 64 | * HOTP from :rfc:`4226` |
| 65 | * TOTP from :rfc:`6238` (Note that an `errata`_ for the test vectors in RFC 6238 exists) |
| 66 | |
| Paul Kehrer | 1681a69 | 2014-02-11 23:43:51 -0600 | [diff] [blame] | 67 | |
| Paul Kehrer | cf6ffb5 | 2014-02-12 16:17:04 -0600 | [diff] [blame] | 68 | Creating Test Vectors |
| 69 | --------------------- |
| 70 | |
| 71 | When official vectors are unavailable ``cryptography`` may choose to build |
| 72 | its own using existing vectors as source material. Current custom vectors: |
| 73 | |
| 74 | .. toctree:: |
| 75 | :maxdepth: 1 |
| 76 | |
| 77 | custom-vectors/cast5 |
| 78 | |
| 79 | If official test vectors appear in the future the custom generated vectors |
| 80 | should be discarded. |
| 81 | |
| 82 | Any vectors generated by this method must also be prefixed with the following |
| 83 | header format (substituting the correct information): |
| 84 | |
| 85 | .. code-block:: python |
| 86 | |
| 87 | # CAST5 CBC vectors built for https://github.com/pyca/cryptography |
| 88 | # Derived from the AESVS MMT test data for CBC |
| 89 | # Verified against the CommonCrypto and Go crypto packages |
| 90 | # Key Length : 128 |
| 91 | |
| Paul Kehrer | 1681a69 | 2014-02-11 23:43:51 -0600 | [diff] [blame] | 92 | .. _`NIST`: http://www.nist.gov/ |
| 93 | .. _`IETF`: https://www.ietf.org/ |
| 94 | .. _`NIST CAVP`: http://csrc.nist.gov/groups/STM/cavp/ |
| 95 | .. _`Bruce Schneier's vectors`: https://www.schneier.com/code/vectors.txt |
| 96 | .. _`Camellia page`: http://info.isl.ntt.co.jp/crypt/eng/camellia/ |
| 97 | .. _`CRYPTREC`: http://www.cryptrec.go.jp |
| 98 | .. _`OpenSSL's test vectors`: https://github.com/openssl/openssl/blob/97cf1f6c2854a3a955fd7dd3a1f113deba00c9ef/crypto/evp/evptests.txt#L232 |
| 99 | .. _`RIPEMD website`: http://homes.esat.kuleuven.be/~bosselae/ripemd160.html |
| 100 | .. _`Whirlpool website`: http://www.larc.usp.br/~pbarreto/WhirlpoolPage.html |
| 101 | .. _`Specification repository`: https://github.com/fernet/spec |
| Ayrx | 933dd68 | 2014-02-18 23:26:11 +0800 | [diff] [blame^] | 102 | .. _`errata`: http://www.rfc-editor.org/errata_search.php?rfc=6238 |