diff options
| author | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-01-04 21:51:31 -0600 |
|---|---|---|
| committer | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-01-09 11:53:48 -0600 |
| commit | 7fccf4c38e1bb63066232198b9aa4551e4da660f (patch) | |
| tree | 4bf720fb3398a9d9adf5c28ce65251e772fae91b /docs/hazmat | |
| parent | 5e612d0ac078bae569dece5f718166a834fa9f7e (diff) | |
| download | cryptography-7fccf4c38e1bb63066232198b9aa4551e4da660f.tar.gz cryptography-7fccf4c38e1bb63066232198b9aa4551e4da660f.tar.bz2 cryptography-7fccf4c38e1bb63066232198b9aa4551e4da660f.zip | |
add CommonCrypto binding docs
Diffstat (limited to 'docs/hazmat')
| -rw-r--r-- | docs/hazmat/bindings/commoncrypto.rst | 28 | ||||
| -rw-r--r-- | docs/hazmat/bindings/index.rst | 1 |
2 files changed, 29 insertions, 0 deletions
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 |