aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat/bindings/commoncrypto.rst
diff options
context:
space:
mode:
authorPaul Kehrer <paul.l.kehrer@gmail.com>2014-01-11 21:59:08 -0600
committerPaul Kehrer <paul.l.kehrer@gmail.com>2014-01-11 21:59:08 -0600
commit74169660e47b760f82c0653b4210b3bc5d3bf46b (patch)
tree33835b3e733f6b918b56240200e29402092cc384 /docs/hazmat/bindings/commoncrypto.rst
parent9ad4d755bb3a2edfb8e46b60f6dfaff6365f0386 (diff)
parent089a860f2d3f0ac923fc3f78190055990a940e2a (diff)
downloadcryptography-74169660e47b760f82c0653b4210b3bc5d3bf46b.tar.gz
cryptography-74169660e47b760f82c0653b4210b3bc5d3bf46b.tar.bz2
cryptography-74169660e47b760f82c0653b4210b3bc5d3bf46b.zip
Merge branch 'master' into urandom-engine
* master: (169 commits) Make just one call to ffi.cdef for most of the definitions Use pytest.fixture for backends drop to >= 0.8 to make pypy happy change to anonymous enum require cffi >= 0.8.1 remove extraneous spaces add hmac to commoncrypto binding bytes byte back add check to confirm we've loaded error strings Bind all the PEM errors Spelling! oops, bytes plz don't leak a context in the test add tests to the openssl backend to verify that we've registered Nonsense I think we need. This is a dep init the ssl library in the backend Actuall install a thing Try to run the spellchecker on travis Use a normal quote here, not sure where the smart quote came from ... Conflicts: cryptography/hazmat/bindings/openssl/binding.py tests/hazmat/backends/test_openssl.py
Diffstat (limited to 'docs/hazmat/bindings/commoncrypto.rst')
-rw-r--r--docs/hazmat/bindings/commoncrypto.rst28
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/hazmat/bindings/commoncrypto.rst b/docs/hazmat/bindings/commoncrypto.rst
new file mode 100644
index 00000000..25535e02
--- /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 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#//apple_ref/doc/man/3cc/CommonCrypto