forked from mirror/gitea
de484e86bc
This PR adds the support for scopes of access tokens, mimicking the design of GitHub OAuth scopes. The changes of the core logic are in `models/auth` that `AccessToken` struct will have a `Scope` field. The normalized (no duplication of scope), comma-separated scope string will be stored in `access_token` table in the database. In `services/auth`, the scope will be stored in context, which will be used by `reqToken` middleware in API calls. Only OAuth2 tokens will have granular token scopes, while others like BasicAuth will default to scope `all`. A large amount of work happens in `routers/api/v1/api.go` and the corresponding `tests/integration` tests, that is adding necessary scopes to each of the API calls as they fit. - [x] Add `Scope` field to `AccessToken` - [x] Add access control to all API endpoints - [x] Update frontend & backend for when creating tokens - [x] Add a database migration for `scope` column (enable 'all' access to past tokens) I'm aiming to complete it before Gitea 1.19 release. Fixes #4300
151 lines
4.4 KiB
Go
151 lines
4.4 KiB
Go
// Copyright 2021 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"
|
|
api "code.gitea.io/gitea/modules/structs"
|
|
"code.gitea.io/gitea/tests"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
type apiUserOrgPermTestCase struct {
|
|
LoginUser string
|
|
User string
|
|
Organization string
|
|
ExpectedOrganizationPermissions api.OrganizationPermissions
|
|
}
|
|
|
|
func TestTokenNeeded(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
req := NewRequest(t, "GET", "/api/v1/users/user1/orgs/user6/permissions")
|
|
MakeRequest(t, req, http.StatusUnauthorized)
|
|
}
|
|
|
|
func sampleTest(t *testing.T, auoptc apiUserOrgPermTestCase) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
session := loginUser(t, auoptc.LoginUser)
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeReadOrg)
|
|
|
|
req := NewRequest(t, "GET", fmt.Sprintf("/api/v1/users/%s/orgs/%s/permissions?token=%s", auoptc.User, auoptc.Organization, token))
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
|
|
var apiOP api.OrganizationPermissions
|
|
DecodeJSON(t, resp, &apiOP)
|
|
assert.Equal(t, auoptc.ExpectedOrganizationPermissions.IsOwner, apiOP.IsOwner)
|
|
assert.Equal(t, auoptc.ExpectedOrganizationPermissions.IsAdmin, apiOP.IsAdmin)
|
|
assert.Equal(t, auoptc.ExpectedOrganizationPermissions.CanWrite, apiOP.CanWrite)
|
|
assert.Equal(t, auoptc.ExpectedOrganizationPermissions.CanRead, apiOP.CanRead)
|
|
assert.Equal(t, auoptc.ExpectedOrganizationPermissions.CanCreateRepository, apiOP.CanCreateRepository)
|
|
}
|
|
|
|
func TestWithOwnerUser(t *testing.T) {
|
|
sampleTest(t, apiUserOrgPermTestCase{
|
|
LoginUser: "user2",
|
|
User: "user2",
|
|
Organization: "user3",
|
|
ExpectedOrganizationPermissions: api.OrganizationPermissions{
|
|
IsOwner: true,
|
|
IsAdmin: true,
|
|
CanWrite: true,
|
|
CanRead: true,
|
|
CanCreateRepository: true,
|
|
},
|
|
})
|
|
}
|
|
|
|
func TestCanWriteUser(t *testing.T) {
|
|
sampleTest(t, apiUserOrgPermTestCase{
|
|
LoginUser: "user4",
|
|
User: "user4",
|
|
Organization: "user3",
|
|
ExpectedOrganizationPermissions: api.OrganizationPermissions{
|
|
IsOwner: false,
|
|
IsAdmin: false,
|
|
CanWrite: true,
|
|
CanRead: true,
|
|
CanCreateRepository: false,
|
|
},
|
|
})
|
|
}
|
|
|
|
func TestAdminUser(t *testing.T) {
|
|
sampleTest(t, apiUserOrgPermTestCase{
|
|
LoginUser: "user1",
|
|
User: "user28",
|
|
Organization: "user3",
|
|
ExpectedOrganizationPermissions: api.OrganizationPermissions{
|
|
IsOwner: false,
|
|
IsAdmin: true,
|
|
CanWrite: true,
|
|
CanRead: true,
|
|
CanCreateRepository: true,
|
|
},
|
|
})
|
|
}
|
|
|
|
func TestAdminCanNotCreateRepo(t *testing.T) {
|
|
sampleTest(t, apiUserOrgPermTestCase{
|
|
LoginUser: "user1",
|
|
User: "user28",
|
|
Organization: "user6",
|
|
ExpectedOrganizationPermissions: api.OrganizationPermissions{
|
|
IsOwner: false,
|
|
IsAdmin: true,
|
|
CanWrite: true,
|
|
CanRead: true,
|
|
CanCreateRepository: false,
|
|
},
|
|
})
|
|
}
|
|
|
|
func TestCanReadUser(t *testing.T) {
|
|
sampleTest(t, apiUserOrgPermTestCase{
|
|
LoginUser: "user1",
|
|
User: "user24",
|
|
Organization: "org25",
|
|
ExpectedOrganizationPermissions: api.OrganizationPermissions{
|
|
IsOwner: false,
|
|
IsAdmin: false,
|
|
CanWrite: false,
|
|
CanRead: true,
|
|
CanCreateRepository: false,
|
|
},
|
|
})
|
|
}
|
|
|
|
func TestUnknowUser(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
session := loginUser(t, "user1")
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeReadOrg)
|
|
|
|
req := NewRequest(t, "GET", fmt.Sprintf("/api/v1/users/unknow/orgs/org25/permissions?token=%s", token))
|
|
resp := MakeRequest(t, req, http.StatusNotFound)
|
|
|
|
var apiError api.APIError
|
|
DecodeJSON(t, resp, &apiError)
|
|
assert.Equal(t, "user redirect does not exist [name: unknow]", apiError.Message)
|
|
}
|
|
|
|
func TestUnknowOrganization(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
session := loginUser(t, "user1")
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeReadOrg)
|
|
|
|
req := NewRequest(t, "GET", fmt.Sprintf("/api/v1/users/user1/orgs/unknow/permissions?token=%s", token))
|
|
resp := MakeRequest(t, req, http.StatusNotFound)
|
|
var apiError api.APIError
|
|
DecodeJSON(t, resp, &apiError)
|
|
assert.Equal(t, "GetUserByName", apiError.Message)
|
|
}
|