diff options
author | Alex Gaynor <alex.gaynor@gmail.com> | 2014-12-24 15:46:29 -0800 |
---|---|---|
committer | Alex Gaynor <alex.gaynor@gmail.com> | 2014-12-24 15:46:29 -0800 |
commit | e710dd9991aee2bfb53f2c2d1756d5f9a89f7193 (patch) | |
tree | 826e5c159474cab5d06c9669b751ffe356b91183 /docs/hazmat/primitives/asymmetric | |
parent | 06f6a4e7b2e89e588c75c4bf755c1bd0563f9e28 (diff) | |
download | cryptography-e710dd9991aee2bfb53f2c2d1756d5f9a89f7193.tar.gz cryptography-e710dd9991aee2bfb53f2c2d1756d5f9a89f7193.tar.bz2 cryptography-e710dd9991aee2bfb53f2c2d1756d5f9a89f7193.zip |
Removed documentation for features which were removed
Diffstat (limited to 'docs/hazmat/primitives/asymmetric')
-rw-r--r-- | docs/hazmat/primitives/asymmetric/serialization.rst | 82 |
1 files changed, 0 insertions, 82 deletions
diff --git a/docs/hazmat/primitives/asymmetric/serialization.rst b/docs/hazmat/primitives/asymmetric/serialization.rst index b523c342..c184cdf2 100644 --- a/docs/hazmat/primitives/asymmetric/serialization.rst +++ b/docs/hazmat/primitives/asymmetric/serialization.rst @@ -114,88 +114,6 @@ all begin with ``-----BEGIN {format}-----`` and end with ``-----END is not supported by the backend. -PKCS #8 Format -~~~~~~~~~~~~~~ - -PKCS #8 is a serialization format originally standardized by RSA and currently -maintained by the IETF in :rfc:`5208` and :rfc:`5958`. It supports password -based encryption and additional key metadata attributes. These keys are -recognizable because they all begin with ``-----BEGIN PRIVATE KEY-----`` or -with ``-----BEGIN ENCRYPTED PRIVATE KEY-----`` if they have a password. - - -.. function:: load_pem_pkcs8_private_key(data, password, backend) - - .. versionadded:: 0.5 - - Deserialize a private key from PEM encoded data to one of the supported - asymmetric private key types. - - This has been deprecated in favor of :func:`load_pem_private_key`. - - :param bytes data: The PEM encoded key data. - - :param bytes password: The password to use to decrypt the data. Should - be ``None`` if the private key is not encrypted. - - :param backend: A - :class:`~cryptography.hazmat.backends.interfaces.PKCS8SerializationBackend` - provider. - - :returns: A new instance of a private key. - - :raises ValueError: If the PEM data could not be decrypted or if its - structure could not be decoded successfully. - - :raises TypeError: If a ``password`` was given and the private key was - not encrypted. Or if the key was encrypted but no - password was supplied. - - :raises UnsupportedAlgorithm: If the serialized key is of a type that - is not supported by the backend or if the key is encrypted with a - symmetric cipher that is not supported by the backend. - - -Traditional OpenSSL Format -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The "traditional" PKCS #1 based serialization format used by OpenSSL. It -supports password based symmetric key encryption. Commonly found in OpenSSL -based TLS applications. It is usually found in PEM format with a header that -mentions the type of the serialized key. e.g. ``-----BEGIN RSA PRIVATE -KEY-----`` or ``-----BEGIN DSA PRIVATE KEY-----``. - -.. function:: load_pem_traditional_openssl_private_key(data, password, backend) - - .. versionadded:: 0.5 - - Deserialize a private key from PEM encoded data to one of the supported - asymmetric private key types. - - This has been deprecated in favor of :func:`load_pem_private_key`. - - :param bytes data: The PEM encoded key data. - - :param bytes password: The password to use to decrypt the data. Should - be ``None`` if the private key is not encrypted. - - :param backend: A - :class:`~cryptography.hazmat.backends.interfaces.TraditionalOpenSSLSerializationBackend` - provider. - - :returns: A new instance of a private key. - - :raises ValueError: If the PEM data could not be decrypted or if its - structure could not be decoded successfully. - - :raises TypeError: If a ``password`` was given and the private key was - not encrypted. Or if the key was encrypted but no - password was supplied. - - :raises UnsupportedAlgorithm: If the serialized key is of a type that - is not supported by the backend or if the key is encrypted with a - symmetric cipher that is not supported by the backend. - OpenSSH Public Key ~~~~~~~~~~~~~~~~~~ |