aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat/backends/openssl.rst
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2013-12-15 22:17:59 -0800
committerAlex Gaynor <alex.gaynor@gmail.com>2013-12-15 22:17:59 -0800
commit4a35b7fede2d8e544abfbe9b1ea0d11231da9908 (patch)
tree01ef45be7d510501965717ad4a39fd9c54a19053 /docs/hazmat/backends/openssl.rst
parentc3f7c37f5718b5deb08edb41125d8c7fb3733cfc (diff)
parentffb7726fa3042e66e8011fbd17a8b6f83f0c8110 (diff)
downloadcryptography-4a35b7fede2d8e544abfbe9b1ea0d11231da9908.tar.gz
cryptography-4a35b7fede2d8e544abfbe9b1ea0d11231da9908.tar.bz2
cryptography-4a35b7fede2d8e544abfbe9b1ea0d11231da9908.zip
Merge branch 'master' into fernet
Diffstat (limited to 'docs/hazmat/backends/openssl.rst')
-rw-r--r--docs/hazmat/backends/openssl.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/hazmat/backends/openssl.rst b/docs/hazmat/backends/openssl.rst
new file mode 100644
index 00000000..12fbff04
--- /dev/null
+++ b/docs/hazmat/backends/openssl.rst
@@ -0,0 +1,25 @@
+.. hazmat::
+
+OpenSSL
+=======
+
+These are `CFFI`_ bindings to the `OpenSSL`_ C library.
+
+.. data:: cryptography.hazmat.backends.openssl.backend
+
+ 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/