diff options
| author | Alex Gaynor <alex.gaynor@gmail.com> | 2013-12-17 07:35:34 -0800 |
|---|---|---|
| committer | Alex Gaynor <alex.gaynor@gmail.com> | 2013-12-17 07:35:34 -0800 |
| commit | 875b36be29e6bcfd1cb2a9cb216aba49c1d9d2f0 (patch) | |
| tree | 71372f15c53afdd4bf2459e9a4774f3d526075a5 /docs/hazmat/backends/index.rst | |
| parent | 4eec0bb4e1d79f107f40b3856f2c9ec76c3eef88 (diff) | |
| parent | a4aa420cc6c0203d201a0f418af68d1f11abbcf5 (diff) | |
| download | cryptography-875b36be29e6bcfd1cb2a9cb216aba49c1d9d2f0.tar.gz cryptography-875b36be29e6bcfd1cb2a9cb216aba49c1d9d2f0.tar.bz2 cryptography-875b36be29e6bcfd1cb2a9cb216aba49c1d9d2f0.zip | |
Merge branch 'master' into no-more-generator
Conflicts:
tests/hazmat/primitives/utils.py
Diffstat (limited to 'docs/hazmat/backends/index.rst')
| -rw-r--r-- | docs/hazmat/backends/index.rst | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/hazmat/backends/index.rst b/docs/hazmat/backends/index.rst new file mode 100644 index 00000000..a89cf0d5 --- /dev/null +++ b/docs/hazmat/backends/index.rst @@ -0,0 +1,34 @@ +.. hazmat:: + +Bindings +======== + +.. toctree:: + :maxdepth: 1 + + openssl + interfaces + + +Getting a Backend Provider +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. currentmodule:: cryptography.hazmat.backends + +``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`. + |