blob: 4f58a6d382960c1874500cd6eb6bdaacf850dfd4 [file] [log] [blame]
Paul Kehrer7fccf4c2014-01-04 21:51:31 -06001.. hazmat::
2
Alex Stapletonc5fffd32014-03-18 15:29:00 +00003CommonCrypto binding
Paul Kehrer7fccf4c2014-01-04 21:51:31 -06004====================
5
6.. currentmodule:: cryptography.hazmat.bindings.commoncrypto.binding
7
Alex Gaynor8ea6a822014-01-17 16:08:46 -06008.. versionadded:: 0.2
9
Paul Kehrer12649af2014-03-10 12:45:19 -040010These are `CFFI`_ bindings to the `CommonCrypto`_ C library. It is only
11available on Mac OS X versions 10.8 and above.
Paul Kehrer7fccf4c2014-01-04 21:51:31 -060012
13.. class:: cryptography.hazmat.bindings.commoncrypto.binding.Binding()
14
15 This is the exposed API for the CommonCrypto bindings. It has two public
16 attributes:
17
18 .. attribute:: ffi
19
Paul Kehrer45efdbc2015-02-12 10:58:22 -060020 This is a ``cffi.FFI`` instance. It can be used to allocate and
Alex Gaynor9180ba52014-01-09 18:06:52 -080021 otherwise manipulate CommonCrypto structures.
Paul Kehrer7fccf4c2014-01-04 21:51:31 -060022
23 .. attribute:: lib
24
Alex Gaynor9180ba52014-01-09 18:06:52 -080025 This is a ``cffi`` library. It can be used to call CommonCrypto
26 functions, and access constants.
Paul Kehrer7fccf4c2014-01-04 21:51:31 -060027
28
29.. _`CFFI`: https://cffi.readthedocs.org/
Alex Gaynor6bee2ab2014-02-05 07:44:12 -080030.. _`CommonCrypto`: https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man3/Common%20Crypto.3cc.html