2014-11-12 06:48:50 -05:00
|
|
|
// Copyright 2014 The Gogs Authors. All rights reserved.
|
2019-05-04 10:45:34 -05:00
|
|
|
// Copyright 2019 The Gitea Authors. All rights reserved.
|
2022-11-27 13:20:29 -05:00
|
|
|
// SPDX-License-Identifier: MIT
|
2014-11-12 06:48:50 -05:00
|
|
|
|
2022-08-24 21:31:57 -05:00
|
|
|
package auth
|
2014-11-12 06:48:50 -05:00
|
|
|
|
|
|
|
import (
|
2019-05-04 10:45:34 -05:00
|
|
|
"crypto/subtle"
|
2022-11-28 10:37:42 -05:00
|
|
|
"encoding/hex"
|
2021-09-19 06:49:59 -05:00
|
|
|
"fmt"
|
2014-11-12 06:48:50 -05:00
|
|
|
"time"
|
|
|
|
|
2021-09-19 06:49:59 -05:00
|
|
|
"code.gitea.io/gitea/models/db"
|
|
|
|
"code.gitea.io/gitea/modules/setting"
|
2019-08-15 09:46:21 -05:00
|
|
|
"code.gitea.io/gitea/modules/timeutil"
|
2021-05-10 01:45:17 -05:00
|
|
|
"code.gitea.io/gitea/modules/util"
|
2019-08-15 09:46:21 -05:00
|
|
|
|
2023-07-13 22:00:31 -05:00
|
|
|
lru "github.com/hashicorp/golang-lru/v2"
|
2014-11-12 06:48:50 -05:00
|
|
|
)
|
|
|
|
|
2022-08-24 21:31:57 -05:00
|
|
|
// ErrAccessTokenNotExist represents a "AccessTokenNotExist" kind of error.
|
|
|
|
type ErrAccessTokenNotExist struct {
|
|
|
|
Token string
|
|
|
|
}
|
|
|
|
|
|
|
|
// IsErrAccessTokenNotExist checks if an error is a ErrAccessTokenNotExist.
|
|
|
|
func IsErrAccessTokenNotExist(err error) bool {
|
|
|
|
_, ok := err.(ErrAccessTokenNotExist)
|
|
|
|
return ok
|
|
|
|
}
|
|
|
|
|
|
|
|
func (err ErrAccessTokenNotExist) Error() string {
|
|
|
|
return fmt.Sprintf("access token does not exist [sha: %s]", err.Token)
|
|
|
|
}
|
|
|
|
|
2022-10-18 00:50:37 -05:00
|
|
|
func (err ErrAccessTokenNotExist) Unwrap() error {
|
|
|
|
return util.ErrNotExist
|
|
|
|
}
|
|
|
|
|
2022-08-24 21:31:57 -05:00
|
|
|
// ErrAccessTokenEmpty represents a "AccessTokenEmpty" kind of error.
|
|
|
|
type ErrAccessTokenEmpty struct{}
|
|
|
|
|
|
|
|
// IsErrAccessTokenEmpty checks if an error is a ErrAccessTokenEmpty.
|
|
|
|
func IsErrAccessTokenEmpty(err error) bool {
|
|
|
|
_, ok := err.(ErrAccessTokenEmpty)
|
|
|
|
return ok
|
|
|
|
}
|
|
|
|
|
|
|
|
func (err ErrAccessTokenEmpty) Error() string {
|
|
|
|
return "access token is empty"
|
|
|
|
}
|
|
|
|
|
2022-10-18 00:50:37 -05:00
|
|
|
func (err ErrAccessTokenEmpty) Unwrap() error {
|
|
|
|
return util.ErrInvalidArgument
|
|
|
|
}
|
|
|
|
|
2023-07-13 22:00:31 -05:00
|
|
|
var successfulAccessTokenCache *lru.Cache[string, any]
|
2021-08-17 13:30:42 -05:00
|
|
|
|
2014-11-12 06:48:50 -05:00
|
|
|
// AccessToken represents a personal access token.
|
|
|
|
type AccessToken struct {
|
2019-05-04 10:45:34 -05:00
|
|
|
ID int64 `xorm:"pk autoincr"`
|
|
|
|
UID int64 `xorm:"INDEX"`
|
|
|
|
Name string
|
|
|
|
Token string `xorm:"-"`
|
|
|
|
TokenHash string `xorm:"UNIQUE"` // sha256 of token
|
|
|
|
TokenSalt string
|
2022-11-23 21:49:41 -05:00
|
|
|
TokenLastEight string `xorm:"INDEX token_last_eight"`
|
2023-01-17 16:46:03 -05:00
|
|
|
Scope AccessTokenScope
|
2016-03-09 19:53:30 -05:00
|
|
|
|
2019-08-15 09:46:21 -05:00
|
|
|
CreatedUnix timeutil.TimeStamp `xorm:"INDEX created"`
|
|
|
|
UpdatedUnix timeutil.TimeStamp `xorm:"INDEX updated"`
|
|
|
|
HasRecentActivity bool `xorm:"-"`
|
|
|
|
HasUsed bool `xorm:"-"`
|
2014-11-12 06:48:50 -05:00
|
|
|
}
|
|
|
|
|
2017-10-01 11:52:35 -05:00
|
|
|
// AfterLoad is invoked from XORM after setting the values of all fields of this object.
|
|
|
|
func (t *AccessToken) AfterLoad() {
|
2017-12-10 23:37:04 -05:00
|
|
|
t.HasUsed = t.UpdatedUnix > t.CreatedUnix
|
2019-08-15 09:46:21 -05:00
|
|
|
t.HasRecentActivity = t.UpdatedUnix.AddDuration(7*24*time.Hour) > timeutil.TimeStampNow()
|
2016-03-09 19:53:30 -05:00
|
|
|
}
|
|
|
|
|
2021-09-19 06:49:59 -05:00
|
|
|
func init() {
|
|
|
|
db.RegisterModel(new(AccessToken), func() error {
|
|
|
|
if setting.SuccessfulTokensCacheSize > 0 {
|
|
|
|
var err error
|
2023-07-13 22:00:31 -05:00
|
|
|
successfulAccessTokenCache, err = lru.New[string, any](setting.SuccessfulTokensCacheSize)
|
2021-09-19 06:49:59 -05:00
|
|
|
if err != nil {
|
2022-10-24 14:29:17 -05:00
|
|
|
return fmt.Errorf("unable to allocate AccessToken cache: %w", err)
|
2021-09-19 06:49:59 -05:00
|
|
|
}
|
|
|
|
} else {
|
|
|
|
successfulAccessTokenCache = nil
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2014-11-12 06:48:50 -05:00
|
|
|
// NewAccessToken creates new access token.
|
|
|
|
func NewAccessToken(t *AccessToken) error {
|
2022-01-25 23:10:10 -05:00
|
|
|
salt, err := util.CryptoRandomString(10)
|
2019-05-04 10:45:34 -05:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2022-11-28 10:37:42 -05:00
|
|
|
token, err := util.CryptoRandomBytes(20)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2019-05-04 10:45:34 -05:00
|
|
|
t.TokenSalt = salt
|
2022-11-28 10:37:42 -05:00
|
|
|
t.Token = hex.EncodeToString(token)
|
2022-08-24 21:31:57 -05:00
|
|
|
t.TokenHash = HashToken(t.Token, t.TokenSalt)
|
2019-05-04 10:45:34 -05:00
|
|
|
t.TokenLastEight = t.Token[len(t.Token)-8:]
|
2021-09-23 10:45:36 -05:00
|
|
|
_, err = db.GetEngine(db.DefaultContext).Insert(t)
|
2014-11-12 06:48:50 -05:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
Redesign Scoped Access Tokens (#24767)
## Changes
- Adds the following high level access scopes, each with `read` and
`write` levels:
- `activitypub`
- `admin` (hidden if user is not a site admin)
- `misc`
- `notification`
- `organization`
- `package`
- `issue`
- `repository`
- `user`
- Adds new middleware function `tokenRequiresScopes()` in addition to
`reqToken()`
- `tokenRequiresScopes()` is used for each high-level api section
- _if_ a scoped token is present, checks that the required scope is
included based on the section and HTTP method
- `reqToken()` is used for individual routes
- checks that required authentication is present (but does not check
scope levels as this will already have been handled by
`tokenRequiresScopes()`
- Adds migration to convert old scoped access tokens to the new set of
scopes
- Updates the user interface for scope selection
### User interface example
<img width="903" alt="Screen Shot 2023-05-31 at 1 56 55 PM"
src="https://github.com/go-gitea/gitea/assets/23248839/654766ec-2143-4f59-9037-3b51600e32f3">
<img width="917" alt="Screen Shot 2023-05-31 at 1 56 43 PM"
src="https://github.com/go-gitea/gitea/assets/23248839/1ad64081-012c-4a73-b393-66b30352654c">
## tokenRequiresScopes Design Decision
- `tokenRequiresScopes()` was added to more reliably cover api routes.
For an incoming request, this function uses the given scope category
(say `AccessTokenScopeCategoryOrganization`) and the HTTP method (say
`DELETE`) and verifies that any scoped tokens in use include
`delete:organization`.
- `reqToken()` is used to enforce auth for individual routes that
require it. If a scoped token is not present for a request,
`tokenRequiresScopes()` will not return an error
## TODO
- [x] Alphabetize scope categories
- [x] Change 'public repos only' to a radio button (private vs public).
Also expand this to organizations
- [X] Disable token creation if no scopes selected. Alternatively, show
warning
- [x] `reqToken()` is missing from many `POST/DELETE` routes in the api.
`tokenRequiresScopes()` only checks that a given token has the correct
scope, `reqToken()` must be used to check that a token (or some other
auth) is present.
- _This should be addressed in this PR_
- [x] The migration should be reviewed very carefully in order to
minimize access changes to existing user tokens.
- _This should be addressed in this PR_
- [x] Link to api to swagger documentation, clarify what
read/write/delete levels correspond to
- [x] Review cases where more than one scope is needed as this directly
deviates from the api definition.
- _This should be addressed in this PR_
- For example:
```go
m.Group("/users/{username}/orgs", func() {
m.Get("", reqToken(), org.ListUserOrgs)
m.Get("/{org}/permissions", reqToken(), org.GetUserOrgsPermissions)
}, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryUser,
auth_model.AccessTokenScopeCategoryOrganization),
context_service.UserAssignmentAPI())
```
## Future improvements
- [ ] Add required scopes to swagger documentation
- [ ] Redesign `reqToken()` to be opt-out rather than opt-in
- [ ] Subdivide scopes like `repository`
- [ ] Once a token is created, if it has no scopes, we should display
text instead of an empty bullet point
- [ ] If the 'public repos only' option is selected, should read
categories be selected by default
Closes #24501
Closes #24799
Co-authored-by: Jonathan Tran <jon@allspice.io>
Co-authored-by: Kyle D <kdumontnu@gmail.com>
Co-authored-by: silverwind <me@silverwind.io>
2023-06-04 13:57:16 -05:00
|
|
|
// DisplayPublicOnly whether to display this as a public-only token.
|
|
|
|
func (t *AccessToken) DisplayPublicOnly() bool {
|
|
|
|
publicOnly, err := t.Scope.PublicOnly()
|
|
|
|
if err != nil {
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
return publicOnly
|
|
|
|
}
|
|
|
|
|
2021-08-17 13:30:42 -05:00
|
|
|
func getAccessTokenIDFromCache(token string) int64 {
|
|
|
|
if successfulAccessTokenCache == nil {
|
|
|
|
return 0
|
|
|
|
}
|
|
|
|
tInterface, ok := successfulAccessTokenCache.Get(token)
|
|
|
|
if !ok {
|
|
|
|
return 0
|
|
|
|
}
|
|
|
|
t, ok := tInterface.(int64)
|
|
|
|
if !ok {
|
|
|
|
return 0
|
|
|
|
}
|
|
|
|
return t
|
|
|
|
}
|
|
|
|
|
2019-05-04 10:45:34 -05:00
|
|
|
// GetAccessTokenBySHA returns access token by given token value
|
|
|
|
func GetAccessTokenBySHA(token string) (*AccessToken, error) {
|
|
|
|
if token == "" {
|
2016-06-27 04:02:39 -05:00
|
|
|
return nil, ErrAccessTokenEmpty{}
|
|
|
|
}
|
2021-06-15 17:29:25 -05:00
|
|
|
// A token is defined as being SHA1 sum these are 40 hexadecimal bytes long
|
|
|
|
if len(token) != 40 {
|
2019-05-04 10:45:34 -05:00
|
|
|
return nil, ErrAccessTokenNotExist{token}
|
|
|
|
}
|
2021-06-15 17:29:25 -05:00
|
|
|
for _, x := range []byte(token) {
|
|
|
|
if x < '0' || (x > '9' && x < 'a') || x > 'f' {
|
|
|
|
return nil, ErrAccessTokenNotExist{token}
|
|
|
|
}
|
|
|
|
}
|
2021-08-17 13:30:42 -05:00
|
|
|
|
2019-05-04 10:45:34 -05:00
|
|
|
lastEight := token[len(token)-8:]
|
2021-08-17 13:30:42 -05:00
|
|
|
|
|
|
|
if id := getAccessTokenIDFromCache(token); id > 0 {
|
2023-07-13 22:00:31 -05:00
|
|
|
accessToken := &AccessToken{
|
2021-08-17 13:30:42 -05:00
|
|
|
TokenLastEight: lastEight,
|
|
|
|
}
|
|
|
|
// Re-get the token from the db in case it has been deleted in the intervening period
|
2023-07-13 22:00:31 -05:00
|
|
|
has, err := db.GetEngine(db.DefaultContext).ID(id).Get(accessToken)
|
2021-08-17 13:30:42 -05:00
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
if has {
|
2023-07-13 22:00:31 -05:00
|
|
|
return accessToken, nil
|
2021-08-17 13:30:42 -05:00
|
|
|
}
|
|
|
|
successfulAccessTokenCache.Remove(token)
|
|
|
|
}
|
|
|
|
|
|
|
|
var tokens []AccessToken
|
2021-09-23 10:45:36 -05:00
|
|
|
err := db.GetEngine(db.DefaultContext).Table(&AccessToken{}).Where("token_last_eight = ?", lastEight).Find(&tokens)
|
2014-11-12 06:48:50 -05:00
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
2019-05-04 10:45:34 -05:00
|
|
|
} else if len(tokens) == 0 {
|
|
|
|
return nil, ErrAccessTokenNotExist{token}
|
|
|
|
}
|
2021-08-17 13:30:42 -05:00
|
|
|
|
2019-05-04 10:45:34 -05:00
|
|
|
for _, t := range tokens {
|
2022-08-24 21:31:57 -05:00
|
|
|
tempHash := HashToken(token, t.TokenSalt)
|
2019-05-04 10:45:34 -05:00
|
|
|
if subtle.ConstantTimeCompare([]byte(t.TokenHash), []byte(tempHash)) == 1 {
|
2021-08-17 13:30:42 -05:00
|
|
|
if successfulAccessTokenCache != nil {
|
|
|
|
successfulAccessTokenCache.Add(token, t.ID)
|
|
|
|
}
|
2019-05-04 10:45:34 -05:00
|
|
|
return &t, nil
|
|
|
|
}
|
2014-11-12 06:48:50 -05:00
|
|
|
}
|
2019-05-04 10:45:34 -05:00
|
|
|
return nil, ErrAccessTokenNotExist{token}
|
2014-11-12 06:48:50 -05:00
|
|
|
}
|
|
|
|
|
2020-04-13 14:02:48 -05:00
|
|
|
// AccessTokenByNameExists checks if a token name has been used already by a user.
|
|
|
|
func AccessTokenByNameExists(token *AccessToken) (bool, error) {
|
2021-09-23 10:45:36 -05:00
|
|
|
return db.GetEngine(db.DefaultContext).Table("access_token").Where("name = ?", token.Name).And("uid = ?", token.UID).Exist()
|
2020-04-13 14:02:48 -05:00
|
|
|
}
|
|
|
|
|
2020-08-28 03:09:33 -05:00
|
|
|
// ListAccessTokensOptions contain filter options
|
|
|
|
type ListAccessTokensOptions struct {
|
2021-09-24 06:32:56 -05:00
|
|
|
db.ListOptions
|
2020-08-28 03:09:33 -05:00
|
|
|
Name string
|
|
|
|
UserID int64
|
|
|
|
}
|
|
|
|
|
2014-11-12 06:48:50 -05:00
|
|
|
// ListAccessTokens returns a list of access tokens belongs to given user.
|
2020-08-28 03:09:33 -05:00
|
|
|
func ListAccessTokens(opts ListAccessTokensOptions) ([]*AccessToken, error) {
|
2021-09-23 10:45:36 -05:00
|
|
|
sess := db.GetEngine(db.DefaultContext).Where("uid=?", opts.UserID)
|
2020-08-28 03:09:33 -05:00
|
|
|
|
|
|
|
if len(opts.Name) != 0 {
|
|
|
|
sess = sess.Where("name=?", opts.Name)
|
|
|
|
}
|
|
|
|
|
2021-10-06 15:36:24 -05:00
|
|
|
sess = sess.Desc("created_unix")
|
2020-01-24 14:00:29 -05:00
|
|
|
|
2020-08-28 03:09:33 -05:00
|
|
|
if opts.Page != 0 {
|
2021-09-24 06:32:56 -05:00
|
|
|
sess = db.SetSessionPagination(sess, &opts)
|
2020-01-24 14:00:29 -05:00
|
|
|
|
2020-08-28 03:09:33 -05:00
|
|
|
tokens := make([]*AccessToken, 0, opts.PageSize)
|
2020-01-24 14:00:29 -05:00
|
|
|
return tokens, sess.Find(&tokens)
|
|
|
|
}
|
|
|
|
|
|
|
|
tokens := make([]*AccessToken, 0, 5)
|
|
|
|
return tokens, sess.Find(&tokens)
|
2014-11-12 06:48:50 -05:00
|
|
|
}
|
|
|
|
|
2016-01-06 14:41:42 -05:00
|
|
|
// UpdateAccessToken updates information of access token.
|
|
|
|
func UpdateAccessToken(t *AccessToken) error {
|
2021-09-23 10:45:36 -05:00
|
|
|
_, err := db.GetEngine(db.DefaultContext).ID(t.ID).AllCols().Update(t)
|
2015-08-18 17:22:33 -05:00
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2021-08-12 07:43:08 -05:00
|
|
|
// CountAccessTokens count access tokens belongs to given user by options
|
|
|
|
func CountAccessTokens(opts ListAccessTokensOptions) (int64, error) {
|
2021-09-23 10:45:36 -05:00
|
|
|
sess := db.GetEngine(db.DefaultContext).Where("uid=?", opts.UserID)
|
2021-08-12 07:43:08 -05:00
|
|
|
if len(opts.Name) != 0 {
|
|
|
|
sess = sess.Where("name=?", opts.Name)
|
|
|
|
}
|
|
|
|
return sess.Count(&AccessToken{})
|
|
|
|
}
|
|
|
|
|
2015-08-18 14:36:16 -05:00
|
|
|
// DeleteAccessTokenByID deletes access token by given ID.
|
2016-12-15 03:49:06 -05:00
|
|
|
func DeleteAccessTokenByID(id, userID int64) error {
|
2021-09-23 10:45:36 -05:00
|
|
|
cnt, err := db.GetEngine(db.DefaultContext).ID(id).Delete(&AccessToken{
|
2016-12-15 03:49:06 -05:00
|
|
|
UID: userID,
|
|
|
|
})
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
} else if cnt != 1 {
|
|
|
|
return ErrAccessTokenNotExist{}
|
|
|
|
}
|
|
|
|
return nil
|
2014-11-12 06:48:50 -05:00
|
|
|
}
|