]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-123726: Document caveats of zipfile.Path around name sanitization (#130537)
authorAffan Shaikhsurab <51104750+AffanShaikhsurab@users.noreply.github.com>
Sat, 8 Mar 2025 21:37:05 +0000 (03:07 +0530)
committerGitHub <noreply@github.com>
Sat, 8 Mar 2025 21:37:05 +0000 (16:37 -0500)
Add a note to the `zipfile.Path` class documentation clarifying that it does not sanitize filenames. This emphasizes the caller's responsibility to validate or sanitize inputs, especially when handling untrusted ZIP archives, to prevent path traversal vulnerabilities. The note also references the `extract` and `extractall` methods for comparison and suggests using `os.path.abspath` and `os.path.commonpath` for safe filename resolution.

Doc/library/zipfile.rst

index afe1cd5c75fcbb7970818557d1e622dbaf7847f3..0e6439f75334e9a48072127623fb977af75c8428 100644 (file)
@@ -554,6 +554,14 @@ Path Objects
    e.g. 'dir/file.txt', 'dir/', or ''. Defaults to the empty string,
    indicating the root.
 
+   .. note::
+      The :class:`Path` class does not sanitize filenames within the ZIP archive. Unlike
+      the :meth:`ZipFile.extract` and :meth:`ZipFile.extractall` methods, it is the
+      caller's responsibility to validate or sanitize filenames to prevent path traversal
+      vulnerabilities (e.g., filenames containing ".." or absolute paths). When handling
+      untrusted archives, consider resolving filenames using :func:`os.path.abspath`
+      and checking against the target directory with :func:`os.path.commonpath`.
+
 Path objects expose the following features of :mod:`pathlib.Path`
 objects: