mirror of
				https://github.com/go-gitea/gitea
				synced 2025-10-31 03:18:24 +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>
		
	
		
			
				
	
	
		
			174 lines
		
	
	
		
			5.8 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			174 lines
		
	
	
		
			5.8 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
| // Copyright 2020 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 TestOAuth2Application(t *testing.T) {
 | |
| 	defer tests.PrepareTestEnv(t)()
 | |
| 	testAPICreateOAuth2Application(t)
 | |
| 	testAPIListOAuth2Applications(t)
 | |
| 	testAPIGetOAuth2Application(t)
 | |
| 	testAPIUpdateOAuth2Application(t)
 | |
| 	testAPIDeleteOAuth2Application(t)
 | |
| }
 | |
| 
 | |
| func testAPICreateOAuth2Application(t *testing.T) {
 | |
| 	user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
 | |
| 	appBody := api.CreateOAuth2ApplicationOptions{
 | |
| 		Name: "test-app-1",
 | |
| 		RedirectURIs: []string{
 | |
| 			"http://www.google.com",
 | |
| 		},
 | |
| 		ConfidentialClient: true,
 | |
| 	}
 | |
| 
 | |
| 	req := NewRequestWithJSON(t, "POST", "/api/v1/user/applications/oauth2", &appBody)
 | |
| 	req = AddBasicAuthHeader(req, user.Name)
 | |
| 	resp := MakeRequest(t, req, http.StatusCreated)
 | |
| 
 | |
| 	var createdApp *api.OAuth2Application
 | |
| 	DecodeJSON(t, resp, &createdApp)
 | |
| 
 | |
| 	assert.EqualValues(t, appBody.Name, createdApp.Name)
 | |
| 	assert.Len(t, createdApp.ClientSecret, 56)
 | |
| 	assert.Len(t, createdApp.ClientID, 36)
 | |
| 	assert.True(t, createdApp.ConfidentialClient)
 | |
| 	assert.NotEmpty(t, createdApp.Created)
 | |
| 	assert.EqualValues(t, appBody.RedirectURIs[0], createdApp.RedirectURIs[0])
 | |
| 	unittest.AssertExistsAndLoadBean(t, &auth_model.OAuth2Application{UID: user.ID, Name: createdApp.Name})
 | |
| }
 | |
| 
 | |
| func testAPIListOAuth2Applications(t *testing.T) {
 | |
| 	user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
 | |
| 	session := loginUser(t, user.Name)
 | |
| 	token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeReadUser)
 | |
| 
 | |
| 	existApp := unittest.AssertExistsAndLoadBean(t, &auth_model.OAuth2Application{
 | |
| 		UID:  user.ID,
 | |
| 		Name: "test-app-1",
 | |
| 		RedirectURIs: []string{
 | |
| 			"http://www.google.com",
 | |
| 		},
 | |
| 		ConfidentialClient: true,
 | |
| 	})
 | |
| 
 | |
| 	urlStr := fmt.Sprintf("/api/v1/user/applications/oauth2?token=%s", token)
 | |
| 	req := NewRequest(t, "GET", urlStr)
 | |
| 	resp := MakeRequest(t, req, http.StatusOK)
 | |
| 
 | |
| 	var appList api.OAuth2ApplicationList
 | |
| 	DecodeJSON(t, resp, &appList)
 | |
| 	expectedApp := appList[0]
 | |
| 
 | |
| 	assert.EqualValues(t, existApp.Name, expectedApp.Name)
 | |
| 	assert.EqualValues(t, existApp.ClientID, expectedApp.ClientID)
 | |
| 	assert.Equal(t, existApp.ConfidentialClient, expectedApp.ConfidentialClient)
 | |
| 	assert.Len(t, expectedApp.ClientID, 36)
 | |
| 	assert.Empty(t, expectedApp.ClientSecret)
 | |
| 	assert.EqualValues(t, existApp.RedirectURIs[0], expectedApp.RedirectURIs[0])
 | |
| 	unittest.AssertExistsAndLoadBean(t, &auth_model.OAuth2Application{ID: expectedApp.ID, Name: expectedApp.Name})
 | |
| }
 | |
| 
 | |
| func testAPIDeleteOAuth2Application(t *testing.T) {
 | |
| 	user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
 | |
| 	session := loginUser(t, user.Name)
 | |
| 	token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteUser)
 | |
| 
 | |
| 	oldApp := unittest.AssertExistsAndLoadBean(t, &auth_model.OAuth2Application{
 | |
| 		UID:  user.ID,
 | |
| 		Name: "test-app-1",
 | |
| 	})
 | |
| 
 | |
