You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
[Security] shutil unpack_archive docs should clarify the security implications #91783
The tarfile module is vulnerable to Tar Slip and various other symlink-related attacks. These are known issues that are currently being discussed in the community (see: #65308, #73974).
While tarfile docs show prominent red boxes entitling developers to be careful with tarballs coming from untrusted sources, shutil unpack_archive says nothing about it. However, unpack_archive will leverage tarfile behind the scenes if it sees a .tar.gz (or similar) extension, hence causing unpack_archive inherit all tarfile's security issues.
On the other hand, zipfile is reasonably well protected against these problems. But I believe it's easy for developers to misuse unpack_archive under the assumption that it is equivalent to zipfile, and hence use it without properly sanitizing the input files. And as long as the application only receives zip files there will be no problem, but as soon as a malicious tar file is received, the vulnerabilities are triggered. The problem is that zipfile only accepts zip files, throwing an exception otherwise. But unpack_archive accepts many other formats as well as zip.
We should backport docs improvements to at least all the bugfix branches. Since this is a security warning, we should even consider backporting to the security-only branches (3.7 and 3.8).
Activity
dignissimus commentedon Apr 22, 2022
Linking documentation for future reference. I wonder if these documentation changes should be back-ported?
Documentation
tarfile: https://docs.python.org/3/library/tarfile.html#tarfile.TarFile.extract
zipfile: https://docs.python.org/3/library/zipfile.html#zipfile.ZipFile.extract
gh-91783: Document security considerations for shutil.unpack_archive (#…
pythongh-91783: Document security considerations for shutil.unpack_ar…
JelleZijlstra commentedon May 2, 2022
We should backport docs improvements to at least all the bugfix branches. Since this is a security warning, we should even consider backporting to the security-only branches (3.7 and 3.8).
gh-91783: Document security considerations for shutil.unpack_archive (G…
gh-91783: Document security considerations for shutil.unpack_archive (G…
pythongh-91783: Document security considerations for shutil.unpack_ar…