aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat/primitives/asymmetric
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2017-06-24 13:21:20 -1000
committerAlex Gaynor <alex.gaynor@gmail.com>2017-06-24 19:21:20 -0400
commit5bc8c7d801e9134d3de7c793a484ed29ec52aa96 (patch)
tree527fc6557138f750d4bd591c2ad7e1426d23b11f /docs/hazmat/primitives/asymmetric
parent2748e2e4ae923c3d2c29a3a31a702fb85ade0fff (diff)
downloadcryptography-5bc8c7d801e9134d3de7c793a484ed29ec52aa96.tar.gz
cryptography-5bc8c7d801e9134d3de7c793a484ed29ec52aa96.tar.bz2
cryptography-5bc8c7d801e9134d3de7c793a484ed29ec52aa96.zip
doc the relationship between PrivateKey and PrivateKeyWithSerialization (#3721)
* doc the relationship between PrivateKey and PrivateKeyWithSerialization Or at least do it better. * let's talk about opaque keys
Diffstat (limited to 'docs/hazmat/primitives/asymmetric')
-rw-r--r--docs/hazmat/primitives/asymmetric/dh.rst8
-rw-r--r--docs/hazmat/primitives/asymmetric/dsa.rst8
-rw-r--r--docs/hazmat/primitives/asymmetric/ec.rst9
-rw-r--r--docs/hazmat/primitives/asymmetric/rsa.rst8
4 files changed, 25 insertions, 8 deletions
diff --git a/docs/hazmat/primitives/asymmetric/dh.rst b/docs/hazmat/primitives/asymmetric/dh.rst
index f97a328b..c52ee4d1 100644
--- a/docs/hazmat/primitives/asymmetric/dh.rst
+++ b/docs/hazmat/primitives/asymmetric/dh.rst
@@ -142,6 +142,9 @@ Key interfaces
.. versionadded:: 0.9
+ A DH private key that is not an :term:`opaque key` also implements
+ :class:`DHPrivateKeyWithSerialization` to provide serialization methods.
+
.. attribute:: key_size
The bit length of the prime modulus.
@@ -172,8 +175,9 @@ Key interfaces
.. versionadded:: 0.9
- Inherits from
- :class:`~cryptography.hazmat.primitives.asymmetric.dh.DHPrivateKey`.
+ This interface contains additional methods relating to serialization.
+ Any object with this interface also has all the methods from
+ :class:`DHPrivateKey`.
.. method:: private_numbers()
diff --git a/docs/hazmat/primitives/asymmetric/dsa.rst b/docs/hazmat/primitives/asymmetric/dsa.rst
index 13cd0412..a6088190 100644
--- a/docs/hazmat/primitives/asymmetric/dsa.rst
+++ b/docs/hazmat/primitives/asymmetric/dsa.rst
@@ -278,7 +278,9 @@ Key interfaces
.. versionadded:: 0.3
- A `DSA`_ private key.
+ A `DSA`_ private key. A DSA private key that is not an
+ :term:`opaque key` also implements :class:`DSAPrivateKeyWithSerialization`
+ to provide serialization methods.
.. method:: public_key()
@@ -322,7 +324,9 @@ Key interfaces
.. versionadded:: 0.8
- Extends :class:`DSAPrivateKey`.
+ This interface contains additional methods relating to serialization.
+ Any object with this interface also has all the methods from
+ :class:`DSAPrivateKey`.
.. method:: private_numbers()
diff --git a/docs/hazmat/primitives/asymmetric/ec.rst b/docs/hazmat/primitives/asymmetric/ec.rst
index 614d7a32..710c11ca 100644
--- a/docs/hazmat/primitives/asymmetric/ec.rst
+++ b/docs/hazmat/primitives/asymmetric/ec.rst
@@ -441,7 +441,10 @@ Key Interfaces
.. versionadded:: 0.5
An elliptic curve private key for use with an algorithm such as `ECDSA`_ or
- `EdDSA`_.
+ `EdDSA`_. An elliptic curve private key that is not an
+ :term:`opaque key` also implements
+ :class:`EllipticCurvePrivateKeyWithSerialization` to provide serialization
+ methods.
.. method:: exchange(algorithm, peer_public_key)
@@ -495,7 +498,9 @@ Key Interfaces
.. versionadded:: 0.8
- Extends :class:`EllipticCurvePrivateKey`.
+ This interface contains additional methods relating to serialization.
+ Any object with this interface also has all the methods from
+ :class:`EllipticCurvePrivateKey`.
.. method:: private_numbers()
diff --git a/docs/hazmat/primitives/asymmetric/rsa.rst b/docs/hazmat/primitives/asymmetric/rsa.rst
index 152e5ed8..97f68c3a 100644
--- a/docs/hazmat/primitives/asymmetric/rsa.rst
+++ b/docs/hazmat/primitives/asymmetric/rsa.rst
@@ -530,7 +530,9 @@ Key interfaces
.. versionadded:: 0.2
- An `RSA`_ private key.
+ An `RSA`_ private key. An RSA private key that is not an
+ :term:`opaque key` also implements :class:`RSAPrivateKeyWithSerialization`
+ to provide serialization methods.
.. method:: decrypt(ciphertext, padding)
@@ -584,7 +586,9 @@ Key interfaces
.. versionadded:: 0.8
- Extends :class:`RSAPrivateKey`.
+ This interface contains additional methods relating to serialization.
+ Any object with this interface also has all the methods from
+ :class:`RSAPrivateKey`.
.. method:: private_numbers()