mirror of
				https://gitee.com/gitea/gitea
				synced 2025-11-04 16:40:24 +08:00 
			
		
		
		
	## 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>
		
	
		
			
				
	
	
		
			114 lines
		
	
	
		
			3.1 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			114 lines
		
	
	
		
			3.1 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
// Copyright 2014 The Gogs Authors. All rights reserved.
 | 
						|
// Copyright 2018 The Gitea Authors. All rights reserved.
 | 
						|
// SPDX-License-Identifier: MIT
 | 
						|
 | 
						|
package setting
 | 
						|
 | 
						|
import (
 | 
						|
	"net/http"
 | 
						|
 | 
						|
	auth_model "code.gitea.io/gitea/models/auth"
 | 
						|
	"code.gitea.io/gitea/modules/base"
 | 
						|
	"code.gitea.io/gitea/modules/context"
 | 
						|
	"code.gitea.io/gitea/modules/setting"
 | 
						|
	"code.gitea.io/gitea/modules/web"
 | 
						|
	"code.gitea.io/gitea/services/forms"
 | 
						|
)
 | 
						|
 | 
						|
const (
 | 
						|
	tplSettingsApplications base.TplName = "user/settings/applications"
 | 
						|
)
 | 
						|
 | 
						|
// Applications render manage access token page
 | 
						|
func Applications(ctx *context.Context) {
 | 
						|
	ctx.Data["Title"] = ctx.Tr("settings.applications")
 | 
						|
	ctx.Data["PageIsSettingsApplications"] = true
 | 
						|
 | 
						|
	loadApplicationsData(ctx)
 | 
						|
 | 
						|
	ctx.HTML(http.StatusOK, tplSettingsApplications)
 | 
						|
}
 | 
						|
 | 
						|
// ApplicationsPost response for add user's access token
 | 
						|
func ApplicationsPost(ctx *context.Context) {
 | 
						|
	form := web.GetForm(ctx).(*forms.NewAccessTokenForm)
 | 
						|
	ctx.Data["Title"] = ctx.Tr("settings")
 | 
						|
	ctx.Data["PageIsSettingsApplications"] = true
 | 
						|
 | 
						|
	if ctx.HasError() {
 | 
						|
		loadApplicationsData(ctx)
 | 
						|
 | 
						|
		ctx.HTML(http.StatusOK, tplSettingsApplications)
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	scope, err := form.GetScope()
 | 
						|
	if err != nil {
 | 
						|
		ctx.ServerError("GetScope", err)
 | 
						|
		return
 | 
						|
	}
 | 
						|
	t := &auth_model.AccessToken{
 | 
						|
		UID:   ctx.Doer.ID,
 | 
						|
		Name:  form.Name,
 | 
						|
		Scope: scope,
 | 
						|
	}
 | 
						|
 | 
						|
	exist, err := auth_model.AccessTokenByNameExists(t)
 | 
						|
	if err != nil {
 | 
						|
		ctx.ServerError("AccessTokenByNameExists", err)
 | 
						|
		return
 | 
						|
	}
 | 
						|
	if exist {
 | 
						|
		ctx.Flash.Error(ctx.Tr("settings.generate_token_name_duplicate", t.Name))
 | 
						|
		ctx.Redirect(setting.AppSubURL + "/user/settings/applications")
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	if err := auth_model.NewAccessToken(t); err != nil {
 | 
						|
		ctx.ServerError("NewAccessToken", err)
 | 
						|
		return
 | 
						|
	}
 | 
						|
 | 
						|
	ctx.Flash.Success(ctx.Tr("settings.generate_token_success"))
 | 
						|
	ctx.Flash.Info(t.Token)
 | 
						|
 | 
						|
	ctx.Redirect(setting.AppSubURL + "/user/settings/applications")
 | 
						|
}
 | 
						|
 | 
						|
// DeleteApplication response for delete user access token
 | 
						|
func DeleteApplication(ctx *context.Context) {
 | 
						|
	if err := auth_model.DeleteAccessTokenByID(ctx.FormInt64("id"), ctx.Doer.ID); err != nil {
 | 
						|
		ctx.Flash.Error("DeleteAccessTokenByID: " + err.Error())
 | 
						|
	} else {
 | 
						|
		ctx.Flash.Success(ctx.Tr("settings.delete_token_success"))
 | 
						|
	}
 | 
						|
 | 
						|
	ctx.JSON(http.StatusOK, map[string]interface{}{
 | 
						|
		"redirect": setting.AppSubURL + "/user/settings/applications",
 | 
						|
	})
 | 
						|
}
 | 
						|
 | 
						|
func loadApplicationsData(ctx *context.Context) {
 | 
						|
	ctx.Data["AccessTokenScopePublicOnly"] = auth_model.AccessTokenScopePublicOnly
 | 
						|
	tokens, err := auth_model.ListAccessTokens(auth_model.ListAccessTokensOptions{UserID: ctx.Doer.ID})
 | 
						|
	if err != nil {
 | 
						|
		ctx.ServerError("ListAccessTokens", err)
 | 
						|
		return
 | 
						|
	}
 | 
						|
	ctx.Data["Tokens"] = tokens
 | 
						|
	ctx.Data["EnableOAuth2"] = setting.OAuth2.Enable
 | 
						|
	ctx.Data["IsAdmin"] = ctx.Doer.IsAdmin
 | 
						|
	if setting.OAuth2.Enable {
 | 
						|
		ctx.Data["Applications"], err = auth_model.GetOAuth2ApplicationsByUserID(ctx, ctx.Doer.ID)
 | 
						|
		if err != nil {
 | 
						|
			ctx.ServerError("GetOAuth2ApplicationsByUserID", err)
 | 
						|
			return
 | 
						|
		}
 | 
						|
		ctx.Data["Grants"], err = auth_model.GetOAuth2GrantsByUserID(ctx, ctx.Doer.ID)
 | 
						|
		if err != nil {
 | 
						|
			ctx.ServerError("GetOAuth2GrantsByUserID", err)
 | 
						|
			return
 | 
						|
		}
 | 
						|
	}
 | 
						|
}
 |