diff options
author | Unknwon <u@gogs.io> | 2015-08-06 22:48:11 +0800 |
---|---|---|
committer | Unknwon <u@gogs.io> | 2015-08-06 22:48:11 +0800 |
commit | 39a3b768bc8b0288cb4aa91d27485f46cfbfeb29 (patch) | |
tree | bef625e010018151863344d9da3ff22d2dfbc8f9 /models | |
parent | 9f12ab0e8847682a686fdb843922a761bbb5c225 (diff) | |
download | gitea-39a3b768bc8b0288cb4aa91d27485f46cfbfeb29.tar.gz gitea-39a3b768bc8b0288cb4aa91d27485f46cfbfeb29.zip |
#334: Add Deployment Key Support
Diffstat (limited to 'models')
-rw-r--r-- | models/error.go | 76 | ||||
-rw-r--r-- | models/issue.go | 18 | ||||
-rw-r--r-- | models/migrations/migrations.go | 2 | ||||
-rw-r--r-- | models/models.go | 4 | ||||
-rw-r--r-- | models/publickey.go | 337 | ||||
-rw-r--r-- | models/user.go | 2 |
6 files changed, 360 insertions, 79 deletions
diff --git a/models/error.go b/models/error.go index 38a3c0534e..7851e19407 100644 --- a/models/error.go +++ b/models/error.go @@ -107,6 +107,82 @@ func (err ErrUserHasOrgs) Error() string { return fmt.Sprintf("user still has membership of organizations: [uid: %d]", err.UID) } +// __________ ___. .__ .__ ____ __. +// \______ \__ _\_ |__ | | |__| ____ | |/ _|____ ___.__. +// | ___/ | \ __ \| | | |/ ___\ | <_/ __ < | | +// | | | | / \_\ \ |_| \ \___ | | \ ___/\___ | +// |____| |____/|___ /____/__|\___ > |____|__ \___ > ____| +// \/ \/ \/ \/\/ + +type ErrKeyNotExist struct { + ID int64 +} + +func IsErrKeyNotExist(err error) bool { + _, ok := err.(ErrKeyNotExist) + return ok +} + +func (err ErrKeyNotExist) Error() string { + return fmt.Sprintf("public key does not exist: [id: %d]", err.ID) +} + +type ErrKeyAlreadyExist struct { + OwnerID int64 + Content string +} + +func IsErrKeyAlreadyExist(err error) bool { + _, ok := err.(ErrKeyAlreadyExist) + return ok +} + +func (err ErrKeyAlreadyExist) Error() string { + return fmt.Sprintf("public key already exists: [owner_id: %d, content: %s]", err.OwnerID, err.Content) +} + +type ErrKeyNameAlreadyUsed struct { + OwnerID int64 + Name string +} + +func IsErrKeyNameAlreadyUsed(err error) bool { + _, ok := err.(ErrKeyNameAlreadyUsed) + return ok +} + +func (err ErrKeyNameAlreadyUsed) Error() string { + return fmt.Sprintf("public key already exists: [owner_id: %d, name: %s]", err.OwnerID, err.Name) +} + +type ErrDeployKeyAlreadyExist struct { + KeyID int64 + RepoID int64 +} + +func IsErrDeployKeyAlreadyExist(err error) bool { + _, ok := err.(ErrDeployKeyAlreadyExist) + return ok +} + +func (err ErrDeployKeyAlreadyExist) Error() string { + return fmt.Sprintf("public key already exists: [key_id: %d, repo_id: %d]", err.KeyID, err.RepoID) +} + +type ErrDeployKeyNameAlreadyUsed struct { + RepoID int64 + Name string +} + +func IsErrDeployKeyNameAlreadyUsed(err error) bool { + _, ok := err.(ErrDeployKeyNameAlreadyUsed) + return ok +} + +func (err ErrDeployKeyNameAlreadyUsed) Error() string { + return fmt.Sprintf("public key already exists: [repo_id: %d, name: %s]", err.RepoID, err.Name) +} + // ________ .__ __ .__ // \_____ \_______ _________ ____ |__|____________ _/ |_|__| ____ ____ // / | \_ __ \/ ___\__ \ / \| \___ /\__ \\ __\ |/ _ \ / \ diff --git a/models/issue.go b/models/issue.go index 80afb415bb..a80a984912 100644 --- a/models/issue.go +++ b/models/issue.go @@ -56,16 +56,11 @@ type Issue struct { Updated time.Time `xorm:"UPDATED"` } -func (i *Issue) BeforeSet(colName string, val xorm.Cell) { +func (i *Issue) AfterSet(colName string, _ xorm.Cell) { var err error switch colName { case "milestone_id": - mid := (*val).(int64) - if mid <= 0 { - return - } - - i.Milestone, err = GetMilestoneById(mid) + i.Milestone, err = GetMilestoneById(i.MilestoneID) if err != nil { log.Error(3, "GetMilestoneById: %v", err) } @@ -664,15 +659,14 @@ type Milestone struct { ClosedDate time.Time } -func (m *Milestone) BeforeSet(colName string, val xorm.Cell) { +func (m *Milestone) AfterSet(colName string, _ xorm.Cell) { if colName == "deadline" { - t := (*val).(time.Time) - if t.Year() == 9999 { + if m.Deadline.Year() == 9999 { return } - m.DeadlineString = t.Format("2006-01-02") - if time.Now().After(t) { + m.DeadlineString = m.Deadline.Format("2006-01-02") + if time.Now().After(m.Deadline) { m.IsOverDue = true } } diff --git a/models/migrations/migrations.go b/models/migrations/migrations.go index 156fceda5e..c7900743f1 100644 --- a/models/migrations/migrations.go +++ b/models/migrations/migrations.go @@ -57,7 +57,7 @@ var migrations = []Migration{ NewMigration("refactor access table to use id's", accessRefactor), // V2 -> V3:v0.5.13 NewMigration("generate team-repo from team", teamToTeamRepo), // V3 -> V4:v0.5.13 NewMigration("fix locale file load panic", fixLocaleFileLoadPanic), // V4 -> V5:v0.6.0 - NewMigration("trim action compare URL prefix", trimCommitActionAppUrlPrefix), // V5 -> V6:v0.6.3 // V4 -> V5:v0.6.0 + NewMigration("trim action compare URL prefix", trimCommitActionAppUrlPrefix), // V5 -> V6:v0.6.3 } // Migrate database to current version diff --git a/models/models.go b/models/models.go index a10a48f3f3..01b96c0f54 100644 --- a/models/models.go +++ b/models/models.go @@ -55,7 +55,7 @@ var ( func init() { tables = append(tables, new(User), new(PublicKey), new(Oauth2), new(AccessToken), - new(Repository), new(Collaboration), new(Access), + new(Repository), new(DeployKey), new(Collaboration), new(Access), new(Watch), new(Star), new(Follow), new(Action), new(Issue), new(Comment), new(Attachment), new(IssueUser), new(Label), new(Milestone), new(Mirror), new(Release), new(LoginSource), new(Webhook), @@ -132,7 +132,7 @@ func NewTestEngine(x *xorm.Engine) (err error) { func SetEngine() (err error) { x, err = getEngine() if err != nil { - return fmt.Errorf("Connect to database: %v", err) + return fmt.Errorf("Fail to connect to database: %v", err) } x.SetMapper(core.GonicMapper{}) diff --git a/models/publickey.go b/models/publickey.go index 0db9f333be..67891fbaf7 100644 --- a/models/publickey.go +++ b/models/publickey.go @@ -21,6 +21,7 @@ import ( "time" "github.com/Unknwon/com" + "github.com/go-xorm/xorm" "github.com/gogits/gogs/modules/log" "github.com/gogits/gogs/modules/process" @@ -33,8 +34,6 @@ const ( ) var ( - ErrKeyAlreadyExist = errors.New("Public key already exists") - ErrKeyNotExist = errors.New("Public key does not exist") ErrKeyUnableVerify = errors.New("Unable to verify public key") ) @@ -78,17 +77,34 @@ func init() { } } -// PublicKey represents a SSH key. +type KeyType int + +const ( + KEY_TYPE_USER = iota + 1 + KEY_TYPE_DEPLOY +) + +// PublicKey represents a SSH or deploy key. type PublicKey struct { - Id int64 - OwnerId int64 `xorm:"UNIQUE(s) INDEX NOT NULL"` - Name string `xorm:"UNIQUE(s) NOT NULL"` - Fingerprint string `xorm:"INDEX NOT NULL"` - Content string `xorm:"TEXT NOT NULL"` - Created time.Time `xorm:"CREATED"` - Updated time.Time - HasRecentActivity bool `xorm:"-"` - HasUsed bool `xorm:"-"` + ID int64 `xorm:"pk autoincr"` + OwnerID int64 `xorm:"INDEX NOT NULL"` + Name string `xorm:"NOT NULL"` + Fingerprint string `xorm:"NOT NULL"` + Content string `xorm:"UNIQUE TEXT NOT NULL"` + 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()) + } } // OmitEmail returns content of public key but without e-mail address. @@ -98,7 +114,7 @@ func (k *PublicKey) OmitEmail() string { // 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, setting.CustomConf, key.Content) + return fmt.Sprintf(_TPL_PUBLICK_KEY, appPath, key.ID, setting.CustomConf, key.Content) } var minimumKeySizes = map[string]int{ @@ -126,8 +142,8 @@ func extractTypeFromBase64Key(key string) (string, error) { 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) { +// parseKeyString parses 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) @@ -190,16 +206,21 @@ func ParseKeyString(content string) (string, error) { } // CheckPublicKeyString checks if the given public key string is recognized by SSH. -func CheckPublicKeyString(content string) (bool, error) { +func CheckPublicKeyString(content string) (_ string, err error) { + content, err = parseKeyString(content) + if err != nil { + return "", err + } + content = strings.TrimRight(content, "\n\r") if strings.ContainsAny(content, "\n\r") { - return false, errors.New("only a single line with a single key please") + return "", errors.New("only a single line with a single key please") } // write the key to a fileā¦ tmpFile, err := ioutil.TempFile(os.TempDir(), "keytest") if err != nil { - return false, err + return "", err } tmpPath := tmpFile.Name() defer os.Remove(tmpPath) @@ -209,37 +230,36 @@ func CheckPublicKeyString(content string) (bool, error) { // Check if ssh-keygen recognizes its contents. stdout, stderr, err := process.Exec("CheckPublicKeyString", "ssh-keygen", "-l", "-f", tmpPath) if err != nil { - return false, errors.New("ssh-keygen -l -f: " + stderr) + return "", errors.New("ssh-keygen -l -f: " + stderr) } else if len(stdout) < 2 { - return false, errors.New("ssh-keygen returned not enough output to evaluate the key: " + stdout) + return "", errors.New("ssh-keygen returned not enough output to evaluate the key: " + stdout) } // The ssh-keygen in Windows does not print key type, so no need go further. if setting.IsWindows { - return true, nil + return content, nil } - fmt.Println(stdout) sshKeygenOutput := strings.Split(stdout, " ") if len(sshKeygenOutput) < 4 { - return false, ErrKeyUnableVerify + return content, ErrKeyUnableVerify } // Check if key type and key size match. if !setting.Service.DisableMinimumKeySizeCheck { keySize := com.StrTo(sshKeygenOutput[0]).MustInt() if keySize == 0 { - return false, errors.New("cannot get key size of the given key") + return "", errors.New("cannot get key size of the given key") } keyType := strings.TrimSpace(sshKeygenOutput[len(sshKeygenOutput)-1]) if minimumKeySize := minimumKeySizes[keyType]; minimumKeySize == 0 { - return false, errors.New("sorry, unrecognized public key type") + return "", errors.New("sorry, unrecognized public key type") } else if keySize < minimumKeySize { - return false, fmt.Errorf("the minimum accepted size of a public key %s is %d", keyType, minimumKeySize) + return "", fmt.Errorf("the minimum accepted size of a public key %s is %d", keyType, minimumKeySize) } } - return true, nil + return content, nil } // saveAuthorizedKeyFile writes SSH key content to authorized_keys file. @@ -278,20 +298,23 @@ func saveAuthorizedKeyFile(keys ...*PublicKey) error { return nil } -// AddPublicKey adds new public key to database and authorized_keys file. -func AddPublicKey(key *PublicKey) (err error) { - has, err := x.Get(key) +func checkKeyContent(content string) error { + // Same key can only be added once. + has, err := x.Where("content=?", content).Get(new(PublicKey)) if err != nil { return err } else if has { - return ErrKeyAlreadyExist + return ErrKeyAlreadyExist{0, content} } + return nil +} +func addKey(e Engine, key *PublicKey) (err error) { // Calculate fingerprint. tmpPath := strings.Replace(path.Join(os.TempDir(), fmt.Sprintf("%d", time.Now().Nanosecond()), "id_rsa.pub"), "\\", "/", -1) os.MkdirAll(path.Dir(tmpPath), os.ModePerm) - if err = ioutil.WriteFile(tmpPath, []byte(key.Content), os.ModePerm); err != nil { + if err = ioutil.WriteFile(tmpPath, []byte(key.Content), 0644); err != nil { return err } stdout, stderr, err := process.Exec("AddPublicKey", "ssh-keygen", "-l", "-f", tmpPath) @@ -301,32 +324,56 @@ func AddPublicKey(key *PublicKey) (err error) { return errors.New("not enough output for calculating fingerprint: " + stdout) } key.Fingerprint = strings.Split(stdout, " ")[1] - if has, err := x.Get(&PublicKey{Fingerprint: key.Fingerprint}); err == nil && has { - return ErrKeyAlreadyExist - } // Save SSH key. - if _, err = x.Insert(key); err != nil { + if _, err = e.Insert(key); err != nil { return err - } else if err = saveAuthorizedKeyFile(key); err != nil { - // Roll back. - if _, err2 := x.Delete(key); err2 != nil { - return err2 - } + } + return saveAuthorizedKeyFile(key) +} + +// AddPublicKey adds new public key to database and authorized_keys file. +func AddPublicKey(ownerID int64, name, content string) (err error) { + if err = checkKeyContent(content); err != nil { return err } - return nil + // Key name of same user cannot be duplicated. + has, err := x.Where("owner_id=? AND name=?", ownerID, name).Get(new(PublicKey)) + if err != nil { + return err + } else if has { + return ErrKeyNameAlreadyUsed{ownerID, name} + } + + sess := x.NewSession() + defer sessionRelease(sess) + if err = sess.Begin(); err != nil { + return err + } + + key := &PublicKey{ + OwnerID: ownerID, + Name: name, + Content: content, + Mode: ACCESS_MODE_WRITE, + Type: KEY_TYPE_USER, + } + if err = addKey(sess, key); err != nil { + return fmt.Errorf("addKey: %v", err) + } + + return sess.Commit() } -// GetPublicKeyById returns public key by given ID. -func GetPublicKeyById(keyId int64) (*PublicKey, error) { +// GetPublicKeyByID returns public key by given ID. +func GetPublicKeyByID(keyID int64) (*PublicKey, error) { key := new(PublicKey) - has, err := x.Id(keyId).Get(key) + has, err := x.Id(keyID).Get(key) if err != nil { return nil, err } else if !has { - return nil, ErrKeyNotExist + return nil, ErrKeyNotExist{keyID} } return key, nil } @@ -334,16 +381,7 @@ func GetPublicKeyById(keyId int64) (*PublicKey, error) { // ListPublicKeys returns a list of public keys belongs to given user. func ListPublicKeys(uid int64) ([]*PublicKey, error) { keys := make([]*PublicKey, 0, 5) - err := x.Where("owner_id=?", uid).Find(&keys) - 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 + return keys, x.Where("owner_id=?", uid).Find(&keys) } // rewriteAuthorizedKeys finds and deletes corresponding line in authorized_keys file. @@ -364,7 +402,7 @@ func rewriteAuthorizedKeys(key *PublicKey, p, tmpP string) error { defer fw.Close() isFound := false - keyword := fmt.Sprintf("key-%d", key.Id) + keyword := fmt.Sprintf("key-%d", key.ID) buf := bufio.NewReader(fr) for { line, errRead := buf.ReadString('\n') @@ -401,20 +439,19 @@ func rewriteAuthorizedKeys(key *PublicKey, p, tmpP string) error { // UpdatePublicKey updates given public key. func UpdatePublicKey(key *PublicKey) error { - _, err := x.Id(key.Id).AllCols().Update(key) + _, err := x.Id(key.ID).AllCols().Update(key) return err } -// DeletePublicKey deletes SSH key information both in database and authorized_keys file. -func DeletePublicKey(key *PublicKey) error { - has, err := x.Get(key) +func deletePublicKey(e *xorm.Session, key *PublicKey) error { + has, err := e.Get(key) if err != nil { return err } else if !has { - return ErrKeyNotExist + return nil } - if _, err = x.Delete(key); err != nil { + if _, err = e.Id(key.ID).Delete(key); err != nil { return err } @@ -428,6 +465,21 @@ func DeletePublicKey(key *PublicKey) error { return os.Rename(tmpPath, fpath) } +// DeletePublicKey deletes SSH key information both in database and authorized_keys file. +func DeletePublicKey(key *PublicKey) (err error) { + sess := x.NewSession() + defer sessionRelease(sess) + if err = sess.Begin(); err != nil { + return err + } + + if err = deletePublicKey(sess, key); err != nil { + return err + } + + return sess.Commit() +} + // RewriteAllPublicKeys removes any authorized key and rewrite all keys from database again. func RewriteAllPublicKeys() error { sshOpLocker.Lock() @@ -461,3 +513,162 @@ func RewriteAllPublicKeys() error { return nil } + +// ________ .__ ____ __. +// \______ \ ____ ______ | | ____ ___.__.| |/ _|____ ___.__. +// | | \_/ __ \\____ \| | / _ < | || <_/ __ < | | +// | ` \ ___/| |_> > |_( <_> )___ || | \ ___/\___ | +// /_______ /\___ > __/|____/\____// ____||____|__ \___ > ____| +// \/ \/|__| \/ \/ \/\/ + +// 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 + 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()) + } +} + +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. +func addDeployKey(e *xorm.Session, keyID, repoID int64, name, fingerprint string) (err error) { + if err = checkDeployKey(e, keyID, repoID, name); err != nil { + return err + } + + _, err = e.Insert(&DeployKey{ + KeyID: keyID, + RepoID: repoID, + Name: name, + Fingerprint: fingerprint, + }) + return err +} + +// 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. +func AddDeployKey(repoID int64, name, content string) (err error) { + if err = checkKeyContent(content); err != nil { + return err + } + + key := &PublicKey{ + Content: content, + Mode: ACCESS_MODE_READ, + Type: KEY_TYPE_DEPLOY, + } + has, err := x.Get(key) + if err != nil { + return err + } + + sess := x.NewSession() + defer sessionRelease(sess) + if err = sess.Begin(); err != nil { + return err + } + + // First time use this deploy key. + if !has { + if err = addKey(sess, key); err != nil { + return nil + } + } + + if err = addDeployKey(sess, key.ID, repoID, name, key.Fingerprint); err != nil { + return err + } + + return sess.Commit() +} + +// 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, + } + _, err := x.Get(key) + return key, err +} + +// 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. +func DeleteDeployKey(id int64) error { + key := &DeployKey{ID: id} + has, err := x.Id(key.ID).Get(key) + if err != nil { + return err + } else if !has { + return nil + } + + sess := x.NewSession() + defer sessionRelease(sess) + if err = sess.Begin(); err != nil { + return err + } + + if _, err = sess.Id(key.ID).Delete(key); err != nil { + return fmt.Errorf("delete deploy key[%d]: %v", key.ID, err) + } + + // Check if this is the last reference to same key content. + has, err = sess.Where("key_id=?", key.KeyID).Get(new(DeployKey)) + if err != nil { + return err + } else if !has { + if err = deletePublicKey(sess, &PublicKey{ID: key.KeyID}); err != nil { + 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) +} diff --git a/models/user.go b/models/user.go index 4b6517d7b1..1e514cdf51 100644 --- a/models/user.go +++ b/models/user.go @@ -505,7 +505,7 @@ func DeleteUser(u *User) error { // Delete all SSH keys. keys := make([]*PublicKey, 0, 10) - if err = sess.Find(&keys, &PublicKey{OwnerId: u.Id}); err != nil { + if err = sess.Find(&keys, &PublicKey{OwnerID: u.Id}); err != nil { return err } for _, key := range keys { |