mirror of
				https://github.com/go-gitea/gitea.git
				synced 2025-10-30 06:38:37 -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>
		
	
		
			
				
	
	
		
			162 lines
		
	
	
		
			5.5 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			162 lines
		
	
	
		
			5.5 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
| // Copyright 2019 The Gitea Authors. All rights reserved.
 | |
| // SPDX-License-Identifier: MIT
 | |
| 
 | |
| package integration
 | |
| 
 | |
| import (
 | |
| 	"fmt"
 | |
| 	"net/http"
 | |
| 	"net/url"
 | |
| 	"path"
 | |
| 	"strings"
 | |
| 	"testing"
 | |
| 
 | |
| 	auth_model "code.gitea.io/gitea/models/auth"
 | |
| 	api "code.gitea.io/gitea/modules/structs"
 | |
| 
 | |
| 	"github.com/stretchr/testify/assert"
 | |
| )
 | |
| 
 | |
| func TestPullCreate_CommitStatus(t *testing.T) {
 | |
| 	onGiteaRun(t, func(t *testing.T, u *url.URL) {
 | |
| 		session := loginUser(t, "user1")
 | |
| 		testRepoFork(t, session, "user2", "repo1", "user1", "repo1")
 | |
| 		testEditFileToNewBranch(t, session, "user1", "repo1", "master", "status1", "README.md", "status1")
 | |
| 
 | |
| 		url := path.Join("user1", "repo1", "compare", "master...status1")
 | |
| 		req := NewRequestWithValues(t, "POST", url,
 | |
| 			map[string]string{
 | |
| 				"_csrf": GetCSRF(t, session, url),
 | |
| 				"title": "pull request from status1",
 | |
| 			},
 | |
| 		)
 | |
| 		session.MakeRequest(t, req, http.StatusSeeOther)
 | |
| 
 | |
| 		req = NewRequest(t, "GET", "/user1/repo1/pulls")
 | |
| 		resp := session.MakeRequest(t, req, http.StatusOK)
 | |
| 		NewHTMLParser(t, resp.Body)
 | |
| 
 | |
| 		// Request repository commits page
 | |
| 		req = NewRequest(t, "GET", "/user1/repo1/pulls/1/commits")
 | |
| 		resp = session.MakeRequest(t, req, http.StatusOK)
 | |
| 		doc := NewHTMLParser(t, resp.Body)
 | |
| 
 | |
| 		// Get first commit URL
 | |
| 		commitURL, exists := doc.doc.Find("#commits-table tbody tr td.sha a").Last().Attr("href")
 | |
| 		assert.True(t, exists)
 | |
| 		assert.NotEmpty(t, commitURL)
 | |
| 
 | |
| 		commitID := path.Base(commitURL)
 | |
| 
 | |
| 		statusList := []api.CommitStatusState{
 | |
| 			api.CommitStatusPending,
 | |
| 			api.CommitStatusError,
 | |
| 			api.CommitStatusFailure,
 | |
| 			api.CommitStatusWarning,
 | |
| 			api.CommitStatusSuccess,
 | |
| 		}
 | |
| 
 | |
| 		statesIcons := map[api.CommitStatusState]string{
 | |
| 			api.CommitStatusPending: "octicon-dot-fill",
 | |
| 			api.CommitStatusSuccess: "octicon-check",
 | |
| 			api.CommitStatusError:   "gitea-exclamation",
 | |
| 			api.CommitStatusFailure: "octicon-x",
 | |
| 			api.CommitStatusWarning: "gitea-exclamation",
 | |
| 		}
 | |
| 
 | |
| 		testCtx := NewAPITestContext(t, "user1", "repo1", auth_model.AccessTokenScopeWriteRepository)
 | |
| 
 | |
| 		// Update commit status, and check if icon is updated as well
 | |
| 		for _, status := range statusList {
 | |
| 
 | |
| 			// Call API to add status for commit
 | |
| 			t.Run("CreateStatus", doAPICreateCommitStatus(testCtx, commitID, api.CreateStatusOption{
 | |
| 				State:       status,
 | |
| 				TargetURL:   "http://test.ci/",
 | |
| 				Description: "",
 | |
| 				Context:     "testci",
 | |
| 			}))
 | |
| 
 | |
| 			req = NewRequestf(t, "GET", "/user1/repo1/pulls/1/commits")
 | |
| 			resp = session.MakeRequest(t, req, http.StatusOK)
 | |
| 			doc = NewHTMLParser(t, resp.Body)
 | |
| 
 | |
| 			commitURL, exists = doc.doc.Find("#commits-table tbody tr td.sha a").Last().Attr("href")
 | |
| 			assert.True(t, exists)
 | |
| 			assert.NotEmpty(t, commitURL)
 | |
| 			assert.EqualValues(t, commitID, path.Base(commitURL))
 | |
| 
 | |
| 			cls, ok := doc.doc.Find("#commits-table tbody tr td.message .commit-status").Last().Attr("class")
 | |
| 			assert.True(t, ok)
 | |
| 			assert.Contains(t, cls, statesIcons[status])
 | |
| 		}
 | |
| 	})
 | |
| }
 | |
