mirror of
				https://github.com/go-gitea/gitea
				synced 2025-10-30 19:08:37 +00: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>
		
	
		
			
				
	
	
		
			183 lines
		
	
	
		
			5.7 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			183 lines
		
	
	
		
			5.7 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
| // Copyright 2020 The Gitea Authors. All rights reserved.
 | |
| // SPDX-License-Identifier: MIT
 | |
| 
 | |
| package integration
 | |
| 
 | |
| import (
 | |
| 	"net/http"
 | |
| 	"net/url"
 | |
| 	"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"
 | |
| 	"code.gitea.io/gitea/modules/git"
 | |
| 	repo_module "code.gitea.io/gitea/modules/repository"
 | |
| 	pull_service "code.gitea.io/gitea/services/pull"
 | |
| 	repo_service "code.gitea.io/gitea/services/repository"
 | |
| 	files_service "code.gitea.io/gitea/services/repository/files"
 | |
| 
 | |
| 	"github.com/stretchr/testify/assert"
 | |
| )
 | |
| 
 | |
| func TestAPIPullUpdate(t *testing.T) {
 | |
| 	onGiteaRun(t, func(t *testing.T, giteaURL *url.URL) {
 | |
| 		// Create PR to test
 | |
| 		user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
 | |
| 		org26 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 26})
 | |
| 		pr := createOutdatedPR(t, user, org26)
 | |
| 
 | |
| 		// Test GetDiverging
 | |
| 		diffCount, err := pull_service.GetDiverging(git.DefaultContext, pr)
 | |
| 		assert.NoError(t, err)
 | |
| 		assert.EqualValues(t, 1, diffCount.Behind)
 | |
| 		assert.EqualValues(t, 1, diffCount.Ahead)
 | |
| 		assert.NoError(t, pr.LoadBaseRepo(db.DefaultContext))
 | |
| 		assert.NoError(t, pr.LoadIssue(db.DefaultContext))
 | |
| 
 | |
| 		session := loginUser(t, "user2")
 | |
| 		token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteRepository)
 | |
| 		req := NewRequestf(t, "POST", "/api/v1/repos/%s/%s/pulls/%d/update?token="+token, pr.BaseRepo.OwnerName, pr.BaseRepo.Name, pr.Issue.Index)
 | |
| 		session.MakeRequest(t, req, http.StatusOK)
 | |
| 
 | |
| 		// Test GetDiverging after update
 | |
| 		diffCount, err = pull_service.GetDiverging(git.DefaultContext, pr)
 | |
| 		assert.NoError(t, err)
 | |
| 		assert.EqualValues(t, 0, diffCount.Behind)
 | |
| 		assert.EqualValues(t, 2, diffCount.Ahead)
 | |
| 	})
 | |
| }
 | |
| 
 | |
| func TestAPIPullUpdateByRebase(t *testing.T) {
 | |
| 	onGiteaRun(t, func(t *testing.T, giteaURL *url.URL) {
 | |
| 		// Create PR to test
 | |
| 		user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
 | |
| 		org26 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 26})
 | |
| 		pr := createOutdatedPR(t, user, org26)
 | |
| 
 | |
| 		// Test GetDiverging
 | |
| 		diffCount, err := pull_service.GetDiverging(git.DefaultContext, pr)
 | |
| 		assert.NoError(t, err)
 | |
| 		assert.EqualValues(t, 1, diffCount.Behind)
 | |
| 		assert.EqualValues(t, 1, diffCount.Ahead)
 | |
| 		assert.NoError(t, pr.LoadBaseRepo(db.DefaultContext))
 | |
| 		assert.NoError(t, pr.LoadIssue(db.DefaultContext))
 | |
| 
 | |
| 		session := loginUser(t, "user2")
 | |
| 		token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteRepository)
 | |
| 		req := NewRequestf(t, "POST", "/api/v1/repos/%s/%s/pulls/%d/update?style=rebase&token="+token, pr.BaseRepo.OwnerName, pr.BaseRepo.Name, pr.Issue.Index)
 | |
| 		session.MakeRequest(t, req, http.StatusOK)
 | |
| 
 | |
| 		// Test GetDiverging after update
 | |
| 		diffCount, err = pull_service.GetDiverging(git.DefaultContext, pr)
 | |
| 		assert.NoError(t, err)
 | |
| 		assert.EqualValues(t, 0, diffCount.Behind)
 | |
| 		assert.EqualValues(t, 1, diffCount.Ahead)
 | |
| 	})
 | |
| }
 | |
| 
 | |
