forgejo/models/ssh_key.go

999 lines
27 KiB
Go
Raw Normal View History

2014-03-16 10:24:13 +01:00
// Copyright 2014 The Gogs Authors. All rights reserved.
// Copyright 2019 The Gitea Authors. All rights reserved.
2014-03-16 10:24:13 +01:00
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.
2014-02-17 16:57:23 +01:00
package models
import (
"bufio"
"crypto/rsa"
"crypto/x509"
"encoding/asn1"
"encoding/base64"
"encoding/binary"
"encoding/pem"
2014-03-16 10:48:20 +01:00
"errors"
2014-02-17 16:57:23 +01:00
"fmt"
"io/ioutil"
"math/big"
2014-02-17 16:57:23 +01:00
"os"
"path/filepath"
2014-03-16 10:24:13 +01:00
"strings"
"sync"
2014-02-17 16:57:23 +01:00
"time"
2014-03-02 21:25:09 +01:00
"code.gitea.io/gitea/modules/log"
"code.gitea.io/gitea/modules/process"
"code.gitea.io/gitea/modules/setting"
"code.gitea.io/gitea/modules/timeutil"
"github.com/unknwon/com"
"golang.org/x/crypto/ssh"
"xorm.io/builder"
2019-10-17 11:26:49 +02:00
"xorm.io/xorm"
2014-02-17 16:57:23 +01:00
)
const (
tplCommentPrefix = `# gitea public key`
tplPublicKey = tplCommentPrefix + "\n" + `command="%s --config='%s' serv key-%d",no-port-forwarding,no-X11-forwarding,no-agent-forwarding,no-pty %s` + "\n"
)
2016-07-26 04:47:25 +02:00
var sshOpLocker sync.Mutex
2014-02-25 09:13:47 +01:00
2016-11-26 01:36:03 +01:00
// KeyType specifies the key type
2015-08-06 16:48:11 +02:00
type KeyType int
const (
2016-11-26 01:36:03 +01:00
// KeyTypeUser specifies the user key
2016-11-07 17:53:22 +01:00
KeyTypeUser = iota + 1
2016-11-26 01:36:03 +01:00
// KeyTypeDeploy specifies the deploy key
2016-11-07 17:53:22 +01:00
KeyTypeDeploy
2015-08-06 16:48:11 +02:00
)
2016-07-26 04:47:25 +02:00
// PublicKey represents a user or deploy SSH public key.
2014-02-17 16:57:23 +01:00
type PublicKey struct {
ID int64 `xorm:"pk autoincr"`
OwnerID int64 `xorm:"INDEX NOT NULL"`
Name string `xorm:"NOT NULL"`
Fingerprint string `xorm:"INDEX NOT NULL"`
Content string `xorm:"TEXT NOT NULL"`
Mode AccessMode `xorm:"NOT NULL DEFAULT 2"`
Type KeyType `xorm:"NOT NULL DEFAULT 1"`
LoginSourceID int64 `xorm:"NOT NULL DEFAULT 0"`
CreatedUnix timeutil.TimeStamp `xorm:"created"`
UpdatedUnix timeutil.TimeStamp `xorm:"updated"`
HasRecentActivity bool `xorm:"-"`
HasUsed bool `xorm:"-"`
2015-08-06 16:48:11 +02:00
}
// AfterLoad is invoked from XORM after setting the values of all fields of this object.
func (key *PublicKey) AfterLoad() {
key.HasUsed = key.UpdatedUnix > key.CreatedUnix
key.HasRecentActivity = key.UpdatedUnix.AddDuration(7*24*time.Hour) > timeutil.TimeStampNow()
2014-02-17 16:57:23 +01:00
}
2016-07-26 04:47:25 +02:00
// OmitEmail returns content of public key without email address.
2016-11-26 01:36:03 +01:00
func (key *PublicKey) OmitEmail() string {
return strings.Join(strings.Split(key.Content, " ")[:2], " ")
2014-11-23 08:33:47 +01:00
}
2016-07-26 04:47:25 +02:00
// AuthorizedString returns formatted public key string for authorized_keys file.
func (key *PublicKey) AuthorizedString() string {
return fmt.Sprintf(tplPublicKey, setting.AppPath, setting.CustomConf, key.ID, key.Content)
2014-02-17 16:57:23 +01:00
}
func extractTypeFromBase64Key(key string) (string, error) {
b, err := base64.StdEncoding.DecodeString(key)
if err != nil || len(b) < 4 {
2016-07-26 04:47:25 +02:00
return "", fmt.Errorf("invalid key format: %v", err)
}
keyLength := int(binary.BigEndian.Uint32(b))
if len(b) < 4+keyLength {
2016-07-26 04:47:25 +02:00
return "", fmt.Errorf("invalid key format: not enough length %d", keyLength)
}
return string(b[4 : 4+keyLength]), nil
}
const ssh2keyStart = "---- BEGIN SSH2 PUBLIC KEY ----"
2016-07-26 04:47:25 +02:00
// parseKeyString parses any key string in OpenSSH or SSH2 format to clean OpenSSH string (RFC4253).
2015-08-06 16:48:11 +02:00
func parseKeyString(content string) (string, error) {
// remove whitespace at start and end
content = strings.TrimSpace(content)
var keyType, keyContent, keyComment string
if content[:len(ssh2keyStart)] == ssh2keyStart {
// Parse SSH2 file format.
// Transform all legal line endings to a single "\n".
content = strings.NewReplacer("\r\n", "\n", "\r", "\n").Replace(content)
lines := strings.Split(content, "\n")
continuationLine := false
for _, line := range lines {
// Skip lines that:
// 1) are a continuation of the previous line,
// 2) contain ":" as that are comment lines
// 3) contain "-" as that are begin and end tags
if continuationLine || strings.ContainsAny(line, ":-") {
continuationLine = strings.HasSuffix(line, "\\")
} else {
keyContent += line
}
}
t, err := extractTypeFromBase64Key(keyContent)
if err != nil {
return "", fmt.Errorf("extractTypeFromBase64Key: %v", err)
}
keyType = t
} else {
if strings.Contains(content, "-----BEGIN") {
// Convert PEM Keys to OpenSSH format
// Transform all legal line endings to a single "\n".
content = strings.NewReplacer("\r\n", "\n", "\r", "\n").Replace(content)
block, _ := pem.Decode([]byte(content))
if block == nil {
return "", fmt.Errorf("failed to parse PEM block containing the public key")
}
pub, err := x509.ParsePKIXPublicKey(block.Bytes)
if err != nil {
var pk rsa.PublicKey
_, err2 := asn1.Unmarshal(block.Bytes, &pk)
if err2 != nil {
return "", fmt.Errorf("failed to parse DER encoded public key as either PKIX or PEM RSA Key: %v %v", err, err2)
}
pub = &pk
}
sshKey, err := ssh.NewPublicKey(pub)
if err != nil {
return "", fmt.Errorf("unable to convert to ssh public key: %v", err)
}
content = string(ssh.MarshalAuthorizedKey(sshKey))
}
2016-07-26 04:47:25 +02:00
// Parse OpenSSH format.
// Remove all newlines
content = strings.NewReplacer("\r\n", "", "\n", "").Replace(content)
parts := strings.SplitN(content, " ", 3)
switch len(parts) {
case 0:
2016-07-26 04:47:25 +02:00
return "", errors.New("empty key")
case 1:
keyContent = parts[0]
case 2:
keyType = parts[0]
keyContent = parts[1]
default:
keyType = parts[0]
keyContent = parts[1]
keyComment = parts[2]
}
2016-07-26 04:47:25 +02:00
// If keyType is not given, extract it from content. If given, validate it.
t, err := extractTypeFromBase64Key(keyContent)
if err != nil {
return "", fmt.Errorf("extractTypeFromBase64Key: %v", err)
}
if len(keyType) == 0 {
2016-07-26 04:47:25 +02:00
keyType = t
} else if keyType != t {
return "", fmt.Errorf("key type and content does not match: %s - %s", keyType, t)
}
}
// Finally we need to check whether we can actually read the proposed key:
_, _, _, _, err := ssh.ParseAuthorizedKey([]byte(keyType + " " + keyContent + " " + keyComment))
if err != nil {
return "", fmt.Errorf("invalid ssh public key: %v", err)
}
return keyType + " " + keyContent + " " + keyComment, nil
}
// writeTmpKeyFile writes key content to a temporary file
// and returns the name of that file, along with any possible errors.
func writeTmpKeyFile(content string) (string, error) {
2016-12-28 09:33:21 +01:00
tmpFile, err := ioutil.TempFile(setting.SSH.KeyTestPath, "gitea_keytest")
if err != nil {
return "", fmt.Errorf("TempFile: %v", err)
}
defer tmpFile.Close()
if _, err = tmpFile.WriteString(content); err != nil {
2016-07-26 04:47:25 +02:00
return "", fmt.Errorf("WriteString: %v", err)
}
return tmpFile.Name(), nil
}
// SSHKeyGenParsePublicKey extracts key type and length using ssh-keygen.
func SSHKeyGenParsePublicKey(key string) (string, int, error) {
// The ssh-keygen in Windows does not print key type, so no need go further.
if setting.IsWindows {
return "", 0, nil
}
tmpName, err := writeTmpKeyFile(key)
if err != nil {
return "", 0, fmt.Errorf("writeTmpKeyFile: %v", err)
}
defer os.Remove(tmpName)
stdout, stderr, err := process.GetManager().Exec("SSHKeyGenParsePublicKey", setting.SSH.KeygenPath, "-lf", tmpName)
if err != nil {
2016-07-26 04:47:25 +02:00
return "", 0, fmt.Errorf("fail to parse public key: %s - %s", err, stderr)
}
if strings.Contains(stdout, "is not a public key file") {
return "", 0, ErrKeyUnableVerify{stdout}
}
fields := strings.Split(stdout, " ")
if len(fields) < 4 {
2016-07-26 04:47:25 +02:00
return "", 0, fmt.Errorf("invalid public key line: %s", stdout)
}
keyType := strings.Trim(fields[len(fields)-1], "()\r\n")
return strings.ToLower(keyType), com.StrTo(fields[0]).MustInt(), nil
}
// SSHNativeParsePublicKey extracts the key type and length using the golang SSH library.
func SSHNativeParsePublicKey(keyLine string) (string, int, error) {
fields := strings.Fields(keyLine)
if len(fields) < 2 {
return "", 0, fmt.Errorf("not enough fields in public key line: %s", keyLine)
}
raw, err := base64.StdEncoding.DecodeString(fields[1])
if err != nil {
return "", 0, err
}
pkey, err := ssh.ParsePublicKey(raw)
if err != nil {
if strings.Contains(err.Error(), "ssh: unknown key algorithm") {
return "", 0, ErrKeyUnableVerify{err.Error()}
}
2016-07-26 04:47:25 +02:00
return "", 0, fmt.Errorf("ParsePublicKey: %v", err)
}
// The ssh library can parse the key, so next we find out what key exactly we have.
switch pkey.Type() {
case ssh.KeyAlgoDSA:
rawPub := struct {
Name string
P, Q, G, Y *big.Int
}{}
if err := ssh.Unmarshal(pkey.Marshal(), &rawPub); err != nil {
return "", 0, err
}
// as per https://bugzilla.mindrot.org/show_bug.cgi?id=1647 we should never
// see dsa keys != 1024 bit, but as it seems to work, we will not check here
return "dsa", rawPub.P.BitLen(), nil // use P as per crypto/dsa/dsa.go (is L)
case ssh.KeyAlgoRSA:
rawPub := struct {
Name string
E *big.Int
N *big.Int
}{}
if err := ssh.Unmarshal(pkey.Marshal(), &rawPub); err != nil {
return "", 0, err
}
return "rsa", rawPub.N.BitLen(), nil // use N as per crypto/rsa/rsa.go (is bits)
case ssh.KeyAlgoECDSA256:
return "ecdsa", 256, nil
case ssh.KeyAlgoECDSA384:
return "ecdsa", 384, nil
case ssh.KeyAlgoECDSA521:
return "ecdsa", 521, nil
case ssh.KeyAlgoED25519:
return "ed25519", 256, nil
}
2016-07-26 04:47:25 +02:00
return "", 0, fmt.Errorf("unsupported key length detection for type: %s", pkey.Type())
}
2014-07-26 06:24:27 +02:00
// CheckPublicKeyString checks if the given public key string is recognized by SSH.
2016-07-26 04:47:25 +02:00
// It returns the actual public key line on success.
2015-08-06 16:48:11 +02:00
func CheckPublicKeyString(content string) (_ string, err error) {
if setting.SSH.Disabled {
return "", ErrSSHDisabled{}
}
2015-08-06 16:48:11 +02:00
content, err = parseKeyString(content)
if err != nil {
return "", err
}
2014-11-18 21:13:08 +01:00
content = strings.TrimRight(content, "\n\r")
2014-07-26 06:24:27 +02:00
if strings.ContainsAny(content, "\n\r") {
2015-08-06 16:48:11 +02:00
return "", errors.New("only a single line with a single key please")
2014-07-26 06:24:27 +02:00
}
// remove any unnecessary whitespace now
content = strings.TrimSpace(content)
if !setting.SSH.MinimumKeySizeCheck {
return content, nil
}
var (
2016-07-26 04:47:25 +02:00
fnName string
keyType string
length int
)
if setting.SSH.StartBuiltinServer {
2016-07-26 04:47:25 +02:00
fnName = "SSHNativeParsePublicKey"
keyType, length, err = SSHNativeParsePublicKey(content)
} else {
2016-07-26 04:47:25 +02:00
fnName = "SSHKeyGenParsePublicKey"
keyType, length, err = SSHKeyGenParsePublicKey(content)
2014-07-26 06:24:27 +02:00
}
if err != nil {
2016-07-26 04:47:25 +02:00
return "", fmt.Errorf("%s: %v", fnName, err)
2014-07-26 06:24:27 +02:00
}
log.Trace("Key info [native: %v]: %s-%d", setting.SSH.StartBuiltinServer, keyType, length)
2014-07-26 06:24:27 +02:00
if minLen, found := setting.SSH.MinimumKeySizes[keyType]; found && length >= minLen {
return content, nil
} else if found && length < minLen {
2016-07-26 04:47:25 +02:00
return "", fmt.Errorf("key length is not enough: got %d, needs %d", length, minLen)
}
2016-07-26 04:47:25 +02:00
return "", fmt.Errorf("key type is not allowed: %s", keyType)
2014-07-26 06:24:27 +02:00
}
2016-07-26 04:47:25 +02:00
// 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 {
return nil
}
2014-05-07 18:09:30 +02:00
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, 0700)
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, 0600)
2014-05-07 18:09:30 +02:00
if err != nil {
return err
}
defer f.Close()
2015-02-01 23:21:56 +01:00
2016-07-26 04:47:25 +02:00
// Note: chmod command does not support in Windows.
2014-09-16 19:34:09 +02:00
if !setting.IsWindows {
2016-07-26 04:47:25 +02:00
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() > 0600 {
Better logging (#6038) (#6095) * Panic don't fatal on create new logger Fixes #5854 Signed-off-by: Andrew Thornton <art27@cantab.net> * partial broken * Update the logging infrastrcture Signed-off-by: Andrew Thornton <art27@cantab.net> * Reset the skip levels for Fatal and Error Signed-off-by: Andrew Thornton <art27@cantab.net> * broken ncsa * More log.Error fixes Signed-off-by: Andrew Thornton <art27@cantab.net> * Remove nal * set log-levels to lowercase * Make console_test test all levels * switch to lowercased levels * OK now working * Fix vetting issues * Fix lint * Fix tests * change default logging to match current gitea * Improve log testing Signed-off-by: Andrew Thornton <art27@cantab.net> * reset error skip levels to 0 * Update documentation and access logger configuration * Redirect the router log back to gitea if redirect macaron log but also allow setting the log level - i.e. TRACE * Fix broken level caching * Refactor the router log * Add Router logger * Add colorizing options * Adjust router colors * Only create logger if they will be used * update app.ini.sample * rename Attribute ColorAttribute * Change from white to green for function * Set fatal/error levels * Restore initial trace logger * Fix Trace arguments in modules/auth/auth.go * Properly handle XORMLogger * Improve admin/config page * fix fmt * Add auto-compression of old logs * Update error log levels * Remove the unnecessary skip argument from Error, Fatal and Critical * Add stacktrace support * Fix tests * Remove x/sync from vendors? * Add stderr option to console logger * Use filepath.ToSlash to protect against Windows in tests * Remove prefixed underscores from names in colors.go * Remove not implemented database logger This was removed from Gogs on 4 Mar 2016 but left in the configuration since then. * Ensure that log paths are relative to ROOT_PATH * use path.Join * rename jsonConfig to logConfig * Rename "config" to "jsonConfig" to make it clearer * Requested changes * Requested changes: XormLogger * Try to color the windows terminal If successful default to colorizing the console logs * fixup * Colorize initially too * update vendor * Colorize logs on default and remove if this is not a colorizing logger * Fix documentation * fix test * Use go-isatty to detect if on windows we are on msys or cygwin * Fix spelling mistake * Add missing vendors * More changes * Rationalise the ANSI writer protection * Adjust colors on advice from @0x5c * Make Flags a comma separated list * Move to use the windows constant for ENABLE_VIRTUAL_TERMINAL_PROCESSING * Ensure matching is done on the non-colored message - to simpify EXPRESSION
2019-04-02 09:48:31 +02:00
log.Error("authorized_keys file has unusual permission flags: %s - setting to -rw-------", fi.Mode().Perm().String())
2014-09-16 14:32:13 +02:00
if err = f.Chmod(0600); err != nil {
return err
}
}
}
for _, key := range keys {
2016-07-26 04:47:25 +02:00
if _, err = f.WriteString(key.AuthorizedString()); err != nil {
return err
}
}
return nil
2014-05-07 18:09:30 +02:00
}
// checkKeyFingerprint only checks if key fingerprint has been used as public key,
// it is OK to use same key as deploy key for multiple repositories/users.
func checkKeyFingerprint(e Engine, fingerprint string) error {
has, err := e.Get(&PublicKey{
Fingerprint: fingerprint,
})
if err != nil {
return err
} else if has {
return ErrKeyAlreadyExist{0, fingerprint, ""}
}
2015-08-06 16:48:11 +02:00
return nil
}
func calcFingerprintSSHKeygen(publicKeyContent string) (string, error) {
2014-03-16 11:16:03 +01:00
// Calculate fingerprint.
tmpPath, err := writeTmpKeyFile(publicKeyContent)
if err != nil {
return "", err
2014-02-17 16:57:23 +01:00
}
defer os.Remove(tmpPath)
stdout, stderr, err := process.GetManager().Exec("AddPublicKey", "ssh-keygen", "-lf", tmpPath)
2014-02-17 16:57:23 +01:00
if err != nil {
return "", fmt.Errorf("'ssh-keygen -lf %s' failed with error '%s': %s", tmpPath, err, stderr)
2014-03-16 11:16:03 +01:00
} else if len(stdout) < 2 {
return "", errors.New("not enough output for calculating fingerprint: " + stdout)
}
return strings.Split(stdout, " ")[1], nil
}
func calcFingerprintNative(publicKeyContent string) (string, error) {
// Calculate fingerprint.
pk, _, _, _, err := ssh.ParseAuthorizedKey([]byte(publicKeyContent))
if err != nil {
return "", err
}
return ssh.FingerprintSHA256(pk), nil
}
func calcFingerprint(publicKeyContent string) (string, error) {
//Call the method based on configuration
var (
fnName, fp string
err error
)
if setting.SSH.StartBuiltinServer {
fnName = "calcFingerprintNative"
fp, err = calcFingerprintNative(publicKeyContent)
} else {
fnName = "calcFingerprintSSHKeygen"
fp, err = calcFingerprintSSHKeygen(publicKeyContent)
}
if err != nil {
return "", fmt.Errorf("%s: %v", fnName, err)
}
return fp, nil
}
func addKey(e Engine, key *PublicKey) (err error) {
if len(key.Fingerprint) == 0 {
key.Fingerprint, err = calcFingerprint(key.Content)
if err != nil {
return err
}
2014-03-16 11:16:03 +01:00
}
// Save SSH key.
2015-08-06 16:48:11 +02:00
if _, err = e.Insert(key); err != nil {
2014-03-16 11:16:03 +01:00
return err
2015-08-06 16:48:11 +02:00
}
2016-07-26 04:47:25 +02:00
return appendAuthorizedKeysToFile(key)
2015-08-06 16:48:11 +02:00
}
// AddPublicKey adds new public key to database and authorized_keys file.
2019-06-12 21:41:28 +02:00
func AddPublicKey(ownerID int64, name, content string, loginSourceID int64) (*PublicKey, error) {
log.Trace(content)
fingerprint, err := calcFingerprint(content)
if err != nil {
return nil, err
}
sess := x.NewSession()
defer sess.Close()
if err = sess.Begin(); err != nil {
return nil, err
}
if err := checkKeyFingerprint(sess, fingerprint); err != nil {
2015-12-03 06:24:37 +01:00
return nil, err
2014-02-17 16:57:23 +01:00
}
2015-08-06 16:48:11 +02:00
// Key name of same user cannot be duplicated.
has, err := sess.
2016-11-10 16:16:32 +01:00
Where("owner_id = ? AND name = ?", ownerID, name).
Get(new(PublicKey))
2015-08-06 16:48:11 +02:00
if err != nil {
2015-12-03 06:24:37 +01:00
return nil, err
2015-08-06 16:48:11 +02:00
} else if has {
2015-12-03 06:24:37 +01:00
return nil, ErrKeyNameAlreadyUsed{ownerID, name}
2015-08-06 16:48:11 +02:00
}
key := &PublicKey{
OwnerID: ownerID,
Name: name,
Fingerprint: fingerprint,
Content: content,
Mode: AccessModeWrite,
Type: KeyTypeUser,
2019-06-12 21:41:28 +02:00
LoginSourceID: loginSourceID,
2015-08-06 16:48:11 +02:00
}
if err = addKey(sess, key); err != nil {
2015-12-03 06:24:37 +01:00
return nil, fmt.Errorf("addKey: %v", err)
2015-08-06 16:48:11 +02:00
}
2015-12-03 06:24:37 +01:00
return key, sess.Commit()
2014-02-17 16:57:23 +01:00
}
2015-08-06 16:48:11 +02:00
// GetPublicKeyByID returns public key by given ID.
func GetPublicKeyByID(keyID int64) (*PublicKey, error) {
2014-08-10 00:40:10 +02:00
key := new(PublicKey)
2016-11-10 16:16:32 +01:00
has, err := x.
Id(keyID).
Get(key)
2014-08-10 00:40:10 +02:00
if err != nil {
return nil, err
} else if !has {
2015-08-06 16:48:11 +02:00
return nil, ErrKeyNotExist{keyID}
2014-08-10 00:40:10 +02:00
}
return key, nil
}
func searchPublicKeyByContentWithEngine(e Engine, content string) (*PublicKey, error) {
key := new(PublicKey)
has, err := e.
2016-11-10 16:16:32 +01:00
Where("content like ?", content+"%").
Get(key)
if err != nil {
return nil, err
} else if !has {
return nil, ErrKeyNotExist{}
}
return key, nil
}
// SearchPublicKeyByContent searches content as prefix (leak e-mail part)
// and returns public key found.
func SearchPublicKeyByContent(content string) (*PublicKey, error) {
return searchPublicKeyByContentWithEngine(x, content)
}
// SearchPublicKey returns a list of public keys matching the provided arguments.
func SearchPublicKey(uid int64, fingerprint string) ([]*PublicKey, error) {
keys := make([]*PublicKey, 0, 5)
cond := builder.NewCond()
if uid != 0 {
cond = cond.And(builder.Eq{"owner_id": uid})
}
if fingerprint != "" {
cond = cond.And(builder.Eq{"fingerprint": fingerprint})
}
return keys, x.Where(cond).Find(&keys)
}
2014-11-12 12:48:50 +01:00
// ListPublicKeys returns a list of public keys belongs to given user.
func ListPublicKeys(uid int64) ([]*PublicKey, error) {
2014-07-26 06:24:27 +02:00
keys := make([]*PublicKey, 0, 5)
2016-11-10 16:16:32 +01:00
return keys, x.
Where("owner_id = ?", uid).
Find(&keys)
2014-05-07 18:09:30 +02:00
}
// ListPublicLdapSSHKeys returns a list of synchronized public ldap ssh keys belongs to given user and login source.
2019-06-12 21:41:28 +02:00
func ListPublicLdapSSHKeys(uid int64, loginSourceID int64) ([]*PublicKey, error) {
keys := make([]*PublicKey, 0, 5)
return keys, x.
2019-06-12 21:41:28 +02:00
Where("owner_id = ? AND login_source_id = ?", uid, loginSourceID).
Find(&keys)
}
// UpdatePublicKeyUpdated updates public key use time.
func UpdatePublicKeyUpdated(id int64) error {
// Check if key exists before update as affected rows count is unreliable
// and will return 0 affected rows if two updates are made at the same time
if cnt, err := x.ID(id).Count(&PublicKey{}); err != nil {
return err
} else if cnt != 1 {
return ErrKeyNotExist{id}
}
_, err := x.ID(id).Cols("updated_unix").Update(&PublicKey{
UpdatedUnix: timeutil.TimeStampNow(),
})
if err != nil {
return err
}
return nil
}
// deletePublicKeys does the actual key deletion but does not update authorized_keys file.
func deletePublicKeys(e Engine, keyIDs ...int64) error {
if len(keyIDs) == 0 {
2015-08-06 16:48:11 +02:00
return nil
2014-03-22 19:27:03 +01:00
}
2014-05-06 22:28:52 +02:00
2016-11-12 09:29:18 +01:00
_, err := e.In("id", keyIDs).Delete(new(PublicKey))
return err
2014-02-17 16:57:23 +01:00
}
2015-08-06 16:48:11 +02:00
// DeletePublicKey deletes SSH key information both in database and authorized_keys file.
2015-12-03 06:24:37 +01:00
func DeletePublicKey(doer *User, id int64) (err error) {
key, err := GetPublicKeyByID(id)
2015-08-20 11:11:29 +02:00
if err != nil {
return err
2015-12-03 06:24:37 +01:00
}
// Check if user has access to delete this key.
2016-07-23 19:08:22 +02:00
if !doer.IsAdmin && doer.ID != key.OwnerID {
return ErrKeyAccessDenied{doer.ID, key.ID, "public"}
2015-08-20 11:11:29 +02:00
}
2015-08-06 16:48:11 +02:00
sess := x.NewSession()
defer sess.Close()
2015-08-06 16:48:11 +02:00
if err = sess.Begin(); err != nil {
return err
}
if err = deletePublicKeys(sess, id); err != nil {
2015-08-06 16:48:11 +02:00
return err
}
if err = sess.Commit(); err != nil {
return err
}
sess.Close()
return RewriteAllPublicKeys()
2015-08-06 16:48:11 +02:00
}
2015-02-01 23:21:56 +01:00
// RewriteAllPublicKeys removes any authorized key and rewrite all keys from database again.
// Note: x.Iterate does not get latest data after insert/delete, so we have to call this function
2017-01-05 01:50:34 +01:00
// outside any session scope independently.
func RewriteAllPublicKeys() error {
return rewriteAllPublicKeys(x)
}
func rewriteAllPublicKeys(e Engine) error {
//Don't rewrite key if internal server
2018-11-01 14:41:07 +01:00
if setting.SSH.StartBuiltinServer || !setting.SSH.CreateAuthorizedKeysFile {
return nil
}
2015-02-01 23:21:56 +01:00
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, 0700)
if err != nil {
log.Error("Unable to MkdirAll(%s): %v", setting.SSH.RootPath, err)
return err
}
}
fPath := filepath.Join(setting.SSH.RootPath, "authorized_keys")
tmpPath := fPath + ".tmp"
t, err := os.OpenFile(tmpPath, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0600)
if err != nil {
return err
}
defer func() {
t.Close()
os.Remove(tmpPath)
}()
if setting.SSH.AuthorizedKeysBackup && com.IsExist(fPath) {
bakPath := fmt.Sprintf("%s_%d.gitea_bak", fPath, time.Now().Unix())
if err = com.Copy(fPath, bakPath); err != nil {
return err
}
}
err = e.Iterate(new(PublicKey), func(idx int, bean interface{}) (err error) {
_, err = t.WriteString((bean.(*PublicKey)).AuthorizedString())
2015-02-01 23:21:56 +01:00
return err
})
if err != nil {
return err
}
2015-02-01 23:21:56 +01:00
if com.IsExist(fPath) {
f, err := os.Open(fPath)
if err != nil {
2015-02-01 23:21:56 +01:00
return err
}
scanner := bufio.NewScanner(f)
for scanner.Scan() {
line := scanner.Text()
if strings.HasPrefix(line, tplCommentPrefix) {
scanner.Scan()
continue
}
_, err = t.WriteString(line + "\n")
if err != nil {
f.Close()
return err
}
}
f.Close()
2015-02-01 23:21:56 +01:00
}
t.Close()
2017-09-19 10:08:30 +02:00
return os.Rename(tmpPath, fPath)
}
2015-08-06 16:48:11 +02:00
// ________ .__ ____ __.
// \______ \ ____ ______ | | ____ ___.__.| |/ _|____ ___.__.
// | | \_/ __ \\____ \| | / _ < | || <_/ __ < | |
// | ` \ ___/| |_> > |_( <_> )___ || | \ ___/\___ |
// /_______ /\___ > __/|____/\____// ____||____|__ \___ > ____|
// \/ \/|__| \/ \/ \/\/
// DeployKey represents deploy key information and its relation with repository.
type DeployKey struct {
ID int64 `xorm:"pk autoincr"`
KeyID int64 `xorm:"UNIQUE(s) INDEX"`
RepoID int64 `xorm:"UNIQUE(s) INDEX"`
Name string
Fingerprint string
Content string `xorm:"-"`
Mode AccessMode `xorm:"NOT NULL DEFAULT 1"`
CreatedUnix timeutil.TimeStamp `xorm:"created"`
UpdatedUnix timeutil.TimeStamp `xorm:"updated"`
HasRecentActivity bool `xorm:"-"`
HasUsed bool `xorm:"-"`
2015-08-06 16:48:11 +02:00
}
// AfterLoad is invoked from XORM after setting the values of all fields of this object.
func (key *DeployKey) AfterLoad() {
key.HasUsed = key.UpdatedUnix > key.CreatedUnix
key.HasRecentActivity = key.UpdatedUnix.AddDuration(7*24*time.Hour) > timeutil.TimeStampNow()
2015-08-06 16:48:11 +02:00
}
2015-11-19 03:21:47 +01:00
// GetContent gets associated public key content.
2016-11-26 01:36:03 +01:00
func (key *DeployKey) GetContent() error {
pkey, err := GetPublicKeyByID(key.KeyID)
2015-11-19 03:21:47 +01:00
if err != nil {
return err
}
2016-11-26 01:36:03 +01:00
key.Content = pkey.Content
2015-11-19 03:21:47 +01:00
return nil
}
// IsReadOnly checks if the key can only be used for read operations
func (key *DeployKey) IsReadOnly() bool {
return key.Mode == AccessModeRead
}
2015-08-06 16:48:11 +02:00
func checkDeployKey(e Engine, keyID, repoID int64, name string) error {
// Note: We want error detail, not just true or false here.
2016-11-10 16:16:32 +01:00
has, err := e.
Where("key_id = ? AND repo_id = ?", keyID, repoID).
Get(new(DeployKey))
2015-08-06 16:48:11 +02:00
if err != nil {
return err
} else if has {
return ErrDeployKeyAlreadyExist{keyID, repoID}
}
2016-11-10 16:16:32 +01:00
has, err = e.
Where("repo_id = ? AND name = ?", repoID, name).
Get(new(DeployKey))
2015-08-06 16:48:11 +02:00
if err != nil {
return err
} else if has {
return ErrDeployKeyNameAlreadyUsed{repoID, name}
}
return nil
}
// addDeployKey adds new key-repo relation.
func addDeployKey(e *xorm.Session, keyID, repoID int64, name, fingerprint string, mode AccessMode) (*DeployKey, error) {
2015-11-19 03:21:47 +01:00
if err := checkDeployKey(e, keyID, repoID, name); err != nil {
return nil, err
2015-08-06 16:48:11 +02:00
}
2015-11-19 03:21:47 +01:00
key := &DeployKey{
2015-08-06 16:48:11 +02:00
KeyID: keyID,
RepoID: repoID,
Name: name,
Fingerprint: fingerprint,
Mode: mode,
2015-11-19 03:21:47 +01:00
}
_, err := e.Insert(key)
return key, err
2015-08-06 16:48:11 +02:00
}
// HasDeployKey returns true if public key is a deploy key of given repository.
func HasDeployKey(keyID, repoID int64) bool {
2016-11-10 16:16:32 +01:00
has, _ := x.
Where("key_id = ? AND repo_id = ?", keyID, repoID).
Get(new(DeployKey))
2015-08-06 16:48:11 +02:00
return has
}
// AddDeployKey add new deploy key to database and authorized_keys file.
func AddDeployKey(repoID int64, name, content string, readOnly bool) (*DeployKey, error) {
fingerprint, err := calcFingerprint(content)
if err != nil {
2015-11-19 03:21:47 +01:00
return nil, err
2015-08-06 16:48:11 +02:00
}
accessMode := AccessModeRead
if !readOnly {
accessMode = AccessModeWrite
}
sess := x.NewSession()
defer sess.Close()
if err = sess.Begin(); err != nil {
return nil, err
}
2015-11-19 03:21:47 +01:00
pkey := &PublicKey{
Fingerprint: fingerprint,
2015-08-06 16:48:11 +02:00
}
has, err := sess.Get(pkey)
2015-08-06 16:48:11 +02:00
if err != nil {
2015-11-19 03:21:47 +01:00
return nil, err
2015-08-06 16:48:11 +02:00
}
if has {
if pkey.Type != KeyTypeDeploy {
return nil, ErrKeyAlreadyExist{0, fingerprint, ""}
}
} else {
// First time use this deploy key.
pkey.Mode = accessMode
pkey.Type = KeyTypeDeploy
pkey.Content = content
pkey.Name = name
2015-11-19 03:21:47 +01:00
if err = addKey(sess, pkey); err != nil {
return nil, fmt.Errorf("addKey: %v", err)
2015-08-06 16:48:11 +02:00
}
}
key, err := addDeployKey(sess, pkey.ID, repoID, name, pkey.Fingerprint, accessMode)
2015-11-19 03:21:47 +01:00
if err != nil {
return nil, err
2015-08-06 16:48:11 +02:00
}
2015-11-19 03:21:47 +01:00
return key, sess.Commit()
}
// GetDeployKeyByID returns deploy key by given ID.
func GetDeployKeyByID(id int64) (*DeployKey, error) {
return getDeployKeyByID(x, id)
}
func getDeployKeyByID(e Engine, id int64) (*DeployKey, error) {
2015-11-19 03:21:47 +01:00
key := new(DeployKey)
has, err := e.ID(id).Get(key)
2015-11-19 03:21:47 +01:00
if err != nil {
return nil, err
} else if !has {
return nil, ErrDeployKeyNotExist{id, 0, 0}
}
return key, nil
2015-08-06 16:48:11 +02:00
}
// GetDeployKeyByRepo returns deploy key by given public key ID and repository ID.
func GetDeployKeyByRepo(keyID, repoID int64) (*DeployKey, error) {
return getDeployKeyByRepo(x, keyID, repoID)
}
func getDeployKeyByRepo(e Engine, keyID, repoID int64) (*DeployKey, error) {
2015-08-06 16:48:11 +02:00
key := &DeployKey{
KeyID: keyID,
RepoID: repoID,
}
has, err := e.Get(key)
2015-11-19 03:21:47 +01:00
if err != nil {
return nil, err
} else if !has {
return nil, ErrDeployKeyNotExist{0, keyID, repoID}
}
return key, nil
2015-08-06 16:48:11 +02:00
}
// UpdateDeployKeyCols updates deploy key information in the specified columns.
func UpdateDeployKeyCols(key *DeployKey, cols ...string) error {
_, err := x.ID(key.ID).Cols(cols...).Update(key)
return err
}
2015-08-06 16:48:11 +02:00
// UpdateDeployKey updates deploy key information.
func UpdateDeployKey(key *DeployKey) error {
_, err := x.ID(key.ID).AllCols().Update(key)
2015-08-06 16:48:11 +02:00
return err
}
// DeleteDeployKey deletes deploy key from its repository authorized_keys file if needed.
2015-12-03 06:24:37 +01:00
func DeleteDeployKey(doer *User, id int64) error {
sess := x.NewSession()
defer sess.Close()
if err := sess.Begin(); err != nil {
return err
}
if err := deleteDeployKey(sess, doer, id); err != nil {
return err
}
return sess.Commit()
}
func deleteDeployKey(sess Engine, doer *User, id int64) error {
key, err := getDeployKeyByID(sess, id)
2015-08-06 16:48:11 +02:00
if err != nil {
2015-12-03 06:24:37 +01:00
if IsErrDeployKeyNotExist(err) {
return nil
}
return fmt.Errorf("GetDeployKeyByID: %v", err)
}
// Check if user has access to delete this key.
2015-12-05 23:13:13 +01:00
if !doer.IsAdmin {
repo, err := getRepositoryByID(sess, key.RepoID)
2015-12-05 23:13:13 +01:00
if err != nil {
return fmt.Errorf("GetRepositoryByID: %v", err)
}
has, err := isUserRepoAdmin(sess, repo, doer)
2015-12-05 23:13:13 +01:00
if err != nil {
return fmt.Errorf("GetUserRepoPermission: %v", err)
} else if !has {
2016-07-23 19:08:22 +02:00
return ErrKeyAccessDenied{doer.ID, key.ID, "deploy"}
2015-12-05 23:13:13 +01:00
}
2015-08-06 16:48:11 +02:00
}
if _, err = sess.ID(key.ID).Delete(new(DeployKey)); err != nil {
2016-07-26 04:47:25 +02:00
return fmt.Errorf("delete deploy key [%d]: %v", key.ID, err)
2015-08-06 16:48:11 +02:00
}
// Check if this is the last reference to same key content.
2016-11-10 16:16:32 +01:00
has, err := sess.
Where("key_id = ?", key.KeyID).
Get(new(DeployKey))
2015-08-06 16:48:11 +02:00
if err != nil {
return err
} else if !has {
if err = deletePublicKeys(sess, key.KeyID); err != nil {
2015-08-06 16:48:11 +02:00
return err
}
// after deleted the public keys, should rewrite the public keys file
if err = rewriteAllPublicKeys(sess); err != nil {
return err
}
2015-08-06 16:48:11 +02:00
}
return nil
2015-08-06 16:48:11 +02:00
}
// ListDeployKeys returns all deploy keys by given repository ID.
func ListDeployKeys(repoID int64) ([]*DeployKey, error) {
return listDeployKeys(x, repoID)
}
func listDeployKeys(e Engine, repoID int64) ([]*DeployKey, error) {
2015-08-06 16:48:11 +02:00
keys := make([]*DeployKey, 0, 5)
return keys, e.
2016-11-10 16:16:32 +01:00
Where("repo_id = ?", repoID).
Find(&keys)
2015-08-06 16:48:11 +02:00
}
// SearchDeployKeys returns a list of deploy keys matching the provided arguments.
func SearchDeployKeys(repoID int64, keyID int64, fingerprint string) ([]*DeployKey, error) {
keys := make([]*DeployKey, 0, 5)
cond := builder.NewCond()
if repoID != 0 {
cond = cond.And(builder.Eq{"repo_id": repoID})
}
if keyID != 0 {
cond = cond.And(builder.Eq{"key_id": keyID})
}
if fingerprint != "" {
cond = cond.And(builder.Eq{"fingerprint": fingerprint})
}
return keys, x.Where(cond).Find(&keys)
}