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