From a9e31b35cb1cfd4489294b6f93eb8ea0f07641fb Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Fri, 10 Jan 2014 00:03:03 -0600 Subject: commoncrypto backend docs --- docs/hazmat/backends/common-crypto.rst | 28 ++++++++++++++++++++++++++++ docs/hazmat/backends/index.rst | 1 + 2 files changed, 29 insertions(+) create mode 100644 docs/hazmat/backends/common-crypto.rst (limited to 'docs') diff --git a/docs/hazmat/backends/common-crypto.rst b/docs/hazmat/backends/common-crypto.rst new file mode 100644 index 00000000..edd45b6b --- /dev/null +++ b/docs/hazmat/backends/common-crypto.rst @@ -0,0 +1,28 @@ +.. hazmat:: + +CommonCrypto Backend +==================== + +These are `CFFI`_ bindings to the `CommonCrypto`_ C library provided by Apple +on OS X and iOS. + +.. currentmodule:: cryptography.hazmat.backends.commoncrypto.backend + +.. data:: cryptography.hazmat.backends.commoncrypto.backend + + This is the exposed API for the CommonCrypto bindings. It has two public + attributes: + + .. attribute:: ffi + + This is a :class:`cffi.FFI` instance. It can be used to allocate and + otherwise manipulate CommonCrypto structures. + + .. attribute:: lib + + This is a ``cffi`` library. It can be used to call CommonCrypto + functions, and access constants. + + +.. _`CFFI`: https://cffi.readthedocs.org/ +.. _`CommonCrypto`: https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man3/Common%20Crypto.3cc.html diff --git a/docs/hazmat/backends/index.rst b/docs/hazmat/backends/index.rst index 06951281..22354f69 100644 --- a/docs/hazmat/backends/index.rst +++ b/docs/hazmat/backends/index.rst @@ -31,4 +31,5 @@ Individual Backends :maxdepth: 1 openssl + common-crypto interfaces -- cgit v1.2.3 From 602d4005b856eb638e59aa1d2a3359e144bb0196 Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Sat, 11 Jan 2014 20:09:38 -0600 Subject: add iOS to wordlist --- docs/spelling_wordlist.txt | 1 + 1 file changed, 1 insertion(+) (limited to 'docs') diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt index 97356c24..b17bcde0 100644 --- a/docs/spelling_wordlist.txt +++ b/docs/spelling_wordlist.txt @@ -26,3 +26,4 @@ Changelog Docstrings Fernet Schneier +iOS -- cgit v1.2.3 From 007e5e11d761a9d05adf7f074c8fdda427c38b10 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Sun, 12 Jan 2014 14:25:49 -0800 Subject: Verify the tag len for GCM --- docs/hazmat/primitives/symmetric-encryption.rst | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'docs') diff --git a/docs/hazmat/primitives/symmetric-encryption.rst b/docs/hazmat/primitives/symmetric-encryption.rst index 83165690..7d954046 100644 --- a/docs/hazmat/primitives/symmetric-encryption.rst +++ b/docs/hazmat/primitives/symmetric-encryption.rst @@ -324,6 +324,11 @@ Modes return (iv, ciphertext, encryptor.tag) def decrypt(key, associated_data, iv, ciphertext, tag): + if len(tag) != 16: + raise ValueError( + "tag must be 16 bytes -- truncation not supported" + ) + # Construct a Cipher object, with the key, iv, and additionally the # GCM tag used for authenticating the message. decryptor = Cipher( -- cgit v1.2.3 From eb656bd97fe5eaac3bb54e3c3c73cbceddcb87b8 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Thu, 16 Jan 2014 14:43:37 -0600 Subject: Don't require sphinx spelling to be installed, for readthedocs benefit --- docs/conf.py | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index a42dcb22..fbd6d57b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,6 +19,11 @@ try: except ImportError: sphinx_rtd_theme = None +try: + from sphinxcontrib import spelling +except ImportError: + spelling = None + # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the @@ -38,9 +43,11 @@ extensions = [ 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode', 'cryptography-docs', - 'sphinxcontrib.spelling', ] +if spelling is not None: + extensions.append('sphinxcontrib.spelling') + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] -- cgit v1.2.3 From dd97bfef26c28cd2a91e8fe7ad13cbfbd9535299 Mon Sep 17 00:00:00 2001 From: David Reid Date: Thu, 16 Jan 2014 19:46:22 -0800 Subject: Specify the epub theme to fix the epub build on RTD. --- docs/conf.py | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index fbd6d57b..3486fb38 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -270,3 +270,5 @@ texinfo_documents = [ # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = {'http://docs.python.org/': None} + +epub_theme = 'epub' -- cgit v1.2.3 From 8ea6a82864ef0074b5b0b6e8327fd155b5075a12 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Fri, 17 Jan 2014 16:08:46 -0600 Subject: Document when the common crypto bindings were added --- docs/changelog.rst | 5 ++++- docs/hazmat/bindings/commoncrypto.rst | 2 ++ 2 files changed, 6 insertions(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/changelog.rst b/docs/changelog.rst index 41db635e..289992f4 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -1,9 +1,12 @@ Changelog ========= + 0.2 - 2014-XX-XX ~~~~~~~~~~~~~~~~ -* In development. +**In development** + +* Added initial CommonCrypto bindings. 0.1 - 2014-01-08 ~~~~~~~~~~~~~~~~ diff --git a/docs/hazmat/bindings/commoncrypto.rst b/docs/hazmat/bindings/commoncrypto.rst index 25535e02..c4f614c2 100644 --- a/docs/hazmat/bindings/commoncrypto.rst +++ b/docs/hazmat/bindings/commoncrypto.rst @@ -5,6 +5,8 @@ CommonCrypto Binding .. currentmodule:: cryptography.hazmat.bindings.commoncrypto.binding +.. versionadded:: 0.2 + These are `CFFI`_ bindings to the `CommonCrypto`_ C library. It is available on Mac OS X. -- cgit v1.2.3 From 2502ce599b39509ba9c05b6e553527e5ed5ac43c Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Sat, 18 Jan 2014 09:32:47 -0600 Subject: docs for explicit backend selection and document name attribute of backend --- docs/contributing.rst | 10 ++++++++++ docs/hazmat/backends/openssl.rst | 6 +++++- 2 files changed, 15 insertions(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/contributing.rst b/docs/contributing.rst index 8e32c368..3710abee 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -250,6 +250,16 @@ each supported Python version and run the tests. For example: You may not have all the required Python versions installed, in which case you will see one or more ``InterpreterNotFound`` errors. + +Explicit Backend Selection +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +While testing you may want to run tests against a subset of the backends that +cryptography supports. Explicit backend selection can be done via the +``--backend`` flag. This flag should be passed to ``py.test`` with a comma +delimited list of backend names. To use it with ``tox`` you must pass it as +``-- --backend``. + Building Documentation ~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/hazmat/backends/openssl.rst b/docs/hazmat/backends/openssl.rst index 404573a3..042ee87d 100644 --- a/docs/hazmat/backends/openssl.rst +++ b/docs/hazmat/backends/openssl.rst @@ -7,7 +7,11 @@ The `OpenSSL`_ C library. .. data:: cryptography.hazmat.backends.openssl.backend - This is the exposed API for the OpenSSL backend. It has no public attributes. + This is the exposed API for the OpenSSL backend. It has one public attribute. + + .. attribute:: name + + The string name of the backend. Using your own OpenSSL on Linux ------------------------------- -- cgit v1.2.3 From 12656e53baf6d66a2a0a83aed9711407a4cf7818 Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Sun, 19 Jan 2014 12:15:54 -0600 Subject: update docs, add name attribute to backend --- docs/hazmat/backends/common-crypto.rst | 18 ++++-------------- 1 file changed, 4 insertions(+), 14 deletions(-) (limited to 'docs') diff --git a/docs/hazmat/backends/common-crypto.rst b/docs/hazmat/backends/common-crypto.rst index edd45b6b..ad4cc210 100644 --- a/docs/hazmat/backends/common-crypto.rst +++ b/docs/hazmat/backends/common-crypto.rst @@ -3,26 +3,16 @@ CommonCrypto Backend ==================== -These are `CFFI`_ bindings to the `CommonCrypto`_ C library provided by Apple -on OS X and iOS. +The `CommonCrypto`_ C library provided by Apple on OS X and iOS. .. currentmodule:: cryptography.hazmat.backends.commoncrypto.backend .. data:: cryptography.hazmat.backends.commoncrypto.backend - This is the exposed API for the CommonCrypto bindings. It has two public - attributes: + This is the exposed API for the OpenSSL backend. It has one public attribute. - .. attribute:: ffi + .. attribute:: name - This is a :class:`cffi.FFI` instance. It can be used to allocate and - otherwise manipulate CommonCrypto structures. + The string name of the backend. - .. attribute:: lib - - This is a ``cffi`` library. It can be used to call CommonCrypto - functions, and access constants. - - -.. _`CFFI`: https://cffi.readthedocs.org/ .. _`CommonCrypto`: https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man3/Common%20Crypto.3cc.html -- cgit v1.2.3 From d6b8dfab17705f2fa2a49395f2b689b0b7d51b38 Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Sun, 19 Jan 2014 13:26:21 -0600 Subject: increase indent and note the value of the attribute in the docs --- docs/hazmat/backends/common-crypto.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/hazmat/backends/common-crypto.rst b/docs/hazmat/backends/common-crypto.rst index ad4cc210..afff9a16 100644 --- a/docs/hazmat/backends/common-crypto.rst +++ b/docs/hazmat/backends/common-crypto.rst @@ -11,8 +11,8 @@ The `CommonCrypto`_ C library provided by Apple on OS X and iOS. This is the exposed API for the OpenSSL backend. It has one public attribute. - .. attribute:: name + .. attribute:: name - The string name of the backend. + Returns ``commoncrypto``, the string name of this backend. .. _`CommonCrypto`: https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man3/Common%20Crypto.3cc.html -- cgit v1.2.3 From 4925575af6f949aaf83f2504c00cb979cc547162 Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Sun, 19 Jan 2014 13:29:06 -0600 Subject: fix copy mistake in docs --- docs/hazmat/backends/common-crypto.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/hazmat/backends/common-crypto.rst b/docs/hazmat/backends/common-crypto.rst index afff9a16..64e95ccb 100644 --- a/docs/hazmat/backends/common-crypto.rst +++ b/docs/hazmat/backends/common-crypto.rst @@ -9,7 +9,7 @@ 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 OpenSSL backend. It has one public attribute. + This is the exposed API for the CommonCrypto backend. It has one public attribute. .. attribute:: name -- cgit v1.2.3 From 5882361dbd8b0f6f9c7933b173bc933cbd90097a Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Sun, 19 Jan 2014 13:31:35 -0600 Subject: update docs for name attribute --- docs/hazmat/backends/openssl.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/hazmat/backends/openssl.rst b/docs/hazmat/backends/openssl.rst index 042ee87d..b0bd3ae0 100644 --- a/docs/hazmat/backends/openssl.rst +++ b/docs/hazmat/backends/openssl.rst @@ -9,9 +9,9 @@ The `OpenSSL`_ C library. This is the exposed API for the OpenSSL backend. It has one public attribute. - .. attribute:: name + .. attribute:: name - The string name of the backend. + Returns ``openssl``, the string name of this backend. Using your own OpenSSL on Linux ------------------------------- -- cgit v1.2.3 From ab6fa0a7f56fbfe3e5c13844969f1ac276ba79e2 Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Sun, 19 Jan 2014 13:57:15 -0600 Subject: doc updates --- docs/hazmat/backends/common-crypto.rst | 4 ++-- docs/spelling_wordlist.txt | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/hazmat/backends/common-crypto.rst b/docs/hazmat/backends/common-crypto.rst index 64e95ccb..6127116b 100644 --- a/docs/hazmat/backends/common-crypto.rst +++ b/docs/hazmat/backends/common-crypto.rst @@ -11,8 +11,8 @@ The `CommonCrypto`_ C library provided by Apple on OS X and iOS. This is the exposed API for the CommonCrypto backend. It has one public attribute. - .. attribute:: name + .. attribute:: name - Returns ``commoncrypto``, the string name of this backend. + The string name of this backend: ``"commoncrypto"`` .. _`CommonCrypto`: https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man3/Common%20Crypto.3cc.html diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt index b17bcde0..75628ba5 100644 --- a/docs/spelling_wordlist.txt +++ b/docs/spelling_wordlist.txt @@ -14,6 +14,7 @@ hazmat indistinguishability introspectability invariants +iOS pickleable plaintext testability @@ -26,4 +27,3 @@ Changelog Docstrings Fernet Schneier -iOS -- cgit v1.2.3 From cfa2d6275e9c31e6fc61109e4853c5687d16532e Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Sun, 19 Jan 2014 14:01:25 -0600 Subject: fix docs --- docs/hazmat/backends/openssl.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/hazmat/backends/openssl.rst b/docs/hazmat/backends/openssl.rst index b0bd3ae0..a1f2d28a 100644 --- a/docs/hazmat/backends/openssl.rst +++ b/docs/hazmat/backends/openssl.rst @@ -9,9 +9,9 @@ The `OpenSSL`_ C library. This is the exposed API for the OpenSSL backend. It has one public attribute. - .. attribute:: name + .. attribute:: name - Returns ``openssl``, the string name of this backend. + The string name of this backend: ``"openssl"`` Using your own OpenSSL on Linux ------------------------------- -- cgit v1.2.3 From 6d913a6a8ebd063c0d8f630ef8e805906e94ef45 Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Sun, 19 Jan 2014 14:04:12 -0600 Subject: changelog to note addition of commoncrypto backend with hash support --- docs/changelog.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'docs') diff --git a/docs/changelog.rst b/docs/changelog.rst index 289992f4..b0baf912 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -6,6 +6,7 @@ Changelog **In development** +* Added CommonCrypto backend with hash support. * Added initial CommonCrypto bindings. 0.1 - 2014-01-08 -- cgit v1.2.3 From 6ce4bb78e7d4c597b1594479d99caa73e9c5c73a Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Sun, 19 Jan 2014 14:29:28 -0600 Subject: added versionadded --- docs/hazmat/backends/common-crypto.rst | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs') diff --git a/docs/hazmat/backends/common-crypto.rst b/docs/hazmat/backends/common-crypto.rst index 6127116b..af2032b6 100644 --- a/docs/hazmat/backends/common-crypto.rst +++ b/docs/hazmat/backends/common-crypto.rst @@ -7,6 +7,8 @@ The `CommonCrypto`_ C library provided by Apple on OS X and iOS. .. currentmodule:: cryptography.hazmat.backends.commoncrypto.backend +.. versionadded:: 0.2 + .. data:: cryptography.hazmat.backends.commoncrypto.backend This is the exposed API for the CommonCrypto backend. It has one public attribute. -- cgit v1.2.3 From 0192692f18d059e0c1f5f5345a8bfe71cc46c8c4 Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Sun, 19 Jan 2014 13:54:53 -0600 Subject: hmac support for commoncrypto --- docs/changelog.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/changelog.rst b/docs/changelog.rst index b0baf912..82d3bf05 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -6,7 +6,7 @@ Changelog **In development** -* Added CommonCrypto backend with hash support. +* Added CommonCrypto backend with hash and HMAC support. * Added initial CommonCrypto bindings. 0.1 - 2014-01-08 -- cgit v1.2.3 From b74658ec6e752e9a510434af23ffad69ed7e4f93 Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Sun, 19 Jan 2014 17:09:22 -0600 Subject: doc updates --- docs/changelog.rst | 5 +++-- docs/hazmat/backends/common-crypto.rst | 20 -------------------- docs/hazmat/backends/commoncrypto.rst | 20 ++++++++++++++++++++ docs/hazmat/backends/index.rst | 2 +- 4 files changed, 24 insertions(+), 23 deletions(-) delete mode 100644 docs/hazmat/backends/common-crypto.rst create mode 100644 docs/hazmat/backends/commoncrypto.rst (limited to 'docs') diff --git a/docs/changelog.rst b/docs/changelog.rst index 82d3bf05..819b426a 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -6,10 +6,11 @@ Changelog **In development** -* Added CommonCrypto backend with hash and HMAC support. -* Added initial CommonCrypto bindings. +* Added :doc:`/hazmat/backends/commoncrypto` with hash and HMAC support. +* Added initial :doc:`/hazmat/bindings/commoncrypto`. 0.1 - 2014-01-08 ~~~~~~~~~~~~~~~~ * Initial release. + diff --git a/docs/hazmat/backends/common-crypto.rst b/docs/hazmat/backends/common-crypto.rst deleted file mode 100644 index af2032b6..00000000 --- a/docs/hazmat/backends/common-crypto.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. hazmat:: - -CommonCrypto Backend -==================== - -The `CommonCrypto`_ C library provided by Apple on OS X and iOS. - -.. currentmodule:: cryptography.hazmat.backends.commoncrypto.backend - -.. versionadded:: 0.2 - -.. data:: cryptography.hazmat.backends.commoncrypto.backend - - This is the exposed API for the CommonCrypto backend. It has one public attribute. - - .. attribute:: name - - The string name of this backend: ``"commoncrypto"`` - -.. _`CommonCrypto`: https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man3/Common%20Crypto.3cc.html diff --git a/docs/hazmat/backends/commoncrypto.rst b/docs/hazmat/backends/commoncrypto.rst new file mode 100644 index 00000000..af2032b6 --- /dev/null +++ b/docs/hazmat/backends/commoncrypto.rst @@ -0,0 +1,20 @@ +.. hazmat:: + +CommonCrypto Backend +==================== + +The `CommonCrypto`_ C library provided by Apple on OS X and iOS. + +.. currentmodule:: cryptography.hazmat.backends.commoncrypto.backend + +.. versionadded:: 0.2 + +.. data:: cryptography.hazmat.backends.commoncrypto.backend + + This is the exposed API for the CommonCrypto backend. It has one public attribute. + + .. attribute:: name + + The string name of this backend: ``"commoncrypto"`` + +.. _`CommonCrypto`: https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man3/Common%20Crypto.3cc.html diff --git a/docs/hazmat/backends/index.rst b/docs/hazmat/backends/index.rst index 22354f69..dbc0724e 100644 --- a/docs/hazmat/backends/index.rst +++ b/docs/hazmat/backends/index.rst @@ -31,5 +31,5 @@ Individual Backends :maxdepth: 1 openssl - common-crypto + commoncrypto interfaces -- cgit v1.2.3 From ad4f646e685beb38e597bab83ea8e8314a3fd581 Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Mon, 20 Jan 2014 09:36:57 -0600 Subject: expand tox backend example --- docs/contributing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/contributing.rst b/docs/contributing.rst index 3710abee..4bb1461d 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -258,7 +258,7 @@ While testing you may want to run tests against a subset of the backends that cryptography supports. Explicit backend selection can be done via the ``--backend`` flag. This flag should be passed to ``py.test`` with a comma delimited list of backend names. To use it with ``tox`` you must pass it as -``-- --backend``. +``tox -- --backend=openssl``. Building Documentation ~~~~~~~~~~~~~~~~~~~~~~ -- cgit v1.2.3 From e2ad5ca3f4ddfdbfcf1c5c64ee5d8dc22877e9ca Mon Sep 17 00:00:00 2001 From: David Reid Date: Mon, 20 Jan 2014 10:08:36 -0800 Subject: Remove register_cipher_adapter from the interface and the documentation. --- docs/hazmat/backends/interfaces.rst | 19 ------------------- 1 file changed, 19 deletions(-) (limited to 'docs') diff --git a/docs/hazmat/backends/interfaces.rst b/docs/hazmat/backends/interfaces.rst index 5b6cd64d..11e2f2a2 100644 --- a/docs/hazmat/backends/interfaces.rst +++ b/docs/hazmat/backends/interfaces.rst @@ -33,25 +33,6 @@ A specific ``backend`` may provide one or more of these interfaces. :returns: ``True`` if the specified ``cipher`` and ``mode`` combination is supported by this backend, otherwise ``False`` - .. method:: register_cipher_adapter(cipher_cls, mode_cls, adapter) - - Register an adapter which can be used to create a backend specific - object from instances of the - :class:`~cryptography.hazmat.primitives.interfaces.CipherAlgorithm` and - the :class:`~cryptography.hazmat.primitives.interfaces.Mode` primitives. - - :param cipher_cls: A class whose instances provide - :class:`~cryptography.hazmat.primitives.interfaces.CipherAlgorithm` - :param mode_cls: A class whose instances provide: - :class:`~cryptography.hazmat.primitives.interfaces.Mode` - :param adapter: A ``function`` that takes 3 arguments, ``backend`` (a - :class:`CipherBackend` provider), ``cipher`` (a - :class:`~cryptography.hazmat.primitives.interfaces.CipherAlgorithm` - provider ), and ``mode`` (a - :class:`~cryptography.hazmat.primitives.interfaces.Mode` provider). - It returns a backend specific object which may be used to construct - a :class:`~cryptogrpahy.hazmat.primitives.interfaces.CipherContext`. - .. method:: create_symmetric_encryption_ctx(cipher, mode) -- cgit v1.2.3 From 2084fa54497b8d80c1ad837bc95c8c6de0c36c4e Mon Sep 17 00:00:00 2001 From: David Reid Date: Mon, 20 Jan 2014 10:48:18 -0800 Subject: Add to changelog. --- docs/changelog.rst | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs') diff --git a/docs/changelog.rst b/docs/changelog.rst index 819b426a..aaca1742 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -8,6 +8,8 @@ Changelog * Added :doc:`/hazmat/backends/commoncrypto` with hash and HMAC support. * Added initial :doc:`/hazmat/bindings/commoncrypto`. +* Removed `register_cipher_adapter` method from + :class:`~cryptography.hazmat.backends.interfaces.CipherBackend`. 0.1 - 2014-01-08 ~~~~~~~~~~~~~~~~ -- cgit v1.2.3 From 5a2494086f8f8215102f2558b12eaca14eebd782 Mon Sep 17 00:00:00 2001 From: David Reid Date: Mon, 20 Jan 2014 10:53:47 -0800 Subject: Moar backtick. --- docs/changelog.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/changelog.rst b/docs/changelog.rst index aaca1742..0a03c396 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -8,7 +8,7 @@ Changelog * Added :doc:`/hazmat/backends/commoncrypto` with hash and HMAC support. * Added initial :doc:`/hazmat/bindings/commoncrypto`. -* Removed `register_cipher_adapter` method from +* Removed ``register_cipher_adapter`` method from :class:`~cryptography.hazmat.backends.interfaces.CipherBackend`. 0.1 - 2014-01-08 -- cgit v1.2.3