0
0
Fork 0
mirror of https://github.com/go-gitea/gitea synced 2024-12-25 17:24:46 +01:00
gitea/templates/user/settings
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
..
security Minor UI improvements: logo alignment, auth map editor, auth name display (#25043) 2023-06-02 18:02:20 +08:00
account.tmpl Change --font-weight-bold to --font-weight-semibold and 600 value, introduce new font weight variables (#24827) 2023-05-21 23:37:32 +00:00
actions.tmpl Add user level action runners (#24995) 2023-05-31 09:39:54 +08:00
appearance.tmpl
applications.tmpl Redesign Scoped Access Tokens (#24767) 2023-06-04 20:57:16 +02:00
applications_oauth2.tmpl
applications_oauth2_edit.tmpl
applications_oauth2_edit_form.tmpl Improve some Forms (#24878) 2023-05-26 09:42:54 +00:00
applications_oauth2_list.tmpl Improve some Forms (#24878) 2023-05-26 09:42:54 +00:00
grants_oauth2.tmpl Change add_on translation to added_on and include placeholder for the date (#24562) 2023-05-06 21:11:27 +08:00
hook_new.tmpl
hooks.tmpl
keys.tmpl
keys_gpg.tmpl Change add_on translation to added_on and include placeholder for the date (#24562) 2023-05-06 21:11:27 +08:00
keys_principal.tmpl Change add_on translation to added_on and include placeholder for the date (#24562) 2023-05-06 21:11:27 +08:00
keys_ssh.tmpl Improve some Forms (#24878) 2023-05-26 09:42:54 +00:00
layout_footer.tmpl
layout_head.tmpl
navbar.tmpl Add user level action runners (#24995) 2023-05-31 09:39:54 +08:00
organization.tmpl Improve some modal action buttons (#24289) 2023-04-24 07:08:59 -04:00
packages.tmpl Move links out of translation (#24446) 2023-05-01 09:17:27 +02:00
packages_cleanup_rules_edit.tmpl
packages_cleanup_rules_preview.tmpl Change to vertical navbar layout for secondary navbar for repo/user/admin settings (#24246) 2023-04-23 18:21:21 +08:00
profile.tmpl various style fixes (#25008) 2023-05-30 22:28:25 +00:00
repos.tmpl Fix layouts of admin table / adapt repo / email test (#24370) 2023-04-28 09:48:41 +08:00
runner_edit.tmpl Add user level action runners (#24995) 2023-05-31 09:39:54 +08:00