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

ssh_key.go 22 kB

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