Skip to content

bpo-12800: 'tarfile.StreamError: seeking backwards is not allowed' when extract symlink #13217

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

bpo-12800: 'tarfile.StreamError: seeking backwards is not allowed' when extract symlink #13217

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b3f1336
bpo-12800: Extracting a symlink from a tarball using the tarfile
websurfer5 May 9, 2019
66ffbac
📜🤖 Added by blurb_it.
blurb-it[bot] May 9, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Lib/tarfile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2226,6 +2226,9 @@ def makelink(self, tarinfo, targetpath):
try:
# For systems that support symbolic and hard links.
if tarinfo.issym():
if os.path.islink(targetpath) or os.path.isfile(targetpath):
os.unlink(targetpath)

os.symlink(tarinfo.linkname, targetpath)
else:
# See extract().
Expand Down
64 changes: 64 additions & 0 deletions Lib/test/test_tarfile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2498,6 +2498,70 @@ def test_partial_input_bz2(self):
self._test_partial_input("r:bz2")


class SymlinkOverwriteTest(unittest.TestCase):
# The testcase checks for correct overwriting of an
# existing symlink (issue #12800)

@support.skip_unless_symlink
def test_overwrite_symlink(self):
tmpdir = support.temp_cwd('overwrite_symlink')
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

temp_cwd is a context manager, please use it in a with statement (also you're not using the variable at all which is strange).

source = 'source'
link = 'link'
try:
with open(source, 'wb'):
pass
os.symlink(source, link)
with tarfile.open(tmpname, 'w') as tar:
tar.add(source, arcname=os.path.basename(source))
tar.add(link, arcname=os.path.basename(link))

with open(tmpname, 'rb') as fileobj:
with tarfile.open(fileobj=fileobj, mode='r|') as tar:
tar.extractall(path=support.SAVEDCWD)
finally:
try:
os.unlink(link)
except:
pass

try:
os.unlink(source)
except:
pass
Comment on lines +2521 to +2530
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If using a temporary directory for your test (temp_cwd in a context manager for example), you should not need this at all.


@support.skip_unless_symlink
def test_overwrite_file_with_symlink(self):
tmpdir = support.temp_cwd('overwrite_file_with_symlink')
source = 'source'
link = 'link'
try:
with open(source, 'wb'):
pass
os.symlink(source, link)
with tarfile.open(tmpname, 'w') as tar:
tar.add(source, arcname=os.path.basename(source))
tar.add(link, arcname=os.path.basename(link))

os.unlink(link)

with open(link, 'wb'):
pass

with open(tmpname, 'rb') as fileobj:
with tarfile.open(fileobj=fileobj, mode='r|') as tar:
tar.extractall(path=support.SAVEDCWD)
finally:
try:
os.unlink(link)
except:
pass

try:
os.unlink(source)
except:
pass


def root_is_uid_gid_0():
try:
import pwd, grp
Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Library/2019-05-09-18-37-37.bpo-12800.TyjRQq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Extracting a symlink from a tarball using the tarfile module in stream mode ('r|') fails with an exception when a file or symlink of the same name already exists. The fix is to remove the existing file or symlink before extraction.