mirror of
				https://github.com/go-gitea/gitea.git
				synced 2025-10-31 14:57:24 -04: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>
		
	
		
			
				
	
	
		
			221 lines
		
	
	
		
			6.9 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			221 lines
		
	
	
		
			6.9 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
| // Copyright 2018 The Gitea Authors. All rights reserved.
 | |
| // SPDX-License-Identifier: MIT
 | |
| 
 | |
| package integration
 | |
| 
 | |
| import (
 | |
| 	"fmt"
 | |
| 	"net/http"
 | |
| 	"net/url"
 | |
| 	"strings"
 | |
| 	"testing"
 | |
| 
 | |
| 	auth_model "code.gitea.io/gitea/models/auth"
 | |
| 	"code.gitea.io/gitea/models/db"
 | |
| 	org_model "code.gitea.io/gitea/models/organization"
 | |
| 	"code.gitea.io/gitea/models/perm"
 | |
| 	unit_model "code.gitea.io/gitea/models/unit"
 | |
| 	"code.gitea.io/gitea/models/unittest"
 | |
| 	user_model "code.gitea.io/gitea/models/user"
 | |
| 	"code.gitea.io/gitea/modules/setting"
 | |
| 	api "code.gitea.io/gitea/modules/structs"
 | |
| 	"code.gitea.io/gitea/tests"
 | |
| 
 | |
| 	"github.com/stretchr/testify/assert"
 | |
| )
 | |
| 
 | |
| func TestAPIOrgCreate(t *testing.T) {
 | |
| 	onGiteaRun(t, func(*testing.T, *url.URL) {
 | |
| 		token := getUserToken(t, "user1", auth_model.AccessTokenScopeWriteOrganization)
 | |
| 
 | |
| 		org := api.CreateOrgOption{
 | |
| 			UserName:    "user1_org",
 | |
| 			FullName:    "User1's organization",
 | |
| 			Description: "This organization created by user1",
 | |
| 			Website:     "https://try.gitea.io",
 | |
| 			Location:    "Shanghai",
 | |
| 			Visibility:  "limited",
 | |
| 		}
 | |
| 		req := NewRequestWithJSON(t, "POST", "/api/v1/orgs?token="+token, &org)
 | |
| 		resp := MakeRequest(t, req, http.StatusCreated)
 | |
| 
 | |
| 		var apiOrg api.Organization
 | |
| 		DecodeJSON(t, resp, &apiOrg)
 | |
| 
 | |
| 		assert.Equal(t, org.UserName, apiOrg.Name)
 | |
| 		assert.Equal(t, org.FullName, apiOrg.FullName)
 | |
| 		assert.Equal(t, org.Description, apiOrg.Description)
 | |
| 		assert.Equal(t, org.Website, apiOrg.Website)
 | |
| 		assert.Equal(t, org.Location, apiOrg.Location)
 | |
| 		assert.Equal(t, org.Visibility, apiOrg.Visibility)
 | |
| 
 | |
| 		unittest.AssertExistsAndLoadBean(t, &user_model.User{
 | |
| 			Name:      org.UserName,
 | |
| 			LowerName: strings.ToLower(org.UserName),
 | |
| 			FullName:  org.FullName,
 | |
| 		})
 | |
| 
 | |
| 		// Check owner team permission
 | |
| 		ownerTeam, _ := org_model.GetOwnerTeam(db.DefaultContext, apiOrg.ID)
 | |
| 
 | |
| 		for _, ut := range unit_model.AllRepoUnitTypes {
 | |
| 			up := perm.AccessModeOwner
 | |
| 			if ut == unit_model.TypeExternalTracker || ut == unit_model.TypeExternalWiki {
 | |
| 				up = perm.AccessModeRead
 | |
| 			}
 | |
| 			unittest.AssertExistsAndLoadBean(t, &org_model.TeamUnit{
 | |
| 				OrgID:      apiOrg.ID,
 | |
| 				TeamID:     ownerTeam.ID,
 | |
| 				Type:       ut,
 | |
| 				AccessMode: up,
 | |
| 			})
 | |
| 		}
 | |
| 
 | |
| 		req = NewRequestf(t, "GET", "/api/v1/orgs/%s?token=%s", org.UserName, token)
 | |
| 		resp = MakeRequest(t, req, http.StatusOK)
 | |
| 		DecodeJSON(t, resp, &apiOrg)
 | |
| 		assert.EqualValues(t, org.UserName, apiOrg.Name)
 | |
| 
 | |
| 		req = NewRequestf(t, "GET", "/api/v1/orgs/%s/repos?token=%s", org.UserName, token)
 | |
| 		resp = MakeRequest(t, req, http.StatusOK)
 | |
| 
 | |
| 		var repos []*api.Repository
 | |
| 		DecodeJSON(t, resp, &repos)
 | |
| 		for _, repo := range repos {
 | |
| 			assert.False(t, repo.Private)
 | |
| 		}
 | |
| 
 | |
| 		req = NewRequestf(t, "GET", "/api/v1/orgs/%s/members?token=%s", org.UserName, token)
 | |
| 		resp = MakeRequest(t, req, http.StatusOK)
 | |
| 
 | |
| 		// user1 on this org is public
 | |
| 		var users []*api.User
 | |
| 		DecodeJSON(t, resp, &users)
 | |
| 		assert.Len(t, users, 1)
 | |
| 		assert.EqualValues(t, "user1", users[0].UserName)
 | |
| 	})
 | |
| }
 | |
