diff options
| author | Alex Gaynor <alex.gaynor@gmail.com> | 2013-11-26 09:31:06 -0800 |
|---|---|---|
| committer | Alex Gaynor <alex.gaynor@gmail.com> | 2013-11-26 09:31:06 -0800 |
| commit | e60e1d782cb7c1abe68811092f7db342ed14b81f (patch) | |
| tree | 555ed6a8cecd2759fd22dfbb41f6d61fd46b7788 /docs/hazmat/bindings/index.rst | |
| parent | 90501724c5b3d73fea5a4242fa09c32277c6c210 (diff) | |
| parent | 6dc73a9bd475dfb7a3c18c65afaeb644cce3749f (diff) | |
| download | cryptography-e60e1d782cb7c1abe68811092f7db342ed14b81f.tar.gz cryptography-e60e1d782cb7c1abe68811092f7db342ed14b81f.tar.bz2 cryptography-e60e1d782cb7c1abe68811092f7db342ed14b81f.zip | |
Merge pull request #227 from dreid/explicit-backend-in-hazmat
Explicit backend
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`. + |