aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat/backends/common-crypto.rst
blob: edd45b6be3e6c32fcd3cc28f9030e711d02a6997 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
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