-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Expand file tree
/
Copy pathtest_verification.py
More file actions
1024 lines (892 loc) · 34.4 KB
/
Copy pathtest_verification.py
File metadata and controls
1024 lines (892 loc) · 34.4 KB
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
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# This file is dual licensed under the terms of the Apache License, Version
# 2.0, and the BSD License. See the LICENSE file in the root of this repository
# for complete details.
import datetime
import os
from functools import lru_cache
from ipaddress import IPv4Address
from typing import Optional
import pytest
from cryptography import x509
from cryptography.hazmat._oid import ExtendedKeyUsageOID
from cryptography.hazmat.primitives import hashes
from cryptography.hazmat.primitives.asymmetric import ec, rsa
from cryptography.hazmat.primitives.asymmetric.types import (
CertificatePublicKeyTypes,
)
from cryptography.x509 import ExtensionType
from cryptography.x509.general_name import DNSName, IPAddress
from cryptography.x509.oid import NameOID
from cryptography.x509.verification import (
Criticality,
ExtensionPolicy,
Policy,
PolicyBuilder,
Store,
VerificationError,
)
from tests.x509.test_x509 import _load_cert
WEBPKI_MINIMUM_RSA_MODULUS = 2048
@lru_cache(maxsize=1)
def dummy_store() -> Store:
cert = _load_cert(
os.path.join("x509", "cryptography.io.pem"),
x509.load_pem_x509_certificate,
)
return Store([cert])
class TestPolicyBuilder:
def test_time_already_set(self):
with pytest.raises(ValueError):
PolicyBuilder().time(datetime.datetime.now()).time(
datetime.datetime.now()
)
def test_store_already_set(self):
with pytest.raises(ValueError):
PolicyBuilder().store(dummy_store()).store(dummy_store())
def test_max_chain_depth_already_set(self):
with pytest.raises(ValueError):
PolicyBuilder().max_chain_depth(8).max_chain_depth(9)
def test_ipaddress_subject(self):
verifier = (
PolicyBuilder()
.store(dummy_store())
.build_server_verifier(IPAddress(IPv4Address("0.0.0.0")))
)
assert verifier.policy.subject == IPAddress(IPv4Address("0.0.0.0"))
def test_dnsname_subject(self):
verifier = (
PolicyBuilder()
.store(dummy_store())
.build_server_verifier(DNSName("cryptography.io"))
)
assert verifier.policy.subject == DNSName("cryptography.io")
def test_subject_bad_types(self):
# Subject must be a supported GeneralName type
with pytest.raises(TypeError):
PolicyBuilder().store(dummy_store()).build_server_verifier(
"cryptography.io" # type: ignore[arg-type]
)
with pytest.raises(TypeError):
PolicyBuilder().store(dummy_store()).build_server_verifier(
"0.0.0.0" # type: ignore[arg-type]
)
with pytest.raises(TypeError):
PolicyBuilder().store(dummy_store()).build_server_verifier(
IPv4Address("0.0.0.0") # type: ignore[arg-type]
)
with pytest.raises(TypeError):
PolicyBuilder().store(dummy_store()).build_server_verifier(None) # type: ignore[arg-type]
def test_builder_pattern(self):
now = datetime.datetime.now().replace(microsecond=0)
store = dummy_store()
max_chain_depth = 16
builder = PolicyBuilder()
builder = builder.time(now)
builder = builder.store(store)
builder = builder.max_chain_depth(max_chain_depth)
subject = DNSName("cryptography.io")
verifier = builder.build_server_verifier(subject)
assert verifier.policy.subject == subject
assert verifier.policy.validation_time == now
assert verifier.policy.max_chain_depth == max_chain_depth
assert (
verifier.policy.extended_key_usage
== ExtendedKeyUsageOID.SERVER_AUTH
)
assert (
verifier.policy.minimum_rsa_modulus == WEBPKI_MINIMUM_RSA_MODULUS
)
assert verifier.store == store
def test_build_server_verifier_missing_store(self):
with pytest.raises(
ValueError, match="A server verifier must have a trust store"
):
PolicyBuilder().build_server_verifier(DNSName("cryptography.io"))
class TestStore:
def test_store_rejects_empty_list(self):
with pytest.raises(ValueError):
Store([])
def test_store_rejects_non_certificates(self):
with pytest.raises(TypeError):
Store(["not a cert"]) # type: ignore[list-item]
class TestClientVerifier:
def test_build_client_verifier_missing_store(self):
with pytest.raises(
ValueError, match="A client verifier must have a trust store"
):
PolicyBuilder().build_client_verifier()
def test_verify(self):
# expires 2018-11-16 01:15:03 UTC
leaf = _load_cert(
os.path.join("x509", "cryptography.io.pem"),
x509.load_pem_x509_certificate,
)
store = Store([leaf])
validation_time = datetime.datetime.fromisoformat(
"2018-11-16T00:00:00+00:00"
)
max_chain_depth = 16
builder = PolicyBuilder().store(store)
builder = builder.time(validation_time).max_chain_depth(
max_chain_depth
)
verifier = builder.build_client_verifier()
assert verifier.policy.subject is None
assert verifier.policy.validation_time == validation_time.replace(
tzinfo=None
)
assert verifier.policy.max_chain_depth == max_chain_depth
assert (
verifier.policy.extended_key_usage
== ExtendedKeyUsageOID.CLIENT_AUTH
)
assert (
verifier.policy.minimum_rsa_modulus == WEBPKI_MINIMUM_RSA_MODULUS
)
assert verifier.store is store
verified_client = verifier.verify(leaf, [])
assert verified_client.chain == [leaf]
assert verified_client.subjects is not None
assert x509.DNSName("www.cryptography.io") in verified_client.subjects
assert x509.DNSName("cryptography.io") in verified_client.subjects
assert len(verified_client.subjects) == 2
def test_verify_fails_renders_oid(self):
leaf = _load_cert(
os.path.join("x509", "custom", "ekucrit-testuser-cert.pem"),
x509.load_pem_x509_certificate,
)
store = Store([leaf])
validation_time = datetime.datetime.fromisoformat(
"2024-06-26T00:00:00+00:00"
)
builder = PolicyBuilder().store(store)
builder = builder.time(validation_time)
verifier = builder.build_client_verifier()
pattern = (
r"invalid extension: 2\.5\.29\.37: "
r"Certificate extension has incorrect criticality"
)
with pytest.raises(
VerificationError,
match=pattern,
):
verifier.verify(leaf, [])
class TestServerVerifier:
@pytest.mark.parametrize(
("validation_time", "valid"),
[
# 03:15:02 UTC+2, or 1 second before expiry in UTC
("2018-11-16T03:15:02+02:00", True),
# 00:15:04 UTC-1, or 1 second after expiry in UTC
("2018-11-16T00:15:04-01:00", False),
],
)
def test_verify_tz_aware(self, validation_time, valid):
# expires 2018-11-16 01:15:03 UTC
leaf = _load_cert(
os.path.join("x509", "cryptography.io.pem"),
x509.load_pem_x509_certificate,
)
store = Store([leaf])
builder = PolicyBuilder().store(store)
builder = builder.time(
datetime.datetime.fromisoformat(validation_time)
)
verifier = builder.build_server_verifier(DNSName("cryptography.io"))
if valid:
assert verifier.verify(leaf, []) == [leaf]
else:
with pytest.raises(
x509.verification.VerificationError,
match="cert is not valid at validation time",
):
verifier.verify(leaf, [])
def test_error_message(self):
# expires 2018-11-16 01:15:03 UTC
leaf = _load_cert(
os.path.join("x509", "cryptography.io.pem"),
x509.load_pem_x509_certificate,
)
store = Store([leaf])
builder = PolicyBuilder().store(store)
verifier = builder.build_server_verifier(DNSName("cryptography.io"))
with pytest.raises(
x509.verification.VerificationError,
match=r"<Certificate\(subject=.*?CN=www.cryptography.io.*?\)>",
):
verifier.verify(leaf, [])
def _key_usage(
*,
digital_signature=False,
key_encipherment=False,
key_cert_sign=False,
crl_sign=False,
) -> x509.KeyUsage:
return x509.KeyUsage(
digital_signature=digital_signature,
content_commitment=False,
key_encipherment=key_encipherment,
data_encipherment=False,
key_agreement=False,
key_cert_sign=key_cert_sign,
crl_sign=crl_sign,
encipher_only=False,
decipher_only=False,
)
def _chain_with_leaf_key_usage(
key_usage: Optional[x509.KeyUsage],
*,
rsa_leaf=False,
):
ca_key = ec.generate_private_key(ec.SECP256R1())
leaf_public_key: CertificatePublicKeyTypes
if rsa_leaf:
leaf_public_key = rsa.generate_private_key(
public_exponent=65537, key_size=2048
).public_key()
else:
leaf_public_key = ec.generate_private_key(ec.SECP256R1()).public_key()
not_before = datetime.datetime(2024, 1, 1)
not_after = datetime.datetime(2034, 1, 1)
validation_time = datetime.datetime(2025, 1, 1)
ca_name = x509.Name([x509.NameAttribute(NameOID.COMMON_NAME, "Test CA")])
ca = (
x509.CertificateBuilder()
.subject_name(ca_name)
.issuer_name(ca_name)
.public_key(ca_key.public_key())
.serial_number(x509.random_serial_number())
.not_valid_before(not_before)
.not_valid_after(not_after)
.add_extension(
x509.BasicConstraints(ca=True, path_length=None),
critical=True,
)
.add_extension(
_key_usage(key_cert_sign=True, crl_sign=True),
critical=True,
)
.sign(ca_key, hashes.SHA256())
)
leaf_name = x509.Name(
[x509.NameAttribute(NameOID.COMMON_NAME, "example.com")]
)
leaf_builder = (
x509.CertificateBuilder()
.subject_name(leaf_name)
.issuer_name(ca_name)
.public_key(leaf_public_key)
.serial_number(x509.random_serial_number())
.not_valid_before(not_before)
.not_valid_after(not_after)
.add_extension(
x509.SubjectAlternativeName([x509.DNSName("example.com")]),
critical=False,
)
.add_extension(
x509.AuthorityKeyIdentifier.from_issuer_public_key(
ca_key.public_key()
),
critical=False,
)
)
if key_usage is not None:
leaf_builder = leaf_builder.add_extension(key_usage, critical=True)
return ca, leaf_builder.sign(ca_key, hashes.SHA256()), validation_time
@pytest.mark.parametrize("verifier_kind", ["server", "client"])
@pytest.mark.parametrize(
("rsa_leaf", "key_usage", "error"),
[
(False, None, None),
(False, _key_usage(digital_signature=True), None),
(
False,
_key_usage(key_encipherment=True),
"EE keyUsage must assert digitalSignature",
),
(
False,
_key_usage(digital_signature=True, key_cert_sign=True),
"EE keyUsage must not assert keyCertSign",
),
(True, None, None),
(True, _key_usage(digital_signature=True), None),
(True, _key_usage(key_encipherment=True), None),
(
True,
_key_usage(),
"RSA EE keyUsage must assert digitalSignature or keyEncipherment",
),
(
True,
_key_usage(key_encipherment=True, key_cert_sign=True),
"EE keyUsage must not assert keyCertSign",
),
],
)
def test_default_ee_key_usage(verifier_kind, rsa_leaf, key_usage, error):
ca, leaf, validation_time = _chain_with_leaf_key_usage(
key_usage, rsa_leaf=rsa_leaf
)
builder = PolicyBuilder().store(Store([ca])).time(validation_time)
def verify_leaf():
if verifier_kind == "server":
builder.build_server_verifier(x509.DNSName("example.com")).verify(
leaf, []
)
else:
builder.build_client_verifier().verify(leaf, [])
if error is None:
verify_leaf()
else:
with pytest.raises(VerificationError, match=error):
verify_leaf()
def test_default_ee_key_usage_can_be_overridden():
ca, leaf, validation_time = _chain_with_leaf_key_usage(
_key_usage(key_encipherment=True)
)
ee_policy = ExtensionPolicy.webpki_defaults_ee().may_be_present(
x509.KeyUsage, Criticality.AGNOSTIC, None
)
builder = (
PolicyBuilder()
.store(Store([ca]))
.time(validation_time)
.extension_policies(
ca_policy=ExtensionPolicy.webpki_defaults_ca(),
ee_policy=ee_policy,
)
)
verifier = builder.build_server_verifier(x509.DNSName("example.com"))
verifier.verify(leaf, [])
SUPPORTED_EXTENSION_TYPES = (
x509.AuthorityInformationAccess,
x509.AuthorityKeyIdentifier,
x509.SubjectKeyIdentifier,
x509.KeyUsage,
x509.SubjectAlternativeName,
x509.BasicConstraints,
x509.NameConstraints,
x509.ExtendedKeyUsage,
)
class TestCustomExtensionPolicies:
leaf = _load_cert(
os.path.join("x509", "cryptography.io.pem"),
x509.load_pem_x509_certificate,
)
ca = _load_cert(
os.path.join("x509", "rapidssl_sha256_ca_g3.pem"),
x509.load_pem_x509_certificate,
)
store = Store([ca])
validation_time = datetime.datetime.fromisoformat(
"2018-11-16T00:00:00+00:00"
)
def test_builder_methods(self):
ext_policy = ExtensionPolicy.permit_all()
ext_policy = ext_policy.require_not_present(x509.BasicConstraints)
def ensure_duplicate_ext_throws(method, *args):
oid_str = x509.BasicConstraints.oid.dotted_string
with pytest.raises(
ValueError,
match="ExtensionPolicy already configured for"
f" extension with OID {oid_str}",
):
method(ext_policy, x509.BasicConstraints, *args)
ensure_duplicate_ext_throws(ExtensionPolicy.require_not_present)
ensure_duplicate_ext_throws(
ExtensionPolicy.may_be_present, Criticality.AGNOSTIC, None
)
ensure_duplicate_ext_throws(
ExtensionPolicy.require_present, Criticality.AGNOSTIC, None
)
with pytest.raises(TypeError):
class _Extension:
pass
ext_policy.require_present(
_Extension, # type: ignore[type-var]
Criticality.AGNOSTIC,
None,
)
def test_arbitrary_extension_supported(self):
# Extension types that aren't among the handful with built-in
# validators can still be added to a policy. See GH #14850.
for extension_type in (x509.Admissions, x509.CertificatePolicies):
ext_policy = ExtensionPolicy.permit_all()
ext_policy.may_be_present(
extension_type, Criticality.AGNOSTIC, None
)
ext_policy.require_present(
extension_type, Criticality.AGNOSTIC, None
)
ext_policy.require_not_present(extension_type)
@staticmethod
def _chain_with_leaf_extension(leaf_extension, critical=True):
# Builds a (ca, leaf) chain where the leaf additionally carries the
# given extension. Used to exercise extensions that aren't among those
# with a built-in validator. See GH #14850.
ca_key = ec.generate_private_key(ec.SECP256R1())
leaf_key = ec.generate_private_key(ec.SECP256R1())
not_before = datetime.datetime(2024, 1, 1)
not_after = datetime.datetime(2034, 1, 1)
validation_time = datetime.datetime(2025, 1, 1)
ca_name = x509.Name(
[x509.NameAttribute(NameOID.COMMON_NAME, "Test CA")]
)
ca = (
x509.CertificateBuilder()
.subject_name(ca_name)
.issuer_name(ca_name)
.public_key(ca_key.public_key())
.serial_number(x509.random_serial_number())
.not_valid_before(not_before)
.not_valid_after(not_after)
.add_extension(
x509.BasicConstraints(ca=True, path_length=None),
critical=True,
)
.add_extension(
x509.KeyUsage(
digital_signature=False,
content_commitment=False,
key_encipherment=False,
data_encipherment=False,
key_agreement=False,
key_cert_sign=True,
crl_sign=True,
encipher_only=False,
decipher_only=False,
),
critical=True,
)
.sign(ca_key, hashes.SHA256())
)
leaf_name = x509.Name(
[x509.NameAttribute(NameOID.COMMON_NAME, "example.com")]
)
leaf = (
x509.CertificateBuilder()
.subject_name(leaf_name)
.issuer_name(ca_name)
.public_key(leaf_key.public_key())
.serial_number(x509.random_serial_number())
.not_valid_before(not_before)
.not_valid_after(not_after)
.add_extension(
x509.SubjectAlternativeName([x509.DNSName("example.com")]),
critical=False,
)
.add_extension(
x509.AuthorityKeyIdentifier.from_issuer_public_key(
ca_key.public_key()
),
critical=False,
)
.add_extension(
x509.KeyUsage(
digital_signature=True,
content_commitment=False,
key_encipherment=False,
data_encipherment=False,
key_agreement=False,
key_cert_sign=False,
crl_sign=False,
encipher_only=False,
decipher_only=False,
),
critical=False,
)
.add_extension(leaf_extension, critical=critical)
.sign(ca_key, hashes.SHA256())
)
return ca, leaf, validation_time
def test_critical_unaccounted_extension_fails(self):
ca, leaf, validation_time = self._chain_with_leaf_extension(
x509.CertificatePolicies(
[
x509.PolicyInformation(
x509.ObjectIdentifier("1.2.3.4"), None
)
]
)
)
builder = PolicyBuilder().store(Store([ca])).time(validation_time)
with pytest.raises(
VerificationError,
match="unaccounted-for critical extensions",
):
builder.build_client_verifier().verify(leaf, [])
def test_critical_extension_accounted_for(self):
ca, leaf, validation_time = self._chain_with_leaf_extension(
x509.CertificatePolicies(
[
x509.PolicyInformation(
x509.ObjectIdentifier("1.2.3.4"), None
)
]
)
)
seen = []
def validator(policy, cert, ext):
assert isinstance(policy, Policy)
assert isinstance(cert, x509.Certificate)
assert isinstance(ext, x509.CertificatePolicies)
seen.append(ext)
ee_policy = ExtensionPolicy.webpki_defaults_ee().require_present(
x509.CertificatePolicies, Criticality.CRITICAL, validator
)
builder = (
PolicyBuilder()
.store(Store([ca]))
.time(validation_time)
.extension_policies(
ca_policy=ExtensionPolicy.webpki_defaults_ca(),
ee_policy=ee_policy,
)
)
builder.build_client_verifier().verify(leaf, [])
assert len(seen) == 1
def test_unparseable_extension_passed_as_unrecognized(self):
# An extension whose value can't be parsed into a known Python object
# is delivered to the validator callback as an UnrecognizedExtension,
# rather than as None.
custom_oid = x509.ObjectIdentifier("1.2.3.4.5.6.7.8")
ca, leaf, validation_time = self._chain_with_leaf_extension(
x509.UnrecognizedExtension(custom_oid, b"\x04\x03abc"),
critical=True,
)
seen = []
def validator(policy, cert, ext):
assert isinstance(ext, x509.UnrecognizedExtension)
assert ext.oid == custom_oid
assert ext.value == b"\x04\x03abc"
seen.append(ext)
# A custom extension type carrying the OID, so it can be registered.
class CustomExtension(x509.ExtensionType):
oid = custom_oid
ee_policy = ExtensionPolicy.webpki_defaults_ee().require_present(
CustomExtension, Criticality.CRITICAL, validator
)
builder = (
PolicyBuilder()
.store(Store([ca]))
.time(validation_time)
.extension_policies(
ca_policy=ExtensionPolicy.webpki_defaults_ca(),
ee_policy=ee_policy,
)
)
builder.build_client_verifier().verify(leaf, [])
assert len(seen) == 1
def test_additional_extension_absent(self):
# Covers the required-but-absent handling for an additional (arbitrary)
# extension, i.e. one without a dedicated field. self.leaf does not
# carry this extension.
custom_oid = x509.ObjectIdentifier("1.2.3.4.5.6.7.8")
class CustomExtension(x509.ExtensionType):
oid = custom_oid
default_builder = (
PolicyBuilder().store(self.store).time(self.validation_time)
)
# require_present for an absent additional extension fails.
require_present_builder = default_builder.extension_policies(
ca_policy=ExtensionPolicy.webpki_defaults_ca(),
ee_policy=ExtensionPolicy.webpki_defaults_ee().require_present(
CustomExtension, Criticality.AGNOSTIC, None
),
)
with pytest.raises(
VerificationError,
match="missing required extension",
):
require_present_builder.build_client_verifier().verify(
self.leaf, []
)
# may_be_present for an absent additional extension still invokes the
# callback, with ext=None.
seen: list[Optional[ExtensionType]] = []
def validator(policy, cert, ext):
assert ext is None
seen.append(ext)
may_be_present_builder = default_builder.extension_policies(
ca_policy=ExtensionPolicy.webpki_defaults_ca(),
ee_policy=ExtensionPolicy.webpki_defaults_ee().may_be_present(
CustomExtension, Criticality.AGNOSTIC, validator
),
)
may_be_present_builder.build_client_verifier().verify(self.leaf, [])
assert seen == [None]
@staticmethod
def _make_validator_cb(extension_type: type[ExtensionType]):
def validator_cb(policy, cert, ext: Optional[ExtensionType]):
assert isinstance(policy, Policy)
assert (
policy.validation_time
== TestCustomExtensionPolicies.validation_time.replace(
tzinfo=None
)
)
assert isinstance(cert, x509.Certificate)
assert ext is None or isinstance(ext, extension_type)
return validator_cb
def test_require_not_present(self):
default_ee = ExtensionPolicy.webpki_defaults_ee()
no_basic_constraints_ee = default_ee.require_not_present(
x509.BasicConstraints
)
default_builder = (
PolicyBuilder().store(self.store).time(self.validation_time)
)
builder_no_basic_constraints = default_builder.extension_policies(
ca_policy=ExtensionPolicy.webpki_defaults_ca(),
ee_policy=no_basic_constraints_ee,
)
default_builder.build_client_verifier().verify(self.leaf, [])
with pytest.raises(
VerificationError,
match="Certificate contains prohibited extension",
):
builder_no_basic_constraints.build_client_verifier().verify(
self.leaf, []
)
def test_require_present(self):
default_builder = (
PolicyBuilder().store(self.store).time(self.validation_time)
)
builder_require_subject_keyid = default_builder.extension_policies(
ca_policy=ExtensionPolicy.webpki_defaults_ca(),
ee_policy=ExtensionPolicy.webpki_defaults_ee().require_present(
x509.SubjectKeyIdentifier,
Criticality.AGNOSTIC,
self._make_validator_cb(x509.SubjectKeyIdentifier),
),
)
builder_require_san = default_builder.extension_policies(
ca_policy=ExtensionPolicy.webpki_defaults_ca(),
ee_policy=ExtensionPolicy.webpki_defaults_ee().require_present(
x509.SubjectAlternativeName,
Criticality.AGNOSTIC,
self._make_validator_cb(x509.SubjectAlternativeName),
),
)
default_builder.build_client_verifier().verify(self.leaf, [])
builder_require_san.build_client_verifier().verify(self.leaf, [])
with pytest.raises(
VerificationError,
match="missing required extension",
):
builder_require_subject_keyid.build_client_verifier().verify(
self.leaf, []
)
def test_criticality_constraints(self):
builder = PolicyBuilder().store(self.store).time(self.validation_time)
noncrit_key_usage_builder = builder.extension_policies(
ca_policy=ExtensionPolicy.webpki_defaults_ca(),
ee_policy=ExtensionPolicy.webpki_defaults_ee().require_present(
x509.KeyUsage, Criticality.NON_CRITICAL, None
),
)
critical_eku_builder = builder.extension_policies(
ca_policy=ExtensionPolicy.webpki_defaults_ca(),
ee_policy=ExtensionPolicy.webpki_defaults_ee().require_present(
x509.ExtendedKeyUsage, Criticality.CRITICAL, None
),
)
def make_pattern(extension_type: type[ExtensionType]):
return (
f"invalid extension: {extension_type.oid.dotted_string}:"
" Certificate extension has incorrect criticality"
)
builder.build_client_verifier().verify(self.leaf, [])
with pytest.raises(
VerificationError,
match=make_pattern(x509.KeyUsage),
):
noncrit_key_usage_builder.build_client_verifier().verify(
self.leaf, []
)
with pytest.raises(
VerificationError,
match=make_pattern(x509.ExtendedKeyUsage),
):
critical_eku_builder.build_client_verifier().verify(self.leaf, [])
@pytest.mark.parametrize(
"extension_type",
SUPPORTED_EXTENSION_TYPES,
)
def test_custom_cb_pass(self, extension_type: type[x509.ExtensionType]):
ca_ext_policy = ExtensionPolicy.webpki_defaults_ca()
ee_ext_policy = ExtensionPolicy.webpki_defaults_ee()
if extension_type is x509.SubjectAlternativeName:
# subjectAltName must be required for server verification
ee_ext_policy = ee_ext_policy.require_present(
extension_type,
Criticality.AGNOSTIC,
self._make_validator_cb(extension_type),
)
else:
ee_ext_policy = ee_ext_policy.may_be_present(
extension_type,
Criticality.AGNOSTIC,
self._make_validator_cb(extension_type),
)
builder = PolicyBuilder().store(self.store)
builder = builder.time(self.validation_time).max_chain_depth(16)
builder = builder.extension_policies(
ca_policy=ca_ext_policy, ee_policy=ee_ext_policy
)
builder.build_client_verifier().verify(self.leaf, [])
path = builder.build_server_verifier(
DNSName("cryptography.io")
).verify(self.leaf, [])
assert path == [self.leaf, self.ca]
@pytest.mark.parametrize(
"extension_type",
SUPPORTED_EXTENSION_TYPES,
)
def test_custom_cb_exception_fails_verification(self, extension_type):
ca_ext_policy = ExtensionPolicy.webpki_defaults_ca()
ee_ext_policy = ExtensionPolicy.webpki_defaults_ee()
def validator(*_):
raise ValueError("test")
if extension_type is x509.BasicConstraints:
# basicConstraints must be required in a ca extension policy
ca_ext_policy = ca_ext_policy.require_present(
extension_type,
Criticality.AGNOSTIC,
validator,
)
else:
ca_ext_policy = ca_ext_policy.may_be_present(
extension_type,
Criticality.AGNOSTIC,
validator,
)
builder = PolicyBuilder().store(self.store).time(self.validation_time)
builder = builder.extension_policies(
ca_policy=ca_ext_policy, ee_policy=ee_ext_policy
)
for verifier in (
builder.build_client_verifier(),
builder.build_server_verifier(DNSName("cryptography.io")),
):
with pytest.raises(
VerificationError,
match="Python extension validator failed: ValueError: test",
):
verifier.verify(self.leaf, [])
def test_custom_cb_no_retval_enforced(self):
ca_ext_policy = ExtensionPolicy.webpki_defaults_ca()
ee_ext_policy = ExtensionPolicy.webpki_defaults_ee()
def validator(*_):
return False
ee_ext_policy = ee_ext_policy.may_be_present(
x509.ExtendedKeyUsage,
Criticality.AGNOSTIC,
validator,
)
builder = PolicyBuilder().store(self.store).time(self.validation_time)
builder = builder.extension_policies(
ca_policy=ca_ext_policy, ee_policy=ee_ext_policy
)
for verifier in (
builder.build_client_verifier(),
builder.build_server_verifier(DNSName("cryptography.io")),
):
with pytest.raises(
VerificationError,
match=r"Python validator must return None\.",
):
verifier.verify(self.leaf, [])
def test_no_subject_alt_name(self):
leaf = _load_cert(
os.path.join("x509", "custom", "no_sans.pem"),
x509.load_pem_x509_certificate,
)
store = Store([leaf])
validation_time = datetime.datetime.fromisoformat(
"2025-04-14T00:00:00+00:00"
)
builder = PolicyBuilder().store(store)
builder = builder.time(validation_time)
with pytest.raises(
VerificationError,
match="missing required extension",
):
builder.build_client_verifier().verify(leaf, [])
with pytest.raises(
VerificationError,
match="missing required extension",
):
builder.build_server_verifier(DNSName("example.com")).verify(
leaf, []
)
builder = builder.extension_policies(
ca_policy=ExtensionPolicy.webpki_defaults_ca(),
ee_policy=ExtensionPolicy.permit_all(),
)
verified_client = builder.build_client_verifier().verify(leaf, [])
assert verified_client.subjects is None
# Trying to build a ServerVerifier with an EE ExtensionPolicy
# that doesn't require SAN extension must fail.
with pytest.raises(
ValueError,
match=(
r"An EE extension policy used for server verification"
r" must require the subjectAltName extension to be present\."
),
):
builder.build_server_verifier(DNSName("example.com"))
def test_ca_ext_policy_must_require_basic_constraints(self):
ca_policies = [
ExtensionPolicy.webpki_defaults_ca().require_not_present(
x509.BasicConstraints
),
ExtensionPolicy.webpki_defaults_ca().may_be_present(
x509.BasicConstraints, Criticality.AGNOSTIC, None
),
]
for ca_policy in ca_policies:
builder = (
PolicyBuilder().store(self.store).time(self.validation_time)
)
builder = builder.extension_policies(
ca_policy=ca_policy,
ee_policy=ExtensionPolicy.webpki_defaults_ee(),
)
pattern = (
"A CA extension policy must require the"
" basicConstraints extension to be present."
)
with pytest.raises(
ValueError,
match=pattern,
):
builder.build_server_verifier(DNSName("example.com"))
with pytest.raises(
ValueError,
match=pattern,
):
builder.build_client_verifier()