2018-05-17 07:05:00 +03:00
// Copyright 2014 The Gogs Authors. All rights reserved.
// Copyright 2018 The Gitea Authors. All rights reserved.
2022-11-27 21:20:29 +03:00
// SPDX-License-Identifier: MIT
2018-05-17 07:05:00 +03:00
package setting
import (
2021-04-05 18:30:52 +03:00
"net/http"
2022-08-25 05:31:57 +03:00
auth_model "code.gitea.io/gitea/models/auth"
2023-11-24 06:49:41 +03:00
"code.gitea.io/gitea/models/db"
2024-07-09 20:36:31 +03:00
user_model "code.gitea.io/gitea/models/user"
2018-05-17 07:05:00 +03:00
"code.gitea.io/gitea/modules/base"
"code.gitea.io/gitea/modules/setting"
2021-01-26 18:36:53 +03:00
"code.gitea.io/gitea/modules/web"
2024-02-27 10:12:22 +03:00
"code.gitea.io/gitea/services/context"
2021-04-06 22:44:05 +03:00
"code.gitea.io/gitea/services/forms"
2018-05-17 07:05:00 +03:00
)
const (
tplSettingsApplications base . TplName = "user/settings/applications"
)
// Applications render manage access token page
func Applications ( ctx * context . Context ) {
2023-02-02 01:56:10 +03:00
ctx . Data [ "Title" ] = ctx . Tr ( "settings.applications" )
2018-05-17 07:05:00 +03:00
ctx . Data [ "PageIsSettingsApplications" ] = true
2024-07-09 20:36:31 +03:00
ctx . Data [ "UserDisabledFeatures" ] = user_model . DisabledFeaturesWithLoginType ( ctx . Doer )
2018-05-17 07:05:00 +03:00
2018-06-18 21:24:45 +03:00
loadApplicationsData ( ctx )
2018-05-17 07:05:00 +03:00
2021-04-05 18:30:52 +03:00
ctx . HTML ( http . StatusOK , tplSettingsApplications )
2018-05-17 07:05:00 +03:00
}
// ApplicationsPost response for add user's access token
2021-01-26 18:36:53 +03:00
func ApplicationsPost ( ctx * context . Context ) {
2021-04-06 22:44:05 +03:00
form := web . GetForm ( ctx ) . ( * forms . NewAccessTokenForm )
2018-05-17 07:05:00 +03:00
ctx . Data [ "Title" ] = ctx . Tr ( "settings" )
ctx . Data [ "PageIsSettingsApplications" ] = true
2024-07-09 20:36:31 +03:00
ctx . Data [ "UserDisabledFeatures" ] = user_model . DisabledFeaturesWithLoginType ( ctx . Doer )
2018-05-17 07:05:00 +03:00
if ctx . HasError ( ) {
2018-06-18 21:24:45 +03:00
loadApplicationsData ( ctx )
2021-04-05 18:30:52 +03:00
ctx . HTML ( http . StatusOK , tplSettingsApplications )
2018-05-17 07:05:00 +03:00
return
}
2023-01-18 00:46:03 +03:00
scope , err := form . GetScope ( )
if err != nil {
ctx . ServerError ( "GetScope" , err )
return
}
2022-08-25 05:31:57 +03:00
t := & auth_model . AccessToken {
2023-01-18 00:46:03 +03:00
UID : ctx . Doer . ID ,
Name : form . Name ,
Scope : scope ,
2018-05-17 07:05:00 +03:00
}
2020-04-13 22:02:48 +03:00
2023-09-15 09:13:19 +03:00
exist , err := auth_model . AccessTokenByNameExists ( ctx , t )
2020-04-13 22:02:48 +03:00
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
}
2023-09-15 09:13:19 +03:00
if err := auth_model . NewAccessToken ( ctx , t ) ; err != nil {
2018-05-17 07:05:00 +03:00
ctx . ServerError ( "NewAccessToken" , err )
return
}
ctx . Flash . Success ( ctx . Tr ( "settings.generate_token_success" ) )
2019-05-04 18:45:34 +03:00
ctx . Flash . Info ( t . Token )
2018-05-17 07:05:00 +03:00
ctx . Redirect ( setting . AppSubURL + "/user/settings/applications" )
}
// DeleteApplication response for delete user access token
func DeleteApplication ( ctx * context . Context ) {
2023-09-15 09:13:19 +03:00
if err := auth_model . DeleteAccessTokenByID ( ctx , ctx . FormInt64 ( "id" ) , ctx . Doer . ID ) ; err != nil {
2018-05-17 07:05:00 +03:00
ctx . Flash . Error ( "DeleteAccessTokenByID: " + err . Error ( ) )
} else {
ctx . Flash . Success ( ctx . Tr ( "settings.delete_token_success" ) )
}
2023-07-26 09:04:01 +03:00
ctx . JSONRedirect ( setting . AppSubURL + "/user/settings/applications" )
2018-05-17 07:05:00 +03:00
}
2018-06-18 21:24:45 +03:00
func loadApplicationsData ( ctx * context . Context ) {
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 21:57:16 +03:00
ctx . Data [ "AccessTokenScopePublicOnly" ] = auth_model . AccessTokenScopePublicOnly
2023-11-24 06:49:41 +03:00
tokens , err := db . Find [ auth_model . AccessToken ] ( ctx , auth_model . ListAccessTokensOptions { UserID : ctx . Doer . ID } )
2018-06-18 21:24:45 +03:00
if err != nil {
ctx . ServerError ( "ListAccessTokens" , err )
return
}
ctx . Data [ "Tokens" ] = tokens
2024-01-28 15:36:44 +03:00
ctx . Data [ "EnableOAuth2" ] = setting . OAuth2 . Enabled
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 21:57:16 +03:00
ctx . Data [ "IsAdmin" ] = ctx . Doer . IsAdmin
2024-01-28 15:36:44 +03:00
if setting . OAuth2 . Enabled {
2023-11-24 06:49:41 +03:00
ctx . Data [ "Applications" ] , err = db . Find [ auth_model . OAuth2Application ] ( ctx , auth_model . FindOAuth2ApplicationsOptions {
OwnerID : ctx . Doer . ID ,
} )
2019-03-08 19:42:50 +03:00
if err != nil {
ctx . ServerError ( "GetOAuth2ApplicationsByUserID" , err )
return
}
2022-08-25 05:31:57 +03:00
ctx . Data [ "Grants" ] , err = auth_model . GetOAuth2GrantsByUserID ( ctx , ctx . Doer . ID )
2019-04-17 11:18:16 +03:00
if err != nil {
ctx . ServerError ( "GetOAuth2GrantsByUserID" , err )
return
}
2019-03-08 19:42:50 +03:00
}
2018-06-18 21:24:45 +03:00
}