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:
		@@ -9,6 +9,7 @@ import (
 | 
			
		||||
	"sort"
 | 
			
		||||
	"testing"
 | 
			
		||||
 | 
			
		||||
	auth_model "code.gitea.io/gitea/models/auth"
 | 
			
		||||
	"code.gitea.io/gitea/models/organization"
 | 
			
		||||
	"code.gitea.io/gitea/models/repo"
 | 
			
		||||
	"code.gitea.io/gitea/models/unit"
 | 
			
		||||
@@ -29,7 +30,7 @@ func TestAPITeam(t *testing.T) {
 | 
			
		||||
	user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: teamUser.UID})
 | 
			
		||||
 | 
			
		||||
	session := loginUser(t, user.Name)
 | 
			
		||||
	token := getTokenForLoggedInUser(t, session)
 | 
			
		||||
	token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeAdminOrg)
 | 
			
		||||
	req := NewRequestf(t, "GET", "/api/v1/teams/%d?token="+token, teamUser.TeamID)
 | 
			
		||||
	resp := MakeRequest(t, req, http.StatusOK)
 | 
			
		||||
 | 
			
		||||
@@ -43,7 +44,7 @@ func TestAPITeam(t *testing.T) {
 | 
			
		||||
	user2 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: teamUser2.UID})
 | 
			
		||||
 | 
			
		||||
	session = loginUser(t, user2.Name)
 | 
			
		||||
	token = getTokenForLoggedInUser(t, session)
 | 
			
		||||
	token = getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeReadOrg)
 | 
			
		||||
	req = NewRequestf(t, "GET", "/api/v1/teams/%d?token="+token, teamUser.TeamID)
 | 
			
		||||
	_ = MakeRequest(t, req, http.StatusForbidden)
 | 
			
		||||
 | 
			
		||||
@@ -53,7 +54,7 @@ func TestAPITeam(t *testing.T) {
 | 
			
		||||
	// Get an admin user able to create, update and delete teams.
 | 
			
		||||
	user = unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 1})
 | 
			
		||||
	session = loginUser(t, user.Name)
 | 
			
		||||
	token = getTokenForLoggedInUser(t, session)
 | 
			
		||||
	token = getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeAdminOrg)
 | 
			
		||||
 | 
			
		||||
	org := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 6})
 | 
			
		||||
 | 
			
		||||
@@ -227,7 +228,7 @@ func TestAPITeamSearch(t *testing.T) {
 | 
			
		||||
 | 
			
		||||
	var results TeamSearchResults
 | 
			
		||||
 | 
			
		||||
	token := getUserToken(t, user.Name)
 | 
			
		||||
	token := getUserToken(t, user.Name, auth_model.AccessTokenScopeReadOrg)
 | 
			
		||||
	req := NewRequestf(t, "GET", "/api/v1/orgs/%s/teams/search?q=%s&token=%s", org.Name, "_team", token)
 | 
			
		||||
	resp := MakeRequest(t, req, http.StatusOK)
 | 
			
		||||
	DecodeJSON(t, resp, &results)
 | 
			
		||||
@@ -237,7 +238,7 @@ func TestAPITeamSearch(t *testing.T) {
 | 
			
		||||
 | 
			
		||||
	// no access if not organization member
 | 
			
		||||
	user5 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 5})
 | 
			
		||||
	token5 := getUserToken(t, user5.Name)
 | 
			
		||||
	token5 := getUserToken(t, user5.Name, auth_model.AccessTokenScopeReadOrg)
 | 
			
		||||
 | 
			
		||||
	req = NewRequestf(t, "GET", "/api/v1/orgs/%s/teams/search?q=%s&token=%s", org.Name, "team", token5)
 | 
			
		||||
	MakeRequest(t, req, http.StatusForbidden)
 | 
			
		||||
@@ -252,7 +253,7 @@ func TestAPIGetTeamRepo(t *testing.T) {
 | 
			
		||||
 | 
			
		||||
	var results api.Repository
 | 
			
		||||
 | 
			
		||||
	token := getUserToken(t, user.Name)
 | 
			
		||||
	token := getUserToken(t, user.Name, auth_model.AccessTokenScopeReadOrg)
 | 
			
		||||
	req := NewRequestf(t, "GET", "/api/v1/teams/%d/repos/%s/?token=%s", team.ID, teamRepo.FullName(), token)
 | 
			
		||||
	resp := MakeRequest(t, req, http.StatusOK)
 | 
			
		||||
	DecodeJSON(t, resp, &results)
 | 
			
		||||
@@ -260,7 +261,7 @@ func TestAPIGetTeamRepo(t *testing.T) {
 | 
			
		||||
 | 
			
		||||
	// no access if not organization member
 | 
			
		||||
	user5 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 5})
 | 
			
		||||
	token5 := getUserToken(t, user5.Name)
 | 
			
		||||
	token5 := getUserToken(t, user5.Name, auth_model.AccessTokenScopeReadOrg)
 | 
			
		||||
 | 
			
		||||
	req = NewRequestf(t, "GET", "/api/v1/teams/%d/repos/%s/?token=%s", team.ID, teamRepo.FullName(), token5)
 | 
			
		||||
	MakeRequest(t, req, http.StatusNotFound)
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user