aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat/bindings/interfaces.rst
diff options
context:
space:
mode:
authorDavid Reid <dreid@dreid.org>2013-11-15 15:32:14 -0800
committerDavid Reid <dreid@dreid.org>2013-11-18 09:57:19 -0800
commit2a746ce5a4e4b69c9c8fa3ab0e90fb87b053a186 (patch)
tree21825d6160b6afc0e48def98b5b2324dea0521c1 /docs/hazmat/bindings/interfaces.rst
parentdf3a462da843955f658d5ab3174799368d57f16b (diff)
downloadcryptography-2a746ce5a4e4b69c9c8fa3ab0e90fb87b053a186.tar.gz
cryptography-2a746ce5a4e4b69c9c8fa3ab0e90fb87b053a186.tar.bz2
cryptography-2a746ce5a4e4b69c9c8fa3ab0e90fb87b053a186.zip
Start documenting the backend interfaces.
Diffstat (limited to 'docs/hazmat/bindings/interfaces.rst')
-rw-r--r--docs/hazmat/bindings/interfaces.rst43
1 files changed, 43 insertions, 0 deletions
diff --git a/docs/hazmat/bindings/interfaces.rst b/docs/hazmat/bindings/interfaces.rst
new file mode 100644
index 00000000..2f163267
--- /dev/null
+++ b/docs/hazmat/bindings/interfaces.rst
@@ -0,0 +1,43 @@
+.. hazmat::
+
+Backend Interfaces
+==================
+
+.. currentmodule:: cryptography.hazmat.bindings.interfaces
+
+
+.. class:: CipherBackend
+
+ .. method:: cipher_supported(cipher, mode)
+
+ pass
+
+ .. method:: register_cipher_adapter(cipher_cls, mode_cls, adapter)
+
+ pass
+
+ .. method:: create_symmetric_encryption_ctx(cipher, mode)
+
+ pass
+
+ .. method:: create_symmetric_decryption_ctx(cipher, mode)
+
+ pass
+
+
+.. class:: HashBackend
+
+ .. method:: hash_supported(algorithm)
+
+ pass
+
+ .. method:: create_hash_ctx(algorithm)
+
+ pass
+
+
+.. class:: HMACBackend
+
+ .. method:: create_hmac_ctx(algorithm)
+
+ pass