diff options
author | Alex Gaynor <alex.gaynor@gmail.com> | 2014-01-02 10:55:36 -0800 |
---|---|---|
committer | Alex Gaynor <alex.gaynor@gmail.com> | 2014-01-02 10:55:36 -0800 |
commit | 5bae063ff2601db15d84920f18bae194bcd3d373 (patch) | |
tree | b6c39a3f84b434ae26245fcda6abe6c1e4165156 /docs/hazmat/bindings | |
parent | 09aa74635f54ace5480a6d502b0da92651f516b6 (diff) | |
parent | a6d5d6ec53da5bea0193047c5e535a05442f2dfd (diff) | |
download | cryptography-5bae063ff2601db15d84920f18bae194bcd3d373.tar.gz cryptography-5bae063ff2601db15d84920f18bae194bcd3d373.tar.bz2 cryptography-5bae063ff2601db15d84920f18bae194bcd3d373.zip |
Merge branch 'master' into fernet
Conflicts:
docs/index.rst
Diffstat (limited to 'docs/hazmat/bindings')
-rw-r--r-- | docs/hazmat/bindings/index.rst | 22 | ||||
-rw-r--r-- | docs/hazmat/bindings/openssl.rst | 27 |
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/ |