mirror of
				https://github.com/go-gitea/gitea
				synced 2025-10-31 11:28:24 +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
		
			
				
	
	
		
			127 lines
		
	
	
		
			3.4 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			127 lines
		
	
	
		
			3.4 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
| // Copyright 2018 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"
 | |
| 	"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/tests"
 | |
| 
 | |
| 	"github.com/stretchr/testify/assert"
 | |
| )
 | |
| 
 | |
| func TestUserOrgs(t *testing.T) {
 | |
| 	defer tests.PrepareTestEnv(t)()
 | |
| 	adminUsername := "user1"
 | |
| 	normalUsername := "user2"
 | |
| 	privateMemberUsername := "user4"
 | |
| 	unrelatedUsername := "user5"
 | |
| 
 | |
| 	orgs := getUserOrgs(t, adminUsername, normalUsername)
 | |
| 
 | |
| 	user3 := unittest.AssertExistsAndLoadBean(t, &user_model.User{Name: "user3"})
 | |
| 	user17 := unittest.AssertExistsAndLoadBean(t, &user_model.User{Name: "user17"})
 | |
| 
 | |
| 	assert.Equal(t, []*api.Organization{
 | |
| 		{
 | |
| 			ID:          17,
 | |
| 			Name:        user17.Name,
 | |
| 			UserName:    user17.Name,
 | |
| 			FullName:    user17.FullName,
 | |
| 			AvatarURL:   user17.AvatarLink(),
 | |
| 			Description: "",
 | |
| 			Website:     "",
 | |
| 			Location:    "",
 | |
| 			Visibility:  "public",
 | |
| 		},
 | |
| 		{
 | |
| 			ID:          3,
 | |
| 			Name:        user3.Name,
 | |
| 			UserName:    user3.Name,
 | |
| 			FullName:    user3.FullName,
 | |
| 			AvatarURL:   user3.AvatarLink(),
 | |
| 			Description: "",
 | |
| 			Website:     "",
 | |
| 			Location:    "",
 | |
| 			Visibility:  "public",
 | |
| 		},
 | |
| 	}, orgs)
 | |
| 
 | |
| 	// user itself should get it's org's he is a member of
 | |
| 	orgs = getUserOrgs(t, privateMemberUsername, privateMemberUsername)
 | |
| 	assert.Len(t, orgs, 1)
 | |
| 
 | |
| 	// unrelated user should not get private org membership of privateMemberUsername
 | |
| 	orgs = getUserOrgs(t, unrelatedUsername, privateMemberUsername)
 | |
| 	assert.Len(t, orgs, 0)
 | |
| 
 | |
| 	// not authenticated call should not be allowed
 | |
| 	testUserOrgsUnauthenticated(t, privateMemberUsername)
 | |
| }
 | |
| 
 | |
| func getUserOrgs(t *testing.T, userDoer, userCheck string) (orgs []*api.Organization) {
 | |
| 	token := ""
 | |
| 	if len(userDoer) != 0 {
 | |
| 		token = getUserToken(t, userDoer, auth_model.AccessTokenScopeReadOrg)
 | |
| 	}
 | |
| 	urlStr := fmt.Sprintf("/api/v1/users/%s/orgs?token=%s", userCheck, token)
 | |
| 	req := NewRequest(t, "GET", urlStr)
 | |
| 	resp := MakeRequest(t, req, http.StatusOK)
 | |
| 	DecodeJSON(t, resp, &orgs)
 | |
| 	return orgs
 | |
| }
 | |
| 
 | |
| func testUserOrgsUnauthenticated(t *testing.T, userCheck string) {
 | |
| 	session := emptyTestSession(t)
 | |
| 	req := NewRequestf(t, "GET", "/api/v1/users/%s/orgs", userCheck)
 | |
| 	session.MakeRequest(t, req, http.StatusUnauthorized)
 | |
| }
 | |
| 
 | |
| func TestMyOrgs(t *testing.T) {
 | |
| 	defer tests.PrepareTestEnv(t)()
 | |
| 
 | |
| 	req := NewRequest(t, "GET", "/api/v1/user/orgs")
 | |
| 	MakeRequest(t, req, http.StatusUnauthorized)
 | |
| 
 | |
| 	normalUsername := "user2"
 | |
| 	token := getUserToken(t, normalUsername, auth_model.AccessTokenScopeReadOrg)
 | |
| 	req = NewRequest(t, "GET", "/api/v1/user/orgs?token="+token)
 | |
| 	resp := MakeRequest(t, req, http.StatusOK)
 | |
| 	var orgs []*api.Organization
 | |
| 	DecodeJSON(t, resp, &orgs)
 | |
| 	user3 := unittest.AssertExistsAndLoadBean(t, &user_model.User{Name: "user3"})
 | |
| 	user17 := unittest.AssertExistsAndLoadBean(t, &user_model.User{Name: "user17"})
 | |
| 
 | |
| 	assert.Equal(t, []*api.Organization{
 | |
| 		{
 | |
| 			ID:          17,
 | |
| 			Name:        user17.Name,
 | |
| 			UserName:    user17.Name,
 | |
| 			FullName:    user17.FullName,
 | |
| 			AvatarURL:   user17.AvatarLink(),
 | |
| 			Description: "",
 | |
| 			Website:     "",
 | |
| 			Location:    "",
 | |
| 			Visibility:  "public",
 | |
| 		},
 | |
| 		{
 | |
| 			ID:          3,
 | |
| 			Name:        user3.Name,
 | |
| 			UserName:    user3.Name,
 | |
| 			FullName:    user3.FullName,
 | |
| 			AvatarURL:   user3.AvatarLink(),
 | |
| 			Description: "",
 | |
| 			Website:     "",
 | |
| 			Location:    "",
 | |
| 			Visibility:  "public",
 | |
| 		},
 | |
| 	}, orgs)
 | |
| }
 |