| 
 | |
| func TestAPIOrgEdit(t *testing.T) {
 | |
| 	onGiteaRun(t, func(*testing.T, *url.URL) {
 | |
| 		session := loginUser(t, "user1")
 | |
| 
 | |
| 		token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteOrganization)
 | |
| 		org := api.EditOrgOption{
 | |
| 			FullName:    "User3 organization new full name",
 | |
| 			Description: "A new description",
 | |
| 			Website:     "https://try.gitea.io/new",
 | |
| 			Location:    "Beijing",
 | |
| 			Visibility:  "private",
 | |
| 		}
 | |
| 		req := NewRequestWithJSON(t, "PATCH", "/api/v1/orgs/user3?token="+token, &org)
 | |
| 		resp := MakeRequest(t, req, http.StatusOK)
 | |
| 
 | |
| 		var apiOrg api.Organization
 | |
| 		DecodeJSON(t, resp, &apiOrg)
 | |
| 
 | |
| 		assert.Equal(t, "user3", apiOrg.Name)
 | |
| 		assert.Equal(t, org.FullName, apiOrg.FullName)
 | |
| 		assert.Equal(t, org.Description, apiOrg.Description)
 | |
| 		assert.Equal(t, org.Website, apiOrg.Website)
 | |
| 		assert.Equal(t, org.Location, apiOrg.Location)
 | |
| 		assert.Equal(t, org.Visibility, apiOrg.Visibility)
 | |
| 	})
 | |
| }
 | |
| 
 | |
| func TestAPIOrgEditBadVisibility(t *testing.T) {
 | |
| 	onGiteaRun(t, func(*testing.T, *url.URL) {
 | |
| 		session := loginUser(t, "user1")
 | |
| 
 | |
| 		token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteOrganization)
 | |
| 		org := api.EditOrgOption{
 | |
| 			FullName:    "User3 organization new full name",
 | |
| 			Description: "A new description",
 | |
| 			Website:     "https://try.gitea.io/new",
 | |
| 			Location:    "Beijing",
 | |
| 			Visibility:  "badvisibility",
 | |
| 		}
 | |
| 		req := NewRequestWithJSON(t, "PATCH", "/api/v1/orgs/user3?token="+token, &org)
 | |
| 		MakeRequest(t, req, http.StatusUnprocessableEntity)
 | |
| 	})
 | |
| }
 | |
| 
 | |
