mirror of
				https://github.com/go-gitea/gitea.git
				synced 2025-10-31 21:28:11 +09:00 
			
		
		
		
	## Changes
- Adds the following high level access scopes, each with `read` and
`write` levels:
    - `activitypub`
    - `admin` (hidden if user is not a site admin)
    - `misc`
    - `notification`
    - `organization`
    - `package`
    - `issue`
    - `repository`
    - `user`
- Adds new middleware function `tokenRequiresScopes()` in addition to
`reqToken()`
  -  `tokenRequiresScopes()` is used for each high-level api section
- _if_ a scoped token is present, checks that the required scope is
included based on the section and HTTP method
  - `reqToken()` is used for individual routes
- checks that required authentication is present (but does not check
scope levels as this will already have been handled by
`tokenRequiresScopes()`
- Adds migration to convert old scoped access tokens to the new set of
scopes
- Updates the user interface for scope selection
### User interface example
<img width="903" alt="Screen Shot 2023-05-31 at 1 56 55 PM"
src="https://github.com/go-gitea/gitea/assets/23248839/654766ec-2143-4f59-9037-3b51600e32f3">
<img width="917" alt="Screen Shot 2023-05-31 at 1 56 43 PM"
src="https://github.com/go-gitea/gitea/assets/23248839/1ad64081-012c-4a73-b393-66b30352654c">
## tokenRequiresScopes  Design Decision
- `tokenRequiresScopes()` was added to more reliably cover api routes.
For an incoming request, this function uses the given scope category
(say `AccessTokenScopeCategoryOrganization`) and the HTTP method (say
`DELETE`) and verifies that any scoped tokens in use include
`delete:organization`.
- `reqToken()` is used to enforce auth for individual routes that
require it. If a scoped token is not present for a request,
`tokenRequiresScopes()` will not return an error
## TODO
- [x] Alphabetize scope categories
- [x] Change 'public repos only' to a radio button (private vs public).
Also expand this to organizations
- [X] Disable token creation if no scopes selected. Alternatively, show
warning
- [x] `reqToken()` is missing from many `POST/DELETE` routes in the api.
`tokenRequiresScopes()` only checks that a given token has the correct
scope, `reqToken()` must be used to check that a token (or some other
auth) is present.
   -  _This should be addressed in this PR_
- [x] The migration should be reviewed very carefully in order to
minimize access changes to existing user tokens.
   - _This should be addressed in this PR_
- [x] Link to api to swagger documentation, clarify what
read/write/delete levels correspond to
- [x] Review cases where more than one scope is needed as this directly
deviates from the api definition.
   - _This should be addressed in this PR_
   - For example: 
   ```go
	m.Group("/users/{username}/orgs", func() {
		m.Get("", reqToken(), org.ListUserOrgs)
		m.Get("/{org}/permissions", reqToken(), org.GetUserOrgsPermissions)
}, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryUser,
auth_model.AccessTokenScopeCategoryOrganization),
context_service.UserAssignmentAPI())
   ```
## Future improvements
- [ ] Add required scopes to swagger documentation
- [ ] Redesign `reqToken()` to be opt-out rather than opt-in
- [ ] Subdivide scopes like `repository`
- [ ] Once a token is created, if it has no scopes, we should display
text instead of an empty bullet point
- [ ] If the 'public repos only' option is selected, should read
categories be selected by default
Closes #24501
Closes #24799
Co-authored-by: Jonathan Tran <jon@allspice.io>
Co-authored-by: Kyle D <kdumontnu@gmail.com>
Co-authored-by: silverwind <me@silverwind.io>
		
	
		
			
				
	
	
		
			151 lines
		
	
	
		
			4.5 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			151 lines
		
	
	
		
			4.5 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
| // Copyright 2021 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"
 | |
| )
 | |
| 
 | |
| type apiUserOrgPermTestCase struct {
 | |
| 	LoginUser                       string
 | |
| 	User                            string
 | |
| 	Organization                    string
 | |
| 	ExpectedOrganizationPermissions api.OrganizationPermissions
 | |
| }
 | |
| 
 | |
| func TestTokenNeeded(t *testing.T) {
 | |
| 	defer tests.PrepareTestEnv(t)()
 | |
| 
 | |
| 	req := NewRequest(t, "GET", "/api/v1/users/user1/orgs/user6/permissions")
 | |
| 	MakeRequest(t, req, http.StatusUnauthorized)
 | |
| }
 | |
| 
 | |
| func sampleTest(t *testing.T, auoptc apiUserOrgPermTestCase) {
 | |
| 	defer tests.PrepareTestEnv(t)()
 | |
| 
 | |
| 	session := loginUser(t, auoptc.LoginUser)
 | |
| 	token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeReadOrganization, auth_model.AccessTokenScopeReadUser)
 | |
| 
 | |
| 	req := NewRequest(t, "GET", fmt.Sprintf("/api/v1/users/%s/orgs/%s/permissions?token=%s", auoptc.User, auoptc.Organization, token))
 | |
| 	resp := MakeRequest(t, req, http.StatusOK)
 | |
| 
 | |
| 	var apiOP api.OrganizationPermissions
 | |
| 	DecodeJSON(t, resp, &apiOP)
 | |
| 	assert.Equal(t, auoptc.ExpectedOrganizationPermissions.IsOwner, apiOP.IsOwner)
 | |
