// Copyright 2021 The Gitea Authors. All rights reserved. // SPDX-License-Identifier: MIT package asymkey import ( "bufio" "context" "fmt" "io" "os" "path/filepath" "strings" "sync" "code.gitea.io/gitea/models/db" "code.gitea.io/gitea/modules/log" "code.gitea.io/gitea/modules/setting" "code.gitea.io/gitea/modules/util" "golang.org/x/crypto/ssh" ) // AuthorizedStringCommentPrefix is a magic tag // some functions like RegeneratePublicKeys needs this tag to skip the keys generated by Gitea, while keep other keys const AuthorizedStringCommentPrefix = `# gitea public key` var sshOpLocker sync.Mutex func WithSSHOpLocker(f func() error) error { sshOpLocker.Lock() defer sshOpLocker.Unlock() return f() } // AuthorizedStringForKey creates the authorized keys string appropriate for the provided key func AuthorizedStringForKey(key *PublicKey) (string, error) { sb := &strings.Builder{} _, err := writeAuthorizedStringForKey(key, sb) return sb.String(), err } // WriteAuthorizedStringForValidKey writes the authorized key for the provided key. If the key is invalid, it does nothing. func WriteAuthorizedStringForValidKey(key *PublicKey, w io.Writer) error { validKey, err := writeAuthorizedStringForKey(key, w) if !validKey { log.Debug("WriteAuthorizedStringForValidKey: key %s is not valid: %v", key, err) return nil } return err } func writeAuthorizedStringForKey(key *PublicKey, w io.Writer) (keyValid bool, err error) { const tpl = AuthorizedStringCommentPrefix + "\n" + `command=%s,no-port-forwarding,no-X11-forwarding,no-agent-forwarding,no-pty,no-user-rc,restrict %s %s` + "\n" pubKey, _, _, _, err := ssh.ParseAuthorizedKey([]byte(key.Content)) if err != nil { return false, err } // now the key is valid, the code below could only return template/IO related errors sbCmd := &strings.Builder{} err = setting.SSH.AuthorizedKeysCommandTemplateTemplate.Execute(sbCmd, map[string]any{ "AppPath": util.ShellEscape(setting.AppPath), "AppWorkPath": util.ShellEscape(setting.AppWorkPath), "CustomConf": util.ShellEscape(setting.CustomConf), "CustomPath": util.ShellEscape(setting.CustomPath), "Key": key, }) if err != nil { return true, err } sshCommandEscaped := util.ShellEscape(sbCmd.String()) sshKeyMarshalled := strings.TrimSpace(string(ssh.MarshalAuthorizedKey(pubKey))) sshKeyComment := fmt.Sprintf("user-%d", key.OwnerID) _, err = fmt.Fprintf(w, tpl, sshCommandEscaped, sshKeyMarshalled, sshKeyComment) return true, err } // appendAuthorizedKeysToFile appends new SSH keys' content to authorized_keys file. func appendAuthorizedKeysToFile(keys ...*PublicKey) error { // Don't need to rewrite this file if builtin SSH server is enabled. if setting.SSH.StartBuiltinServer || !setting.SSH.CreateAuthorizedKeysFile { return nil } sshOpLocker.Lock() defer sshOpLocker.Unlock() if setting.SSH.RootPath != "" { // First of ensure that the RootPath is present, and if not make it with 0700 permissions // This of course doesn't guarantee that this is the right directory for authorized_keys // but at least if it's supposed to be this directory and it doesn't exist and we're the // right user it will at least be created properly. err := os.MkdirAll(setting.SSH.RootPath, 0o700) if err != nil { log.Error("Unable to MkdirAll(%s): %v", setting.SSH.RootPath, err) return err } } fPath := filepath.Join(setting.SSH.RootPath, "authorized_keys") f, err := os.OpenFile(fPath, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0o600) if err != nil { return err } defer f.Close() // Note: chmod command does not support in Windows. if !setting.IsWindows { fi, err := f.Stat() if err != nil { return err } // .ssh directory should have mode 700, and authorized_keys file should have mode 600. if fi.Mode().Perm() > 0o600 { log.Error("authorized_keys file has unusual permission flags: %s - setting to -rw-------", fi.Mode().Perm().String()) if err = f.Chmod(0o600); err != nil { return err } } } for _, key := range keys { if key.Type == KeyTypePrincipal { continue } if err = WriteAuthorizedStringForValidKey(key, f); err != nil { return err } } return nil } // RegeneratePublicKeys regenerates the authorized_keys file func RegeneratePublicKeys(ctx context.Context, t io.Writer) error { if err := db.GetEngine(ctx).Where("type != ?", KeyTypePrincipal).Iterate(new(PublicKey), func(idx int, bean any) (err error) { return WriteAuthorizedStringForValidKey(bean.(*PublicKey), t) }); err != nil { return err } fPath := filepath.Join(setting.SSH.RootPath, "authorized_keys") isExist, err := util.IsExist(fPath) if err != nil { log.Error("Unable to check if %s exists. Error: %v", fPath, err) return err } if isExist { f, err := os.Open(fPath) if err != nil { return err } defer f.Close() scanner := bufio.NewScanner(f) for scanner.Scan() { line := scanner.Text() if strings.HasPrefix(line, AuthorizedStringCommentPrefix) { scanner.Scan() continue } _, err = io.WriteString(t, line+"\n") if err != nil { return err } } if err = scanner.Err(); err != nil { return fmt.Errorf("RegeneratePublicKeys scan: %w", err) } } return nil }