FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Reject unsafe submodule checkout paths by Byron · Pull Request #2225 · gitpython-developers/GitPython · GitHub

  1. gitpython-developers
  2. GitPython

Repository navigation

Reject unsafe submodule checkout paths #2225

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

Merged
Byron merged 1 commit into from
Sep 1, 2026
+65 −0
Conversation 2 Commits 1 Checks 53 Files changed 3
Merged

Reject unsafe submodule checkout paths #2225

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension .py  (2) .rst  (1) All 2 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
13 changes: 13 additions & 0 deletions doc/source/changes.rst
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,19 @@
Changelog
=========

3.1.62
======

Security fixes for

* https://github.com/gitpython-developers/GitPython/security/advisories/GHSA-59cr-6r3x-644w

If you can, also try and provide feedback on the upcoming v4 branch
https://github.com/gitpython-developers/GitPython/pull/2177 - patches welcome.

See the following for all changes.
https://github.com/gitpython-developers/GitPython/releases/tag/3.1.62

3.1.61
======

Expand Down
12 changes: 12 additions & 0 deletions git/objects/submodule/base.py
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -414,6 +414,18 @@ def _to_relative_path(cls, parent_repo: "Repo", path: PathLike) -> PathLike:

return path

@property
def abspath(self) -> PathLike:
root = self.repo.working_tree_dir
if root is None:
return super().abspath
path = root
for component in os.fspath(self._to_relative_path(self.repo, self.path)).split("/"):
path = join_path_native(path, component)
if osp.islink(path):
raise ValueError("Submodule checkout path %r contains a symbolic link" % self.path)
return path

@classmethod
def _write_git_file_and_module_config(cls, working_tree_dir: PathLike, module_abspath: PathLike) -> None:
"""Write a ``.git`` file containing a (preferably) relative path to the actual
Expand Down
40 changes: 40 additions & 0 deletions test/test_submodule.py
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -1369,6 +1369,46 @@ class Repo:
osp.join(Repo.working_tree_dir + "-other", "module"),
)

@with_rw_directory
def test_update_rejects_checkout_path_outside_parent(self, rwdir):
parent = git.Repo.init(osp.join(rwdir, "parent"))
submodule = Submodule(
parent,
Submodule.NULL_BIN_SHA,
name="module",
path=osp.join("..", "outside"),
url="unused",
)

with mock.patch.object(Submodule, "_clone_repo", side_effect=AssertionError("clone attempted")):
with pytest.raises(ValueError, match="is not in repository"):
submodule.update(init=True)

@with_rw_directory
def test_update_rejects_checkout_path_through_symlink(self, rwdir):
parent = git.Repo.init(osp.join(rwdir, "parent"))
os.mkdir(osp.join(parent.working_tree_dir, "target"))
os.symlink("target", osp.join(parent.working_tree_dir, "link"))
Comment on lines +1390 to +1391
submodule = Submodule(
parent,
Submodule.NULL_BIN_SHA,
name="module",
path=osp.join("link", "module"),
url="unused",
)

with mock.patch.object(Submodule, "_clone_repo", side_effect=AssertionError("clone attempted")):
with pytest.raises(ValueError, match="contains a symbolic link"):
submodule.update(init=True)

@with_rw_directory
def test_update_rejects_checkout_path_at_parent_root(self, rwdir):
parent = git.Repo.init(osp.join(rwdir, "parent"))
submodule = Submodule(parent, Submodule.NULL_BIN_SHA, name="module", path=".", url="unused")

with pytest.raises(ValueError, match="must not be the repository root"):
submodule.update(init=True)

@skipUnless(sys.platform == "win32", "Specifically for Windows.")
@with_rw_directory
def test_to_relative_path_windows_path_kinds(self, rwdir):
Expand Down
Loading
Back | FazBrowse Home | New Git URL