mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-12-05 05:18:15 +01:00
18de83b2a3
## 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>
127 lines
3.6 KiB
Go
127 lines
3.6 KiB
Go
// Copyright 2018 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package integration
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
"testing"
|
|
|
|
auth_model "code.gitea.io/gitea/models/auth"
|
|
"code.gitea.io/gitea/models/db"
|
|
"code.gitea.io/gitea/models/unittest"
|
|
user_model "code.gitea.io/gitea/models/user"
|
|
api "code.gitea.io/gitea/modules/structs"
|
|
"code.gitea.io/gitea/tests"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestUserOrgs(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
adminUsername := "user1"
|
|
normalUsername := "user2"
|
|
privateMemberUsername := "user4"
|
|
unrelatedUsername := "user5"
|
|
|
|
orgs := getUserOrgs(t, adminUsername, normalUsername)
|
|
|
|
user3 := unittest.AssertExistsAndLoadBean(t, &user_model.User{Name: "user3"})
|
|
user17 := unittest.AssertExistsAndLoadBean(t, &user_model.User{Name: "user17"})
|
|
|
|
assert.Equal(t, []*api.Organization{
|
|
{
|
|
ID: 17,
|
|
Name: user17.Name,
|
|
UserName: user17.Name,
|
|
FullName: user17.FullName,
|
|
AvatarURL: user17.AvatarLink(db.DefaultContext),
|
|
Description: "",
|
|
Website: "",
|
|
Location: "",
|
|
Visibility: "public",
|
|
},
|
|
{
|
|
ID: 3,
|
|
Name: user3.Name,
|
|
UserName: user3.Name,
|
|
FullName: user3.FullName,
|
|
AvatarURL: user3.AvatarLink(db.DefaultContext),
|
|
Description: "",
|
|
Website: "",
|
|
Location: "",
|
|
Visibility: "public",
|
|
},
|
|
}, orgs)
|
|
|
|
// user itself should get it's org's he is a member of
|
|
orgs = getUserOrgs(t, privateMemberUsername, privateMemberUsername)
|
|
assert.Len(t, orgs, 1)
|
|
|
|
// unrelated user should not get private org membership of privateMemberUsername
|
|
orgs = getUserOrgs(t, unrelatedUsername, privateMemberUsername)
|
|
assert.Len(t, orgs, 0)
|
|
|
|
// not authenticated call should not be allowed
|
|
testUserOrgsUnauthenticated(t, privateMemberUsername)
|
|
}
|
|
|
|
func getUserOrgs(t *testing.T, userDoer, userCheck string) (orgs []*api.Organization) {
|
|
token := ""
|
|
if len(userDoer) != 0 {
|
|
token = getUserToken(t, userDoer, auth_model.AccessTokenScopeReadOrganization, auth_model.AccessTokenScopeReadUser)
|
|
}
|
|
urlStr := fmt.Sprintf("/api/v1/users/%s/orgs?token=%s", userCheck, token)
|
|
req := NewRequest(t, "GET", urlStr)
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
DecodeJSON(t, resp, &orgs)
|
|
return orgs
|
|
}
|
|
|
|
func testUserOrgsUnauthenticated(t *testing.T, userCheck string) {
|
|
session := emptyTestSession(t)
|
|
req := NewRequestf(t, "GET", "/api/v1/users/%s/orgs", userCheck)
|
|
session.MakeRequest(t, req, http.StatusUnauthorized)
|
|
}
|
|
|
|
func TestMyOrgs(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
req := NewRequest(t, "GET", "/api/v1/user/orgs")
|
|
MakeRequest(t, req, http.StatusUnauthorized)
|
|
|
|
normalUsername := "user2"
|
|
token := getUserToken(t, normalUsername, auth_model.AccessTokenScopeReadOrganization, auth_model.AccessTokenScopeReadUser)
|
|
req = NewRequest(t, "GET", "/api/v1/user/orgs?token="+token)
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
var orgs []*api.Organization
|
|
DecodeJSON(t, resp, &orgs)
|
|
user3 := unittest.AssertExistsAndLoadBean(t, &user_model.User{Name: "user3"})
|
|
user17 := unittest.AssertExistsAndLoadBean(t, &user_model.User{Name: "user17"})
|
|
|
|
assert.Equal(t, []*api.Organization{
|
|
{
|
|
ID: 17,
|
|
Name: user17.Name,
|
|
UserName: user17.Name,
|
|
FullName: user17.FullName,
|
|
AvatarURL: user17.AvatarLink(db.DefaultContext),
|
|
Description: "",
|
|
Website: "",
|
|
Location: "",
|
|
Visibility: "public",
|
|
},
|
|
{
|
|
ID: 3,
|
|
Name: user3.Name,
|
|
UserName: user3.Name,
|
|
FullName: user3.FullName,
|
|
AvatarURL: user3.AvatarLink(db.DefaultContext),
|
|
Description: "",
|
|
Website: "",
|
|
Location: "",
|
|
Visibility: "public",
|
|
},
|
|
}, orgs)
|
|
}
|