mirror of
				https://gitee.com/gitea/gitea
				synced 2025-11-04 08:30:25 +08: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:
		@@ -8,6 +8,7 @@ import (
 | 
			
		||||
	"net/url"
 | 
			
		||||
	"testing"
 | 
			
		||||
 | 
			
		||||
	auth_model "code.gitea.io/gitea/models/auth"
 | 
			
		||||
	api "code.gitea.io/gitea/modules/structs"
 | 
			
		||||
	"code.gitea.io/gitea/tests"
 | 
			
		||||
 | 
			
		||||
@@ -15,7 +16,7 @@ import (
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
func testAPIGetBranch(t *testing.T, branchName string, exists bool) {
 | 
			
		||||
	token := getUserToken(t, "user2")
 | 
			
		||||
	token := getUserToken(t, "user2", auth_model.AccessTokenScopeRepo)
 | 
			
		||||
	req := NewRequestf(t, "GET", "/api/v1/repos/user2/repo1/branches/%s?token=%s", branchName, token)
 | 
			
		||||
	resp := MakeRequest(t, req, NoExpectedStatus)
 | 
			
		||||
	if !exists {
 | 
			
		||||
@@ -31,7 +32,7 @@ func testAPIGetBranch(t *testing.T, branchName string, exists bool) {
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func testAPIGetBranchProtection(t *testing.T, branchName string, expectedHTTPStatus int) {
 | 
			
		||||
	token := getUserToken(t, "user2")
 | 
			
		||||
	token := getUserToken(t, "user2", auth_model.AccessTokenScopeRepo)
 | 
			
		||||
	req := NewRequestf(t, "GET", "/api/v1/repos/user2/repo1/branch_protections/%s?token=%s", branchName, token)
 | 
			
		||||
	resp := MakeRequest(t, req, expectedHTTPStatus)
 | 
			
		||||
 | 
			
		||||
@@ -43,7 +44,7 @@ func testAPIGetBranchProtection(t *testing.T, branchName string, expectedHTTPSta
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func testAPICreateBranchProtection(t *testing.T, branchName string, expectedHTTPStatus int) {
 | 
			
		||||
	token := getUserToken(t, "user2")
 | 
			
		||||
	token := getUserToken(t, "user2", auth_model.AccessTokenScopeRepo)
 | 
			
		||||
	req := NewRequestWithJSON(t, "POST", "/api/v1/repos/user2/repo1/branch_protections?token="+token, &api.BranchProtection{
 | 
			
		||||
		RuleName: branchName,
 | 
			
		||||
	})
 | 
			
		||||
@@ -57,7 +58,7 @@ func testAPICreateBranchProtection(t *testing.T, branchName string, expectedHTTP
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func testAPIEditBranchProtection(t *testing.T, branchName string, body *api.BranchProtection, expectedHTTPStatus int) {
 | 
			
		||||
	token := getUserToken(t, "user2")
 | 
			
		||||
	token := getUserToken(t, "user2", auth_model.AccessTokenScopeRepo)
 | 
			
		||||
	req := NewRequestWithJSON(t, "PATCH", "/api/v1/repos/user2/repo1/branch_protections/"+branchName+"?token="+token, body)
 | 
			
		||||
	resp := MakeRequest(t, req, expectedHTTPStatus)
 | 
			
		||||
 | 
			
		||||
@@ -69,13 +70,13 @@ func testAPIEditBranchProtection(t *testing.T, branchName string, body *api.Bran
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func testAPIDeleteBranchProtection(t *testing.T, branchName string, expectedHTTPStatus int) {
 | 
			
		||||
	token := getUserToken(t, "user2")
 | 
			
		||||
	token := getUserToken(t, "user2", auth_model.AccessTokenScopeRepo)
 | 
			
		||||
	req := NewRequestf(t, "DELETE", "/api/v1/repos/user2/repo1/branch_protections/%s?token=%s", branchName, token)
 | 
			
		||||
	MakeRequest(t, req, expectedHTTPStatus)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func testAPIDeleteBranch(t *testing.T, branchName string, expectedHTTPStatus int) {
 | 
			
		||||
	token := getUserToken(t, "user2")
 | 
			
		||||
	token := getUserToken(t, "user2", auth_model.AccessTokenScopeRepo)
 | 
			
		||||
	req := NewRequestf(t, "DELETE", "/api/v1/repos/user2/repo1/branches/%s?token=%s", branchName, token)
 | 
			
		||||
	MakeRequest(t, req, expectedHTTPStatus)
 | 
			
		||||
}
 | 
			
		||||
@@ -101,7 +102,7 @@ func TestAPICreateBranch(t *testing.T) {
 | 
			
		||||
 | 
			
		||||
func testAPICreateBranches(t *testing.T, giteaURL *url.URL) {
 | 
			
		||||
	username := "user2"
 | 
			
		||||
	ctx := NewAPITestContext(t, username, "my-noo-repo")
 | 
			
		||||
	ctx := NewAPITestContext(t, username, "my-noo-repo", auth_model.AccessTokenScopeRepo)
 | 
			
		||||
	giteaURL.Path = ctx.GitPath()
 | 
			
		||||
 | 
			
		||||
	t.Run("CreateRepo", doAPICreateRepository(ctx, false))
 | 
			
		||||
@@ -149,7 +150,7 @@ func testAPICreateBranches(t *testing.T, giteaURL *url.URL) {
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func testAPICreateBranch(t testing.TB, session *TestSession, user, repo, oldBranch, newBranch string, status int) bool {
 | 
			
		||||
	token := getTokenForLoggedInUser(t, session)
 | 
			
		||||
	token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeRepo)
 | 
			
		||||
	req := NewRequestWithJSON(t, "POST", "/api/v1/repos/"+user+"/"+repo+"/branches?token="+token, &api.CreateBranchRepoOption{
 | 
			
		||||
		BranchName:    newBranch,
 | 
			
		||||
		OldBranchName: oldBranch,
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user