Files
Atay-Makhzan/cmd/serv.go
T

317 lines
9.3 KiB
Go
Raw Normal View History

2014-04-10 14:20:58 -04:00
// Copyright 2014 The Gogs Authors. All rights reserved.
// Copyright 2016 The Gitea Authors. All rights reserved.
2014-04-10 14:20:58 -04:00
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.
2014-05-01 21:21:46 -04:00
package cmd
2014-04-10 14:20:58 -04:00
import (
"fmt"
"net/http"
"net/url"
2014-04-10 14:20:58 -04:00
"os"
"os/exec"
2020-02-05 03:40:35 -06:00
"regexp"
"strconv"
2014-04-10 14:20:58 -04:00
"strings"
2014-08-09 15:40:10 -07:00
"time"
2014-04-10 14:20:58 -04:00
"code.gitea.io/gitea/models"
2021-12-10 16:14:24 +08:00
asymkey_model "code.gitea.io/gitea/models/asymkey"
2021-11-28 19:58:28 +08:00
"code.gitea.io/gitea/models/perm"
2021-07-28 17:42:56 +08:00
"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/setting"
2021-04-09 00:25:57 +02:00
"code.gitea.io/gitea/services/lfs"
2022-01-14 23:03:31 +08:00
"github.com/golang-jwt/jwt/v4"
"github.com/kballard/go-shellquote"
"github.com/urfave/cli"
2014-04-10 14:20:58 -04:00
)
2015-02-16 16:38:01 +02:00
const (
2016-12-26 02:16:37 +01:00
lfsAuthenticateVerb = "git-lfs-authenticate"
2015-02-16 16:38:01 +02:00
)
2016-11-04 12:42:18 +01:00
// CmdServ represents the available serv sub-command.
2014-04-10 14:20:58 -04:00
var CmdServ = cli.Command{
2014-05-05 00:55:17 -04:00
Name: "serv",
Usage: "This command should only be called by SSH shell",
Description: `Serv provide access auth for repositories`,
Action: runServ,
Flags: []cli.Flag{
cli.BoolFlag{
Name: "enable-pprof",
},
cli.BoolFlag{
Name: "debug",
},
},
2014-04-10 14:20:58 -04:00
}
func setup(logPath string, debug bool) {
_ = log.DelLogger("console")
if debug {
_ = log.NewLogger(1000, "console", "console", `{"level":"trace","stacktracelevel":"NONE","stderr":true}`)
} else {
_ = log.NewLogger(1000, "console", "console", `{"level":"fatal","stacktracelevel":"NONE","stderr":true}`)
}
setting.LoadFromExisting()
if debug {
setting.RunMode = "dev"
}
2014-05-21 21:37:13 -04:00
}
var (
2021-11-28 19:58:28 +08:00
allowedCommands = map[string]perm.AccessMode{
"git-upload-pack": perm.AccessModeRead,
"git-upload-archive": perm.AccessModeRead,
"git-receive-pack": perm.AccessModeWrite,
lfsAuthenticateVerb: perm.AccessModeNone,
2014-05-21 21:37:13 -04:00
}
2020-02-05 03:40:35 -06:00
alphaDashDotPattern = regexp.MustCompile(`[^\w-\.]`)
2014-05-21 21:37:13 -04:00
)
func fail(userMessage, logMessage string, args ...interface{}) 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)
2015-11-08 14:31:49 -05:00
if len(logMessage) > 0 {
if !setting.IsProd {
2015-11-30 10:00:52 -05:00
fmt.Fprintf(os.Stderr, logMessage+"\n", args...)
}
2015-11-08 14:31:49 -05:00
}
ctx, cancel := installSignals()
defer cancel()
2015-11-08 14:31:49 -05:00
if len(logMessage) > 0 {
_ = private.SSHLog(ctx, true, fmt.Sprintf(logMessage+": ", args...))
}
return cli.NewExitError("", 1)
2015-08-06 22:48:11 +08:00
}
2016-05-12 14:32:28 -04:00
func runServ(c *cli.Context) error {
ctx, cancel := installSignals()
defer cancel()
// FIXME: This needs to internationalised
setup("serv.log", c.Bool("debug"))
2014-04-10 14:20:58 -04:00
2016-02-27 20:48:39 -05:00
if setting.SSH.Disabled {
println("Gitea: SSH has been disabled")
2016-05-12 14:32:28 -04:00
return nil
2016-02-21 21:55:59 -05:00
}
2015-02-13 00:58:46 -05:00
if len(c.Args()) < 1 {
2019-06-12 21:41:28 +02:00
if err := cli.ShowSubcommandHelp(c); err != nil {
fmt.Printf("error showing subcommand help: %v\n", err)
}
return nil
2015-02-09 12:32:42 +02:00
}
2015-02-16 16:38:01 +02:00
keys := strings.Split(c.Args()[0], "-")
if len(keys) != 2 || keys[0] != "key" {
return fail("Key ID format error", "Invalid key argument: %s", c.Args()[0])
}
2020-12-25 09:59:32 +00:00
keyID, err := strconv.ParseInt(keys[1], 10, 64)
if err != nil {
return fail("Key ID format error", "Invalid key argument: %s", c.Args()[1])
2020-12-25 09:59:32 +00:00
}
2014-04-10 14:20:58 -04:00
cmd := os.Getenv("SSH_ORIGINAL_COMMAND")
2015-08-05 11:14:17 +08:00
if len(cmd) == 0 {
key, user, err := private.ServNoCommand(ctx, keyID)
if err != nil {
return fail("Internal error", "Failed to check provided key: %v", err)
}
2020-10-11 02:38:09 +02:00
switch key.Type {
2021-12-10 16:14:24 +08:00
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.")
2021-12-10 16:14:24 +08:00
case asymkey_model.KeyTypePrincipal:
2020-10-11 02:38:09 +02:00
println("Hi there! You've successfully authenticated with the principal " + key.Content + ", but Gitea does not provide shell access.")
default:
2019-08-11 14:15:58 +02:00
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.")
2016-05-12 14:32:28 -04:00
return nil
} else if c.Bool("debug") {
log.Debug("SSH_ORIGINAL_COMMAND: %s", os.Getenv("SSH_ORIGINAL_COMMAND"))
2014-04-10 14:20:58 -04:00
}
words, err := shellquote.Split(cmd)
if err != nil {
return fail("Error parsing arguments", "Failed to parse arguments: %v", err)
}
if len(words) < 2 {
2021-07-28 17:42:56 +08:00
if git.CheckGitVersionAtLeast("2.29") == nil {
// for AGit Flow
if cmd == "ssh_info" {
fmt.Print(`{"type":"gitea","version":1}`)
return nil
}
}
return fail("Too few arguments", "Too few arguments in cmd: %s", cmd)
}
verb := words[0]
repoPath := words[1]
if repoPath[0] == '/' {
repoPath = repoPath[1:]
}
2016-12-26 02:16:37 +01:00
var lfsVerb string
if verb == lfsAuthenticateVerb {
if !setting.LFS.StartServer {
return fail("Unknown git command", "LFS authentication request over SSH denied, LFS support is disabled")
2016-12-26 02:16:37 +01:00
}
if len(words) > 2 {
lfsVerb = words[2]
2016-12-26 02:16:37 +01:00
}
}
// LowerCase and trim the repoPath as that's how they are stored.
repoPath = strings.ToLower(strings.TrimSpace(repoPath))
2014-04-10 14:20:58 -04:00
rr := strings.SplitN(repoPath, "/", 2)
if len(rr) != 2 {
return fail("Invalid repository path", "Invalid repository path: %v", repoPath)
2014-04-10 14:20:58 -04:00
}
2015-11-30 20:45:55 -05:00
username := strings.ToLower(rr[0])
reponame := strings.ToLower(strings.TrimSuffix(rr[1], ".git"))
2020-02-05 03:40:35 -06:00
if alphaDashDotPattern.MatchString(reponame) {
return fail("Invalid repo name", "Invalid repo name: %s", reponame)
2020-02-05 03:40:35 -06:00
}
if c.Bool("enable-pprof") {
if err := os.MkdirAll(setting.PprofDataPath, os.ModePerm); err != nil {
return fail("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("Internal Server Error", "Unable to start CPU profile: %v", err)
}
defer func() {
stopCPUProfiler()
err := pprof.DumpMemProfileForUsername(setting.PprofDataPath, username)
if err != nil {
_ = fail("Internal Server Error", "Unable to dump Mem Profile: %v", err)
}
}()
}
requestedMode, has := allowedCommands[verb]
2015-02-16 16:38:01 +02:00
if !has {
return fail("Unknown git command", "Unknown git command %s", verb)
2015-02-16 16:38:01 +02:00
}
2014-04-10 14:20:58 -04:00
2016-12-26 02:16:37 +01:00
if verb == lfsAuthenticateVerb {
if lfsVerb == "upload" {
2021-11-28 19:58:28 +08:00
requestedMode = perm.AccessModeWrite
} else if lfsVerb == "download" {
2021-11-28 19:58:28 +08:00
requestedMode = perm.AccessModeRead
} else {
return fail("Unknown LFS verb", "Unknown lfs verb %s", lfsVerb)
2016-12-26 02:16:37 +01:00
}
}
results, err := private.ServCommand(ctx, keyID, username, reponame, requestedMode, verb, lfsVerb)
if err != nil {
if private.IsErrServCommand(err) {
errServCommand := err.(private.ErrServCommand)
if errServCommand.StatusCode != http.StatusInternalServerError {
return fail("Unauthorized", "%s", errServCommand.Error())
2015-08-05 11:14:17 +08:00
}
return fail("Internal Server Error", "%s", errServCommand.Error())
2014-04-10 14:20:58 -04:00
}
return fail("Internal Server Error", "%s", err.Error())
2014-04-10 14:20:58 -04:00
}
os.Setenv(models.EnvRepoIsWiki, strconv.FormatBool(results.IsWiki))
os.Setenv(models.EnvRepoName, results.RepoName)
os.Setenv(models.EnvRepoUsername, results.OwnerName)
2019-06-11 09:13:24 +08:00
os.Setenv(models.EnvPusherName, results.UserName)
os.Setenv(models.EnvPusherEmail, results.UserEmail)
os.Setenv(models.EnvPusherID, strconv.FormatInt(results.UserID, 10))
os.Setenv(models.EnvRepoID, strconv.FormatInt(results.RepoID, 10))
os.Setenv(models.EnvPRID, fmt.Sprintf("%d", 0))
os.Setenv(models.EnvIsDeployKey, fmt.Sprintf("%t", results.IsDeployKey))
os.Setenv(models.EnvKeyID, fmt.Sprintf("%d", results.KeyID))
os.Setenv(models.EnvAppURL, setting.AppURL)
2014-04-10 14:20:58 -04:00
2016-12-26 02:16:37 +01:00
//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))
2016-12-26 02:16:37 +01:00
now := time.Now()
2020-03-09 19:56:18 +00:00
claims := lfs.Claims{
2022-01-14 23:03:31 +08:00
// FIXME: we need to migrate to RegisteredClaims
StandardClaims: jwt.StandardClaims{ // nolint
2020-03-09 19:56:18 +00:00
ExpiresAt: now.Add(setting.LFS.HTTPAuthExpiry).Unix(),
NotBefore: now.Unix(),
},
RepoID: results.RepoID,
Op: lfsVerb,
UserID: results.UserID,
2018-01-27 17:48:15 +01:00
}
token := jwt.NewWithClaims(jwt.SigningMethodHS256, claims)
2016-12-26 02:16:37 +01:00
// 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("Internal error", "Failed to sign JWT token: %v", err)
2016-12-26 02:16:37 +01:00
}
tokenAuthentication := &models.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("Internal error", "Failed to encode LFS json response: %v", err)
2016-12-26 02:16:37 +01:00
}
return nil
}
// Special handle for Windows.
if setting.IsWindows {
verb = strings.Replace(verb, "-", " ", 1)
}
2014-10-01 07:40:48 -04:00
var gitcmd *exec.Cmd
verbs := strings.Split(verb, " ")
if len(verbs) == 2 {
2021-06-30 21:07:23 +01:00
gitcmd = exec.CommandContext(ctx, verbs[0], verbs[1], repoPath)
2014-10-01 07:40:48 -04:00
} else {
2021-06-30 21:07:23 +01:00
gitcmd = exec.CommandContext(ctx, verb, repoPath)
2014-10-01 07:40:48 -04:00
}
2017-03-17 12:59:42 +08:00
2014-05-25 20:11:25 -04:00
gitcmd.Dir = setting.RepoRootPath
2014-04-10 14:20:58 -04:00
gitcmd.Stdout = os.Stdout
gitcmd.Stdin = os.Stdin
gitcmd.Stderr = os.Stderr
2014-07-26 00:24:27 -04:00
if err = gitcmd.Run(); err != nil {
return fail("Internal error", "Failed to execute git command: %v", err)
2014-04-10 14:20:58 -04:00
}
2014-06-28 23:56:41 +08:00
2015-08-06 22:48:11 +08:00
// Update user key activity.
if results.KeyID > 0 {
if err = private.UpdatePublicKeyInRepo(ctx, results.KeyID, results.RepoID); err != nil {
return fail("Internal error", "UpdatePublicKeyInRepo: %v", err)
2015-08-05 11:14:17 +08:00
}
2014-08-09 15:40:10 -07:00
}
2016-05-12 14:32:28 -04:00
return nil
2014-04-10 14:20:58 -04:00
}