mirror of
				https://github.com/go-gitea/gitea
				synced 2025-11-04 05:18:25 +00:00 
			
		
		
		
	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
		
			
				
	
	
		
			113 lines
		
	
	
		
			2.8 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			113 lines
		
	
	
		
			2.8 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
// Copyright 2021 The Gitea Authors. All rights reserved.
 | 
						|
// SPDX-License-Identifier: MIT
 | 
						|
 | 
						|
package integration
 | 
						|
 | 
						|
import (
 | 
						|
	"net/http"
 | 
						|
	"testing"
 | 
						|
 | 
						|
	auth_model "code.gitea.io/gitea/models/auth"
 | 
						|
	api "code.gitea.io/gitea/modules/structs"
 | 
						|
	"code.gitea.io/gitea/tests"
 | 
						|
 | 
						|
	"github.com/stretchr/testify/assert"
 | 
						|
)
 | 
						|
 | 
						|
func TestAPIListEmails(t *testing.T) {
 | 
						|
	defer tests.PrepareTestEnv(t)()
 | 
						|
 | 
						|
	normalUsername := "user2"
 | 
						|
	session := loginUser(t, normalUsername)
 | 
						|
	token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeReadUser)
 | 
						|
 | 
						|
	req := NewRequest(t, "GET", "/api/v1/user/emails?token="+token)
 | 
						|
	resp := MakeRequest(t, req, http.StatusOK)
 | 
						|
 | 
						|
	var emails []*api.Email
 | 
						|
	DecodeJSON(t, resp, &emails)
 | 
						|
 | 
						|
	assert.EqualValues(t, []*api.Email{
 | 
						|
		{
 | 
						|
			Email:    "user2@example.com",
 | 
						|
			Verified: true,
 | 
						|
			Primary:  true,
 | 
						|
		},
 | 
						|
		{
 | 
						|
			Email:    "user2-2@example.com",
 | 
						|
			Verified: false,
 | 
						|
			Primary:  false,
 | 
						|
		},
 | 
						|
	}, emails)
 | 
						|
}
 | 
						|
 | 
						|
func TestAPIAddEmail(t *testing.T) {
 | 
						|
	defer tests.PrepareTestEnv(t)()
 | 
						|
 | 
						|
	normalUsername := "user2"
 | 
						|
	session := loginUser(t, normalUsername)
 | 
						|
	token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeUser)
 | 
						|
 | 
						|
	opts := api.CreateEmailOption{
 | 
						|
		Emails: []string{"user101@example.com"},
 | 
						|
	}
 | 
						|
 | 
						|
	req := NewRequestWithJSON(t, "POST", "/api/v1/user/emails?token="+token, &opts)
 | 
						|
	MakeRequest(t, req, http.StatusUnprocessableEntity)
 | 
						|
 | 
						|
	opts = api.CreateEmailOption{
 | 
						|
		Emails: []string{"user2-3@example.com"},
 | 
						|
	}
 | 
						|
	req = NewRequestWithJSON(t, "POST", "/api/v1/user/emails?token="+token, &opts)
 | 
						|
	resp := MakeRequest(t, req, http.StatusCreated)
 | 
						|
 | 
						|
	var emails []*api.Email
 | 
						|
	DecodeJSON(t, resp, &emails)
 | 
						|
	assert.EqualValues(t, []*api.Email{
 | 
						|
		{
 | 
						|
			Email:    "user2-3@example.com",
 | 
						|
			Verified: true,
 | 
						|
			Primary:  false,
 | 
						|
		},
 | 
						|
	}, emails)
 | 
						|
 | 
						|
	opts = api.CreateEmailOption{
 | 
						|
		Emails: []string{"notAEmail"},
 | 
						|
	}
 | 
						|
	req = NewRequestWithJSON(t, "POST", "/api/v1/user/emails?token="+token, &opts)
 | 
						|
	MakeRequest(t, req, http.StatusUnprocessableEntity)
 | 
						|
}
 | 
						|
 | 
						|
func TestAPIDeleteEmail(t *testing.T) {
 | 
						|
	defer tests.PrepareTestEnv(t)()
 | 
						|
 | 
						|
	normalUsername := "user2"
 | 
						|
	session := loginUser(t, normalUsername)
 | 
						|
	token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeUser)
 | 
						|
 | 
						|
	opts := api.DeleteEmailOption{
 | 
						|
		Emails: []string{"user2-3@example.com"},
 | 
						|
	}
 | 
						|
	req := NewRequestWithJSON(t, "DELETE", "/api/v1/user/emails?token="+token, &opts)
 | 
						|
	MakeRequest(t, req, http.StatusNotFound)
 | 
						|
 | 
						|
	opts = api.DeleteEmailOption{
 | 
						|
		Emails: []string{"user2-2@example.com"},
 | 
						|
	}
 | 
						|
	req = NewRequestWithJSON(t, "DELETE", "/api/v1/user/emails?token="+token, &opts)
 | 
						|
	MakeRequest(t, req, http.StatusNoContent)
 | 
						|
 | 
						|
	req = NewRequest(t, "GET", "/api/v1/user/emails?token="+token)
 | 
						|
	resp := MakeRequest(t, req, http.StatusOK)
 | 
						|
 | 
						|
	var emails []*api.Email
 | 
						|
	DecodeJSON(t, resp, &emails)
 | 
						|
	assert.EqualValues(t, []*api.Email{
 | 
						|
		{
 | 
						|
			Email:    "user2@example.com",
 | 
						|
			Verified: true,
 | 
						|
			Primary:  true,
 | 
						|
		},
 | 
						|
	}, emails)
 | 
						|
}
 |