From 1225270be8af862a82e45342f086419dbedce0fb Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Thu, 2 Jan 2014 11:10:35 -0800 Subject: Correct spelling, fix phrasing, line wrap. --- docs/hazmat/bindings/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/hazmat/bindings') diff --git a/docs/hazmat/bindings/index.rst b/docs/hazmat/bindings/index.rst index 809eddfc..e2a17591 100644 --- a/docs/hazmat/bindings/index.rst +++ b/docs/hazmat/bindings/index.rst @@ -6,7 +6,7 @@ Bindings .. currentmodule:: cryptography.hazmat.bindings ``cryptography`` aims to provide low-level CFFI based bindings to multiple -native C libraries. These provide no automatic initialisation of the library +native C libraries. These provide no automatic initialization of the library and may not provide complete wrappers for its API. Using these functions directly is likely to require you to be careful in -- cgit v1.2.3 From 7fccf4c38e1bb63066232198b9aa4551e4da660f Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Sat, 4 Jan 2014 21:51:31 -0600 Subject: add CommonCrypto binding docs --- docs/hazmat/bindings/commoncrypto.rst | 28 ++++++++++++++++++++++++++++ docs/hazmat/bindings/index.rst | 1 + 2 files changed, 29 insertions(+) create mode 100644 docs/hazmat/bindings/commoncrypto.rst (limited to 'docs/hazmat/bindings') diff --git a/docs/hazmat/bindings/commoncrypto.rst b/docs/hazmat/bindings/commoncrypto.rst new file mode 100644 index 00000000..a4423365 --- /dev/null +++ b/docs/hazmat/bindings/commoncrypto.rst @@ -0,0 +1,28 @@ +.. hazmat:: + +CommonCrypto Binding +==================== + +.. currentmodule:: cryptography.hazmat.bindings.commoncrypto.binding + +These are `CFFI`_ bindings to the `CommonCrypto`_ C library. It is available on +Mac OS X. + +.. class:: cryptography.hazmat.bindings.commoncrypto.binding.Binding() + + This is the exposed API for the CommonCrypto 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`: https://cffi.readthedocs.org/ +.. _`CommonCrypto`: https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man3/Common%20Crypto.3cc.html#//apple_ref/doc/man/3cc/CommonCrypto diff --git a/docs/hazmat/bindings/index.rst b/docs/hazmat/bindings/index.rst index e2a17591..caab8d6a 100644 --- a/docs/hazmat/bindings/index.rst +++ b/docs/hazmat/bindings/index.rst @@ -20,3 +20,4 @@ Individual Bindings :maxdepth: 1 openssl + commoncrypto -- cgit v1.2.3 From 9180ba525c440ef7c8ef814f59aef4e57bc241b0 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Thu, 9 Jan 2014 18:06:52 -0800 Subject: Fix up a mistaken copy paste --- docs/hazmat/bindings/commoncrypto.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/hazmat/bindings') diff --git a/docs/hazmat/bindings/commoncrypto.rst b/docs/hazmat/bindings/commoncrypto.rst index a4423365..25535e02 100644 --- a/docs/hazmat/bindings/commoncrypto.rst +++ b/docs/hazmat/bindings/commoncrypto.rst @@ -16,12 +16,12 @@ Mac OS X. .. attribute:: ffi This is a :class:`cffi.FFI` instance. It can be used to allocate and - otherwise manipulate OpenSSL structures. + otherwise manipulate CommonCrypto structures. .. attribute:: lib - This is a ``cffi`` library. It can be used to call OpenSSL functions, - and access constants. + This is a ``cffi`` library. It can be used to call CommonCrypto + functions, and access constants. .. _`CFFI`: https://cffi.readthedocs.org/ -- cgit v1.2.3