mirror of
https://github.com/go-gitea/gitea
synced 2024-08-25 19:52:15 +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>
194 lines
7.1 KiB
Go
194 lines
7.1 KiB
Go
// Copyright 2020 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package integration
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
"testing"
|
|
|
|
activities_model "code.gitea.io/gitea/models/activities"
|
|
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"
|
|
api "code.gitea.io/gitea/modules/structs"
|
|
"code.gitea.io/gitea/tests"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestAPINotification(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
user2 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
|
|
repo1 := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 1})
|
|
thread5 := unittest.AssertExistsAndLoadBean(t, &activities_model.Notification{ID: 5})
|
|
assert.NoError(t, thread5.LoadAttributes(db.DefaultContext))
|
|
session := loginUser(t, user2.Name)
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteNotification, auth_model.AccessTokenScopeWriteRepository)
|
|
|
|
// -- GET /notifications --
|
|
// test filter
|
|
since := "2000-01-01T00%3A50%3A01%2B00%3A00" // 946687801
|
|
req := NewRequest(t, "GET", fmt.Sprintf("/api/v1/notifications?since=%s&token=%s", since, token))
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
var apiNL []api.NotificationThread
|
|
DecodeJSON(t, resp, &apiNL)
|
|
|
|
assert.Len(t, apiNL, 1)
|
|
assert.EqualValues(t, 5, apiNL[0].ID)
|
|
|
|
// test filter
|
|
before := "2000-01-01T01%3A06%3A59%2B00%3A00" // 946688819
|
|
|
|
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/notifications?all=%s&before=%s&token=%s", "true", before, token))
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
DecodeJSON(t, resp, &apiNL)
|
|
|
|
assert.Len(t, apiNL, 3)
|
|
assert.EqualValues(t, 4, apiNL[0].ID)
|
|
assert.True(t, apiNL[0].Unread)
|
|
assert.False(t, apiNL[0].Pinned)
|
|
assert.EqualValues(t, 3, apiNL[1].ID)
|
|
assert.False(t, apiNL[1].Unread)
|
|
assert.True(t, apiNL[1].Pinned)
|
|
assert.EqualValues(t, 2, apiNL[2].ID)
|
|
assert.False(t, apiNL[2].Unread)
|
|
assert.False(t, apiNL[2].Pinned)
|
|
|
|
// -- GET /repos/{owner}/{repo}/notifications --
|
|
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/repos/%s/%s/notifications?status-types=unread&token=%s", user2.Name, repo1.Name, token))
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
DecodeJSON(t, resp, &apiNL)
|
|
|
|
assert.Len(t, apiNL, 1)
|
|
assert.EqualValues(t, 4, apiNL[0].ID)
|
|
|
|
// -- GET /repos/{owner}/{repo}/notifications -- multiple status-types
|
|
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/repos/%s/%s/notifications?status-types=unread&status-types=pinned&token=%s", user2.Name, repo1.Name, token))
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
DecodeJSON(t, resp, &apiNL)
|
|
|
|
assert.Len(t, apiNL, 2)
|
|
assert.EqualValues(t, 4, apiNL[0].ID)
|
|
assert.True(t, apiNL[0].Unread)
|
|
assert.False(t, apiNL[0].Pinned)
|
|
assert.EqualValues(t, 3, apiNL[1].ID)
|
|
assert.False(t, apiNL[1].Unread)
|
|
assert.True(t, apiNL[1].Pinned)
|
|
|
|
// -- GET /notifications/threads/{id} --
|
|
// get forbidden
|
|
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/notifications/threads/%d?token=%s", 1, token))
|
|
MakeRequest(t, req, http.StatusForbidden)
|
|
|
|
// get own
|
|
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/notifications/threads/%d?token=%s", thread5.ID, token))
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
var apiN api.NotificationThread
|
|
DecodeJSON(t, resp, &apiN)
|
|
|
|
assert.EqualValues(t, 5, apiN.ID)
|
|
assert.False(t, apiN.Pinned)
|
|
assert.True(t, apiN.Unread)
|
|
assert.EqualValues(t, "issue4", apiN.Subject.Title)
|
|
assert.EqualValues(t, "Issue", apiN.Subject.Type)
|
|
assert.EqualValues(t, thread5.Issue.APIURL(), apiN.Subject.URL)
|
|
assert.EqualValues(t, thread5.Repository.HTMLURL(), apiN.Repository.HTMLURL)
|
|
|
|
new := struct {
|
|
New int64 `json:"new"`
|
|
}{}
|
|
|
|
// -- check notifications --
|
|
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/notifications/new?token=%s", token))
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
DecodeJSON(t, resp, &new)
|
|
assert.True(t, new.New > 0)
|
|
|
|
// -- mark notifications as read --
|
|
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/notifications?status-types=unread&token=%s", token))
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
DecodeJSON(t, resp, &apiNL)
|
|
assert.Len(t, apiNL, 2)
|
|
|
|
lastReadAt := "2000-01-01T00%3A50%3A01%2B00%3A00" // 946687801 <- only Notification 4 is in this filter ...
|
|
req = NewRequest(t, "PUT", fmt.Sprintf("/api/v1/repos/%s/%s/notifications?last_read_at=%s&token=%s", user2.Name, repo1.Name, lastReadAt, token))
|
|
MakeRequest(t, req, http.StatusResetContent)
|
|
|
|
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/notifications?status-types=unread&token=%s", token))
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
DecodeJSON(t, resp, &apiNL)
|
|
assert.Len(t, apiNL, 1)
|
|
|
|
// -- PATCH /notifications/threads/{id} --
|
|
req = NewRequest(t, "PATCH", fmt.Sprintf("/api/v1/notifications/threads/%d?token=%s", thread5.ID, token))
|
|
MakeRequest(t, req, http.StatusResetContent)
|
|
|
|
assert.Equal(t, activities_model.NotificationStatusUnread, thread5.Status)
|
|
thread5 = unittest.AssertExistsAndLoadBean(t, &activities_model.Notification{ID: 5})
|
|
assert.Equal(t, activities_model.NotificationStatusRead, thread5.Status)
|
|
|
|
// -- check notifications --
|
|
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/notifications/new?token=%s", token))
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
DecodeJSON(t, resp, &new)
|
|
assert.True(t, new.New == 0)
|
|
}
|
|
|
|
func TestAPINotificationPUT(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
user2 := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
|
|
thread5 := unittest.AssertExistsAndLoadBean(t, &activities_model.Notification{ID: 5})
|
|
assert.NoError(t, thread5.LoadAttributes(db.DefaultContext))
|
|
session := loginUser(t, user2.Name)
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteNotification)
|
|
|
|
// Check notifications are as expected
|
|
req := NewRequest(t, "GET", fmt.Sprintf("/api/v1/notifications?all=true&token=%s", token))
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
var apiNL []api.NotificationThread
|
|
DecodeJSON(t, resp, &apiNL)
|
|
|
|
assert.Len(t, apiNL, 4)
|
|
assert.EqualValues(t, 5, apiNL[0].ID)
|
|
assert.True(t, apiNL[0].Unread)
|
|
assert.False(t, apiNL[0].Pinned)
|
|
assert.EqualValues(t, 4, apiNL[1].ID)
|
|
assert.True(t, apiNL[1].Unread)
|
|
assert.False(t, apiNL[1].Pinned)
|
|
assert.EqualValues(t, 3, apiNL[2].ID)
|
|
assert.False(t, apiNL[2].Unread)
|
|
assert.True(t, apiNL[2].Pinned)
|
|
assert.EqualValues(t, 2, apiNL[3].ID)
|
|
assert.False(t, apiNL[3].Unread)
|
|
assert.False(t, apiNL[3].Pinned)
|
|
|
|
//
|
|
// Notification ID 2 is the only one with status-type read & pinned
|
|
// change it to unread.
|
|
//
|
|
req = NewRequest(t, "PUT", fmt.Sprintf("/api/v1/notifications?status-types=read&status-type=pinned&to-status=unread&token=%s", token))
|
|
resp = MakeRequest(t, req, http.StatusResetContent)
|
|
DecodeJSON(t, resp, &apiNL)
|
|
assert.Len(t, apiNL, 1)
|
|
assert.EqualValues(t, 2, apiNL[0].ID)
|
|
assert.True(t, apiNL[0].Unread)
|
|
assert.False(t, apiNL[0].Pinned)
|
|
|
|
//
|
|
// Now nofication ID 2 is the first in the list and is unread.
|
|
//
|
|
req = NewRequest(t, "GET", fmt.Sprintf("/api/v1/notifications?all=true&token=%s", token))
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
DecodeJSON(t, resp, &apiNL)
|
|
|
|
assert.Len(t, apiNL, 4)
|
|
assert.EqualValues(t, 2, apiNL[0].ID)
|
|
assert.True(t, apiNL[0].Unread)
|
|
assert.False(t, apiNL[0].Pinned)
|
|
}
|