mirror of
https://github.com/go-gitea/gitea
synced 2024-08-22 02:05:10 +02:00
## ⚠️ Breaking The `log.<mode>.<logger>` style config has been dropped. If you used it, please check the new config manual & app.example.ini to make your instance output logs as expected. Although many legacy options still work, it's encouraged to upgrade to the new options. The SMTP logger is deleted because SMTP is not suitable to collect logs. If you have manually configured Gitea log options, please confirm the logger system works as expected after upgrading. ## Description Close #12082 and maybe more log-related issues, resolve some related FIXMEs in old code (which seems unfixable before) Just like rewriting queue #24505 : make code maintainable, clear legacy bugs, and add the ability to support more writers (eg: JSON, structured log) There is a new document (with examples): `logging-config.en-us.md` This PR is safer than the queue rewriting, because it's just for logging, it won't break other logic. ## The old problems The logging system is quite old and difficult to maintain: * Unclear concepts: Logger, NamedLogger, MultiChannelledLogger, SubLogger, EventLogger, WriterLogger etc * Some code is diffuclt to konw whether it is right: `log.DelNamedLogger("console")` vs `log.DelNamedLogger(log.DEFAULT)` vs `log.DelLogger("console")` * The old system heavily depends on ini config system, it's difficult to create new logger for different purpose, and it's very fragile. * The "color" trick is difficult to use and read, many colors are unnecessary, and in the future structured log could help * It's difficult to add other log formats, eg: JSON format * The log outputer doesn't have full control of its goroutine, it's difficult to make outputer have advanced behaviors * The logs could be lost in some cases: eg: no Fatal error when using CLI. * Config options are passed by JSON, which is quite fragile. * INI package makes the KEY in `[log]` section visible in `[log.sub1]` and `[log.sub1.subA]`, this behavior is quite fragile and would cause more unclear problems, and there is no strong requirement to support `log.<mode>.<logger>` syntax. ## The new design See `logger.go` for documents. ## Screenshot <details> ![image](https://github.com/go-gitea/gitea/assets/2114189/4462d713-ba39-41f5-bb08-de912e67e1ff) ![image](https://github.com/go-gitea/gitea/assets/2114189/b188035e-f691-428b-8b2d-ff7b2199b2f9) ![image](https://github.com/go-gitea/gitea/assets/2114189/132e9745-1c3b-4e00-9e0d-15eaea495dee) </details> ## TODO * [x] add some new tests * [x] fix some tests * [x] test some sub-commands (manually ....) --------- Co-authored-by: Jason Song <i@wolfogre.com> Co-authored-by: delvh <dev.lh@web.de> Co-authored-by: Giteabot <teabot@gitea.io>
360 lines
12 KiB
Go
360 lines
12 KiB
Go
// Copyright 2014 The Gogs Authors. All rights reserved.
|
|
// Copyright 2016 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package cmd
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"net/url"
|
|
"os"
|
|
"os/exec"
|
|
"path/filepath"
|
|
"regexp"
|
|
"strconv"
|
|
"strings"
|
|
"time"
|
|
"unicode"
|
|
|
|
asymkey_model "code.gitea.io/gitea/models/asymkey"
|
|
git_model "code.gitea.io/gitea/models/git"
|
|
"code.gitea.io/gitea/models/perm"
|
|
"code.gitea.io/gitea/modules/git"
|
|
"code.gitea.io/gitea/modules/json"
|
|
"code.gitea.io/gitea/modules/log"
|
|
"code.gitea.io/gitea/modules/pprof"
|
|
"code.gitea.io/gitea/modules/private"
|
|
"code.gitea.io/gitea/modules/process"
|
|
repo_module "code.gitea.io/gitea/modules/repository"
|
|
"code.gitea.io/gitea/modules/setting"
|
|
"code.gitea.io/gitea/services/lfs"
|
|
|
|
"github.com/golang-jwt/jwt/v4"
|
|
"github.com/kballard/go-shellquote"
|
|
"github.com/urfave/cli"
|
|
)
|
|
|
|
const (
|
|
lfsAuthenticateVerb = "git-lfs-authenticate"
|
|
)
|
|
|
|
// CmdServ represents the available serv sub-command.
|
|
var CmdServ = cli.Command{
|
|
Name: "serv",
|
|
Usage: "This command should only be called by SSH shell",
|
|
Description: "Serv provides access auth for repositories",
|
|
Action: runServ,
|
|
Flags: []cli.Flag{
|
|
cli.BoolFlag{
|
|
Name: "enable-pprof",
|
|
},
|
|
cli.BoolFlag{
|
|
Name: "debug",
|
|
},
|
|
},
|
|
}
|
|
|
|
func setup(ctx context.Context, debug bool) {
|
|
if debug {
|
|
setupConsoleLogger(log.TRACE, false, os.Stderr)
|
|
} else {
|
|
setupConsoleLogger(log.FATAL, false, os.Stderr)
|
|
}
|
|
setting.Init(&setting.Options{})
|
|
if debug {
|
|
setting.RunMode = "dev"
|
|
}
|
|
|
|
// Check if setting.RepoRootPath exists. It could be the case that it doesn't exist, this can happen when
|
|
// `[repository]` `ROOT` is a relative path and $GITEA_WORK_DIR isn't passed to the SSH connection.
|
|
if _, err := os.Stat(setting.RepoRootPath); err != nil {
|
|
if os.IsNotExist(err) {
|
|
_ = fail(ctx, "Incorrect configuration, no repository directory.", "Directory `[repository].ROOT` %q was not found, please check if $GITEA_WORK_DIR is passed to the SSH connection or make `[repository].ROOT` an absolute value.", setting.RepoRootPath)
|
|
} else {
|
|
_ = fail(ctx, "Incorrect configuration, repository directory is inaccessible", "Directory `[repository].ROOT` %q is inaccessible. err: %v", setting.RepoRootPath, err)
|
|
}
|
|
return
|
|
}
|
|
|
|
if err := git.InitSimple(context.Background()); err != nil {
|
|
_ = fail(ctx, "Failed to init git", "Failed to init git, err: %v", err)
|
|
}
|
|
}
|
|
|
|
var (
|
|
allowedCommands = map[string]perm.AccessMode{
|
|
"git-upload-pack": perm.AccessModeRead,
|
|
"git-upload-archive": perm.AccessModeRead,
|
|
"git-receive-pack": perm.AccessModeWrite,
|
|
lfsAuthenticateVerb: perm.AccessModeNone,
|
|
}
|
|
alphaDashDotPattern = regexp.MustCompile(`[^\w-\.]`)
|
|
)
|
|
|
|
// fail prints message to stdout, it's mainly used for git serv and git hook commands.
|
|
// The output will be passed to git client and shown to user.
|
|
func fail(ctx context.Context, userMessage, logMsgFmt string, args ...interface{}) error {
|
|
if userMessage == "" {
|
|
userMessage = "Internal Server Error (no specific error)"
|
|
}
|
|
|
|
// There appears to be a chance to cause a zombie process and failure to read the Exit status
|
|
// if nothing is outputted on stdout.
|
|
_, _ = fmt.Fprintln(os.Stdout, "")
|
|
_, _ = fmt.Fprintln(os.Stderr, "Gitea:", userMessage)
|
|
|
|
if logMsgFmt != "" {
|
|
logMsg := fmt.Sprintf(logMsgFmt, args...)
|
|
if !setting.IsProd {
|
|
_, _ = fmt.Fprintln(os.Stderr, "Gitea:", logMsg)
|
|
}
|
|
if userMessage != "" {
|
|
if unicode.IsPunct(rune(userMessage[len(userMessage)-1])) {
|
|
logMsg = userMessage + " " + logMsg
|
|
} else {
|
|
logMsg = userMessage + ". " + logMsg
|
|
}
|
|
}
|
|
_ = private.SSHLog(ctx, true, logMsg)
|
|
}
|
|
return cli.NewExitError("", 1)
|
|
}
|
|
|
|
// handleCliResponseExtra handles the extra response from the cli sub-commands
|
|
// If there is a user message it will be printed to stdout
|
|
// If the command failed it will return an error (the error will be printed by cli framework)
|
|
func handleCliResponseExtra(extra private.ResponseExtra) error {
|
|
if extra.UserMsg != "" {
|
|
_, _ = fmt.Fprintln(os.Stdout, extra.UserMsg)
|
|
}
|
|
if extra.HasError() {
|
|
return cli.NewExitError(extra.Error, 1)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func runServ(c *cli.Context) error {
|
|
ctx, cancel := installSignals()
|
|
defer cancel()
|
|
|
|
// FIXME: This needs to internationalised
|
|
setup(ctx, c.Bool("debug"))
|
|
|
|
if setting.SSH.Disabled {
|
|
println("Gitea: SSH has been disabled")
|
|
return nil
|
|
}
|
|
|
|
if len(c.Args()) < 1 {
|
|
if err := cli.ShowSubcommandHelp(c); err != nil {
|
|
fmt.Printf("error showing subcommand help: %v\n", err)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
keys := strings.Split(c.Args()[0], "-")
|
|
if len(keys) != 2 || keys[0] != "key" {
|
|
return fail(ctx, "Key ID format error", "Invalid key argument: %s", c.Args()[0])
|
|
}
|
|
keyID, err := strconv.ParseInt(keys[1], 10, 64)
|
|
if err != nil {
|
|
return fail(ctx, "Key ID parsing error", "Invalid key argument: %s", c.Args()[1])
|
|
}
|
|
|
|
cmd := os.Getenv("SSH_ORIGINAL_COMMAND")
|
|
if len(cmd) == 0 {
|
|
key, user, err := private.ServNoCommand(ctx, keyID)
|
|
if err != nil {
|
|
return fail(ctx, "Key check failed", "Failed to check provided key: %v", err)
|
|
}
|
|
switch key.Type {
|
|
case asymkey_model.KeyTypeDeploy:
|
|
println("Hi there! You've successfully authenticated with the deploy key named " + key.Name + ", but Gitea does not provide shell access.")
|
|
case asymkey_model.KeyTypePrincipal:
|
|
println("Hi there! You've successfully authenticated with the principal " + key.Content + ", but Gitea does not provide shell access.")
|
|
default:
|
|
println("Hi there, " + user.Name + "! You've successfully authenticated with the key named " + key.Name + ", but Gitea does not provide shell access.")
|
|
}
|
|
println("If this is unexpected, please log in with password and setup Gitea under another user.")
|
|
return nil
|
|
} else if c.Bool("debug") {
|
|
log.Debug("SSH_ORIGINAL_COMMAND: %s", os.Getenv("SSH_ORIGINAL_COMMAND"))
|
|
}
|
|
|
|
words, err := shellquote.Split(cmd)
|
|
if err != nil {
|
|
return fail(ctx, "Error parsing arguments", "Failed to parse arguments: %v", err)
|
|
}
|
|
|
|
if len(words) < 2 {
|
|
if git.CheckGitVersionAtLeast("2.29") == nil {
|
|
// for AGit Flow
|
|
if cmd == "ssh_info" {
|
|
fmt.Print(`{"type":"gitea","version":1}`)
|
|
return nil
|
|
}
|
|
}
|
|
return fail(ctx, "Too few arguments", "Too few arguments in cmd: %s", cmd)
|
|
}
|
|
|
|
verb := words[0]
|
|
repoPath := words[1]
|
|
if repoPath[0] == '/' {
|
|
repoPath = repoPath[1:]
|
|
}
|
|
|
|
var lfsVerb string
|
|
if verb == lfsAuthenticateVerb {
|
|
if !setting.LFS.StartServer {
|
|
return fail(ctx, "Unknown git command", "LFS authentication request over SSH denied, LFS support is disabled")
|
|
}
|
|
|
|
if len(words) > 2 {
|
|
lfsVerb = words[2]
|
|
}
|
|
}
|
|
|
|
// LowerCase and trim the repoPath as that's how they are stored.
|
|
repoPath = strings.ToLower(strings.TrimSpace(repoPath))
|
|
|
|
rr := strings.SplitN(repoPath, "/", 2)
|
|
if len(rr) != 2 {
|
|
return fail(ctx, "Invalid repository path", "Invalid repository path: %v", repoPath)
|
|
}
|
|
|
|
username := strings.ToLower(rr[0])
|
|
reponame := strings.ToLower(strings.TrimSuffix(rr[1], ".git"))
|
|
|
|
if alphaDashDotPattern.MatchString(reponame) {
|
|
return fail(ctx, "Invalid repo name", "Invalid repo name: %s", reponame)
|
|
}
|
|
|
|
if c.Bool("enable-pprof") {
|
|
if err := os.MkdirAll(setting.PprofDataPath, os.ModePerm); err != nil {
|
|
return fail(ctx, "Error while trying to create PPROF_DATA_PATH", "Error while trying to create PPROF_DATA_PATH: %v", err)
|
|
}
|
|
|
|
stopCPUProfiler, err := pprof.DumpCPUProfileForUsername(setting.PprofDataPath, username)
|
|
if err != nil {
|
|
return fail(ctx, "Unable to start CPU profiler", "Unable to start CPU profile: %v", err)
|
|
}
|
|
defer func() {
|
|
stopCPUProfiler()
|
|
err := pprof.DumpMemProfileForUsername(setting.PprofDataPath, username)
|
|
if err != nil {
|
|
_ = fail(ctx, "Unable to dump Mem profile", "Unable to dump Mem Profile: %v", err)
|
|
}
|
|
}()
|
|
}
|
|
|
|
requestedMode, has := allowedCommands[verb]
|
|
if !has {
|
|
return fail(ctx, "Unknown git command", "Unknown git command %s", verb)
|
|
}
|
|
|
|
if verb == lfsAuthenticateVerb {
|
|
if lfsVerb == "upload" {
|
|
requestedMode = perm.AccessModeWrite
|
|
} else if lfsVerb == "download" {
|
|
requestedMode = perm.AccessModeRead
|
|
} else {
|
|
return fail(ctx, "Unknown LFS verb", "Unknown lfs verb %s", lfsVerb)
|
|
}
|
|
}
|
|
|
|
results, extra := private.ServCommand(ctx, keyID, username, reponame, requestedMode, verb, lfsVerb)
|
|
if extra.HasError() {
|
|
return fail(ctx, extra.UserMsg, "ServCommand failed: %s", extra.Error)
|
|
}
|
|
|
|
// LFS token authentication
|
|
if verb == lfsAuthenticateVerb {
|
|
url := fmt.Sprintf("%s%s/%s.git/info/lfs", setting.AppURL, url.PathEscape(results.OwnerName), url.PathEscape(results.RepoName))
|
|
|
|
now := time.Now()
|
|
claims := lfs.Claims{
|
|
RegisteredClaims: jwt.RegisteredClaims{
|
|
ExpiresAt: jwt.NewNumericDate(now.Add(setting.LFS.HTTPAuthExpiry)),
|
|
NotBefore: jwt.NewNumericDate(now),
|
|
},
|
|
RepoID: results.RepoID,
|
|
Op: lfsVerb,
|
|
UserID: results.UserID,
|
|
}
|
|
token := jwt.NewWithClaims(jwt.SigningMethodHS256, claims)
|
|
|
|
// Sign and get the complete encoded token as a string using the secret
|
|
tokenString, err := token.SignedString(setting.LFS.JWTSecretBytes)
|
|
if err != nil {
|
|
return fail(ctx, "Failed to sign JWT Token", "Failed to sign JWT token: %v", err)
|
|
}
|
|
|
|
tokenAuthentication := &git_model.LFSTokenResponse{
|
|
Header: make(map[string]string),
|
|
Href: url,
|
|
}
|
|
tokenAuthentication.Header["Authorization"] = fmt.Sprintf("Bearer %s", tokenString)
|
|
|
|
enc := json.NewEncoder(os.Stdout)
|
|
err = enc.Encode(tokenAuthentication)
|
|
if err != nil {
|
|
return fail(ctx, "Failed to encode LFS json response", "Failed to encode LFS json response: %v", err)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
var gitcmd *exec.Cmd
|
|
gitBinPath := filepath.Dir(git.GitExecutable) // e.g. /usr/bin
|
|
gitBinVerb := filepath.Join(gitBinPath, verb) // e.g. /usr/bin/git-upload-pack
|
|
if _, err := os.Stat(gitBinVerb); err != nil {
|
|
// if the command "git-upload-pack" doesn't exist, try to split "git-upload-pack" to use the sub-command with git
|
|
// ps: Windows only has "git.exe" in the bin path, so Windows always uses this way
|
|
verbFields := strings.SplitN(verb, "-", 2)
|
|
if len(verbFields) == 2 {
|
|
// use git binary with the sub-command part: "C:\...\bin\git.exe", "upload-pack", ...
|
|
gitcmd = exec.CommandContext(ctx, git.GitExecutable, verbFields[1], repoPath)
|
|
}
|
|
}
|
|
if gitcmd == nil {
|
|
// by default, use the verb (it has been checked above by allowedCommands)
|
|
gitcmd = exec.CommandContext(ctx, gitBinVerb, repoPath)
|
|
}
|
|
|
|
process.SetSysProcAttribute(gitcmd)
|
|
gitcmd.Dir = setting.RepoRootPath
|
|
gitcmd.Stdout = os.Stdout
|
|
gitcmd.Stdin = os.Stdin
|
|
gitcmd.Stderr = os.Stderr
|
|
gitcmd.Env = append(gitcmd.Env, os.Environ()...)
|
|
gitcmd.Env = append(gitcmd.Env,
|
|
repo_module.EnvRepoIsWiki+"="+strconv.FormatBool(results.IsWiki),
|
|
repo_module.EnvRepoName+"="+results.RepoName,
|
|
repo_module.EnvRepoUsername+"="+results.OwnerName,
|
|
repo_module.EnvPusherName+"="+results.UserName,
|
|
repo_module.EnvPusherEmail+"="+results.UserEmail,
|
|
repo_module.EnvPusherID+"="+strconv.FormatInt(results.UserID, 10),
|
|
repo_module.EnvRepoID+"="+strconv.FormatInt(results.RepoID, 10),
|
|
repo_module.EnvPRID+"="+fmt.Sprintf("%d", 0),
|
|
repo_module.EnvDeployKeyID+"="+fmt.Sprintf("%d", results.DeployKeyID),
|
|
repo_module.EnvKeyID+"="+fmt.Sprintf("%d", results.KeyID),
|
|
repo_module.EnvAppURL+"="+setting.AppURL,
|
|
)
|
|
// to avoid breaking, here only use the minimal environment variables for the "gitea serv" command.
|
|
// it could be re-considered whether to use the same git.CommonGitCmdEnvs() as "git" command later.
|
|
gitcmd.Env = append(gitcmd.Env, git.CommonCmdServEnvs()...)
|
|
|
|
if err = gitcmd.Run(); err != nil {
|
|
return fail(ctx, "Failed to execute git command", "Failed to execute git command: %v", err)
|
|
}
|
|
|
|
// Update user key activity.
|
|
if results.KeyID > 0 {
|
|
if err = private.UpdatePublicKeyInRepo(ctx, results.KeyID, results.RepoID); err != nil {
|
|
return fail(ctx, "Failed to update public key", "UpdatePublicKeyInRepo: %v", err)
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|