Skip to content
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.

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

[1.0] Ensure Git parameters are safe #203

Merged
merged 1 commit into from Sep 17, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 19 additions & 1 deletion poetry/core/vcs/git.py
Expand Up @@ -92,6 +92,11 @@
]


class GitError(RuntimeError):

pass


class ParsedUrl:
def __init__(
self,
Expand Down Expand Up @@ -209,7 +214,9 @@ def config(self): # type: () -> GitConfig
return self._config

def clone(self, repository, dest): # type: (str, Path) -> str
return self.run("clone", "--recurse-submodules", repository, str(dest))
self._check_parameter(repository)

return self.run("clone", "--recurse-submodules", "--", repository, str(dest))

def checkout(self, rev, folder=None): # type: (str, Optional[Path]) -> str
args = []
Expand All @@ -224,6 +231,8 @@ def checkout(self, rev, folder=None): # type: (str, Optional[Path]) -> str
folder.as_posix(),
]

self._check_parameter(rev)

args += ["checkout", rev]

return self.run(*args)
Expand All @@ -241,6 +250,8 @@ def rev_parse(self, rev, folder=None): # type: (str, Optional[Path]) -> str
folder.as_posix(),
]

self._check_parameter(rev)

# We need "^0" (an alternative to "^{commit}") to ensure that the
# commit SHA of the commit the tag points to is returned, even in
# the case of annotated tags.
Expand Down Expand Up @@ -301,3 +312,10 @@ def run(self, *args, **kwargs): # type: (*Any, **Any) -> str
return decode(
subprocess.check_output(["git"] + list(args), stderr=subprocess.STDOUT)
).strip()

def _check_parameter(self, parameter): # type: (str) -> None
"""
Checks a git parameter to avoid unwanted code execution.
"""
if parameter.strip().startswith("-"):
raise GitError("Invalid Git parameter: {}".format(parameter))
17 changes: 17 additions & 0 deletions tests/vcs/test_vcs.py
@@ -1,6 +1,8 @@
import pytest

from poetry.core.utils._compat import Path
from poetry.core.vcs.git import Git
from poetry.core.vcs.git import GitError
from poetry.core.vcs.git import GitUrl
from poetry.core.vcs.git import ParsedUrl

Expand Down Expand Up @@ -259,3 +261,18 @@ def test_parse_url_should_fail():

with pytest.raises(ValueError):
ParsedUrl.parse(url)


def test_git_clone_raises_error_on_invalid_repository():
with pytest.raises(GitError):
Git().clone("-u./payload", Path("foo"))


def test_git_checkout_raises_error_on_invalid_repository():
with pytest.raises(GitError):
Git().checkout("-u./payload")


def test_git_rev_parse_raises_error_on_invalid_repository():
with pytest.raises(GitError):
Git().rev_parse("-u./payload")