mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-12-04 23:22:51 +01:00
18de83b2a3
## 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>
250 lines
6.7 KiB
Go
250 lines
6.7 KiB
Go
// Copyright 2014 The Gogs Authors. All rights reserved.
|
|
// Copyright 2019 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package auth
|
|
|
|
import (
|
|
"crypto/subtle"
|
|
"encoding/hex"
|
|
"fmt"
|
|
"time"
|
|
|
|
"code.gitea.io/gitea/models/db"
|
|
"code.gitea.io/gitea/modules/setting"
|
|
"code.gitea.io/gitea/modules/timeutil"
|
|
"code.gitea.io/gitea/modules/util"
|
|
|
|
lru "github.com/hashicorp/golang-lru"
|
|
)
|
|
|
|
// 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)
|
|
}
|
|
|
|
func (err ErrAccessTokenNotExist) Unwrap() error {
|
|
return util.ErrNotExist
|
|
}
|
|
|
|
// 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"
|
|
}
|
|
|
|
func (err ErrAccessTokenEmpty) Unwrap() error {
|
|
return util.ErrInvalidArgument
|
|
}
|
|
|
|
var successfulAccessTokenCache *lru.Cache
|
|
|
|
// AccessToken represents a personal access token.
|
|
type AccessToken struct {
|
|
ID int64 `xorm:"pk autoincr"`
|
|
UID int64 `xorm:"INDEX"`
|
|
Name string
|
|
Token string `xorm:"-"`
|
|
TokenHash string `xorm:"UNIQUE"` // sha256 of token
|
|
TokenSalt string
|
|
TokenLastEight string `xorm:"INDEX token_last_eight"`
|
|
Scope AccessTokenScope
|
|
|
|
CreatedUnix timeutil.TimeStamp `xorm:"INDEX created"`
|
|
UpdatedUnix timeutil.TimeStamp `xorm:"INDEX updated"`
|
|
HasRecentActivity bool `xorm:"-"`
|
|
HasUsed bool `xorm:"-"`
|
|
}
|
|
|
|
// AfterLoad is invoked from XORM after setting the values of all fields of this object.
|
|
func (t *AccessToken) AfterLoad() {
|
|
t.HasUsed = t.UpdatedUnix > t.CreatedUnix
|
|
t.HasRecentActivity = t.UpdatedUnix.AddDuration(7*24*time.Hour) > timeutil.TimeStampNow()
|
|
}
|
|
|
|
func init() {
|
|
db.RegisterModel(new(AccessToken), func() error {
|
|
if setting.SuccessfulTokensCacheSize > 0 {
|
|
var err error
|
|
successfulAccessTokenCache, err = lru.New(setting.SuccessfulTokensCacheSize)
|
|
if err != nil {
|
|
return fmt.Errorf("unable to allocate AccessToken cache: %w", err)
|
|
}
|
|
} else {
|
|
successfulAccessTokenCache = nil
|
|
}
|
|
return nil
|
|
})
|
|
}
|
|
|
|
// NewAccessToken creates new access token.
|
|
func NewAccessToken(t *AccessToken) error {
|
|
salt, err := util.CryptoRandomString(10)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
token, err := util.CryptoRandomBytes(20)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
t.TokenSalt = salt
|
|
t.Token = hex.EncodeToString(token)
|
|
t.TokenHash = HashToken(t.Token, t.TokenSalt)
|
|
t.TokenLastEight = t.Token[len(t.Token)-8:]
|
|
_, err = db.GetEngine(db.DefaultContext).Insert(t)
|
|
return err
|
|
}
|
|
|
|
// 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
|
|
}
|
|
|
|
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
|
|
}
|
|
|
|
// GetAccessTokenBySHA returns access token by given token value
|
|
func GetAccessTokenBySHA(token string) (*AccessToken, error) {
|
|
if token == "" {
|
|
return nil, ErrAccessTokenEmpty{}
|
|
}
|
|
// A token is defined as being SHA1 sum these are 40 hexadecimal bytes long
|
|
if len(token) != 40 {
|
|
return nil, ErrAccessTokenNotExist{token}
|
|
}
|
|
for _, x := range []byte(token) {
|
|
if x < '0' || (x > '9' && x < 'a') || x > 'f' {
|
|
return nil, ErrAccessTokenNotExist{token}
|
|
}
|
|
}
|
|
|
|
lastEight := token[len(token)-8:]
|
|
|
|
if id := getAccessTokenIDFromCache(token); id > 0 {
|
|
token := &AccessToken{
|
|
TokenLastEight: lastEight,
|
|
}
|
|
// Re-get the token from the db in case it has been deleted in the intervening period
|
|
has, err := db.GetEngine(db.DefaultContext).ID(id).Get(token)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if has {
|
|
return token, nil
|
|
}
|
|
successfulAccessTokenCache.Remove(token)
|
|
}
|
|
|
|
var tokens []AccessToken
|
|
err := db.GetEngine(db.DefaultContext).Table(&AccessToken{}).Where("token_last_eight = ?", lastEight).Find(&tokens)
|
|
if err != nil {
|
|
return nil, err
|
|
} else if len(tokens) == 0 {
|
|
return nil, ErrAccessTokenNotExist{token}
|
|
}
|
|
|
|
for _, t := range tokens {
|
|
tempHash := HashToken(token, t.TokenSalt)
|
|
if subtle.ConstantTimeCompare([]byte(t.TokenHash), []byte(tempHash)) == 1 {
|
|
if successfulAccessTokenCache != nil {
|
|
successfulAccessTokenCache.Add(token, t.ID)
|
|
}
|
|
return &t, nil
|
|
}
|
|
}
|
|
return nil, ErrAccessTokenNotExist{token}
|
|
}
|
|
|
|
// AccessTokenByNameExists checks if a token name has been used already by a user.
|
|
func AccessTokenByNameExists(token *AccessToken) (bool, error) {
|
|
return db.GetEngine(db.DefaultContext).Table("access_token").Where("name = ?", token.Name).And("uid = ?", token.UID).Exist()
|
|
}
|
|
|
|
// ListAccessTokensOptions contain filter options
|
|
type ListAccessTokensOptions struct {
|
|
db.ListOptions
|
|
Name string
|
|
UserID int64
|
|
}
|
|
|
|
// ListAccessTokens returns a list of access tokens belongs to given user.
|
|
func ListAccessTokens(opts ListAccessTokensOptions) ([]*AccessToken, error) {
|
|
sess := db.GetEngine(db.DefaultContext).Where("uid=?", opts.UserID)
|
|
|
|
if len(opts.Name) != 0 {
|
|
sess = sess.Where("name=?", opts.Name)
|
|
}
|
|
|
|
sess = sess.Desc("created_unix")
|
|
|
|
if opts.Page != 0 {
|
|
sess = db.SetSessionPagination(sess, &opts)
|
|
|
|
tokens := make([]*AccessToken, 0, opts.PageSize)
|
|
return tokens, sess.Find(&tokens)
|
|
}
|
|
|
|
tokens := make([]*AccessToken, 0, 5)
|
|
return tokens, sess.Find(&tokens)
|
|
}
|
|
|
|
// UpdateAccessToken updates information of access token.
|
|
func UpdateAccessToken(t *AccessToken) error {
|
|
_, err := db.GetEngine(db.DefaultContext).ID(t.ID).AllCols().Update(t)
|
|
return err
|
|
}
|
|
|
|
// CountAccessTokens count access tokens belongs to given user by options
|
|
func CountAccessTokens(opts ListAccessTokensOptions) (int64, error) {
|
|
sess := db.GetEngine(db.DefaultContext).Where("uid=?", opts.UserID)
|
|
if len(opts.Name) != 0 {
|
|
sess = sess.Where("name=?", opts.Name)
|
|
}
|
|
return sess.Count(&AccessToken{})
|
|
}
|
|
|
|
// DeleteAccessTokenByID deletes access token by given ID.
|
|
func DeleteAccessTokenByID(id, userID int64) error {
|
|
cnt, err := db.GetEngine(db.DefaultContext).ID(id).Delete(&AccessToken{
|
|
UID: userID,
|
|
})
|
|
if err != nil {
|
|
return err
|
|
} else if cnt != 1 {
|
|
return ErrAccessTokenNotExist{}
|
|
}
|
|
return nil
|
|
}
|