diff options
| author | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-01-10 00:03:03 -0600 |
|---|---|---|
| committer | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-01-10 00:56:49 -0600 |
| commit | a9e31b35cb1cfd4489294b6f93eb8ea0f07641fb (patch) | |
| tree | d8ae9f61badc0033d063f81e71a2372fa8573d31 /docs/hazmat | |
| parent | a124429fb01ebde3f82cc338e20579d614b12f16 (diff) | |
| download | cryptography-a9e31b35cb1cfd4489294b6f93eb8ea0f07641fb.tar.gz cryptography-a9e31b35cb1cfd4489294b6f93eb8ea0f07641fb.tar.bz2 cryptography-a9e31b35cb1cfd4489294b6f93eb8ea0f07641fb.zip | |
commoncrypto backend docs
Diffstat (limited to 'docs/hazmat')
| -rw-r--r-- | docs/hazmat/backends/common-crypto.rst | 28 | ||||
| -rw-r--r-- | docs/hazmat/backends/index.rst | 1 |
2 files changed, 29 insertions, 0 deletions
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 |