diff options
| author | Alex Gaynor <alex.gaynor@gmail.com> | 2013-11-27 08:45:31 -0600 |
|---|---|---|
| committer | Alex Gaynor <alex.gaynor@gmail.com> | 2013-11-27 08:45:31 -0600 |
| commit | 4b3326eef8e5b2694609701e4fdbdd58cbf96c99 (patch) | |
| tree | b0725c7195ff528e1a118f1e0df618dec8b65ef7 /docs/hazmat/bindings | |
| parent | be91a92cddf6fc54bc6069b2299a650a2edad104 (diff) | |
| parent | e60e1d782cb7c1abe68811092f7db342ed14b81f (diff) | |
| download | cryptography-4b3326eef8e5b2694609701e4fdbdd58cbf96c99.tar.gz cryptography-4b3326eef8e5b2694609701e4fdbdd58cbf96c99.tar.bz2 cryptography-4b3326eef8e5b2694609701e4fdbdd58cbf96c99.zip | |
Merge branch 'master' into fernet
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`. + |