Repository navigation
Reject unsafe submodule checkout paths - #2225
Merged
Byron merged 1 commit intoSep 1, 2026
Merged
Byron merged 1 commit into
Byron merged 1 commit into
Conversation
Copy link
Copy Markdown
Member
Sorry, something went wrong.
Byron
force-pushed
the
submodule-path-hardening
branch
from
dcd956a to
c0ed846
Compare
September 1, 2026 10:19
GHSA-59cr-6r3x-644w identifies that submodule update paths could reach filesystem operations without the containment check already used by add and move. Add a regression that proves update rejects a parent-directory checkout path before cloning, and override Submodule.abspath to apply the shared _to_relative_path guard for every filesystem consumer. Git baseline: git.git read-cache.c verify_path_internal() rejects invalid index paths, covered for parent traversal by t/t9300-fast-import.sh. Assisted-by: GPT 5.6 Co-authored-by: GPT 5.6 <codex@openai.com>
Byron
force-pushed
the
submodule-path-hardening
branch
from
c0ed846 to
1ed0ebc
Compare
September 1, 2026 11:49
Byron
marked this pull request as ready for review
September 1, 2026 12:51
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Pull request overview
This PR hardens submodule checkout path handling to mitigate GHSA-59cr-6r3x-644w by ensuring submodule paths are confined to the parent repository before filesystem operations, including rejecting paths that traverse through symlink components.
Changes:
- Add Submodule.abspath validation that rejects checkout paths containing symbolic-link components under a non-bare parent repo.
- Add regression tests covering updates with checkout paths outside the parent, through a symlink, and at the repository root.
- Document the security fix in the changelog for the 3.1.62 release entry.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| git/objects/submodule/base.py | Adds symlink-component rejection during submodule absolute path resolution. |
| test/test_submodule.py | Adds tests asserting update(init=True) rejects unsafe checkout paths. |
| doc/source/changes.rst | Adds a 3.1.62 changelog entry referencing the security advisory. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Sorry, something went wrong.
Comment thread
test/test_submodule.py
Comment on lines
+1390
to
+1391
| os.mkdir(osp.join(parent.working_tree_dir, "target")) | ||
| os.symlink("target", osp.join(parent.working_tree_dir, "link")) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Tasks
This section is for Byron only. Models continuing this PR must not add, remove, check, uncheck, rename, or reorder checkboxes here.
Everything below this line was generated by Codex GPT-5.
Created by Codex on behalf of Byron. Byron will review before this is ready to merge.
Summary
Confine submodule checkout paths to the parent repository before filesystem operations. The shared absolute-path accessor now rejects parent traversal, paths resolving through symlinks outside the worktree, and paths resolving to the worktree root.
Advisory
GHSA-59cr-6r3x-644w
Advisory summary
Validation
Git behavior reference: commit e8d0608944, submodule.c::validate_submodule_path(), and t/t7423-submodule-symlinks.sh reject every existing symlink component before submodule update. read-cache.c::verify_path_internal() rejects parent-traversing index paths.
Commits