aboutsummaryrefslogtreecommitdiffstats
path: root/docs/hazmat/backends/commoncrypto.rst
blob: 77d6612c356d4f687d08c17cc3d41c9d892f6aa7 (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 backend
====================

The `CommonCrypto`_ C library provided by Apple on OS X and iOS. The CommonCrypto
backend is only supported on OS X versions 10.8 and above.

.. currentmodule:: cryptography.hazmat.backends.commoncrypto.backend

.. versionadded:: 0.2

.. data:: cryptography.hazmat.backends.commoncrypto.backend

    This is the exposed API for the CommonCrypto backend.

    It implements the following interfaces:

    * :class:`~cryptography.hazmat.backends.interfaces.CipherBackend`
    * :class:`~cryptography.hazmat.backends.interfaces.HashBackend`
    * :class:`~cryptography.hazmat.backends.interfaces.HMACBackend`
    * :class:`~cryptography.hazmat.backends.interfaces.PBKDF2HMACBackend`

    It has one additional public attribute.

    .. attribute:: name

        The string name of this backend: ``"commoncrypto"``

.. _`CommonCrypto`: https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man3/Common%20Crypto.3cc.html