mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-08-30 16:34:53 +02: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>
309 lines
14 KiB
Go
309 lines
14 KiB
Go
// Copyright 2023 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package integration
|
|
|
|
import (
|
|
stdCtx "context"
|
|
"encoding/base64"
|
|
"fmt"
|
|
"net/http"
|
|
"net/url"
|
|
"testing"
|
|
|
|
auth_model "code.gitea.io/gitea/models/auth"
|
|
repo_model "code.gitea.io/gitea/models/repo"
|
|
"code.gitea.io/gitea/models/unittest"
|
|
user_model "code.gitea.io/gitea/models/user"
|
|
"code.gitea.io/gitea/modules/context"
|
|
"code.gitea.io/gitea/modules/git"
|
|
"code.gitea.io/gitea/modules/setting"
|
|
api "code.gitea.io/gitea/modules/structs"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func getChangeFilesOptions() *api.ChangeFilesOptions {
|
|
newContent := "This is new text"
|
|
updateContent := "This is updated text"
|
|
newContentEncoded := base64.StdEncoding.EncodeToString([]byte(newContent))
|
|
updateContentEncoded := base64.StdEncoding.EncodeToString([]byte(updateContent))
|
|
return &api.ChangeFilesOptions{
|
|
FileOptions: api.FileOptions{
|
|
BranchName: "master",
|
|
NewBranchName: "master",
|
|
Message: "My update of new/file.txt",
|
|
Author: api.Identity{
|
|
Name: "Anne Doe",
|
|
Email: "annedoe@example.com",
|
|
},
|
|
Committer: api.Identity{
|
|
Name: "John Doe",
|
|
Email: "johndoe@example.com",
|
|
},
|
|
},
|
|
Files: []*api.ChangeFileOperation{
|
|
{
|
|
Operation: "create",
|
|
Content: newContentEncoded,
|
|
},
|
|
{
|
|
Operation: "update",
|
|
Content: updateContentEncoded,
|
|
SHA: "103ff9234cefeee5ec5361d22b49fbb04d385885",
|
|
},
|
|
{
|
|
Operation: "delete",
|
|
SHA: "103ff9234cefeee5ec5361d22b49fbb04d385885",
|
|
},
|
|
},
|
|
}
|
|
}
|
|
|
|
func TestAPIChangeFiles(t *testing.T) {
|
|
onGiteaRun(t, func(t *testing.T, u *url.URL) {
|
|
user2 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2}) // owner of the repo1 & repo16
|
|
user3 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 3}) // owner of the repo3, is an org
|
|
user4 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 4}) // owner of neither repos
|
|
repo1 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 1}) // public repo
|
|
repo3 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 3}) // public repo
|
|
repo16 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 16}) // private repo
|
|
fileID := 0
|
|
|
|
// Get user2's token
|
|
session := loginUser(t, user2.Name)
|
|
token2 := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteRepository)
|
|
// Get user4's token
|
|
session = loginUser(t, user4.Name)
|
|
token4 := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteRepository)
|
|
|
|
// Test changing files in repo1 which user2 owns, try both with branch and empty branch
|
|
for _, branch := range [...]string{
|
|
"master", // Branch
|
|
"", // Empty branch
|
|
} {
|
|
fileID++
|
|
createTreePath := fmt.Sprintf("new/file%d.txt", fileID)
|
|
updateTreePath := fmt.Sprintf("update/file%d.txt", fileID)
|
|
deleteTreePath := fmt.Sprintf("delete/file%d.txt", fileID)
|
|
createFile(user2, repo1, updateTreePath)
|
|
createFile(user2, repo1, deleteTreePath)
|
|
changeFilesOptions := getChangeFilesOptions()
|
|
changeFilesOptions.BranchName = branch
|
|
changeFilesOptions.Files[0].Path = createTreePath
|
|
changeFilesOptions.Files[1].Path = updateTreePath
|
|
changeFilesOptions.Files[2].Path = deleteTreePath
|
|
url := fmt.Sprintf("/api/v1/repos/%s/%s/contents?token=%s", user2.Name, repo1.Name, token2)
|
|
req := NewRequestWithJSON(t, "POST", url, &changeFilesOptions)
|
|
resp := MakeRequest(t, req, http.StatusCreated)
|
|
gitRepo, _ := git.OpenRepository(stdCtx.Background(), repo1.RepoPath())
|
|
commitID, _ := gitRepo.GetBranchCommitID(changeFilesOptions.NewBranchName)
|
|
createLasCommit, _ := gitRepo.GetCommitByPath(createTreePath)
|
|
updateLastCommit, _ := gitRepo.GetCommitByPath(updateTreePath)
|
|
expectedCreateFileResponse := getExpectedFileResponseForCreate(fmt.Sprintf("%v/%v", user2.Name, repo1.Name), commitID, createTreePath, createLasCommit.ID.String())
|
|
expectedUpdateFileResponse := getExpectedFileResponseForUpdate(commitID, updateTreePath, updateLastCommit.ID.String())
|
|
var filesResponse api.FilesResponse
|
|
DecodeJSON(t, resp, &filesResponse)
|
|
|
|
// check create file
|
|
assert.EqualValues(t, expectedCreateFileResponse.Content, filesResponse.Files[0])
|
|
|
|
// check update file
|
|
assert.EqualValues(t, expectedUpdateFileResponse.Content, filesResponse.Files[1])
|
|
|
|
// test commit info
|
|
assert.EqualValues(t, expectedCreateFileResponse.Commit.SHA, filesResponse.Commit.SHA)
|
|
assert.EqualValues(t, expectedCreateFileResponse.Commit.HTMLURL, filesResponse.Commit.HTMLURL)
|
|
assert.EqualValues(t, expectedCreateFileResponse.Commit.Author.Email, filesResponse.Commit.Author.Email)
|
|
assert.EqualValues(t, expectedCreateFileResponse.Commit.Author.Name, filesResponse.Commit.Author.Name)
|
|
assert.EqualValues(t, expectedCreateFileResponse.Commit.Committer.Email, filesResponse.Commit.Committer.Email)
|
|
assert.EqualValues(t, expectedCreateFileResponse.Commit.Committer.Name, filesResponse.Commit.Committer.Name)
|
|
|
|
// test delete file
|
|
assert.Nil(t, filesResponse.Files[2])
|
|
|
|
gitRepo.Close()
|
|
}
|
|
|
|
// Test changing files in a new branch
|
|
changeFilesOptions := getChangeFilesOptions()
|
|
changeFilesOptions.BranchName = repo1.DefaultBranch
|
|
changeFilesOptions.NewBranchName = "new_branch"
|
|
fileID++
|
|
createTreePath := fmt.Sprintf("new/file%d.txt", fileID)
|
|
updateTreePath := fmt.Sprintf("update/file%d.txt", fileID)
|
|
deleteTreePath := fmt.Sprintf("delete/file%d.txt", fileID)
|
|
changeFilesOptions.Files[0].Path = createTreePath
|
|
changeFilesOptions.Files[1].Path = updateTreePath
|
|
changeFilesOptions.Files[2].Path = deleteTreePath
|
|
createFile(user2, repo1, updateTreePath)
|
|
createFile(user2, repo1, deleteTreePath)
|
|
url := fmt.Sprintf("/api/v1/repos/%s/%s/contents?token=%s", user2.Name, repo1.Name, token2)
|
|
req := NewRequestWithJSON(t, "POST", url, &changeFilesOptions)
|
|
resp := MakeRequest(t, req, http.StatusCreated)
|
|
var filesResponse api.FilesResponse
|
|
DecodeJSON(t, resp, &filesResponse)
|
|
expectedCreateSHA := "a635aa942442ddfdba07468cf9661c08fbdf0ebf"
|
|
expectedCreateHTMLURL := fmt.Sprintf(setting.AppURL+"user2/repo1/src/branch/new_branch/new/file%d.txt", fileID)
|
|
expectedCreateDownloadURL := fmt.Sprintf(setting.AppURL+"user2/repo1/raw/branch/new_branch/new/file%d.txt", fileID)
|
|
expectedUpdateSHA := "08bd14b2e2852529157324de9c226b3364e76136"
|
|
expectedUpdateHTMLURL := fmt.Sprintf(setting.AppURL+"user2/repo1/src/branch/new_branch/update/file%d.txt", fileID)
|
|
expectedUpdateDownloadURL := fmt.Sprintf(setting.AppURL+"user2/repo1/raw/branch/new_branch/update/file%d.txt", fileID)
|
|
assert.EqualValues(t, expectedCreateSHA, filesResponse.Files[0].SHA)
|
|
assert.EqualValues(t, expectedCreateHTMLURL, *filesResponse.Files[0].HTMLURL)
|
|
assert.EqualValues(t, expectedCreateDownloadURL, *filesResponse.Files[0].DownloadURL)
|
|
assert.EqualValues(t, expectedUpdateSHA, filesResponse.Files[1].SHA)
|
|
assert.EqualValues(t, expectedUpdateHTMLURL, *filesResponse.Files[1].HTMLURL)
|
|
assert.EqualValues(t, expectedUpdateDownloadURL, *filesResponse.Files[1].DownloadURL)
|
|
assert.Nil(t, filesResponse.Files[2])
|
|
|
|
assert.EqualValues(t, changeFilesOptions.Message+"\n", filesResponse.Commit.Message)
|
|
|
|
// Test updating a file and renaming it
|
|
changeFilesOptions = getChangeFilesOptions()
|
|
changeFilesOptions.BranchName = repo1.DefaultBranch
|
|
fileID++
|
|
updateTreePath = fmt.Sprintf("update/file%d.txt", fileID)
|
|
createFile(user2, repo1, updateTreePath)
|
|
changeFilesOptions.Files = []*api.ChangeFileOperation{changeFilesOptions.Files[1]}
|
|
changeFilesOptions.Files[0].FromPath = updateTreePath
|
|
changeFilesOptions.Files[0].Path = "rename/" + updateTreePath
|
|
req = NewRequestWithJSON(t, "POST", url, &changeFilesOptions)
|
|
resp = MakeRequest(t, req, http.StatusCreated)
|
|
DecodeJSON(t, resp, &filesResponse)
|
|
expectedUpdateSHA = "08bd14b2e2852529157324de9c226b3364e76136"
|
|
expectedUpdateHTMLURL = fmt.Sprintf(setting.AppURL+"user2/repo1/src/branch/master/rename/update/file%d.txt", fileID)
|
|
expectedUpdateDownloadURL = fmt.Sprintf(setting.AppURL+"user2/repo1/raw/branch/master/rename/update/file%d.txt", fileID)
|
|
assert.EqualValues(t, expectedUpdateSHA, filesResponse.Files[0].SHA)
|
|
assert.EqualValues(t, expectedUpdateHTMLURL, *filesResponse.Files[0].HTMLURL)
|
|
assert.EqualValues(t, expectedUpdateDownloadURL, *filesResponse.Files[0].DownloadURL)
|
|
|
|
// Test updating a file without a message
|
|
changeFilesOptions = getChangeFilesOptions()
|
|
changeFilesOptions.Message = ""
|
|
changeFilesOptions.BranchName = repo1.DefaultBranch
|
|
fileID++
|
|
createTreePath = fmt.Sprintf("new/file%d.txt", fileID)
|
|
updateTreePath = fmt.Sprintf("update/file%d.txt", fileID)
|
|
deleteTreePath = fmt.Sprintf("delete/file%d.txt", fileID)
|
|
changeFilesOptions.Files[0].Path = createTreePath
|
|
changeFilesOptions.Files[1].Path = updateTreePath
|
|
changeFilesOptions.Files[2].Path = deleteTreePath
|
|
createFile(user2, repo1, updateTreePath)
|
|
createFile(user2, repo1, deleteTreePath)
|
|
req = NewRequestWithJSON(t, "POST", url, &changeFilesOptions)
|
|
resp = MakeRequest(t, req, http.StatusCreated)
|
|
DecodeJSON(t, resp, &filesResponse)
|
|
expectedMessage := fmt.Sprintf("Add %v\nUpdate %v\nDelete %v\n", createTreePath, updateTreePath, deleteTreePath)
|
|
assert.EqualValues(t, expectedMessage, filesResponse.Commit.Message)
|
|
|
|
// Test updating a file with the wrong SHA
|
|
fileID++
|
|
updateTreePath = fmt.Sprintf("update/file%d.txt", fileID)
|
|
createFile(user2, repo1, updateTreePath)
|
|
changeFilesOptions = getChangeFilesOptions()
|
|
changeFilesOptions.Files = []*api.ChangeFileOperation{changeFilesOptions.Files[1]}
|
|
changeFilesOptions.Files[0].Path = updateTreePath
|
|
correctSHA := changeFilesOptions.Files[0].SHA
|
|
changeFilesOptions.Files[0].SHA = "badsha"
|
|
req = NewRequestWithJSON(t, "POST", url, &changeFilesOptions)
|
|
resp = MakeRequest(t, req, http.StatusUnprocessableEntity)
|
|
expectedAPIError := context.APIError{
|
|
Message: "sha does not match [given: " + changeFilesOptions.Files[0].SHA + ", expected: " + correctSHA + "]",
|
|
URL: setting.API.SwaggerURL,
|
|
}
|
|
var apiError context.APIError
|
|
DecodeJSON(t, resp, &apiError)
|
|
assert.Equal(t, expectedAPIError, apiError)
|
|
|
|
// Test creating a file in repo1 by user4 who does not have write access
|
|
fileID++
|
|
createTreePath = fmt.Sprintf("new/file%d.txt", fileID)
|
|
updateTreePath = fmt.Sprintf("update/file%d.txt", fileID)
|
|
deleteTreePath = fmt.Sprintf("delete/file%d.txt", fileID)
|
|
createFile(user2, repo16, updateTreePath)
|
|
createFile(user2, repo16, deleteTreePath)
|
|
changeFilesOptions = getChangeFilesOptions()
|
|
changeFilesOptions.Files[0].Path = createTreePath
|
|
changeFilesOptions.Files[1].Path = updateTreePath
|
|
changeFilesOptions.Files[2].Path = deleteTreePath
|
|
url = fmt.Sprintf("/api/v1/repos/%s/%s/contents?token=%s", user2.Name, repo16.Name, token4)
|
|
req = NewRequestWithJSON(t, "POST", url, &changeFilesOptions)
|
|
MakeRequest(t, req, http.StatusNotFound)
|
|
|
|
// Tests a repo with no token given so will fail
|
|
fileID++
|
|
createTreePath = fmt.Sprintf("new/file%d.txt", fileID)
|
|
updateTreePath = fmt.Sprintf("update/file%d.txt", fileID)
|
|
deleteTreePath = fmt.Sprintf("delete/file%d.txt", fileID)
|
|
createFile(user2, repo16, updateTreePath)
|
|
createFile(user2, repo16, deleteTreePath)
|
|
changeFilesOptions = getChangeFilesOptions()
|
|
changeFilesOptions.Files[0].Path = createTreePath
|
|
changeFilesOptions.Files[1].Path = updateTreePath
|
|
changeFilesOptions.Files[2].Path = deleteTreePath
|
|
url = fmt.Sprintf("/api/v1/repos/%s/%s/contents", user2.Name, repo16.Name)
|
|
req = NewRequestWithJSON(t, "POST", url, &changeFilesOptions)
|
|
MakeRequest(t, req, http.StatusNotFound)
|
|
|
|
// Test using access token for a private repo that the user of the token owns
|
|
fileID++
|
|
createTreePath = fmt.Sprintf("new/file%d.txt", fileID)
|
|
updateTreePath = fmt.Sprintf("update/file%d.txt", fileID)
|
|
deleteTreePath = fmt.Sprintf("delete/file%d.txt", fileID)
|
|
createFile(user2, repo16, updateTreePath)
|
|
createFile(user2, repo16, deleteTreePath)
|
|
changeFilesOptions = getChangeFilesOptions()
|
|
changeFilesOptions.Files[0].Path = createTreePath
|
|
changeFilesOptions.Files[1].Path = updateTreePath
|
|
changeFilesOptions.Files[2].Path = deleteTreePath
|
|
url = fmt.Sprintf("/api/v1/repos/%s/%s/contents?token=%s", user2.Name, repo16.Name, token2)
|
|
req = NewRequestWithJSON(t, "POST", url, &changeFilesOptions)
|
|
MakeRequest(t, req, http.StatusCreated)
|
|
|
|
// Test using org repo "user3/repo3" where user2 is a collaborator
|
|
fileID++
|
|
createTreePath = fmt.Sprintf("new/file%d.txt", fileID)
|
|
updateTreePath = fmt.Sprintf("update/file%d.txt", fileID)
|
|
deleteTreePath = fmt.Sprintf("delete/file%d.txt", fileID)
|
|
createFile(user3, repo3, updateTreePath)
|
|
createFile(user3, repo3, deleteTreePath)
|
|
changeFilesOptions = getChangeFilesOptions()
|
|
changeFilesOptions.Files[0].Path = createTreePath
|
|
changeFilesOptions.Files[1].Path = updateTreePath
|
|
changeFilesOptions.Files[2].Path = deleteTreePath
|
|
url = fmt.Sprintf("/api/v1/repos/%s/%s/contents?token=%s", user3.Name, repo3.Name, token2)
|
|
req = NewRequestWithJSON(t, "POST", url, &changeFilesOptions)
|
|
MakeRequest(t, req, http.StatusCreated)
|
|
|
|
// Test using org repo "user3/repo3" with no user token
|
|
fileID++
|
|
createTreePath = fmt.Sprintf("new/file%d.txt", fileID)
|
|
updateTreePath = fmt.Sprintf("update/file%d.txt", fileID)
|
|
deleteTreePath = fmt.Sprintf("delete/file%d.txt", fileID)
|
|
createFile(user3, repo3, updateTreePath)
|
|
createFile(user3, repo3, deleteTreePath)
|
|
changeFilesOptions = getChangeFilesOptions()
|
|
changeFilesOptions.Files[0].Path = createTreePath
|
|
changeFilesOptions.Files[1].Path = updateTreePath
|
|
changeFilesOptions.Files[2].Path = deleteTreePath
|
|
url = fmt.Sprintf("/api/v1/repos/%s/%s/contents", user3.Name, repo3.Name)
|
|
req = NewRequestWithJSON(t, "POST", url, &changeFilesOptions)
|
|
MakeRequest(t, req, http.StatusNotFound)
|
|
|
|
// Test using repo "user2/repo1" where user4 is a NOT collaborator
|
|
fileID++
|
|
createTreePath = fmt.Sprintf("new/file%d.txt", fileID)
|
|
updateTreePath = fmt.Sprintf("update/file%d.txt", fileID)
|
|
deleteTreePath = fmt.Sprintf("delete/file%d.txt", fileID)
|
|
createFile(user2, repo1, updateTreePath)
|
|
createFile(user2, repo1, deleteTreePath)
|
|
changeFilesOptions = getChangeFilesOptions()
|
|
changeFilesOptions.Files[0].Path = createTreePath
|
|
changeFilesOptions.Files[1].Path = updateTreePath
|
|
changeFilesOptions.Files[2].Path = deleteTreePath
|
|
url = fmt.Sprintf("/api/v1/repos/%s/%s/contents?token=%s", user2.Name, repo1.Name, token4)
|
|
req = NewRequestWithJSON(t, "POST", url, &changeFilesOptions)
|
|
MakeRequest(t, req, http.StatusForbidden)
|
|
})
|
|
}
|