Skip to content

Commit 2f630e1

Browse files
illia-vgpshead
andauthored
pythongh-102153: Start stripping C0 control and space chars in urlsplit (python#102508)
`urllib.parse.urlsplit` has already been respecting the WHATWG spec a bit python#25595. This adds more sanitizing to respect the "Remove any leading C0 control or space from input" [rule](https://url.spec.whatwg.org/#url-parsing:~:text=Remove%20any%20leading%20and%20trailing%20C0%20control%20or%20space%20from%20input.) in response to [CVE-2023-24329](https://nvd.nist.gov/vuln/detail/CVE-2023-24329). --------- Co-authored-by: Gregory P. Smith [Google] <greg@krypto.org>
1 parent b58bc8c commit 2f630e1

File tree

4 files changed

+119
-3
lines changed

4 files changed

+119
-3
lines changed

Diff for: Doc/library/urllib.parse.rst

+44-2
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,10 @@ or on combining URL components into a URL string.
159159
ParseResult(scheme='http', netloc='www.cwi.nl:80', path='/%7Eguido/Python.html',
160160
params='', query='', fragment='')
161161

162+
.. warning::
163+
164+
:func:`urlparse` does not perform validation. See :ref:`URL parsing
165+
security <url-parsing-security>` for details.
162166

163167
.. versionchanged:: 3.2
164168
Added IPv6 URL parsing capabilities.
@@ -324,8 +328,14 @@ or on combining URL components into a URL string.
324328
``#``, ``@``, or ``:`` will raise a :exc:`ValueError`. If the URL is
325329
decomposed before parsing, no error will be raised.
326330

327-
Following the `WHATWG spec`_ that updates RFC 3986, ASCII newline
328-
``\n``, ``\r`` and tab ``\t`` characters are stripped from the URL.
331+
Following some of the `WHATWG spec`_ that updates RFC 3986, leading C0
332+
control and space characters are stripped from the URL. ``\n``,
333+
``\r`` and tab ``\t`` characters are removed from the URL at any position.
334+
335+
.. warning::
336+
337+
:func:`urlsplit` does not perform validation. See :ref:`URL parsing
338+
security <url-parsing-security>` for details.
329339

330340
.. versionchanged:: 3.6
331341
Out-of-range port numbers now raise :exc:`ValueError`, instead of
@@ -338,6 +348,9 @@ or on combining URL components into a URL string.
338348
.. versionchanged:: 3.10
339349
ASCII newline and tab characters are stripped from the URL.
340350

351+
.. versionchanged:: 3.12
352+
Leading WHATWG C0 control and space characters are stripped from the URL.
353+
341354
.. _WHATWG spec: https://url.spec.whatwg.org/#concept-basic-url-parser
342355

343356
.. function:: urlunsplit(parts)
@@ -414,6 +427,35 @@ or on combining URL components into a URL string.
414427
or ``scheme://host/path``). If *url* is not a wrapped URL, it is returned
415428
without changes.
416429

430+
.. _url-parsing-security:
431+
432+
URL parsing security
433+
--------------------
434+
435+
The :func:`urlsplit` and :func:`urlparse` APIs do not perform **validation** of
436+
inputs. They may not raise errors on inputs that other applications consider
437+
invalid. They may also succeed on some inputs that might not be considered
438+
URLs elsewhere. Their purpose is for practical functionality rather than
439+
purity.
440+
441+
Instead of raising an exception on unusual input, they may instead return some
442+
component parts as empty strings. Or components may contain more than perhaps
443+
they should.
444+
445+
We recommend that users of these APIs where the values may be used anywhere
446+
with security implications code defensively. Do some verification within your
447+
code before trusting a returned component part. Does that ``scheme`` make
448+
sense? Is that a sensible ``path``? Is there anything strange about that
449+
``hostname``? etc.
450+
451+
What constitutes a URL is not universally well defined. Different applications
452+
have different needs and desired constraints. For instance the living `WHATWG
453+
spec`_ describes what user facing web clients such as a web browser require.
454+
While :rfc:`3986` is more general. These functions incorporate some aspects of
455+
both, but cannot be claimed compliant with either. The APIs and existing user
456+
code with expectations on specific behaviors predate both standards leading us
457+
to be very cautious about making API behavior changes.
458+
417459
.. _parsing-ascii-encoded-bytes:
418460

419461
Parsing ASCII Encoded Bytes

Diff for: Lib/test/test_urlparse.py

+60-1
Original file line numberDiff line numberDiff line change
@@ -654,14 +654,73 @@ def test_urlsplit_remove_unsafe_bytes(self):
654654
self.assertEqual(p.scheme, "http")
655655
self.assertEqual(p.geturl(), "http://www.python.org/javascript:alert('msg')/?query=something#fragment")
656656

657+
def test_urlsplit_strip_url(self):
658+
noise = bytes(range(0, 0x20 + 1))
659+
base_url = "http://User:Pass@www.python.org:080/doc/?query=yes#frag"
660+
661+
url = noise.decode("utf-8") + base_url
662+
p = urllib.parse.urlsplit(url)
663+
self.assertEqual(p.scheme, "http")
664+
self.assertEqual(p.netloc, "User:Pass@www.python.org:080")
665+
self.assertEqual(p.path, "/doc/")
666+
self.assertEqual(p.query, "query=yes")
667+
self.assertEqual(p.fragment, "frag")
668+
self.assertEqual(p.username, "User")
669+
self.assertEqual(p.password, "Pass")
670+
self.assertEqual(p.hostname, "www.python.org")
671+
self.assertEqual(p.port, 80)
672+
self.assertEqual(p.geturl(), base_url)
673+
674+
url = noise + base_url.encode("utf-8")
675+
p = urllib.parse.urlsplit(url)
676+
self.assertEqual(p.scheme, b"http")
677+
self.assertEqual(p.netloc, b"User:Pass@www.python.org:080")
678+
self.assertEqual(p.path, b"/doc/")
679+
self.assertEqual(p.query, b"query=yes")
680+
self.assertEqual(p.fragment, b"frag")
681+
self.assertEqual(p.username, b"User")
682+
self.assertEqual(p.password, b"Pass")
683+
self.assertEqual(p.hostname, b"www.python.org")
684+
self.assertEqual(p.port, 80)
685+
self.assertEqual(p.geturl(), base_url.encode("utf-8"))
686+
687+
# Test that trailing space is preserved as some applications rely on
688+
# this within query strings.
689+
query_spaces_url = "https://www.python.org:88/doc/?query= "
690+
p = urllib.parse.urlsplit(noise.decode("utf-8") + query_spaces_url)
691+
self.assertEqual(p.scheme, "https")
692+
self.assertEqual(p.netloc, "www.python.org:88")
693+
self.assertEqual(p.path, "/doc/")
694+
self.assertEqual(p.query, "query= ")
695+
self.assertEqual(p.port, 88)
696+
self.assertEqual(p.geturl(), query_spaces_url)
697+
698+
p = urllib.parse.urlsplit("www.pypi.org ")
699+
# That "hostname" gets considered a "path" due to the
700+
# trailing space and our existing logic... YUCK...
701+
# and re-assembles via geturl aka unurlsplit into the original.
702+
# django.core.validators.URLValidator (at least through v3.2) relies on
703+
# this, for better or worse, to catch it in a ValidationError via its
704+
# regular expressions.
705+
# Here we test the basic round trip concept of such a trailing space.
706+
self.assertEqual(urllib.parse.urlunsplit(p), "www.pypi.org ")
707+
708+
# with scheme as cache-key
709+
url = "//www.python.org/"
710+
scheme = noise.decode("utf-8") + "https" + noise.decode("utf-8")
711+
for _ in range(2):
712+
p = urllib.parse.urlsplit(url, scheme=scheme)
713+
self.assertEqual(p.scheme, "https")
714+
self.assertEqual(p.geturl(), "https://www.python.org/")
715+
657716
def test_attributes_bad_port(self):
658717
"""Check handling of invalid ports."""
659718
for bytes in (False, True):
660719
for parse in (urllib.parse.urlsplit, urllib.parse.urlparse):
661720
for port in ("foo", "1.5", "-1", "0x10", "-0", "1_1", " 1", "1 ", "६"):
662721
with self.subTest(bytes=bytes, parse=parse, port=port):
663722
netloc = "www.example.net:" + port
664-
url = "http://" + netloc
723+
url = "http://" + netloc + "/"
665724
if bytes:
666725
if netloc.isascii() and port.isascii():
667726
netloc = netloc.encode("ascii")

Diff for: Lib/urllib/parse.py

+12
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@
2525
scenarios for parsing, and for backward compatibility purposes, some
2626
parsing quirks from older RFCs are retained. The testcases in
2727
test_urlparse.py provides a good indicator of parsing behavior.
28+
29+
The WHATWG URL Parser spec should also be considered. We are not compliant with
30+
it either due to existing user code API behavior expectations (Hyrum's Law).
31+
It serves as a useful guide when making changes.
2832
"""
2933

3034
from collections import namedtuple
@@ -80,6 +84,10 @@
8084
'0123456789'
8185
'+-.')
8286

87+
# Leading and trailing C0 control and space to be stripped per WHATWG spec.
88+
# == "".join([chr(i) for i in range(0, 0x20 + 1)])
89+
_WHATWG_C0_CONTROL_OR_SPACE = '\x00\x01\x02\x03\x04\x05\x06\x07\x08\t\n\x0b\x0c\r\x0e\x0f\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f '
90+
8391
# Unsafe bytes to be removed per WHATWG spec
8492
_UNSAFE_URL_BYTES_TO_REMOVE = ['\t', '\r', '\n']
8593

@@ -464,6 +472,10 @@ def urlsplit(url, scheme='', allow_fragments=True):
464472
"""
465473

466474
url, scheme, _coerce_result = _coerce_args(url, scheme)
475+
# Only lstrip url as some applications rely on preserving trailing space.
476+
# (https://url.spec.whatwg.org/#concept-basic-url-parser would strip both)
477+
url = url.lstrip(_WHATWG_C0_CONTROL_OR_SPACE)
478+
scheme = scheme.strip(_WHATWG_C0_CONTROL_OR_SPACE)
467479

468480
for b in _UNSAFE_URL_BYTES_TO_REMOVE:
469481
url = url.replace(b, "")
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
:func:`urllib.parse.urlsplit` now strips leading C0 control and space
2+
characters following the specification for URLs defined by WHATWG in
3+
response to CVE-2023-24329. Patch by Illia Volochii.

0 commit comments

Comments
 (0)