mirror of
https://github.com/go-gitea/gitea
synced 2024-09-12 04:09:41 +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>
146 lines
5.3 KiB
Go
146 lines
5.3 KiB
Go
// Copyright 2017 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package integration
|
|
|
|
import (
|
|
"bytes"
|
|
"encoding/base64"
|
|
"fmt"
|
|
"io"
|
|
"mime/multipart"
|
|
"net/http"
|
|
"testing"
|
|
|
|
auth_model "code.gitea.io/gitea/models/auth"
|
|
"code.gitea.io/gitea/models/db"
|
|
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/json"
|
|
"code.gitea.io/gitea/modules/setting"
|
|
api "code.gitea.io/gitea/modules/structs"
|
|
"code.gitea.io/gitea/modules/test"
|
|
"code.gitea.io/gitea/tests"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestEmptyRepo(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
subPaths := []string{
|
|
"commits/master",
|
|
"raw/foo",
|
|
"commit/1ae57b34ccf7e18373",
|
|
"graph",
|
|
}
|
|
emptyRepo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 5})
|
|
assert.True(t, emptyRepo.IsEmpty)
|
|
owner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: emptyRepo.OwnerID})
|
|
for _, subPath := range subPaths {
|
|
req := NewRequestf(t, "GET", "/%s/%s/%s", owner.Name, emptyRepo.Name, subPath)
|
|
MakeRequest(t, req, http.StatusNotFound)
|
|
}
|
|
}
|
|
|
|
func TestEmptyRepoAddFile(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
err := user_model.UpdateUserCols(db.DefaultContext, &user_model.User{ID: 30, ProhibitLogin: false}, "prohibit_login")
|
|
assert.NoError(t, err)
|
|
|
|
session := loginUser(t, "user30")
|
|
req := NewRequest(t, "GET", "/user30/empty/_new/"+setting.Repository.DefaultBranch)
|
|
resp := session.MakeRequest(t, req, http.StatusOK)
|
|
doc := NewHTMLParser(t, resp.Body).Find(`input[name="commit_choice"]`)
|
|
assert.Empty(t, doc.AttrOr("checked", "_no_"))
|
|
req = NewRequestWithValues(t, "POST", "/user30/empty/_new/"+setting.Repository.DefaultBranch, map[string]string{
|
|
"_csrf": GetCSRF(t, session, "/user/settings"),
|
|
"commit_choice": "direct",
|
|
"tree_path": "test-file.md",
|
|
"content": "newly-added-test-file",
|
|
})
|
|
|
|
resp = session.MakeRequest(t, req, http.StatusSeeOther)
|
|
redirect := test.RedirectURL(resp)
|
|
assert.Equal(t, "/user30/empty/src/branch/"+setting.Repository.DefaultBranch+"/test-file.md", redirect)
|
|
|
|
req = NewRequest(t, "GET", redirect)
|
|
resp = session.MakeRequest(t, req, http.StatusOK)
|
|
assert.Contains(t, resp.Body.String(), "newly-added-test-file")
|
|
}
|
|
|
|
func TestEmptyRepoUploadFile(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
err := user_model.UpdateUserCols(db.DefaultContext, &user_model.User{ID: 30, ProhibitLogin: false}, "prohibit_login")
|
|
assert.NoError(t, err)
|
|
|
|
session := loginUser(t, "user30")
|
|
req := NewRequest(t, "GET", "/user30/empty/_new/"+setting.Repository.DefaultBranch)
|
|
resp := session.MakeRequest(t, req, http.StatusOK)
|
|
doc := NewHTMLParser(t, resp.Body).Find(`input[name="commit_choice"]`)
|
|
assert.Empty(t, doc.AttrOr("checked", "_no_"))
|
|
|
|
body := &bytes.Buffer{}
|
|
mpForm := multipart.NewWriter(body)
|
|
_ = mpForm.WriteField("_csrf", GetCSRF(t, session, "/user/settings"))
|
|
file, _ := mpForm.CreateFormFile("file", "uploaded-file.txt")
|
|
_, _ = io.Copy(file, bytes.NewBufferString("newly-uploaded-test-file"))
|
|
_ = mpForm.Close()
|
|
|
|
req = NewRequestWithBody(t, "POST", "/user30/empty/upload-file", body)
|
|
req.Header.Add("Content-Type", mpForm.FormDataContentType())
|
|
resp = session.MakeRequest(t, req, http.StatusOK)
|
|
respMap := map[string]string{}
|
|
assert.NoError(t, json.Unmarshal(resp.Body.Bytes(), &respMap))
|
|
|
|
req = NewRequestWithValues(t, "POST", "/user30/empty/_upload/"+setting.Repository.DefaultBranch, map[string]string{
|
|
"_csrf": GetCSRF(t, session, "/user/settings"),
|
|
"commit_choice": "direct",
|
|
"files": respMap["uuid"],
|
|
"tree_path": "",
|
|
})
|
|
resp = session.MakeRequest(t, req, http.StatusSeeOther)
|
|
redirect := test.RedirectURL(resp)
|
|
assert.Equal(t, "/user30/empty/src/branch/"+setting.Repository.DefaultBranch+"/", redirect)
|
|
|
|
req = NewRequest(t, "GET", redirect)
|
|
resp = session.MakeRequest(t, req, http.StatusOK)
|
|
assert.Contains(t, resp.Body.String(), "uploaded-file.txt")
|
|
}
|
|
|
|
func TestEmptyRepoAddFileByAPI(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
err := user_model.UpdateUserCols(db.DefaultContext, &user_model.User{ID: 30, ProhibitLogin: false}, "prohibit_login")
|
|
assert.NoError(t, err)
|
|
|
|
session := loginUser(t, "user30")
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteRepository)
|
|
|
|
url := fmt.Sprintf("/api/v1/repos/user30/empty/contents/new-file.txt?token=%s", token)
|
|
req := NewRequestWithJSON(t, "POST", url, &api.CreateFileOptions{
|
|
FileOptions: api.FileOptions{
|
|
NewBranchName: "new_branch",
|
|
Message: "init",
|
|
},
|
|
Content: base64.StdEncoding.EncodeToString([]byte("newly-added-api-file")),
|
|
})
|
|
|
|
resp := MakeRequest(t, req, http.StatusCreated)
|
|
var fileResponse api.FileResponse
|
|
DecodeJSON(t, resp, &fileResponse)
|
|
expectedHTMLURL := setting.AppURL + "user30/empty/src/branch/new_branch/new-file.txt"
|
|
assert.EqualValues(t, expectedHTMLURL, *fileResponse.Content.HTMLURL)
|
|
|
|
req = NewRequest(t, "GET", "/user30/empty/src/branch/new_branch/new-file.txt")
|
|
resp = session.MakeRequest(t, req, http.StatusOK)
|
|
assert.Contains(t, resp.Body.String(), "newly-added-api-file")
|
|
|
|
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/repos/user30/empty?token=%s", token))
|
|
resp = session.MakeRequest(t, req, http.StatusOK)
|
|
var apiRepo api.Repository
|
|
DecodeJSON(t, resp, &apiRepo)
|
|
assert.Equal(t, "new_branch", apiRepo.DefaultBranch)
|
|
}
|