diff options
| author | Alex Gaynor <alex.gaynor@gmail.com> | 2014-09-25 08:06:01 -0400 |
|---|---|---|
| committer | Alex Gaynor <alex.gaynor@gmail.com> | 2014-09-25 08:06:01 -0400 |
| commit | d31446085ba34f5bacf2631c8adab1ab491bee2e (patch) | |
| tree | 2055832f416c76226459e832cf2d06b32bc0e217 | |
| parent | 903a2b4c7c7d0d7d558e728291b79191a866eff5 (diff) | |
| parent | 9f7ad198955c918c7e4d9a7160dc226779382ac7 (diff) | |
| download | cryptography-d31446085ba34f5bacf2631c8adab1ab491bee2e.tar.gz cryptography-d31446085ba34f5bacf2631c8adab1ab491bee2e.tar.bz2 cryptography-d31446085ba34f5bacf2631c8adab1ab491bee2e.zip | |
Merge pull request #1347 from reaperhulk/doc-cleanup
small cleanup to docs
| -rw-r--r-- | docs/development/test-vectors.rst | 30 | ||||
| -rw-r--r-- | docs/spelling_wordlist.txt | 7 |
2 files changed, 15 insertions, 22 deletions
diff --git a/docs/development/test-vectors.rst b/docs/development/test-vectors.rst index e9ab6123..32128681 100644 --- a/docs/development/test-vectors.rst +++ b/docs/development/test-vectors.rst @@ -99,29 +99,29 @@ Creating test vectors --------------------- When official vectors are unavailable ``cryptography`` may choose to build -its own using existing vectors as source material. +its own using existing vectors as source material. Current custom vectors ~~~~~~~~~~~~~~~~~~~~~~ -* ec_private_key.pem - Contains an Elliptic Curve key generated by OpenSSL - from the curve secp256r1. -* ec_private_key_encrypted.pem - Contains the same Elliptic Curve key as - ec_private_key.pem, except that it is encrypted with AES-256 with the +* ``ec_private_key.pem`` - Contains an Elliptic Curve key generated by OpenSSL + from the curve ``secp256r1``. +* ``ec_private_key_encrypted.pem`` - Contains the same Elliptic Curve key as + ``ec_private_key.pem``, except that it is encrypted with AES-256 with the password "123456". -* ec_public_key.pem - Contains the public key corresponding to - ec_private_key.pem, generated using OpenSSL. -* rsa_private_key.pem - Contains an RSA 2048 bit key generated using +* ``ec_public_key.pem`` - Contains the public key corresponding to + ``ec_private_key.pem``, generated using OpenSSL. +* ``rsa_private_key.pem`` - Contains an RSA 2048 bit key generated using OpenSSL, protected by the secret "123456" with DES3 encryption. -* rsa_public_key.pem - Contains an RSA 2048 bit public generated using - OpenSSL from rsa_private_key.pem. -* dsaparam.pem - Contains 2048-bit DSA parameters generated using OpenSSL; +* ``rsa_public_key.pem`` - Contains an RSA 2048 bit public generated using + OpenSSL from ``rsa_private_key.pem``. +* ``dsaparam.pem`` - Contains 2048-bit DSA parameters generated using OpenSSL; contains no keys. -* dsa_private_key.pem - Contains a DSA 2048 bit key generated using - OpenSSL from the parameters in dsaparam.pem, protected by the secret +* ``dsa_private_key.pem`` - Contains a DSA 2048 bit key generated using + OpenSSL from the parameters in ``dsaparam.pem``, protected by the secret "123456" with DES3 encryption. -* dsa_public_key.pem - Contains a DSA 2048 bit key generated using OpenSSL - from dsa_private_key.pem. +* ``dsa_public_key.pem`` - Contains a DSA 2048 bit key generated using OpenSSL + from ``dsa_private_key.pem``. .. toctree:: :maxdepth: 1 diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt index 47be985f..b16026f6 100644 --- a/docs/spelling_wordlist.txt +++ b/docs/spelling_wordlist.txt @@ -20,9 +20,6 @@ decrypting deserialize deserialized Docstrings -dsa -dsaparam -ec fernet Fernet hazmat @@ -36,16 +33,12 @@ Lange metadata namespace namespaces -pem pickleable plaintext preprocessor preprocessors pseudorandom pyOpenSSL -rsa -secp -secp256r1 Schneier scrypt Solaris |