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 (
 | 
			
		||||
	"testing"
 | 
			
		||||
 | 
			
		||||
	asymkey_model "code.gitea.io/gitea/models/asymkey"
 | 
			
		||||
	auth_model "code.gitea.io/gitea/models/auth"
 | 
			
		||||
	"code.gitea.io/gitea/models/unittest"
 | 
			
		||||
	user_model "code.gitea.io/gitea/models/user"
 | 
			
		||||
	"code.gitea.io/gitea/modules/json"
 | 
			
		||||
@@ -24,7 +25,7 @@ func TestAPIAdminCreateAndDeleteSSHKey(t *testing.T) {
 | 
			
		||||
	session := loginUser(t, "user1")
 | 
			
		||||
	keyOwner := unittest.AssertExistsAndLoadBean(t, &user_model.User{Name: "user2"})
 | 
			
		||||
 | 
			
		||||
	token := getTokenForLoggedInUser(t, session)
 | 
			
		||||
	token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeSudo)
 | 
			
		||||
	urlStr := fmt.Sprintf("/api/v1/admin/users/%s/keys?token=%s", keyOwner.Name, token)
 | 
			
		||||
	req := NewRequestWithValues(t, "POST", urlStr, map[string]string{
 | 
			
		||||
		"key":   "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQC4cn+iXnA4KvcQYSV88vGn0Yi91vG47t1P7okprVmhNTkipNRIHWr6WdCO4VDr/cvsRkuVJAsLO2enwjGWWueOO6BodiBgyAOZ/5t5nJNMCNuLGT5UIo/RI1b0WRQwxEZTRjt6mFNw6lH14wRd8ulsr9toSWBPMOGWoYs1PDeDL0JuTjL+tr1SZi/EyxCngpYszKdXllJEHyI79KQgeD0Vt3pTrkbNVTOEcCNqZePSVmUH8X8Vhugz3bnE0/iE9Pb5fkWO9c4AnM1FgI/8Bvp27Fw2ShryIXuR6kKvUqhVMTuOSDHwu6A8jLE5Owt3GAYugDpDYuwTVNGrHLXKpPzrGGPE/jPmaLCMZcsdkec95dYeU3zKODEm8UQZFhmJmDeWVJ36nGrGZHL4J5aTTaeFUJmmXDaJYiJ+K2/ioKgXqnXvltu0A9R8/LGy4nrTJRr4JMLuJFoUXvGm1gXQ70w2LSpk6yl71RNC0hCtsBe8BP8IhYCM0EP5jh7eCMQZNvM= nocomment\n",
 | 
			
		||||
@@ -51,7 +52,7 @@ func TestAPIAdminDeleteMissingSSHKey(t *testing.T) {
 | 
			
		||||
	defer tests.PrepareTestEnv(t)()
 | 
			
		||||
 | 
			
		||||
	// user1 is an admin user
 | 
			
		||||
	token := getUserToken(t, "user1")
 | 
			
		||||
	token := getUserToken(t, "user1", auth_model.AccessTokenScopeSudo)
 | 
			
		||||
	req := NewRequestf(t, "DELETE", "/api/v1/admin/users/user1/keys/%d?token=%s", unittest.NonexistentID, token)
 | 
			
		||||
	MakeRequest(t, req, http.StatusNotFound)
 | 
			
		||||
}
 | 
			
		||||
@@ -60,7 +61,7 @@ func TestAPIAdminDeleteUnauthorizedKey(t *testing.T) {
 | 
			
		||||
	defer tests.PrepareTestEnv(t)()
 | 
			
		||||
	adminUsername := "user1"
 | 
			
		||||
	normalUsername := "user2"
 | 
			
		||||
	token := getUserToken(t, adminUsername)
 | 
			
		||||
	token := getUserToken(t, adminUsername, auth_model.AccessTokenScopeSudo)
 | 
			
		||||
 | 
			
		||||
	urlStr := fmt.Sprintf("/api/v1/admin/users/%s/keys?token=%s", adminUsername, token)
 | 
			
		||||
	req := NewRequestWithValues(t, "POST", urlStr, map[string]string{
 | 
			
		||||
@@ -81,7 +82,7 @@ func TestAPISudoUser(t *testing.T) {
 | 
			
		||||
	defer tests.PrepareTestEnv(t)()
 | 
			
		||||
	adminUsername := "user1"
 | 
			
		||||
	normalUsername := "user2"
 | 
			
		||||
	token := getUserToken(t, adminUsername)
 | 
			
		||||
	token := getUserToken(t, adminUsername, auth_model.AccessTokenScopeSudo)
 | 
			
		||||
 | 
			
		||||
	urlStr := fmt.Sprintf("/api/v1/user?sudo=%s&token=%s", normalUsername, token)
 | 
			
		||||
	req := NewRequest(t, "GET", urlStr)
 | 
			
		||||
@@ -97,7 +98,7 @@ func TestAPISudoUserForbidden(t *testing.T) {
 | 
			
		||||
	adminUsername := "user1"
 | 
			
		||||
	normalUsername := "user2"
 | 
			
		||||
 | 
			
		||||
	token := getUserToken(t, normalUsername)
 | 
			
		||||
	token := getUserToken(t, normalUsername, auth_model.AccessTokenScopeSudo)
 | 
			
		||||
	urlStr := fmt.Sprintf("/api/v1/user?sudo=%s&token=%s", adminUsername, token)
 | 
			
		||||
	req := NewRequest(t, "GET", urlStr)
 | 
			
		||||
	MakeRequest(t, req, http.StatusForbidden)
 | 
			
		||||
@@ -106,7 +107,7 @@ func TestAPISudoUserForbidden(t *testing.T) {
 | 
			
		||||
func TestAPIListUsers(t *testing.T) {
 | 
			
		||||
	defer tests.PrepareTestEnv(t)()
 | 
			
		||||
	adminUsername := "user1"
 | 
			
		||||
	token := getUserToken(t, adminUsername)
 | 
			
		||||
	token := getUserToken(t, adminUsername, auth_model.AccessTokenScopeSudo)
 | 
			
		||||
 | 
			
		||||
	urlStr := fmt.Sprintf("/api/v1/admin/users?token=%s", token)
 | 
			
		||||
	req := NewRequest(t, "GET", urlStr)
 | 
			
		||||
@@ -142,7 +143,7 @@ func TestAPIListUsersNonAdmin(t *testing.T) {
 | 
			
		||||
func TestAPICreateUserInvalidEmail(t *testing.T) {
 | 
			
		||||
	defer tests.PrepareTestEnv(t)()
 | 
			
		||||
	adminUsername := "user1"
 | 
			
		||||
	token := getUserToken(t, adminUsername)
 | 
			
		||||
	token := getUserToken(t, adminUsername, auth_model.AccessTokenScopeSudo)
 | 
			
		||||
	urlStr := fmt.Sprintf("/api/v1/admin/users?token=%s", token)
 | 
			
		||||
	req := NewRequestWithValues(t, "POST", urlStr, map[string]string{
 | 
			
		||||
		"email":                "invalid_email@domain.com\r\n",
 | 
			
		||||
@@ -160,7 +161,7 @@ func TestAPICreateUserInvalidEmail(t *testing.T) {
 | 
			
		||||
func TestAPICreateAndDeleteUser(t *testing.T) {
 | 
			
		||||
	defer tests.PrepareTestEnv(t)()
 | 
			
		||||
	adminUsername := "user1"
 | 
			
		||||
	token := getUserToken(t, adminUsername)
 | 
			
		||||
	token := getUserToken(t, adminUsername, auth_model.AccessTokenScopeSudo)
 | 
			
		||||
 | 
			
		||||
	req := NewRequestWithValues(
 | 
			
		||||
		t,
 | 
			
		||||
@@ -186,7 +187,7 @@ func TestAPICreateAndDeleteUser(t *testing.T) {
 | 
			
		||||
func TestAPIEditUser(t *testing.T) {
 | 
			
		||||
	defer tests.PrepareTestEnv(t)()
 | 
			
		||||
	adminUsername := "user1"
 | 
			
		||||
	token := getUserToken(t, adminUsername)
 | 
			
		||||
	token := getUserToken(t, adminUsername, auth_model.AccessTokenScopeSudo)
 | 
			
		||||
	urlStr := fmt.Sprintf("/api/v1/admin/users/%s?token=%s", "user2", token)
 | 
			
		||||
 | 
			
		||||
	req := NewRequestWithValues(t, "PATCH", urlStr, map[string]string{
 | 
			
		||||
@@ -228,7 +229,7 @@ func TestAPIEditUser(t *testing.T) {
 | 
			
		||||
func TestAPICreateRepoForUser(t *testing.T) {
 | 
			
		||||
	defer tests.PrepareTestEnv(t)()
 | 
			
		||||
	adminUsername := "user1"
 | 
			
		||||
	token := getUserToken(t, adminUsername)
 | 
			
		||||
	token := getUserToken(t, adminUsername, auth_model.AccessTokenScopeSudo)
 | 
			
		||||
 | 
			
		||||
	req := NewRequestWithJSON(
 | 
			
		||||
		t,
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user