Pair tarfile hard-link / symlink checks with the correct predicate#38390
Pair tarfile hard-link / symlink checks with the correct predicate#38390Chessing234 wants to merge 1 commit intoopenedx:masterfrom
Conversation
_check_tarinfo guarded the "Hard link" branch with finfo.issym() and
the "Symlink" branch with finfo.islnk(). Those predicates are swapped:
tarfile.TarInfo.issym() returns True for symbolic links, and
TarInfo.islnk() returns True for hard links. As a result a bad
symbolic link raises SuspiciousOperation("Hard link") and a bad hard
link raises SuspiciousOperation("Symlink"), and the debug log attributes
the wrong kind of link to the offending archive member. Swap the
predicates so they match their block labels and debug messages. Both
kinds of unsafe link remain blocked, so security behaviour is unchanged;
only the reported classification is corrected.
|
Thanks for the pull request, @Chessing234! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Submit a signed contributor agreement (CLA)
If you've signed an agreement in the past, you may need to re-sign. Once you've signed the CLA, please allow 1 business day for it to be processed. 🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
Bug
_check_tarinfoinopenedx/core/lib/extract_archive.pyreports thewrong link type when it blocks an unsafe archive member: a malicious
symbolic link is logged and raised as a "Hard link", and a malicious
hard link is logged and raised as a "Symlink".
Root cause
Per Python's
tarfilemodule:TarInfo.issym()— Return True if it is a symbolic link.TarInfo.islnk()— Return True if it is a hard link.So the predicate guarding each branch is the opposite of its label and
debug message. Both kinds of unsafe link are still blocked (because both
arms exist), but the error message and log line attribute the wrong
category — which is misleading for operators looking at the log and for
any downstream code keying off the
SuspiciousOperationreason string.Why the fix is correct
finfo.islnk()is the authoritative hard-link predicate, so itbelongs with the "Hard link" label and debug line.
finfo.issym()is the symbolic-link predicate, so it belongs withthe "Symlink" label and debug line.
raisesites and thesubsequent
finfo.isdev()check are unchanged, and every unsafe linkremains blocked.
Change
openedx/core/lib/extract_archive.py: swapfinfo.issym()andfinfo.islnk()in_check_tarinfoso each predicate matches itsblock label. Two-line change.