aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat/backends/index.rst
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2013-12-13 20:28:55 -0800
committerAlex Gaynor <alex.gaynor@gmail.com>2013-12-13 20:28:55 -0800
commitf8796b15a279db82cdefcd00bebfef4cdef8fee8 (patch)
treed356e592a7a174f356a8f5b9904860b95e9a0312 /docs/hazmat/backends/index.rst
parentb9dd85c661f405099a88b7a76aefde5f59a6b985 (diff)
downloadcryptography-f8796b15a279db82cdefcd00bebfef4cdef8fee8.tar.gz
cryptography-f8796b15a279db82cdefcd00bebfef4cdef8fee8.tar.bz2
cryptography-f8796b15a279db82cdefcd00bebfef4cdef8fee8.zip
Renamed bindings to backends
Diffstat (limited to 'docs/hazmat/backends/index.rst')
-rw-r--r--docs/hazmat/backends/index.rst34
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`.
+