gh-91783: Document security considerations for shutil.unpack_archive (#91844)

This commit is contained in:
Sam Ezeh 2022-05-02 18:15:04 +01:00 committed by GitHub
parent feb45d0ae9
commit 4b297a9ffd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 1 deletions

View File

@ -636,10 +636,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

View File

@ -0,0 +1,2 @@
Document security issues concerning the use of the function
:meth:`shutil.unpack_archive`