blob: 50dbe69a42bc66c0d19714d5299ad61059630436 [file] [log] [blame]
Paul Kehrer7fccf4c2014-01-04 21:51:31 -06001.. hazmat::
2
3CommonCrypto Binding
4====================
5
6.. currentmodule:: cryptography.hazmat.bindings.commoncrypto.binding
7
Alex Gaynor8ea6a822014-01-17 16:08:46 -06008.. versionadded:: 0.2
9
Paul Kehrer7fccf4c2014-01-04 21:51:31 -060010These are `CFFI`_ bindings to the `CommonCrypto`_ C library. It is available on
11Mac OS X.
12
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
20 This is a :class:`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