From 14971b7c3a1a5d43363b76506e6a3d1881d7d51f Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Thu, 13 Feb 2014 12:56:14 -0800 Subject: Fixed a missing word in the RSA docs --- docs/hazmat/primitives/rsa.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) (limited to 'docs/hazmat') diff --git a/docs/hazmat/primitives/rsa.rst b/docs/hazmat/primitives/rsa.rst index a19ada33..0c7be2c2 100644 --- a/docs/hazmat/primitives/rsa.rst +++ b/docs/hazmat/primitives/rsa.rst @@ -8,7 +8,7 @@ RSA `RSA`_ is a `public-key`_ algorithm for encrypting and signing messages. .. class:: RSAPrivateKey(p, q, private_exponent, public_exponent, modulus) - + .. versionadded:: 0.2 An RSA private key is required for decryption and signing of messages. @@ -16,23 +16,23 @@ RSA You should use :meth:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPrivateKey.generate` to generate new keys. - + .. warning:: This method only checks a limited set of properties of its arguments. - Using an RSA that you do not trust or with incorrect parameters may - lead to insecure operation, crashes, and other undefined behavior. We - recommend that you only ever load private keys that were generated with - software you trust. + Using an RSA private key that you do not trust or with incorrect + parameters may lead to insecure operation, crashes, and other undefined + behavior. We recommend that you only ever load private keys that were + generated with software you trust. This class conforms to the :class:`~cryptography.hazmat.primitives.interfaces.RSAPrivateKey` interface. - :raises TypeError: This is raised when the arguments are not all integers. + :raises TypeError: This is raised when the arguments are not all integers. :raises ValueError: This is raised when the values of `p`, `q`, - `private_exponent`, `public_exponent` or `modulus` do + `private_exponent`, `public_exponent` or `modulus` do not match the bounds specified in `RFC 3447`_. .. classmethod:: generate(public_exponent, key_size, backend) @@ -52,7 +52,7 @@ RSA :return: A new instance of ``RSAPrivateKey``. .. class:: RSAPublicKey(public_exponent, modulus) - + .. versionadded:: 0.2 An RSA public key is required for encryption and verification of messages. @@ -65,7 +65,7 @@ RSA :class:`~cryptography.hazmat.primitives.interfaces.RSAPublicKey` interface. - :raises TypeError: This is raised when the arguments are not all integers. + :raises TypeError: This is raised when the arguments are not all integers. :raises ValueError: This is raised when the values of `public_exponent` or `modulus` do not match the bounds specified in -- cgit v1.2.3 From a9d802a8364bff9f511db28b4c57bce3498b937d Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Thu, 13 Feb 2014 12:57:57 -0800 Subject: Also clean up this syntax --- docs/hazmat/primitives/rsa.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'docs/hazmat') diff --git a/docs/hazmat/primitives/rsa.rst b/docs/hazmat/primitives/rsa.rst index 0c7be2c2..2875b209 100644 --- a/docs/hazmat/primitives/rsa.rst +++ b/docs/hazmat/primitives/rsa.rst @@ -31,9 +31,10 @@ RSA :raises TypeError: This is raised when the arguments are not all integers. - :raises ValueError: This is raised when the values of `p`, `q`, - `private_exponent`, `public_exponent` or `modulus` do - not match the bounds specified in `RFC 3447`_. + :raises ValueError: This is raised when the values of ``p``, ``q``, + ``private_exponent``, ``public_exponent``, or + ``modulus`` do not match the bounds specified in + :rfc:`3447`. .. classmethod:: generate(public_exponent, key_size, backend) @@ -67,12 +68,11 @@ RSA :raises TypeError: This is raised when the arguments are not all integers. - :raises ValueError: This is raised when the values of `public_exponent` or - `modulus` do not match the bounds specified in - `RFC 3447`_. + :raises ValueError: This is raised when the values of ``public_exponent`` + or ``modulus`` do not match the bounds specified in + :rfc:`3447`. .. _`RSA`: https://en.wikipedia.org/wiki/RSA_(cryptosystem) .. _`public-key`: https://en.wikipedia.org/wiki/Public-key_cryptography -.. _`RFC 3447`: https://tools.ietf.org/html/rfc3447 .. _`use 65537`: http://www.daemonology.net/blog/2009-06-11-cryptographic-right-answers.html .. _`at least 2048`: http://www.ecrypt.eu.org/documents/D.SPA.20.pdf -- cgit v1.2.3