blob: 40b49a54dbe47e618dde77adfebb2219a262b849 (
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
.. hazmat::
Interfaces
==========
``cryptography`` uses `Abstract Base Classes`_ as interfaces to describe the
properties and methods of most primitive constructs. Backends may also use
this information to influence their operation. Interfaces should also be used
to document argument and return types.
.. _`Abstract Base Classes`: http://docs.python.org/3.2/library/abc.html
Symmetric Ciphers
~~~~~~~~~~~~~~~~~
.. currentmodule:: cryptography.hazmat.primitives.interfaces
.. class:: CipherAlgorithm
A named symmetric encryption algorithm.
.. attribute:: name
:type: str
The standard name for the mode, for example, "AES", "Camellia", or
"Blowfish".
.. attribute:: key_size
:type: int
The number of bits in the key being used.
.. class:: BlockCipherAlgorithm
A block cipher algorithm.
.. attribute:: block_size
:type: int
The number of bits in a block.
Cipher Modes
------------
Interfaces used by the symmetric cipher modes described in
:ref:`Symmetric Encryption Modes <symmetric-encryption-modes>`.
.. class:: Mode
A named cipher mode.
.. attribute:: name
:type: str
This should be the standard shorthand name for the mode, for example
Cipher-Block Chaining mode is "CBC".
The name may be used by a backend to influence the operation of a
cipher in conjunction with the algorithm's name.
.. method:: validate_for_algorithm(algorithm)
:param CipherAlgorithm algorithm:
Checks that the combination of this mode with the provided algorithm
meets any necessary invariants. This should raise an exception if they
are not met.
For example, the :class:`~cryptography.hazmat.primitives.modes.CBC`
mode uses this method to check that the provided initialization
vector's length matches the block size of the algorithm.
.. class:: ModeWithInitializationVector
A cipher mode with an initialization vector.
.. attribute:: initialization_vector
:type: bytes
Exact requirements of the initialization are described by the
documentation of individual modes.
.. class:: ModeWithNonce
A cipher mode with a nonce.
.. attribute:: nonce
:type: bytes
Exact requirements of the nonce are described by the documentation of
individual modes.
Asymmetric Interfaces
~~~~~~~~~~~~~~~~~~~~~
.. class:: RSAPrivateKey
An `RSA`_ private key.
.. attribute:: public_key
:type: :class:`~cryptography.hazmat.primitives.interfaces.RSAPublicKey`
An RSA public key object corresponding to the values of the private key.
.. attribute:: modulus
:type: str
Hexadecimal representation of the public modulus. Alias for ``n``.
.. attribute:: public_exponent
:type: int
The public exponent. Alias for ``e``.
.. attribute:: key_length
:type: int
The bit length of the modulus.
.. attribute:: p
:type: str
Hexadecimal representation of ``p``, one of the two primes composing
``n``.
.. attribute:: q
:type: str
Hexadecimal representation of ``q``, one of the two primes composing
``n``.
.. attribute:: d
:type: str
Hexadecimal representation of ``d``, the private exponent.
.. attribute:: n
:type: str
Hexadecimal representation of the public modulus.
.. attribute:: e
:type: int
The public exponent.
.. class:: RSAPublicKey
An `RSA`_ public key.
.. attribute:: modulus
:type: str
Hexadecimal representation of the public modulus. Alias for ``n``.
.. attribute:: key_length
:type: int
The bit length of the modulus.
.. attribute:: public_exponent
:type: int
The public exponent. Alias for ``e``.
.. attribute:: n
:type: str
Hexadecimal representation of the public modulus.
.. attribute:: e
:type: int
The public exponent.
.. _`RSA`: http://en.wikipedia.org/wiki/RSA_(cryptosystem)
|