| func TestAPIOrgDeny(t *testing.T) {
 | |
| 	onGiteaRun(t, func(*testing.T, *url.URL) {
 | |
| 		setting.Service.RequireSignInView = true
 | |
| 		defer func() {
 | |
| 			setting.Service.RequireSignInView = false
 | |
| 		}()
 | |
| 
 | |
| 		orgName := "user1_org"
 | |
| 		req := NewRequestf(t, "GET", "/api/v1/orgs/%s", orgName)
 | |
| 		MakeRequest(t, req, http.StatusNotFound)
 | |
| 
 | |
| 		req = NewRequestf(t, "GET", "/api/v1/orgs/%s/repos", orgName)
 | |
| 		MakeRequest(t, req, http.StatusNotFound)
 | |
| 
 | |
| 		req = NewRequestf(t, "GET", "/api/v1/orgs/%s/members", orgName)
 | |
| 		MakeRequest(t, req, http.StatusNotFound)
 | |
| 	})
 | |
| }
 | |
| 
 | |
| func TestAPIGetAll(t *testing.T) {
 | |
| 	defer tests.PrepareTestEnv(t)()
 | |
| 
 | |
| 	token := getUserToken(t, "user1", auth_model.AccessTokenScopeReadOrganization)
 | |
| 
 | |
| 	// accessing with a token will return all orgs
 | |
| 	req := NewRequestf(t, "GET", "/api/v1/orgs?token=%s", token)
 | |
| 	resp := MakeRequest(t, req, http.StatusOK)
 | |
| 	var apiOrgList []*api.Organization
 | |
| 
 | |
| 	DecodeJSON(t, resp, &apiOrgList)
 | |
| 	assert.Len(t, apiOrgList, 9)
 | |
| 	assert.Equal(t, "org25", apiOrgList[1].FullName)
 | |
| 	assert.Equal(t, "public", apiOrgList[1].Visibility)
 | |
| 
 | |
| 	// accessing without a token will return only public orgs
 | |
| 	req = NewRequestf(t, "GET", "/api/v1/orgs")
 | |
| 	resp = MakeRequest(t, req, http.StatusOK)
 | |
| 
 | |
| 	DecodeJSON(t, resp, &apiOrgList)
 | |
| 	assert.Len(t, apiOrgList, 7)
 | |
| 	assert.Equal(t, "org25", apiOrgList[0].FullName)
 | |
| 	assert.Equal(t, "public", apiOrgList[0].Visibility)
 | |
| }
 | |
| 
 | |
| func TestAPIOrgSearchEmptyTeam(t *testing.T) {
 | |
| 	onGiteaRun(t, func(*testing.T, *url.URL) {
 | |
| 		token := getUserToken(t, "user1", auth_model.AccessTokenScopeWriteOrganization)
 | |
| 		orgName := "org_with_empty_team"
 | |
| 
 | |
| 		// create org
 | |
| 		req := NewRequestWithJSON(t, "POST", "/api/v1/orgs?token="+token, &api.CreateOrgOption{
 | |
| 			UserName: orgName,
 | |
| 		})
 | |
| 		MakeRequest(t, req, http.StatusCreated)
 | |
| 
 | |
| 		// create team with no member
 | |
| 		req = NewRequestWithJSON(t, "POST", fmt.Sprintf("/api/v1/orgs/%s/teams?token=%s", orgName, token), &api.CreateTeamOption{
 | |
| 			Name:                    "Empty",
 | |
| 			IncludesAllRepositories: true,
 | |
| 			Permission:              "read",
 | |
| 			Units:                   []string{"repo.code", "repo.issues", "repo.ext_issues", "repo.wiki", "repo.pulls"},
 | |
| 		})
 | |
| 		MakeRequest(t, req, http.StatusCreated)
 | |
| 
 | |
| 		// case-insensitive search for teams that have no members
 | |
| 		req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/orgs/%s/teams/search?q=%s&token=%s", orgName, "empty", token))
 | |
| 		resp := MakeRequest(t, req, http.StatusOK)
 | |
| 		data := struct {
 | |
| 			Ok   bool
 | |
| 			Data []*api.Team
 | |
| 		}{}
 | |
| 		DecodeJSON(t, resp, &data)
 | |
| 		assert.True(t, data.Ok)
 | |
| 		if assert.Len(t, data.Data, 1) {
 | |
| 			assert.EqualValues(t, "Empty", data.Data[0].Name)
 | |
| 		}
 | |
| 	})
 | |
| }
 |