forgejo-federation/models/migrations/v1_20
Jack Hay 18de83b2a3
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 20:57:16 +02:00
..
main_test.go Redesign Scoped Access Tokens (#24767) 2023-06-04 20:57:16 +02:00
v244.go Require approval to run actions for fork pull request (#22803) 2023-02-24 15:58:49 +08:00
v245.go Add user webhooks (#21563) 2023-03-10 08:28:32 -06:00
v246.go Fix missed migration in #22235 (#23482) 2023-03-15 10:33:10 +01:00
v247.go Do not store user projects as organization projects (#23353) 2023-03-17 21:07:23 +08:00
v248.go Display the version of runner in the runner list (#23490) 2023-03-19 22:19:40 -04:00
v249.go Improve indices for action table (#23532) 2023-03-24 23:44:33 +08:00
v250.go Display image size for multiarch container images (#23821) 2023-04-02 17:53:37 +08:00
v251.go Fix owner team access mode value in team_unit table (#23675) 2023-04-03 10:36:35 -04:00
v252.go Fix admin team access mode value in team_unit table (#24012) 2023-04-13 21:06:10 +02:00
v253.go Add migration to fix external unit access mode of owner/admin team (#24117) 2023-04-15 09:52:44 -04:00
v254.go Support upload outputs and use needs context on Actions (#24230) 2023-04-22 16:12:41 -04:00
v255.go Display when a repo was archived (#22664) 2023-04-26 10:46:26 -04:00
v256.go Add Debian package registry (#24426) 2023-05-02 12:31:35 -04:00
v257.go Implement actions artifacts (#22738) 2023-05-19 21:37:57 +08:00
v258.go Add the ability to pin Issues (#24406) 2023-05-25 15:17:19 +02:00
v259.go Redesign Scoped Access Tokens (#24767) 2023-06-04 20:57:16 +02:00
v259_test.go Redesign Scoped Access Tokens (#24767) 2023-06-04 20:57:16 +02:00