This repository has been archived on 2023-02-01. You can view files and clone it, but cannot push or open issues or pull requests.
gitea/models/publickey.go

464 lines
12 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 (
2014-03-16 09:24:13 +00:00
"bufio"
"encoding/base64"
"encoding/binary"
2014-03-16 09:48:20 +00:00
"errors"
2014-02-17 15:57:23 +00:00
"fmt"
2014-05-07 16:09:30 +00:00
"io"
"io/ioutil"
2014-02-17 15:57:23 +00:00
"os"
2014-05-07 21:04:32 +00:00
"os/exec"
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"
2014-03-22 18:27:03 +00:00
"github.com/gogits/gogs/modules/log"
2014-06-19 05:08:03 +00:00
"github.com/gogits/gogs/modules/process"
2014-09-16 17:34:09 +00:00
"github.com/gogits/gogs/modules/setting"
2014-02-17 15:57:23 +00:00
)
const (
// "### autogenerated by gitgos, DO NOT EDIT\n"
2014-05-07 16:09:30 +00:00
_TPL_PUBLICK_KEY = `command="%s serv key-%d",no-port-forwarding,no-X11-forwarding,no-agent-forwarding,no-pty %s` + "\n"
)
2014-02-17 15:57:23 +00:00
var (
2015-02-01 22:21:56 +00:00
ErrKeyAlreadyExist = errors.New("Public key already exists")
2014-05-06 20:28:52 +00:00
ErrKeyNotExist = errors.New("Public key does not exist")
2014-10-12 01:04:42 +00:00
ErrKeyUnableVerify = errors.New("Unable to verify public key")
2014-03-20 20:04:56 +00:00
)
2014-03-20 20:04:56 +00:00
var sshOpLocker = sync.Mutex{}
var (
2015-02-01 22:21:56 +00:00
SSHPath string // SSH directory.
2014-05-06 20:28:52 +00:00
appPath string // Execution(binary) path.
2014-02-17 15:57:23 +00:00
)
2014-05-07 21:04:32 +00:00
// exePath returns the executable path.
func exePath() (string, error) {
file, err := exec.LookPath(os.Args[0])
if err != nil {
return "", err
}
return filepath.Abs(file)
}
// homeDir returns the home directory of current user.
2014-02-25 10:58:55 +00:00
func homeDir() string {
2014-03-02 20:25:09 +00:00
home, err := com.HomeDir()
2014-02-25 10:58:55 +00:00
if err != nil {
2014-07-26 04:24:27 +00:00
log.Fatal(4, "Fail to get home directory: %v", err)
2014-02-25 10:58:55 +00:00
}
2014-03-02 20:25:09 +00:00
return home
2014-02-25 10:58:55 +00:00
}
2014-02-25 08:13:47 +00:00
func init() {
var err error
2014-05-07 21:04:32 +00:00
if appPath, err = exePath(); err != nil {
2014-07-26 04:24:27 +00:00
log.Fatal(4, "fail to get app path: %v\n", err)
2014-02-25 08:13:47 +00:00
}
2014-07-26 04:24:27 +00:00
appPath = strings.Replace(appPath, "\\", "/", -1)
2014-02-25 10:58:55 +00:00
// Determine and create .ssh path.
2015-02-01 22:21:56 +00:00
SSHPath = filepath.Join(homeDir(), ".ssh")
if err = os.MkdirAll(SSHPath, 0700); err != nil {
log.Fatal(4, "fail to create '%s': %v", SSHPath, err)
}
2014-02-25 08:13:47 +00:00
}
2014-05-07 16:09:30 +00:00
// PublicKey represents a SSH key.
2014-02-17 15:57:23 +00:00
type PublicKey struct {
2014-07-26 04:24:27 +00:00
Id int64
2014-10-28 02:36:47 +00:00
OwnerId int64 `xorm:"UNIQUE(s) INDEX NOT NULL"`
Name string `xorm:"UNIQUE(s) NOT NULL"`
2014-11-17 21:29:23 +00:00
Fingerprint string `xorm:"INDEX NOT NULL"`
2014-07-26 04:24:27 +00:00
Content string `xorm:"TEXT NOT NULL"`
Created time.Time `xorm:"CREATED"`
Updated time.Time
HasRecentActivity bool `xorm:"-"`
HasUsed bool `xorm:"-"`
2014-02-17 15:57:23 +00:00
}
2014-11-23 07:33:47 +00:00
// 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 16:09:30 +00:00
// GetAuthorizedString generates and returns formatted public key string for authorized_keys file.
func (key *PublicKey) GetAuthorizedString() string {
return fmt.Sprintf(_TPL_PUBLICK_KEY, appPath, key.Id, key.Content)
2014-02-17 15:57:23 +00:00
}
2014-07-26 04:24:27 +00:00
var (
MinimumKeySize = map[string]int{
"(ED25519)": 256,
"(ECDSA)": 256,
"(NTRU)": 1087,
"(MCE)": 1702,
"(McE)": 1702,
"(RSA)": 2048,
2014-09-29 04:37:34 +00:00
"(DSA)": 1024,
2014-07-26 04:24:27 +00:00
}
)
func extractTypeFromBase64Key(key string) (string, error) {
b, err := base64.StdEncoding.DecodeString(key)
if err != nil || len(b) < 4 {
return "", errors.New("Invalid key format")
}
keyLength := int(binary.BigEndian.Uint32(b))
if len(b) < 4+keyLength {
return "", errors.New("Invalid key format")
}
return string(b[4 : 4+keyLength]), nil
}
// Parse any key string in openssh or ssh2 format to clean openssh string (rfc4253)
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
parts := strings.Fields(lines[0])
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
}
2014-07-26 04:24:27 +00:00
// CheckPublicKeyString checks if the given public key string is recognized by SSH.
func CheckPublicKeyString(content string) (bool, error) {
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") {
2014-10-12 00:34:48 +00:00
return false, errors.New("only a single line with a single key please")
2014-07-26 04:24:27 +00:00
}
// write the key to a file…
tmpFile, err := ioutil.TempFile(os.TempDir(), "keytest")
if err != nil {
return false, err
}
tmpPath := tmpFile.Name()
defer os.Remove(tmpPath)
tmpFile.WriteString(content)
tmpFile.Close()
2014-09-16 17:34:09 +00:00
// Check if ssh-keygen recognizes its contents.
2014-07-26 04:24:27 +00:00
stdout, stderr, err := process.Exec("CheckPublicKeyString", "ssh-keygen", "-l", "-f", tmpPath)
if err != nil {
return false, errors.New("ssh-keygen -l -f: " + stderr)
} else if len(stdout) < 2 {
2014-10-12 00:06:35 +00:00
return false, errors.New("ssh-keygen returned not enough output to evaluate the key: " + stdout)
2014-07-26 04:24:27 +00:00
}
2014-09-16 17:34:09 +00:00
// The ssh-keygen in Windows does not print key type, so no need go further.
if setting.IsWindows {
return true, nil
}
2014-10-12 01:04:42 +00:00
fmt.Println(stdout)
2014-07-26 04:24:27 +00:00
sshKeygenOutput := strings.Split(stdout, " ")
if len(sshKeygenOutput) < 4 {
2014-10-12 01:04:42 +00:00
return false, ErrKeyUnableVerify
2014-07-26 04:24:27 +00:00
}
2014-09-16 17:34:09 +00:00
// Check if key type and key size match.
2014-10-12 00:34:48 +00:00
keySize := com.StrTo(sshKeygenOutput[0]).MustInt()
if keySize == 0 {
return false, errors.New("cannot get key size of the given key")
2014-07-26 04:24:27 +00:00
}
keyType := strings.TrimSpace(sshKeygenOutput[len(sshKeygenOutput)-1])
if minimumKeySize := MinimumKeySize[keyType]; minimumKeySize == 0 {
2014-10-12 00:34:48 +00:00
return false, errors.New("sorry, unrecognized public key type")
2014-07-26 04:24:27 +00:00
} else if keySize < minimumKeySize {
2014-10-12 00:34:48 +00:00
return false, fmt.Errorf("the minimum accepted size of a public key %s is %d", keyType, minimumKeySize)
2014-07-26 04:24:27 +00:00
}
return true, nil
}
2014-05-07 16:09:30 +00:00
// saveAuthorizedKeyFile writes SSH key content to authorized_keys file.
func saveAuthorizedKeyFile(keys ...*PublicKey) error {
2014-05-07 16:09:30 +00:00
sshOpLocker.Lock()
defer sshOpLocker.Unlock()
2015-02-01 22:21:56 +00:00
fpath := filepath.Join(SSHPath, "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
finfo, err := f.Stat()
if err != nil {
return err
}
2014-09-16 12:32:13 +00:00
// FIXME: following command does not support in Windows.
2014-09-16 17:34:09 +00:00
if !setting.IsWindows {
2014-09-16 12:32:13 +00:00
if finfo.Mode().Perm() > 0600 {
log.Error(4, "authorized_keys file has unusual permission flags: %s - setting to -rw-------", finfo.Mode().Perm().String())
if err = f.Chmod(0600); err != nil {
return err
}
}
}
for _, key := range keys {
2015-02-01 22:21:56 +00:00
if _, err = f.WriteString(key.GetAuthorizedString()); err != nil {
return err
}
}
return nil
2014-05-07 16:09:30 +00:00
}
// AddPublicKey adds new public key to database and authorized_keys file.
2014-03-16 10:16:03 +00:00
func AddPublicKey(key *PublicKey) (err error) {
2014-06-21 04:51:41 +00:00
has, err := x.Get(key)
if err != nil {
return err
} else if has {
return ErrKeyAlreadyExist
}
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)
if err = ioutil.WriteFile(tmpPath, []byte(key.Content), os.ModePerm); err != nil {
2014-02-17 15:57:23 +00:00
return err
}
2014-06-19 05:08:03 +00:00
stdout, stderr, err := process.Exec("AddPublicKey", "ssh-keygen", "-l", "-f", tmpPath)
2014-02-17 15:57:23 +00:00
if err != nil {
2014-04-27 21:01:39 +00:00
return errors.New("ssh-keygen -l -f: " + 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]
2014-10-28 02:36:47 +00:00
if has, err := x.Get(&PublicKey{Fingerprint: key.Fingerprint}); err == nil && has {
return ErrKeyAlreadyExist
}
2014-03-16 10:16:03 +00:00
// Save SSH key.
2014-06-21 04:51:41 +00:00
if _, err = x.Insert(key); err != nil {
2014-03-16 10:16:03 +00:00
return err
2014-05-07 16:09:30 +00:00
} else if err = saveAuthorizedKeyFile(key); err != nil {
// Roll back.
2014-06-21 04:51:41 +00:00
if _, err2 := x.Delete(key); err2 != nil {
2014-03-16 10:16:03 +00:00
return err2
2014-02-17 15:57:23 +00:00
}
return err
}
return nil
}
2014-08-09 22:40:10 +00:00
// GetPublicKeyById returns public key by given ID.
func GetPublicKeyById(keyId int64) (*PublicKey, error) {
key := new(PublicKey)
has, err := x.Id(keyId).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)
2014-11-12 11:48:50 +00:00
err := x.Where("owner_id=?", uid).Find(&keys)
2014-07-26 04:24:27 +00:00
if err != nil {
return nil, err
}
for _, key := range keys {
key.HasUsed = key.Updated.After(key.Created)
key.HasRecentActivity = key.Updated.Add(7 * 24 * time.Hour).After(time.Now())
}
return keys, nil
2014-05-07 16:09:30 +00:00
}
2014-05-06 20:28:52 +00:00
// rewriteAuthorizedKeys finds and deletes corresponding line in authorized_keys file.
2014-03-22 18:27:03 +00:00
func rewriteAuthorizedKeys(key *PublicKey, p, tmpP string) error {
2014-03-16 09:24:13 +00:00
sshOpLocker.Lock()
defer sshOpLocker.Unlock()
fr, err := os.Open(p)
if err != nil {
return err
}
defer fr.Close()
2014-06-24 08:53:42 +00:00
fw, err := os.OpenFile(tmpP, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0600)
2014-03-16 09:24:13 +00:00
if err != nil {
return err
}
defer fw.Close()
2014-05-06 20:28:52 +00:00
isFound := false
2014-05-07 16:09:30 +00:00
keyword := fmt.Sprintf("key-%d", key.Id)
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 09:24:13 +00:00
}
// Found the line and copy rest of file.
2014-05-07 16:09:30 +00:00
if !isFound && strings.Contains(line, keyword) && strings.Contains(line, key.Content) {
2014-05-06 20:28:52 +00:00
isFound = true
2014-03-16 09:48:20 +00:00
continue
2014-03-16 09:24:13 +00:00
}
// Still finding the line, copy the line that currently read.
2014-05-07 16:09:30 +00:00
if _, err = fw.WriteString(line + "\n"); err != nil {
2014-03-16 09:24:13 +00:00
return err
}
2014-05-06 20:28:52 +00:00
2014-05-07 16:09:30 +00:00
if errRead == io.EOF {
break
}
}
2014-03-22 18:27:03 +00:00
return nil
}
2014-03-16 09:24:13 +00:00
2014-08-09 22:40:10 +00:00
// UpdatePublicKey updates given public key.
func UpdatePublicKey(key *PublicKey) error {
_, err := x.Id(key.Id).AllCols().Update(key)
return err
}
2014-03-22 18:27:03 +00:00
// DeletePublicKey deletes SSH key information both in database and authorized_keys file.
2014-05-06 20:28:52 +00:00
func DeletePublicKey(key *PublicKey) error {
2014-06-21 04:51:41 +00:00
has, err := x.Get(key)
2014-03-22 18:27:03 +00:00
if err != nil {
return err
} else if !has {
2014-05-06 20:28:52 +00:00
return ErrKeyNotExist
2014-03-22 18:27:03 +00:00
}
2014-05-06 20:28:52 +00:00
2014-06-21 04:51:41 +00:00
if _, err = x.Delete(key); err != nil {
2014-03-22 18:27:03 +00:00
return err
}
2015-02-01 22:21:56 +00:00
fpath := filepath.Join(SSHPath, "authorized_keys")
tmpPath := filepath.Join(SSHPath, "authorized_keys.tmp")
2014-05-07 16:09:30 +00:00
if err = rewriteAuthorizedKeys(key, fpath, tmpPath); err != nil {
2014-03-22 18:27:03 +00:00
return err
2014-05-07 16:09:30 +00:00
} else if err = os.Remove(fpath); err != nil {
2014-03-16 09:24:13 +00:00
return err
}
2014-05-07 16:09:30 +00:00
return os.Rename(tmpPath, fpath)
2014-02-17 15:57:23 +00:00
}
2015-02-01 22:21:56 +00:00
// RewriteAllPublicKeys removes any authorized key and rewrite all keys from database again.
func RewriteAllPublicKeys() error {
2015-02-01 22:21:56 +00:00
sshOpLocker.Lock()
defer sshOpLocker.Unlock()
tmpPath := filepath.Join(SSHPath, "authorized_keys.tmp")
f, err := os.Create(tmpPath)
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) {
_, err = f.WriteString((bean.(*PublicKey)).GetAuthorizedString())
return err
})
f.Close()
if err != nil {
return err
}
2015-02-01 22:21:56 +00:00
fpath := filepath.Join(SSHPath, "authorized_keys")
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
}