aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat/bindings/commoncrypto.rst
blob: 63e734c693b3d29647942bf05d584ba01d67b0bd (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
29
30
.. hazmat::

CommonCrypto binding
====================

.. currentmodule:: cryptography.hazmat.bindings.commoncrypto.binding

.. versionadded:: 0.2

These are `CFFI`_ bindings to the `CommonCrypto`_ C library. It is only
available on macOS versions 10.8 and above.

.. 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 ``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.io
.. _`CommonCrypto`: https://developer.apple.com/library/content/documentation/Security/Conceptual/cryptoservices/GeneralPurposeCrypto/GeneralPurposeCrypto.html#//apple_ref/doc/uid/TP40011172-CH9-SW10