2017-07-01 21:03:57 -05:00
// Copyright 2017 The Gitea Authors. All rights reserved.
2022-11-27 13:20:29 -05:00
// SPDX-License-Identifier: MIT
2017-07-01 21:03:57 -05:00
2022-09-02 14:18:23 -05:00
package integration
2017-07-01 21:03:57 -05:00
import (
"net/http"
2020-05-29 13:16:20 -05:00
"net/url"
2017-07-01 21:03:57 -05:00
"testing"
2023-01-17 16:46:03 -05:00
auth_model "code.gitea.io/gitea/models/auth"
2023-12-28 02:28:57 -05:00
git_model "code.gitea.io/gitea/models/git"
2024-11-10 12:25:41 -05:00
"code.gitea.io/gitea/models/unittest"
2024-05-16 03:48:48 -05:00
"code.gitea.io/gitea/modules/git"
2019-05-11 05:21:34 -05:00
api "code.gitea.io/gitea/modules/structs"
2022-09-02 14:18:23 -05:00
"code.gitea.io/gitea/tests"
2017-07-01 21:03:57 -05:00
"github.com/stretchr/testify/assert"
)
func testAPIGetBranch ( t * testing . T , branchName string , exists bool ) {
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 13:57:16 -05:00
token := getUserToken ( t , "user2" , auth_model . AccessTokenScopeReadRepository )
2023-12-21 18:59:59 -05:00
req := NewRequestf ( t , "GET" , "/api/v1/repos/user2/repo1/branches/%s" , branchName ) .
AddTokenAuth ( token )
2022-12-01 22:39:42 -05:00
resp := MakeRequest ( t , req , NoExpectedStatus )
2017-07-01 21:03:57 -05:00
if ! exists {
2017-12-03 17:46:01 -05:00
assert . EqualValues ( t , http . StatusNotFound , resp . Code )
2017-07-01 21:03:57 -05:00
return
}
2017-12-03 17:46:01 -05:00
assert . EqualValues ( t , http . StatusOK , resp . Code )
2017-07-01 21:03:57 -05:00
var branch api . Branch
DecodeJSON ( t , resp , & branch )
assert . EqualValues ( t , branchName , branch . Name )
2020-03-20 22:41:33 -05:00
assert . True ( t , branch . UserCanPush )
assert . True ( t , branch . UserCanMerge )
2017-07-01 21:03:57 -05:00
}
2023-08-24 00:36:04 -05:00
func testAPIGetBranchProtection ( t * testing . T , branchName string , expectedHTTPStatus int ) * api . BranchProtection {
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 13:57:16 -05:00
token := getUserToken ( t , "user2" , auth_model . AccessTokenScopeReadRepository )
2023-12-21 18:59:59 -05:00
req := NewRequestf ( t , "GET" , "/api/v1/repos/user2/repo1/branch_protections/%s" , branchName ) .
AddTokenAuth ( token )
2022-12-01 22:39:42 -05:00
resp := MakeRequest ( t , req , expectedHTTPStatus )
2020-02-12 18:19:35 -05:00
2022-03-22 23:54:07 -05:00
if resp . Code == http . StatusOK {
2020-02-12 18:19:35 -05:00
var branchProtection api . BranchProtection
DecodeJSON ( t , resp , & branchProtection )
2023-01-16 03:00:22 -05:00
assert . EqualValues ( t , branchName , branchProtection . RuleName )
2023-08-24 00:36:04 -05:00
return & branchProtection
2020-02-12 18:19:35 -05:00
}
2023-08-24 00:36:04 -05:00
return nil
2020-02-12 18:19:35 -05:00
}
func testAPICreateBranchProtection ( t * testing . T , branchName string , expectedHTTPStatus int ) {
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 13:57:16 -05:00
token := getUserToken ( t , "user2" , auth_model . AccessTokenScopeWriteRepository )
2023-12-21 18:59:59 -05:00
req := NewRequestWithJSON ( t , "POST" , "/api/v1/repos/user2/repo1/branch_protections" , & api . BranchProtection {
2023-01-16 03:00:22 -05:00
RuleName : branchName ,
2023-12-21 18:59:59 -05:00
} ) . AddTokenAuth ( token )
2022-12-01 22:39:42 -05:00
resp := MakeRequest ( t , req , expectedHTTPStatus )
2020-02-12 18:19:35 -05:00
2022-03-22 23:54:07 -05:00
if resp . Code == http . StatusCreated {
2020-02-12 18:19:35 -05:00
var branchProtection api . BranchProtection
DecodeJSON ( t , resp , & branchProtection )
2023-01-16 03:00:22 -05:00
assert . EqualValues ( t , branchName , branchProtection . RuleName )
2020-02-12 18:19:35 -05:00
}
}
func testAPIEditBranchProtection ( t * testing . T , branchName string , body * api . BranchProtection , expectedHTTPStatus int ) {
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 13:57:16 -05:00
token := getUserToken ( t , "user2" , auth_model . AccessTokenScopeWriteRepository )
2023-12-21 18:59:59 -05:00
req := NewRequestWithJSON ( t , "PATCH" , "/api/v1/repos/user2/repo1/branch_protections/" + branchName , body ) .
AddTokenAuth ( token )
2022-12-01 22:39:42 -05:00
resp := MakeRequest ( t , req , expectedHTTPStatus )
2020-02-12 18:19:35 -05:00
2022-03-22 23:54:07 -05:00
if resp . Code == http . StatusOK {
2020-02-12 18:19:35 -05:00
var branchProtection api . BranchProtection
DecodeJSON ( t , resp , & branchProtection )
2023-01-16 03:00:22 -05:00
assert . EqualValues ( t , branchName , branchProtection . RuleName )
2020-02-12 18:19:35 -05:00
}
}
func testAPIDeleteBranchProtection ( t * testing . T , branchName string , expectedHTTPStatus int ) {
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 13:57:16 -05:00
token := getUserToken ( t , "user2" , auth_model . AccessTokenScopeWriteRepository )
2023-12-21 18:59:59 -05:00
req := NewRequestf ( t , "DELETE" , "/api/v1/repos/user2/repo1/branch_protections/%s" , branchName ) .
AddTokenAuth ( token )
2022-12-01 22:39:42 -05:00
MakeRequest ( t , req , expectedHTTPStatus )
2020-02-12 18:19:35 -05:00
}
2020-04-18 21:38:09 -05:00
func testAPIDeleteBranch ( t * testing . T , branchName string , expectedHTTPStatus int ) {
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 13:57:16 -05:00
token := getUserToken ( t , "user2" , auth_model . AccessTokenScopeWriteRepository )
2023-12-21 18:59:59 -05:00
req := NewRequestf ( t , "DELETE" , "/api/v1/repos/user2/repo1/branches/%s" , branchName ) .
AddTokenAuth ( token )
2022-12-01 22:39:42 -05:00
MakeRequest ( t , req , expectedHTTPStatus )
2020-04-18 21:38:09 -05:00
}
2017-07-01 21:03:57 -05:00
func TestAPIGetBranch ( t * testing . T ) {
2022-09-02 14:18:23 -05:00
defer tests . PrepareTestEnv ( t ) ( )
2017-07-01 21:03:57 -05:00
for _ , test := range [ ] struct {
BranchName string
Exists bool
} {
{ "master" , true } ,
{ "master/doesnotexist" , false } ,
{ "feature/1" , true } ,
{ "feature/1/doesnotexist" , false } ,
} {
testAPIGetBranch ( t , test . BranchName , test . Exists )
}
}
2020-02-12 18:19:35 -05:00
2020-05-29 13:16:20 -05:00
func TestAPICreateBranch ( t * testing . T ) {
onGiteaRun ( t , testAPICreateBranches )
}
func testAPICreateBranches ( t * testing . T , giteaURL * url . URL ) {
2024-05-16 03:54:32 -05:00
forEachObjectFormat ( t , func ( t * testing . T , objectFormat git . ObjectFormat ) {
ctx := NewAPITestContext ( t , "user2" , "my-noo-repo-" + objectFormat . Name ( ) , auth_model . AccessTokenScopeWriteRepository , auth_model . AccessTokenScopeWriteUser )
giteaURL . Path = ctx . GitPath ( )
t . Run ( "CreateRepo" , doAPICreateRepository ( ctx , false , objectFormat ) )
testCases := [ ] struct {
OldBranch string
NewBranch string
ExpectedHTTPStatus int
} {
// Creating branch from default branch
{
OldBranch : "" ,
NewBranch : "new_branch_from_default_branch" ,
ExpectedHTTPStatus : http . StatusCreated ,
} ,
// Creating branch from master
{
OldBranch : "master" ,
NewBranch : "new_branch_from_master_1" ,
ExpectedHTTPStatus : http . StatusCreated ,
} ,
// Trying to create from master but already exists
{
OldBranch : "master" ,
NewBranch : "new_branch_from_master_1" ,
ExpectedHTTPStatus : http . StatusConflict ,
} ,
// Trying to create from other branch (not default branch)
// ps: it can't test the case-sensitive behavior here: the "BRANCH_2" can't be created by git on a case-insensitive filesystem, it makes the test fail quickly before the database code.
// Suppose some users are running Gitea on a case-insensitive filesystem, it seems that it's unable to support case-sensitive branch names.
{
OldBranch : "new_branch_from_master_1" ,
NewBranch : "branch_2" ,
ExpectedHTTPStatus : http . StatusCreated ,
} ,
// Trying to create from a branch which does not exist
{
OldBranch : "does_not_exist" ,
NewBranch : "new_branch_from_non_existent" ,
ExpectedHTTPStatus : http . StatusNotFound ,
} ,
// Trying to create a branch with UTF8
{
OldBranch : "master" ,
NewBranch : "test-👀" ,
ExpectedHTTPStatus : http . StatusCreated ,
} ,
}
for _ , test := range testCases {
session := ctx . Session
t . Run ( test . NewBranch , func ( t * testing . T ) {
testAPICreateBranch ( t , session , ctx . Username , ctx . Reponame , test . OldBranch , test . NewBranch , test . ExpectedHTTPStatus )
} )
}
} )
2020-05-29 13:16:20 -05:00
}
2021-04-16 13:30:16 -05:00
func testAPICreateBranch ( t testing . TB , session * TestSession , user , repo , oldBranch , newBranch string , status int ) bool {
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 13:57:16 -05:00
token := getTokenForLoggedInUser ( t , session , auth_model . AccessTokenScopeWriteRepository )
2023-12-21 18:59:59 -05:00
req := NewRequestWithJSON ( t , "POST" , "/api/v1/repos/" + user + "/" + repo + "/branches" , & api . CreateBranchRepoOption {
2021-04-16 13:30:16 -05:00
BranchName : newBranch ,
OldBranchName : oldBranch ,
2023-12-21 18:59:59 -05:00
} ) . AddTokenAuth ( token )
2022-12-01 22:39:42 -05:00
resp := MakeRequest ( t , req , status )
2021-04-16 13:30:16 -05:00
var branch api . Branch
DecodeJSON ( t , resp , & branch )
2024-01-10 06:03:23 -05:00
if resp . Result ( ) . StatusCode == http . StatusCreated {
2021-04-16 13:30:16 -05:00
assert . EqualValues ( t , newBranch , branch . Name )
}
return resp . Result ( ) . StatusCode == status
}
2020-02-12 18:19:35 -05:00
func TestAPIBranchProtection ( t * testing . T ) {
2022-09-02 14:18:23 -05:00
defer tests . PrepareTestEnv ( t ) ( )
2020-02-12 18:19:35 -05:00
2023-01-16 03:00:22 -05:00
// Branch protection on branch that not exist
testAPICreateBranchProtection ( t , "master/doesnotexist" , http . StatusCreated )
2020-02-12 18:19:35 -05:00
// Get branch protection on branch that exist but not branch protection
testAPIGetBranchProtection ( t , "master" , http . StatusNotFound )
testAPICreateBranchProtection ( t , "master" , http . StatusCreated )
// Can only create once
testAPICreateBranchProtection ( t , "master" , http . StatusForbidden )
2020-04-18 21:38:09 -05:00
// Can't delete a protected branch
testAPIDeleteBranch ( t , "master" , http . StatusForbidden )
2020-02-12 18:19:35 -05:00
testAPIGetBranchProtection ( t , "master" , http . StatusOK )
testAPIEditBranchProtection ( t , "master" , & api . BranchProtection {
EnablePush : true ,
} , http . StatusOK )
2023-08-24 00:36:04 -05:00
// enable status checks, require the "test1" check to pass
testAPIEditBranchProtection ( t , "master" , & api . BranchProtection {
EnableStatusCheck : true ,
StatusCheckContexts : [ ] string { "test1" } ,
} , http . StatusOK )
bp := testAPIGetBranchProtection ( t , "master" , http . StatusOK )
2024-07-30 14:41:10 -05:00
assert . True ( t , bp . EnableStatusCheck )
2023-08-24 00:36:04 -05:00
assert . Equal ( t , [ ] string { "test1" } , bp . StatusCheckContexts )
// disable status checks, clear the list of required checks
testAPIEditBranchProtection ( t , "master" , & api . BranchProtection {
EnableStatusCheck : false ,
StatusCheckContexts : [ ] string { } ,
} , http . StatusOK )
bp = testAPIGetBranchProtection ( t , "master" , http . StatusOK )
2024-07-30 14:41:10 -05:00
assert . False ( t , bp . EnableStatusCheck )
2023-08-24 00:36:04 -05:00
assert . Equal ( t , [ ] string { } , bp . StatusCheckContexts )
2020-02-12 18:19:35 -05:00
testAPIDeleteBranchProtection ( t , "master" , http . StatusNoContent )
2020-04-18 21:38:09 -05:00
// Test branch deletion
testAPIDeleteBranch ( t , "master" , http . StatusForbidden )
testAPIDeleteBranch ( t , "branch2" , http . StatusNoContent )
2020-02-12 18:19:35 -05:00
}
2023-12-28 02:28:57 -05:00
func TestAPICreateBranchWithSyncBranches ( t * testing . T ) {
2024-11-10 12:25:41 -05:00
onGiteaRun ( t , func ( t * testing . T , giteaURL * url . URL ) {
unittest . AssertCount ( t , & git_model . Branch { RepoID : 1 } , 4 )
2023-12-28 02:28:57 -05:00
2024-11-10 12:25:41 -05:00
// make a broke repository with no branch on database
unittest . AssertSuccessfulDelete ( t , & git_model . Branch { RepoID : 1 } )
2023-12-28 02:28:57 -05:00
ctx := NewAPITestContext ( t , "user2" , "repo1" , auth_model . AccessTokenScopeWriteRepository , auth_model . AccessTokenScopeWriteUser )
giteaURL . Path = ctx . GitPath ( )
testAPICreateBranch ( t , ctx . Session , "user2" , "repo1" , "" , "new_branch" , http . StatusCreated )
2024-11-10 12:25:41 -05:00
unittest . AssertExistsIf ( t , true , & git_model . Branch { RepoID : 1 , Name : "new_branch" } )
2023-12-28 02:28:57 -05:00
} )
}