Skip to content

sec: added --end-of-options to prevent unintended options #118

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

sec: added --end-of-options to prevent unintended options #118

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
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions repo.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ func Init(path string, opts ...InitOptions) error {
if opt.Bare {
cmd.AddArgs("--bare")
}
cmd.AddArgs("--end-of-options")
_, err = cmd.RunInDirWithTimeout(opt.Timeout, path)
return err
}
Expand Down Expand Up @@ -157,6 +158,7 @@ func Clone(url, dst string, opts ...CloneOptions) error {
cmd.AddArgs("--depth", strconv.FormatUint(opt.Depth, 10))
}

cmd.AddArgs("--end-of-options")
_, err = cmd.AddArgs(url, dst).RunWithTimeout(opt.Timeout)
return err
}
Expand Down Expand Up @@ -259,7 +261,7 @@ func Push(repoPath, remote, branch string, opts ...PushOptions) error {
opt = opts[0]
}

cmd := NewCommand("push").AddOptions(opt.CommandOptions).AddArgs(remote, branch)
cmd := NewCommand("push").AddOptions(opt.CommandOptions).AddArgs("--end-of-options", remote, branch)
_, err := cmd.RunInDirWithTimeout(opt.Timeout, repoPath)
return err
}
Expand Down Expand Up @@ -346,7 +348,7 @@ func Reset(repoPath, rev string, opts ...ResetOptions) error {
cmd.AddArgs("--hard")
}

_, err := cmd.AddOptions(opt.CommandOptions).AddArgs(rev).RunInDir(repoPath)
_, err := cmd.AddOptions(opt.CommandOptions).AddArgs("--end-of-options", rev).RunInDir(repoPath)
return err
}

Expand Down Expand Up @@ -382,7 +384,7 @@ func Move(repoPath, src, dst string, opts ...MoveOptions) error {
opt = opts[0]
}

_, err := NewCommand("mv").AddOptions(opt.CommandOptions).AddArgs(src, dst).RunInDirWithTimeout(opt.Timeout, repoPath)
_, err := NewCommand("mv").AddOptions(opt.CommandOptions).AddArgs("--end-of-options", src, dst).RunInDirWithTimeout(opt.Timeout, repoPath)
return err
}

