aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat/bindings/openssl.rst
diff options
context:
space:
mode:
authorAlex Stapleton <alexs@prol.etari.at>2013-12-31 13:43:38 +0000
committerAlex Stapleton <alexs@prol.etari.at>2014-01-01 23:48:39 +0000
commitc368ac2edfa21a6686ccd613fe0b889feb05d421 (patch)
treed2035e85ef17023137b35c37768e80dfd3d9c211 /docs/hazmat/bindings/openssl.rst
parent5f4c492c8e9124ac51c27b4e323426003cca47e3 (diff)
downloadcryptography-c368ac2edfa21a6686ccd613fe0b889feb05d421.tar.gz
cryptography-c368ac2edfa21a6686ccd613fe0b889feb05d421.tar.bz2
cryptography-c368ac2edfa21a6686ccd613fe0b889feb05d421.zip
Split OpenSSL binding
Diffstat (limited to 'docs/hazmat/bindings/openssl.rst')
-rw-r--r--docs/hazmat/bindings/openssl.rst27
1 files changed, 27 insertions, 0 deletions
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/