diff options
| author | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-02-12 23:59:59 -0600 |
|---|---|---|
| committer | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-02-12 23:59:59 -0600 |
| commit | b393bdcbc637768ad774e8404f2efcbdd7f1e8c5 (patch) | |
| tree | b2f9254b37e4cfb9799f27f7ef73eae5109a46a2 /docs/hazmat | |
| parent | 09328bbfb3306d3c7b02a44f12ecd22ce3ec700e (diff) | |
| download | cryptography-b393bdcbc637768ad774e8404f2efcbdd7f1e8c5.tar.gz cryptography-b393bdcbc637768ad774e8404f2efcbdd7f1e8c5.tar.bz2 cryptography-b393bdcbc637768ad774e8404f2efcbdd7f1e8c5.zip | |
update constructor docs for rsa
Diffstat (limited to 'docs/hazmat')
| -rw-r--r-- | docs/hazmat/primitives/rsa.rst | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/docs/hazmat/primitives/rsa.rst b/docs/hazmat/primitives/rsa.rst index a19ada33..4925366a 100644 --- a/docs/hazmat/primitives/rsa.rst +++ b/docs/hazmat/primitives/rsa.rst @@ -7,8 +7,9 @@ RSA `RSA`_ is a `public-key`_ algorithm for encrypting and signing messages. -.. class:: RSAPrivateKey(p, q, private_exponent, public_exponent, modulus) - +.. class:: RSAPrivateKey(p, q, private_exponent, dmp1, dmq1, iqmp, + public_exponent, modulus) + .. versionadded:: 0.2 An RSA private key is required for decryption and signing of messages. @@ -16,7 +17,7 @@ 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 @@ -29,10 +30,10 @@ RSA :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 +53,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 +66,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 |