Skip to content

Commit 0a795b8

Browse files
committed
Reject redirects in PyJWKClient fetches
1 parent f91ed44 commit 0a795b8

2 files changed

Lines changed: 99 additions & 13 deletions

File tree

‎jwt/jwks_client.py‎

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,19 @@
1414
from .jwk_set_cache import JWKSetCache
1515

1616

17+
class _NoRedirectHandler(urllib.request.HTTPRedirectHandler):
18+
def redirect_request(
19+
self,
20+
req: urllib.request.Request,
21+
fp: Any,
22+
code: int,
23+
msg: str,
24+
headers: Any,
25+
newurl: str,
26+
) -> None:
27+
return None
28+
29+
1730
class PyJWKClient:
1831
def __init__(
1932
self,
@@ -115,9 +128,11 @@ def fetch_data(self) -> Any:
115128
"""
116129
try:
117130
r = urllib.request.Request(url=self.uri, headers=self.headers)
118-
with urllib.request.urlopen(
119-
r, timeout=self.timeout, context=self.ssl_context
120-
) as response:
131+
handlers: list[Any] = [_NoRedirectHandler()]
132+
if self.ssl_context is not None:
133+
handlers.append(urllib.request.HTTPSHandler(context=self.ssl_context))
134+
opener = urllib.request.build_opener(*handlers)
135+
with opener.open(r, timeout=self.timeout) as response:
121136
jwk_set = json.load(response)
122137
except (URLError, TimeoutError) as e:
123138
if isinstance(e, HTTPError):

‎tests/test_jwks_client.py‎

Lines changed: 81 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22
import io
33
import json
44
import ssl
5+
import threading
56
import time
67
from collections.abc import Iterator
8+
from http.server import BaseHTTPRequestHandler, ThreadingHTTPServer
79
from unittest import mock
810
from urllib.error import HTTPError, URLError
911
from email.message import Message
@@ -12,6 +14,7 @@
1214

1315
import jwt
1416
from jwt import PyJWKClient
17+
from jwt.jwks_client import _NoRedirectHandler
1518
from jwt.api_jwk import PyJWK
1619
from jwt.exceptions import PyJWKClientConnectionError, PyJWKClientError
1720

@@ -50,7 +53,10 @@
5053

5154
@contextlib.contextmanager
5255
def mocked_success_response(data: object) -> Iterator[mock.Mock]:
53-
with mock.patch("urllib.request.urlopen") as urlopen_mock:
56+
with mock.patch("urllib.request.build_opener") as build_opener_mock:
57+
opener = mock.Mock()
58+
build_opener_mock.return_value = opener
59+
urlopen_mock = opener.open
5460
response = mock.Mock()
5561
response.__enter__ = mock.Mock(return_value=response)
5662
response.__exit__ = mock.Mock()
@@ -61,7 +67,10 @@ def mocked_success_response(data: object) -> Iterator[mock.Mock]:
6167

6268
@contextlib.contextmanager
6369
def mocked_failed_response() -> Iterator[mock.Mock]:
64-
with mock.patch("urllib.request.urlopen") as urlopen_mock:
70+
with mock.patch("urllib.request.build_opener") as build_opener_mock:
71+
opener = mock.Mock()
72+
build_opener_mock.return_value = opener
73+
urlopen_mock = opener.open
6574
urlopen_mock.side_effect = URLError("Fail to process the request.")
6675
yield urlopen_mock
6776

@@ -70,7 +79,10 @@ def mocked_failed_response() -> Iterator[mock.Mock]:
7079
def mocked_first_call_wrong_kid_second_call_correct_kid(
7180
response_data_one: object, response_data_two: object
7281
) -> Iterator[mock.Mock]:
73-
with mock.patch("urllib.request.urlopen") as urlopen_mock:
82+
with mock.patch("urllib.request.build_opener") as build_opener_mock:
83+
opener = mock.Mock()
84+
build_opener_mock.return_value = opener
85+
urlopen_mock = opener.open
7486
response = mock.Mock()
7587
response.__enter__ = mock.Mock(return_value=response)
7688
response.__exit__ = mock.Mock()
@@ -84,14 +96,20 @@ def mocked_first_call_wrong_kid_second_call_correct_kid(
8496

8597
@contextlib.contextmanager
8698
def mocked_timeout() -> Iterator[mock.Mock]:
87-
with mock.patch("urllib.request.urlopen") as urlopen_mock:
99+
with mock.patch("urllib.request.build_opener") as build_opener_mock:
100+
opener = mock.Mock()
101+
build_opener_mock.return_value = opener
102+
urlopen_mock = opener.open
88103
urlopen_mock.side_effect = TimeoutError("timed out")
89104
yield urlopen_mock
90105

91106

92107
@contextlib.contextmanager
93108
def mocked_http_error_response() -> Iterator[tuple[mock.Mock, HTTPError]]:
94-
with mock.patch("urllib.request.urlopen") as urlopen_mock:
109+
with mock.patch("urllib.request.build_opener") as build_opener_mock:
110+
opener = mock.Mock()
111+
build_opener_mock.return_value = opener
112+
urlopen_mock = opener.open
95113
http_error = HTTPError(
96114
url="https://example.com",
97115
code=401,
@@ -105,6 +123,50 @@ def mocked_http_error_response() -> Iterator[tuple[mock.Mock, HTTPError]]:
105123

106124
@crypto_required
107125
class TestPyJWKClient:
126+
def test_fetch_data_rejects_redirect_without_contacting_destination(self) -> None:
127+
destination_requests = 0
128+
129+
class RedirectHandler(BaseHTTPRequestHandler):
130+
def do_GET(self) -> None: # noqa: N802 - stdlib handler API
131+
nonlocal destination_requests
132+
if self.path == "/start":
133+
self.send_response(302)
134+
self.send_header("Location", f"{base_url}/destination")
135+
self.end_headers()
136+
else:
137+
destination_requests += 1
138+
self.send_response(200)
139+
self.end_headers()
140+
141+
def log_message(self, _format: str, *args: object) -> None:
142+
return
143+
144+
server = ThreadingHTTPServer(("127.0.0.1", 0), RedirectHandler)
145+
base_url = f"http://127.0.0.1:{server.server_port}"
146+
thread = threading.Thread(target=server.serve_forever, daemon=True)
147+
thread.start()
148+
try:
149+
client = PyJWKClient(
150+
f"{base_url}/start", headers={"Authorization": "secret"}
151+
)
152+
with pytest.raises(PyJWKClientConnectionError):
153+
client.fetch_data()
154+
assert destination_requests == 0
155+
finally:
156+
server.shutdown()
157+
server.server_close()
158+
thread.join()
159+
160+
def test_redirect_handler_does_not_follow_redirects(self) -> None:
161+
handler = _NoRedirectHandler()
162+
163+
assert (
164+
handler.redirect_request(
165+
mock.Mock(), mock.Mock(), 302, "Found", {}, "https://other.test"
166+
)
167+
is None
168+
)
169+
108170
def test_fetch_data_forwards_headers_to_correct_url(self) -> None:
109171
url = "https://dev-87evx9ru.auth0.com/.well-known/jwks.json"
110172

@@ -401,10 +463,19 @@ def test_get_jwt_set_sslcontext_default(self) -> None:
401463
ssl_ctx = ssl.create_default_context()
402464
jwks_client = PyJWKClient(url, ssl_context=ssl_ctx)
403465

404-
with mocked_success_response(RESPONSE_DATA_WITH_MATCHING_KID) as mock_request:
466+
with mock.patch("urllib.request.build_opener") as build_opener_mock:
467+
opener = mock.Mock()
468+
build_opener_mock.return_value = opener
469+
response = mock.Mock()
470+
response.__enter__ = mock.Mock(return_value=response)
471+
response.__exit__ = mock.Mock()
472+
response.read.return_value = json.dumps(RESPONSE_DATA_WITH_MATCHING_KID)
473+
opener.open.return_value = response
405474
jwk_set = jwks_client.get_jwk_set()
406-
request_call = mock_request.call_args
407-
assert request_call[1].get("context") is ssl_ctx
475+
handlers = build_opener_mock.call_args.args
476+
assert any(
477+
getattr(handler, "_context", None) is ssl_ctx for handler in handlers
478+
)
408479

409480
assert jwk_set is not None
410481

@@ -414,8 +485,8 @@ def test_get_jwt_set_sslcontext_no_ca(self) -> None:
414485
url, ssl_context=ssl.SSLContext(protocol=ssl.PROTOCOL_TLS_CLIENT)
415486
)
416487

417-
with mock.patch("urllib.request.urlopen") as urlopen_mock:
418-
urlopen_mock.side_effect = URLError(
488+
with mock.patch("urllib.request.build_opener") as build_opener_mock:
489+
build_opener_mock.return_value.open.side_effect = URLError(
419490
ssl.SSLCertVerificationError("certificate verify failed")
420491
)
421492
with pytest.raises(PyJWKClientError):

0 commit comments

Comments
 (0)