aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat/backends
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2014-02-08 09:10:30 -0600
committerPaul Kehrer <paul.l.kehrer@gmail.com>2014-02-08 09:10:30 -0600
commit96f31fd81b9d5f29adf5290e1630a79d89039538 (patch)
treefc85c3614a223f1f1eed4c715e2b29a28e209fb7 /docs/hazmat/backends
parent41ace0a57d8e45b8034237a617ccc9fcaf45f4d4 (diff)
parent209a132abcfbcbe70a0864d664ab7a4fce136ef9 (diff)
downloadcryptography-96f31fd81b9d5f29adf5290e1630a79d89039538.tar.gz
cryptography-96f31fd81b9d5f29adf5290e1630a79d89039538.tar.bz2
cryptography-96f31fd81b9d5f29adf5290e1630a79d89039538.zip
Merge pull request #577 from public/backend-rsa-interface
RSABackend interface
Diffstat (limited to 'docs/hazmat/backends')
-rw-r--r--docs/hazmat/backends/interfaces.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/hazmat/backends/interfaces.rst b/docs/hazmat/backends/interfaces.rst
index 5131ca12..444ecb46 100644
--- a/docs/hazmat/backends/interfaces.rst
+++ b/docs/hazmat/backends/interfaces.rst
@@ -191,3 +191,24 @@ A specific ``backend`` may provide one or more of these interfaces.
the derived key. This is typically a password.
:return bytes: Derived key.
+
+
+.. class:: RSABackend
+
+ .. versionadded:: 0.2
+
+ A backend with methods for using RSA.
+
+ .. method:: generate_rsa_private_key(public_exponent, bit_length)
+
+ :param int public_exponent: The public exponent of the new key.
+ Often one of the small Fermat primes 3, 5, 17, 257 or 65537.
+
+ :param int bit_length: The length in bits of the modulus. Should be
+ at least 2048.
+
+ :return: A new instance of a
+ :class:`~cryptography.hazmat.primitives.interfaces.RSAPrivateKey`
+ provider.
+
+ :raises ValueError: If the public_exponent is not valid.