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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
|
.. hazmat::
DSA
===
.. currentmodule:: cryptography.hazmat.primitives.asymmetric.dsa
`DSA`_ is a `public-key`_ algorithm for signing messages.
Generation
~~~~~~~~~~
.. function:: generate_private_key(key_size, backend)
.. versionadded:: 0.5
Generate a DSA private key from the given key size. This function will
generate a new set of parameters and key in one step.
:param int key_size: The length of the modulus in bits. It should be
either 1024, 2048 or 3072. For keys generated in 2014 this should
be `at least 2048`_ (See page 41). Note that some applications
(such as SSH) have not yet gained support for larger key sizes
specified in FIPS 186-3 and are still restricted to only the
1024-bit keys specified in FIPS 186-2.
:param backend: A
:class:`~cryptography.hazmat.backends.interfaces.DSABackend`
provider.
:return: A :class:`~cryptography.hazmat.primitives.interfaces.DSAPrivateKey`
provider.
:raises cryptography.exceptions.UnsupportedAlgorithm: This is raised if
the provided ``backend`` does not implement
:class:`~cryptography.hazmat.backends.interfaces.DSABackend`
.. function:: generate_parameters(key_size, backend)
.. versionadded:: 0.5
Generate DSA parameters using the provided ``backend``.
:param int key_size: The length of the modulus in bits. It should be
either 1024, 2048 or 3072. For keys generated in 2014 this should
be `at least 2048`_ (See page 41). Note that some applications
(such as SSH) have not yet gained support for larger key sizes
specified in FIPS 186-3 and are still restricted to only the
1024-bit keys specified in FIPS 186-2.
:param backend: A
:class:`~cryptography.hazmat.backends.interfaces.DSABackend`
provider.
:return: A :class:`~cryptography.hazmat.primitives.interfaces.DSAParameters`
provider.
:raises cryptography.exceptions.UnsupportedAlgorithm: This is raised if
the provided ``backend`` does not implement
:class:`~cryptography.hazmat.backends.interfaces.DSABackend`
Signing
~~~~~~~
Using a :class:`~cryptography.hazmat.primitives.interfaces.DSAPrivateKey`
provider.
.. doctest::
>>> from cryptography.hazmat.backends import default_backend
>>> from cryptography.hazmat.primitives import hashes
>>> from cryptography.hazmat.primitives.asymmetric import dsa
>>> private_key = dsa.generate_private_key(
... key_size=1024,
... backend=default_backend()
... )
>>> signer = private_key.signer(hashes.SHA256())
>>> data = b"this is some data I'd like to sign"
>>> signer.update(data)
>>> signature = signer.finalize()
Verification
~~~~~~~~~~~~
Using a :class:`~cryptography.hazmat.primitives.interfaces.DSAPublicKey`
provider.
.. doctest::
>>> public_key = private_key.public_key()
>>> verifier = public_key.verifier(signature, hashes.SHA256())
>>> verifier.update(data)
>>> verifier.verify()
Numbers
~~~~~~~
.. class:: DSAParameterNumbers(p, q, g)
.. versionadded:: 0.5
The collection of integers that make up a set of DSA parameters.
.. attribute:: p
:type: int
The public modulus.
.. attribute:: q
:type: int
The sub-group order.
.. attribute:: g
:type: int
The generator.
.. method:: parameters(backend)
:param backend: A
:class:`~cryptography.hazmat.backends.interfaces.DSABackend`
provider.
:returns: A new instance of a
:class:`~cryptography.hazmat.primitives.interfaces.DSAParameters`
provider.
.. class:: DSAPublicNumbers(y, parameter_numbers)
.. versionadded:: 0.5
The collection of integers that make up a DSA public key.
.. attribute:: y
:type: int
The public value ``y``.
.. attribute:: parameter_numbers
:type: :class:`~cryptography.hazmat.primitives.dsa.DSAParameterNumbers`
The :class:`~cryptography.hazmat.primitives.dsa.DSAParameterNumbers`
associated with the public key.
.. method:: public_key(backend)
:param backend: A
:class:`~cryptography.hazmat.backends.interfaces.DSABackend`
provider.
:returns: A new instance of a
:class:`~cryptography.hazmat.primitives.interfaces.DSAPublicKey`
provider.
.. class:: DSAPrivateNumbers(x, public_numbers)
.. versionadded:: 0.5
The collection of integers that make up a DSA private key.
.. warning::
Revealing the value of ``x`` will compromise the security of any
cryptographic operations performed.
.. attribute:: x
:type: int
The private value ``x``.
.. attribute:: public_numbers
:type: :class:`~cryptography.hazmat.primitives.dsa.DSAPublicNumbers`
The :class:`~cryptography.hazmat.primitives.dsa.DSAPublicNumbers`
associated with the private key.
.. method:: private_key(backend)
:param backend: A
:class:`~cryptography.hazmat.backends.interfaces.DSABackend`
provider.
:returns: A new instance of a
:class:`~cryptography.hazmat.primitives.interfaces.DSAPrivateKey`
provider.
Deprecated Concrete Classes
~~~~~~~~~~~~~~~~~~~~~~~~~~~
These classes were deprecated in version 0.5 in favor of backend specific
providers of the
:class:`~cryptography.hazmat.primitives.interfaces.DSAParameters`,
:class:`~cryptography.hazmat.primitives.interfaces.DSAPrivateKey`, and
:class:`~cryptography.hazmat.primitives.interfaces.DSAPublicKey` interfaces.
.. class:: DSAParameters(modulus, subgroup_order, generator)
.. versionadded:: 0.4
.. deprecated:: 0.5
DSA Parameters are required for generating a DSA private key.
You should use :meth:`~generate` to generate new parameters.
.. warning::
This method only checks a limited set of properties of its arguments.
Using DSA parameters that you do not trust or with incorrect arguments
may lead to insecure operation, crashes, and other undefined behavior.
We recommend that you only ever load parameters that were generated
with software you trust.
This class conforms to the
:class:`~cryptography.hazmat.primitives.interfaces.DSAParameters`
interface.
:raises TypeError: This is raised when the arguments are not all integers.
:raises ValueError: This is raised when the values of ``modulus``,
``subgroup_order``, or ``generator`` do
not match the bounds specified in `FIPS 186-4`_.
.. classmethod:: generate(key_size, backend)
Generate a new ``DSAParameters`` instance using ``backend``.
:param int key_size: The length of the modulus in bits. It should be
either 1024, 2048 or 3072. For keys generated in 2014 this should
be `at least 2048`_ (See page 41). Note that some applications
(such as SSH) have not yet gained support for larger key sizes
specified in FIPS 186-3 and are still restricted to only the
1024-bit keys specified in FIPS 186-2.
:return: A new instance of ``DSAParameters``
:raises cryptography.exceptions.UnsupportedAlgorithm: This is raised if
the provided ``backend`` does not implement
:class:`~cryptography.hazmat.backends.interfaces.DSABackend`
.. class:: DSAPrivateKey(modulus, subgroup_order, generator, x, y)
.. versionadded:: 0.4
.. deprecated:: 0.5
A DSA private key is required for signing messages.
You should use :meth:`~generate` to generate new keys.
.. warning::
This method only checks a limited set of properties of its arguments.
Using a DSA private key that you do not trust or with incorrect
parameters may lead to insecure operation, crashes, and other undefined
behavior. We recommend that you only ever load private keys that were
generated with software you trust.
This class conforms to the
:class:`~cryptography.hazmat.primitives.interfaces.DSAPrivateKey`
interface.
:raises TypeError: This is raised when the arguments are not all integers.
:raises ValueError: This is raised when the values of ``modulus``,
``subgroup_order``, or ``generator`` do
not match the bounds specified in `FIPS 186-4`_.
.. classmethod:: generate(parameters, backend)
Generate a new ``DSAPrivateKey`` instance using ``backend``.
:param parameters: A
:class:`~cryptography.hazmat.primitives.interfaces.DSAParameters`
provider.
:param backend: A
:class:`~cryptography.hazmat.backends.interfaces.DSABackend`
provider.
:return: A new instance of ``DSAPrivateKey``.
:raises cryptography.exceptions.UnsupportedAlgorithm: This is raised if
the provided ``backend`` does not implement
:class:`~cryptography.hazmat.backends.interfaces.DSABackend`
:raises ValueError: This is raised if the key size is not (1024 or 2048 or 3072)
or if the OpenSSL version is older than 1.0.0 and the key size is larger than 1024
because older OpenSSL versions don't support a key size larger than 1024.
.. method:: signer(algorithm, backend)
.. versionadded:: 0.4
Sign data which can be verified later by others using the public key.
:param algorithm: An instance of a
:class:`~cryptography.hazmat.primitives.interfaces.HashAlgorithm`
provider.
:param backend: A
:class:`~cryptography.hazmat.backends.interfaces.RSABackend`
provider.
:returns:
:class:`~cryptography.hazmat.primitives.interfaces.AsymmetricSignatureContext`
:raises cryptography.exceptions.UnsupportedAlgorithm: This is raised if
the provided ``backend`` does not implement
:class:`~cryptography.hazmat.backends.interfaces.DSABackend`
.. class:: DSAPublicKey(modulus, subgroup_order, generator, y)
.. versionadded:: 0.4
.. deprecated:: 0.5
A DSA public key is required for verifying messages.
Normally you do not need to directly construct public keys because you'll
be loading them from a file, generating them automatically or receiving
them from a 3rd party.
This class conforms to the
:class:`~cryptography.hazmat.primitives.interfaces.DSAPublicKey`
interface.
:raises TypeError: This is raised when the arguments are not all integers.
:raises ValueError: This is raised when the values of ``modulus``,
``subgroup_order``, ``generator``, or ``y``
do not match the bounds specified in `FIPS 186-4`_.
.. method:: verifier(signature, algorithm, backend)
.. versionadded:: 0.4
Verify data was signed by the private key associated with this public
key.
:param bytes signature: The signature to verify. DER encoded as
specified in :rfc:`6979`.
:param algorithm: An instance of a
:class:`~cryptography.hazmat.primitives.interfaces.HashAlgorithm`
provider.
:param backend: A
:class:`~cryptography.hazmat.backends.interfaces.DSABackend`
provider.
:returns:
:class:`~cryptography.hazmat.primitives.interfaces.AsymmetricVerificationContext`
.. _`DSA`: https://en.wikipedia.org/wiki/Digital_Signature_Algorithm
.. _`public-key`: https://en.wikipedia.org/wiki/Public-key_cryptography
.. _`FIPS 186-4`: http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.186-4.pdf
.. _`at least 2048`: http://www.ecrypt.eu.org/documents/D.SPA.20.pdf
|
