mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-12-27 18:04:04 -05: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
84 lines
3 KiB
Go
84 lines
3 KiB
Go
// Copyright 2022 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package auth
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestAccessTokenScope_Normalize(t *testing.T) {
|
|
tests := []struct {
|
|
in AccessTokenScope
|
|
out AccessTokenScope
|
|
err error
|
|
}{
|
|
{"", "", nil},
|
|
{"repo", "repo", nil},
|
|
{"repo,repo:status", "repo", nil},
|
|
{"repo,public_repo", "repo", nil},
|
|
{"admin:public_key,write:public_key", "admin:public_key", nil},
|
|
{"admin:public_key,read:public_key", "admin:public_key", nil},
|
|
{"write:public_key,read:public_key", "write:public_key", nil}, // read is include in write
|
|
{"admin:repo_hook,write:repo_hook", "admin:repo_hook", nil},
|
|
{"admin:repo_hook,read:repo_hook", "admin:repo_hook", nil},
|
|
{"repo,admin:repo_hook,read:repo_hook", "repo", nil}, // admin:repo_hook is a child scope of repo
|
|
{"repo,read:repo_hook", "repo", nil}, // read:repo_hook is a child scope of repo
|
|
{"user", "user", nil},
|
|
{"user,read:user", "user", nil},
|
|
{"user,admin:org,write:org", "admin:org,user", nil},
|
|
{"admin:org,write:org,user", "admin:org,user", nil},
|
|
{"package", "package", nil},
|
|
{"package,write:package", "package", nil},
|
|
{"package,write:package,delete:package", "package", nil},
|
|
{"write:package,read:package", "write:package", nil}, // read is include in write
|
|
{"write:package,delete:package", "write:package,delete:package", nil}, // write and delete are not include in each other
|
|
{"admin:gpg_key", "admin:gpg_key", nil},
|
|
{"admin:gpg_key,write:gpg_key", "admin:gpg_key", nil},
|
|
{"admin:gpg_key,write:gpg_key,user", "user,admin:gpg_key", nil},
|
|
{"admin:application,write:application,user", "user,admin:application", nil},
|
|
{"all", "all", nil},
|
|
{"repo,admin:org,admin:public_key,admin:repo_hook,admin:org_hook,notification,user,delete_repo,package,admin:gpg_key,admin:application", "all", nil},
|
|
{"repo,admin:org,admin:public_key,admin:repo_hook,admin:org_hook,notification,user,delete_repo,package,admin:gpg_key,admin:application,sudo", "all,sudo", nil},
|
|
}
|
|
|
|
for _, test := range tests {
|
|
t.Run(string(test.in), func(t *testing.T) {
|
|
scope, err := test.in.Normalize()
|
|
assert.Equal(t, test.out, scope)
|
|
assert.Equal(t, test.err, err)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestAccessTokenScope_HasScope(t *testing.T) {
|
|
tests := []struct {
|
|
in AccessTokenScope
|
|
scope AccessTokenScope
|
|
out bool
|
|
err error
|
|
}{
|
|
{"repo", "repo", true, nil},
|
|
{"repo", "repo:status", true, nil},
|
|
{"repo", "public_repo", true, nil},
|
|
{"repo", "admin:org", false, nil},
|
|
{"repo", "admin:public_key", false, nil},
|
|
{"repo:status", "repo", false, nil},
|
|
{"repo:status", "public_repo", false, nil},
|
|
{"admin:org", "write:org", true, nil},
|
|
{"admin:org", "read:org", true, nil},
|
|
{"admin:org", "admin:org", true, nil},
|
|
{"user", "read:user", true, nil},
|
|
{"package", "write:package", true, nil},
|
|
}
|
|
|
|
for _, test := range tests {
|
|
t.Run(string(test.in), func(t *testing.T) {
|
|
scope, err := test.in.HasScope(test.scope)
|
|
assert.Equal(t, test.out, scope)
|
|
assert.Equal(t, test.err, err)
|
|
})
|
|
}
|
|
}
|