2018-11-20 10:31:30 -07:00
|
|
|
// Copyright 2018 The Gitea Authors. All rights reserved.
|
2022-11-27 11:20:29 -07:00
|
|
|
// SPDX-License-Identifier: MIT
|
2018-11-20 10:31:30 -07:00
|
|
|
|
2022-09-02 13:18:23 -06:00
|
|
|
package integration
|
2018-11-20 10:31:30 -07:00
|
|
|
|
|
|
|
import (
|
2022-09-19 06:02:29 -06:00
|
|
|
"fmt"
|
2018-11-20 10:31:30 -07:00
|
|
|
"net/http"
|
2019-04-24 10:16:14 -06:00
|
|
|
"net/url"
|
2018-11-20 10:31:30 -07:00
|
|
|
"strings"
|
|
|
|
"testing"
|
|
|
|
|
2023-01-17 14:46:03 -07:00
|
|
|
auth_model "code.gitea.io/gitea/models/auth"
|
2023-04-19 17:19:13 -06:00
|
|
|
"code.gitea.io/gitea/models/db"
|
|
|
|
org_model "code.gitea.io/gitea/models/organization"
|
|
|
|
"code.gitea.io/gitea/models/perm"
|
|
|
|
unit_model "code.gitea.io/gitea/models/unit"
|
2021-11-16 01:53:21 -07:00
|
|
|
"code.gitea.io/gitea/models/unittest"
|
2021-11-24 02:49:20 -07:00
|
|
|
user_model "code.gitea.io/gitea/models/user"
|
2019-04-24 10:16:14 -06:00
|
|
|
"code.gitea.io/gitea/modules/setting"
|
2019-05-11 04:21:34 -06:00
|
|
|
api "code.gitea.io/gitea/modules/structs"
|
2022-09-02 13:18:23 -06:00
|
|
|
"code.gitea.io/gitea/tests"
|
2018-11-20 10:31:30 -07:00
|
|
|
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
|
|
)
|
|
|
|
|
2019-05-30 11:57:55 -06:00
|
|
|
func TestAPIOrgCreate(t *testing.T) {
|
2019-04-24 10:16:14 -06:00
|
|
|
onGiteaRun(t, func(*testing.T, *url.URL) {
|
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 12:57:16 -06:00
|
|
|
token := getUserToken(t, "user1", auth_model.AccessTokenScopeWriteOrganization)
|
2019-04-24 10:16:14 -06:00
|
|
|
|
2022-01-20 10:46:10 -07:00
|
|
|
org := api.CreateOrgOption{
|
2019-04-24 10:16:14 -06:00
|
|
|
UserName: "user1_org",
|
|
|
|
FullName: "User1's organization",
|
|
|
|
Description: "This organization created by user1",
|
|
|
|
Website: "https://try.gitea.io",
|
|
|
|
Location: "Shanghai",
|
2019-05-30 11:57:55 -06:00
|
|
|
Visibility: "limited",
|
2019-04-24 10:16:14 -06:00
|
|
|
}
|
2023-12-21 16:59:59 -07:00
|
|
|
req := NewRequestWithJSON(t, "POST", "/api/v1/orgs", &org).
|
|
|
|
AddTokenAuth(token)
|
2022-04-07 22:22:10 -06:00
|
|
|
resp := MakeRequest(t, req, http.StatusCreated)
|
2019-04-24 10:16:14 -06:00
|
|
|
|
|
|
|
var apiOrg api.Organization
|
|
|
|
DecodeJSON(t, resp, &apiOrg)
|
|
|
|
|
2022-09-28 21:27:33 -06:00
|
|
|
assert.Equal(t, org.UserName, apiOrg.Name)
|
2019-04-24 10:16:14 -06:00
|
|
|
assert.Equal(t, org.FullName, apiOrg.FullName)
|
|
|
|
assert.Equal(t, org.Description, apiOrg.Description)
|
|
|
|
assert.Equal(t, org.Website, apiOrg.Website)
|
|
|
|
assert.Equal(t, org.Location, apiOrg.Location)
|
2019-05-30 11:57:55 -06:00
|
|
|
assert.Equal(t, org.Visibility, apiOrg.Visibility)
|
2019-04-24 10:16:14 -06:00
|
|
|
|
2021-11-24 02:49:20 -07:00
|
|
|
unittest.AssertExistsAndLoadBean(t, &user_model.User{
|
2019-04-24 10:16:14 -06:00
|
|
|
Name: org.UserName,
|
|
|
|
LowerName: strings.ToLower(org.UserName),
|
|
|
|
FullName: org.FullName,
|
|
|
|
})
|
|
|
|
|
2023-04-19 17:19:13 -06:00
|
|
|
// Check owner team permission
|
|
|
|
ownerTeam, _ := org_model.GetOwnerTeam(db.DefaultContext, apiOrg.ID)
|
|
|
|
|
|
|
|
for _, ut := range unit_model.AllRepoUnitTypes {
|
|
|
|
up := perm.AccessModeOwner
|
|
|
|
if ut == unit_model.TypeExternalTracker || ut == unit_model.TypeExternalWiki {
|
|
|
|
up = perm.AccessModeRead
|
|
|
|
}
|
|
|
|
unittest.AssertExistsAndLoadBean(t, &org_model.TeamUnit{
|
|
|
|
OrgID: apiOrg.ID,
|
|
|
|
TeamID: ownerTeam.ID,
|
|
|
|
Type: ut,
|
|
|
|
AccessMode: up,
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2023-12-21 16:59:59 -07:00
|
|
|
req = NewRequestf(t, "GET", "/api/v1/orgs/%s", org.UserName).
|
|
|
|
AddTokenAuth(token)
|
2022-04-07 22:22:10 -06:00
|
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
2019-04-24 10:16:14 -06:00
|
|
|
DecodeJSON(t, resp, &apiOrg)
|
2022-09-28 21:27:33 -06:00
|
|
|
assert.EqualValues(t, org.UserName, apiOrg.Name)
|
2019-04-24 10:16:14 -06:00
|
|
|
|
2023-12-21 16:59:59 -07:00
|
|
|
req = NewRequestf(t, "GET", "/api/v1/orgs/%s/repos", org.UserName).
|
|
|
|
AddTokenAuth(token)
|
2022-04-07 22:22:10 -06:00
|
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
2019-04-24 10:16:14 -06:00
|
|
|
|
|
|
|
var repos []*api.Repository
|
|
|
|
DecodeJSON(t, resp, &repos)
|
|
|
|
for _, repo := range repos {
|
|
|
|
assert.False(t, repo.Private)
|
|
|
|
}
|
|
|
|
|
2023-12-21 16:59:59 -07:00
|
|
|
req = NewRequestf(t, "GET", "/api/v1/orgs/%s/members", org.UserName).
|
|
|
|
AddTokenAuth(token)
|
2022-04-07 22:22:10 -06:00
|
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
2019-04-24 10:16:14 -06:00
|
|
|
|
|
|
|
// user1 on this org is public
|
|
|
|
var users []*api.User
|
|
|
|
DecodeJSON(t, resp, &users)
|
2021-06-06 23:27:09 -06:00
|
|
|
assert.Len(t, users, 1)
|
2019-04-24 10:16:14 -06:00
|
|
|
assert.EqualValues(t, "user1", users[0].UserName)
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2019-05-30 11:57:55 -06:00
|
|
|
func TestAPIOrgEdit(t *testing.T) {
|
|
|
|
onGiteaRun(t, func(*testing.T, *url.URL) {
|
|
|
|
session := loginUser(t, "user1")
|
|
|
|
|
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 12:57:16 -06:00
|
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteOrganization)
|
2022-01-20 10:46:10 -07:00
|
|
|
org := api.EditOrgOption{
|
2023-09-13 20:59:53 -06:00
|
|
|
FullName: "Org3 organization new full name",
|
2019-05-30 11:57:55 -06:00
|
|
|
Description: "A new description",
|
|
|
|
Website: "https://try.gitea.io/new",
|
|
|
|
Location: "Beijing",
|
|
|
|
Visibility: "private",
|
|
|
|
}
|
2023-12-21 16:59:59 -07:00
|
|
|
req := NewRequestWithJSON(t, "PATCH", "/api/v1/orgs/org3", &org).
|
|
|
|
AddTokenAuth(token)
|
2022-12-01 20:39:42 -07:00
|
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
2019-05-30 11:57:55 -06:00
|
|
|
|
|
|
|
var apiOrg api.Organization
|
|
|
|
DecodeJSON(t, resp, &apiOrg)
|
|
|
|
|
2023-09-13 20:59:53 -06:00
|
|
|
assert.Equal(t, "org3", apiOrg.Name)
|
2019-05-30 11:57:55 -06:00
|
|
|
assert.Equal(t, org.FullName, apiOrg.FullName)
|
|
|
|
assert.Equal(t, org.Description, apiOrg.Description)
|
|
|
|
assert.Equal(t, org.Website, apiOrg.Website)
|
|
|
|
assert.Equal(t, org.Location, apiOrg.Location)
|
|
|
|
assert.Equal(t, org.Visibility, apiOrg.Visibility)
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
|
|
|
func TestAPIOrgEditBadVisibility(t *testing.T) {
|
|
|
|
onGiteaRun(t, func(*testing.T, *url.URL) {
|
|
|
|
session := loginUser(t, "user1")
|
|
|
|
|
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 12:57:16 -06:00
|
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteOrganization)
|
2022-01-20 10:46:10 -07:00
|
|
|
org := api.EditOrgOption{
|
2023-09-13 20:59:53 -06:00
|
|
|
FullName: "Org3 organization new full name",
|
2019-05-30 11:57:55 -06:00
|
|
|
Description: "A new description",
|
|
|
|
Website: "https://try.gitea.io/new",
|
|
|
|
Location: "Beijing",
|
|
|
|
Visibility: "badvisibility",
|
|
|
|
}
|
2023-12-21 16:59:59 -07:00
|
|
|
req := NewRequestWithJSON(t, "PATCH", "/api/v1/orgs/org3", &org).
|
|
|
|
AddTokenAuth(token)
|
2022-12-01 20:39:42 -07:00
|
|
|
MakeRequest(t, req, http.StatusUnprocessableEntity)
|
2019-05-30 11:57:55 -06:00
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2019-04-24 10:16:14 -06:00
|
|
|
func TestAPIOrgDeny(t *testing.T) {
|
|
|
|
onGiteaRun(t, func(*testing.T, *url.URL) {
|
|
|
|
setting.Service.RequireSignInView = true
|
|
|
|
defer func() {
|
|
|
|
setting.Service.RequireSignInView = false
|
|
|
|
}()
|
|
|
|
|
2022-01-20 10:46:10 -07:00
|
|
|
orgName := "user1_org"
|
2023-04-21 09:39:03 -06:00
|
|
|
req := NewRequestf(t, "GET", "/api/v1/orgs/%s", orgName)
|
2019-04-24 10:16:14 -06:00
|
|
|
MakeRequest(t, req, http.StatusNotFound)
|
|
|
|
|
2023-04-21 09:39:03 -06:00
|
|
|
req = NewRequestf(t, "GET", "/api/v1/orgs/%s/repos", orgName)
|
2019-04-24 10:16:14 -06:00
|
|
|
MakeRequest(t, req, http.StatusNotFound)
|
|
|
|
|
2023-04-21 09:39:03 -06:00
|
|
|
req = NewRequestf(t, "GET", "/api/v1/orgs/%s/members", orgName)
|
2019-04-24 10:16:14 -06:00
|
|
|
MakeRequest(t, req, http.StatusNotFound)
|
2018-11-20 10:31:30 -07:00
|
|
|
})
|
|
|
|
}
|
2020-01-12 08:43:44 -07:00
|
|
|
|
|
|
|
func TestAPIGetAll(t *testing.T) {
|
2022-09-02 13:18:23 -06:00
|
|
|
defer tests.PrepareTestEnv(t)()
|
2020-01-12 08:43:44 -07:00
|
|
|
|
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 12:57:16 -06:00
|
|
|
token := getUserToken(t, "user1", auth_model.AccessTokenScopeReadOrganization)
|
2023-01-17 14:46:03 -07:00
|
|
|
|
2023-04-21 09:39:03 -06:00
|
|
|
// accessing with a token will return all orgs
|
2023-12-21 16:59:59 -07:00
|
|
|
req := NewRequest(t, "GET", "/api/v1/orgs").
|
|
|
|
AddTokenAuth(token)
|
2020-01-12 08:43:44 -07:00
|
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
|
|
var apiOrgList []*api.Organization
|
|
|
|
|
2023-04-21 09:39:03 -06:00
|
|
|
DecodeJSON(t, resp, &apiOrgList)
|
2024-10-11 17:35:04 -06:00
|
|
|
assert.Len(t, apiOrgList, 13)
|
2023-07-09 07:00:07 -06:00
|
|
|
assert.Equal(t, "Limited Org 36", apiOrgList[1].FullName)
|
|
|
|
assert.Equal(t, "limited", apiOrgList[1].Visibility)
|
2023-04-21 09:39:03 -06:00
|
|
|
|
|
|
|
// accessing without a token will return only public orgs
|
2023-12-21 16:59:59 -07:00
|
|
|
req = NewRequest(t, "GET", "/api/v1/orgs")
|
2023-04-21 09:39:03 -06:00
|
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
|
|
|
|
|
|
DecodeJSON(t, resp, &apiOrgList)
|
2024-10-11 17:35:04 -06:00
|
|
|
assert.Len(t, apiOrgList, 9)
|
2023-09-13 20:59:53 -06:00
|
|
|
assert.Equal(t, "org 17", apiOrgList[0].FullName)
|
2023-04-21 09:39:03 -06:00
|
|
|
assert.Equal(t, "public", apiOrgList[0].Visibility)
|
2020-01-12 08:43:44 -07:00
|
|
|
}
|
2022-09-19 06:02:29 -06:00
|
|
|
|
|
|
|
func TestAPIOrgSearchEmptyTeam(t *testing.T) {
|
|
|
|
onGiteaRun(t, func(*testing.T, *url.URL) {
|
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 12:57:16 -06:00
|
|
|
token := getUserToken(t, "user1", auth_model.AccessTokenScopeWriteOrganization)
|
2022-09-19 06:02:29 -06:00
|
|
|
orgName := "org_with_empty_team"
|
|
|
|
|
|
|
|
// create org
|
2023-12-21 16:59:59 -07:00
|
|
|
req := NewRequestWithJSON(t, "POST", "/api/v1/orgs", &api.CreateOrgOption{
|
2022-09-19 06:02:29 -06:00
|
|
|
UserName: orgName,
|
2023-12-21 16:59:59 -07:00
|
|
|
}).AddTokenAuth(token)
|
2022-09-19 06:02:29 -06:00
|
|
|
MakeRequest(t, req, http.StatusCreated)
|
|
|
|
|
|
|
|
// create team with no member
|
2023-12-21 16:59:59 -07:00
|
|
|
req = NewRequestWithJSON(t, "POST", fmt.Sprintf("/api/v1/orgs/%s/teams", orgName), &api.CreateTeamOption{
|
2022-09-19 06:02:29 -06:00
|
|
|
Name: "Empty",
|
|
|
|
IncludesAllRepositories: true,
|
|
|
|
Permission: "read",
|
|
|
|
Units: []string{"repo.code", "repo.issues", "repo.ext_issues", "repo.wiki", "repo.pulls"},
|
2023-12-21 16:59:59 -07:00
|
|
|
}).AddTokenAuth(token)
|
2022-09-19 06:02:29 -06:00
|
|
|
MakeRequest(t, req, http.StatusCreated)
|
|
|
|
|
|
|
|
// case-insensitive search for teams that have no members
|
2023-12-21 16:59:59 -07:00
|
|
|
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/orgs/%s/teams/search?q=%s", orgName, "empty")).
|
|
|
|
AddTokenAuth(token)
|
2022-09-19 06:02:29 -06:00
|
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
|
|
data := struct {
|
|
|
|
Ok bool
|
|
|
|
Data []*api.Team
|
|
|
|
}{}
|
|
|
|
DecodeJSON(t, resp, &data)
|
|
|
|
assert.True(t, data.Ok)
|
|
|
|
if assert.Len(t, data.Data, 1) {
|
|
|
|
assert.EqualValues(t, "Empty", data.Data[0].Name)
|
|
|
|
}
|
|
|
|
})
|
|
|
|
}
|