githaven/routers/web
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
..
admin Add main landmark to templates and adjust titles (#22670) 2023-02-01 22:56:10 +00:00
auth Fix error on account activation with wrong passwd (#22609) 2023-01-28 15:59:46 +08:00
events Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
explore Move convert package to services (#22264) 2022-12-29 10:57:15 +08:00
feed Add Feed for Releases and Tags (#21696) 2022-12-21 15:06:26 -06:00
healthcheck Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
misc Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
org Add user secrets (#22191) 2023-02-01 20:53:04 +08:00
repo Refactor git command package to improve security and maintainability (#22678) 2023-02-04 10:30:43 +08:00
shared Add user secrets (#22191) 2023-02-01 20:53:04 +08:00
user Improve error report when user passes a private key (#22726) 2023-02-02 18:25:54 +00:00
auth_windows.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
auth.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
base.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
goget.go refactor some functions to support ctx as first parameter (#21878) 2022-12-03 10:48:26 +08:00
home.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
metrics.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
nodeinfo.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
swagger_json.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
web.go Add user secrets (#22191) 2023-02-01 20:53:04 +08:00
webfinger.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00