From a9e31b35cb1cfd4489294b6f93eb8ea0f07641fb Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Fri, 10 Jan 2014 00:03:03 -0600 Subject: commoncrypto backend docs --- docs/hazmat/backends/common-crypto.rst | 28 ++++++++++++++++++++++++++++ docs/hazmat/backends/index.rst | 1 + 2 files changed, 29 insertions(+) create mode 100644 docs/hazmat/backends/common-crypto.rst (limited to 'docs/hazmat/backends') diff --git a/docs/hazmat/backends/common-crypto.rst b/docs/hazmat/backends/common-crypto.rst new file mode 100644 index 00000000..edd45b6b --- /dev/null +++ b/docs/hazmat/backends/common-crypto.rst @@ -0,0 +1,28 @@ +.. hazmat:: + +CommonCrypto Backend +==================== + +These are `CFFI`_ bindings to the `CommonCrypto`_ C library provided by Apple +on OS X and iOS. + +.. currentmodule:: cryptography.hazmat.backends.commoncrypto.backend + +.. data:: cryptography.hazmat.backends.commoncrypto.backend + + 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 CommonCrypto structures. + + .. attribute:: lib + + This is a ``cffi`` library. It can be used to call CommonCrypto + 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 diff --git a/docs/hazmat/backends/index.rst b/docs/hazmat/backends/index.rst index 06951281..22354f69 100644 --- a/docs/hazmat/backends/index.rst +++ b/docs/hazmat/backends/index.rst @@ -31,4 +31,5 @@ Individual Backends :maxdepth: 1 openssl + common-crypto interfaces -- cgit v1.2.3 From 12656e53baf6d66a2a0a83aed9711407a4cf7818 Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Sun, 19 Jan 2014 12:15:54 -0600 Subject: update docs, add name attribute to backend --- docs/hazmat/backends/common-crypto.rst | 18 ++++-------------- 1 file changed, 4 insertions(+), 14 deletions(-) (limited to 'docs/hazmat/backends') diff --git a/docs/hazmat/backends/common-crypto.rst b/docs/hazmat/backends/common-crypto.rst index edd45b6b..ad4cc210 100644 --- a/docs/hazmat/backends/common-crypto.rst +++ b/docs/hazmat/backends/common-crypto.rst @@ -3,26 +3,16 @@ CommonCrypto Backend ==================== -These are `CFFI`_ bindings to the `CommonCrypto`_ C library provided by Apple -on OS X and iOS. +The `CommonCrypto`_ C library provided by Apple on OS X and iOS. .. currentmodule:: cryptography.hazmat.backends.commoncrypto.backend .. data:: cryptography.hazmat.backends.commoncrypto.backend - This is the exposed API for the CommonCrypto bindings. It has two public - attributes: + This is the exposed API for the OpenSSL backend. It has one public attribute. - .. attribute:: ffi + .. attribute:: name - This is a :class:`cffi.FFI` instance. It can be used to allocate and - otherwise manipulate CommonCrypto structures. + The string name of the backend. - .. attribute:: lib - - This is a ``cffi`` library. It can be used to call CommonCrypto - 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 -- cgit v1.2.3 From d6b8dfab17705f2fa2a49395f2b689b0b7d51b38 Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Sun, 19 Jan 2014 13:26:21 -0600 Subject: increase indent and note the value of the attribute in the docs --- docs/hazmat/backends/common-crypto.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/hazmat/backends') diff --git a/docs/hazmat/backends/common-crypto.rst b/docs/hazmat/backends/common-crypto.rst index ad4cc210..afff9a16 100644 --- a/docs/hazmat/backends/common-crypto.rst +++ b/docs/hazmat/backends/common-crypto.rst @@ -11,8 +11,8 @@ The `CommonCrypto`_ C library provided by Apple on OS X and iOS. This is the exposed API for the OpenSSL backend. It has one public attribute. - .. attribute:: name + .. attribute:: name - The string name of the backend. + Returns ``commoncrypto``, the string name of this backend. .. _`CommonCrypto`: https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man3/Common%20Crypto.3cc.html -- cgit v1.2.3 From 4925575af6f949aaf83f2504c00cb979cc547162 Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Sun, 19 Jan 2014 13:29:06 -0600 Subject: fix copy mistake in docs --- docs/hazmat/backends/common-crypto.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/hazmat/backends') diff --git a/docs/hazmat/backends/common-crypto.rst b/docs/hazmat/backends/common-crypto.rst index afff9a16..64e95ccb 100644 --- a/docs/hazmat/backends/common-crypto.rst +++ b/docs/hazmat/backends/common-crypto.rst @@ -9,7 +9,7 @@ The `CommonCrypto`_ C library provided by Apple on OS X and iOS. .. data:: cryptography.hazmat.backends.commoncrypto.backend - This is the exposed API for the OpenSSL backend. It has one public attribute. + This is the exposed API for the CommonCrypto backend. It has one public attribute. .. attribute:: name -- cgit v1.2.3 From ab6fa0a7f56fbfe3e5c13844969f1ac276ba79e2 Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Sun, 19 Jan 2014 13:57:15 -0600 Subject: doc updates --- docs/hazmat/backends/common-crypto.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/hazmat/backends') diff --git a/docs/hazmat/backends/common-crypto.rst b/docs/hazmat/backends/common-crypto.rst index 64e95ccb..6127116b 100644 --- a/docs/hazmat/backends/common-crypto.rst +++ b/docs/hazmat/backends/common-crypto.rst @@ -11,8 +11,8 @@ The `CommonCrypto`_ C library provided by Apple on OS X and iOS. This is the exposed API for the CommonCrypto backend. It has one public attribute. - .. attribute:: name + .. attribute:: name - Returns ``commoncrypto``, the string name of this backend. + The string name of this backend: ``"commoncrypto"`` .. _`CommonCrypto`: https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man3/Common%20Crypto.3cc.html -- cgit v1.2.3 From 6ce4bb78e7d4c597b1594479d99caa73e9c5c73a Mon Sep 17 00:00:00 2001 From: Paul Kehrer Date: Sun, 19 Jan 2014 14:29:28 -0600 Subject: added versionadded --- docs/hazmat/backends/common-crypto.rst | 2 ++ 1 file changed, 2 insertions(+) (limited to 'docs/hazmat/backends') diff --git a/docs/hazmat/backends/common-crypto.rst b/docs/hazmat/backends/common-crypto.rst index 6127116b..af2032b6 100644 --- a/docs/hazmat/backends/common-crypto.rst +++ b/docs/hazmat/backends/common-crypto.rst @@ -7,6 +7,8 @@ The `CommonCrypto`_ C library provided by Apple on OS X and iOS. .. currentmodule:: cryptography.hazmat.backends.commoncrypto.backend +.. versionadded:: 0.2 + .. data:: cryptography.hazmat.backends.commoncrypto.backend This is the exposed API for the CommonCrypto backend. It has one public attribute. -- cgit v1.2.3