From ce0d781707979ccb7f6983601c5ccb25d2354582 Mon Sep 17 00:00:00 2001 From: Donald Stufft Date: Sun, 27 Oct 2013 16:52:33 -0400 Subject: Move the bindings into the hazmat module --- docs/architecture.rst | 10 +++++----- docs/bindings/index.rst | 7 ------- docs/bindings/openssl.rst | 30 ------------------------------ docs/hazmat/bindings/index.rst | 7 +++++++ docs/hazmat/bindings/openssl.rst | 30 ++++++++++++++++++++++++++++++ docs/index.rst | 2 +- 6 files changed, 43 insertions(+), 43 deletions(-) delete mode 100644 docs/bindings/index.rst delete mode 100644 docs/bindings/openssl.rst create mode 100644 docs/hazmat/bindings/index.rst create mode 100644 docs/hazmat/bindings/openssl.rst (limited to 'docs') diff --git a/docs/architecture.rst b/docs/architecture.rst index 8de8649d..4cf639c2 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -8,11 +8,11 @@ Architecture ``cryptography`` has three different layers: -* ``cryptography.bindings``: This package contains bindings to low level - cryptographic libraries. Our initial target will be OpenSSL. -* ``cryptography.hazmat.primitives``: This packages contains low level - algorithms, things like ``AES`` or ``SHA1``. This is implemented on top of - ``cryptography.bindings``. * ``cryptography``: This package contains higher level recipes, for example "encrypt and then MAC". This is implemented on top of ``cryptography.hazmat.primitives``. +* ``cryptography.hazmat.primitives``: This packages contains low level + algorithms, things like ``AES`` or ``SHA1``. This is implemented on top of + ``cryptography.hazmat.bindings``. +* ``cryptography.hazmat.bindings``: This package contains bindings to low level + cryptographic libraries. Our initial target will be OpenSSL. diff --git a/docs/bindings/index.rst b/docs/bindings/index.rst deleted file mode 100644 index 80f53594..00000000 --- a/docs/bindings/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -Bindings -======== - -.. toctree:: - :maxdepth: 1 - - openssl diff --git a/docs/bindings/openssl.rst b/docs/bindings/openssl.rst deleted file mode 100644 index e59b0c13..00000000 --- a/docs/bindings/openssl.rst +++ /dev/null @@ -1,30 +0,0 @@ -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.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`: http://cffi.readthedocs.org/ -.. _`OpenSSL`: https://www.openssl.org/ diff --git a/docs/hazmat/bindings/index.rst b/docs/hazmat/bindings/index.rst new file mode 100644 index 00000000..80f53594 --- /dev/null +++ b/docs/hazmat/bindings/index.rst @@ -0,0 +1,7 @@ +Bindings +======== + +.. toctree:: + :maxdepth: 1 + + openssl diff --git a/docs/hazmat/bindings/openssl.rst b/docs/hazmat/bindings/openssl.rst new file mode 100644 index 00000000..5a00395e --- /dev/null +++ b/docs/hazmat/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.hazmat.bindings.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`: http://cffi.readthedocs.org/ +.. _`OpenSSL`: https://www.openssl.org/ diff --git a/docs/index.rst b/docs/index.rst index 47418abb..b2420a8f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -31,7 +31,6 @@ Contents :maxdepth: 2 architecture - bindings/index contributing security community @@ -43,3 +42,4 @@ Hazard Materials :maxdepth: 2 hazmat/primitives/index + hazmat/bindings/index -- cgit v1.2.3