diff options
author | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-04-24 16:21:05 -0500 |
---|---|---|
committer | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-04-24 16:21:05 -0500 |
commit | dcf63ab6bcee9d5a4ae837186db8f0804ddca62c (patch) | |
tree | 1c7e5904c9e52f9da377ef2eb4d10a731bd7fb6f | |
parent | 13ec5478f95cdffc7f0d224c80eb1a595a2538b0 (diff) | |
parent | 239d51834dd1fb22030e9d83563fe5fa63fe2696 (diff) | |
download | cryptography-dcf63ab6bcee9d5a4ae837186db8f0804ddca62c.tar.gz cryptography-dcf63ab6bcee9d5a4ae837186db8f0804ddca62c.tar.bz2 cryptography-dcf63ab6bcee9d5a4ae837186db8f0804ddca62c.zip |
Merge pull request #963 from alex/docs-typo
Some docs fixes
-rw-r--r-- | docs/hazmat/backends/interfaces.rst | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/docs/hazmat/backends/interfaces.rst b/docs/hazmat/backends/interfaces.rst index 3ed4cfb6..0349901a 100644 --- a/docs/hazmat/backends/interfaces.rst +++ b/docs/hazmat/backends/interfaces.rst @@ -307,12 +307,12 @@ A specific ``backend`` may provide one or more of these interfaces. .. method:: generate_dsa_parameters(key_size) - :param int key_size: The length of the modulus in bits. It should be - either "1024, 2048 or 3072". For keys generated in 2014 this should + :param int key_size: The length of the modulus in bits. It should be + either 1024, 2048 or 3072. For keys generated in 2014 this should be at least 2048. - 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 1024-bit keys specified in FIPS 186-2. + 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 1024-bit keys specified in FIPS 186-2. :return: A new instance of a :class:`~cryptography.hazmat.primitives.interfaces.DSAParameters` @@ -328,9 +328,10 @@ A specific ``backend`` may provide one or more of these interfaces. :class:`~cryptography.hazmat.primitives.interfaces.DSAPrivateKey` provider. - :raises ValueError: This is raised if the key size is not (1024 or 2048 or 3072) - or if the OpenSSL version is older than 1.0.0 and the key size is larger than 1024 - because older OpenSSL versions don't support a key size larger than 1024. + :raises ValueError: This is raised if the key size is not one of 1024, + 2048, or 3072. It is also raised when OpenSSL is older than version + 1.0.0 and the key size is larger than 1024; older OpenSSL versions + do not support keys larger than 1024 bits. .. class:: CMACBackend |