blob: 98c099bbccc8636b631cfd3b71a0bbb5c47ae1cd (
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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
.. hazmat::
Backend Interfaces
==================
.. currentmodule:: cryptography.hazmat.bindings.interfaces
.. class:: CipherBackend
A backend which provides methods for using ciphers for encryption
and decryption.
.. method:: cipher_supported(cipher, mode)
Check if a ``cipher`` and ``mode`` combination is supported by
this backend.
:param cipher: An instance of a
:class:`~cryptography.hazmat.primitives.interfaces.CipherAlgorithm`
provider.
:param mode: An instance of a
:class:`~cryptography.hazmat.primitives.interfaces.Mode` provider.
:returns: ``True`` if the specified ``cipher`` and ``mode`` combination
is supported by this backend, otherwise ``False``
.. method:: register_cipher_adapter(cipher_cls, mode_cls, adapter)
Register an adapter which can be used to create a backend specific
object from instances of the
:class:`~cryptography.hazmat.primitives.interfaces.CipherAlgorithm` and
the :class:`~cryptography.hazmat.primitives.interfaces.Mode` primitives.
:param cipher_cls: A class whose instances provide
:class:`~cryptography.hazmat.primitives.interfaces.CipherAlgorithm`
:param mode_cls: A class whose instances provide:
:class:`~cryptography.hazmat.primitives.interfaces.Mode`
:param adapter: A ``function`` that takes 3 arguments, ``backend`` (a
:class:`CipherBackend` provider), ``cipher`` (a
:class:`~cryptography.hazmat.primitives.interfaces.CipherAlgorithm`
provider ), and ``mode`` (a
:class:`~cryptography.hazmat.primitives.interfaces.Mode` provider).
It returns a backend specific object which may be used to construct
a :class:`~cryptogrpahy.hazmat.primitives.interfaces.CipherContext`.
.. method:: create_symmetric_encryption_ctx(cipher, mode)
Create a
:class:`~cryptogrpahy.hazmat.primitives.interfaces.CipherContext` that
can be used for encrypting data with the symmetric ``cipher`` using
the given ``mode``.
:param cipher: An instance of a
:class:`~cryptography.hazmat.primitives.interfaces.CipherAlgorithm`
provider.
:param mode: An instance of a
:class:`~cryptography.hazmat.primitives.interfaces.Mode` provider.
:returns:
:class:`~cryptography.hazmat.primitives.interfaces.CipherContext`
.. method:: create_symmetric_decryption_ctx(cipher, mode)
Create a
:class:`~cryptogrpahy.hazmat.primitives.interfaces.CipherContext` that
can be used for decrypting data with the symmetric ``cipher`` using
the given ``mode``.
:param cipher: An instance of a
:class:`~cryptography.hazmat.primitives.interfaces.CipherAlgorithm`
provider.
:param mode: An instance of a
:class:`~cryptography.hazmat.primitives.interfaces.Mode` provider.
:returns:
:class:`~cryptography.hazmat.primitives.interfaces.CipherContext`
.. class:: HashBackend
A backend with methods for using cryptographic hash functions.
.. method:: hash_supported(algorithm)
Check if the specified ``algorithm`` is supported by this backend.
:param algorithm: An instance of a
:class:`~cryptography.hazmat.primitives.interfaces.HashAlgorithm`
provider.
:returns: ``True`` if the specified ``algorithm`` is supported by this
backend, otherwise ``False``.
.. method:: create_hash_ctx(algorithm)
Create a
:class:`~cryptogrpahy.hazmat.primitives.interfaces.HashContext` that
uses the specified ``algorithm`` to calculate a message digest.
:param algorithm: An instance of a
:class:`~cryptography.hazmat.primitives.interfaces.HashAlgorithm`
provider.
:returns:
:class:`~cryptography.hazmat.primitives.interfaces.HashContext`
.. class:: HMACBackend
A backend with methods for using cryptographic hash functions as message
authentication codes.
.. method:: create_hmac_ctx(algorithm)
Create a
:class:`~cryptogrpahy.hazmat.primitives.interfaces.HashContext` that
uses the specified ``algorithm`` to calculate a hash-based message
authentication code.
:param algorithm: An instance of a
:class:`~cryptography.hazmat.primitives.interfaces.HashAlgorithm`
provider.
:returns:
:class:`~cryptography.hazmat.primitives.interfaces.HashContext`
|