aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2014-01-31 11:44:53 -0800
committerAlex Gaynor <alex.gaynor@gmail.com>2014-01-31 11:44:53 -0800
commit031c2cb544478b4dee341bcf76fb359ad8ac788a (patch)
tree4eb398b13aa67365492da23989b55e75132d0c8a /docs/hazmat
parent719c8970188a354a466c0464ad0445e1b4ce2d6d (diff)
downloadcryptography-031c2cb544478b4dee341bcf76fb359ad8ac788a.tar.gz
cryptography-031c2cb544478b4dee341bcf76fb359ad8ac788a.tar.bz2
cryptography-031c2cb544478b4dee341bcf76fb359ad8ac788a.zip
Fixes #539 -- document which interfaces a backend implements
Diffstat (limited to 'docs/hazmat')
-rw-r--r--docs/hazmat/backends/commoncrypto.rst9
-rw-r--r--docs/hazmat/backends/openssl.rst11
2 files changed, 18 insertions, 2 deletions
diff --git a/docs/hazmat/backends/commoncrypto.rst b/docs/hazmat/backends/commoncrypto.rst
index af2032b6..7bf1bc42 100644
--- a/docs/hazmat/backends/commoncrypto.rst
+++ b/docs/hazmat/backends/commoncrypto.rst
@@ -11,7 +11,14 @@ 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.
+
+ * :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