| 	urlStr := fmt.Sprintf("/api/v1/user/applications/oauth2/%d?token=%s", oldApp.ID, token)
 | |
| 	req := NewRequest(t, "DELETE", urlStr)
 | |
| 	MakeRequest(t, req, http.StatusNoContent)
 | |
| 
 | |
| 	unittest.AssertNotExistsBean(t, &auth_model.OAuth2Application{UID: oldApp.UID, Name: oldApp.Name})
 | |
| 
 | |
| 	// Delete again will return not found
 | |
| 	req = NewRequest(t, "DELETE", urlStr)
 | |
| 	MakeRequest(t, req, http.StatusNotFound)
 | |
| }
 | |
| 
 | |
| func testAPIGetOAuth2Application(t *testing.T) {
 | |
| 	user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
 | |
| 	session := loginUser(t, user.Name)
 | |
| 	token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeReadUser)
 | |
| 
 | |
| 	existApp := unittest.AssertExistsAndLoadBean(t, &auth_model.OAuth2Application{
 | |
| 		UID:  user.ID,
 | |
| 		Name: "test-app-1",
 | |
| 		RedirectURIs: []string{
 | |
| 			"http://www.google.com",
 | |
| 		},
 | |
| 		ConfidentialClient: true,
 | |
| 	})
 | |
| 
 | |
| 	urlStr := fmt.Sprintf("/api/v1/user/applications/oauth2/%d?token=%s", existApp.ID, token)
 | |
| 	req := NewRequest(t, "GET", urlStr)
 | |
| 	resp := MakeRequest(t, req, http.StatusOK)
 | |
| 
 | |
| 	var app api.OAuth2Application
 | |
| 	DecodeJSON(t, resp, &app)
 | |
| 	expectedApp := app
 | |
| 
 | |
| 	assert.EqualValues(t, existApp.Name, expectedApp.Name)
 | |
| 	assert.EqualValues(t, existApp.ClientID, expectedApp.ClientID)
 | |
| 	assert.Equal(t, existApp.ConfidentialClient, expectedApp.ConfidentialClient)
 | |
| 	assert.Len(t, expectedApp.ClientID, 36)
 | |
| 	assert.Empty(t, expectedApp.ClientSecret)
 | |
| 	assert.Len(t, expectedApp.RedirectURIs, 1)
 | |
| 	assert.EqualValues(t, existApp.RedirectURIs[0], expectedApp.RedirectURIs[0])
 | |
| 	unittest.AssertExistsAndLoadBean(t, &auth_model.OAuth2Application{ID: expectedApp.ID, Name: expectedApp.Name})
 | |
| }
 | |
| 
 | |
| func testAPIUpdateOAuth2Application(t *testing.T) {
 | |
| 	user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
 | |
| 
 | |
| 	existApp := unittest.AssertExistsAndLoadBean(t, &auth_model.OAuth2Application{
 | |
| 		UID:  user.ID,
 | |
| 		Name: "test-app-1",
 | |
| 		RedirectURIs: []string{
 | |
| 			"http://www.google.com",
 | |
| 		},
 | |
| 	})
 | |
| 
 | |
| 	appBody := api.CreateOAuth2ApplicationOptions{
 | |
| 		Name: "test-app-1",
 | |
| 		RedirectURIs: []string{
 | |
| 			"http://www.google.com/",
 | |
| 			"http://www.github.com/",
 | |
| 		},
 | |
| 		ConfidentialClient: true,
 | |
| 	}
 | |
| 
 | |
| 	urlStr := fmt.Sprintf("/api/v1/user/applications/oauth2/%d", existApp.ID)
 | |
| 	req := NewRequestWithJSON(t, "PATCH", urlStr, &appBody)
 | |
| 	req = AddBasicAuthHeader(req, user.Name)
 | |
| 	resp := MakeRequest(t, req, http.StatusOK)
 | |
| 
 | |
| 	var app api.OAuth2Application
 | |
| 	DecodeJSON(t, resp, &app)
 | |
| 	expectedApp := app
 | |
| 
 | |
| 	assert.Len(t, expectedApp.RedirectURIs, 2)
 | |
| 	assert.EqualValues(t, expectedApp.RedirectURIs[0], appBody.RedirectURIs[0])
 | |
| 	assert.EqualValues(t, expectedApp.RedirectURIs[1], appBody.RedirectURIs[1])
 | |
| 	assert.Equal(t, expectedApp.ConfidentialClient, appBody.ConfidentialClient)
 | |
| 	unittest.AssertExistsAndLoadBean(t, &auth_model.OAuth2Application{ID: expectedApp.ID, Name: expectedApp.Name})
 | |
| }
 |