From 6d02e2ddfd87f0fd06a70d56ad1a2167ceec5232 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Mon, 30 Sep 2013 10:37:22 -0700 Subject: Make the lib and ffi public for the OpenSSL binding and document them --- docs/bindings/index.rst | 7 +++++++ docs/bindings/openssl.rst | 23 +++++++++++++++++++++++ docs/index.rst | 1 + 3 files changed, 31 insertions(+) create mode 100644 docs/bindings/index.rst create mode 100644 docs/bindings/openssl.rst (limited to 'docs') 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..144ed9b3 --- /dev/null +++ b/docs/bindings/openssl.rst @@ -0,0 +1,23 @@ +OpenSSL +======= + +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/ diff --git a/docs/index.rst b/docs/index.rst index c8f63883..5cc455f6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -32,5 +32,6 @@ Contents architecture primitives/index + bindings/index contributing community -- cgit v1.2.3