diff options
| author | Donald Stufft <donald@stufft.io> | 2013-12-15 20:13:02 -0800 |
|---|---|---|
| committer | Donald Stufft <donald@stufft.io> | 2013-12-15 20:13:02 -0800 |
| commit | ffb7726fa3042e66e8011fbd17a8b6f83f0c8110 (patch) | |
| tree | 0535ae742bacf071a19f74fc487a7d1b66cb092f /docs/hazmat/backends/index.rst | |
| parent | a14c0fe87e4fbc44f566df0378f5af5a18822cb8 (diff) | |
| parent | 41e5ab64e9526c1e759034bafb3d75c1492ff54d (diff) | |
| download | cryptography-ffb7726fa3042e66e8011fbd17a8b6f83f0c8110.tar.gz cryptography-ffb7726fa3042e66e8011fbd17a8b6f83f0c8110.tar.bz2 cryptography-ffb7726fa3042e66e8011fbd17a8b6f83f0c8110.zip | |
Merge pull request #308 from alex/rename-bindings
Renamed bindings to backends
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`. + |