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 +++++++++++++++++++++++ 2 files changed, 30 insertions(+) create mode 100644 docs/bindings/index.rst create mode 100644 docs/bindings/openssl.rst (limited to 'docs/bindings') 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/ -- cgit v1.2.3 From 0f7f7813ebf7b1fb52f0bab1c6c26321bf9cd5d9 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Mon, 30 Sep 2013 10:52:36 -0700 Subject: Put a warning --- docs/bindings/openssl.rst | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'docs/bindings') diff --git a/docs/bindings/openssl.rst b/docs/bindings/openssl.rst index 144ed9b3..79468cb4 100644 --- a/docs/bindings/openssl.rst +++ b/docs/bindings/openssl.rst @@ -1,6 +1,13 @@ OpenSSL ======= +.. warning:: + + The OpenSSL API is not easy to use, small mistakes can lead to significant + security vulnerabilities. We strongly reccomend 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 -- cgit v1.2.3 From 5cb03b2c442e6b2f9af95867058f8a48325874d8 Mon Sep 17 00:00:00 2001 From: Hynek Schlawack Date: Thu, 3 Oct 2013 13:13:55 +0200 Subject: Fix typo in OpenSSL bindings docs --- docs/bindings/openssl.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/bindings') diff --git a/docs/bindings/openssl.rst b/docs/bindings/openssl.rst index 79468cb4..241cc4d6 100644 --- a/docs/bindings/openssl.rst +++ b/docs/bindings/openssl.rst @@ -4,7 +4,7 @@ OpenSSL .. warning:: The OpenSSL API is not easy to use, small mistakes can lead to significant - security vulnerabilities. We strongly reccomend not using this directly, + security vulnerabilities. We strongly recommend not using this directly, and instead using one of the higher level APIs exposed by ``cryptography``. -- cgit v1.2.3