mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-12-05 15:43:12 +01:00
18de83b2a3
## 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>
227 lines
6.8 KiB
Go
227 lines
6.8 KiB
Go
// Copyright 2019 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package integration
|
|
|
|
import (
|
|
"archive/zip"
|
|
"bytes"
|
|
"io"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"testing"
|
|
|
|
"code.gitea.io/gitea/models/auth"
|
|
"code.gitea.io/gitea/models/db"
|
|
git_model "code.gitea.io/gitea/models/git"
|
|
repo_model "code.gitea.io/gitea/models/repo"
|
|
"code.gitea.io/gitea/modules/json"
|
|
"code.gitea.io/gitea/modules/lfs"
|
|
"code.gitea.io/gitea/modules/setting"
|
|
"code.gitea.io/gitea/routers/web"
|
|
"code.gitea.io/gitea/tests"
|
|
|
|
gzipp "github.com/klauspost/compress/gzip"
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func storeObjectInRepo(t *testing.T, repositoryID int64, content *[]byte) string {
|
|
pointer, err := lfs.GeneratePointer(bytes.NewReader(*content))
|
|
assert.NoError(t, err)
|
|
|
|
_, err = git_model.NewLFSMetaObject(db.DefaultContext, &git_model.LFSMetaObject{Pointer: pointer, RepositoryID: repositoryID})
|
|
assert.NoError(t, err)
|
|
contentStore := lfs.NewContentStore()
|
|
exist, err := contentStore.Exists(pointer)
|
|
assert.NoError(t, err)
|
|
if !exist {
|
|
err := contentStore.Put(pointer, bytes.NewReader(*content))
|
|
assert.NoError(t, err)
|
|
}
|
|
return pointer.Oid
|
|
}
|
|
|
|
func storeAndGetLfsToken(t *testing.T, content *[]byte, extraHeader *http.Header, expectedStatus int, ts ...auth.AccessTokenScope) *httptest.ResponseRecorder {
|
|
repo, err := repo_model.GetRepositoryByOwnerAndName(db.DefaultContext, "user2", "repo1")
|
|
assert.NoError(t, err)
|
|
oid := storeObjectInRepo(t, repo.ID, content)
|
|
defer git_model.RemoveLFSMetaObjectByOid(db.DefaultContext, repo.ID, oid)
|
|
|
|
token := getUserToken(t, "user2", ts...)
|
|
|
|
// Request OID
|
|
req := NewRequest(t, "GET", "/user2/repo1.git/info/lfs/objects/"+oid+"/test")
|
|
req.Header.Set("Accept-Encoding", "gzip")
|
|
req.SetBasicAuth("user2", token)
|
|
if extraHeader != nil {
|
|
for key, values := range *extraHeader {
|
|
for _, value := range values {
|
|
req.Header.Add(key, value)
|
|
}
|
|
}
|
|
}
|
|
|
|
resp := MakeRequest(t, req, expectedStatus)
|
|
|
|
return resp
|
|
}
|
|
|
|
func storeAndGetLfs(t *testing.T, content *[]byte, extraHeader *http.Header, expectedStatus int) *httptest.ResponseRecorder {
|
|
repo, err := repo_model.GetRepositoryByOwnerAndName(db.DefaultContext, "user2", "repo1")
|
|
assert.NoError(t, err)
|
|
oid := storeObjectInRepo(t, repo.ID, content)
|
|
defer git_model.RemoveLFSMetaObjectByOid(db.DefaultContext, repo.ID, oid)
|
|
|
|
session := loginUser(t, "user2")
|
|
|
|
// Request OID
|
|
req := NewRequest(t, "GET", "/user2/repo1.git/info/lfs/objects/"+oid+"/test")
|
|
req.Header.Set("Accept-Encoding", "gzip")
|
|
if extraHeader != nil {
|
|
for key, values := range *extraHeader {
|
|
for _, value := range values {
|
|
req.Header.Add(key, value)
|
|
}
|
|
}
|
|
}
|
|
|
|
resp := session.MakeRequest(t, req, expectedStatus)
|
|
|
|
return resp
|
|
}
|
|
|
|
func checkResponseTestContentEncoding(t *testing.T, content *[]byte, resp *httptest.ResponseRecorder, expectGzip bool) {
|
|
contentEncoding := resp.Header().Get("Content-Encoding")
|
|
if !expectGzip || !setting.EnableGzip {
|
|
assert.NotContains(t, contentEncoding, "gzip")
|
|
|
|
result := resp.Body.Bytes()
|
|
assert.Equal(t, *content, result)
|
|
} else {
|
|
assert.Contains(t, contentEncoding, "gzip")
|
|
gzippReader, err := gzipp.NewReader(resp.Body)
|
|
assert.NoError(t, err)
|
|
result, err := io.ReadAll(gzippReader)
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, *content, result)
|
|
}
|
|
}
|
|
|
|
func TestGetLFSSmall(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
content := []byte("A very small file\n")
|
|
|
|
resp := storeAndGetLfs(t, &content, nil, http.StatusOK)
|
|
checkResponseTestContentEncoding(t, &content, resp, false)
|
|
}
|
|
|
|
func TestGetLFSSmallToken(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
content := []byte("A very small file\n")
|
|
|
|
resp := storeAndGetLfsToken(t, &content, nil, http.StatusOK, auth.AccessTokenScopePublicOnly, auth.AccessTokenScopeReadRepository)
|
|
checkResponseTestContentEncoding(t, &content, resp, false)
|
|
}
|
|
|
|
func TestGetLFSSmallTokenFail(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
content := []byte("A very small file\n")
|
|
|
|
storeAndGetLfsToken(t, &content, nil, http.StatusForbidden, auth.AccessTokenScopeReadNotification)
|
|
}
|
|
|
|
func TestGetLFSLarge(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
content := make([]byte, web.GzipMinSize*10)
|
|
for i := range content {
|
|
content[i] = byte(i % 256)
|
|
}
|
|
|
|
resp := storeAndGetLfs(t, &content, nil, http.StatusOK)
|
|
checkResponseTestContentEncoding(t, &content, resp, true)
|
|
}
|
|
|
|
func TestGetLFSGzip(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
b := make([]byte, web.GzipMinSize*10)
|
|
for i := range b {
|
|
b[i] = byte(i % 256)
|
|
}
|
|
outputBuffer := bytes.NewBuffer([]byte{})
|
|
gzippWriter := gzipp.NewWriter(outputBuffer)
|
|
gzippWriter.Write(b)
|
|
gzippWriter.Close()
|
|
content := outputBuffer.Bytes()
|
|
|
|
resp := storeAndGetLfs(t, &content, nil, http.StatusOK)
|
|
checkResponseTestContentEncoding(t, &content, resp, false)
|
|
}
|
|
|
|
func TestGetLFSZip(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
b := make([]byte, web.GzipMinSize*10)
|
|
for i := range b {
|
|
b[i] = byte(i % 256)
|
|
}
|
|
outputBuffer := bytes.NewBuffer([]byte{})
|
|
zipWriter := zip.NewWriter(outputBuffer)
|
|
fileWriter, err := zipWriter.Create("default")
|
|
assert.NoError(t, err)
|
|
fileWriter.Write(b)
|
|
zipWriter.Close()
|
|
content := outputBuffer.Bytes()
|
|
|
|
resp := storeAndGetLfs(t, &content, nil, http.StatusOK)
|
|
checkResponseTestContentEncoding(t, &content, resp, false)
|
|
}
|
|
|
|
func TestGetLFSRangeNo(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
content := []byte("123456789\n")
|
|
|
|
resp := storeAndGetLfs(t, &content, nil, http.StatusOK)
|
|
assert.Equal(t, content, resp.Body.Bytes())
|
|
}
|
|
|
|
func TestGetLFSRange(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
content := []byte("123456789\n")
|
|
|
|
tests := []struct {
|
|
in string
|
|
out string
|
|
status int
|
|
}{
|
|
{"bytes=0-0", "1", http.StatusPartialContent},
|
|
{"bytes=0-1", "12", http.StatusPartialContent},
|
|
{"bytes=1-1", "2", http.StatusPartialContent},
|
|
{"bytes=1-3", "234", http.StatusPartialContent},
|
|
{"bytes=1-", "23456789\n", http.StatusPartialContent},
|
|
// end-range smaller than start-range is ignored
|
|
{"bytes=1-0", "23456789\n", http.StatusPartialContent},
|
|
{"bytes=0-10", "123456789\n", http.StatusPartialContent},
|
|
// end-range bigger than length-1 is ignored
|
|
{"bytes=0-11", "123456789\n", http.StatusPartialContent},
|
|
{"bytes=11-", "Requested Range Not Satisfiable", http.StatusRequestedRangeNotSatisfiable},
|
|
// incorrect header value cause whole header to be ignored
|
|
{"bytes=-", "123456789\n", http.StatusOK},
|
|
{"foobar", "123456789\n", http.StatusOK},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.in, func(t *testing.T) {
|
|
h := http.Header{
|
|
"Range": []string{tt.in},
|
|
}
|
|
resp := storeAndGetLfs(t, &content, &h, tt.status)
|
|
if tt.status == http.StatusPartialContent || tt.status == http.StatusOK {
|
|
assert.Equal(t, tt.out, resp.Body.String())
|
|
} else {
|
|
var er lfs.ErrorResponse
|
|
err := json.Unmarshal(resp.Body.Bytes(), &er)
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, tt.out, er.Message)
|
|
}
|
|
})
|
|
}
|
|
}
|