diff options
author | Alex Gaynor <alex.gaynor@gmail.com> | 2013-11-27 08:48:53 -0600 |
---|---|---|
committer | Alex Gaynor <alex.gaynor@gmail.com> | 2013-11-27 08:48:53 -0600 |
commit | bb30eb160045181b0c91fc9f2d8f374d65c2c13b (patch) | |
tree | 46009a3261034571d1549f36f5c5d196cbd2f7a7 /docs/hazmat/bindings/index.rst | |
parent | 3c25f61c18c6f8f9a2210fb2124654023bcec775 (diff) | |
parent | e60e1d782cb7c1abe68811092f7db342ed14b81f (diff) | |
download | cryptography-bb30eb160045181b0c91fc9f2d8f374d65c2c13b.tar.gz cryptography-bb30eb160045181b0c91fc9f2d8f374d65c2c13b.tar.bz2 cryptography-bb30eb160045181b0c91fc9f2d8f374d65c2c13b.zip |
Merge branch 'master' into validate-iv
Conflicts:
tests/hazmat/primitives/test_block.py
Diffstat (limited to 'docs/hazmat/bindings/index.rst')
-rw-r--r-- | docs/hazmat/bindings/index.rst | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/hazmat/bindings/index.rst b/docs/hazmat/bindings/index.rst index 11355bfa..746f4596 100644 --- a/docs/hazmat/bindings/index.rst +++ b/docs/hazmat/bindings/index.rst @@ -8,3 +8,27 @@ Bindings openssl interfaces + + +Getting a Backend Provider +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. currentmodule:: cryptography.hazmat.bindings + +``cryptography`` aims to support multiple backends to ensure it can provide +the widest number of supported cryptographic algorithms as well as supporting +platform specific implementations. + +You can get the default backend by calling +:func:`~default_backend`. + +The default backend will change over time as we implement new backends and +the libraries we use in those backends changes. + + +.. function:: default_backend() + + :returns: An object that provides at least + :class:`~interfaces.CipherBackend`, :class:`~interfaces.HashBackend`, and + :class:`~interfaces.HMACBackend`. + |