]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-91783: Document security considerations for shutil.unpack_archive (GH-91844)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Mon, 2 May 2022 17:36:05 +0000 (10:36 -0700)
committerGitHub <noreply@github.com>
Mon, 2 May 2022 17:36:05 +0000 (10:36 -0700)
(cherry picked from commit 4b297a9ffd4a1d420c1a8016f4ed2c7f1d298469)

Co-authored-by: Sam Ezeh <sam.z.ezeh@gmail.com>
Doc/library/shutil.rst
Misc/NEWS.d/next/Documentation/2022-04-23-00-22-54.gh-issue-91783.N09dRR.rst [new file with mode: 0644]

index 403df45b3966ad72491fcf9feccd11e414fd7c9e..193c01006171e2209ddd7bd79881f6961efb09f5 100644 (file)
@@ -630,10 +630,16 @@ provided.  They rely on the :mod:`zipfile` and :mod:`tarfile` modules.
 
    .. audit-event:: shutil.unpack_archive filename,extract_dir,format shutil.unpack_archive
 
+   .. warning::
+
+      Never extract archives from untrusted sources without prior inspection.
+      It is possible that files are created outside of the path specified in
+      the *extract_dir* argument, e.g. members that have absolute filenames
+      starting with "/" or filenames with two dots "..".
+
    .. versionchanged:: 3.7
       Accepts a :term:`path-like object` for *filename* and *extract_dir*.
 
-
 .. function:: register_unpack_format(name, extensions, function[, extra_args[, description]])
 
    Registers an unpack format. *name* is the name of the format and
diff --git a/Misc/NEWS.d/next/Documentation/2022-04-23-00-22-54.gh-issue-91783.N09dRR.rst b/Misc/NEWS.d/next/Documentation/2022-04-23-00-22-54.gh-issue-91783.N09dRR.rst
new file mode 100644 (file)
index 0000000..4d6be37
--- /dev/null
@@ -0,0 +1,2 @@
+Document security issues concerning the use of the function
+:meth:`shutil.unpack_archive`