2021-02-02 00:57:12 +03:00
// Copyright 2021 The Gitea Authors. All rights reserved.
2022-11-27 21:20:29 +03:00
// SPDX-License-Identifier: MIT
2021-02-02 00:57:12 +03:00
2022-09-02 22:18:23 +03:00
package integration
2021-02-02 00:57:12 +03:00
import (
"fmt"
"net/http"
"testing"
2023-01-18 00:46:03 +03:00
auth_model "code.gitea.io/gitea/models/auth"
2021-12-10 04:27:50 +03:00
repo_model "code.gitea.io/gitea/models/repo"
2022-01-05 06:37:00 +03:00
"code.gitea.io/gitea/models/unit"
2021-11-16 11:53:21 +03:00
"code.gitea.io/gitea/models/unittest"
2021-11-24 12:49:20 +03:00
user_model "code.gitea.io/gitea/models/user"
2021-02-02 00:57:12 +03:00
api "code.gitea.io/gitea/modules/structs"
2022-01-05 06:37:00 +03:00
"code.gitea.io/gitea/modules/util"
2022-09-02 22:18:23 +03:00
"code.gitea.io/gitea/tests"
2021-02-02 00:57:12 +03:00
"github.com/stretchr/testify/assert"
)
func TestAPIRepoTeams ( t * testing . T ) {
2022-09-02 22:18:23 +03:00
defer tests . PrepareTestEnv ( t ) ( )
2021-02-02 00:57:12 +03:00
2023-09-14 05:59:53 +03:00
// publicOrgRepo = org3/repo21
2022-08-16 05:22:25 +03:00
publicOrgRepo := unittest . AssertExistsAndLoadBean ( t , & repo_model . Repository { ID : 32 } )
2021-02-02 00:57:12 +03:00
// user4
2022-08-16 05:22:25 +03:00
user := unittest . AssertExistsAndLoadBean ( t , & user_model . User { ID : 4 } )
2021-02-02 00:57:12 +03:00
session := loginUser ( t , user . Name )
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
token := getTokenForLoggedInUser ( t , session , auth_model . AccessTokenScopeWriteRepository )
2021-02-02 00:57:12 +03:00
// ListTeams
2023-12-22 02:59:59 +03:00
req := NewRequest ( t , "GET" , fmt . Sprintf ( "/api/v1/repos/%s/teams" , publicOrgRepo . FullName ( ) ) ) .
AddTokenAuth ( token )
2022-12-02 06:39:42 +03:00
res := MakeRequest ( t , req , http . StatusOK )
2021-02-02 00:57:12 +03:00
var teams [ ] * api . Team
DecodeJSON ( t , res , & teams )
if assert . Len ( t , teams , 2 ) {
assert . EqualValues ( t , "Owners" , teams [ 0 ] . Name )
2022-03-29 09:29:02 +03:00
assert . True ( t , teams [ 0 ] . CanCreateOrgRepo )
Improve utils of slices (#22379)
- Move the file `compare.go` and `slice.go` to `slice.go`.
- Fix `ExistsInSlice`, it's buggy
- It uses `sort.Search`, so it assumes that the input slice is sorted.
- It passes `func(i int) bool { return slice[i] == target })` to
`sort.Search`, that's incorrect, check the doc of `sort.Search`.
- Conbine `IsInt64InSlice(int64, []int64)` and `ExistsInSlice(string,
[]string)` to `SliceContains[T]([]T, T)`.
- Conbine `IsSliceInt64Eq([]int64, []int64)` and `IsEqualSlice([]string,
[]string)` to `SliceSortedEqual[T]([]T, T)`.
- Add `SliceEqual[T]([]T, T)` as a distinction from
`SliceSortedEqual[T]([]T, T)`.
- Redesign `RemoveIDFromList([]int64, int64) ([]int64, bool)` to
`SliceRemoveAll[T]([]T, T) []T`.
- Add `SliceContainsFunc[T]([]T, func(T) bool)` and
`SliceRemoveAllFunc[T]([]T, func(T) bool)` for general use.
- Add comments to explain why not `golang.org/x/exp/slices`.
- Add unit tests.
2023-01-11 08:31:16 +03:00
assert . True ( t , util . SliceSortedEqual ( unit . AllUnitKeyNames ( ) , teams [ 0 ] . Units ) , fmt . Sprintf ( "%v == %v" , unit . AllUnitKeyNames ( ) , teams [ 0 ] . Units ) )
2021-02-02 00:57:12 +03:00
assert . EqualValues ( t , "owner" , teams [ 0 ] . Permission )
assert . EqualValues ( t , "test_team" , teams [ 1 ] . Name )
2021-06-07 08:27:09 +03:00
assert . False ( t , teams [ 1 ] . CanCreateOrgRepo )
2021-02-02 00:57:12 +03:00
assert . EqualValues ( t , [ ] string { "repo.issues" } , teams [ 1 ] . Units )
assert . EqualValues ( t , "write" , teams [ 1 ] . Permission )
}
// IsTeam
2023-12-22 02:59:59 +03:00
req = NewRequest ( t , "GET" , fmt . Sprintf ( "/api/v1/repos/%s/teams/%s" , publicOrgRepo . FullName ( ) , "Test_Team" ) ) .
AddTokenAuth ( token )
2022-12-02 06:39:42 +03:00
res = MakeRequest ( t , req , http . StatusOK )
2021-02-02 00:57:12 +03:00
var team * api . Team
DecodeJSON ( t , res , & team )
assert . EqualValues ( t , teams [ 1 ] , team )
2023-12-22 02:59:59 +03:00
req = NewRequest ( t , "GET" , fmt . Sprintf ( "/api/v1/repos/%s/teams/%s" , publicOrgRepo . FullName ( ) , "NonExistingTeam" ) ) .
AddTokenAuth ( token )
2022-12-02 06:39:42 +03:00
MakeRequest ( t , req , http . StatusNotFound )
2021-02-02 00:57:12 +03:00
// AddTeam with user4
2023-12-22 02:59:59 +03:00
req = NewRequest ( t , "PUT" , fmt . Sprintf ( "/api/v1/repos/%s/teams/%s" , publicOrgRepo . FullName ( ) , "team1" ) ) .
AddTokenAuth ( token )
2022-12-02 06:39:42 +03:00
MakeRequest ( t , req , http . StatusForbidden )
2021-02-02 00:57:12 +03:00
// AddTeam with user2
2022-08-16 05:22:25 +03:00
user = unittest . AssertExistsAndLoadBean ( t , & user_model . User { ID : 2 } )
2021-02-02 00:57:12 +03:00
session = loginUser ( t , user . Name )
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
token = getTokenForLoggedInUser ( t , session , auth_model . AccessTokenScopeWriteRepository )
2023-12-22 02:59:59 +03:00
req = NewRequest ( t , "PUT" , fmt . Sprintf ( "/api/v1/repos/%s/teams/%s" , publicOrgRepo . FullName ( ) , "team1" ) ) .
AddTokenAuth ( token )
2022-12-02 06:39:42 +03:00
MakeRequest ( t , req , http . StatusNoContent )
MakeRequest ( t , req , http . StatusUnprocessableEntity ) // test duplicate request
2021-02-02 00:57:12 +03:00
// DeleteTeam
2023-12-22 02:59:59 +03:00
req = NewRequest ( t , "DELETE" , fmt . Sprintf ( "/api/v1/repos/%s/teams/%s" , publicOrgRepo . FullName ( ) , "team1" ) ) .
AddTokenAuth ( token )
2022-12-02 06:39:42 +03:00
MakeRequest ( t , req , http . StatusNoContent )
MakeRequest ( t , req , http . StatusUnprocessableEntity ) // test duplicate request
2021-02-02 00:57:12 +03:00
}