diff options
Diffstat (limited to 'docs/hazmat/backends')
| -rw-r--r-- | docs/hazmat/backends/commoncrypto.rst | 5 | ||||
| -rw-r--r-- | docs/hazmat/backends/index.rst | 4 | ||||
| -rw-r--r-- | docs/hazmat/backends/interfaces.rst | 18 | ||||
| -rw-r--r-- | docs/hazmat/backends/openssl.rst | 10 |
4 files changed, 27 insertions, 10 deletions
diff --git a/docs/hazmat/backends/commoncrypto.rst b/docs/hazmat/backends/commoncrypto.rst index 16a61337..77d6612c 100644 --- a/docs/hazmat/backends/commoncrypto.rst +++ b/docs/hazmat/backends/commoncrypto.rst @@ -1,9 +1,10 @@ .. hazmat:: -CommonCrypto Backend +CommonCrypto backend ==================== -The `CommonCrypto`_ C library provided by Apple on OS X and iOS. +The `CommonCrypto`_ C library provided by Apple on OS X and iOS. The CommonCrypto +backend is only supported on OS X versions 10.8 and above. .. currentmodule:: cryptography.hazmat.backends.commoncrypto.backend diff --git a/docs/hazmat/backends/index.rst b/docs/hazmat/backends/index.rst index 983a44e9..aec7a1e0 100644 --- a/docs/hazmat/backends/index.rst +++ b/docs/hazmat/backends/index.rst @@ -3,7 +3,7 @@ Backends ======== -Getting a Backend +Getting a backend ----------------- .. currentmodule:: cryptography.hazmat.backends @@ -24,7 +24,7 @@ the libraries we use in those backends changes. :class:`~interfaces.CipherBackend`, :class:`~interfaces.HashBackend`, and :class:`~interfaces.HMACBackend`. -Individual Backends +Individual backends ------------------- .. toctree:: diff --git a/docs/hazmat/backends/interfaces.rst b/docs/hazmat/backends/interfaces.rst index af19fbc6..c38f818f 100644 --- a/docs/hazmat/backends/interfaces.rst +++ b/docs/hazmat/backends/interfaces.rst @@ -1,6 +1,6 @@ .. hazmat:: -Backend Interfaces +Backend interfaces ================== .. currentmodule:: cryptography.hazmat.backends.interfaces @@ -249,6 +249,20 @@ A specific ``backend`` may provide one or more of these interfaces. :returns: :class:`~cryptography.hazmat.primitives.interfaces.AsymmetricVerificationContext` + .. method:: mgf1_hash_supported(algorithm) + + Check if the specified ``algorithm`` is supported for use with + :class:`~cryptography.hazmat.primitives.asymmetric.padding.MGF1` + inside :class:`~cryptography.hazmat.primitives.asymmetric.padding.PSS` + padding. + + :param algorithm: An instance of a + :class:`~cryptography.hazmat.primitives.interfaces.HashAlgorithm` + provider. + + :returns: ``True`` if the specified ``algorithm`` is supported by this + backend, otherwise ``False``. + .. class:: OpenSSLSerializationBackend @@ -258,7 +272,7 @@ A specific ``backend`` may provide one or more of these interfaces. style key serialization. .. method:: load_openssl_pem_private_key(data, password) - + :param bytes data: PEM data to deserialize. :param bytes password: The password to use if this data is encrypted. diff --git a/docs/hazmat/backends/openssl.rst b/docs/hazmat/backends/openssl.rst index d6351c9c..fdfadf0b 100644 --- a/docs/hazmat/backends/openssl.rst +++ b/docs/hazmat/backends/openssl.rst @@ -1,9 +1,11 @@ .. hazmat:: -OpenSSL Backend +OpenSSL backend =============== -The `OpenSSL`_ C library. +The `OpenSSL`_ C library. Cryptography supports version ``0.9.8e`` (present in +Red Hat Enterprise Linux 5) and greater. Earlier versions may work but are +**not tested or supported**. .. data:: cryptography.hazmat.backends.openssl.backend @@ -32,7 +34,7 @@ The `OpenSSL`_ C library. This will activate the default OpenSSL CSPRNG. -OS Random Engine +OS random engine ---------------- OpenSSL uses a user-space CSPRNG that is seeded from system random ( @@ -56,7 +58,7 @@ When importing only the binding it is added to the engine list but **not activated**. -OS Random Sources +OS random sources ----------------- On OS X and FreeBSD ``/dev/urandom`` is an alias for ``/dev/random`` and |