aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2014-01-25 14:13:09 -0600
committerPaul Kehrer <paul.l.kehrer@gmail.com>2014-01-25 14:13:09 -0600
commitac423232f884b94a24257e80ac95cccd5749ba9f (patch)
tree44cd38a47b3e69194b978df036dd3b6a4745bef4 /docs/hazmat
parentd062dc8a617f95e4e0b1893f384c482e16f10550 (diff)
downloadcryptography-ac423232f884b94a24257e80ac95cccd5749ba9f.tar.gz
cryptography-ac423232f884b94a24257e80ac95cccd5749ba9f.tar.bz2
cryptography-ac423232f884b94a24257e80ac95cccd5749ba9f.zip
RSA private/public key interface + docs
Diffstat (limited to 'docs/hazmat')
-rw-r--r--docs/hazmat/primitives/interfaces.rst100
1 files changed, 100 insertions, 0 deletions
diff --git a/docs/hazmat/primitives/interfaces.rst b/docs/hazmat/primitives/interfaces.rst
index edb24cd9..40b49a54 100644
--- a/docs/hazmat/primitives/interfaces.rst
+++ b/docs/hazmat/primitives/interfaces.rst
@@ -102,3 +102,103 @@ Interfaces used by the symmetric cipher modes described in
Exact requirements of the nonce are described by the documentation of
individual modes.
+
+Asymmetric Interfaces
+~~~~~~~~~~~~~~~~~~~~~
+
+.. class:: RSAPrivateKey
+
+ An `RSA`_ private key.
+
+ .. attribute:: public_key
+
+ :type: :class:`~cryptography.hazmat.primitives.interfaces.RSAPublicKey`
+
+ An RSA public key object corresponding to the values of the private key.
+
+ .. attribute:: modulus
+
+ :type: str
+
+ Hexadecimal representation of the public modulus. Alias for ``n``.
+
+ .. attribute:: public_exponent
+
+ :type: int
+
+ The public exponent. Alias for ``e``.
+
+ .. attribute:: key_length
+
+ :type: int
+
+ The bit length of the modulus.
+
+ .. attribute:: p
+
+ :type: str
+
+ Hexadecimal representation of ``p``, one of the two primes composing
+ ``n``.
+
+ .. attribute:: q
+
+ :type: str
+
+ Hexadecimal representation of ``q``, one of the two primes composing
+ ``n``.
+
+ .. attribute:: d
+
+ :type: str
+
+ Hexadecimal representation of ``d``, the private exponent.
+
+ .. attribute:: n
+
+ :type: str
+
+ Hexadecimal representation of the public modulus.
+
+ .. attribute:: e
+
+ :type: int
+
+ The public exponent.
+
+
+.. class:: RSAPublicKey
+
+ An `RSA`_ public key.
+
+ .. attribute:: modulus
+
+ :type: str
+
+ Hexadecimal representation of the public modulus. Alias for ``n``.
+
+ .. attribute:: key_length
+
+ :type: int
+
+ The bit length of the modulus.
+
+ .. attribute:: public_exponent
+
+ :type: int
+
+ The public exponent. Alias for ``e``.
+
+ .. attribute:: n
+
+ :type: str
+
+ Hexadecimal representation of the public modulus.
+
+ .. attribute:: e
+
+ :type: int
+
+ The public exponent.
+
+.. _`RSA`: http://en.wikipedia.org/wiki/RSA_(cryptosystem)