| 	assert.Equal(t, auoptc.ExpectedOrganizationPermissions.IsAdmin, apiOP.IsAdmin)
 | |
| 	assert.Equal(t, auoptc.ExpectedOrganizationPermissions.CanWrite, apiOP.CanWrite)
 | |
| 	assert.Equal(t, auoptc.ExpectedOrganizationPermissions.CanRead, apiOP.CanRead)
 | |
| 	assert.Equal(t, auoptc.ExpectedOrganizationPermissions.CanCreateRepository, apiOP.CanCreateRepository)
 | |
| }
 | |
| 
 | |
| func TestWithOwnerUser(t *testing.T) {
 | |
| 	sampleTest(t, apiUserOrgPermTestCase{
 | |
| 		LoginUser:    "user2",
 | |
| 		User:         "user2",
 | |
| 		Organization: "user3",
 | |
| 		ExpectedOrganizationPermissions: api.OrganizationPermissions{
 | |
| 			IsOwner:             true,
 | |
| 			IsAdmin:             true,
 | |
| 			CanWrite:            true,
 | |
| 			CanRead:             true,
 | |
| 			CanCreateRepository: true,
 | |
| 		},
 | |
| 	})
 | |
| }
 | |
| 
 | |
| func TestCanWriteUser(t *testing.T) {
 | |
| 	sampleTest(t, apiUserOrgPermTestCase{
 | |
| 		LoginUser:    "user4",
 | |
| 		User:         "user4",
 | |
| 		Organization: "user3",
 | |
| 		ExpectedOrganizationPermissions: api.OrganizationPermissions{
 | |
| 			IsOwner:             false,
 | |
| 			IsAdmin:             false,
 | |
| 			CanWrite:            true,
 | |
| 			CanRead:             true,
 | |
| 			CanCreateRepository: false,
 | |
| 		},
 | |
| 	})
 | |
| }
 | |
| 
 | |
| func TestAdminUser(t *testing.T) {
 | |
| 	sampleTest(t, apiUserOrgPermTestCase{
 | |
| 		LoginUser:    "user1",
 | |
| 		User:         "user28",
 | |
| 		Organization: "user3",
 | |
| 		ExpectedOrganizationPermissions: api.OrganizationPermissions{
 | |
| 			IsOwner:             false,
 | |
| 			IsAdmin:             true,
 | |
| 			CanWrite:            true,
 | |
| 			CanRead:             true,
 | |
| 			CanCreateRepository: true,
 | |
| 		},
 | |
| 	})
 | |
| }
 | |
| 
 | |
| func TestAdminCanNotCreateRepo(t *testing.T) {
 | |
| 	sampleTest(t, apiUserOrgPermTestCase{
 | |
| 		LoginUser:    "user1",
 | |
| 		User:         "user28",
 | |
| 		Organization: "user6",
 | |
| 		ExpectedOrganizationPermissions: api.OrganizationPermissions{
 | |
| 			IsOwner:             false,
 | |
| 			IsAdmin:             true,
 | |
| 			CanWrite:            true,
 | |
| 			CanRead:             true,
 | |
| 			CanCreateRepository: false,
 | |
| 		},
 | |
| 	})
 | |
| }
 | |
| 
 | |
| func TestCanReadUser(t *testing.T) {
 | |
| 	sampleTest(t, apiUserOrgPermTestCase{
 | |
| 		LoginUser:    "user1",
 | |
| 		User:         "user24",
 | |
| 		Organization: "org25",
 | |
| 		ExpectedOrganizationPermissions: api.OrganizationPermissions{
 | |
| 			IsOwner:             false,
 | |
| 			IsAdmin:             false,
 | |
| 			CanWrite:            false,
 | |
| 			CanRead:             true,
 | |
| 			CanCreateRepository: false,
 | |
| 		},
 | |
| 	})
 | |
| }
 | |
| 
 | |
| func TestUnknowUser(t *testing.T) {
 | |
| 	defer tests.PrepareTestEnv(t)()
 | |
| 
 | |
| 	session := loginUser(t, "user1")
 | |
| 	token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeReadUser, auth_model.AccessTokenScopeReadOrganization)
 | |
| 
 | |
| 	req := NewRequest(t, "GET", fmt.Sprintf("/api/v1/users/unknow/orgs/org25/permissions?token=%s", token))
 | |
| 	resp := MakeRequest(t, req, http.StatusNotFound)
 | |
| 
 | |
| 	var apiError api.APIError
 | |
| 	DecodeJSON(t, resp, &apiError)
 | |
| 	assert.Equal(t, "user redirect does not exist [name: unknow]", apiError.Message)
 | |
| }
 | |
| 
 | |
| func TestUnknowOrganization(t *testing.T) {
 | |
| 	defer tests.PrepareTestEnv(t)()
 | |
| 
 | |
| 	session := loginUser(t, "user1")
 | |
| 	token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeReadUser, auth_model.AccessTokenScopeReadOrganization)
 | |
| 
 | |
| 	req := NewRequest(t, "GET", fmt.Sprintf("/api/v1/users/user1/orgs/unknow/permissions?token=%s", token))
 | |
| 	resp := MakeRequest(t, req, http.StatusNotFound)
 | |
| 	var apiError api.APIError
 | |
| 	DecodeJSON(t, resp, &apiError)
 | |
| 	assert.Equal(t, "GetUserByName", apiError.Message)
 | |
| }
 |