aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2014-06-06 22:29:05 -0500
committerPaul Kehrer <paul.l.kehrer@gmail.com>2014-06-06 22:29:05 -0500
commit433e2a78dbafb210ddec13131b66bbb369e57d6d (patch)
tree54beda39a2eaa7c797b3e0a7985e1a4d3f7bb547 /docs
parentc294c1d363dcf3feb227f45c2c31a51f623c70ae (diff)
downloadcryptography-433e2a78dbafb210ddec13131b66bbb369e57d6d.tar.gz
cryptography-433e2a78dbafb210ddec13131b66bbb369e57d6d.tar.bz2
cryptography-433e2a78dbafb210ddec13131b66bbb369e57d6d.zip
add some missing docs
Diffstat (limited to 'docs')
-rw-r--r--docs/hazmat/primitives/asymmetric/rsa.rst21
1 files changed, 18 insertions, 3 deletions
diff --git a/docs/hazmat/primitives/asymmetric/rsa.rst b/docs/hazmat/primitives/asymmetric/rsa.rst
index ff9b0a7b..2056b010 100644
--- a/docs/hazmat/primitives/asymmetric/rsa.rst
+++ b/docs/hazmat/primitives/asymmetric/rsa.rst
@@ -12,9 +12,24 @@ RSA
.. versionadded:: 0.5
- Generate a provider of
- :class:`~cryptography.hazmat.primitives.interfaces.RSAPrivateKey`
- using ``backend``.
+ Generate an RSA private key using the provided ``backend``.
+
+ :param int public_exponent: The public exponent of the new key.
+ 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
+ generated in 2014 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.
+ :param backend: A
+ :class:`~cryptography.hazmat.backends.interfaces.RSABackend`
+ provider.
+ :return: A :class:`~cryptography.hazmat.primitives.interfaces.RSAPrivateKey`
+ provider.
+
+ :raises cryptography.exceptions.UnsupportedAlgorithm: This is raised if
+ the provided ``backend`` does not implement
+ :class:`~cryptography.hazmat.backends.interfaces.RSABackend`
.. class:: RSAPrivateKey(p, q, private_exponent, dmp1, dmq1, iqmp, public_exponent, modulus)