bench-forgejo/models/ssh_key.go

804 lines
21 KiB
Go
Raw Normal View History

2014-03-16 14:54:13 +05:30
// 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 21:27:23 +05:30
package models
import (
2014-03-16 14:54:13 +05:30
"bufio"
"encoding/base64"
"encoding/binary"
2014-03-16 15:18:20 +05:30
"errors"
2014-02-17 21:27:23 +05:30
"fmt"
2014-05-07 21:39:30 +05:30
"io"
"io/ioutil"
"math/big"
2014-02-17 21:27:23 +05:30
"os"
2014-03-16 15:46:03 +05:30
"path"
2014-02-17 21:27:23 +05:30
"path/filepath"
2014-03-16 14:54:13 +05:30
"strings"
"sync"
2014-02-17 21:27:23 +05:30
"time"
2014-03-03 01:55:09 +05:30
"github.com/Unknwon/com"
2015-08-06 20:18:11 +05:30
"github.com/go-xorm/xorm"
"golang.org/x/crypto/ssh"
2014-03-22 23:57:03 +05:30
"github.com/gogits/gogs/modules/log"
2014-06-19 10:38:03 +05:30
"github.com/gogits/gogs/modules/process"
2014-09-16 23:04:09 +05:30
"github.com/gogits/gogs/modules/setting"
2014-02-17 21:27:23 +05:30
)
const (
// "### autogenerated by gitgos, DO NOT EDIT\n"
2015-02-09 15:57:15 +05:30
_TPL_PUBLICK_KEY = `command="%s serv key-%d --config='%s'",no-port-forwarding,no-X11-forwarding,no-agent-forwarding,no-pty %s` + "\n"
)
var sshOpLocker = sync.Mutex{}
2014-02-25 13:43:47 +05:30
2015-08-06 20:18:11 +05:30
type KeyType int
const (
KEY_TYPE_USER = iota + 1
KEY_TYPE_DEPLOY
)
// PublicKey represents a SSH or deploy key.
2014-02-17 21:27:23 +05:30
type PublicKey struct {
2015-08-06 20:18:11 +05:30
ID int64 `xorm:"pk autoincr"`
OwnerID int64 `xorm:"INDEX NOT NULL"`
Name string `xorm:"NOT NULL"`
Fingerprint string `xorm:"NOT NULL"`
2015-08-06 20:25:03 +05:30
Content string `xorm:"TEXT NOT NULL"`
2015-08-06 20:18:11 +05:30
Mode AccessMode `xorm:"NOT NULL DEFAULT 2"`
Type KeyType `xorm:"NOT NULL DEFAULT 1"`
Created time.Time `xorm:"CREATED"`
Updated time.Time // Note: Updated must below Created for AfterSet.
HasRecentActivity bool `xorm:"-"`
HasUsed bool `xorm:"-"`
}
func (k *PublicKey) AfterSet(colName string, _ xorm.Cell) {
switch colName {
case "created":
k.HasUsed = k.Updated.After(k.Created)
k.HasRecentActivity = k.Updated.Add(7 * 24 * time.Hour).After(time.Now())
}
2014-02-17 21:27:23 +05:30
}
2014-11-23 13:03:47 +05:30
// OmitEmail returns content of public key but without e-mail address.
func (k *PublicKey) OmitEmail() string {
return strings.Join(strings.Split(k.Content, " ")[:2], " ")
}
2014-05-07 21:39:30 +05:30
// GetAuthorizedString generates and returns formatted public key string for authorized_keys file.
func (key *PublicKey) GetAuthorizedString() string {
return fmt.Sprintf(_TPL_PUBLICK_KEY, setting.AppPath, key.ID, setting.CustomConf, key.Content)
2014-02-17 21:27:23 +05:30
}
func extractTypeFromBase64Key(key string) (string, error) {
b, err := base64.StdEncoding.DecodeString(key)
if err != nil || len(b) < 4 {
return "", fmt.Errorf("Invalid key format: %v", err)
}
keyLength := int(binary.BigEndian.Uint32(b))
if len(b) < 4+keyLength {
return "", fmt.Errorf("Invalid key format: not enough length")
}
return string(b[4 : 4+keyLength]), nil
}
// parseKeyString parses any key string in OpenSSH or SSH2 format to clean OpenSSH string (RFC4253)
2015-08-06 20:18:11 +05:30
func parseKeyString(content string) (string, error) {
// Transform all legal line endings to a single "\n"
s := strings.Replace(strings.Replace(strings.TrimSpace(content), "\r\n", "\n", -1), "\r", "\n", -1)
lines := strings.Split(s, "\n")
var keyType, keyContent, keyComment string
if len(lines) == 1 {
// Parse openssh format
2015-09-13 02:28:18 +05:30
parts := strings.SplitN(lines[0], " ", 3)
switch len(parts) {
case 0:
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]
}
// If keyType is not given, extract it from content. If given, validate it
if len(keyType) == 0 {
if t, err := extractTypeFromBase64Key(keyContent); err == nil {
keyType = t
} else {
return "", err
}
} else {
if t, err := extractTypeFromBase64Key(keyContent); err != nil || keyType != t {
return "", err
}
}
} 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
}
}
if t, err := extractTypeFromBase64Key(keyContent); err == nil {
keyType = t
} else {
return "", 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) {
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 {
return "", fmt.Errorf("tmpFile.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 {
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 {
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()}
}
return "", 0, fmt.Errorf("ssh.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-ed25519": // TODO replace with ssh constant when available
return "ed25519", 256, nil
}
return "", 0, fmt.Errorf("Unsupported key length detection for type: %s", pkey.Type())
}
2014-07-26 09:54:27 +05:30
// CheckPublicKeyString checks if the given public key string is recognized by SSH.
//
// The function returns the actual public key line on success.
2015-08-06 20:18:11 +05:30
func CheckPublicKeyString(content string) (_ string, err error) {
if setting.SSH.Disabled {
return "", errors.New("SSH is disabled")
}
2015-08-06 20:18:11 +05:30
content, err = parseKeyString(content)
if err != nil {
return "", err
}
2014-11-19 01:43:08 +05:30
content = strings.TrimRight(content, "\n\r")
2014-07-26 09:54:27 +05:30
if strings.ContainsAny(content, "\n\r") {
2015-08-06 20:18:11 +05:30
return "", errors.New("only a single line with a single key please")
2014-07-26 09:54:27 +05:30
}
// remove any unnecessary whitespace now
content = strings.TrimSpace(content)
var (
keyType string
length int
)
if setting.SSH.StartBuiltinServer {
keyType, length, err = SSHNativeParsePublicKey(content)
} else {
keyType, length, err = SSHKeyGenParsePublicKey(content)
2014-07-26 09:54:27 +05:30
}
if err != nil {
return "", fmt.Errorf("ParsePublicKey: %v", err)
2014-07-26 09:54:27 +05:30
}
log.Trace("Key info [native: %v]: %s-%d", setting.SSH.StartBuiltinServer, keyType, length)
2014-07-26 09:54:27 +05:30
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 {
return "", fmt.Errorf("Key length is not enough: got %d, needs %d", length, minLen)
}
return "", fmt.Errorf("Key type is not allowed: %s", keyType)
2014-07-26 09:54:27 +05:30
}
2014-05-07 21:39:30 +05:30
// saveAuthorizedKeyFile writes SSH key content to authorized_keys file.
func saveAuthorizedKeyFile(keys ...*PublicKey) error {
2014-05-07 21:39:30 +05:30
sshOpLocker.Lock()
defer sshOpLocker.Unlock()
fpath := filepath.Join(setting.SSH.RootPath, "authorized_keys")
2014-05-07 21:39:30 +05:30
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-02 03:51:56 +05:30
fi, err := f.Stat()
if err != nil {
return err
}
2014-09-16 18:02:13 +05:30
// FIXME: following command does not support in Windows.
2014-09-16 23:04:09 +05:30
if !setting.IsWindows {
// .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 18:02:13 +05:30
if err = f.Chmod(0600); err != nil {
return err
}
}
}
for _, key := range keys {
2015-02-02 03:51:56 +05:30
if _, err = f.WriteString(key.GetAuthorizedString()); err != nil {
return err
}
}
return nil
2014-05-07 21:39:30 +05:30
}
// 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 20:18:11 +05:30
func checkKeyContent(content string) error {
has, err := x.Get(&PublicKey{
Content: content,
Type: KEY_TYPE_USER,
})
if err != nil {
return err
} else if has {
2015-08-06 20:18:11 +05:30
return ErrKeyAlreadyExist{0, content}
}
2015-08-06 20:18:11 +05:30
return nil
}
2015-08-06 20:18:11 +05:30
func addKey(e Engine, key *PublicKey) (err error) {
2014-03-16 15:46:03 +05:30
// Calculate fingerprint.
2014-05-07 21:39:30 +05:30
tmpPath := strings.Replace(path.Join(os.TempDir(), fmt.Sprintf("%d", time.Now().Nanosecond()),
2014-03-22 23:57:03 +05:30
"id_rsa.pub"), "\\", "/", -1)
2014-03-16 15:46:03 +05:30
os.MkdirAll(path.Dir(tmpPath), os.ModePerm)
2015-08-06 20:18:11 +05:30
if err = ioutil.WriteFile(tmpPath, []byte(key.Content), 0644); err != nil {
2014-02-17 21:27:23 +05:30
return err
}
2015-11-03 05:24:47 +05:30
stdout, stderr, err := process.Exec("AddPublicKey", "ssh-keygen", "-lf", tmpPath)
2014-02-17 21:27:23 +05:30
if err != nil {
return fmt.Errorf("'ssh-keygen -lf %s' failed with error '%s': %s", tmpPath, err, stderr)
2014-03-16 15:46:03 +05:30
} else if len(stdout) < 2 {
2014-10-12 06:04:48 +05:30
return errors.New("not enough output for calculating fingerprint: " + stdout)
2014-03-16 15:46:03 +05:30
}
key.Fingerprint = strings.Split(stdout, " ")[1]
// Save SSH key.
2015-08-06 20:18:11 +05:30
if _, err = e.Insert(key); err != nil {
2014-03-16 15:46:03 +05:30
return err
2015-08-06 20:18:11 +05:30
}
// Don't need to rewrite this file if builtin SSH server is enabled.
if setting.SSH.StartBuiltinServer {
return nil
}
2015-08-06 20:18:11 +05:30
return saveAuthorizedKeyFile(key)
}
// AddPublicKey adds new public key to database and authorized_keys file.
2015-12-03 10:54:37 +05:30
func AddPublicKey(ownerID int64, name, content string) (*PublicKey, error) {
log.Trace(content)
2015-12-03 10:54:37 +05:30
if err := checkKeyContent(content); err != nil {
return nil, err
2014-02-17 21:27:23 +05:30
}
2015-08-06 20:18:11 +05:30
// Key name of same user cannot be duplicated.
has, err := x.Where("owner_id=? AND name=?", ownerID, name).Get(new(PublicKey))
if err != nil {
2015-12-03 10:54:37 +05:30
return nil, err
2015-08-06 20:18:11 +05:30
} else if has {
2015-12-03 10:54:37 +05:30
return nil, ErrKeyNameAlreadyUsed{ownerID, name}
2015-08-06 20:18:11 +05:30
}
sess := x.NewSession()
defer sessionRelease(sess)
if err = sess.Begin(); err != nil {
2015-12-03 10:54:37 +05:30
return nil, err
2015-08-06 20:18:11 +05:30
}
key := &PublicKey{
OwnerID: ownerID,
Name: name,
Content: content,
Mode: ACCESS_MODE_WRITE,
Type: KEY_TYPE_USER,
}
if err = addKey(sess, key); err != nil {
2015-12-03 10:54:37 +05:30
return nil, fmt.Errorf("addKey: %v", err)
2015-08-06 20:18:11 +05:30
}
2015-12-03 10:54:37 +05:30
return key, sess.Commit()
2014-02-17 21:27:23 +05:30
}
2015-08-06 20:18:11 +05:30
// GetPublicKeyByID returns public key by given ID.
func GetPublicKeyByID(keyID int64) (*PublicKey, error) {
2014-08-10 04:10:10 +05:30
key := new(PublicKey)
2015-08-06 20:18:11 +05:30
has, err := x.Id(keyID).Get(key)
2014-08-10 04:10:10 +05:30
if err != nil {
return nil, err
} else if !has {
2015-08-06 20:18:11 +05:30
return nil, ErrKeyNotExist{keyID}
2014-08-10 04:10:10 +05:30
}
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)
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 17:18:50 +05:30
// ListPublicKeys returns a list of public keys belongs to given user.
func ListPublicKeys(uid int64) ([]*PublicKey, error) {
2014-07-26 09:54:27 +05:30
keys := make([]*PublicKey, 0, 5)
2015-08-06 20:18:11 +05:30
return keys, x.Where("owner_id=?", uid).Find(&keys)
2014-05-07 21:39:30 +05:30
}
2014-05-07 01:58:52 +05:30
// rewriteAuthorizedKeys finds and deletes corresponding line in authorized_keys file.
2014-03-22 23:57:03 +05:30
func rewriteAuthorizedKeys(key *PublicKey, p, tmpP string) error {
2014-03-16 14:54:13 +05:30
fr, err := os.Open(p)
if err != nil {
return err
}
defer fr.Close()
2014-06-24 14:23:42 +05:30
fw, err := os.OpenFile(tmpP, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0600)
2014-03-16 14:54:13 +05:30
if err != nil {
return err
}
defer fw.Close()
2014-05-07 01:58:52 +05:30
isFound := false
2015-08-06 20:18:11 +05:30
keyword := fmt.Sprintf("key-%d", key.ID)
2014-05-07 21:39:30 +05:30
buf := bufio.NewReader(fr)
for {
line, errRead := buf.ReadString('\n')
line = strings.TrimSpace(line)
if errRead != nil {
if errRead != io.EOF {
return errRead
}
// Reached end of file, if nothing to read then break,
// otherwise handle the last line.
if len(line) == 0 {
break
}
2014-03-16 14:54:13 +05:30
}
// Found the line and copy rest of file.
2014-05-07 21:39:30 +05:30
if !isFound && strings.Contains(line, keyword) && strings.Contains(line, key.Content) {
2014-05-07 01:58:52 +05:30
isFound = true
2014-03-16 15:18:20 +05:30
continue
2014-03-16 14:54:13 +05:30
}
// Still finding the line, copy the line that currently read.
2014-05-07 21:39:30 +05:30
if _, err = fw.WriteString(line + "\n"); err != nil {
2014-03-16 14:54:13 +05:30
return err
}
2014-05-07 01:58:52 +05:30
2014-05-07 21:39:30 +05:30
if errRead == io.EOF {
break
}
}
if !isFound {
log.Warn("SSH key %d not found in authorized_keys file for deletion", key.ID)
}
2014-03-22 23:57:03 +05:30
return nil
}
2014-03-16 14:54:13 +05:30
2014-08-10 04:10:10 +05:30
// UpdatePublicKey updates given public key.
func UpdatePublicKey(key *PublicKey) error {
2015-08-06 20:18:11 +05:30
_, err := x.Id(key.ID).AllCols().Update(key)
2014-08-10 04:10:10 +05:30
return err
}
func deletePublicKey(e *xorm.Session, keyID int64) error {
2015-08-13 03:30:43 +05:30
sshOpLocker.Lock()
defer sshOpLocker.Unlock()
key := &PublicKey{ID: keyID}
2015-08-06 20:18:11 +05:30
has, err := e.Get(key)
2014-03-22 23:57:03 +05:30
if err != nil {
return err
} else if !has {
2015-08-06 20:18:11 +05:30
return nil
2014-03-22 23:57:03 +05:30
}
2014-05-07 01:58:52 +05:30
if _, err = e.Id(key.ID).Delete(new(PublicKey)); err != nil {
2014-03-22 23:57:03 +05:30
return err
}
// Don't need to rewrite this file if builtin SSH server is enabled.
if setting.SSH.StartBuiltinServer {
return nil
}
fpath := filepath.Join(setting.SSH.RootPath, "authorized_keys")
tmpPath := fpath + ".tmp"
2014-05-07 21:39:30 +05:30
if err = rewriteAuthorizedKeys(key, fpath, tmpPath); err != nil {
2014-03-22 23:57:03 +05:30
return err
2014-05-07 21:39:30 +05:30
} else if err = os.Remove(fpath); err != nil {
2014-03-16 14:54:13 +05:30
return err
}
2014-05-07 21:39:30 +05:30
return os.Rename(tmpPath, fpath)
2014-02-17 21:27:23 +05:30
}
2015-08-06 20:18:11 +05:30
// DeletePublicKey deletes SSH key information both in database and authorized_keys file.
2015-12-03 10:54:37 +05:30
func DeletePublicKey(doer *User, id int64) (err error) {
key, err := GetPublicKeyByID(id)
2015-08-20 14:41:29 +05:30
if err != nil {
2015-12-03 10:54:37 +05:30
if IsErrKeyNotExist(err) {
return nil
}
return fmt.Errorf("GetPublicKeyByID: %v", err)
}
// Check if user has access to delete this key.
2015-12-06 03:43:13 +05:30
if !doer.IsAdmin && doer.Id != key.OwnerID {
2015-12-03 10:54:37 +05:30
return ErrKeyAccessDenied{doer.Id, key.ID, "public"}
2015-08-20 14:41:29 +05:30
}
2015-08-06 20:18:11 +05:30
sess := x.NewSession()
defer sessionRelease(sess)
if err = sess.Begin(); err != nil {
return err
}
if err = deletePublicKey(sess, id); err != nil {
2015-08-06 20:18:11 +05:30
return err
}
return sess.Commit()
}
2015-02-02 03:51:56 +05:30
// RewriteAllPublicKeys removes any authorized key and rewrite all keys from database again.
func RewriteAllPublicKeys() error {
2015-02-02 03:51:56 +05:30
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-02 03:51:56 +05:30
defer os.Remove(tmpPath)
2015-02-02 03:51:56 +05:30
err = x.Iterate(new(PublicKey), func(idx int, bean interface{}) (err error) {
_, err = f.WriteString((bean.(*PublicKey)).GetAuthorizedString())
return err
})
f.Close()
if err != nil {
return err
}
2015-02-02 03:51:56 +05:30
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-02 03:51:56 +05:30
return nil
}
2015-08-06 20:18:11 +05:30
// ________ .__ ____ __.
// \______ \ ____ ______ | | ____ ___.__.| |/ _|____ ___.__.
// | | \_/ __ \\____ \| | / _ < | || <_/ __ < | |
// | ` \ ___/| |_> > |_( <_> )___ || | \ ___/\___ |
// /_______ /\___ > __/|____/\____// ____||____|__ \___ > ____|
// \/ \/|__| \/ \/ \/\/
// 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
2015-11-19 07:51:47 +05:30
Content string `xorm:"-"`
2015-08-06 20:18:11 +05:30
Created time.Time `xorm:"CREATED"`
Updated time.Time // Note: Updated must below Created for AfterSet.
HasRecentActivity bool `xorm:"-"`
HasUsed bool `xorm:"-"`
}
func (k *DeployKey) AfterSet(colName string, _ xorm.Cell) {
switch colName {
case "created":
k.HasUsed = k.Updated.After(k.Created)
k.HasRecentActivity = k.Updated.Add(7 * 24 * time.Hour).After(time.Now())
}
}
2015-11-19 07:51:47 +05:30
// 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 20:18:11 +05:30
func checkDeployKey(e Engine, keyID, repoID int64, name string) error {
// Note: We want error detail, not just true or false here.
has, err := e.Where("key_id=? AND repo_id=?", keyID, repoID).Get(new(DeployKey))
if err != nil {
return err
} else if has {
return ErrDeployKeyAlreadyExist{keyID, repoID}
}
has, err = e.Where("repo_id=? AND name=?", repoID, name).Get(new(DeployKey))
if err != nil {
return err
} else if has {
return ErrDeployKeyNameAlreadyUsed{repoID, name}
}
return nil
}
// addDeployKey adds new key-repo relation.
2015-11-19 07:51:47 +05:30
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 20:18:11 +05:30
}
2015-11-19 07:51:47 +05:30
key := &DeployKey{
2015-08-06 20:18:11 +05:30
KeyID: keyID,
RepoID: repoID,
Name: name,
Fingerprint: fingerprint,
2015-11-19 07:51:47 +05:30
}
_, err := e.Insert(key)
return key, err
2015-08-06 20:18:11 +05:30
}
// HasDeployKey returns true if public key is a deploy key of given repository.
func HasDeployKey(keyID, repoID int64) bool {
has, _ := x.Where("key_id=? AND repo_id=?", keyID, repoID).Get(new(DeployKey))
return has
}
// AddDeployKey add new deploy key to database and authorized_keys file.
2015-11-19 07:51:47 +05:30
func AddDeployKey(repoID int64, name, content string) (*DeployKey, error) {
if err := checkKeyContent(content); err != nil {
return nil, err
2015-08-06 20:18:11 +05:30
}
2015-11-19 07:51:47 +05:30
pkey := &PublicKey{
2015-08-06 20:18:11 +05:30
Content: content,
Mode: ACCESS_MODE_READ,
Type: KEY_TYPE_DEPLOY,
}
2015-11-19 07:51:47 +05:30
has, err := x.Get(pkey)
2015-08-06 20:18:11 +05:30
if err != nil {
2015-11-19 07:51:47 +05:30
return nil, err
2015-08-06 20:18:11 +05:30
}
sess := x.NewSession()
defer sessionRelease(sess)
if err = sess.Begin(); err != nil {
2015-11-19 07:51:47 +05:30
return nil, err
2015-08-06 20:18:11 +05:30
}
// First time use this deploy key.
if !has {
2015-11-19 07:51:47 +05:30
if err = addKey(sess, pkey); err != nil {
return nil, fmt.Errorf("addKey: %v", err)
2015-08-06 20:18:11 +05:30
}
}
2015-11-19 07:51:47 +05:30
key, err := addDeployKey(sess, pkey.ID, repoID, name, pkey.Fingerprint)
if err != nil {
return nil, fmt.Errorf("addDeployKey: %v", err)
2015-08-06 20:18:11 +05:30
}
2015-11-19 07:51:47 +05:30
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 20:18:11 +05:30
}
// 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 07:51:47 +05:30
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 20:18:11 +05:30
}
// 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 10:54:37 +05:30
func DeleteDeployKey(doer *User, id int64) error {
key, err := GetDeployKeyByID(id)
2015-08-06 20:18:11 +05:30
if err != nil {
2015-12-03 10:54:37 +05:30
if IsErrDeployKeyNotExist(err) {
return nil
}
return fmt.Errorf("GetDeployKeyByID: %v", err)
}
// Check if user has access to delete this key.
2015-12-06 03:43:13 +05:30
if !doer.IsAdmin {
repo, err := GetRepositoryByID(key.RepoID)
if err != nil {
return fmt.Errorf("GetRepositoryByID: %v", err)
}
yes, err := HasAccess(doer, repo, ACCESS_MODE_ADMIN)
if err != nil {
return fmt.Errorf("HasAccess: %v", err)
} else if !yes {
return ErrKeyAccessDenied{doer.Id, key.ID, "deploy"}
}
2015-08-06 20:18:11 +05:30
}
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 {
2015-08-06 20:18:11 +05:30
return fmt.Errorf("delete deploy key[%d]: %v", key.ID, err)
}
// Check if this is the last reference to same key content.
2015-12-03 10:54:37 +05:30
has, err := sess.Where("key_id=?", key.KeyID).Get(new(DeployKey))
2015-08-06 20:18:11 +05:30
if err != nil {
return err
} else if !has {
if err = deletePublicKey(sess, key.KeyID); err != nil {
2015-08-06 20:18:11 +05:30
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)
return keys, x.Where("repo_id=?", repoID).Find(&keys)
}