| func createOutdatedPR(t *testing.T, actor, forkOrg *user_model.User) *issues_model.PullRequest {
 | |
| 	baseRepo, err := repo_service.CreateRepository(db.DefaultContext, actor, actor, repo_module.CreateRepoOptions{
 | |
| 		Name:        "repo-pr-update",
 | |
| 		Description: "repo-tmp-pr-update description",
 | |
| 		AutoInit:    true,
 | |
| 		Gitignores:  "C,C++",
 | |
| 		License:     "MIT",
 | |
| 		Readme:      "Default",
 | |
| 		IsPrivate:   false,
 | |
| 	})
 | |
| 	assert.NoError(t, err)
 | |
| 	assert.NotEmpty(t, baseRepo)
 | |
| 
 | |
| 	headRepo, err := repo_service.ForkRepository(git.DefaultContext, actor, forkOrg, repo_service.ForkRepoOptions{
 | |
| 		BaseRepo:    baseRepo,
 | |
| 		Name:        "repo-pr-update",
 | |
| 		Description: "desc",
 | |
| 	})
 | |
| 	assert.NoError(t, err)
 | |
| 	assert.NotEmpty(t, headRepo)
 | |
| 
 | |
| 	// create a commit on base Repo
 | |
| 	_, err = files_service.ChangeRepoFiles(git.DefaultContext, baseRepo, actor, &files_service.ChangeRepoFilesOptions{
 | |
| 		Files: []*files_service.ChangeRepoFile{
 | |
| 			{
 | |
| 				Operation: "create",
 | |
| 				TreePath:  "File_A",
 | |
| 				Content:   "File A",
 | |
| 			},
 | |
| 		},
 | |
| 		Message:   "Add File A",
 | |
| 		OldBranch: "master",
 | |
| 		NewBranch: "master",
 | |
| 		Author: &files_service.IdentityOptions{
 | |
| 			Name:  actor.Name,
 | |
| 			Email: actor.Email,
 | |
| 		},
 | |
| 		Committer: &files_service.IdentityOptions{
 | |
| 			Name:  actor.Name,
 | |
| 			Email: actor.Email,
 | |
| 		},
 | |
| 		Dates: &files_service.CommitDateOptions{
 | |
| 			Author:    time.Now(),
 | |
| 			Committer: time.Now(),
 | |
| 		},
 | |
| 	})
 | |
| 	assert.NoError(t, err)
 | |
| 
 | |
| 	// create a commit on head Repo
 | |
| 	_, err = files_service.ChangeRepoFiles(git.DefaultContext, headRepo, actor, &files_service.ChangeRepoFilesOptions{
 | |
| 		Files: []*files_service.ChangeRepoFile{
 | |
| 			{
 | |
| 				Operation: "create",
 | |
| 				TreePath:  "File_B",
 | |
| 				Content:   "File B",
 | |
| 			},
 | |
| 		},
 | |
| 		Message:   "Add File on PR branch",
 | |
| 		OldBranch: "master",
 | |
| 		NewBranch: "newBranch",
 | |
| 		Author: &files_service.IdentityOptions{
 | |
| 			Name:  actor.Name,
 | |
| 			Email: actor.Email,
 | |
| 		},
 | |
| 		Committer: &files_service.IdentityOptions{
 | |
| 			Name:  actor.Name,
 | |
| 			Email: actor.Email,
 | |
| 		},
 | |
| 		Dates: &files_service.CommitDateOptions{
 | |
| 			Author:    time.Now(),
 | |
| 			Committer: time.Now(),
 | |
| 		},
 | |
| 	})
 | |
| 	assert.NoError(t, err)
 | |
| 
 | |
| 	// create Pull
 | |
| 	pullIssue := &issues_model.Issue{
 | |
| 		RepoID:   baseRepo.ID,
 | |
| 		Title:    "Test Pull -to-update-",
 | |
| 		PosterID: actor.ID,
 | |
| 		Poster:   actor,
 | |
| 		IsPull:   true,
 | |
| 	}
 | |
| 	pullRequest := &issues_model.PullRequest{
 | |
| 		HeadRepoID: headRepo.ID,
 | |
| 		BaseRepoID: baseRepo.ID,
 | |
| 		HeadBranch: "newBranch",
 | |
| 		BaseBranch: "master",
 | |
| 		HeadRepo:   headRepo,
 | |
| 		BaseRepo:   baseRepo,
 | |
| 		Type:       issues_model.PullRequestGitea,
 | |
| 	}
 | |
| 	err = pull_service.NewPullRequest(git.DefaultContext, baseRepo, pullIssue, nil, nil, pullRequest, nil)
 | |
| 	assert.NoError(t, err)
 | |
| 
 | |
| 	issue := unittest.AssertExistsAndLoadBean(t, &issues_model.Issue{Title: "Test Pull -to-update-"})
 | |
| 	pr, err := issues_model.GetPullRequestByIssueID(db.DefaultContext, issue.ID)
 | |
| 	assert.NoError(t, err)
 | |
| 
 | |
| 	return pr
 | |
| }
 |