Fix code scanning alert no. 4: Arbitrary file write during tarfile extraction #495
Conversation
…traction Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
📝 WalkthroughWalkthroughThe changes in this pull request involve modifications to the Changes
Possibly related PRs
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #495 +/- ##
==========================================
- Coverage 60.19% 60.15% -0.05%
==========================================
Files 39 39
Lines 3859 3862 +3
==========================================
Hits 2323 2323
- Misses 1536 1539 +3 ☔ View full report in Codecov by Sentry. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- dpdispatcher/contexts/ssh_context.py (1 hunks)
🧰 Additional context used
🪛 GitHub Check: codecov/patch
dpdispatcher/contexts/ssh_context.py
[warning] 975-977: dpdispatcher/contexts/ssh_context.py#L975-L977
Added lines #L975 - L977 were not covered by tests
| for member in tar.getmembers(): | ||
| if os.path.isabs(member.name) or ".." in member.name: | ||
| raise ValueError(f"Illegal tar archive entry: {member.name}") |
There was a problem hiding this comment.
Add unit tests for the new security validation
Lines 975-977 introduce critical validation to prevent security vulnerabilities. Currently, these lines are not covered by tests. Adding unit tests will ensure that the validation works as intended and remains effective against potential directory traversal attacks.
🧰 Tools
🪛 GitHub Check: codecov/patch
[warning] 975-977: dpdispatcher/contexts/ssh_context.py#L975-L977
Added lines #L975 - L977 were not covered by tests
Enhance directory traversal protection in tar extraction
The current validation in the _get_files method checks if member.name is absolute or contains ".." to prevent directory traversal attacks. However, this approach may not be sufficient, as attackers can craft filenames like "../" or use multiple consecutive dots to bypass the check.
Consider normalizing the path using os.path.normpath() and validating that the resulting path does not escape the intended extraction directory.
Apply this diff to improve the security validation:
for member in tar.getmembers():
+ member_path = os.path.normpath(member.name)
- if os.path.isabs(member.name) or ".." in member.name:
+ if os.path.isabs(member_path) or member_path.startswith(".."):
raise ValueError(f"Illegal tar archive entry: {member.name}")
+ member.name = member_path📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| for member in tar.getmembers(): | |
| if os.path.isabs(member.name) or ".." in member.name: | |
| raise ValueError(f"Illegal tar archive entry: {member.name}") | |
| for member in tar.getmembers(): | |
| member_path = os.path.normpath(member.name) | |
| if os.path.isabs(member_path) or member_path.startswith(".."): | |
| raise ValueError(f"Illegal tar archive entry: {member.name}") | |
| member.name = member_path |
🧰 Tools
🪛 GitHub Check: codecov/patch
[warning] 975-977: dpdispatcher/contexts/ssh_context.py#L975-L977
Added lines #L975 - L977 were not covered by tests
|
I am not sure if it is worth adding this as it adds extra cost. |
Fixes https://github.com/deepmodeling/dpdispatcher/security/code-scanning/4
To fix the problem, we need to ensure that the paths of the files within the tar archive do not contain any directory traversal elements (
..). This can be done by checking each file path before extraction and raising an error if any path is found to be unsafe.Steps to fix:
... If it does, raise an error.Suggested fixes powered by Copilot Autofix. Review carefully before merging.
Summary by CodeRabbit
New Features
rsyncwhen available.Bug Fixes
Documentation