mirror of
https://github.com/go-gitea/gitea
synced 2024-08-26 03:55:26 +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>
125 lines
4.9 KiB
Go
125 lines
4.9 KiB
Go
// Copyright 2019 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package integration
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
"testing"
|
|
"time"
|
|
|
|
auth_model "code.gitea.io/gitea/models/auth"
|
|
"code.gitea.io/gitea/models/db"
|
|
issues_model "code.gitea.io/gitea/models/issues"
|
|
"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 TestAPIGetTrackedTimes(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
user2 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
|
|
issue2 := unittest.AssertExistsAndLoadBean(t, &issues_model.Issue{ID: 2})
|
|
assert.NoError(t, issue2.LoadRepo(db.DefaultContext))
|
|
|
|
session := loginUser(t, user2.Name)
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeReadIssue)
|
|
|
|
req := NewRequestf(t, "GET", "/api/v1/repos/%s/%s/issues/%d/times?token=%s", user2.Name, issue2.Repo.Name, issue2.Index, token)
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
var apiTimes api.TrackedTimeList
|
|
DecodeJSON(t, resp, &apiTimes)
|
|
expect, err := issues_model.GetTrackedTimes(db.DefaultContext, &issues_model.FindTrackedTimesOptions{IssueID: issue2.ID})
|
|
assert.NoError(t, err)
|
|
assert.Len(t, apiTimes, 3)
|
|
|
|
for i, time := range expect {
|
|
assert.Equal(t, time.ID, apiTimes[i].ID)
|
|
assert.EqualValues(t, issue2.Title, apiTimes[i].Issue.Title)
|
|
assert.EqualValues(t, issue2.ID, apiTimes[i].IssueID)
|
|
assert.Equal(t, time.Created.Unix(), apiTimes[i].Created.Unix())
|
|
assert.Equal(t, time.Time, apiTimes[i].Time)
|
|
user, err := user_model.GetUserByID(db.DefaultContext, time.UserID)
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, user.Name, apiTimes[i].UserName)
|
|
}
|
|
|
|
// test filter
|
|
since := "2000-01-01T00%3A00%3A02%2B00%3A00" // 946684802
|
|
before := "2000-01-01T00%3A00%3A12%2B00%3A00" // 946684812
|
|
|
|
req = NewRequestf(t, "GET", "/api/v1/repos/%s/%s/issues/%d/times?since=%s&before=%s&token=%s", user2.Name, issue2.Repo.Name, issue2.Index, since, before, token)
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
var filterAPITimes api.TrackedTimeList
|
|
DecodeJSON(t, resp, &filterAPITimes)
|
|
assert.Len(t, filterAPITimes, 2)
|
|
assert.Equal(t, int64(3), filterAPITimes[0].ID)
|
|
assert.Equal(t, int64(6), filterAPITimes[1].ID)
|
|
}
|
|
|
|
func TestAPIDeleteTrackedTime(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
time6 := unittest.AssertExistsAndLoadBean(t, &issues_model.TrackedTime{ID: 6})
|
|
issue2 := unittest.AssertExistsAndLoadBean(t, &issues_model.Issue{ID: 2})
|
|
assert.NoError(t, issue2.LoadRepo(db.DefaultContext))
|
|
user2 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
|
|
|
|
session := loginUser(t, user2.Name)
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteIssue)
|
|
|
|
// Deletion not allowed
|
|
req := NewRequestf(t, "DELETE", "/api/v1/repos/%s/%s/issues/%d/times/%d?token=%s", user2.Name, issue2.Repo.Name, issue2.Index, time6.ID, token)
|
|
MakeRequest(t, req, http.StatusForbidden)
|
|
|
|
time3 := unittest.AssertExistsAndLoadBean(t, &issues_model.TrackedTime{ID: 3})
|
|
req = NewRequestf(t, "DELETE", "/api/v1/repos/%s/%s/issues/%d/times/%d?token=%s", user2.Name, issue2.Repo.Name, issue2.Index, time3.ID, token)
|
|
MakeRequest(t, req, http.StatusNoContent)
|
|
// Delete non existing time
|
|
MakeRequest(t, req, http.StatusNotFound)
|
|
|
|
// Reset time of user 2 on issue 2
|
|
trackedSeconds, err := issues_model.GetTrackedSeconds(db.DefaultContext, issues_model.FindTrackedTimesOptions{IssueID: 2, UserID: 2})
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, int64(3661), trackedSeconds)
|
|
|
|
req = NewRequestf(t, "DELETE", "/api/v1/repos/%s/%s/issues/%d/times?token=%s", user2.Name, issue2.Repo.Name, issue2.Index, token)
|
|
MakeRequest(t, req, http.StatusNoContent)
|
|
MakeRequest(t, req, http.StatusNotFound)
|
|
|
|
trackedSeconds, err = issues_model.GetTrackedSeconds(db.DefaultContext, issues_model.FindTrackedTimesOptions{IssueID: 2, UserID: 2})
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, int64(0), trackedSeconds)
|
|
}
|
|
|
|
func TestAPIAddTrackedTimes(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
issue2 := unittest.AssertExistsAndLoadBean(t, &issues_model.Issue{ID: 2})
|
|
assert.NoError(t, issue2.LoadRepo(db.DefaultContext))
|
|
user2 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
|
|
admin := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 1})
|
|
|
|
session := loginUser(t, admin.Name)
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteIssue)
|
|
|
|
urlStr := fmt.Sprintf("/api/v1/repos/%s/%s/issues/%d/times?token=%s", user2.Name, issue2.Repo.Name, issue2.Index, token)
|
|
|
|
req := NewRequestWithJSON(t, "POST", urlStr, &api.AddTimeOption{
|
|
Time: 33,
|
|
User: user2.Name,
|
|
Created: time.Unix(947688818, 0),
|
|
})
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
var apiNewTime api.TrackedTime
|
|
DecodeJSON(t, resp, &apiNewTime)
|
|
|
|
assert.EqualValues(t, 33, apiNewTime.Time)
|
|
assert.EqualValues(t, user2.ID, apiNewTime.UserID)
|
|
assert.EqualValues(t, 947688818, apiNewTime.Created.Unix())
|
|
}
|