Skip to content

gh-108948: tarfile should handle sticky bit in FreeBSD #108950

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
sorcio wants to merge 21 commits into from
Closed

gh-108948: tarfile should handle sticky bit in FreeBSD #108950

Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
6a4be8f
tarfile: fix sticky bit handling in FreeBSD
sorcio Sep 5, 2023
50729f7
📜🤖 Added by blurb_it.
blurb-it[bot] Sep 5, 2023
3587710
fix blurb
sorcio Sep 5, 2023
41491bb
fix blurb
sorcio Sep 5, 2023
4f6536d
fix chmod exception handler in tarfile
sorcio Sep 5, 2023
fe7dfed
chain exceptions
sorcio Sep 5, 2023
4009573
test exception branches
sorcio Sep 6, 2023
7b784b5
Update Lib/test/test_tarfile.py
sorcio Sep 7, 2023
02d7c21
add explanatory comment
sorcio Sep 15, 2023
94efbbb
apply review suggestions
sorcio Sep 15, 2023
d1824c8
fix expected mode
sorcio Sep 15, 2023
bd1dba7
avoid deprecation warnings
sorcio Sep 15, 2023
417e31a
Update Misc/NEWS.d/next/Library/2023-09-05-17-11-17.gh-issue-108948.H…
sorcio Sep 16, 2023
83c08fc
move tarfile eftype test
sorcio Sep 16, 2023
54f5548
eftype test should handle macos
sorcio Sep 16, 2023
b60ada6
use can_chmod_set_sticky helper where possible
sorcio Sep 16, 2023
5a51aab
bit of polishing
sorcio Sep 16, 2023
cac6595
split and refactor tests
sorcio Sep 16, 2023
23a6fd5
make TarFile.chmod slightly more readable
sorcio Sep 16, 2023
060bcb2
document tarfile behavior with sticky bit on files
sorcio Sep 16, 2023
5ae3e30
apply review suggestions
sorcio Sep 18, 2023
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
Prev Previous commit
Next Next commit
eftype test should handle macos
  • Loading branch information
@sorcio
sorcio committed Sep 16, 2023
commit 54f5548b0e7dbefd1d12e43cfdf96e5903099e2a
31 changes: 30 additions & 1 deletion Lib/test/test_tarfile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3057,6 +3057,32 @@ def test_keyword_only(self, mock_geteuid):
tarfl.extract, filename_1, TEMPDIR, False, True)


_can_chmod_set_sticky = None


def can_chmod_set_sticky():
Copy link
Copy Markdown
Member

@vstinner vstinner Sep 16, 2023

Choose a reason for hiding this comment

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

You should move it to support.os_helper.

I suggest to rename to can_chmod_set_sticky_bit().

Copy link
Copy Markdown
Contributor Author

@sorcio sorcio Sep 18, 2023

Choose a reason for hiding this comment

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

Done.

def can_chmod_set_sticky_inner():
if not os_helper.can_chmod():
return False
filename = os_helper.TESTFN + "-chmod-sticky"
Copy link
Copy Markdown
Member

@vstinner vstinner Sep 16, 2023

Choose a reason for hiding this comment

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

honestly, just use "chmod-sticky", to avoid further troubles with non-ASCII filenames.

Copy link
Copy Markdown
Contributor Author

@sorcio sorcio Sep 18, 2023

Choose a reason for hiding this comment

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

Decided not to do it, and instead just use TESTFN like can_chmod() does. The concern is fair but I don't want to touch os_helper more than necessary.

try:
with open(filename, "w") as f:
os.chmod(f.fileno(), 0o666)
try:
os.chmod(f.fileno(), 0o666 | stat.S_ISVTX)
except OSError:
return False
mode = os.stat(f.fileno()).st_mode
return bool(mode & stat.S_ISVTX)
finally:
os.unlink(filename)
Copy link
Copy Markdown
Member

@vstinner vstinner Sep 16, 2023

Choose a reason for hiding this comment

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

It's safer to use os_helper.unlink() here.

Copy link
Copy Markdown
Contributor Author

@sorcio sorcio Sep 18, 2023

Choose a reason for hiding this comment

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

Done.


global _can_chmod_set_sticky
if _can_chmod_set_sticky is None:
_can_chmod_set_sticky = can_chmod_set_sticky_inner()
return _can_chmod_set_sticky


@os_helper.skip_unless_working_chmod
class FileModesTest(unittest.TestCase):
@unittest.skipUnless(hasattr(errno, "EFTYPE"), "errno.EFTYPE required")
Expand All @@ -3076,7 +3102,10 @@ def test_extract_chmod_eftype(self):
# this should not raise:
tar.extract("sticky1", DIR, filter="fully_trusted")
got_mode = stat.filemode(os.stat(os.path.join(DIR, "sticky1")).st_mode)
expected_mode = "-rwxrwxrwx" if os.geteuid() != 0 else "-rwxrwxrwt"
if can_chmod_set_sticky():
expected_mode = "-rwxrwxrwt"
else:
expected_mode = "-rwxrwxrwx"
self.assertEqual(got_mode, expected_mode)

# but we can create a situation where it does raise:
Expand Down