aboutsummaryrefslogtreecommitdiffstats
path: root/docs/bindings
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2013-10-16 16:55:40 -0700
committerAlex Gaynor <alex.gaynor@gmail.com>2013-10-16 16:55:40 -0700
commite761f8b33519104605b14cf8a24e9f68bd23b624 (patch)
tree672968fa7c23790bc9f5c9cd3c779adce09fae8c /docs/bindings
parent62ebc7e212a92a13c3836de5d129cb93f40a128d (diff)
parent169dee88faa7c46b5551b89cf97a1b30c0a1c6ea (diff)
downloadcryptography-e761f8b33519104605b14cf8a24e9f68bd23b624.tar.gz
cryptography-e761f8b33519104605b14cf8a24e9f68bd23b624.tar.bz2
cryptography-e761f8b33519104605b14cf8a24e9f68bd23b624.zip
Merge branch 'master' into triple-des
Also moved most of the tests to the new format except for one which doesn't yet have an obvious translation Conflicts: cryptography/primitives/block/ciphers.py tests/primitives/test_nist.py
Diffstat (limited to 'docs/bindings')
-rw-r--r--docs/bindings/index.rst7
-rw-r--r--docs/bindings/openssl.rst30
2 files changed, 37 insertions, 0 deletions
diff --git a/docs/bindings/index.rst b/docs/bindings/index.rst
new file mode 100644
index 00000000..80f53594
--- /dev/null
+++ b/docs/bindings/index.rst
@@ -0,0 +1,7 @@
+Bindings
+========
+
+.. toctree::
+ :maxdepth: 1
+
+ openssl
diff --git a/docs/bindings/openssl.rst b/docs/bindings/openssl.rst
new file mode 100644
index 00000000..241cc4d6
--- /dev/null
+++ b/docs/bindings/openssl.rst
@@ -0,0 +1,30 @@
+OpenSSL
+=======
+
+.. warning::
+
+ The OpenSSL API is not easy to use, small mistakes can lead to significant
+ security vulnerabilities. We strongly recommend not using this directly,
+ and instead using one of the higher level APIs exposed by ``cryptography``.
+
+
+These are `CFFI`_ bindings to the `OpenSSL`_ C library.
+
+.. data:: cryptography.bindings.openssl.api
+
+ 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`: http://cffi.readthedocs.org/
+.. _`OpenSSL`: https://www.openssl.org/