forgejo/models/publickey.go

230 lines
5.4 KiB
Go
Raw Normal View History

2014-03-16 10:24:13 +01: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 16:57:23 +01:00
package models
import (
2014-03-16 10:24:13 +01:00
"bufio"
2014-03-16 10:48:20 +01:00
"errors"
2014-02-17 16:57:23 +01:00
"fmt"
2014-05-07 18:09:30 +02:00
"io"
"io/ioutil"
2014-02-17 16:57:23 +01:00
"os"
2014-05-07 23:04:32 +02:00
"os/exec"
2014-03-16 11:16:03 +01:00
"path"
2014-02-17 16:57:23 +01:00
"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
"github.com/Unknwon/com"
2014-05-06 22:28:52 +02:00
qlog "github.com/qiniu/log"
2014-03-22 19:27:03 +01:00
"github.com/gogits/gogs/modules/log"
2014-02-17 16:57:23 +01:00
)
const (
// "### autogenerated by gitgos, DO NOT EDIT\n"
2014-05-07 18:09:30 +02: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 16:57:23 +01:00
var (
2014-03-20 21:04:56 +01:00
ErrKeyAlreadyExist = errors.New("Public key already exist")
2014-05-06 22:28:52 +02:00
ErrKeyNotExist = errors.New("Public key does not exist")
2014-03-20 21:04:56 +01:00
)
2014-03-20 21:04:56 +01:00
var sshOpLocker = sync.Mutex{}
var (
2014-06-11 01:11:53 +02:00
SshPath string // SSH directory.
2014-05-06 22:28:52 +02:00
appPath string // Execution(binary) path.
2014-02-17 16:57:23 +01:00
)
2014-05-07 23:04:32 +02: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 11:58:55 +01:00
func homeDir() string {
2014-03-02 21:25:09 +01:00
home, err := com.HomeDir()
2014-02-25 11:58:55 +01:00
if err != nil {
2014-05-06 22:28:52 +02:00
qlog.Fatalln(err)
2014-02-25 11:58:55 +01:00
}
2014-03-02 21:25:09 +01:00
return home
2014-02-25 11:58:55 +01:00
}
2014-02-25 09:13:47 +01:00
func init() {
var err error
2014-05-07 23:04:32 +02:00
if appPath, err = exePath(); err != nil {
2014-05-06 22:28:52 +02:00
qlog.Fatalf("publickey.init(fail to get app path): %v\n", err)
2014-02-25 09:13:47 +01:00
}
2014-02-25 11:58:55 +01:00
// Determine and create .ssh path.
2014-06-11 01:11:53 +02:00
SshPath = filepath.Join(homeDir(), ".ssh")
if err = os.MkdirAll(SshPath, os.ModePerm); err != nil {
qlog.Fatalf("publickey.init(fail to create SshPath(%s)): %v\n", SshPath, err)
}
2014-02-25 09:13:47 +01:00
}
2014-05-07 18:09:30 +02:00
// PublicKey represents a SSH key.
2014-02-17 16:57:23 +01:00
type PublicKey struct {
2014-03-16 11:16:03 +01:00
Id int64
2014-04-27 23:01:39 +02:00
OwnerId int64 `xorm:"UNIQUE(s) INDEX NOT NULL"`
Name string `xorm:"UNIQUE(s) NOT NULL"`
2014-03-16 11:16:03 +01:00
Fingerprint string
2014-04-27 23:01:39 +02:00
Content string `xorm:"TEXT NOT NULL"`
Created time.Time `xorm:"CREATED"`
Updated time.Time `xorm:"UPDATED"`
2014-02-17 16:57:23 +01:00
}
2014-05-07 18:09:30 +02: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 16:57:23 +01:00
}
2014-05-07 18:09:30 +02:00
// saveAuthorizedKeyFile writes SSH key content to authorized_keys file.
func saveAuthorizedKeyFile(key *PublicKey) error {
sshOpLocker.Lock()
defer sshOpLocker.Unlock()
2014-06-11 01:11:53 +02:00
fpath := filepath.Join(SshPath, "authorized_keys")
2014-05-07 18:09:30 +02:00
f, err := os.OpenFile(fpath, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0600)
if err != nil {
return err
}
defer f.Close()
_, err = f.WriteString(key.GetAuthorizedString())
return err
}
// AddPublicKey adds new public key to database and authorized_keys file.
2014-03-16 11:16:03 +01:00
func AddPublicKey(key *PublicKey) (err error) {
has, err := orm.Get(key)
if err != nil {
return err
} else if has {
return ErrKeyAlreadyExist
}
2014-03-16 11:16:03 +01:00
// Calculate fingerprint.
2014-05-07 18:09:30 +02:00
tmpPath := strings.Replace(path.Join(os.TempDir(), fmt.Sprintf("%d", time.Now().Nanosecond()),
2014-03-22 19:27:03 +01:00
"id_rsa.pub"), "\\", "/", -1)
2014-03-16 11:16:03 +01:00
os.MkdirAll(path.Dir(tmpPath), os.ModePerm)
if err = ioutil.WriteFile(tmpPath, []byte(key.Content), os.ModePerm); err != nil {
2014-02-17 16:57:23 +01:00
return err
}
2014-04-27 23:01:39 +02:00
stdout, stderr, err := com.ExecCmd("ssh-keygen", "-l", "-f", tmpPath)
2014-02-17 16:57:23 +01:00
if err != nil {
2014-04-27 23:01:39 +02:00
return errors.New("ssh-keygen -l -f: " + stderr)
2014-03-16 11:16:03 +01:00
} else if len(stdout) < 2 {
return errors.New("Not enough output for calculating fingerprint")
}
key.Fingerprint = strings.Split(stdout, " ")[1]
// Save SSH key.
if _, err = orm.Insert(key); err != nil {
return err
2014-05-07 18:09:30 +02:00
} else if err = saveAuthorizedKeyFile(key); err != nil {
// Roll back.
2014-03-16 11:16:03 +01:00
if _, err2 := orm.Delete(key); err2 != nil {
return err2
2014-02-17 16:57:23 +01:00
}
return err
}
return nil
}
2014-05-07 18:09:30 +02:00
// ListPublicKey returns a list of all public keys that user has.
func ListPublicKey(uid int64) ([]PublicKey, error) {
keys := make([]PublicKey, 0, 5)
err := orm.Find(&keys, &PublicKey{OwnerId: uid})
return keys, err
}
2014-05-06 22:28:52 +02:00
// rewriteAuthorizedKeys finds and deletes corresponding line in authorized_keys file.
2014-03-22 19:27:03 +01:00
func rewriteAuthorizedKeys(key *PublicKey, p, tmpP string) error {
2014-03-16 10:24:13 +01:00
sshOpLocker.Lock()
defer sshOpLocker.Unlock()
fr, err := os.Open(p)
if err != nil {
return err
}
defer fr.Close()
fw, err := os.Create(tmpP)
if err != nil {
return err
}
defer fw.Close()
2014-05-06 22:28:52 +02:00
isFound := false
2014-05-07 18:09:30 +02: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 10:24:13 +01:00
}
// Found the line and copy rest of file.
2014-05-07 18:09:30 +02:00
if !isFound && strings.Contains(line, keyword) && strings.Contains(line, key.Content) {
2014-05-06 22:28:52 +02:00
isFound = true
2014-03-16 10:48:20 +01:00
continue
2014-03-16 10:24:13 +01:00
}
// Still finding the line, copy the line that currently read.
2014-05-07 18:09:30 +02:00
if _, err = fw.WriteString(line + "\n"); err != nil {
2014-03-16 10:24:13 +01:00
return err
}
2014-05-06 22:28:52 +02:00
2014-05-07 18:09:30 +02:00
if errRead == io.EOF {
break
}
}
2014-03-22 19:27:03 +01:00
return nil
}
2014-03-16 10:24:13 +01:00
2014-03-22 19:27:03 +01:00
// DeletePublicKey deletes SSH key information both in database and authorized_keys file.
2014-05-06 22:28:52 +02:00
func DeletePublicKey(key *PublicKey) error {
has, err := orm.Get(key)
2014-03-22 19:27:03 +01:00
if err != nil {
return err
} else if !has {
2014-05-06 22:28:52 +02:00
return ErrKeyNotExist
2014-03-22 19:27:03 +01:00
}
2014-05-06 22:28:52 +02:00
2014-03-22 19:27:03 +01:00
if _, err = orm.Delete(key); err != nil {
return err
}
2014-06-11 01:11:53 +02:00
fpath := filepath.Join(SshPath, "authorized_keys")
tmpPath := filepath.Join(SshPath, "authorized_keys.tmp")
2014-05-07 18:09:30 +02:00
log.Trace("publickey.DeletePublicKey(authorized_keys): %s", fpath)
2014-03-22 19:27:03 +01:00
2014-05-07 18:09:30 +02:00
if err = rewriteAuthorizedKeys(key, fpath, tmpPath); err != nil {
2014-03-22 19:27:03 +01:00
return err
2014-05-07 18:09:30 +02:00
} else if err = os.Remove(fpath); err != nil {
2014-03-16 10:24:13 +01:00
return err
}
2014-05-07 18:09:30 +02:00
return os.Rename(tmpPath, fpath)
2014-02-17 16:57:23 +01:00
}