aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat/bindings
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2014-01-02 10:56:08 -0800
committerAlex Gaynor <alex.gaynor@gmail.com>2014-01-02 10:56:08 -0800
commit267dbc946b4584b7b4ed10a439b2820d3b048356 (patch)
tree45fea345889584b74496359496ba202cf4c60802 /docs/hazmat/bindings
parent71e8ca0d79d8599f1f00d6ec18cb19a2ffabfc8d (diff)
parenta6d5d6ec53da5bea0193047c5e535a05442f2dfd (diff)
downloadcryptography-267dbc946b4584b7b4ed10a439b2820d3b048356.tar.gz
cryptography-267dbc946b4584b7b4ed10a439b2820d3b048356.tar.bz2
cryptography-267dbc946b4584b7b4ed10a439b2820d3b048356.zip
Merge branch 'master' into validate-iv
Conflicts: cryptography/hazmat/primitives/ciphers/modes.py
Diffstat (limited to 'docs/hazmat/bindings')
-rw-r--r--docs/hazmat/bindings/index.rst22
-rw-r--r--docs/hazmat/bindings/openssl.rst27
2 files changed, 49 insertions, 0 deletions
diff --git a/docs/hazmat/bindings/index.rst b/docs/hazmat/bindings/index.rst
new file mode 100644
index 00000000..809eddfc
--- /dev/null
+++ b/docs/hazmat/bindings/index.rst
@@ -0,0 +1,22 @@
+.. hazmat::
+
+Bindings
+========
+
+.. currentmodule:: cryptography.hazmat.bindings
+
+``cryptography`` aims to provide low-level CFFI based bindings to multiple
+native C libraries. These provide no automatic initialisation of the library
+and may not provide complete wrappers for its API.
+
+Using these functions directly is likely to require you to be careful in
+managing memory allocation, locking and other resources.
+
+
+Individual Bindings
+-------------------
+
+.. toctree::
+ :maxdepth: 1
+
+ openssl
diff --git a/docs/hazmat/bindings/openssl.rst b/docs/hazmat/bindings/openssl.rst
new file mode 100644
index 00000000..373fe472
--- /dev/null
+++ b/docs/hazmat/bindings/openssl.rst
@@ -0,0 +1,27 @@
+.. hazmat::
+
+OpenSSL Binding
+===============
+
+.. currentmodule:: cryptography.hazmat.bindings.openssl.binding
+
+These are `CFFI`_ bindings to the `OpenSSL`_ C library.
+
+.. class:: cryptography.hazmat.bindings.openssl.binding.Binding()
+
+ This is the exposed API for the OpenSSL bindings. It has two public
+ attributes:
+
+ .. attribute:: ffi
+
+ This is a :class:`cffi.FFI` instance. It can be used to allocate and
+ otherwise manipulate OpenSSL structures.
+
+ .. attribute:: lib
+
+ This is a ``cffi`` library. It can be used to call OpenSSL functions,
+ and access constants.
+
+
+.. _`CFFI`: https://cffi.readthedocs.org/
+.. _`OpenSSL`: https://www.openssl.org/