mirror of
				https://github.com/go-gitea/gitea
				synced 2025-11-03 21:08:25 +00:00 
			
		
		
		
	Support scoped access tokens (#20908)
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
This commit is contained in:
		@@ -16,6 +16,7 @@ import (
 | 
			
		||||
	"testing"
 | 
			
		||||
	"time"
 | 
			
		||||
 | 
			
		||||
	auth_model "code.gitea.io/gitea/models/auth"
 | 
			
		||||
	"code.gitea.io/gitea/models/db"
 | 
			
		||||
	issues_model "code.gitea.io/gitea/models/issues"
 | 
			
		||||
	"code.gitea.io/gitea/models/perm"
 | 
			
		||||
@@ -42,11 +43,11 @@ func TestGit(t *testing.T) {
 | 
			
		||||
 | 
			
		||||
func testGit(t *testing.T, u *url.URL) {
 | 
			
		||||
	username := "user2"
 | 
			
		||||
	baseAPITestContext := NewAPITestContext(t, username, "repo1")
 | 
			
		||||
	baseAPITestContext := NewAPITestContext(t, username, "repo1", auth_model.AccessTokenScopeRepo, auth_model.AccessTokenScopeWritePublicKey, auth_model.AccessTokenScopeDeleteRepo)
 | 
			
		||||
 | 
			
		||||
	u.Path = baseAPITestContext.GitPath()
 | 
			
		||||
 | 
			
		||||
	forkedUserCtx := NewAPITestContext(t, "user4", "repo1")
 | 
			
		||||
	forkedUserCtx := NewAPITestContext(t, "user4", "repo1", auth_model.AccessTokenScopeRepo)
 | 
			
		||||
 | 
			
		||||
	t.Run("HTTP", func(t *testing.T) {
 | 
			
		||||
		defer tests.PrintCurrentTest(t)()
 | 
			
		||||
@@ -357,7 +358,7 @@ func doBranchProtectPRMerge(baseCtx *APITestContext, dstPath string) func(t *tes
 | 
			
		||||
		t.Run("CreateBranchProtected", doGitCreateBranch(dstPath, "protected"))
 | 
			
		||||
		t.Run("PushProtectedBranch", doGitPushTestRepository(dstPath, "origin", "protected"))
 | 
			
		||||
 | 
			
		||||
		ctx := NewAPITestContext(t, baseCtx.Username, baseCtx.Reponame)
 | 
			
		||||
		ctx := NewAPITestContext(t, baseCtx.Username, baseCtx.Reponame, auth_model.AccessTokenScopeRepo)
 | 
			
		||||
		t.Run("ProtectProtectedBranchNoWhitelist", doProtectBranch(ctx, "protected", "", ""))
 | 
			
		||||
		t.Run("GenerateCommit", func(t *testing.T) {
 | 
			
		||||
			_, err := generateCommitWithNewData(littleSize, dstPath, "user2@example.com", "User Two", "branch-data-file-")
 | 
			
		||||
@@ -601,7 +602,7 @@ func doAutoPRMerge(baseCtx *APITestContext, dstPath string) func(t *testing.T) {
 | 
			
		||||
	return func(t *testing.T) {
 | 
			
		||||
		defer tests.PrintCurrentTest(t)()
 | 
			
		||||
 | 
			
		||||
		ctx := NewAPITestContext(t, baseCtx.Username, baseCtx.Reponame)
 | 
			
		||||
		ctx := NewAPITestContext(t, baseCtx.Username, baseCtx.Reponame, auth_model.AccessTokenScopeRepo)
 | 
			
		||||
 | 
			
		||||
		t.Run("CheckoutProtected", doGitCheckoutBranch(dstPath, "protected"))
 | 
			
		||||
		t.Run("PullProtected", doGitPull(dstPath, "origin", "protected"))
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user