forgejo-federation/modules/git
wxiaoguang 6bc3079c00
Refactor git command package to improve security and maintainability (#22678)
This PR follows #21535 (and replace #22592)

## Review without space diff

https://github.com/go-gitea/gitea/pull/22678/files?diff=split&w=1

## Purpose of this PR

1. Make git module command completely safe (risky user inputs won't be
passed as argument option anymore)
2. Avoid low-level mistakes like
https://github.com/go-gitea/gitea/pull/22098#discussion_r1045234918
3. Remove deprecated and dirty `CmdArgCheck` function, hide the `CmdArg`
type
4. Simplify code when using git command

## The main idea of this PR

* Move the `git.CmdArg` to the `internal` package, then no other package
except `git` could use it. Then developers could never do
`AddArguments(git.CmdArg(userInput))` any more.
* Introduce `git.ToTrustedCmdArgs`, it's for user-provided and already
trusted arguments. It's only used in a few cases, for example: use git
arguments from config file, help unit test with some arguments.
* Introduce `AddOptionValues` and `AddOptionFormat`, they make code more
clear and simple:
    * Before: `AddArguments("-m").AddDynamicArguments(message)`
    * After: `AddOptionValues("-m", message)`
    * -
* Before: `AddArguments(git.CmdArg(fmt.Sprintf("--author='%s <%s>'",
sig.Name, sig.Email)))`
* After: `AddOptionFormat("--author='%s <%s>'", sig.Name, sig.Email)`

## FAQ

### Why these changes were not done in #21535 ?

#21535 is mainly a search&replace, it did its best to not change too
much logic.

Making the framework better needs a lot of changes, so this separate PR
is needed as the second step.


### The naming of `AddOptionXxx`

According to git's manual, the `--xxx` part is called `option`.

### How can it guarantee that `internal.CmdArg` won't be not misused?

Go's specification guarantees that. Trying to access other package's
internal package causes compilation error.

And, `golangci-lint` also denies the git/internal package. Only the
`git/command.go` can use it carefully.

### There is still a `ToTrustedCmdArgs`, will it still allow developers
to make mistakes and pass untrusted arguments?

Generally speaking, no. Because when using `ToTrustedCmdArgs`, the code
will be very complex (see the changes for examples). Then developers and
reviewers can know that something might be unreasonable.

### Why there was a `CmdArgCheck` and why it's removed?

At the moment of #21535, to reduce unnecessary changes, `CmdArgCheck`
was introduced as a hacky patch. Now, almost all code could be written
as `cmd := NewCommand(); cmd.AddXxx(...)`, then there is no need for
`CmdArgCheck` anymore.


### Why many codes for `signArg == ""` is deleted?

Because in the old code, `signArg` could never be empty string, it's
either `-S[key-id]` or `--no-gpg-sign`. So the `signArg == ""` is just
dead code.

---------

Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2023-02-04 10:30:43 +08:00
..
foreachref Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
internal Refactor git command package to improve security and maintainability (#22678) 2023-02-04 10:30:43 +08:00
pipeline Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
tests/repos Auto merge pull requests when all checks succeeded via API (#9307) 2022-05-08 01:05:52 +08:00
url Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
batch_reader.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
blame.go Use git command instead of exec.Cmd in blame (#22098) 2023-01-03 16:17:13 +08:00
blame_test.go Use git command instead of exec.Cmd in blame (#22098) 2023-01-03 16:17:13 +08:00
blob.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
blob_gogit.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
blob_nogogit.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
blob_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
command.go Refactor git command package to improve security and maintainability (#22678) 2023-02-04 10:30:43 +08:00
command_race_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
command_test.go Refactor git command package to improve security and maintainability (#22678) 2023-02-04 10:30:43 +08:00
commit.go Refactor git command package to improve security and maintainability (#22678) 2023-02-04 10:30:43 +08:00
commit_convert_gogit.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
commit_info.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
commit_info_gogit.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
commit_info_nogogit.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
commit_info_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
commit_reader.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
commit_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
diff.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
diff_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
error.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
git.go Refactor git command package to improve security and maintainability (#22678) 2023-02-04 10:30:43 +08:00
git_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
hook.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
last_commit_cache.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
last_commit_cache_gogit.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
last_commit_cache_nogogit.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
log_name_status.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
notes.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
notes_gogit.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
notes_nogogit.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
notes_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
parse_gogit.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
parse_gogit_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
parse_nogogit.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
parse_nogogit_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
README.md move code.gitea.io/git to code.gitea.io/gitea/modules/git (#6364) 2019-03-27 17:33:00 +08:00
ref.go Util type to parse ref name (#21969) 2022-12-01 19:56:04 +08:00
remote.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo.go Refactor git command package to improve security and maintainability (#22678) 2023-02-04 10:30:43 +08:00
repo_archive.go Refactor git command package to improve security and maintainability (#22678) 2023-02-04 10:30:43 +08:00
repo_attribute.go Refactor git command package to improve security and maintainability (#22678) 2023-02-04 10:30:43 +08:00
repo_attribute_test.go Remove deadcode (#22245) 2022-12-27 09:15:35 +08:00
repo_base.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo_base_gogit.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo_base_nogogit.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo_blame.go Refactor git command package to improve security and maintainability (#22678) 2023-02-04 10:30:43 +08:00
repo_blob.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo_blob_gogit.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo_blob_nogogit.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo_blob_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo_branch.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo_branch_gogit.go Refactor git command package to improve security and maintainability (#22678) 2023-02-04 10:30:43 +08:00
repo_branch_nogogit.go Refactor git command package to improve security and maintainability (#22678) 2023-02-04 10:30:43 +08:00
repo_branch_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo_commit.go Refactor git command package to improve security and maintainability (#22678) 2023-02-04 10:30:43 +08:00
repo_commit_gogit.go Use complete SHA to create and query commit status (#22244) 2022-12-27 21:12:49 +08:00
repo_commit_nogogit.go Use complete SHA to create and query commit status (#22244) 2022-12-27 21:12:49 +08:00
repo_commit_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo_commitgraph.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo_commitgraph_gogit.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo_compare.go Refactor git command package to improve security and maintainability (#22678) 2023-02-04 10:30:43 +08:00
repo_compare_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo_gpg.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo_hook.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo_index.go Use complete SHA to create and query commit status (#22244) 2022-12-27 21:12:49 +08:00
repo_language_stats.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo_language_stats_gogit.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo_language_stats_nogogit.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo_language_stats_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo_object.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo_ref.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo_ref_gogit.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo_ref_nogogit.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo_ref_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo_stats.go Refactor git command package to improve security and maintainability (#22678) 2023-02-04 10:30:43 +08:00
repo_stats_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo_tag.go Refactor git command package to improve security and maintainability (#22678) 2023-02-04 10:30:43 +08:00
repo_tag_gogit.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo_tag_nogogit.go Refactor git command package to improve security and maintainability (#22678) 2023-02-04 10:30:43 +08:00
repo_tag_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo_tree.go Refactor git command package to improve security and maintainability (#22678) 2023-02-04 10:30:43 +08:00
repo_tree_gogit.go Use complete SHA to create and query commit status (#22244) 2022-12-27 21:12:49 +08:00
repo_tree_nogogit.go Use complete SHA to create and query commit status (#22244) 2022-12-27 21:12:49 +08:00
sha1.go Use complete SHA to create and query commit status (#22244) 2022-12-27 21:12:49 +08:00
sha1_gogit.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
sha1_nogogit.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
sha1_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
signature.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
signature_gogit.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
signature_nogogit.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
submodule.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
submodule_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
tag.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
tag_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
tree.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
tree_blob.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
tree_blob_gogit.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
tree_blob_nogogit.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
tree_entry.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
tree_entry_gogit.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
tree_entry_mode.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
tree_entry_nogogit.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
tree_entry_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
tree_gogit.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
tree_nogogit.go Refactor git command package to improve security and maintainability (#22678) 2023-02-04 10:30:43 +08:00
utils.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
utils_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00

Git Module

This module is merged from https://github.com/go-gitea/git which is a Go module to access Git through shell commands. Now it's a part of gitea's main repository for easier pull request.