aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2014-05-31 12:05:38 -0500
committerPaul Kehrer <paul.l.kehrer@gmail.com>2014-05-31 12:05:38 -0500
commit286c7dc91f8a95ed19791f8b15a6759897f2563e (patch)
treef5bfb033b64651054294a1567710d8e917601d56 /docs
parent35f190c4d3b6b61304b4124849bbc07b44f314bb (diff)
downloadcryptography-286c7dc91f8a95ed19791f8b15a6759897f2563e.tar.gz
cryptography-286c7dc91f8a95ed19791f8b15a6759897f2563e.tar.bz2
cryptography-286c7dc91f8a95ed19791f8b15a6759897f2563e.zip
add some missing docs for PKCS8SerializationBackend, update changelog
Diffstat (limited to 'docs')
-rw-r--r--docs/hazmat/backends/interfaces.rst22
-rw-r--r--docs/hazmat/backends/openssl.rst2
2 files changed, 24 insertions, 0 deletions
diff --git a/docs/hazmat/backends/interfaces.rst b/docs/hazmat/backends/interfaces.rst
index 78a35cd9..6f24f906 100644
--- a/docs/hazmat/backends/interfaces.rst
+++ b/docs/hazmat/backends/interfaces.rst
@@ -454,3 +454,25 @@ A specific ``backend`` may provide one or more of these interfaces.
:returns:
:class:`~cryptography.hazmat.primitives.interfaces.CMACContext`
+
+
+.. class:: PKCS8SerializationBackend
+
+ .. versionadded:: 0.5
+
+ A backend with methods for working with PKCS #8 key serialization.
+
+ .. method:: load_pkcs8_pem_private_key(data, password)
+
+ :param bytes data: PEM data to deserialize.
+
+ :param bytes password: The password to use if this data is encrypted.
+ Should be None if the data is not encrypted.
+
+ :return: A new instance of the appropriate private key or public key
+ that the serialized data contains.
+
+ :raises ValueError: If the data could not be deserialized correctly.
+
+ :raises cryptography.exceptions.UnsupportedAlgorithm: If the data is
+ encrypted with an unsupported algorithm.
diff --git a/docs/hazmat/backends/openssl.rst b/docs/hazmat/backends/openssl.rst
index 6ad0d045..e829798a 100644
--- a/docs/hazmat/backends/openssl.rst
+++ b/docs/hazmat/backends/openssl.rst
@@ -19,7 +19,9 @@ Red Hat Enterprise Linux 5) and greater. Earlier versions may work but are
* :class:`~cryptography.hazmat.backends.interfaces.HashBackend`
* :class:`~cryptography.hazmat.backends.interfaces.HMACBackend`
* :class:`~cryptography.hazmat.backends.interfaces.PBKDF2HMACBackend`
+ * :class:`~cryptography.hazmat.backends.interfaces.PKCS8SerializationBackend`
* :class:`~cryptography.hazmat.backends.interfaces.RSABackend`
+ * :class:`~cryptography.hazmat.backends.interfaces.TraditionalOpenSSLSerializationBackend`
It also exposes the following: