gitroast/models/ssh_key.go

778 lines
21 KiB
Go
Raw Normal View History

2014-03-16 09:24:13 +00:00
// Copyright 2014 The Gogs Authors. All rights reserved.
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.
2014-02-17 15:57:23 +00:00
package models
import (
"encoding/base64"
"encoding/binary"
2014-03-16 09:48:20 +00:00
"errors"
2014-02-17 15:57:23 +00:00
"fmt"
"io/ioutil"
"math/big"
2014-02-17 15:57:23 +00:00
"os"
2014-03-16 10:16:03 +00:00
"path"
2014-02-17 15:57:23 +00:00
"path/filepath"
2014-03-16 09:24:13 +00:00
"strings"
"sync"
2014-02-17 15:57:23 +00:00
"time"
2014-03-02 20:25:09 +00:00
"github.com/Unknwon/com"
2015-08-06 14:48:11 +00:00
"github.com/go-xorm/xorm"
"golang.org/x/crypto/ssh"
2014-03-22 18:27:03 +00:00
"code.gitea.io/gitea/modules/log"
"code.gitea.io/gitea/modules/process"
"code.gitea.io/gitea/modules/setting"
2014-02-17 15:57:23 +00:00
)
const (
2016-11-07 16:53:22 +00:00
tplPublicKey = `command="%s serv key-%d --config='%s'",no-port-forwarding,no-X11-forwarding,no-agent-forwarding,no-pty %s` + "\n"
)
2016-07-26 02:47:25 +00:00
var sshOpLocker sync.Mutex
2014-02-25 08:13:47 +00:00
2015-08-06 14:48:11 +00:00
type KeyType int
const (
2016-11-07 16:53:22 +00:00
KeyTypeUser = iota + 1
KeyTypeDeploy
2015-08-06 14:48:11 +00:00
)
2016-07-26 02:47:25 +00:00
// PublicKey represents a user or deploy SSH public key.
2014-02-17 15:57:23 +00:00
type PublicKey struct {
ID int64 `xorm:"pk autoincr"`
OwnerID int64 `xorm:"INDEX NOT NULL"`
Name string `xorm:"NOT NULL"`
Fingerprint string `xorm:"NOT NULL"`
Content string `xorm:"TEXT NOT NULL"`
Mode AccessMode `xorm:"NOT NULL DEFAULT 2"`
Type KeyType `xorm:"NOT NULL DEFAULT 1"`
Created time.Time `xorm:"-"`
CreatedUnix int64
Updated time.Time `xorm:"-"` // Note: Updated must below Created for AfterSet.
UpdatedUnix int64
HasRecentActivity bool `xorm:"-"`
HasUsed bool `xorm:"-"`
}
func (k *PublicKey) BeforeInsert() {
k.CreatedUnix = time.Now().Unix()
}
func (k *PublicKey) BeforeUpdate() {
k.UpdatedUnix = time.Now().Unix()
2015-08-06 14:48:11 +00:00
}
func (k *PublicKey) AfterSet(colName string, _ xorm.Cell) {
switch colName {
case "created_unix":
k.Created = time.Unix(k.CreatedUnix, 0).Local()
case "updated_unix":
k.Updated = time.Unix(k.UpdatedUnix, 0).Local()
2015-08-06 14:48:11 +00:00
k.HasUsed = k.Updated.After(k.Created)
k.HasRecentActivity = k.Updated.Add(7 * 24 * time.Hour).After(time.Now())
}
2014-02-17 15:57:23 +00:00
}
2016-07-26 02:47:25 +00:00
// OmitEmail returns content of public key without email address.
2014-11-23 07:33:47 +00:00
func (k *PublicKey) OmitEmail() string {
return strings.Join(strings.Split(k.Content, " ")[:2], " ")
}
2016-07-26 02:47:25 +00:00
// AuthorizedString returns formatted public key string for authorized_keys file.
func (key *PublicKey) AuthorizedString() string {
2016-11-07 16:53:22 +00:00
return fmt.Sprintf(tplPublicKey, setting.AppPath, key.ID, setting.CustomConf, key.Content)
2014-02-17 15:57:23 +00:00
}
func extractTypeFromBase64Key(key string) (string, error) {
b, err := base64.StdEncoding.DecodeString(key)
if err != nil || len(b) < 4 {
2016-07-26 02:47:25 +00:00
return "", fmt.Errorf("invalid key format: %v", err)
}
keyLength := int(binary.BigEndian.Uint32(b))
if len(b) < 4+keyLength {
2016-07-26 02:47:25 +00:00
return "", fmt.Errorf("invalid key format: not enough length %d", keyLength)
}
return string(b[4 : 4+keyLength]), nil
}
2016-07-26 02:47:25 +00:00
// parseKeyString parses any key string in OpenSSH or SSH2 format to clean OpenSSH string (RFC4253).
2015-08-06 14:48:11 +00:00
func parseKeyString(content string) (string, error) {
2016-07-26 02:47:25 +00:00
// Transform all legal line endings to a single "\n".
content = strings.NewReplacer("\r\n", "\n", "\r", "\n").Replace(content)
// remove trailing newline (and beginning spaces too)
content = strings.TrimSpace(content)
2016-07-26 02:47:25 +00:00
lines := strings.Split(content, "\n")
var keyType, keyContent, keyComment string
if len(lines) == 1 {
2016-07-26 02:47:25 +00:00
// Parse OpenSSH format.
2015-09-12 20:58:18 +00:00
parts := strings.SplitN(lines[0], " ", 3)
switch len(parts) {
case 0:
2016-07-26 02:47:25 +00: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 02:47:25 +00: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 02:47:25 +00:00
keyType = t
} else if keyType != t {
return "", fmt.Errorf("key type and content does not match: %s - %s", keyType, t)
}
} else {
// Parse SSH2 file format.
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 = keyContent + line
}
}
2016-07-26 02:47:25 +00:00
t, err := extractTypeFromBase64Key(keyContent)
if err != nil {
return "", fmt.Errorf("extractTypeFromBase64Key: %v", err)
}
2016-07-26 02:47:25 +00:00
keyType = t
}
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) {
tmpFile, err := ioutil.TempFile(setting.SSH.KeyTestPath, "gogs_keytest")
if err != nil {
return "", fmt.Errorf("TempFile: %v", err)
}
defer tmpFile.Close()
if _, err = tmpFile.WriteString(content); err != nil {
2016-07-26 02:47:25 +00: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.Exec("SSHKeyGenParsePublicKey", setting.SSH.KeygenPath, "-lf", tmpName)
if err != nil {
2016-07-26 02:47:25 +00: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 02:47:25 +00: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.
// NOTE: ed25519 is not supported.
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", string(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 02:47:25 +00: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
2016-07-26 02:47:25 +00:00
case "ssh-ed25519": // TODO: replace with ssh constant when available
return "ed25519", 256, nil
}
2016-07-26 02:47:25 +00:00
return "", 0, fmt.Errorf("unsupported key length detection for type: %s", pkey.Type())
}
2014-07-26 04:24:27 +00:00
// CheckPublicKeyString checks if the given public key string is recognized by SSH.
2016-07-26 02:47:25 +00:00
// It returns the actual public key line on success.
2015-08-06 14:48:11 +00:00
func CheckPublicKeyString(content string) (_ string, err error) {
if setting.SSH.Disabled {
return "", errors.New("SSH is disabled")
}
2015-08-06 14:48:11 +00:00
content, err = parseKeyString(content)
if err != nil {
return "", err
}
2014-11-18 20:13:08 +00:00
content = strings.TrimRight(content, "\n\r")
2014-07-26 04:24:27 +00:00
if strings.ContainsAny(content, "\n\r") {
2015-08-06 14:48:11 +00:00
return "", errors.New("only a single line with a single key please")
2014-07-26 04:24:27 +00:00
}
// remove any unnecessary whitespace now
content = strings.TrimSpace(content)
var (
2016-07-26 02:47:25 +00:00
fnName string
keyType string
length int
)
if setting.SSH.StartBuiltinServer {
2016-07-26 02:47:25 +00:00
fnName = "SSHNativeParsePublicKey"
keyType, length, err = SSHNativeParsePublicKey(content)
} else {
2016-07-26 02:47:25 +00:00
fnName = "SSHKeyGenParsePublicKey"
keyType, length, err = SSHKeyGenParsePublicKey(content)
2014-07-26 04:24:27 +00:00
}
if err != nil {
2016-07-26 02:47:25 +00:00
return "", fmt.Errorf("%s: %v", fnName, err)
2014-07-26 04:24:27 +00:00
}
log.Trace("Key info [native: %v]: %s-%d", setting.SSH.StartBuiltinServer, keyType, length)
2014-07-26 04:24:27 +00:00
if !setting.SSH.MinimumKeySizeCheck {
return content, nil
}
if minLen, found := setting.SSH.MinimumKeySizes[keyType]; found && length >= minLen {
return content, nil
} else if found && length < minLen {
2016-07-26 02:47:25 +00:00
return "", fmt.Errorf("key length is not enough: got %d, needs %d", length, minLen)
}
2016-07-26 02:47:25 +00:00
return "", fmt.Errorf("key type is not allowed: %s", keyType)
2014-07-26 04:24:27 +00:00
}
2016-07-26 02:47:25 +00:00
// appendAuthorizedKeysToFile appends new SSH keys' content to authorized_keys file.
func appendAuthorizedKeysToFile(keys ...*PublicKey) error {
2014-05-07 16:09:30 +00:00
sshOpLocker.Lock()
defer sshOpLocker.Unlock()
fpath := filepath.Join(setting.SSH.RootPath, "authorized_keys")
2014-05-07 16:09:30 +00:00
f, err := os.OpenFile(fpath, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0600)
if err != nil {
return err
}
defer f.Close()
2015-02-01 22:21:56 +00:00
2016-07-26 02:47:25 +00:00
// Note: chmod command does not support in Windows.
2014-09-16 17:34:09 +00:00
if !setting.IsWindows {
2016-07-26 02:47:25 +00: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 {
log.Error(4, "authorized_keys file has unusual permission flags: %s - setting to -rw-------", fi.Mode().Perm().String())
2014-09-16 12:32:13 +00:00
if err = f.Chmod(0600); err != nil {
return err
}
}
}
for _, key := range keys {
2016-07-26 02:47:25 +00:00
if _, err = f.WriteString(key.AuthorizedString()); err != nil {
return err
}
}
return nil
2014-05-07 16:09:30 +00:00
}
// checkKeyContent onlys checks if key content has been used as public key,
// it is OK to use same key as deploy key for multiple repositories/users.
2015-08-06 14:48:11 +00:00
func checkKeyContent(content string) error {
has, err := x.Get(&PublicKey{
Content: content,
2016-11-07 16:53:22 +00:00
Type: KeyTypeUser,
})
if err != nil {
return err
} else if has {
2015-08-06 14:48:11 +00:00
return ErrKeyAlreadyExist{0, content}
}
2015-08-06 14:48:11 +00:00
return nil
}
2015-08-06 14:48:11 +00:00
func addKey(e Engine, key *PublicKey) (err error) {
2014-03-16 10:16:03 +00:00
// Calculate fingerprint.
2014-05-07 16:09:30 +00:00
tmpPath := strings.Replace(path.Join(os.TempDir(), fmt.Sprintf("%d", time.Now().Nanosecond()),
2014-03-22 18:27:03 +00:00
"id_rsa.pub"), "\\", "/", -1)
2014-03-16 10:16:03 +00:00
os.MkdirAll(path.Dir(tmpPath), os.ModePerm)
2015-08-06 14:48:11 +00:00
if err = ioutil.WriteFile(tmpPath, []byte(key.Content), 0644); err != nil {
2014-02-17 15:57:23 +00:00
return err
}
2015-11-02 23:54:47 +00:00
stdout, stderr, err := process.Exec("AddPublicKey", "ssh-keygen", "-lf", tmpPath)
2014-02-17 15:57:23 +00:00
if err != nil {
return fmt.Errorf("'ssh-keygen -lf %s' failed with error '%s': %s", tmpPath, err, stderr)
2014-03-16 10:16:03 +00:00
} else if len(stdout) < 2 {
2014-10-12 00:34:48 +00:00
return errors.New("not enough output for calculating fingerprint: " + stdout)
2014-03-16 10:16:03 +00:00
}
key.Fingerprint = strings.Split(stdout, " ")[1]
// Save SSH key.
2015-08-06 14:48:11 +00:00
if _, err = e.Insert(key); err != nil {
2014-03-16 10:16:03 +00:00
return err
2015-08-06 14:48:11 +00:00
}
// Don't need to rewrite this file if builtin SSH server is enabled.
if setting.SSH.StartBuiltinServer {
return nil
}
2016-07-26 02:47:25 +00:00
return appendAuthorizedKeysToFile(key)
2015-08-06 14:48:11 +00:00
}
// AddPublicKey adds new public key to database and authorized_keys file.
2015-12-03 05:24:37 +00:00
func AddPublicKey(ownerID int64, name, content string) (*PublicKey, error) {
log.Trace(content)
2015-12-03 05:24:37 +00:00
if err := checkKeyContent(content); err != nil {
return nil, err
2014-02-17 15:57:23 +00:00
}
2015-08-06 14:48:11 +00:00
// Key name of same user cannot be duplicated.
2016-11-10 15:16:32 +00:00
has, err := x.
Where("owner_id = ? AND name = ?", ownerID, name).
Get(new(PublicKey))
2015-08-06 14:48:11 +00:00
if err != nil {
2015-12-03 05:24:37 +00:00
return nil, err
2015-08-06 14:48:11 +00:00
} else if has {
2015-12-03 05:24:37 +00:00
return nil, ErrKeyNameAlreadyUsed{ownerID, name}
2015-08-06 14:48:11 +00:00
}
sess := x.NewSession()
defer sessionRelease(sess)
if err = sess.Begin(); err != nil {
2015-12-03 05:24:37 +00:00
return nil, err
2015-08-06 14:48:11 +00:00
}
key := &PublicKey{
OwnerID: ownerID,
Name: name,
Content: content,
2016-11-07 16:20:37 +00:00
Mode: AccessModeWrite,
2016-11-07 16:53:22 +00:00
Type: KeyTypeUser,
2015-08-06 14:48:11 +00:00
}
if err = addKey(sess, key); err != nil {
2015-12-03 05:24:37 +00:00
return nil, fmt.Errorf("addKey: %v", err)
2015-08-06 14:48:11 +00:00
}
2015-12-03 05:24:37 +00:00
return key, sess.Commit()
2014-02-17 15:57:23 +00:00
}
2015-08-06 14:48:11 +00:00
// GetPublicKeyByID returns public key by given ID.
func GetPublicKeyByID(keyID int64) (*PublicKey, error) {
2014-08-09 22:40:10 +00:00
key := new(PublicKey)
2016-11-10 15:16:32 +00:00
has, err := x.
Id(keyID).
Get(key)
2014-08-09 22:40:10 +00:00
if err != nil {
return nil, err
} else if !has {
2015-08-06 14:48:11 +00:00
return nil, ErrKeyNotExist{keyID}
2014-08-09 22:40:10 +00:00
}
return key, nil
}
// SearchPublicKeyByContent searches content as prefix (leak e-mail part)
// and returns public key found.
func SearchPublicKeyByContent(content string) (*PublicKey, error) {
key := new(PublicKey)
2016-11-10 15:16:32 +00:00
has, err := x.
Where("content like ?", content+"%").
Get(key)
if err != nil {
return nil, err
} else if !has {
return nil, ErrKeyNotExist{}
}
return key, nil
}
2014-11-12 11:48:50 +00:00
// ListPublicKeys returns a list of public keys belongs to given user.
func ListPublicKeys(uid int64) ([]*PublicKey, error) {
2014-07-26 04:24:27 +00:00
keys := make([]*PublicKey, 0, 5)
2016-11-10 15:16:32 +00:00
return keys, x.
Where("owner_id = ?", uid).
Find(&keys)
2014-05-07 16:09:30 +00:00
}
2014-08-09 22:40:10 +00:00
// UpdatePublicKey updates given public key.
func UpdatePublicKey(key *PublicKey) error {
2015-08-06 14:48:11 +00:00
_, err := x.Id(key.ID).AllCols().Update(key)
2014-08-09 22:40:10 +00:00
return err
}
// deletePublicKeys does the actual key deletion but does not update authorized_keys file.
func deletePublicKeys(e *xorm.Session, keyIDs ...int64) error {
if len(keyIDs) == 0 {
2015-08-06 14:48:11 +00:00
return nil
2014-03-22 18:27:03 +00:00
}
2014-05-06 20:28:52 +00:00
2016-11-12 08:29:18 +00:00
_, err := e.In("id", keyIDs).Delete(new(PublicKey))
return err
2014-02-17 15:57:23 +00:00
}
2015-08-06 14:48:11 +00:00
// DeletePublicKey deletes SSH key information both in database and authorized_keys file.
2015-12-03 05:24:37 +00:00
func DeletePublicKey(doer *User, id int64) (err error) {
key, err := GetPublicKeyByID(id)
2015-08-20 09:11:29 +00:00
if err != nil {
2015-12-03 05:24:37 +00:00
if IsErrKeyNotExist(err) {
return nil
}
return fmt.Errorf("GetPublicKeyByID: %v", err)
}
// Check if user has access to delete this key.
2016-07-23 17:08:22 +00:00
if !doer.IsAdmin && doer.ID != key.OwnerID {
return ErrKeyAccessDenied{doer.ID, key.ID, "public"}
2015-08-20 09:11:29 +00:00
}
2015-08-06 14:48:11 +00:00
sess := x.NewSession()
defer sessionRelease(sess)
if err = sess.Begin(); err != nil {
return err
}
if err = deletePublicKeys(sess, id); err != nil {
2015-08-06 14:48:11 +00:00
return err
}
if err = sess.Commit(); err != nil {
return err
}
return RewriteAllPublicKeys()
2015-08-06 14:48:11 +00:00
}
2015-02-01 22:21:56 +00: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
// outsite any session scope independently.
func RewriteAllPublicKeys() error {
2015-02-01 22:21:56 +00:00
sshOpLocker.Lock()
defer sshOpLocker.Unlock()
fpath := filepath.Join(setting.SSH.RootPath, "authorized_keys")
tmpPath := fpath + ".tmp"
f, err := os.OpenFile(tmpPath, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0600)
if err != nil {
return err
}
2015-02-01 22:21:56 +00:00
defer os.Remove(tmpPath)
2015-02-01 22:21:56 +00:00
err = x.Iterate(new(PublicKey), func(idx int, bean interface{}) (err error) {
2016-07-26 02:47:25 +00:00
_, err = f.WriteString((bean.(*PublicKey)).AuthorizedString())
2015-02-01 22:21:56 +00:00
return err
})
f.Close()
if err != nil {
return err
}
2015-02-01 22:21:56 +00:00
if com.IsExist(fpath) {
if err = os.Remove(fpath); err != nil {
return err
}
}
if err = os.Rename(tmpPath, fpath); err != nil {
return err
}
2015-02-01 22:21:56 +00:00
return nil
}
2015-08-06 14:48:11 +00: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:"-"`
Created time.Time `xorm:"-"`
CreatedUnix int64
Updated time.Time `xorm:"-"` // Note: Updated must below Created for AfterSet.
UpdatedUnix int64
HasRecentActivity bool `xorm:"-"`
HasUsed bool `xorm:"-"`
}
func (k *DeployKey) BeforeInsert() {
k.CreatedUnix = time.Now().Unix()
}
func (k *DeployKey) BeforeUpdate() {
k.UpdatedUnix = time.Now().Unix()
2015-08-06 14:48:11 +00:00
}
func (k *DeployKey) AfterSet(colName string, _ xorm.Cell) {
switch colName {
case "created_unix":
k.Created = time.Unix(k.CreatedUnix, 0).Local()
case "updated_unix":
k.Updated = time.Unix(k.UpdatedUnix, 0).Local()
2015-08-06 14:48:11 +00:00
k.HasUsed = k.Updated.After(k.Created)
k.HasRecentActivity = k.Updated.Add(7 * 24 * time.Hour).After(time.Now())
}
}
2015-11-19 02:21:47 +00:00
// GetContent gets associated public key content.
func (k *DeployKey) GetContent() error {
pkey, err := GetPublicKeyByID(k.KeyID)
if err != nil {
return err
}
k.Content = pkey.Content
return nil
}
2015-08-06 14:48:11 +00: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 15:16:32 +00:00
has, err := e.
Where("key_id = ? AND repo_id = ?", keyID, repoID).
Get(new(DeployKey))
2015-08-06 14:48:11 +00:00
if err != nil {
return err
} else if has {
return ErrDeployKeyAlreadyExist{keyID, repoID}
}
2016-11-10 15:16:32 +00:00
has, err = e.
Where("repo_id = ? AND name = ?", repoID, name).
Get(new(DeployKey))
2015-08-06 14:48:11 +00:00
if err != nil {
return err
} else if has {
return ErrDeployKeyNameAlreadyUsed{repoID, name}
}
return nil
}
// addDeployKey adds new key-repo relation.
2015-11-19 02:21:47 +00:00
func addDeployKey(e *xorm.Session, keyID, repoID int64, name, fingerprint string) (*DeployKey, error) {
if err := checkDeployKey(e, keyID, repoID, name); err != nil {
return nil, err
2015-08-06 14:48:11 +00:00
}
2015-11-19 02:21:47 +00:00
key := &DeployKey{
2015-08-06 14:48:11 +00:00
KeyID: keyID,
RepoID: repoID,
Name: name,
Fingerprint: fingerprint,
2015-11-19 02:21:47 +00:00
}
_, err := e.Insert(key)
return key, err
2015-08-06 14:48:11 +00:00
}
// HasDeployKey returns true if public key is a deploy key of given repository.
func HasDeployKey(keyID, repoID int64) bool {
2016-11-10 15:16:32 +00:00
has, _ := x.
Where("key_id = ? AND repo_id = ?", keyID, repoID).
Get(new(DeployKey))
2015-08-06 14:48:11 +00:00
return has
}
// AddDeployKey add new deploy key to database and authorized_keys file.
2015-11-19 02:21:47 +00:00
func AddDeployKey(repoID int64, name, content string) (*DeployKey, error) {
if err := checkKeyContent(content); err != nil {
return nil, err
2015-08-06 14:48:11 +00:00
}
2015-11-19 02:21:47 +00:00
pkey := &PublicKey{
2015-08-06 14:48:11 +00:00
Content: content,
2016-11-07 16:20:37 +00:00
Mode: AccessModeRead,
2016-11-07 16:53:22 +00:00
Type: KeyTypeDeploy,
2015-08-06 14:48:11 +00:00
}
2015-11-19 02:21:47 +00:00
has, err := x.Get(pkey)
2015-08-06 14:48:11 +00:00
if err != nil {
2015-11-19 02:21:47 +00:00
return nil, err
2015-08-06 14:48:11 +00:00
}
sess := x.NewSession()
defer sessionRelease(sess)
if err = sess.Begin(); err != nil {
2015-11-19 02:21:47 +00:00
return nil, err
2015-08-06 14:48:11 +00:00
}
// First time use this deploy key.
if !has {
2015-11-19 02:21:47 +00:00
if err = addKey(sess, pkey); err != nil {
return nil, fmt.Errorf("addKey: %v", err)
2015-08-06 14:48:11 +00:00
}
}
2015-11-19 02:21:47 +00:00
key, err := addDeployKey(sess, pkey.ID, repoID, name, pkey.Fingerprint)
if err != nil {
return nil, fmt.Errorf("addDeployKey: %v", err)
2015-08-06 14:48:11 +00:00
}
2015-11-19 02:21:47 +00:00
return key, sess.Commit()
}
// GetDeployKeyByID returns deploy key by given ID.
func GetDeployKeyByID(id int64) (*DeployKey, error) {
key := new(DeployKey)
has, err := x.Id(id).Get(key)
if err != nil {
return nil, err
} else if !has {
return nil, ErrDeployKeyNotExist{id, 0, 0}
}
return key, nil
2015-08-06 14:48:11 +00:00
}
// GetDeployKeyByRepo returns deploy key by given public key ID and repository ID.
func GetDeployKeyByRepo(keyID, repoID int64) (*DeployKey, error) {
key := &DeployKey{
KeyID: keyID,
RepoID: repoID,
}
2015-11-19 02:21:47 +00:00
has, err := x.Get(key)
if err != nil {
return nil, err
} else if !has {
return nil, ErrDeployKeyNotExist{0, keyID, repoID}
}
return key, nil
2015-08-06 14:48:11 +00:00
}
// UpdateDeployKey updates deploy key information.
func UpdateDeployKey(key *DeployKey) error {
_, err := x.Id(key.ID).AllCols().Update(key)
return err
}
// DeleteDeployKey deletes deploy key from its repository authorized_keys file if needed.
2015-12-03 05:24:37 +00:00
func DeleteDeployKey(doer *User, id int64) error {
key, err := GetDeployKeyByID(id)
2015-08-06 14:48:11 +00:00
if err != nil {
2015-12-03 05:24:37 +00:00
if IsErrDeployKeyNotExist(err) {
return nil
}
return fmt.Errorf("GetDeployKeyByID: %v", err)
}
// Check if user has access to delete this key.
2015-12-05 22:13:13 +00:00
if !doer.IsAdmin {
repo, err := GetRepositoryByID(key.RepoID)
if err != nil {
return fmt.Errorf("GetRepositoryByID: %v", err)
}
2016-11-07 16:20:37 +00:00
yes, err := HasAccess(doer, repo, AccessModeAdmin)
2015-12-05 22:13:13 +00:00
if err != nil {
return fmt.Errorf("HasAccess: %v", err)
} else if !yes {
2016-07-23 17:08:22 +00:00
return ErrKeyAccessDenied{doer.ID, key.ID, "deploy"}
2015-12-05 22:13:13 +00:00
}
2015-08-06 14:48:11 +00:00
}
sess := x.NewSession()
defer sessionRelease(sess)
if err = sess.Begin(); err != nil {
return err
}
if _, err = sess.Id(key.ID).Delete(new(DeployKey)); err != nil {
2016-07-26 02:47:25 +00:00
return fmt.Errorf("delete deploy key [%d]: %v", key.ID, err)
2015-08-06 14:48:11 +00:00
}
// Check if this is the last reference to same key content.
2016-11-10 15:16:32 +00:00
has, err := sess.
Where("key_id = ?", key.KeyID).
Get(new(DeployKey))
2015-08-06 14:48:11 +00:00
if err != nil {
return err
} else if !has {
if err = deletePublicKeys(sess, key.KeyID); err != nil {
2015-08-06 14:48:11 +00:00
return err
}
}
return sess.Commit()
}
// ListDeployKeys returns all deploy keys by given repository ID.
func ListDeployKeys(repoID int64) ([]*DeployKey, error) {
keys := make([]*DeployKey, 0, 5)
2016-11-10 15:16:32 +00:00
return keys, x.
Where("repo_id = ?", repoID).
Find(&keys)
2015-08-06 14:48:11 +00:00
}