mirror of
				https://github.com/go-gitea/gitea.git
				synced 2025-10-30 01:04:25 +01: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
		
			
				
	
	
		
			112 lines
		
	
	
		
			3.1 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			112 lines
		
	
	
		
			3.1 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
| // Copyright 2022 The Gitea Authors. All rights reserved.
 | |
| // SPDX-License-Identifier: MIT
 | |
| 
 | |
| package integration
 | |
| 
 | |
| import (
 | |
| 	"fmt"
 | |
| 	"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 TestAPIFollow(t *testing.T) {
 | |
| 	defer tests.PrepareTestEnv(t)()
 | |
| 
 | |
| 	user1 := "user4"
 | |
| 	user2 := "user1"
 | |
| 
 | |
| 	session1 := loginUser(t, user1)
 | |
| 	token1 := getTokenForLoggedInUser(t, session1)
 | |
| 
 | |
| 	session2 := loginUser(t, user2)
 | |
| 	token2 := getTokenForLoggedInUser(t, session2, auth_model.AccessTokenScopeUserFollow)
 | |
| 
 | |
| 	t.Run("Follow", func(t *testing.T) {
 | |
| 		defer tests.PrintCurrentTest(t)()
 | |
| 
 | |
| 		req := NewRequest(t, "PUT", fmt.Sprintf("/api/v1/user/following/%s?token=%s", user1, token2))
 | |
| 		MakeRequest(t, req, http.StatusNoContent)
 | |
| 	})
 | |
| 
 | |
| 	t.Run("ListFollowing", func(t *testing.T) {
 | |
| 		defer tests.PrintCurrentTest(t)()
 | |
| 
 | |
| 		req := NewRequest(t, "GET", fmt.Sprintf("/api/v1/users/%s/following?token=%s", user2, token2))
 | |
| 		resp := MakeRequest(t, req, http.StatusOK)
 | |
| 
 | |
| 		var users []api.User
 | |
| 		DecodeJSON(t, resp, &users)
 | |
| 		assert.Len(t, users, 1)
 | |
| 		assert.Equal(t, user1, users[0].UserName)
 | |
| 	})
 | |
| 
 | |
| 	t.Run("ListMyFollowing", func(t *testing.T) {
 | |
| 		defer tests.PrintCurrentTest(t)()
 | |
| 
 | |
| 		req := NewRequest(t, "GET", fmt.Sprintf("/api/v1/user/following?token=%s", token2))
 | |
| 		resp := MakeRequest(t, req, http.StatusOK)
 | |
| 
 | |
| 		var users []api.User
 | |
| 		DecodeJSON(t, resp, &users)
 | |
| 		assert.Len(t, users, 1)
 | |
| 		assert.Equal(t, user1, users[0].UserName)
 | |
| 	})
 | |
| 
 | |
| 	t.Run("ListFollowers", func(t *testing.T) {
 | |
| 		defer tests.PrintCurrentTest(t)()
 | |
| 
 | |
| 		req := NewRequest(t, "GET", fmt.Sprintf("/api/v1/users/%s/followers?token=%s", user1, token1))
 | |
| 		resp := MakeRequest(t, req, http.StatusOK)
 | |
| 
 | |
| 		var users []api.User
 | |
| 		DecodeJSON(t, resp, &users)
 | |
| 		assert.Len(t, users, 1)
 | |
| 		assert.Equal(t, user2, users[0].UserName)
 | |
| 	})
 | |
| 
 | |
| 	t.Run("ListMyFollowers", func(t *testing.T) {
 | |
| 		defer tests.PrintCurrentTest(t)()
 | |
| 
 | |
| 		req := NewRequest(t, "GET", fmt.Sprintf("/api/v1/user/followers?token=%s", token1))
 | |
| 		resp := MakeRequest(t, req, http.StatusOK)
 | |
| 
 | |
| 		var users []api.User
 | |
| 		DecodeJSON(t, resp, &users)
 | |
| 		assert.Len(t, users, 1)
 | |
| 		assert.Equal(t, user2, users[0].UserName)
 | |
| 	})
 | |
| 
 | |
| 	t.Run("CheckFollowing", func(t *testing.T) {
 | |
| 		defer tests.PrintCurrentTest(t)()
 | |
| 
 | |
| 		req := NewRequest(t, "GET", fmt.Sprintf("/api/v1/users/%s/following/%s?token=%s", user2, user1, token2))
 | |
| 		MakeRequest(t, req, http.StatusNoContent)
 | |
| 
 | |
| 		req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/users/%s/following/%s?token=%s", user1, user2, token2))
 | |
| 		MakeRequest(t, req, http.StatusNotFound)
 | |
| 	})
 | |
| 
 | |
| 	t.Run("CheckMyFollowing", func(t *testing.T) {
 | |
| 		defer tests.PrintCurrentTest(t)()
 | |
| 
 | |
| 		req := NewRequest(t, "GET", fmt.Sprintf("/api/v1/user/following/%s?token=%s", user1, token2))
 | |
| 		MakeRequest(t, req, http.StatusNoContent)
 | |
| 
 | |
| 		req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/user/following/%s?token=%s", user2, token1))
 | |
| 		MakeRequest(t, req, http.StatusNotFound)
 | |
| 	})
 | |
| 
 | |
| 	t.Run("Unfollow", func(t *testing.T) {
 | |
| 		defer tests.PrintCurrentTest(t)()
 | |
| 
 | |
| 		req := NewRequest(t, "DELETE", fmt.Sprintf("/api/v1/user/following/%s?token=%s", user1, token2))
 | |
| 		MakeRequest(t, req, http.StatusNoContent)
 | |
| 	})
 | |
| }
 |