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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
|
.. hazmat::
Backend interfaces
==================
.. currentmodule:: cryptography.hazmat.backends.interfaces
Backend implementations may provide a number of interfaces to support
operations such as :doc:`/hazmat/primitives/symmetric-encryption`,
:doc:`/hazmat/primitives/cryptographic-hashes`, and
:doc:`/hazmat/primitives/mac/hmac`.
A specific ``backend`` may provide one or more of these interfaces.
.. class:: CipherBackend
A backend that provides methods for using ciphers for encryption
and decryption.
The following backends implement this interface:
* :doc:`/hazmat/backends/openssl`
* :doc:`/hazmat/backends/commoncrypto`
.. 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.ciphers.CipherAlgorithm`
provider.
:param mode: An instance of a
:class:`~cryptography.hazmat.primitives.ciphers.modes.Mode` provider.
:returns: ``True`` if the specified ``cipher`` and ``mode`` combination
is supported by this backend, otherwise ``False``
.. method:: create_symmetric_encryption_ctx(cipher, mode)
Create a
:class:`~cryptography.hazmat.primitives.ciphers.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.ciphers.CipherAlgorithm`
provider.
:param mode: An instance of a
:class:`~cryptography.hazmat.primitives.ciphers.modes.Mode` provider.
:returns:
:class:`~cryptography.hazmat.primitives.ciphers.CipherContext`
:raises ValueError: When tag is not None in an AEAD mode
.. method:: create_symmetric_decryption_ctx(cipher, mode)
Create a
:class:`~cryptography.hazmat.primitives.ciphers.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.ciphers.CipherAlgorithm`
provider.
:param mode: An instance of a
:class:`~cryptography.hazmat.primitives.ciphers.modes.Mode` provider.
:returns:
:class:`~cryptography.hazmat.primitives.ciphers.CipherContext`
:raises ValueError: When tag is None in an AEAD mode
.. class:: HashBackend
A backend with methods for using cryptographic hash functions.
The following backends implement this interface:
* :doc:`/hazmat/backends/openssl`
* :doc:`/hazmat/backends/commoncrypto`
.. method:: hash_supported(algorithm)
Check if the specified ``algorithm`` is supported by this backend.
:param algorithm: An instance of a
:class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm`
provider.
:returns: ``True`` if the specified ``algorithm`` is supported by this
backend, otherwise ``False``.
.. method:: create_hash_ctx(algorithm)
Create a
:class:`~cryptography.hazmat.primitives.hashes.HashContext` that
uses the specified ``algorithm`` to calculate a message digest.
:param algorithm: An instance of a
:class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm`
provider.
:returns:
:class:`~cryptography.hazmat.primitives.hashes.HashContext`
.. class:: HMACBackend
A backend with methods for using cryptographic hash functions as message
authentication codes.
The following backends implement this interface:
* :doc:`/hazmat/backends/openssl`
* :doc:`/hazmat/backends/commoncrypto`
.. method:: hmac_supported(algorithm)
Check if the specified ``algorithm`` is supported by this backend.
:param algorithm: An instance of a
:class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm`
provider.
:returns: ``True`` if the specified ``algorithm`` is supported for HMAC
by this backend, otherwise ``False``.
.. method:: create_hmac_ctx(algorithm)
Create a
:class:`~cryptography.hazmat.primitives.hashes.HashContext` that
uses the specified ``algorithm`` to calculate a hash-based message
authentication code.
:param algorithm: An instance of a
:class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm`
provider.
:returns:
:class:`~cryptography.hazmat.primitives.hashes.HashContext`
.. class:: CMACBackend
.. versionadded:: 0.4
A backend with methods for using CMAC
.. method:: cmac_algorithm_supported(algorithm)
:param algorithm: An instance of a
:class:`~cryptography.hazmat.primitives.ciphers.BlockCipherAlgorithm`
provider.
:return: Returns True if the block cipher is supported for CMAC by this backend
.. method:: create_cmac_ctx(algorithm)
Create a
:class:`~cryptography.hazmat.primitives.interfaces.MACContext` that
uses the specified ``algorithm`` to calculate a message authentication code.
:param algorithm: An instance of a
:class:`~cryptography.hazmat.primitives.ciphers.BlockCipherAlgorithm`
provider.
:returns:
:class:`~cryptography.hazmat.primitives.interfaces.MACContext`
.. class:: PBKDF2HMACBackend
.. versionadded:: 0.2
A backend with methods for using PBKDF2 using HMAC as a PRF.
The following backends implement this interface:
* :doc:`/hazmat/backends/openssl`
* :doc:`/hazmat/backends/commoncrypto`
.. method:: pbkdf2_hmac_supported(algorithm)
Check if the specified ``algorithm`` is supported by this backend.
:param algorithm: An instance of a
:class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm`
provider.
:returns: ``True`` if the specified ``algorithm`` is supported for
PBKDF2 HMAC by this backend, otherwise ``False``.
.. method:: derive_pbkdf2_hmac(self, algorithm, length, salt, iterations, key_material)
:param algorithm: An instance of a
:class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm`
provider.
:param int length: The desired length of the derived key. Maximum is
(2\ :sup:`32` - 1) * ``algorithm.digest_size``
:param bytes salt: A salt.
:param int iterations: The number of iterations to perform of the hash
function. This can be used to control the length of time the
operation takes. Higher numbers help mitigate brute force attacks
against derived keys.
:param bytes key_material: The key material to use as a basis for
the derived key. This is typically a password.
:return bytes: Derived key.
.. class:: RSABackend
.. versionadded:: 0.2
A backend with methods for using RSA.
.. method:: generate_rsa_private_key(public_exponent, key_size)
:param int public_exponent: The public exponent of the new key.
Often one of the small Fermat primes 3, 5, 17, 257 or 65537.
:param int key_size: The length in bits of the modulus. Should be
at least 2048.
:return: A new instance of a
:class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPrivateKey`
provider.
:raises ValueError: If the public_exponent is not valid.
.. method:: rsa_padding_supported(padding)
Check if the specified ``padding`` is supported by the backend.
:param padding: An instance of an
:class:`~cryptography.hazmat.primitives.asymmetric.padding.AsymmetricPadding`
provider.
:returns: ``True`` if the specified ``padding`` is supported by this
backend, otherwise ``False``.
.. method:: generate_rsa_parameters_supported(public_exponent, key_size)
Check if the specified parameters are supported for key generation by
the backend.
:param int public_exponent: The public exponent.
:param int key_size: The bit length of the generated modulus.
.. method:: load_rsa_private_numbers(numbers)
:param numbers: An instance of
:class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPrivateNumbers`.
:returns: A provider of
:class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPrivateKey`.
:raises ValueError: This is raised when the values of ``p``, ``q``,
``private_exponent``, ``public_exponent``, or ``modulus`` do not
match the bounds specified in :rfc:`3447`.
:raises cryptography.exceptions.UnsupportedAlgorithm: This is raised
when any backend specific criteria are not met.
.. method:: load_rsa_public_numbers(numbers)
:param numbers: An instance of
:class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPrivateNumbers`.
:returns: A provider of
:class:`~cryptography.hazmat.primitives.asymmetric.rsa.RSAPublicKey`.
:raises ValueError: This is raised when the values of
``public_exponent`` or ``modulus`` do not match the bounds
specified in :rfc:`3447`.
:raises cryptography.exceptions.UnsupportedAlgorithm: This is raised
when any backend specific criteria are not met.
.. class:: DSABackend
.. versionadded:: 0.4
A backend with methods for using DSA.
.. method:: generate_dsa_parameters(key_size)
:param int key_size: The length of the modulus in bits. It should be
either 1024, 2048 or 3072. For keys generated in 2015 this should
be at least 2048.
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 a
:class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAParameters`
provider.
.. method:: generate_dsa_private_key(parameters)
:param parameters: A
:class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAParameters`
provider.
:return: A new instance of a
:class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPrivateKey`
provider.
:raises ValueError: This is raised if the key size is not one of 1024,
2048, or 3072. It is also raised when OpenSSL is older than version
1.0.0 and the key size is larger than 1024; older OpenSSL versions
do not support keys larger than 1024 bits.
.. method:: generate_dsa_private_key_and_parameters(key_size)
:param int key_size: The length of the modulus in bits. It should be
either 1024, 2048 or 3072. For keys generated in 2015 this should
be at least 2048.
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 a
:class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPrivateKey`
provider.
:raises ValueError: This is raised if the key size is not supported
by the backend.
.. method:: dsa_hash_supported(algorithm)
:param algorithm: An instance of a
:class:`~cryptography.hazmat.primitives.hashes.HashAlgorithm`
provider.
:returns: ``True`` if the specified ``algorithm`` is supported by this
backend, otherwise ``False``.
.. method:: dsa_parameters_supported(p, q, g)
:param int p: The p value of a DSA key.
:param int q: The q value of a DSA key.
:param int g: The g value of a DSA key.
:returns: ``True`` if the given values of ``p``, ``q``, and ``g`` are
supported by this backend, otherwise ``False``.
.. method:: load_dsa_parameter_numbers(numbers)
:param numbers: An instance of
:class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAParameterNumbers`.
:returns: A provider of
:class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAParameters`.
:raises cryptography.exceptions.UnsupportedAlgorithm: This is raised
when any backend specific criteria are not met.
.. method:: load_dsa_private_numbers(numbers)
:param numbers: An instance of
:class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPrivateNumbers`.
:returns: A provider of
:class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPrivateKey`.
:raises cryptography.exceptions.UnsupportedAlgorithm: This is raised
when any backend specific criteria are not met.
.. method:: load_dsa_public_numbers(numbers)
:param numbers: An instance of
:class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPublicNumbers`.
:returns: A provider of
:class:`~cryptography.hazmat.primitives.asymmetric.dsa.DSAPublicKey`.
:raises cryptography.exceptions.UnsupportedAlgorithm: This is raised
when any backend specific criteria are not met.
.. class:: EllipticCurveBackend
.. versionadded:: 0.5
.. method:: elliptic_curve_supported(curve)
:param curve: An instance of a
:class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurve`
provider.
:returns: True if the elliptic curve is supported by this backend.
.. method:: elliptic_curve_signature_algorithm_supported(signature_algorithm, curve)
:param signature_algorithm: An instance of a
:class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurveSignatureAlgorithm`
provider.
:param curve: An instance of a
:class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurve`
provider.
:returns: True if the signature algorithm and curve are supported by this backend.
.. method:: generate_elliptic_curve_private_key(curve)
:param curve: An instance of a
:class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurve`
provider.
.. method:: load_elliptic_curve_private_numbers(numbers)
:param numbers: An instance of a
:class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePrivateNumbers`
provider.
:returns: An instance of a
:class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePrivateKey`
provider.
.. method:: load_elliptic_curve_public_numbers(numbers)
:param numbers: An instance of a
:class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicNumbers`
provider.
:returns: An instance of a
:class:`~cryptography.hazmat.primitives.asymmetric.ec.EllipticCurvePublicKey`
provider.
.. class:: PEMSerializationBackend
.. versionadded:: 0.6
A backend with methods for working with any PEM encoded keys.
.. method:: load_pem_private_key(data, password)
:param bytes data: PEM data to load.
:param bytes password: The password to use if the data is encrypted.
Should be ``None`` if the data is not encrypted.
:return: A new instance of the appropriate type of private key that the
serialized data contains.
:raises ValueError: If the data could not be deserialized.
:raises cryptography.exceptions.UnsupportedAlgorithm: If the data is
encrypted with an unsupported algorithm.
.. method:: load_pem_public_key(data)
:param bytes data: PEM data to load.
:return: A new instance of the appropriate type of public key
serialized data contains.
:raises ValueError: If the data could not be deserialized.
.. class:: DERSerializationBackend
.. versionadded:: 0.8
A backend with methods for working with DER encoded keys.
.. method:: load_der_private_key(data, password)
:param bytes data: DER data to load.
:param bytes password: The password to use if the data is encrypted.
Should be ``None`` if the data is not encrypted.
:return: A new instance of the appropriate type of private key that the
serialized data contains.
:raises ValueError: If the data could not be deserialized.
:raises cryptography.exceptions.UnsupportedAlgorithm: If the data is
encrypted with an unsupported algorithm.
.. method:: load_der_public_key(data)
:param bytes data: DER data to load.
:return: A new instance of the appropriate type of public key
serialized data contains.
:raises ValueError: If the data could not be deserialized.
.. class:: X509Backend
.. versionadded:: 0.7
A backend with methods for working with X.509 objects.
.. method:: load_pem_x509_certificate(data)
:param bytes data: PEM formatted certificate data.
:returns: An instance of :class:`~cryptography.x509.Certificate`.
.. method:: load_der_x509_certificate(data)
:param bytes data: DER formatted certificate data.
:returns: An instance of :class:`~cryptography.x509.Certificate`.
.. method:: load_pem_x509_csr(data)
.. versionadded:: 0.9
:param bytes data: PEM formatted certificate signing request data.
:returns: An instance of
:class:`~cryptography.x509.CertificateSigningRequest`.
.. class:: DHBackend
.. versionadded:: 0.9
A backend with methods for doing Diffie-Hellman key exchange.
.. method:: generate_dh_parameters(key_size)
:param int key_size: The bit length of the prime modulus to generate.
:return: A new instance of a
:class:`~cryptography.hazmat.primitives.asymmetric.dh.DHParameters`
provider.
:raises ValueError: If ``key_size`` is not at least 512.
.. method:: generate_dh_private_key(parameters)
:param parameters: A
:class:`~cryptography.hazmat.primitives.asymmetric.dh.DHParameters`
provider.
:return: A new instance of a
:class:`~cryptography.hazmat.primitives.asymmetric.dh.DHPrivateKey`
provider.
.. method:: generate_dh_private_key_and_parameters(self, key_size)
:param int key_size: The bit length of the prime modulus to generate.
:return: A new instance of a
:class:`~cryptography.hazmat.primitives.asymmetric.dh.DHPrivateKey`
provider.
:raises ValueError: If ``key_size`` is not at least 512.
.. method:: load_dh_private_numbers(numbers)
:param numbers: A
:class:`~cryptography.hazmat.primitives.asymmetric.dh.DHPrivateNumbers`
instance.
:return: A new instance of a
:class:`~cryptography.hazmat.primitives.asymmetric.dh.DHPrivateKey`
provider.
:raises cryptography.exceptions.UnsupportedAlgorithm: This is raised
when any backend specific criteria are not met.
.. method:: load_dh_public_numbers(numbers)
:param numbers: A
:class:`~cryptography.hazmat.primitives.asymmetric.dh.DHPublicNumbers`
instance.
:return: A new instance of a
:class:`~cryptography.hazmat.primitives.asymmetric.dh.DHPublicKey`
provider.
:raises cryptography.exceptions.UnsupportedAlgorithm: This is raised
when any backend specific criteria are not met.
.. method:: load_dh_parameter_numbers(numbers)
:param numbers: A
:class:`~cryptography.hazmat.primitives.asymmetric.dh.DHParameterNumbers`
instance.
:return: A new instance of a
:class:`~cryptography.hazmat.primitives.asymmetric.dh.DHParameters`
provider.
:raises cryptography.exceptions.UnsupportedAlgorithm: This is raised
when any backend specific criteria are not met.
.. method:: dh_parameters_supported(p, g)
:param int p: The p value of the DH key.
:param int g: The g value of the DH key.
:returns: ``True`` if the given values of ``p`` and ``g`` are supported
by this backend, otherwise ``False``.
|