mirror of
				https://codeberg.org/forgejo/forgejo.git
				synced 2025-11-04 08:21:11 +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
		
			
				
	
	
		
			144 lines
		
	
	
	
		
			4.5 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			144 lines
		
	
	
	
		
			4.5 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
// Copyright 2019 The Gitea Authors. All rights reserved.
 | 
						|
// SPDX-License-Identifier: MIT
 | 
						|
 | 
						|
package integration
 | 
						|
 | 
						|
import (
 | 
						|
	"fmt"
 | 
						|
	"net/http"
 | 
						|
	"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/unittest"
 | 
						|
	user_model "code.gitea.io/gitea/models/user"
 | 
						|
	api "code.gitea.io/gitea/modules/structs"
 | 
						|
	"code.gitea.io/gitea/services/convert"
 | 
						|
	"code.gitea.io/gitea/tests"
 | 
						|
 | 
						|
	"github.com/stretchr/testify/assert"
 | 
						|
)
 | 
						|
 | 
						|
func TestAPIIssuesReactions(t *testing.T) {
 | 
						|
	defer tests.PrepareTestEnv(t)()
 | 
						|
 | 
						|
	issue := unittest.AssertExistsAndLoadBean(t, &issues_model.Issue{ID: 1})
 | 
						|
	_ = issue.LoadRepo(db.DefaultContext)
 | 
						|
	owner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: issue.Repo.OwnerID})
 | 
						|
 | 
						|
	session := loginUser(t, owner.Name)
 | 
						|
	token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeRepo)
 | 
						|
 | 
						|
	user2 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
 | 
						|
	urlStr := fmt.Sprintf("/api/v1/repos/%s/%s/issues/%d/reactions?token=%s",
 | 
						|
		owner.Name, issue.Repo.Name, issue.Index, token)
 | 
						|
 | 
						|
	// Try to add not allowed reaction
 | 
						|
	req := NewRequestWithJSON(t, "POST", urlStr, &api.EditReactionOption{
 | 
						|
		Reaction: "wrong",
 | 
						|
	})
 | 
						|
	MakeRequest(t, req, http.StatusForbidden)
 | 
						|
 | 
						|
	// Delete not allowed reaction
 | 
						|
	req = NewRequestWithJSON(t, "DELETE", urlStr, &api.EditReactionOption{
 | 
						|
		Reaction: "zzz",
 | 
						|
	})
 | 
						|
	MakeRequest(t, req, http.StatusOK)
 | 
						|
 | 
						|
	// Add allowed reaction
 | 
						|
	req = NewRequestWithJSON(t, "POST", urlStr, &api.EditReactionOption{
 | 
						|
		Reaction: "rocket",
 | 
						|
	})
 | 
						|
	resp := MakeRequest(t, req, http.StatusCreated)
 | 
						|
	var apiNewReaction api.Reaction
 | 
						|
	DecodeJSON(t, resp, &apiNewReaction)
 | 
						|
 | 
						|
	// Add existing reaction
 | 
						|
	MakeRequest(t, req, http.StatusForbidden)
 | 
						|
 | 
						|
	// Get end result of reaction list of issue #1
 | 
						|
	req = NewRequestf(t, "GET", urlStr)
 | 
						|
	resp = MakeRequest(t, req, http.StatusOK)
 | 
						|
	var apiReactions []*api.Reaction
 | 
						|
	DecodeJSON(t, resp, &apiReactions)
 | 
						|
	expectResponse := make(map[int]api.Reaction)
 | 
						|
	expectResponse[0] = api.Reaction{
 | 
						|
		User:     convert.ToUser(user2, user2),
 | 
						|
		Reaction: "eyes",
 | 
						|
		Created:  time.Unix(1573248003, 0),
 | 
						|
	}
 | 
						|
	expectResponse[1] = apiNewReaction
 | 
						|
	assert.Len(t, apiReactions, 2)
 | 
						|
	for i, r := range apiReactions {
 | 
						|
		assert.Equal(t, expectResponse[i].Reaction, r.Reaction)
 | 
						|
		assert.Equal(t, expectResponse[i].Created.Unix(), r.Created.Unix())
 | 
						|
		assert.Equal(t, expectResponse[i].User.ID, r.User.ID)
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
func TestAPICommentReactions(t *testing.T) {
 | 
						|
	defer tests.PrepareTestEnv(t)()
 | 
						|
 | 
						|
	comment := unittest.AssertExistsAndLoadBean(t, &issues_model.Comment{ID: 2})
 | 
						|
	_ = comment.LoadIssue(db.DefaultContext)
 | 
						|
	issue := comment.Issue
 | 
						|
	_ = issue.LoadRepo(db.DefaultContext)
 | 
						|
	owner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: issue.Repo.OwnerID})
 | 
						|
 | 
						|
	session := loginUser(t, owner.Name)
 | 
						|
	token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeRepo)
 | 
						|
 | 
						|
	user1 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 1})
 | 
						|
	user2 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
 | 
						|
	urlStr := fmt.Sprintf("/api/v1/repos/%s/%s/issues/comments/%d/reactions?token=%s",
 | 
						|
		owner.Name, issue.Repo.Name, comment.ID, token)
 | 
						|
 | 
						|
	// Try to add not allowed reaction
 | 
						|
	req := NewRequestWithJSON(t, "POST", urlStr, &api.EditReactionOption{
 | 
						|
		Reaction: "wrong",
 | 
						|
	})
 | 
						|
	MakeRequest(t, req, http.StatusForbidden)
 | 
						|
 | 
						|
	// Delete none existing reaction
 | 
						|
	req = NewRequestWithJSON(t, "DELETE", urlStr, &api.EditReactionOption{
 | 
						|
		Reaction: "eyes",
 | 
						|
	})
 | 
						|
	MakeRequest(t, req, http.StatusOK)
 | 
						|
 | 
						|
	// Add allowed reaction
 | 
						|
	req = NewRequestWithJSON(t, "POST", urlStr, &api.EditReactionOption{
 | 
						|
		Reaction: "+1",
 | 
						|
	})
 | 
						|
	resp := MakeRequest(t, req, http.StatusCreated)
 | 
						|
	var apiNewReaction api.Reaction
 | 
						|
	DecodeJSON(t, resp, &apiNewReaction)
 | 
						|
 | 
						|
	// Add existing reaction
 | 
						|
	MakeRequest(t, req, http.StatusForbidden)
 | 
						|
 | 
						|
	// Get end result of reaction list of issue #1
 | 
						|
	req = NewRequestf(t, "GET", urlStr)
 | 
						|
	resp = MakeRequest(t, req, http.StatusOK)
 | 
						|
	var apiReactions []*api.Reaction
 | 
						|
	DecodeJSON(t, resp, &apiReactions)
 | 
						|
	expectResponse := make(map[int]api.Reaction)
 | 
						|
	expectResponse[0] = api.Reaction{
 | 
						|
		User:     convert.ToUser(user2, user2),
 | 
						|
		Reaction: "laugh",
 | 
						|
		Created:  time.Unix(1573248004, 0),
 | 
						|
	}
 | 
						|
	expectResponse[1] = api.Reaction{
 | 
						|
		User:     convert.ToUser(user1, user1),
 | 
						|
		Reaction: "laugh",
 | 
						|
		Created:  time.Unix(1573248005, 0),
 | 
						|
	}
 | 
						|
	expectResponse[2] = apiNewReaction
 | 
						|
	assert.Len(t, apiReactions, 3)
 | 
						|
	for i, r := range apiReactions {
 | 
						|
		assert.Equal(t, expectResponse[i].Reaction, r.Reaction)
 | 
						|
		assert.Equal(t, expectResponse[i].Created.Unix(), r.Created.Unix())
 | 
						|
		assert.Equal(t, expectResponse[i].User.ID, r.User.ID)
 | 
						|
	}
 | 
						|
}
 |