Skip to content

Commit 75709c1

Browse files
RichieB2Billia-v
andauthored
Set verify flags in create_urllib3_context (#3577)
Co-authored-by: Illia Volochii <[email protected]>
1 parent 5c8f82a commit 75709c1

8 files changed

Lines changed: 137 additions & 10 deletions

File tree

‎changelog/3571.feature.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Added ``verify_flags`` option to ``create_urllib3_context`` with a default of ``VERIFY_X509_PARTIAL_CHAIN`` and ``VERIFY_X509_STRICT`` for Python 3.13+.
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
From 2019450b43511289d45c6b3e7376f2813e1c27b4 Mon Sep 17 00:00:00 2001
2+
From: Richard van den Berg <[email protected]>
3+
Date: Sat, 29 Mar 2025 14:53:45 +0100
4+
Subject: [PATCH] Add key usage extension to test ca.crt
5+
6+
---
7+
tests/certs/expired/ca/ca.cnf | 1 +
8+
tests/certs/expired/ca/ca.crt | 20 ++++++++++----------
9+
2 files changed, 11 insertions(+), 10 deletions(-)
10+
11+
diff --git a/tests/certs/expired/ca/ca.cnf b/tests/certs/expired/ca/ca.cnf
12+
index 1443cb9374..09fcb6de1c 100644
13+
--- a/tests/certs/expired/ca/ca.cnf
14+
+++ b/tests/certs/expired/ca/ca.cnf
15+
@@ -14,3 +14,4 @@ CN = Self-Signed Root CA # common name / your cert name
16+
17+
[v3_ca]
18+
basicConstraints = critical, CA:true
19+
+keyUsage = critical, cRLSign, digitalSignature, keyCertSign
20+
diff --git a/tests/certs/expired/ca/ca.crt b/tests/certs/expired/ca/ca.crt
21+
index f08b2d67a5..2c8ebd44ae 100644
22+
--- a/tests/certs/expired/ca/ca.crt
23+
+++ b/tests/certs/expired/ca/ca.crt
24+
@@ -1,8 +1,8 @@
25+
-----BEGIN CERTIFICATE-----
26+
-MIIDlDCCAnygAwIBAgIUG/CTOPIQbH2BI36TyThUChQyR8wwDQYJKoZIhvcNAQEL
27+
+MIIDpDCCAoygAwIBAgIUQt0yyZmppkHKNx4aXRrmD5tvjbswDQYJKoZIhvcNAQEL
28+
BQAwajELMAkGA1UEBhMCVVMxIzAhBgNVBAoMGlB5dGhvbiBTb2Z0d2FyZSBGb3Vu
29+
ZGF0aW9uMRgwFgYDVQQLDA9weXRob24tcmVxdWVzdHMxHDAaBgNVBAMME1NlbGYt
30+
-U2lnbmVkIFJvb3QgQ0EwHhcNMjUwMjE3MDAzODIyWhcNNDUwMjEyMDAzODIyWjBq
31+
+U2lnbmVkIFJvb3QgQ0EwHhcNMjUwMzI5MTM1MTQ1WhcNNDUwMzI0MTM1MTQ1WjBq
32+
MQswCQYDVQQGEwJVUzEjMCEGA1UECgwaUHl0aG9uIFNvZnR3YXJlIEZvdW5kYXRp
33+
b24xGDAWBgNVBAsMD3B5dGhvbi1yZXF1ZXN0czEcMBoGA1UEAwwTU2VsZi1TaWdu
34+
ZWQgUm9vdCBDQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJ9lSHzZ
35+
@@ -11,12 +11,12 @@ dqlagCS2jI9dJz8Y3MnMLBmiiXvET6ub/S9u7VdtRxByoHydBEvNMKEMga64PwMe
36+
ztuZ6fX2xPmRnLQIippzfzdxDFHxbUWzjzEQEl+4EGbKX5vPi6A9yL3ofgMi4APZ
37+
C8/YoqAaqzjLIM9KZ/zqT36iQ6wsxBXAacd63L5M8lrAKfZoJeX6uYxNIIfaxQRz
38+
zVxdpVBjHJ/odqoadwKzU7YzN5Fs+6ATNvkrhlUzg1i0MyTGtCdkUIAt/hc6ZrW6
39+
-/kqHpCgUwUc4Dq0CAwEAAaMyMDAwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQU
40+
-CEaIPf7XQsGt0xbf6P9x5cxdKpwwDQYJKoZIhvcNAQELBQADggEBAHMgyQNA3DQG
41+
-0l9eX8RMl4YNwhAXChU/wOTcvD+F4OsJcPqzy6QHFh1AbBBGOI9/HN7du+EiKwGZ
42+
-wE+69FEsSbhSv22XidPm+kHPTguWl1eKveeWrrT5MPl9F48s14lKb/8yMEa1/ryG
43+
-Iu8NQ6ZL91JbTXdkLoBDya9HZqyXjwcGkXLE8fSqTibJ7EhWS5Q3Ic7WPgUoGAum
44+
-b5ygoxqhm+SEyXC2/LAktwmFawkv1SsMeYpT790VIFqJ/TVVnUl+gQ2RjSEl2WLb
45+
-UO4Hwq4FZbWF9NrY6JVThLmbcr8eW6+UxWfiXHLw/qTRre4/3367QAUQRt7EuEsb
46+
-KOWpOS3fbsI=
47+
+/kqHpCgUwUc4Dq0CAwEAAaNCMEAwDwYDVR0TAQH/BAUwAwEB/zAOBgNVHQ8BAf8E
48+
+BAMCAYYwHQYDVR0OBBYEFAhGiD3+10LBrdMW3+j/ceXMXSqcMA0GCSqGSIb3DQEB
49+
+CwUAA4IBAQBRT21cyZ0Jx0JLA2ilYTLvpMsSryGyWrCOXlmRlBt1MAhmxdTRgCmu
50+
+UB3UU2pfnrC16UeMVVS411lhzjowFXkXrjAqSUBRcetUIYHlpnGgDdUl4dV/X5kx
51+
+HxD9VUBx/QwGeyzFhjzjeN89M2v9kPnhU/kkVfcsafwYiHdC6pwN6zeZNz7JP+GS
52+
+rmI+KVpm5C+Nz6ekm3TR8rFgPIsiDTbY3qj/DNYX2+NhpU1DZfm687vhOr3Ekljx
53+
+NHNu9++STEjGpirrI8EqQnK+FP2fRJ5D82YZM0d++8tmHKpY0+FRCr8//459sgun
54+
+CojmhIobDa2NuF81Jx6Cc7lagCPG3/Ts
55+
-----END CERTIFICATE-----

‎noxfile.py‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,13 @@ def downstream_requests(session: nox.Session) -> None:
168168
session.cd(tmp_dir)
169169
git_clone(session, "https://github.com/psf/requests")
170170
session.chdir("requests")
171+
# https://github.com/psf/requests/pull/6924
172+
session.run(
173+
"git",
174+
"apply",
175+
f"{root}/ci/0001-requests-test-cert-key-usage.patch",
176+
external=True,
177+
)
171178
session.run("git", "rev-parse", "HEAD", external=True)
172179
session.install(".[socks]", silent=False)
173180
session.install("-r", "requirements-dev.txt", silent=False)

‎src/urllib3/contrib/pyopenssl.py‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -424,6 +424,7 @@ def __init__(self, protocol: int) -> None:
424424
self.check_hostname = False
425425
self._minimum_version: int = ssl.TLSVersion.MINIMUM_SUPPORTED
426426
self._maximum_version: int = ssl.TLSVersion.MAXIMUM_SUPPORTED
427+
self._verify_flags: int = ssl.VERIFY_X509_TRUSTED_FIRST
427428

428429
@property
429430
def options(self) -> int:
@@ -434,6 +435,15 @@ def options(self, value: int) -> None:
434435
self._options = value
435436
self._set_ctx_options()
436437

438+
@property
439+
def verify_flags(self) -> int:
440+
return self._verify_flags
441+
442+
@verify_flags.setter
443+
def verify_flags(self, value: int) -> None:
444+
self._verify_flags = value
445+
self._ctx.get_cert_store().set_flags(self._verify_flags)
446+
437447
@property
438448
def verify_mode(self) -> int:
439449
return _openssl_to_stdlib_verify[self._ctx.get_verify_mode()]

‎src/urllib3/util/ssl_.py‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@ class _TYPE_PEER_CERT_RET_DICT(TypedDict, total=False):
101101
OPENSSL_VERSION_NUMBER,
102102
PROTOCOL_TLS,
103103
PROTOCOL_TLS_CLIENT,
104+
VERIFY_X509_STRICT,
104105
OP_NO_SSLv2,
105106
OP_NO_SSLv3,
106107
SSLContext,
@@ -109,6 +110,9 @@ class _TYPE_PEER_CERT_RET_DICT(TypedDict, total=False):
109110

110111
PROTOCOL_SSLv23 = PROTOCOL_TLS
111112

113+
# Needed for Python 3.9 which does not define this
114+
VERIFY_X509_PARTIAL_CHAIN = getattr(ssl, "VERIFY_X509_PARTIAL_CHAIN", 0x80000)
115+
112116
# Setting SSLContext.hostname_checks_common_name = False didn't work before CPython
113117
# 3.9.3, and 3.10 (but OK on PyPy) or OpenSSL 1.1.1l+
114118
if HAS_NEVER_CHECK_COMMON_NAME and not _is_has_never_check_common_name_reliable(
@@ -138,6 +142,8 @@ class _TYPE_PEER_CERT_RET_DICT(TypedDict, total=False):
138142
OP_NO_SSLv3 = 0x2000000 # type: ignore[assignment]
139143
PROTOCOL_SSLv23 = PROTOCOL_TLS = 2 # type: ignore[assignment]
140144
PROTOCOL_TLS_CLIENT = 16 # type: ignore[assignment]
145+
VERIFY_X509_PARTIAL_CHAIN = 0x80000
146+
VERIFY_X509_STRICT = 0x20 # type: ignore[assignment]
141147

142148

143149
_TYPE_PEER_CERT_RET = typing.Union["_TYPE_PEER_CERT_RET_DICT", bytes, None]
@@ -223,6 +229,7 @@ def create_urllib3_context(
223229
ciphers: str | None = None,
224230
ssl_minimum_version: int | None = None,
225231
ssl_maximum_version: int | None = None,
232+
verify_flags: int | None = None,
226233
) -> ssl.SSLContext:
227234
"""Creates and configures an :class:`ssl.SSLContext` instance for use with urllib3.
228235
@@ -247,6 +254,9 @@ def create_urllib3_context(
247254
:param ciphers:
248255
Which cipher suites to allow the server to select. Defaults to either system configured
249256
ciphers if OpenSSL 1.1.1+, otherwise uses a secure default set of ciphers.
257+
:param verify_flags:
258+
The flags for certificate verification operations. These default to
259+
``ssl.VERIFY_X509_PARTIAL_CHAIN`` and ``ssl.VERIFY_X509_STRICT`` for Python 3.13+.
250260
:returns:
251261
Constructed SSLContext object with specified options
252262
:rtype: SSLContext
@@ -320,6 +330,16 @@ def create_urllib3_context(
320330

321331
context.options |= options
322332

333+
if verify_flags is None:
334+
verify_flags = 0
335+
# In Python 3.13+ ssl.create_default_context() sets VERIFY_X509_PARTIAL_CHAIN
336+
# and VERIFY_X509_STRICT so we do the same
337+
if sys.version_info >= (3, 13):
338+
verify_flags |= VERIFY_X509_PARTIAL_CHAIN
339+
verify_flags |= VERIFY_X509_STRICT
340+
341+
context.verify_flags |= verify_flags
342+
323343
# Enable post-handshake authentication for TLS 1.3, see GH #1634. PHA is
324344
# necessary for conditional client cert authentication with TLS 1.3.
325345
# The attribute is None for OpenSSL <= 1.1.0 or does not exist when using

‎test/test_ssl.py‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
from __future__ import annotations
22

33
import ssl
4+
import sys
45
import typing
56
from unittest import mock
67

@@ -63,6 +64,25 @@ def test_create_urllib3_no_context(self) -> None:
6364
with pytest.raises(TypeError):
6465
ssl_.create_urllib3_context()
6566

67+
def test_create_urllib3_context_default_verify_flags(self) -> None:
68+
context = ssl_.create_urllib3_context()
69+
if sys.version_info >= (3, 13):
70+
assert context.verify_flags & ssl.VERIFY_X509_PARTIAL_CHAIN
71+
assert context.verify_flags & ssl.VERIFY_X509_STRICT
72+
else:
73+
# Needed for Python 3.9 which does not define this
74+
assert not (
75+
context.verify_flags
76+
& getattr(ssl, "VERIFY_X509_PARTIAL_CHAIN", 0x80000)
77+
)
78+
assert not (context.verify_flags & ssl.VERIFY_X509_STRICT)
79+
80+
def test_create_urllib3_context_custom_verify_flags(self) -> None:
81+
context = ssl_.create_urllib3_context()
82+
assert not (context.verify_flags & ssl.VERIFY_CRL_CHECK_LEAF)
83+
context = ssl_.create_urllib3_context(verify_flags=ssl.VERIFY_CRL_CHECK_LEAF)
84+
assert context.verify_flags & ssl.VERIFY_CRL_CHECK_LEAF
85+
6686
def test_wrap_socket_given_context_no_load_default_certs(self) -> None:
6787
context = mock.create_autospec(ssl_.SSLContext)
6888
context.load_default_certs = mock.Mock()

‎test/with_dummyserver/test_https.py‎

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1140,6 +1140,11 @@ def test_ssl_context_ssl_version_uses_ssl_min_max_versions(self) -> None:
11401140
assert ctx.minimum_version == self.tls_version()
11411141
assert ctx.maximum_version == self.tls_version()
11421142

1143+
def test_default_ssl_context_verify_flags(self) -> None:
1144+
ctx = urllib3.util.ssl_.create_urllib3_context()
1145+
ssl_ctx = ssl.create_default_context()
1146+
assert ctx.verify_flags == ssl_ctx.verify_flags
1147+
11431148
def test_assert_missing_hashfunc(self, monkeypatch: pytest.MonkeyPatch) -> None:
11441149
fingerprint = "55:39:BF:70:05:12:43:FA:1F:D1:BF:4E:E8:1B:07:1D"
11451150
with HTTPSConnectionPool(
@@ -1208,14 +1213,16 @@ def test_common_name_without_san_fails(self, no_san_server: ServerConfig) -> Non
12081213
MaxRetryError,
12091214
) as e:
12101215
https_pool.request("GET", "/")
1211-
assert "mismatch, certificate is not valid" in str(
1212-
e.value
1213-
) or "no appropriate subjectAltName" in str(e.value)
1216+
assert (
1217+
"mismatch, certificate is not valid" in str(e.value)
1218+
or "no appropriate subjectAltName" in str(e.value)
1219+
or "Empty Subject Alternative Name extension" in str(e.value)
1220+
)
12141221

12151222
def test_common_name_without_san_with_different_common_name(
12161223
self, no_san_server_with_different_commmon_name: ServerConfig
12171224
) -> None:
1218-
ctx = urllib3.util.ssl_.create_urllib3_context()
1225+
ctx = urllib3.util.ssl_.create_urllib3_context(verify_flags=0)
12191226
try:
12201227
ctx.hostname_checks_common_name = True
12211228
except AttributeError:
@@ -1238,7 +1245,7 @@ def test_common_name_without_san_with_different_common_name(
12381245
def test_hostname_checks_common_name_respected(
12391246
self, no_san_server: ServerConfig, use_assert_hostname: bool
12401247
) -> None:
1241-
ctx = urllib3.util.ssl_.create_urllib3_context()
1248+
ctx = urllib3.util.ssl_.create_urllib3_context(verify_flags=0)
12421249
if not hasattr(ctx, "hostname_checks_common_name"):
12431250
pytest.skip("Test requires 'SSLContext.hostname_checks_common_name'")
12441251
ctx.load_verify_locations(no_san_server.ca_certs)
@@ -1291,11 +1298,13 @@ def test_assert_hostname_invalid_cn(
12911298
self, no_san_server_with_different_commmon_name: ServerConfig
12921299
) -> None:
12931300
"""Ensure CN errors are not raised while assert_hostname is false"""
1301+
ctx = urllib3.util.ssl_.create_urllib3_context(verify_flags=0)
12941302
with HTTPSConnectionPool(
12951303
no_san_server_with_different_commmon_name.host,
12961304
no_san_server_with_different_commmon_name.port,
12971305
cert_reqs="CERT_REQUIRED",
12981306
ca_certs=no_san_server_with_different_commmon_name.ca_certs,
1307+
ssl_context=ctx,
12991308
assert_hostname=False,
13001309
) as https_pool:
13011310
https_pool.request("GET", "/")

‎test/with_dummyserver/test_proxy_poolmanager.py‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -731,10 +731,12 @@ def test_https_proxy_assert_fingerprint_md5(
731731
proxy_url = f"https://{proxy.host}:{proxy.port}"
732732
destination_url = f"https://{server.host}:{server.port}"
733733

734+
proxy_ctx = urllib3.util.ssl_.create_urllib3_context(verify_flags=0)
734735
proxy_fingerprint = self._get_proxy_fingerprint_md5(proxy.ca_certs)
735736
with proxy_from_url(
736737
proxy_url,
737738
ca_certs=proxy.ca_certs,
739+
proxy_ssl_context=proxy_ctx,
738740
proxy_assert_fingerprint=proxy_fingerprint,
739741
) as https:
740742
https.request("GET", destination_url)
@@ -746,13 +748,15 @@ def test_https_proxy_assert_fingerprint_md5_non_matching(
746748
proxy_url = f"https://{proxy.host}:{proxy.port}"
747749
destination_url = f"https://{server.host}:{server.port}"
748750

751+
proxy_ctx = urllib3.util.ssl_.create_urllib3_context(verify_flags=0)
749752
proxy_fingerprint = self._get_proxy_fingerprint_md5(proxy.ca_certs)
750753
new_char = "b" if proxy_fingerprint[5] == "a" else "a"
751754
proxy_fingerprint = proxy_fingerprint[:5] + new_char + proxy_fingerprint[6:]
752755

753756
with proxy_from_url(
754757
proxy_url,
755758
ca_certs=proxy.ca_certs,
759+
proxy_ssl_context=proxy_ctx,
756760
proxy_assert_fingerprint=proxy_fingerprint,
757761
) as https:
758762
with pytest.raises(MaxRetryError) as e:
@@ -856,10 +860,11 @@ def test_https_proxy_no_san(
856860

857861
ssl_error = e.value.reason.original_error
858862
assert isinstance(ssl_error, SSLError)
859-
assert "no appropriate subjectAltName fields were found" in str(
860-
ssl_error
861-
) or "Hostname mismatch, certificate is not valid for 'localhost'" in str(
862-
ssl_error
863+
assert (
864+
"no appropriate subjectAltName fields were found" in str(ssl_error)
865+
or "Hostname mismatch, certificate is not valid for 'localhost'"
866+
in str(ssl_error)
867+
or "Empty Subject Alternative Name extension" in str(ssl_error)
863868
)
864869

865870
def test_https_proxy_no_san_hostname_checks_common_name(
@@ -869,7 +874,7 @@ def test_https_proxy_no_san_hostname_checks_common_name(
869874
proxy_url = f"https://{proxy.host}:{proxy.port}"
870875
destination_url = f"https://{server.host}:{server.port}"
871876

872-
proxy_ctx = urllib3.util.ssl_.create_urllib3_context()
877+
proxy_ctx = urllib3.util.ssl_.create_urllib3_context(verify_flags=0)
873878
try:
874879
proxy_ctx.hostname_checks_common_name = True
875880
# PyPy doesn't like us setting 'hostname_checks_common_name'

0 commit comments

Comments
 (0)