| 
 | |
| func doAPICreateCommitStatus(ctx APITestContext, commitID string, data api.CreateStatusOption) func(*testing.T) {
 | |
| 	return func(t *testing.T) {
 | |
| 		req := NewRequestWithJSON(
 | |
| 			t,
 | |
| 			http.MethodPost,
 | |
| 			fmt.Sprintf("/api/v1/repos/%s/%s/statuses/%s?token=%s", ctx.Username, ctx.Reponame, commitID, ctx.Token),
 | |
| 			data,
 | |
| 		)
 | |
| 		if ctx.ExpectedCode != 0 {
 | |
| 			ctx.Session.MakeRequest(t, req, ctx.ExpectedCode)
 | |
| 			return
 | |
| 		}
 | |
| 		ctx.Session.MakeRequest(t, req, http.StatusCreated)
 | |
| 	}
 | |
| }
 | |
| 
 | |
| func TestPullCreate_EmptyChangesWithDifferentCommits(t *testing.T) {
 | |
| 	// Merge must continue if commits SHA are different, even if content is same
 | |
| 	// Reason: gitflow and merging master back into develop, where is high possibility, there are no changes
 | |
| 	// but just commit saying "Merge branch". And this meta commit can be also tagged,
 | |
| 	// so we need to have this meta commit also in develop branch.
 | |
| 	onGiteaRun(t, func(t *testing.T, u *url.URL) {
 | |
| 		session := loginUser(t, "user1")
 | |
| 		testRepoFork(t, session, "user2", "repo1", "user1", "repo1")
 | |
| 		testEditFileToNewBranch(t, session, "user1", "repo1", "master", "status1", "README.md", "status1")
 | |
| 		testEditFileToNewBranch(t, session, "user1", "repo1", "status1", "status1", "README.md", "# repo1\n\nDescription for repo1")
 | |
| 
 | |
| 		url := path.Join("user1", "repo1", "compare", "master...status1")
 | |
| 		req := NewRequestWithValues(t, "POST", url,
 | |
| 			map[string]string{
 | |
| 				"_csrf": GetCSRF(t, session, url),
 | |
| 				"title": "pull request from status1",
 | |
| 			},
 | |
| 		)
 | |
| 		session.MakeRequest(t, req, http.StatusSeeOther)
 | |
| 
 | |
| 		req = NewRequest(t, "GET", "/user1/repo1/pulls/1")
 | |
| 		resp := session.MakeRequest(t, req, http.StatusOK)
 | |
| 		doc := NewHTMLParser(t, resp.Body)
 | |
| 
 | |
| 		text := strings.TrimSpace(doc.doc.Find(".merge-section").Text())
 | |
| 		assert.Contains(t, text, "This pull request can be merged automatically.")
 | |
| 	})
 | |
| }
 | |
| 
 | |
| func TestPullCreate_EmptyChangesWithSameCommits(t *testing.T) {
 | |
| 	onGiteaRun(t, func(t *testing.T, u *url.URL) {
 | |
| 		session := loginUser(t, "user1")
 | |
| 		testRepoFork(t, session, "user2", "repo1", "user1", "repo1")
 | |
| 		testCreateBranch(t, session, "user1", "repo1", "branch/master", "status1", http.StatusSeeOther)
 | |
| 		url := path.Join("user1", "repo1", "compare", "master...status1")
 | |
| 		req := NewRequestWithValues(t, "POST", url,
 | |
| 			map[string]string{
 | |
| 				"_csrf": GetCSRF(t, session, url),
 | |
| 				"title": "pull request from status1",
 | |
| 			},
 | |
| 		)
 | |
| 		session.MakeRequest(t, req, http.StatusSeeOther)
 | |
| 		req = NewRequest(t, "GET", "/user1/repo1/pulls/1")
 | |
| 		resp := session.MakeRequest(t, req, http.StatusOK)
 | |
| 		doc := NewHTMLParser(t, resp.Body)
 | |
| 
 | |
| 		text := strings.TrimSpace(doc.doc.Find(".merge-section").Text())
 | |
| 		assert.Contains(t, text, "This branch is already included in the target branch. There is nothing to merge.")
 | |
| 	})
 | |
| }
 |