mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-12-05 23:46:48 +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>
181 lines
5.1 KiB
Go
181 lines
5.1 KiB
Go
// Copyright 2022 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package integration
|
|
|
|
import (
|
|
"archive/tar"
|
|
"bytes"
|
|
"compress/gzip"
|
|
"fmt"
|
|
"io"
|
|
"mime/multipart"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"testing"
|
|
"time"
|
|
|
|
auth_model "code.gitea.io/gitea/models/auth"
|
|
"code.gitea.io/gitea/models/db"
|
|
"code.gitea.io/gitea/models/packages"
|
|
"code.gitea.io/gitea/models/unittest"
|
|
user_model "code.gitea.io/gitea/models/user"
|
|
pub_module "code.gitea.io/gitea/modules/packages/pub"
|
|
"code.gitea.io/gitea/tests"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestPackagePub(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
|
|
|
|
token := "Bearer " + getUserToken(t, user.Name, auth_model.AccessTokenScopeWritePackage)
|
|
|
|
packageName := "test_package"
|
|
packageVersion := "1.0.1"
|
|
packageDescription := "Test Description"
|
|
|
|
filename := fmt.Sprintf("%s.tar.gz", packageVersion)
|
|
|
|
pubspecContent := `name: ` + packageName + `
|
|
version: ` + packageVersion + `
|
|
description: ` + packageDescription
|
|
|
|
var buf bytes.Buffer
|
|
zw := gzip.NewWriter(&buf)
|
|
archive := tar.NewWriter(zw)
|
|
archive.WriteHeader(&tar.Header{
|
|
Name: "pubspec.yaml",
|
|
Mode: 0o600,
|
|
Size: int64(len(pubspecContent)),
|
|
})
|
|
archive.Write([]byte(pubspecContent))
|
|
archive.Close()
|
|
zw.Close()
|
|
content := buf.Bytes()
|
|
|
|
root := fmt.Sprintf("/api/packages/%s/pub", user.Name)
|
|
|
|
t.Run("Upload", func(t *testing.T) {
|
|
defer tests.PrintCurrentTest(t)()
|
|
|
|
uploadURL := root + "/api/packages/versions/new"
|
|
|
|
req := NewRequest(t, "GET", uploadURL)
|
|
MakeRequest(t, req, http.StatusUnauthorized)
|
|
|
|
req = NewRequest(t, "GET", uploadURL)
|
|
addTokenAuthHeader(req, token)
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
|
|
type UploadRequest struct {
|
|
URL string `json:"url"`
|
|
Fields map[string]string `json:"fields"`
|
|
}
|
|
|
|
var result UploadRequest
|
|
DecodeJSON(t, resp, &result)
|
|
|
|
assert.Empty(t, result.Fields)
|
|
|
|
uploadFile := func(t *testing.T, url string, content []byte, expectedStatus int) *httptest.ResponseRecorder {
|
|
body := &bytes.Buffer{}
|
|
writer := multipart.NewWriter(body)
|
|
part, _ := writer.CreateFormFile("file", "dummy.tar.gz")
|
|
_, _ = io.Copy(part, bytes.NewReader(content))
|
|
|
|
_ = writer.Close()
|
|
|
|
req := NewRequestWithBody(t, "POST", url, body)
|
|
req.Header.Add("Content-Type", writer.FormDataContentType())
|
|
addTokenAuthHeader(req, token)
|
|
return MakeRequest(t, req, expectedStatus)
|
|
}
|
|
|
|
resp = uploadFile(t, result.URL, content, http.StatusNoContent)
|
|
|
|
req = NewRequest(t, "GET", resp.Header().Get("Location"))
|
|
addTokenAuthHeader(req, token)
|
|
MakeRequest(t, req, http.StatusOK)
|
|
|
|
pvs, err := packages.GetVersionsByPackageType(db.DefaultContext, user.ID, packages.TypePub)
|
|
assert.NoError(t, err)
|
|
assert.Len(t, pvs, 1)
|
|
|
|
pd, err := packages.GetPackageDescriptor(db.DefaultContext, pvs[0])
|
|
assert.NoError(t, err)
|
|
assert.NotNil(t, pd.SemVer)
|
|
assert.IsType(t, &pub_module.Metadata{}, pd.Metadata)
|
|
assert.Equal(t, packageName, pd.Package.Name)
|
|
assert.Equal(t, packageVersion, pd.Version.Version)
|
|
|
|
pfs, err := packages.GetFilesByVersionID(db.DefaultContext, pvs[0].ID)
|
|
assert.NoError(t, err)
|
|
assert.Len(t, pfs, 1)
|
|
assert.Equal(t, filename, pfs[0].Name)
|
|
assert.True(t, pfs[0].IsLead)
|
|
|
|
pb, err := packages.GetBlobByID(db.DefaultContext, pfs[0].BlobID)
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, int64(len(content)), pb.Size)
|
|
|
|
_ = uploadFile(t, result.URL, content, http.StatusBadRequest)
|
|
})
|
|
|
|
t.Run("Download", func(t *testing.T) {
|
|
defer tests.PrintCurrentTest(t)()
|
|
|
|
req := NewRequest(t, "GET", fmt.Sprintf("%s/api/packages/%s/%s", root, packageName, packageVersion))
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
|
|
type VersionMetadata struct {
|
|
Version string `json:"version"`
|
|
ArchiveURL string `json:"archive_url"`
|
|
Published time.Time `json:"published"`
|
|
Pubspec interface{} `json:"pubspec,omitempty"`
|
|
}
|
|
|
|
var result VersionMetadata
|
|
DecodeJSON(t, resp, &result)
|
|
|
|
assert.Equal(t, packageVersion, result.Version)
|
|
assert.NotNil(t, result.Pubspec)
|
|
|
|
req = NewRequest(t, "GET", result.ArchiveURL)
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
|
|
assert.Equal(t, content, resp.Body.Bytes())
|
|
})
|
|
|
|
t.Run("EnumeratePackageVersions", func(t *testing.T) {
|
|
defer tests.PrintCurrentTest(t)()
|
|
|
|
req := NewRequest(t, "GET", fmt.Sprintf("%s/api/packages/%s", root, packageName))
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
|
|
type VersionMetadata struct {
|
|
Version string `json:"version"`
|
|
ArchiveURL string `json:"archive_url"`
|
|
Published time.Time `json:"published"`
|
|
Pubspec interface{} `json:"pubspec,omitempty"`
|
|
}
|
|
|
|
type PackageVersions struct {
|
|
Name string `json:"name"`
|
|
Latest *VersionMetadata `json:"latest"`
|
|
Versions []*VersionMetadata `json:"versions"`
|
|
}
|
|
|
|
var result PackageVersions
|
|
DecodeJSON(t, resp, &result)
|
|
|
|
assert.Equal(t, packageName, result.Name)
|
|
assert.NotNil(t, result.Latest)
|
|
assert.Len(t, result.Versions, 1)
|
|
assert.Equal(t, result.Latest.Version, result.Versions[0].Version)
|
|
assert.Equal(t, packageVersion, result.Latest.Version)
|
|
assert.NotNil(t, result.Latest.Pubspec)
|
|
})
|
|
}
|