blob: d31391d73e911ca33f39c0dc190f111773c7551a [file] [log] [blame]
Paul Kehrera9e31b32014-01-10 00:03:03 -06001.. hazmat::
2
3CommonCrypto Backend
4====================
5
Ayrxc44e0f02014-03-08 23:33:01 +08006The `CommonCrypto`_ C library provided by Apple on OS X and iOS. The CommonCrypto
7backend is only supported on OS X versions 10.8 and above.
Paul Kehrera9e31b32014-01-10 00:03:03 -06008
9.. currentmodule:: cryptography.hazmat.backends.commoncrypto.backend
10
Paul Kehrer6ce4bb72014-01-19 14:29:28 -060011.. versionadded:: 0.2
12
Paul Kehrera9e31b32014-01-10 00:03:03 -060013.. data:: cryptography.hazmat.backends.commoncrypto.backend
14
Alex Gaynor031c2cb2014-01-31 11:44:53 -080015 This is the exposed API for the CommonCrypto backend.
16
Alex Gaynor8ca6fad2014-01-31 13:23:51 -080017 It implements the following interfaces:
18
Alex Gaynor031c2cb2014-01-31 11:44:53 -080019 * :class:`~cryptography.hazmat.backends.interfaces.CipherBackend`
20 * :class:`~cryptography.hazmat.backends.interfaces.HashBackend`
21 * :class:`~cryptography.hazmat.backends.interfaces.HMACBackend`
22 * :class:`~cryptography.hazmat.backends.interfaces.PBKDF2HMACBackend`
23
24 It has one additional public attribute.
Paul Kehrera9e31b32014-01-10 00:03:03 -060025
Paul Kehrerab6fa0a2014-01-19 13:57:15 -060026 .. attribute:: name
Paul Kehrera9e31b32014-01-10 00:03:03 -060027
Paul Kehrerab6fa0a2014-01-19 13:57:15 -060028 The string name of this backend: ``"commoncrypto"``
Paul Kehrera9e31b32014-01-10 00:03:03 -060029
Paul Kehrera9e31b32014-01-10 00:03:03 -060030.. _`CommonCrypto`: https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man3/Common%20Crypto.3cc.html