diff options
| author | David Reid <dreid@dreid.org> | 2014-01-31 16:04:14 -0800 |
|---|---|---|
| committer | David Reid <dreid@dreid.org> | 2014-01-31 16:04:14 -0800 |
| commit | 390d38e264eaccff1cd285624146710fff5f8775 (patch) | |
| tree | de25d7fb426075150c339a658b17e8d1a367a391 | |
| parent | 719c8970188a354a466c0464ad0445e1b4ce2d6d (diff) | |
| parent | 8ca6fadca6b4c8805c241382e24d87c127cff306 (diff) | |
| download | cryptography-390d38e264eaccff1cd285624146710fff5f8775.tar.gz cryptography-390d38e264eaccff1cd285624146710fff5f8775.tar.bz2 cryptography-390d38e264eaccff1cd285624146710fff5f8775.zip | |
Merge pull request #540 from alex/document-interfaces
Fixes #539 -- document which interfaces a backend implements
| -rw-r--r-- | docs/hazmat/backends/commoncrypto.rst | 11 | ||||
| -rw-r--r-- | docs/hazmat/backends/openssl.rst | 11 |
2 files changed, 20 insertions, 2 deletions
diff --git a/docs/hazmat/backends/commoncrypto.rst b/docs/hazmat/backends/commoncrypto.rst index af2032b6..16a61337 100644 --- a/docs/hazmat/backends/commoncrypto.rst +++ b/docs/hazmat/backends/commoncrypto.rst @@ -11,7 +11,16 @@ The `CommonCrypto`_ C library provided by Apple on OS X and iOS. .. data:: cryptography.hazmat.backends.commoncrypto.backend - This is the exposed API for the CommonCrypto backend. It has one public attribute. + This is the exposed API for the CommonCrypto backend. + + It implements the following interfaces: + + * :class:`~cryptography.hazmat.backends.interfaces.CipherBackend` + * :class:`~cryptography.hazmat.backends.interfaces.HashBackend` + * :class:`~cryptography.hazmat.backends.interfaces.HMACBackend` + * :class:`~cryptography.hazmat.backends.interfaces.PBKDF2HMACBackend` + + It has one additional public attribute. .. attribute:: name diff --git a/docs/hazmat/backends/openssl.rst b/docs/hazmat/backends/openssl.rst index 12d2d9f6..4db3972d 100644 --- a/docs/hazmat/backends/openssl.rst +++ b/docs/hazmat/backends/openssl.rst @@ -7,7 +7,16 @@ The `OpenSSL`_ C library. .. data:: cryptography.hazmat.backends.openssl.backend - This is the exposed API for the OpenSSL backend. It has one public attribute. + This is the exposed API for the OpenSSL backend. + + It implements the following interfaces: + + * :class:`~cryptography.hazmat.backends.interfaces.CipherBackend` + * :class:`~cryptography.hazmat.backends.interfaces.HashBackend` + * :class:`~cryptography.hazmat.backends.interfaces.HMACBackend` + * :class:`~cryptography.hazmat.backends.interfaces.PBKDF2HMACBackend` + + It has one additional public attribute. .. attribute:: name |