diff options
| author | Alex Gaynor <alex.gaynor@gmail.com> | 2013-09-30 10:37:22 -0700 |
|---|---|---|
| committer | Alex Gaynor <alex.gaynor@gmail.com> | 2013-09-30 10:37:22 -0700 |
| commit | 6d02e2ddfd87f0fd06a70d56ad1a2167ceec5232 (patch) | |
| tree | 5334be3cae172e5b66965ec1b7bf0d603989ebc6 /docs/bindings | |
| parent | d59a0485bc8195efcc476e4362cb3bb47e89d9e8 (diff) | |
| download | cryptography-6d02e2ddfd87f0fd06a70d56ad1a2167ceec5232.tar.gz cryptography-6d02e2ddfd87f0fd06a70d56ad1a2167ceec5232.tar.bz2 cryptography-6d02e2ddfd87f0fd06a70d56ad1a2167ceec5232.zip | |
Make the lib and ffi public for the OpenSSL binding and document them
Diffstat (limited to 'docs/bindings')
| -rw-r--r-- | docs/bindings/index.rst | 7 | ||||
| -rw-r--r-- | docs/bindings/openssl.rst | 23 |
2 files changed, 30 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..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/ |