You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

ssh_key.go 21KB

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