diff options
author | Paul Kehrer <paul.l.kehrer@gmail.com> | 2017-10-11 19:49:57 +0800 |
---|---|---|
committer | Alex Gaynor <alex.gaynor@gmail.com> | 2017-10-11 07:49:57 -0400 |
commit | 1aac78c4d036d20e8892f3861ea947cadf6ab739 (patch) | |
tree | bb432229f698e613a554f23b9ec95b8ff2d20a8a /docs/hazmat/primitives/asymmetric | |
parent | a3facfae09c881b8a1953ffd7b192debc58bb5a0 (diff) | |
download | cryptography-1aac78c4d036d20e8892f3861ea947cadf6ab739.tar.gz cryptography-1aac78c4d036d20e8892f3861ea947cadf6ab739.tar.bz2 cryptography-1aac78c4d036d20e8892f3861ea947cadf6ab739.zip |
let's talk about bits baby (#3956)
Diffstat (limited to 'docs/hazmat/primitives/asymmetric')
-rw-r--r-- | docs/hazmat/primitives/asymmetric/dsa.rst | 4 | ||||
-rw-r--r-- | docs/hazmat/primitives/asymmetric/ec.rst | 14 | ||||
-rw-r--r-- | docs/hazmat/primitives/asymmetric/rsa.rst | 8 |
3 files changed, 13 insertions, 13 deletions
diff --git a/docs/hazmat/primitives/asymmetric/dsa.rst b/docs/hazmat/primitives/asymmetric/dsa.rst index 57b4a960..9da7273e 100644 --- a/docs/hazmat/primitives/asymmetric/dsa.rst +++ b/docs/hazmat/primitives/asymmetric/dsa.rst @@ -17,8 +17,8 @@ Generation Generate a DSA private key from the given key size. This function will generate a new set of parameters and key in one step. - :param int key_size: The length of the modulus in bits. It should be - either 1024, 2048 or 3072. For keys generated in 2015 this should + :param int key_size: The length of the modulus in :term:`bits`. It should + be either 1024, 2048 or 3072. For keys generated in 2015 this should be `at least 2048`_ (See page 41). Note that some applications (such as SSH) have not yet gained support for larger key sizes specified in FIPS 186-3 and are still restricted to only the diff --git a/docs/hazmat/primitives/asymmetric/ec.rst b/docs/hazmat/primitives/asymmetric/ec.rst index 50c38e3e..0bb74c6f 100644 --- a/docs/hazmat/primitives/asymmetric/ec.rst +++ b/docs/hazmat/primitives/asymmetric/ec.rst @@ -268,7 +268,7 @@ is faster than diffie-hellman`_. .. note:: Curves with a size of `less than 224 bits`_ should not be used. You should - strongly consider using curves of at least 224 bits. + strongly consider using curves of at least 224 :term:`bits`. Generally the NIST prime field ("P") curves are significantly faster than the other types suggested by NIST at both signing and verifying with ECDSA. @@ -415,8 +415,8 @@ Key Interfaces :type: int - Size (in bits) of a secret scalar for the curve (as generated by - :func:`generate_private_key`). + Size (in :term:`bits`) of a secret scalar for the curve (as generated + by :func:`generate_private_key`). .. class:: EllipticCurveSignatureAlgorithm @@ -490,8 +490,8 @@ Key Interfaces :type: int - Size (in bits) of a secret scalar for the curve (as generated by - :func:`generate_private_key`). + Size (in :term:`bits`) of a secret scalar for the curve (as generated + by :func:`generate_private_key`). .. class:: EllipticCurvePrivateKeyWithSerialization @@ -593,8 +593,8 @@ Key Interfaces :type: int - Size (in bits) of a secret scalar for the curve (as generated by - :func:`generate_private_key`). + Size (in :term:`bits`) of a secret scalar for the curve (as generated + by :func:`generate_private_key`). .. class:: EllipticCurvePublicKeyWithSerialization diff --git a/docs/hazmat/primitives/asymmetric/rsa.rst b/docs/hazmat/primitives/asymmetric/rsa.rst index a49b4d34..607cebb1 100644 --- a/docs/hazmat/primitives/asymmetric/rsa.rst +++ b/docs/hazmat/primitives/asymmetric/rsa.rst @@ -19,9 +19,9 @@ mathematical properties`_. .. versionadded:: 0.5 Generates a new RSA private key using the provided ``backend``. - ``key_size`` describes how many bits long the key should be, larger keys - provide more security, currently ``1024`` and below are considered - breakable, and ``2048`` or ``4096`` are reasonable default key sizes for + ``key_size`` describes how many :term:`bits` long the key should be. Larger + keys provide more security; currently ``1024`` and below are considered + breakable while ``2048`` or ``4096`` are reasonable default key sizes for new keys. The ``public_exponent`` indicates what one mathematical property of the key generation will be. Unless you have a specific reason to do otherwise, you should always `use 65537`_. @@ -40,7 +40,7 @@ mathematical properties`_. Usually one of the small Fermat primes 3, 5, 17, 257, 65537. If in doubt you should `use 65537`_. - :param int key_size: The length of the modulus in bits. For keys + :param int key_size: The length of the modulus in :term:`bits`. For keys generated in 2015 it is strongly recommended to be `at least 2048`_ (See page 41). It must not be less than 512. Some backends may have additional limitations. |