mirror of
https://codeberg.org/forgejo/forgejo
synced 2024-11-25 11:16:11 +01:00
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
148 lines
4.8 KiB
Go
148 lines
4.8 KiB
Go
// Copyright 2020 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package integration
|
|
|
|
import (
|
|
"net/url"
|
|
"strings"
|
|
"testing"
|
|
|
|
auth_model "code.gitea.io/gitea/models/auth"
|
|
"code.gitea.io/gitea/models/organization"
|
|
"code.gitea.io/gitea/models/unittest"
|
|
user_model "code.gitea.io/gitea/models/user"
|
|
api "code.gitea.io/gitea/modules/structs"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestOrgCounts(t *testing.T) {
|
|
onGiteaRun(t, testOrgCounts)
|
|
}
|
|
|
|
func testOrgCounts(t *testing.T, u *url.URL) {
|
|
orgOwner := "user2"
|
|
orgName := "testOrg"
|
|
orgCollaborator := "user4"
|
|
ctx := NewAPITestContext(t, orgOwner, "repo1", auth_model.AccessTokenScopeAdminOrg)
|
|
|
|
var ownerCountRepos map[string]int
|
|
var collabCountRepos map[string]int
|
|
|
|
t.Run("GetTheOwnersNumRepos", doCheckOrgCounts(orgOwner, map[string]int{},
|
|
false,
|
|
func(_ *testing.T, calcOrgCounts map[string]int) {
|
|
ownerCountRepos = calcOrgCounts
|
|
},
|
|
))
|
|
t.Run("GetTheCollaboratorsNumRepos", doCheckOrgCounts(orgCollaborator, map[string]int{},
|
|
false,
|
|
func(_ *testing.T, calcOrgCounts map[string]int) {
|
|
collabCountRepos = calcOrgCounts
|
|
},
|
|
))
|
|
|
|
t.Run("CreatePublicTestOrganization", doAPICreateOrganization(ctx, &api.CreateOrgOption{
|
|
UserName: orgName,
|
|
Visibility: "public",
|
|
}))
|
|
|
|
// Following the creation of the organization, the orgName must appear in the counts with 0 repos
|
|
ownerCountRepos[orgName] = 0
|
|
|
|
t.Run("AssertNumRepos0ForTestOrg", doCheckOrgCounts(orgOwner, ownerCountRepos, true))
|
|
|
|
// the collaborator is not a collaborator yet
|
|
t.Run("AssertNoTestOrgReposForCollaborator", doCheckOrgCounts(orgCollaborator, collabCountRepos, true))
|
|
|
|
t.Run("CreateOrganizationPrivateRepo", doAPICreateOrganizationRepository(ctx, orgName, &api.CreateRepoOption{
|
|
Name: "privateTestRepo",
|
|
AutoInit: true,
|
|
Private: true,
|
|
}))
|
|
|
|
ownerCountRepos[orgName] = 1
|
|
t.Run("AssertNumRepos1ForTestOrg", doCheckOrgCounts(orgOwner, ownerCountRepos, true))
|
|
|
|
t.Run("AssertNoTestOrgReposForCollaborator", doCheckOrgCounts(orgCollaborator, collabCountRepos, true))
|
|
|
|
var testTeam api.Team
|
|
|
|
t.Run("CreateTeamForPublicTestOrganization", doAPICreateOrganizationTeam(ctx, orgName, &api.CreateTeamOption{
|
|
Name: "test",
|
|
Permission: "read",
|
|
Units: []string{"repo.code", "repo.issues", "repo.wiki", "repo.pulls", "repo.releases"},
|
|
CanCreateOrgRepo: true,
|
|
}, func(_ *testing.T, team api.Team) {
|
|
testTeam = team
|
|
}))
|
|
|
|
t.Run("AssertNoTestOrgReposForCollaborator", doCheckOrgCounts(orgCollaborator, collabCountRepos, true))
|
|
|
|
t.Run("AddCollboratorToTeam", doAPIAddUserToOrganizationTeam(ctx, testTeam.ID, orgCollaborator))
|
|
|
|
collabCountRepos[orgName] = 0
|
|
t.Run("AssertNumRepos0ForTestOrgForCollaborator", doCheckOrgCounts(orgOwner, ownerCountRepos, true))
|
|
|
|
// Now create a Public Repo
|
|
t.Run("CreateOrganizationPublicRepo", doAPICreateOrganizationRepository(ctx, orgName, &api.CreateRepoOption{
|
|
Name: "publicTestRepo",
|
|
AutoInit: true,
|
|
}))
|
|
|
|
ownerCountRepos[orgName] = 2
|
|
t.Run("AssertNumRepos2ForTestOrg", doCheckOrgCounts(orgOwner, ownerCountRepos, true))
|
|
collabCountRepos[orgName] = 1
|
|
t.Run("AssertNumRepos1ForTestOrgForCollaborator", doCheckOrgCounts(orgOwner, ownerCountRepos, true))
|
|
|
|
// Now add the testTeam to the privateRepo
|
|
t.Run("AddTestTeamToPrivateRepo", doAPIAddRepoToOrganizationTeam(ctx, testTeam.ID, orgName, "privateTestRepo"))
|
|
|
|
t.Run("AssertNumRepos2ForTestOrg", doCheckOrgCounts(orgOwner, ownerCountRepos, true))
|
|
collabCountRepos[orgName] = 2
|
|
t.Run("AssertNumRepos2ForTestOrgForCollaborator", doCheckOrgCounts(orgOwner, ownerCountRepos, true))
|
|
}
|
|
|
|
func doCheckOrgCounts(username string, orgCounts map[string]int, strict bool, callback ...func(*testing.T, map[string]int)) func(t *testing.T) {
|
|
canonicalCounts := make(map[string]int, len(orgCounts))
|
|
|
|
for key, value := range orgCounts {
|
|
newKey := strings.TrimSpace(strings.ToLower(key))
|
|
canonicalCounts[newKey] = value
|
|
}
|
|
|
|
return func(t *testing.T) {
|
|
user := unittest.AssertExistsAndLoadBean(t, &user_model.User{
|
|
Name: username,
|
|
})
|
|
|
|
orgs, err := organization.FindOrgs(organization.FindOrgOptions{
|
|
UserID: user.ID,
|
|
IncludePrivate: true,
|
|
})
|
|
assert.NoError(t, err)
|
|
|
|
calcOrgCounts := map[string]int{}
|
|
|
|
for _, org := range orgs {
|
|
calcOrgCounts[org.LowerName] = org.NumRepos
|
|
count, ok := canonicalCounts[org.LowerName]
|
|
if ok {
|
|
assert.True(t, count == org.NumRepos, "Number of Repos in %s is %d when we expected %d", org.Name, org.NumRepos, count)
|
|
} else {
|
|
assert.False(t, strict, "Did not expect to see %s with count %d", org.Name, org.NumRepos)
|
|
}
|
|
}
|
|
|
|
for key, value := range orgCounts {
|
|
_, seen := calcOrgCounts[strings.TrimSpace(strings.ToLower(key))]
|
|
assert.True(t, seen, "Expected to see %s with %d but did not", key, value)
|
|
}
|
|
|
|
if len(callback) > 0 {
|
|
callback[0](t, calcOrgCounts)
|
|
}
|
|
}
|
|
}
|