forked from gitea/gitea
1
0
Fork 0
gitea/routers/web/repo
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
..
actions Add step start time to `ViewStepLog` (#24980) 2023-05-29 08:18:36 +00:00
setting Add user level action runners (#24995) 2023-05-31 09:39:54 +08:00
activity.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
attachment.go Fix users cannot visit issue attachment bug (#25019) 2023-05-31 19:06:17 +02:00
blame.go Sort repo topic labels by name (#24123) 2023-04-14 15:29:05 -04:00
branch.go Use the type RefName for all the needed places and fix pull mirror sync bugs (#24634) 2023-05-26 01:04:48 +00:00
cherry_pick.go Rename almost all Ctx functions (#22071) 2022-12-10 10:46:31 +08:00
commit.go Pass 'not' to commit count (#24473) 2023-05-08 07:10:53 +00:00
compare.go Don't list root repository on compare page if pulls not allowed (#24183) 2023-04-19 11:16:46 -04:00
download.go Decouple the different contexts from each other (#24786) 2023-05-21 09:50:53 +08:00
editor.go API endpoint for changing/creating/deleting multiple files (#24887) 2023-05-29 17:41:35 +08:00
editor_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
find.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
helper.go Refactor authors dropdown (send get request from frontend to avoid long wait time) (#23890) 2023-04-07 08:11:02 +08:00
helper_test.go Refactor authors dropdown (send get request from frontend to avoid long wait time) (#23890) 2023-04-07 08:11:02 +08:00
http.go Redesign Scoped Access Tokens (#24767) 2023-06-04 20:57:16 +02:00
http_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
issue.go Use the type RefName for all the needed places and fix pull mirror sync bugs (#24634) 2023-05-26 01:04:48 +00:00
issue_content_history.go Move helpers to be prefixed with `gt-` (#22879) 2023-02-13 17:59:59 +00:00
issue_dependency.go Add API to manage issue dependencies (#17935) 2023-03-28 13:23:25 -04:00
issue_label.go Make label templates have consistent behavior and priority (#23749) 2023-04-10 16:44:02 +08:00
issue_label_test.go Make label templates have consistent behavior and priority (#23749) 2023-04-10 16:44:02 +08:00
issue_lock.go Fix improper HTMLURL usages in Go code (#22839) 2023-02-11 14:34:11 +08:00
issue_pin.go Followup to pinned Issues (#24945) 2023-05-30 15:26:51 +00:00
issue_stopwatch.go Speed up HasUserStopwatch & GetActiveStopwatch (#23051) 2023-02-27 13:46:00 -05:00
issue_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
issue_timetrack.go Fix improper HTMLURL usages in Go code (#22839) 2023-02-11 14:34:11 +08:00
issue_watch.go Rewrite logger system (#24726) 2023-05-21 22:35:11 +00:00
lfs.go Introduce path Clean/Join helper functions (#23495) 2023-03-21 16:02:49 -04:00
main_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
middlewares.go Use graceful editorconfig loader to reduce errors when loading malformed editorconfigs (#21257) 2023-04-06 16:01:20 -04:00
migrate.go Make repo migration cancelable and fix various bugs (#24605) 2023-05-11 08:25:46 +00:00
milestone.go Improve Gitea's web context, decouple "issue template" code into service package (#24590) 2023-05-09 01:30:14 +02:00
packages.go Use dynamic package type list (#22263) 2022-12-29 00:31:54 +01:00
patch.go Redirect to the commit page after applying patch (#23056) 2023-02-24 16:56:41 +00:00
projects.go Merge `new project` templates into one (#24985) 2023-05-31 08:50:18 +02:00
projects_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
pull.go Add IsErrRepoFilesAlreadyExist check when fork repo (#24678) 2023-05-22 18:21:46 +08:00
pull_review.go Make Ctrl+Enter submit a pending comment (starting review) instead of submitting a single comment (#23245) 2023-03-04 02:13:37 -05:00
release.go fix: release page for empty or non-existing target (#24470) 2023-05-10 11:43:55 +08:00
release_test.go fix: release page for empty or non-existing target (#24470) 2023-05-10 11:43:55 +08:00
render.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo.go Remove the parallelizing when loading repo for dashboard (#24705) 2023-05-14 21:45:47 +08:00
search.go Fix improper HTMLURL usages in Go code (#22839) 2023-02-11 14:34:11 +08:00
setting.go Hide 'Mirror Settings' when unneeded, improve hints (#24433) 2023-05-29 11:32:52 +00:00
setting_protected_branch.go Support for status check pattern (#24633) 2023-05-17 16:11:13 +08:00
settings_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
tag.go Add main landmark to templates and adjust titles (#22670) 2023-02-01 22:56:10 +00:00
topic.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
treelist.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
view.go Improve Gitea's web context, decouple "issue template" code into service package (#24590) 2023-05-09 01:30:14 +02:00
view_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
webhook.go New webhook trigger for receiving Pull Request review requests (#24481) 2023-05-24 22:06:27 -04:00
wiki.go Decouple the different contexts from each other (#24786) 2023-05-21 09:50:53 +08:00
wiki_test.go Make wiki title supports dashes and improve wiki name related features (#24143) 2023-04-19 13:50:10 -04:00