diff options
| author | David Reid <dreid@dreid.org> | 2013-11-25 09:45:52 -0800 |
|---|---|---|
| committer | David Reid <dreid@dreid.org> | 2013-11-25 09:45:52 -0800 |
| commit | d5d085e056936ffec5461f313edda195690cd636 (patch) | |
| tree | 890d19530a5934e0d8b78b3348b9d5316eb24ae3 /docs/hazmat/bindings | |
| parent | 9a1b0c75518e6eb2b4c0cb8fd35d94dad124ccd6 (diff) | |
| download | cryptography-d5d085e056936ffec5461f313edda195690cd636.tar.gz cryptography-d5d085e056936ffec5461f313edda195690cd636.tar.bz2 cryptography-d5d085e056936ffec5461f313edda195690cd636.zip | |
Put some docs for default_backend in a place.
Diffstat (limited to 'docs/hazmat/bindings')
| -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`. + |