Expand Down Expand Up @@ -549,7 +551,7 @@ func ShowNameStatus(repoPath, rev string, opts ...ShowNameStatusOptions) (*NameS
stderr := new(bytes.Buffer)
cmd := NewCommand("show", "--name-status", "--pretty=format:''").
AddOptions(opt.CommandOptions).
AddArgs(rev)
AddArgs("--end-of-options", rev)
err := cmd.RunInDirPipelineWithTimeout(opt.Timeout, w, stderr, repoPath)
_ = w.Close() // Close writer to exit parsing goroutine
if err != nil {
Expand Down
8 changes: 6 additions & 2 deletions repo_commit.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ func (r *Repository) Log(rev string, opts ...LogOptions) ([]*Commit, error) {

cmd := NewCommand("log").
AddOptions(opt.CommandOptions).
AddArgs("--pretty="+LogFormatHashOnly, rev)
AddArgs("--pretty=" + LogFormatHashOnly)
if opt.MaxCount > 0 {
cmd.AddArgs("--max-count=" + strconv.Itoa(opt.MaxCount))
}
Expand All @@ -237,6 +237,7 @@ func (r *Repository) Log(rev string, opts ...LogOptions) ([]*Commit, error) {
if opt.RegexpIgnoreCase {
cmd.AddArgs("--regexp-ignore-case")
}
cmd.AddArgs("--end-of-options", rev)
cmd.AddArgs("--")
if opt.Path != "" {
cmd.AddArgs(escapePath(opt.Path))
Expand Down Expand Up @@ -406,6 +407,7 @@ func DiffNameOnly(repoPath, base, head string, opts ...DiffNameOnlyOptions) ([]s
cmd := NewCommand("diff").
AddOptions(opt.CommandOptions).
AddArgs("--name-only")
cmd.AddArgs("--end-of-options")
if opt.NeedsMergeBase {
cmd.AddArgs(base + "..." + head)
} else {
Expand Down Expand Up @@ -471,7 +473,8 @@ func (r *Repository) RevListCount(refspecs []string, opts ...RevListCountOptions

cmd := NewCommand("rev-list").
AddOptions(opt.CommandOptions).
AddArgs("--count")
AddArgs("--count").
AddArgs("--end-of-options")
cmd.AddArgs(refspecs...)
cmd.AddArgs("--")
if opt.Path != "" {
Expand Down Expand Up @@ -512,6 +515,7 @@ func (r *Repository) RevList(refspecs []string, opts ...RevListOptions) ([]*Comm
}

cmd := NewCommand("rev-list").AddOptions(opt.CommandOptions)
cmd.AddArgs("--end-of-options")
cmd.AddArgs(refspecs...)
cmd.AddArgs("--")
if opt.Path != "" {
Expand Down
14 changes: 7 additions & 7 deletions repo_diff.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,20 +45,20 @@ func (r *Repository) Diff(rev string, maxFiles, maxFileLines, maxLineChars int,
if commit.ParentsCount() == 0 {
cmd = cmd.AddArgs("show").
AddOptions(opt.CommandOptions).
AddArgs("--full-index", rev)
AddArgs("--full-index", "--end-of-options", rev)
} else {
c, err := commit.Parent(0)
if err != nil {
return nil, err
}
cmd = cmd.AddArgs("diff").
AddOptions(opt.CommandOptions).
AddArgs("--full-index", "-M", c.ID.String(), rev)
AddArgs("--full-index", "-M", c.ID.String(), "--end-of-options", rev)
}
} else {
cmd = cmd.AddArgs("diff").
AddOptions(opt.CommandOptions).
AddArgs("--full-index", "-M", opt.Base, rev)
AddArgs("--full-index", "-M", opt.Base, "--end-of-options", rev)
}

stdout, w := io.Pipe()
Expand Down Expand Up @@ -114,29 +114,29 @@ func (r *Repository) RawDiff(rev string, diffType RawDiffFormat, w io.Writer, op
if commit.ParentsCount() == 0 {
cmd = cmd.AddArgs("show").
AddOptions(opt.CommandOptions).
AddArgs("--full-index", rev)
AddArgs("--full-index", "--end-of-options", rev)
} else {
c, err := commit.Parent(0)
if err != nil {
return err
}
cmd = cmd.AddArgs("diff").
AddOptions(opt.CommandOptions).
AddArgs("--full-index", "-M", c.ID.String(), rev)
AddArgs("--full-index", "-M", c.ID.String(), "--end-of-options", rev)
}
case RawDiffPatch:
if commit.ParentsCount() == 0 {
cmd = cmd.AddArgs("format-patch").
AddOptions(opt.CommandOptions).
AddArgs("--full-index", "--no-signoff", "--no-signature", "--stdout", "--root", rev)
AddArgs("--full-index", "--no-signoff", "--no-signature", "--stdout", "--root", "--end-of-options", rev)
} else {
c, err := commit.Parent(0)
if err != nil {
return err
}
cmd = cmd.AddArgs("format-patch").
AddOptions(opt.CommandOptions).
AddArgs("--full-index", "--no-signoff", "--no-signature", "--stdout", rev+"..."+c.ID.String())
AddArgs("--full-index", "--no-signoff", "--no-signature", "--stdout", "--end-of-options", rev+"..."+c.ID.String())
}
default:
return fmt.Errorf("invalid diffType: %s", diffType)
Expand Down
1 change: 1 addition & 0 deletions repo_grep.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ func (r *Repository) Grep(pattern string, opts ...GrepOptions) []*GrepResult {
if opt.ExtendedRegexp {
cmd.AddArgs("--extended-regexp")
}
cmd.AddArgs("--end-of-options")
cmd.AddArgs(pattern, opt.Tree)
if opt.Pathspec != "" {
cmd.AddArgs("--", opt.Pathspec)
Expand Down
1 change: 1 addition & 0 deletions repo_pull.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ func MergeBase(repoPath, base, head string, opts ...MergeBaseOptions) (string, e

stdout, err := NewCommand("merge-base").
AddOptions(opt.CommandOptions).
AddArgs("--end-of-options").
AddArgs(base, head).
RunInDirWithTimeout(opt.Timeout, repoPath)
if err != nil {
Expand Down
4 changes: 3 additions & 1 deletion repo_reference.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ func ShowRefVerify(repoPath, ref string, opts ...ShowRefVerifyOptions) (string,
opt = opts[0]
}

cmd := NewCommand("show-ref", "--verify", ref).AddOptions(opt.CommandOptions)
cmd := NewCommand("show-ref", "--verify", "--end-of-options", ref).AddOptions(opt.CommandOptions)
stdout, err := cmd.RunInDirWithTimeout(opt.Timeout, repoPath)
if err != nil {
if strings.Contains(err.Error(), "not a valid ref") {
Expand Down Expand Up @@ -162,6 +162,7 @@ func SymbolicRef(repoPath string, opts ...SymbolicRefOptions) (string, error) {
if opt.Name == "" {
opt.Name = "HEAD"
}
cmd.AddArgs("--end-of-options")
cmd.AddArgs(opt.Name)
if opt.Ref != "" {
cmd.AddArgs(opt.Ref)
Expand Down Expand Up @@ -281,6 +282,7 @@ func DeleteBranch(repoPath, name string, opts ...DeleteBranchOptions) error {
} else {
cmd.AddArgs("-d")
}
cmd.AddArgs("--end-of-options")
_, err := cmd.AddArgs(name).RunInDirWithTimeout(opt.Timeout, repoPath)
return err
}
Expand Down
8 changes: 7 additions & 1 deletion repo_remote.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ func LsRemote(url string, opts ...LsRemoteOptions) ([]*Reference, error) {
if opt.Refs {
cmd.AddArgs("--refs")
}
cmd.AddArgs("--end-of-options")
cmd.AddArgs(url)
if len(opt.Patterns) > 0 {
cmd.AddArgs(opt.Patterns...)
Expand Down Expand Up @@ -120,6 +121,7 @@ func RemoteAdd(repoPath, name, url string, opts ...RemoteAddOptions) error {
if opt.MirrorFetch {
cmd.AddArgs("--mirror=fetch")
}
cmd.AddArgs("--end-of-options")

_, err := cmd.AddArgs(name, url).RunInDirWithTimeout(opt.Timeout, repoPath)
return err
Expand Down Expand Up @@ -166,7 +168,7 @@ func RemoteRemove(repoPath, name string, opts ...RemoteRemoveOptions) error {

_, err := NewCommand("remote", "remove").
AddOptions(opt.CommandOptions).
AddArgs(name).
AddArgs("--end-of-options", name).
RunInDirWithTimeout(opt.Timeout, repoPath)
if err != nil {
// the error status may differ from git clients
Expand Down Expand Up @@ -262,6 +264,7 @@ func RemoteGetURL(repoPath, name string, opts ...RemoteGetURLOptions) ([]string,
if opt.All {
cmd.AddArgs("--all")
}
cmd.AddArgs("--end-of-options")

stdout, err := cmd.AddArgs(name).RunInDirWithTimeout(opt.Timeout, repoPath)
if err != nil {
Expand Down Expand Up @@ -306,6 +309,7 @@ func RemoteSetURL(repoPath, name, newurl string, opts ...RemoteSetURLOptions) er
cmd.AddArgs("--push")
}

cmd.AddArgs("--end-of-options")
cmd.AddArgs(name, newurl)

if opt.Regex != "" {
Expand Down Expand Up @@ -361,6 +365,7 @@ func RemoteSetURLAdd(repoPath, name, newurl string, opts ...RemoteSetURLAddOptio
cmd.AddArgs("--push")
}

cmd.AddArgs("--end-of-options")
cmd.AddArgs(name, newurl)

_, err := cmd.RunInDirWithTimeout(opt.Timeout, repoPath)
Expand Down Expand Up @@ -407,6 +412,7 @@ func RemoteSetURLDelete(repoPath, name, regex string, opts ...RemoteSetURLDelete
cmd.AddArgs("--push")
}

cmd.AddArgs("--end-of-options")
cmd.AddArgs(name, regex)

_, err := cmd.RunInDirWithTimeout(opt.Timeout, repoPath)
Expand Down
3 changes: 2 additions & 1 deletion repo_tag.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,7 @@ func (r *Repository) CreateTag(name, rev string, opts ...CreateTagOptions) error
if opt.Author != nil {
cmd.AddCommitter(opt.Author)
}
cmd.AddArgs("--end-of-options")
} else {
// 🚨 SECURITY: Prevent including unintended options in the path to the Git command.
cmd.AddArgs("--end-of-options")
Expand Down Expand Up @@ -279,7 +280,7 @@ func (r *Repository) DeleteTag(name string, opts ...DeleteTagOptions) error {
opt = opts[0]
}

_, err := NewCommand("tag", "--delete", name).
_, err := NewCommand("tag", "--delete", "--end-of-options", name).
AddOptions(opt.CommandOptions).
RunInDirWithTimeout(opt.Timeout, r.path)
return err
Expand Down