1
0

ssh_key.go 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791
  1. package database
  2. import (
  3. "context"
  4. "encoding/base64"
  5. "encoding/binary"
  6. "fmt"
  7. "math/big"
  8. "os"
  9. "path"
  10. "path/filepath"
  11. "strings"
  12. "sync"
  13. "time"
  14. "github.com/cockroachdb/errors"
  15. "github.com/unknwon/com"
  16. "golang.org/x/crypto/ssh"
  17. log "unknwon.dev/clog/v2"
  18. "xorm.io/xorm"
  19. "gogs.io/gogs/internal/conf"
  20. "gogs.io/gogs/internal/errutil"
  21. "gogs.io/gogs/internal/process"
  22. )
  23. const (
  24. tplPublicKey = `command="%s serv key-%d --config='%s'",no-port-forwarding,no-X11-forwarding,no-agent-forwarding,no-pty %s` + "\n"
  25. )
  26. var sshOpLocker sync.Mutex
  27. type KeyType int
  28. const (
  29. KeyTypeUser = iota + 1
  30. KeyTypeDeploy
  31. )
  32. // PublicKey represents a user or deploy SSH public key.
  33. type PublicKey struct {
  34. ID int64 `gorm:"primaryKey"`
  35. OwnerID int64 `xorm:"INDEX NOT NULL" gorm:"index;not null"`
  36. Name string `xorm:"NOT NULL" gorm:"not null"`
  37. Fingerprint string `xorm:"NOT NULL" gorm:"not null"`
  38. Content string `xorm:"TEXT NOT NULL" gorm:"type:TEXT;not null"`
  39. Mode AccessMode `xorm:"NOT NULL DEFAULT 2" gorm:"not null;default:2"`
  40. Type KeyType `xorm:"NOT NULL DEFAULT 1" gorm:"not null;default:1"`
  41. Created time.Time `xorm:"-" json:"-" gorm:"-"`
  42. CreatedUnix int64
  43. Updated time.Time `xorm:"-" json:"-" gorm:"-"` // Note: Updated must below Created for AfterSet.
  44. UpdatedUnix int64
  45. HasRecentActivity bool `xorm:"-" json:"-" gorm:"-"`
  46. HasUsed bool `xorm:"-" json:"-" gorm:"-"`
  47. }
  48. func (k *PublicKey) BeforeInsert() {
  49. k.CreatedUnix = time.Now().Unix()
  50. }
  51. func (k *PublicKey) BeforeUpdate() {
  52. k.UpdatedUnix = time.Now().Unix()
  53. }
  54. func (k *PublicKey) AfterSet(colName string, _ xorm.Cell) {
  55. switch colName {
  56. case "created_unix":
  57. k.Created = time.Unix(k.CreatedUnix, 0).Local()
  58. case "updated_unix":
  59. k.Updated = time.Unix(k.UpdatedUnix, 0).Local()
  60. k.HasUsed = k.Updated.After(k.Created)
  61. k.HasRecentActivity = k.Updated.Add(7 * 24 * time.Hour).After(time.Now())
  62. }
  63. }
  64. // OmitEmail returns content of public key without email address.
  65. func (k *PublicKey) OmitEmail() string {
  66. return strings.Join(strings.Split(k.Content, " ")[:2], " ")
  67. }
  68. // AuthorizedString returns formatted public key string for authorized_keys file.
  69. func (k *PublicKey) AuthorizedString() string {
  70. return fmt.Sprintf(tplPublicKey, conf.AppPath(), k.ID, conf.CustomConf, k.Content)
  71. }
  72. // IsDeployKey returns true if the public key is used as deploy key.
  73. func (k *PublicKey) IsDeployKey() bool {
  74. return k.Type == KeyTypeDeploy
  75. }
  76. func extractTypeFromBase64Key(key string) (string, error) {
  77. b, err := base64.StdEncoding.DecodeString(key)
  78. if err != nil || len(b) < 4 {
  79. return "", errors.Newf("invalid key format: %v", err)
  80. }
  81. keyLength := int(binary.BigEndian.Uint32(b))
  82. if len(b) < 4+keyLength {
  83. return "", errors.Newf("invalid key format: not enough length %d", keyLength)
  84. }
  85. return string(b[4 : 4+keyLength]), nil
  86. }
  87. // parseKeyString parses any key string in OpenSSH or SSH2 format to clean OpenSSH string (RFC4253).
  88. func parseKeyString(content string) (string, error) {
  89. // Transform all legal line endings to a single "\n"
  90. // Replace all windows full new lines ("\r\n")
  91. content = strings.ReplaceAll(content, "\r\n", "\n")
  92. // Replace all windows half new lines ("\r"), if it happen not to match replace above
  93. content = strings.ReplaceAll(content, "\r", "\n")
  94. // Replace ending new line as its may cause unwanted behaviour (extra line means not a single line key | OpenSSH key)
  95. content = strings.TrimRight(content, "\n")
  96. // split lines
  97. lines := strings.Split(content, "\n")
  98. var keyType, keyContent, keyComment string
  99. if len(lines) == 1 {
  100. // Parse OpenSSH format.
  101. parts := strings.SplitN(lines[0], " ", 3)
  102. switch len(parts) {
  103. case 0:
  104. return "", errors.New("empty key")
  105. case 1:
  106. keyContent = parts[0]
  107. case 2:
  108. keyType = parts[0]
  109. keyContent = parts[1]
  110. default:
  111. keyType = parts[0]
  112. keyContent = parts[1]
  113. keyComment = parts[2]
  114. }
  115. // If keyType is not given, extract it from content. If given, validate it.
  116. t, err := extractTypeFromBase64Key(keyContent)
  117. if err != nil {
  118. return "", errors.Newf("extractTypeFromBase64Key: %v", err)
  119. }
  120. if keyType == "" {
  121. keyType = t
  122. } else if keyType != t {
  123. return "", errors.Newf("key type and content does not match: %s - %s", keyType, t)
  124. }
  125. } else {
  126. // Parse SSH2 file format.
  127. continuationLine := false
  128. for _, line := range lines {
  129. // Skip lines that:
  130. // 1) are a continuation of the previous line,
  131. // 2) contain ":" as that are comment lines
  132. // 3) contain "-" as that are begin and end tags
  133. if continuationLine || strings.ContainsAny(line, ":-") {
  134. continuationLine = strings.HasSuffix(line, "\\")
  135. } else {
  136. keyContent = keyContent + line
  137. }
  138. }
  139. t, err := extractTypeFromBase64Key(keyContent)
  140. if err != nil {
  141. return "", errors.Newf("extractTypeFromBase64Key: %v", err)
  142. }
  143. keyType = t
  144. }
  145. return keyType + " " + keyContent + " " + keyComment, nil
  146. }
  147. // writeTmpKeyFile writes key content to a temporary file
  148. // and returns the name of that file, along with any possible errors.
  149. func writeTmpKeyFile(content string) (string, error) {
  150. tmpFile, err := os.CreateTemp(conf.SSH.KeyTestPath, "gogs_keytest")
  151. if err != nil {
  152. return "", errors.Newf("TempFile: %v", err)
  153. }
  154. defer tmpFile.Close()
  155. if _, err = tmpFile.WriteString(content); err != nil {
  156. return "", errors.Newf("WriteString: %v", err)
  157. }
  158. return tmpFile.Name(), nil
  159. }
  160. // SSHKeyGenParsePublicKey extracts key type and length using ssh-keygen.
  161. func SSHKeyGenParsePublicKey(key string) (string, int, error) {
  162. tmpName, err := writeTmpKeyFile(key)
  163. if err != nil {
  164. return "", 0, errors.Newf("writeTmpKeyFile: %v", err)
  165. }
  166. defer os.Remove(tmpName)
  167. stdout, stderr, err := process.Exec("SSHKeyGenParsePublicKey", conf.SSH.KeygenPath, "-lf", tmpName)
  168. if err != nil {
  169. return "", 0, errors.Newf("fail to parse public key: %s - %s", err, stderr)
  170. }
  171. if strings.Contains(stdout, "is not a public key file") {
  172. return "", 0, ErrKeyUnableVerify{stdout}
  173. }
  174. fields := strings.Split(stdout, " ")
  175. if len(fields) < 4 {
  176. return "", 0, errors.Newf("invalid public key line: %s", stdout)
  177. }
  178. keyType := strings.Trim(fields[len(fields)-1], "()\r\n")
  179. return strings.ToLower(keyType), com.StrTo(fields[0]).MustInt(), nil
  180. }
  181. // SSHNativeParsePublicKey extracts the key type and length using the golang SSH library.
  182. func SSHNativeParsePublicKey(keyLine string) (string, int, error) {
  183. fields := strings.Fields(keyLine)
  184. if len(fields) < 2 {
  185. return "", 0, errors.Newf("not enough fields in public key line: %s", keyLine)
  186. }
  187. raw, err := base64.StdEncoding.DecodeString(fields[1])
  188. if err != nil {
  189. return "", 0, err
  190. }
  191. pkey, err := ssh.ParsePublicKey(raw)
  192. if err != nil {
  193. if strings.Contains(err.Error(), "ssh: unknown key algorithm") {
  194. return "", 0, ErrKeyUnableVerify{err.Error()}
  195. }
  196. return "", 0, errors.Newf("ParsePublicKey: %v", err)
  197. }
  198. // The ssh library can parse the key, so next we find out what key exactly we have.
  199. switch pkey.Type() {
  200. case ssh.KeyAlgoDSA:
  201. rawPub := struct {
  202. Name string
  203. P, Q, G, Y *big.Int
  204. }{}
  205. if err := ssh.Unmarshal(pkey.Marshal(), &rawPub); err != nil {
  206. return "", 0, err
  207. }
  208. // as per https://bugzilla.mindrot.org/show_bug.cgi?id=1647 we should never
  209. // see dsa keys != 1024 bit, but as it seems to work, we will not check here
  210. return "dsa", rawPub.P.BitLen(), nil // use P as per crypto/dsa/dsa.go (is L)
  211. case ssh.KeyAlgoRSA:
  212. rawPub := struct {
  213. Name string
  214. E *big.Int
  215. N *big.Int
  216. }{}
  217. if err := ssh.Unmarshal(pkey.Marshal(), &rawPub); err != nil {
  218. return "", 0, err
  219. }
  220. return "rsa", rawPub.N.BitLen(), nil // use N as per crypto/rsa/rsa.go (is bits)
  221. case ssh.KeyAlgoECDSA256:
  222. return "ecdsa", 256, nil
  223. case ssh.KeyAlgoECDSA384:
  224. return "ecdsa", 384, nil
  225. case ssh.KeyAlgoECDSA521:
  226. return "ecdsa", 521, nil
  227. case ssh.KeyAlgoED25519:
  228. return "ed25519", 256, nil
  229. }
  230. return "", 0, errors.Newf("unsupported key length detection for type: %s", pkey.Type())
  231. }
  232. // CheckPublicKeyString checks if the given public key string is recognized by SSH.
  233. // It returns the actual public key line on success.
  234. func CheckPublicKeyString(content string) (_ string, err error) {
  235. if conf.SSH.Disabled {
  236. return "", errors.New("SSH is disabled")
  237. }
  238. content, err = parseKeyString(content)
  239. if err != nil {
  240. return "", err
  241. }
  242. content = strings.TrimRight(content, "\n\r")
  243. if strings.ContainsAny(content, "\n\r") {
  244. return "", errors.New("only a single line with a single key please")
  245. }
  246. // Remove any unnecessary whitespace
  247. content = strings.TrimSpace(content)
  248. if !conf.SSH.MinimumKeySizeCheck {
  249. return content, nil
  250. }
  251. var (
  252. fnName string
  253. keyType string
  254. length int
  255. )
  256. if conf.SSH.StartBuiltinServer {
  257. fnName = "SSHNativeParsePublicKey"
  258. keyType, length, err = SSHNativeParsePublicKey(content)
  259. } else {
  260. fnName = "SSHKeyGenParsePublicKey"
  261. keyType, length, err = SSHKeyGenParsePublicKey(content)
  262. }
  263. if err != nil {
  264. return "", errors.Newf("%s: %v", fnName, err)
  265. }
  266. log.Trace("Key info [native: %v]: %s-%d", conf.SSH.StartBuiltinServer, keyType, length)
  267. if minLen, found := conf.SSH.MinimumKeySizes[keyType]; found && length >= minLen {
  268. return content, nil
  269. } else if found && length < minLen {
  270. return "", errors.Newf("key length is not enough: got %d, needs %d", length, minLen)
  271. }
  272. return "", errors.Newf("key type is not allowed: %s", keyType)
  273. }
  274. // appendAuthorizedKeysToFile appends new SSH keys' content to authorized_keys file.
  275. func appendAuthorizedKeysToFile(keys ...*PublicKey) error {
  276. sshOpLocker.Lock()
  277. defer sshOpLocker.Unlock()
  278. fpath := filepath.Join(conf.SSH.RootPath, "authorized_keys")
  279. f, err := os.OpenFile(fpath, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0o600)
  280. if err != nil {
  281. return err
  282. }
  283. defer f.Close()
  284. // Note: chmod command does not support in Windows.
  285. if !conf.IsWindowsRuntime() {
  286. fi, err := f.Stat()
  287. if err != nil {
  288. return err
  289. }
  290. // .ssh directory should have mode 700, and authorized_keys file should have mode 600.
  291. if fi.Mode().Perm() > 0o600 {
  292. log.Error("authorized_keys file has unusual permission flags: %s - setting to -rw-------", fi.Mode().Perm().String())
  293. if err = f.Chmod(0o600); err != nil {
  294. return err
  295. }
  296. }
  297. }
  298. for _, key := range keys {
  299. if _, err = f.WriteString(key.AuthorizedString()); err != nil {
  300. return err
  301. }
  302. }
  303. return nil
  304. }
  305. // checkKeyContent onlys checks if key content has been used as public key,
  306. // it is OK to use same key as deploy key for multiple repositories/users.
  307. func checkKeyContent(content string) error {
  308. has, err := x.Get(&PublicKey{
  309. Content: content,
  310. Type: KeyTypeUser,
  311. })
  312. if err != nil {
  313. return err
  314. } else if has {
  315. return ErrKeyAlreadyExist{0, content}
  316. }
  317. return nil
  318. }
  319. func addKey(e Engine, key *PublicKey) (err error) {
  320. // Calculate fingerprint.
  321. tmpPath := strings.ReplaceAll(path.Join(os.TempDir(), fmt.Sprintf("%d", time.Now().Nanosecond()), "id_rsa.pub"), "\\", "/")
  322. _ = os.MkdirAll(path.Dir(tmpPath), os.ModePerm)
  323. if err = os.WriteFile(tmpPath, []byte(key.Content), 0o644); err != nil {
  324. return err
  325. }
  326. stdout, stderr, err := process.Exec("AddPublicKey", conf.SSH.KeygenPath, "-lf", tmpPath)
  327. if err != nil {
  328. return errors.Newf("fail to parse public key: %s - %s", err, stderr)
  329. } else if len(stdout) < 2 {
  330. return errors.New("not enough output for calculating fingerprint: " + stdout)
  331. }
  332. key.Fingerprint = strings.Split(stdout, " ")[1]
  333. // Save SSH key.
  334. if _, err = e.Insert(key); err != nil {
  335. return err
  336. }
  337. // Don't need to rewrite this file if builtin SSH server is enabled.
  338. if conf.SSH.StartBuiltinServer {
  339. return nil
  340. }
  341. return appendAuthorizedKeysToFile(key)
  342. }
  343. // AddPublicKey adds new public key to database and authorized_keys file.
  344. func AddPublicKey(ownerID int64, name, content string) (*PublicKey, error) {
  345. log.Trace("Add public key: %s", content)
  346. if err := checkKeyContent(content); err != nil {
  347. return nil, err
  348. }
  349. // Key name of same user cannot be duplicated.
  350. has, err := x.Where("owner_id = ? AND name = ?", ownerID, name).Get(new(PublicKey))
  351. if err != nil {
  352. return nil, err
  353. } else if has {
  354. return nil, ErrKeyNameAlreadyUsed{ownerID, name}
  355. }
  356. sess := x.NewSession()
  357. defer sess.Close()
  358. if err = sess.Begin(); err != nil {
  359. return nil, err
  360. }
  361. key := &PublicKey{
  362. OwnerID: ownerID,
  363. Name: name,
  364. Content: content,
  365. Mode: AccessModeWrite,
  366. Type: KeyTypeUser,
  367. }
  368. if err = addKey(sess, key); err != nil {
  369. return nil, errors.Newf("addKey: %v", err)
  370. }
  371. return key, sess.Commit()
  372. }
  373. // GetPublicKeyByID returns public key by given ID.
  374. func GetPublicKeyByID(keyID int64) (*PublicKey, error) {
  375. key := new(PublicKey)
  376. has, err := x.Id(keyID).Get(key)
  377. if err != nil {
  378. return nil, err
  379. } else if !has {
  380. return nil, ErrKeyNotExist{keyID}
  381. }
  382. return key, nil
  383. }
  384. // SearchPublicKeyByContent searches a public key using the content as prefix
  385. // (i.e. ignore the email part). It returns ErrKeyNotExist if no such key
  386. // exists.
  387. func SearchPublicKeyByContent(content string) (*PublicKey, error) {
  388. key := new(PublicKey)
  389. has, err := x.Where("content like ?", content+"%").Get(key)
  390. if err != nil {
  391. return nil, err
  392. } else if !has {
  393. return nil, ErrKeyNotExist{}
  394. }
  395. return key, nil
  396. }
  397. // ListPublicKeys returns a list of public keys belongs to given user.
  398. func ListPublicKeys(uid int64) ([]*PublicKey, error) {
  399. keys := make([]*PublicKey, 0, 5)
  400. return keys, x.Where("owner_id = ?", uid).Find(&keys)
  401. }
  402. // UpdatePublicKey updates given public key.
  403. func UpdatePublicKey(key *PublicKey) error {
  404. _, err := x.Id(key.ID).AllCols().Update(key)
  405. return err
  406. }
  407. // deletePublicKeys does the actual key deletion but does not update authorized_keys file.
  408. func deletePublicKeys(e *xorm.Session, keyIDs ...int64) error {
  409. if len(keyIDs) == 0 {
  410. return nil
  411. }
  412. _, err := e.In("id", keyIDs).Delete(new(PublicKey))
  413. return err
  414. }
  415. // DeletePublicKey deletes SSH key information both in database and authorized_keys file.
  416. func DeletePublicKey(doer *User, id int64) (err error) {
  417. key, err := GetPublicKeyByID(id)
  418. if err != nil {
  419. if IsErrKeyNotExist(err) {
  420. return nil
  421. }
  422. return errors.Newf("GetPublicKeyByID: %v", err)
  423. }
  424. // Check if user has access to delete this key.
  425. if !doer.IsAdmin && doer.ID != key.OwnerID {
  426. return ErrKeyAccessDenied{doer.ID, key.ID, "public"}
  427. }
  428. sess := x.NewSession()
  429. defer sess.Close()
  430. if err = sess.Begin(); err != nil {
  431. return err
  432. }
  433. if err = deletePublicKeys(sess, id); err != nil {
  434. return err
  435. }
  436. if err = sess.Commit(); err != nil {
  437. return err
  438. }
  439. return RewriteAuthorizedKeys()
  440. }
  441. // RewriteAuthorizedKeys removes any authorized key and rewrite all keys from database again.
  442. // Note: x.Iterate does not get latest data after insert/delete, so we have to call this function
  443. // outside any session scope independently.
  444. //
  445. // Deprecated: Use PublicKeys.RewriteAuthorizedKeys instead.
  446. func RewriteAuthorizedKeys() error {
  447. sshOpLocker.Lock()
  448. defer sshOpLocker.Unlock()
  449. log.Trace("Doing: RewriteAuthorizedKeys")
  450. _ = os.MkdirAll(conf.SSH.RootPath, os.ModePerm)
  451. fpath := authorizedKeysPath()
  452. tmpPath := fpath + ".tmp"
  453. f, err := os.OpenFile(tmpPath, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0o600)
  454. if err != nil {
  455. return err
  456. }
  457. defer os.Remove(tmpPath)
  458. err = x.Iterate(new(PublicKey), func(idx int, bean any) (err error) {
  459. _, err = f.WriteString((bean.(*PublicKey)).AuthorizedString())
  460. return err
  461. })
  462. _ = f.Close()
  463. if err != nil {
  464. return err
  465. }
  466. if com.IsExist(fpath) {
  467. if err = os.Remove(fpath); err != nil {
  468. return err
  469. }
  470. }
  471. if err = os.Rename(tmpPath, fpath); err != nil {
  472. return err
  473. }
  474. return nil
  475. }
  476. // ________ .__ ____ __.
  477. // \______ \ ____ ______ | | ____ ___.__.| |/ _|____ ___.__.
  478. // | | \_/ __ \\____ \| | / _ < | || <_/ __ < | |
  479. // | ` \ ___/| |_> > |_( <_> )___ || | \ ___/\___ |
  480. // /_______ /\___ > __/|____/\____// ____||____|__ \___ > ____|
  481. // \/ \/|__| \/ \/ \/\/
  482. // DeployKey represents deploy key information and its relation with repository.
  483. type DeployKey struct {
  484. ID int64
  485. KeyID int64 `xorm:"UNIQUE(s) INDEX"`
  486. RepoID int64 `xorm:"UNIQUE(s) INDEX"`
  487. Name string
  488. Fingerprint string
  489. Content string `xorm:"-" json:"-" gorm:"-"`
  490. Created time.Time `xorm:"-" json:"-" gorm:"-"`
  491. CreatedUnix int64
  492. Updated time.Time `xorm:"-" json:"-" gorm:"-"` // Note: Updated must below Created for AfterSet.
  493. UpdatedUnix int64
  494. HasRecentActivity bool `xorm:"-" json:"-" gorm:"-"`
  495. HasUsed bool `xorm:"-" json:"-" gorm:"-"`
  496. }
  497. func (k *DeployKey) BeforeInsert() {
  498. k.CreatedUnix = time.Now().Unix()
  499. }
  500. func (k *DeployKey) BeforeUpdate() {
  501. k.UpdatedUnix = time.Now().Unix()
  502. }
  503. func (k *DeployKey) AfterSet(colName string, _ xorm.Cell) {
  504. switch colName {
  505. case "created_unix":
  506. k.Created = time.Unix(k.CreatedUnix, 0).Local()
  507. case "updated_unix":
  508. k.Updated = time.Unix(k.UpdatedUnix, 0).Local()
  509. k.HasUsed = k.Updated.After(k.Created)
  510. k.HasRecentActivity = k.Updated.Add(7 * 24 * time.Hour).After(time.Now())
  511. }
  512. }
  513. // GetContent gets associated public key content.
  514. func (k *DeployKey) GetContent() error {
  515. pkey, err := GetPublicKeyByID(k.KeyID)
  516. if err != nil {
  517. return err
  518. }
  519. k.Content = pkey.Content
  520. return nil
  521. }
  522. func checkDeployKey(e Engine, keyID, repoID int64, name string) error {
  523. // Note: We want error detail, not just true or false here.
  524. has, err := e.Where("key_id = ? AND repo_id = ?", keyID, repoID).Get(new(DeployKey))
  525. if err != nil {
  526. return err
  527. } else if has {
  528. return ErrDeployKeyAlreadyExist{keyID, repoID}
  529. }
  530. has, err = e.Where("repo_id = ? AND name = ?", repoID, name).Get(new(DeployKey))
  531. if err != nil {
  532. return err
  533. } else if has {
  534. return ErrDeployKeyNameAlreadyUsed{repoID, name}
  535. }
  536. return nil
  537. }
  538. // addDeployKey adds new key-repo relation.
  539. func addDeployKey(e *xorm.Session, keyID, repoID int64, name, fingerprint string) (*DeployKey, error) {
  540. if err := checkDeployKey(e, keyID, repoID, name); err != nil {
  541. return nil, err
  542. }
  543. key := &DeployKey{
  544. KeyID: keyID,
  545. RepoID: repoID,
  546. Name: name,
  547. Fingerprint: fingerprint,
  548. }
  549. _, err := e.Insert(key)
  550. return key, err
  551. }
  552. // HasDeployKey returns true if public key is a deploy key of given repository.
  553. func HasDeployKey(keyID, repoID int64) bool {
  554. has, _ := x.Where("key_id = ? AND repo_id = ?", keyID, repoID).Get(new(DeployKey))
  555. return has
  556. }
  557. // AddDeployKey add new deploy key to database and authorized_keys file.
  558. func AddDeployKey(repoID int64, name, content string) (*DeployKey, error) {
  559. if err := checkKeyContent(content); err != nil {
  560. return nil, err
  561. }
  562. pkey := &PublicKey{
  563. Content: content,
  564. Mode: AccessModeRead,
  565. Type: KeyTypeDeploy,
  566. }
  567. has, err := x.Get(pkey)
  568. if err != nil {
  569. return nil, err
  570. }
  571. sess := x.NewSession()
  572. defer sess.Close()
  573. if err = sess.Begin(); err != nil {
  574. return nil, err
  575. }
  576. // First time use this deploy key.
  577. if !has {
  578. if err = addKey(sess, pkey); err != nil {
  579. return nil, errors.Newf("addKey: %v", err)
  580. }
  581. }
  582. key, err := addDeployKey(sess, pkey.ID, repoID, name, pkey.Fingerprint)
  583. if err != nil {
  584. return nil, errors.Newf("addDeployKey: %v", err)
  585. }
  586. return key, sess.Commit()
  587. }
  588. var _ errutil.NotFound = (*ErrDeployKeyNotExist)(nil)
  589. type ErrDeployKeyNotExist struct {
  590. args map[string]any
  591. }
  592. func IsErrDeployKeyNotExist(err error) bool {
  593. _, ok := err.(ErrDeployKeyNotExist)
  594. return ok
  595. }
  596. func (err ErrDeployKeyNotExist) Error() string {
  597. return fmt.Sprintf("deploy key does not exist: %v", err.args)
  598. }
  599. func (ErrDeployKeyNotExist) NotFound() bool {
  600. return true
  601. }
  602. // GetDeployKeyByID returns deploy key by given ID.
  603. func GetDeployKeyByID(id int64) (*DeployKey, error) {
  604. key := new(DeployKey)
  605. has, err := x.Id(id).Get(key)
  606. if err != nil {
  607. return nil, err
  608. } else if !has {
  609. return nil, ErrDeployKeyNotExist{args: map[string]any{"deployKeyID": id}}
  610. }
  611. return key, nil
  612. }
  613. // GetDeployKeyByRepo returns deploy key by given public key ID and repository ID.
  614. func GetDeployKeyByRepo(keyID, repoID int64) (*DeployKey, error) {
  615. key := &DeployKey{
  616. KeyID: keyID,
  617. RepoID: repoID,
  618. }
  619. has, err := x.Get(key)
  620. if err != nil {
  621. return nil, err
  622. } else if !has {
  623. return nil, ErrDeployKeyNotExist{args: map[string]any{"keyID": keyID, "repoID": repoID}}
  624. }
  625. return key, nil
  626. }
  627. // UpdateDeployKey updates deploy key information.
  628. func UpdateDeployKey(key *DeployKey) error {
  629. _, err := x.Id(key.ID).AllCols().Update(key)
  630. return err
  631. }
  632. // DeleteDeployKey deletes deploy key from its repository authorized_keys file if needed.
  633. func DeleteDeployKey(doer *User, id int64) error {
  634. key, err := GetDeployKeyByID(id)
  635. if err != nil {
  636. if IsErrDeployKeyNotExist(err) {
  637. return nil
  638. }
  639. return errors.Newf("GetDeployKeyByID: %v", err)
  640. }
  641. // Check if user has access to delete this key.
  642. if !doer.IsAdmin {
  643. repo, err := GetRepositoryByID(key.RepoID)
  644. if err != nil {
  645. return errors.Newf("GetRepositoryByID: %v", err)
  646. }
  647. if !Handle.Permissions().Authorize(context.TODO(), doer.ID, repo.ID, AccessModeAdmin,
  648. AccessModeOptions{
  649. OwnerID: repo.OwnerID,
  650. Private: repo.IsPrivate,
  651. },
  652. ) {
  653. return ErrKeyAccessDenied{doer.ID, key.ID, "deploy"}
  654. }
  655. }
  656. sess := x.NewSession()
  657. defer sess.Close()
  658. if err = sess.Begin(); err != nil {
  659. return err
  660. }
  661. if _, err = sess.ID(key.ID).Delete(new(DeployKey)); err != nil {
  662. return errors.Newf("delete deploy key [%d]: %v", key.ID, err)
  663. }
  664. // Check if this is the last reference to same key content.
  665. has, err := sess.Where("key_id = ?", key.KeyID).Get(new(DeployKey))
  666. if err != nil {
  667. return err
  668. } else if !has {
  669. if err = deletePublicKeys(sess, key.KeyID); err != nil {
  670. return err
  671. }
  672. }
  673. return sess.Commit()
  674. }
  675. // ListDeployKeys returns all deploy keys by given repository ID.
  676. func ListDeployKeys(repoID int64) ([]*DeployKey, error) {
  677. keys := make([]*DeployKey, 0, 5)
  678. return keys, x.Where("repo_id = ?", repoID).Find(&keys)
  679. }