2017-05-26 15:15:45 +02:00
|
|
|
// Copyright 2017 The Gitea Authors. All rights reserved.
|
2022-11-27 19:20:29 +01:00
|
|
|
// SPDX-License-Identifier: MIT
|
2017-05-26 15:15:45 +02:00
|
|
|
|
2022-09-02 21:18:23 +02:00
|
|
|
package integration
|
2017-05-26 15:15:45 +02:00
|
|
|
|
|
|
|
|
import (
|
2019-04-28 01:32:33 +02:00
|
|
|
"fmt"
|
2017-05-26 15:15:45 +02:00
|
|
|
"net/http"
|
2019-04-28 01:32:33 +02:00
|
|
|
"sort"
|
2017-05-26 15:15:45 +02:00
|
|
|
"testing"
|
|
|
|
|
|
2023-01-17 22:46:03 +01:00
|
|
|
auth_model "code.gitea.io/gitea/models/auth"
|
Add context cache as a request level cache (#22294)
To avoid duplicated load of the same data in an HTTP request, we can set
a context cache to do that. i.e. Some pages may load a user from a
database with the same id in different areas on the same page. But the
code is hidden in two different deep logic. How should we share the
user? As a result of this PR, now if both entry functions accept
`context.Context` as the first parameter and we just need to refactor
`GetUserByID` to reuse the user from the context cache. Then it will not
be loaded twice on an HTTP request.
But of course, sometimes we would like to reload an object from the
database, that's why `RemoveContextData` is also exposed.
The core context cache is here. It defines a new context
```go
type cacheContext struct {
ctx context.Context
data map[any]map[any]any
lock sync.RWMutex
}
var cacheContextKey = struct{}{}
func WithCacheContext(ctx context.Context) context.Context {
return context.WithValue(ctx, cacheContextKey, &cacheContext{
ctx: ctx,
data: make(map[any]map[any]any),
})
}
```
Then you can use the below 4 methods to read/write/del the data within
the same context.
```go
func GetContextData(ctx context.Context, tp, key any) any
func SetContextData(ctx context.Context, tp, key, value any)
func RemoveContextData(ctx context.Context, tp, key any)
func GetWithContextCache[T any](ctx context.Context, cacheGroupKey string, cacheTargetID any, f func() (T, error)) (T, error)
```
Then let's take a look at how `system.GetString` implement it.
```go
func GetSetting(ctx context.Context, key string) (string, error) {
return cache.GetWithContextCache(ctx, contextCacheKey, key, func() (string, error) {
return cache.GetString(genSettingCacheKey(key), func() (string, error) {
res, err := GetSettingNoCache(ctx, key)
if err != nil {
return "", err
}
return res.SettingValue, nil
})
})
}
```
First, it will check if context data include the setting object with the
key. If not, it will query from the global cache which may be memory or
a Redis cache. If not, it will get the object from the database. In the
end, if the object gets from the global cache or database, it will be
set into the context cache.
An object stored in the context cache will only be destroyed after the
context disappeared.
2023-02-15 14:37:34 +01:00
|
|
|
"code.gitea.io/gitea/models/db"
|
2022-03-29 08:29:02 +02:00
|
|
|
"code.gitea.io/gitea/models/organization"
|
2023-04-13 21:06:10 +02:00
|
|
|
"code.gitea.io/gitea/models/perm"
|
2022-05-01 17:39:04 +02:00
|
|
|
"code.gitea.io/gitea/models/repo"
|
2022-01-05 04:37:00 +01:00
|
|
|
"code.gitea.io/gitea/models/unit"
|
2021-11-16 09:53:21 +01:00
|
|
|
"code.gitea.io/gitea/models/unittest"
|
2021-11-24 10:49:20 +01:00
|
|
|
user_model "code.gitea.io/gitea/models/user"
|
2019-05-11 12:21:34 +02:00
|
|
|
api "code.gitea.io/gitea/modules/structs"
|
2022-12-29 03:57:15 +01:00
|
|
|
"code.gitea.io/gitea/services/convert"
|
2022-09-02 21:18:23 +02:00
|
|
|
"code.gitea.io/gitea/tests"
|
2017-05-26 15:15:45 +02:00
|
|
|
|
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
func TestAPITeam(t *testing.T) {
|
2022-09-02 21:18:23 +02:00
|
|
|
defer tests.PrepareTestEnv(t)()
|
2019-04-24 07:32:35 +02:00
|
|
|
|
2022-12-21 02:22:23 +01:00
|
|
|
teamUser := unittest.AssertExistsAndLoadBean(t, &organization.TeamUser{ID: 1})
|
2022-08-16 04:22:25 +02:00
|
|
|
team := unittest.AssertExistsAndLoadBean(t, &organization.Team{ID: teamUser.TeamID})
|
2023-05-13 23:26:35 +02:00
|
|
|
org := unittest.AssertExistsAndLoadBean(t, &organization.Organization{ID: teamUser.OrgID})
|
2022-08-16 04:22:25 +02:00
|
|
|
user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: teamUser.UID})
|
2017-05-26 15:15:45 +02:00
|
|
|
|
2017-06-17 06:49:45 +02: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 20:57:16 +02:00
|
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeReadOrganization)
|
2023-12-22 00:59:59 +01:00
|
|
|
req := NewRequestf(t, "GET", "/api/v1/teams/%d", teamUser.TeamID).
|
|
|
|
|
AddTokenAuth(token)
|
2022-12-02 04:39:42 +01:00
|
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
2017-05-26 15:15:45 +02:00
|
|
|
|
|
|
|
|
var apiTeam api.Team
|
2017-06-18 11:06:17 +02:00
|
|
|
DecodeJSON(t, resp, &apiTeam)
|
2017-05-26 15:15:45 +02:00
|
|
|
assert.EqualValues(t, team.ID, apiTeam.ID)
|
|
|
|
|
assert.Equal(t, team.Name, apiTeam.Name)
|
2023-05-13 23:26:35 +02:00
|
|
|
assert.EqualValues(t, convert.ToOrganization(db.DefaultContext, org), apiTeam.Organization)
|
2019-04-24 07:32:35 +02:00
|
|
|
|
|
|
|
|
// non team member user will not access the teams details
|
2022-08-16 04:22:25 +02:00
|
|
|
teamUser2 := unittest.AssertExistsAndLoadBean(t, &organization.TeamUser{ID: 3})
|
|
|
|
|
user2 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: teamUser2.UID})
|
2019-04-24 07:32:35 +02:00
|
|
|
|
|
|
|
|
session = loginUser(t, user2.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 20:57:16 +02:00
|
|
|
token = getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeReadOrganization)
|
2023-12-22 00:59:59 +01:00
|
|
|
req = NewRequestf(t, "GET", "/api/v1/teams/%d", teamUser.TeamID).
|
|
|
|
|
AddTokenAuth(token)
|
2022-12-02 04:39:42 +01:00
|
|
|
_ = MakeRequest(t, req, http.StatusForbidden)
|
2019-04-24 07:32:35 +02:00
|
|
|
|
|
|
|
|
req = NewRequestf(t, "GET", "/api/v1/teams/%d", teamUser.TeamID)
|
2022-12-02 04:39:42 +01:00
|
|
|
_ = MakeRequest(t, req, http.StatusUnauthorized)
|
2019-04-28 01:32:33 +02:00
|
|
|
|
|
|
|
|
// Get an admin user able to create, update and delete teams.
|
2022-08-16 04:22:25 +02:00
|
|
|
user = unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 1})
|
2019-04-28 01:32:33 +02: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 20:57:16 +02:00
|
|
|
token = getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteOrganization)
|
2019-04-28 01:32:33 +02:00
|
|
|
|
2023-05-13 23:26:35 +02:00
|
|
|
org = unittest.AssertExistsAndLoadBean(t, &organization.Organization{ID: 6})
|
2019-04-28 01:32:33 +02:00
|
|
|
|
|
|
|
|
// Create team.
|
|
|
|
|
teamToCreate := &api.CreateTeamOption{
|
2019-11-06 10:37:14 +01:00
|
|
|
Name: "team1",
|
|
|
|
|
Description: "team one",
|
|
|
|
|
IncludesAllRepositories: true,
|
|
|
|
|
Permission: "write",
|
|
|
|
|
Units: []string{"repo.code", "repo.issues"},
|
2019-04-28 01:32:33 +02:00
|
|
|
}
|
2023-12-22 00:59:59 +01:00
|
|
|
req = NewRequestWithJSON(t, "POST", fmt.Sprintf("/api/v1/orgs/%s/teams", org.Name), teamToCreate).
|
|
|
|
|
AddTokenAuth(token)
|
2022-12-02 04:39:42 +01:00
|
|
|
resp = MakeRequest(t, req, http.StatusCreated)
|
2022-01-05 04:37:00 +01:00
|
|
|
apiTeam = api.Team{}
|
2019-04-28 01:32:33 +02:00
|
|
|
DecodeJSON(t, resp, &apiTeam)
|
2022-05-13 19:27:58 +02:00
|
|
|
checkTeamResponse(t, "CreateTeam1", &apiTeam, teamToCreate.Name, teamToCreate.Description, teamToCreate.IncludesAllRepositories,
|
2022-01-05 04:37:00 +01:00
|
|
|
teamToCreate.Permission, teamToCreate.Units, nil)
|
2019-11-06 10:37:14 +01:00
|
|
|
checkTeamBean(t, apiTeam.ID, teamToCreate.Name, teamToCreate.Description, teamToCreate.IncludesAllRepositories,
|
2022-01-05 04:37:00 +01:00
|
|
|
teamToCreate.Permission, teamToCreate.Units, nil)
|
2019-04-28 01:32:33 +02:00
|
|
|
teamID := apiTeam.ID
|
|
|
|
|
|
|
|
|
|
// Edit team.
|
2020-01-09 14:15:14 +01:00
|
|
|
editDescription := "team 1"
|
|
|
|
|
editFalse := false
|
2019-04-28 01:32:33 +02:00
|
|
|
teamToEdit := &api.EditTeamOption{
|
2019-11-06 10:37:14 +01:00
|
|
|
Name: "teamone",
|
2020-01-09 14:15:14 +01:00
|
|
|
Description: &editDescription,
|
2019-11-06 10:37:14 +01:00
|
|
|
Permission: "admin",
|
2020-01-09 14:15:14 +01:00
|
|
|
IncludesAllRepositories: &editFalse,
|
2019-11-06 10:37:14 +01:00
|
|
|
Units: []string{"repo.code", "repo.pulls", "repo.releases"},
|
2019-04-28 01:32:33 +02:00
|
|
|
}
|
2020-01-09 14:15:14 +01:00
|
|
|
|
2023-12-22 00:59:59 +01:00
|
|
|
req = NewRequestWithJSON(t, "PATCH", fmt.Sprintf("/api/v1/teams/%d", teamID), teamToEdit).
|
|
|
|
|
AddTokenAuth(token)
|
2022-12-02 04:39:42 +01:00
|
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
2022-01-05 04:37:00 +01:00
|
|
|
apiTeam = api.Team{}
|
2019-04-28 01:32:33 +02:00
|
|
|
DecodeJSON(t, resp, &apiTeam)
|
2022-05-13 19:27:58 +02:00
|
|
|
checkTeamResponse(t, "EditTeam1", &apiTeam, teamToEdit.Name, *teamToEdit.Description, *teamToEdit.IncludesAllRepositories,
|
2022-01-05 04:37:00 +01:00
|
|
|
teamToEdit.Permission, unit.AllUnitKeyNames(), nil)
|
2020-01-09 14:15:14 +01:00
|
|
|
checkTeamBean(t, apiTeam.ID, teamToEdit.Name, *teamToEdit.Description, *teamToEdit.IncludesAllRepositories,
|
2022-01-05 04:37:00 +01:00
|
|
|
teamToEdit.Permission, unit.AllUnitKeyNames(), nil)
|
2020-01-09 14:15:14 +01:00
|
|
|
|
|
|
|
|
// Edit team Description only
|
|
|
|
|
editDescription = "first team"
|
|
|
|
|
teamToEditDesc := api.EditTeamOption{Description: &editDescription}
|
2023-12-22 00:59:59 +01:00
|
|
|
req = NewRequestWithJSON(t, "PATCH", fmt.Sprintf("/api/v1/teams/%d", teamID), teamToEditDesc).
|
|
|
|
|
AddTokenAuth(token)
|
2022-12-02 04:39:42 +01:00
|
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
2022-01-05 04:37:00 +01:00
|
|
|
apiTeam = api.Team{}
|
2020-01-09 14:15:14 +01:00
|
|
|
DecodeJSON(t, resp, &apiTeam)
|
2022-05-13 19:27:58 +02:00
|
|
|
checkTeamResponse(t, "EditTeam1_DescOnly", &apiTeam, teamToEdit.Name, *teamToEditDesc.Description, *teamToEdit.IncludesAllRepositories,
|
2022-01-05 04:37:00 +01:00
|
|
|
teamToEdit.Permission, unit.AllUnitKeyNames(), nil)
|
2020-01-09 14:15:14 +01:00
|
|
|
checkTeamBean(t, apiTeam.ID, teamToEdit.Name, *teamToEditDesc.Description, *teamToEdit.IncludesAllRepositories,
|
2022-01-05 04:37:00 +01:00
|
|
|
teamToEdit.Permission, unit.AllUnitKeyNames(), nil)
|
2019-04-28 01:32:33 +02:00
|
|
|
|
|
|
|
|
// Read team.
|
2022-08-16 04:22:25 +02:00
|
|
|
teamRead := unittest.AssertExistsAndLoadBean(t, &organization.Team{ID: teamID})
|
2023-02-19 09:31:39 +01:00
|
|
|
assert.NoError(t, teamRead.LoadUnits(db.DefaultContext))
|
2023-12-22 00:59:59 +01:00
|
|
|
req = NewRequestf(t, "GET", "/api/v1/teams/%d", teamID).
|
|
|
|
|
AddTokenAuth(token)
|
2022-12-02 04:39:42 +01:00
|
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
2022-01-05 04:37:00 +01:00
|
|
|
apiTeam = api.Team{}
|
2019-04-28 01:32:33 +02:00
|
|
|
DecodeJSON(t, resp, &apiTeam)
|
2022-05-13 19:27:58 +02:00
|
|
|
checkTeamResponse(t, "ReadTeam1", &apiTeam, teamRead.Name, *teamToEditDesc.Description, teamRead.IncludesAllRepositories,
|
2024-04-17 17:58:37 +02:00
|
|
|
teamRead.AccessMode.ToString(), teamRead.GetUnitNames(), teamRead.GetUnitsMap())
|
2022-01-05 04:37:00 +01:00
|
|
|
|
|
|
|
|
// Delete team.
|
2023-12-22 00:59:59 +01:00
|
|
|
req = NewRequestf(t, "DELETE", "/api/v1/teams/%d", teamID).
|
|
|
|
|
AddTokenAuth(token)
|
2022-12-02 04:39:42 +01:00
|
|
|
MakeRequest(t, req, http.StatusNoContent)
|
2022-03-29 08:29:02 +02:00
|
|
|
unittest.AssertNotExistsBean(t, &organization.Team{ID: teamID})
|
2022-01-05 04:37:00 +01:00
|
|
|
|
|
|
|
|
// create team again via UnitsMap
|
|
|
|
|
// Create team.
|
|
|
|
|
teamToCreate = &api.CreateTeamOption{
|
|
|
|
|
Name: "team2",
|
|
|
|
|
Description: "team two",
|
|
|
|
|
IncludesAllRepositories: true,
|
|
|
|
|
Permission: "write",
|
|
|
|
|
UnitsMap: map[string]string{"repo.code": "read", "repo.issues": "write", "repo.wiki": "none"},
|
|
|
|
|
}
|
2023-12-22 00:59:59 +01:00
|
|
|
req = NewRequestWithJSON(t, "POST", fmt.Sprintf("/api/v1/orgs/%s/teams", org.Name), teamToCreate).
|
|
|
|
|
AddTokenAuth(token)
|
2022-12-02 04:39:42 +01:00
|
|
|
resp = MakeRequest(t, req, http.StatusCreated)
|
2022-01-05 04:37:00 +01:00
|
|
|
apiTeam = api.Team{}
|
|
|
|
|
DecodeJSON(t, resp, &apiTeam)
|
2022-05-13 19:27:58 +02:00
|
|
|
checkTeamResponse(t, "CreateTeam2", &apiTeam, teamToCreate.Name, teamToCreate.Description, teamToCreate.IncludesAllRepositories,
|
2022-01-05 04:37:00 +01:00
|
|
|
"read", nil, teamToCreate.UnitsMap)
|
|
|
|
|
checkTeamBean(t, apiTeam.ID, teamToCreate.Name, teamToCreate.Description, teamToCreate.IncludesAllRepositories,
|
|
|
|
|
"read", nil, teamToCreate.UnitsMap)
|
|
|
|
|
teamID = apiTeam.ID
|
|
|
|
|
|
|
|
|
|
// Edit team.
|
|
|
|
|
editDescription = "team 1"
|
|
|
|
|
editFalse = false
|
|
|
|
|
teamToEdit = &api.EditTeamOption{
|
|
|
|
|
Name: "teamtwo",
|
|
|
|
|
Description: &editDescription,
|
|
|
|
|
Permission: "write",
|
|
|
|
|
IncludesAllRepositories: &editFalse,
|
|
|
|
|
UnitsMap: map[string]string{"repo.code": "read", "repo.pulls": "read", "repo.releases": "write"},
|
|
|
|
|
}
|
|
|
|
|
|
2023-12-22 00:59:59 +01:00
|
|
|
req = NewRequestWithJSON(t, "PATCH", fmt.Sprintf("/api/v1/teams/%d", teamID), teamToEdit).
|
|
|
|
|
AddTokenAuth(token)
|
2022-12-02 04:39:42 +01:00
|
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
2022-01-05 04:37:00 +01:00
|
|
|
apiTeam = api.Team{}
|
|
|
|
|
DecodeJSON(t, resp, &apiTeam)
|
2022-05-13 19:27:58 +02:00
|
|
|
checkTeamResponse(t, "EditTeam2", &apiTeam, teamToEdit.Name, *teamToEdit.Description, *teamToEdit.IncludesAllRepositories,
|
2022-01-05 04:37:00 +01:00
|
|
|
"read", nil, teamToEdit.UnitsMap)
|
|
|
|
|
checkTeamBean(t, apiTeam.ID, teamToEdit.Name, *teamToEdit.Description, *teamToEdit.IncludesAllRepositories,
|
|
|
|
|
"read", nil, teamToEdit.UnitsMap)
|
|
|
|
|
|
|
|
|
|
// Edit team Description only
|
|
|
|
|
editDescription = "second team"
|
|
|
|
|
teamToEditDesc = api.EditTeamOption{Description: &editDescription}
|
2023-12-22 00:59:59 +01:00
|
|
|
req = NewRequestWithJSON(t, "PATCH", fmt.Sprintf("/api/v1/teams/%d", teamID), teamToEditDesc).
|
|
|
|
|
AddTokenAuth(token)
|
2022-12-02 04:39:42 +01:00
|
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
2022-01-05 04:37:00 +01:00
|
|
|
apiTeam = api.Team{}
|
|
|
|
|
DecodeJSON(t, resp, &apiTeam)
|
2022-05-13 19:27:58 +02:00
|
|
|
checkTeamResponse(t, "EditTeam2_DescOnly", &apiTeam, teamToEdit.Name, *teamToEditDesc.Description, *teamToEdit.IncludesAllRepositories,
|
2022-01-05 04:37:00 +01:00
|
|
|
"read", nil, teamToEdit.UnitsMap)
|
|
|
|
|
checkTeamBean(t, apiTeam.ID, teamToEdit.Name, *teamToEditDesc.Description, *teamToEdit.IncludesAllRepositories,
|
|
|
|
|
"read", nil, teamToEdit.UnitsMap)
|
|
|
|
|
|
|
|
|
|
// Read team.
|
2022-08-16 04:22:25 +02:00
|
|
|
teamRead = unittest.AssertExistsAndLoadBean(t, &organization.Team{ID: teamID})
|
2023-12-22 00:59:59 +01:00
|
|
|
req = NewRequestf(t, "GET", "/api/v1/teams/%d", teamID).
|
|
|
|
|
AddTokenAuth(token)
|
2022-12-02 04:39:42 +01:00
|
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
2022-01-05 04:37:00 +01:00
|
|
|
apiTeam = api.Team{}
|
|
|
|
|
DecodeJSON(t, resp, &apiTeam)
|
2023-02-19 09:31:39 +01:00
|
|
|
assert.NoError(t, teamRead.LoadUnits(db.DefaultContext))
|
2022-05-13 19:27:58 +02:00
|
|
|
checkTeamResponse(t, "ReadTeam2", &apiTeam, teamRead.Name, *teamToEditDesc.Description, teamRead.IncludesAllRepositories,
|
2024-04-17 17:58:37 +02:00
|
|
|
teamRead.AccessMode.ToString(), teamRead.GetUnitNames(), teamRead.GetUnitsMap())
|
2019-04-28 01:32:33 +02:00
|
|
|
|
|
|
|
|
// Delete team.
|
2023-12-22 00:59:59 +01:00
|
|
|
req = NewRequestf(t, "DELETE", "/api/v1/teams/%d", teamID).
|
|
|
|
|
AddTokenAuth(token)
|
2022-12-02 04:39:42 +01:00
|
|
|
MakeRequest(t, req, http.StatusNoContent)
|
2022-03-29 08:29:02 +02:00
|
|
|
unittest.AssertNotExistsBean(t, &organization.Team{ID: teamID})
|
2023-04-13 21:06:10 +02:00
|
|
|
|
|
|
|
|
// Create admin team
|
|
|
|
|
teamToCreate = &api.CreateTeamOption{
|
|
|
|
|
Name: "teamadmin",
|
|
|
|
|
Description: "team admin",
|
|
|
|
|
IncludesAllRepositories: true,
|
|
|
|
|
Permission: "admin",
|
|
|
|
|
}
|
2023-12-22 00:59:59 +01:00
|
|
|
req = NewRequestWithJSON(t, "POST", fmt.Sprintf("/api/v1/orgs/%s/teams", org.Name), teamToCreate).
|
|
|
|
|
AddTokenAuth(token)
|
2023-04-13 21:06:10 +02:00
|
|
|
resp = MakeRequest(t, req, http.StatusCreated)
|
|
|
|
|
apiTeam = api.Team{}
|
|
|
|
|
DecodeJSON(t, resp, &apiTeam)
|
|
|
|
|
for _, ut := range unit.AllRepoUnitTypes {
|
|
|
|
|
up := perm.AccessModeAdmin
|
|
|
|
|
if ut == unit.TypeExternalTracker || ut == unit.TypeExternalWiki {
|
|
|
|
|
up = perm.AccessModeRead
|
|
|
|
|
}
|
|
|
|
|
unittest.AssertExistsAndLoadBean(t, &organization.TeamUnit{
|
|
|
|
|
OrgID: org.ID,
|
|
|
|
|
TeamID: apiTeam.ID,
|
|
|
|
|
Type: ut,
|
|
|
|
|
AccessMode: up,
|
|
|
|
|
})
|
|
|
|
|
}
|
|
|
|
|
teamID = apiTeam.ID
|
|
|
|
|
|
|
|
|
|
// Delete team.
|
2023-12-22 00:59:59 +01:00
|
|
|
req = NewRequestf(t, "DELETE", "/api/v1/teams/%d", teamID).
|
|
|
|
|
AddTokenAuth(token)
|
2023-04-13 21:06:10 +02:00
|
|
|
MakeRequest(t, req, http.StatusNoContent)
|
|
|
|
|
unittest.AssertNotExistsBean(t, &organization.Team{ID: teamID})
|
2019-04-28 01:32:33 +02:00
|
|
|
}
|
|
|
|
|
|
2022-05-13 19:27:58 +02:00
|
|
|
func checkTeamResponse(t *testing.T, testName string, apiTeam *api.Team, name, description string, includesAllRepositories bool, permission string, units []string, unitsMap map[string]string) {
|
|
|
|
|
t.Run(testName, func(t *testing.T) {
|
2022-01-05 04:37:00 +01:00
|
|
|
assert.Equal(t, name, apiTeam.Name, "name")
|
|
|
|
|
assert.Equal(t, description, apiTeam.Description, "description")
|
|
|
|
|
assert.Equal(t, includesAllRepositories, apiTeam.IncludesAllRepositories, "includesAllRepositories")
|
|
|
|
|
assert.Equal(t, permission, apiTeam.Permission, "permission")
|
|
|
|
|
if units != nil {
|
|
|
|
|
sort.StringSlice(units).Sort()
|
|
|
|
|
sort.StringSlice(apiTeam.Units).Sort()
|
|
|
|
|
assert.EqualValues(t, units, apiTeam.Units, "units")
|
|
|
|
|
}
|
|
|
|
|
if unitsMap != nil {
|
|
|
|
|
assert.EqualValues(t, unitsMap, apiTeam.UnitsMap, "unitsMap")
|
|
|
|
|
}
|
|
|
|
|
})
|
2019-04-28 01:32:33 +02:00
|
|
|
}
|
|
|
|
|
|
2022-01-05 04:37:00 +01:00
|
|
|
func checkTeamBean(t *testing.T, id int64, name, description string, includesAllRepositories bool, permission string, units []string, unitsMap map[string]string) {
|
2022-08-16 04:22:25 +02:00
|
|
|
team := unittest.AssertExistsAndLoadBean(t, &organization.Team{ID: id})
|
2023-02-19 09:31:39 +01:00
|
|
|
assert.NoError(t, team.LoadUnits(db.DefaultContext), "LoadUnits")
|
Add context cache as a request level cache (#22294)
To avoid duplicated load of the same data in an HTTP request, we can set
a context cache to do that. i.e. Some pages may load a user from a
database with the same id in different areas on the same page. But the
code is hidden in two different deep logic. How should we share the
user? As a result of this PR, now if both entry functions accept
`context.Context` as the first parameter and we just need to refactor
`GetUserByID` to reuse the user from the context cache. Then it will not
be loaded twice on an HTTP request.
But of course, sometimes we would like to reload an object from the
database, that's why `RemoveContextData` is also exposed.
The core context cache is here. It defines a new context
```go
type cacheContext struct {
ctx context.Context
data map[any]map[any]any
lock sync.RWMutex
}
var cacheContextKey = struct{}{}
func WithCacheContext(ctx context.Context) context.Context {
return context.WithValue(ctx, cacheContextKey, &cacheContext{
ctx: ctx,
data: make(map[any]map[any]any),
})
}
```
Then you can use the below 4 methods to read/write/del the data within
the same context.
```go
func GetContextData(ctx context.Context, tp, key any) any
func SetContextData(ctx context.Context, tp, key, value any)
func RemoveContextData(ctx context.Context, tp, key any)
func GetWithContextCache[T any](ctx context.Context, cacheGroupKey string, cacheTargetID any, f func() (T, error)) (T, error)
```
Then let's take a look at how `system.GetString` implement it.
```go
func GetSetting(ctx context.Context, key string) (string, error) {
return cache.GetWithContextCache(ctx, contextCacheKey, key, func() (string, error) {
return cache.GetString(genSettingCacheKey(key), func() (string, error) {
res, err := GetSettingNoCache(ctx, key)
if err != nil {
return "", err
}
return res.SettingValue, nil
})
})
}
```
First, it will check if context data include the setting object with the
key. If not, it will query from the global cache which may be memory or
a Redis cache. If not, it will get the object from the database. In the
end, if the object gets from the global cache or database, it will be
set into the context cache.
An object stored in the context cache will only be destroyed after the
context disappeared.
2023-02-15 14:37:34 +01:00
|
|
|
apiTeam, err := convert.ToTeam(db.DefaultContext, team)
|
2022-05-13 19:27:58 +02:00
|
|
|
assert.NoError(t, err)
|
|
|
|
|
checkTeamResponse(t, fmt.Sprintf("checkTeamBean/%s_%s", name, description), apiTeam, name, description, includesAllRepositories, permission, units, unitsMap)
|
2017-05-26 15:15:45 +02:00
|
|
|
}
|
2019-10-01 07:32:28 +02:00
|
|
|
|
|
|
|
|
type TeamSearchResults struct {
|
|
|
|
|
OK bool `json:"ok"`
|
|
|
|
|
Data []*api.Team `json:"data"`
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func TestAPITeamSearch(t *testing.T) {
|
2022-09-02 21:18:23 +02:00
|
|
|
defer tests.PrepareTestEnv(t)()
|
2019-10-01 07:32:28 +02:00
|
|
|
|
2022-08-16 04:22:25 +02:00
|
|
|
user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
|
2022-08-21 18:24:05 +02:00
|
|
|
org := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 17})
|
2019-10-01 07:32:28 +02:00
|
|
|
|
|
|
|
|
var results TeamSearchResults
|
|
|
|
|
|
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
|
|
|
token := getUserToken(t, user.Name, auth_model.AccessTokenScopeReadOrganization)
|
2023-12-22 00:59:59 +01:00
|
|
|
req := NewRequestf(t, "GET", "/api/v1/orgs/%s/teams/search?q=%s", org.Name, "_team").
|
|
|
|
|
AddTokenAuth(token)
|
2022-04-08 06:22:10 +02:00
|
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
2019-10-01 07:32:28 +02:00
|
|
|
DecodeJSON(t, resp, &results)
|
|
|
|
|
assert.NotEmpty(t, results.Data)
|
2021-06-07 07:27:09 +02:00
|
|
|
assert.Len(t, results.Data, 1)
|
2019-10-01 07:32:28 +02:00
|
|
|
assert.Equal(t, "test_team", results.Data[0].Name)
|
|
|
|
|
|
|
|
|
|
// no access if not organization member
|
2022-08-16 04:22:25 +02:00
|
|
|
user5 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 5})
|
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
|
|
|
token5 := getUserToken(t, user5.Name, auth_model.AccessTokenScopeReadOrganization)
|
2022-04-08 06:22:10 +02:00
|
|
|
|
2023-12-22 00:59:59 +01:00
|
|
|
req = NewRequestf(t, "GET", "/api/v1/orgs/%s/teams/search?q=%s", org.Name, "team").
|
|
|
|
|
AddTokenAuth(token5)
|
2022-04-08 06:22:10 +02:00
|
|
|
MakeRequest(t, req, http.StatusForbidden)
|
2019-10-01 07:32:28 +02:00
|
|
|
}
|
2022-05-01 17:39:04 +02:00
|
|
|
|
|
|
|
|
func TestAPIGetTeamRepo(t *testing.T) {
|
2022-09-02 21:18:23 +02:00
|
|
|
defer tests.PrepareTestEnv(t)()
|
2022-05-01 17:39:04 +02:00
|
|
|
|
2022-08-16 04:22:25 +02:00
|
|
|
user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 15})
|
|
|
|
|
teamRepo := unittest.AssertExistsAndLoadBean(t, &repo.Repository{ID: 24})
|
|
|
|
|
team := unittest.AssertExistsAndLoadBean(t, &organization.Team{ID: 5})
|
2022-05-01 17:39:04 +02:00
|
|
|
|
|
|
|
|
var results api.Repository
|
|
|
|
|
|
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
|
|
|
token := getUserToken(t, user.Name, auth_model.AccessTokenScopeReadOrganization)
|
2023-12-22 00:59:59 +01:00
|
|
|
req := NewRequestf(t, "GET", "/api/v1/teams/%d/repos/%s/", team.ID, teamRepo.FullName()).
|
|
|
|
|
AddTokenAuth(token)
|
2022-05-01 17:39:04 +02:00
|
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
|
|
|
DecodeJSON(t, resp, &results)
|
|
|
|
|
assert.Equal(t, "big_test_private_4", teamRepo.Name)
|
|
|
|
|
|
|
|
|
|
// no access if not organization member
|
2022-08-16 04:22:25 +02:00
|
|
|
user5 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 5})
|
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
|
|
|
token5 := getUserToken(t, user5.Name, auth_model.AccessTokenScopeReadOrganization)
|
2022-05-01 17:39:04 +02:00
|
|
|
|
2023-12-22 00:59:59 +01:00
|
|
|
req = NewRequestf(t, "GET", "/api/v1/teams/%d/repos/%s/", team.ID, teamRepo.FullName()).
|
|
|
|
|
AddTokenAuth(token5)
|
2022-05-01 17:39:04 +02:00
|
|
|
MakeRequest(t, req, http.StatusNotFound)
|
|
|
|
|
}
|
