From 2a746ce5a4e4b69c9c8fa3ab0e90fb87b053a186 Mon Sep 17 00:00:00 2001 From: David Reid Date: Fri, 15 Nov 2013 15:32:14 -0800 Subject: Start documenting the backend interfaces. --- docs/hazmat/bindings/index.rst | 1 + docs/hazmat/bindings/interfaces.rst | 43 +++++++++++++++++++++++++++++++++++++ 2 files changed, 44 insertions(+) create mode 100644 docs/hazmat/bindings/interfaces.rst (limited to 'docs/hazmat/bindings') diff --git a/docs/hazmat/bindings/index.rst b/docs/hazmat/bindings/index.rst index 19e03999..11355bfa 100644 --- a/docs/hazmat/bindings/index.rst +++ b/docs/hazmat/bindings/index.rst @@ -7,3 +7,4 @@ Bindings :maxdepth: 1 openssl + interfaces 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 -- cgit v1.2.3