aboutsummaryrefslogtreecommitdiffstats
path: root/models/ssh_key_deploy.go
diff options
context:
space:
mode:
authorLunny Xiao <xiaolunwen@gmail.com>2021-12-10 16:14:24 +0800
committerGitHub <noreply@github.com>2021-12-10 16:14:24 +0800
commit3ca5dc7e32b372d14ff80d96f14b8f6a805862f1 (patch)
tree50d193ed0dacf2888d57b193a9b0d36065aff205 /models/ssh_key_deploy.go
parent0a9fcf63a49799ad3b0f146c54879161bac61e10 (diff)
downloadgitea-3ca5dc7e32b372d14ff80d96f14b8f6a805862f1.tar.gz
gitea-3ca5dc7e32b372d14ff80d96f14b8f6a805862f1.zip
Move keys to models/asymkey (#17917)
* Move keys to models/keys * Rename models/keys -> models/asymkey * change the missed package name * Fix package alias * Fix test * Fix docs * Fix test * Fix test * merge
Diffstat (limited to 'models/ssh_key_deploy.go')
-rw-r--r--models/ssh_key_deploy.go324
1 files changed, 0 insertions, 324 deletions
diff --git a/models/ssh_key_deploy.go b/models/ssh_key_deploy.go
deleted file mode 100644
index 672974afb3..0000000000
--- a/models/ssh_key_deploy.go
+++ /dev/null
@@ -1,324 +0,0 @@
-// Copyright 2021 The Gitea Authors. All rights reserved.
-// Use of this source code is governed by a MIT-style
-// license that can be found in the LICENSE file.
-
-package models
-
-import (
- "context"
- "fmt"
- "time"
-
- "code.gitea.io/gitea/models/db"
- "code.gitea.io/gitea/models/perm"
- repo_model "code.gitea.io/gitea/models/repo"
- user_model "code.gitea.io/gitea/models/user"
- "code.gitea.io/gitea/modules/timeutil"
-
- "xorm.io/builder"
-)
-
-// ________ .__ ____ __.
-// \______ \ ____ ______ | | ____ ___.__.| |/ _|____ ___.__.
-// | | \_/ __ \\____ \| | / _ < | || <_/ __ < | |
-// | ` \ ___/| |_> > |_( <_> )___ || | \ ___/\___ |
-// /_______ /\___ > __/|____/\____// ____||____|__ \___ > ____|
-// \/ \/|__| \/ \/ \/\/
-//
-// This file contains functions specific to DeployKeys
-
-// 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:"-"`
-
- Mode perm.AccessMode `xorm:"NOT NULL DEFAULT 1"`
-
- CreatedUnix timeutil.TimeStamp `xorm:"created"`
- UpdatedUnix timeutil.TimeStamp `xorm:"updated"`
- HasRecentActivity bool `xorm:"-"`
- HasUsed bool `xorm:"-"`
-}
-
-// AfterLoad is invoked from XORM after setting the values of all fields of this object.
-func (key *DeployKey) AfterLoad() {
- key.HasUsed = key.UpdatedUnix > key.CreatedUnix
- key.HasRecentActivity = key.UpdatedUnix.AddDuration(7*24*time.Hour) > timeutil.TimeStampNow()
-}
-
-// GetContent gets associated public key content.
-func (key *DeployKey) GetContent() error {
- pkey, err := GetPublicKeyByID(key.KeyID)
- if err != nil {
- return err
- }
- key.Content = pkey.Content
- return nil
-}
-
-// IsReadOnly checks if the key can only be used for read operations
-func (key *DeployKey) IsReadOnly() bool {
- return key.Mode == perm.AccessModeRead
-}
-
-func init() {
- db.RegisterModel(new(DeployKey))
-}
-
-func checkDeployKey(e db.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 db.Engine, keyID, repoID int64, name, fingerprint string, mode perm.AccessMode) (*DeployKey, error) {
- if err := checkDeployKey(e, keyID, repoID, name); err != nil {
- return nil, err
- }
-
- key := &DeployKey{
- KeyID: keyID,
- RepoID: repoID,
- Name: name,
- Fingerprint: fingerprint,
- Mode: mode,
- }
- _, err := e.Insert(key)
- return key, err
-}
-
-// HasDeployKey returns true if public key is a deploy key of given repository.
-func HasDeployKey(keyID, repoID int64) bool {
- has, _ := db.GetEngine(db.DefaultContext).
- 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, readOnly bool) (*DeployKey, error) {
- fingerprint, err := calcFingerprint(content)
- if err != nil {
- return nil, err
- }
-
- accessMode := perm.AccessModeRead
- if !readOnly {
- accessMode = perm.AccessModeWrite
- }
-
- ctx, committer, err := db.TxContext()
- if err != nil {
- return nil, err
- }
- defer committer.Close()
-
- sess := db.GetEngine(ctx)
-
- pkey := &PublicKey{
- Fingerprint: fingerprint,
- }
- has, err := sess.Get(pkey)
- if err != nil {
- return nil, err
- }
-
- if has {
- if pkey.Type != KeyTypeDeploy {
- return nil, ErrKeyAlreadyExist{0, fingerprint, ""}
- }
- } else {
- // First time use this deploy key.
- pkey.Mode = accessMode
- pkey.Type = KeyTypeDeploy
- pkey.Content = content
- pkey.Name = name
- if err = addKey(sess, pkey); err != nil {
- return nil, fmt.Errorf("addKey: %v", err)
- }
- }
-
- key, err := addDeployKey(sess, pkey.ID, repoID, name, pkey.Fingerprint, accessMode)
- if err != nil {
- return nil, err
- }
-
- return key, committer.Commit()
-}
-
-// GetDeployKeyByID returns deploy key by given ID.
-func GetDeployKeyByID(id int64) (*DeployKey, error) {
- return getDeployKeyByID(db.GetEngine(db.DefaultContext), id)
-}
-
-func getDeployKeyByID(e db.Engine, id int64) (*DeployKey, error) {
- key := new(DeployKey)
- has, err := e.ID(id).Get(key)
- if err != nil {
- return nil, err
- } else if !has {
- return nil, ErrDeployKeyNotExist{id, 0, 0}
- }
- return key, nil
-}
-
-// GetDeployKeyByRepo returns deploy key by given public key ID and repository ID.
-func GetDeployKeyByRepo(keyID, repoID int64) (*DeployKey, error) {
- return getDeployKeyByRepo(db.GetEngine(db.DefaultContext), keyID, repoID)
-}
-
-func getDeployKeyByRepo(e db.Engine, keyID, repoID int64) (*DeployKey, error) {
- key := &DeployKey{
- KeyID: keyID,
- RepoID: repoID,
- }
- has, err := e.Get(key)
- if err != nil {
- return nil, err
- } else if !has {
- return nil, ErrDeployKeyNotExist{0, keyID, repoID}
- }
- return key, nil
-}
-
-// UpdateDeployKeyCols updates deploy key information in the specified columns.
-func UpdateDeployKeyCols(key *DeployKey, cols ...string) error {
- _, err := db.GetEngine(db.DefaultContext).ID(key.ID).Cols(cols...).Update(key)
- return err
-}
-
-// UpdateDeployKey updates deploy key information.
-func UpdateDeployKey(key *DeployKey) error {
- _, err := db.GetEngine(db.DefaultContext).ID(key.ID).AllCols().Update(key)
- return err
-}
-
-// DeleteDeployKey deletes deploy key from its repository authorized_keys file if needed.
-func DeleteDeployKey(doer *user_model.User, id int64) error {
- ctx, committer, err := db.TxContext()
- if err != nil {
- return err
- }
- defer committer.Close()
-
- if err := deleteDeployKey(ctx, doer, id); err != nil {
- return err
- }
- return committer.Commit()
-}
-
-func deleteDeployKey(ctx context.Context, doer *user_model.User, id int64) error {
- sess := db.GetEngine(ctx)
- key, err := getDeployKeyByID(sess, id)
- if err != nil {
- if IsErrDeployKeyNotExist(err) {
- return nil
- }
- return fmt.Errorf("GetDeployKeyByID: %v", err)
- }
-
- // Check if user has access to delete this key.
- if !doer.IsAdmin {
- repo, err := repo_model.GetRepositoryByIDCtx(ctx, key.RepoID)
- if err != nil {
- return fmt.Errorf("repo_model.GetRepositoryByID: %v", err)
- }
- has, err := isUserRepoAdmin(sess, repo, doer)
- if err != nil {
- return fmt.Errorf("GetUserRepoPermission: %v", err)
- } else if !has {
- return ErrKeyAccessDenied{doer.ID, key.ID, "deploy"}
- }
- }
-
- if _, err = sess.ID(key.ID).Delete(new(DeployKey)); 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 = deletePublicKeys(sess, key.KeyID); err != nil {
- return err
- }
-
- // after deleted the public keys, should rewrite the public keys file
- if err = rewriteAllPublicKeys(sess); err != nil {
- return err
- }
- }
-
- return nil
-}
-
-// ListDeployKeysOptions are options for ListDeployKeys
-type ListDeployKeysOptions struct {
- db.ListOptions
- RepoID int64
- KeyID int64
- Fingerprint string
-}
-
-func (opt ListDeployKeysOptions) toCond() builder.Cond {
- cond := builder.NewCond()
- if opt.RepoID != 0 {
- cond = cond.And(builder.Eq{"repo_id": opt.RepoID})
- }
- if opt.KeyID != 0 {
- cond = cond.And(builder.Eq{"key_id": opt.KeyID})
- }
- if opt.Fingerprint != "" {
- cond = cond.And(builder.Eq{"fingerprint": opt.Fingerprint})
- }
- return cond
-}
-
-// ListDeployKeys returns a list of deploy keys matching the provided arguments.
-func ListDeployKeys(opts *ListDeployKeysOptions) ([]*DeployKey, error) {
- return listDeployKeys(db.GetEngine(db.DefaultContext), opts)
-}
-
-func listDeployKeys(e db.Engine, opts *ListDeployKeysOptions) ([]*DeployKey, error) {
- sess := e.Where(opts.toCond())
-
- if opts.Page != 0 {
- sess = db.SetSessionPagination(sess, opts)
-
- keys := make([]*DeployKey, 0, opts.PageSize)
- return keys, sess.Find(&keys)
- }
-
- keys := make([]*DeployKey, 0, 5)
- return keys, sess.Find(&keys)
-}
-
-// CountDeployKeys returns count deploy keys matching the provided arguments.
-func CountDeployKeys(opts *ListDeployKeysOptions) (int64, error) {
- return db.GetEngine(db.DefaultContext).Where(opts.toCond()).Count(&DeployKey{})
-}