2017-12-06 05:27:10 -05:00
// Copyright 2017 The Gitea Authors. All rights reserved.
2022-11-27 13:20:29 -05:00
// SPDX-License-Identifier: MIT
2017-12-06 05:27:10 -05:00
2022-09-02 15:18:23 -04:00
package integration
2017-12-06 05:27:10 -05:00
import (
"fmt"
"net/http"
"testing"
2023-10-11 03:28:16 -04:00
"time"
2017-12-06 05:27:10 -05:00
2025-03-27 15:40:14 -04:00
asymkey_model "forgejo.org/models/asymkey"
auth_model "forgejo.org/models/auth"
"forgejo.org/models/unittest"
user_model "forgejo.org/models/user"
"forgejo.org/modules/json"
"forgejo.org/modules/setting"
api "forgejo.org/modules/structs"
"forgejo.org/tests"
2018-09-12 22:33:48 -04:00
2024-03-05 00:55:47 -05:00
"github.com/gobwas/glob"
2018-09-12 22:33:48 -04:00
"github.com/stretchr/testify/assert"
2017-12-06 05:27:10 -05:00
)
func TestAPIAdminCreateAndDeleteSSHKey ( t * testing . T ) {
2022-09-02 15:18:23 -04:00
defer tests . PrepareTestEnv ( t ) ( )
2017-12-06 05:27:10 -05:00
// user1 is an admin user
session := loginUser ( t , "user1" )
2022-08-15 22:22:25 -04:00
keyOwner := unittest . AssertExistsAndLoadBean ( t , & user_model . User { Name : "user2" } )
2017-12-06 05:27:10 -05:00
Redesign Scoped Access Tokens (#24767)
## 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>
2023-06-04 14:57:16 -04:00
token := getTokenForLoggedInUser ( t , session , auth_model . AccessTokenScopeWriteAdmin )
2023-12-21 18:59:59 -05:00
urlStr := fmt . Sprintf ( "/api/v1/admin/users/%s/keys" , keyOwner . Name )
2017-12-06 05:27:10 -05:00
req := NewRequestWithValues ( t , "POST" , urlStr , map [ string ] string {
2020-10-09 02:52:57 -04:00
"key" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQC4cn+iXnA4KvcQYSV88vGn0Yi91vG47t1P7okprVmhNTkipNRIHWr6WdCO4VDr/cvsRkuVJAsLO2enwjGWWueOO6BodiBgyAOZ/5t5nJNMCNuLGT5UIo/RI1b0WRQwxEZTRjt6mFNw6lH14wRd8ulsr9toSWBPMOGWoYs1PDeDL0JuTjL+tr1SZi/EyxCngpYszKdXllJEHyI79KQgeD0Vt3pTrkbNVTOEcCNqZePSVmUH8X8Vhugz3bnE0/iE9Pb5fkWO9c4AnM1FgI/8Bvp27Fw2ShryIXuR6kKvUqhVMTuOSDHwu6A8jLE5Owt3GAYugDpDYuwTVNGrHLXKpPzrGGPE/jPmaLCMZcsdkec95dYeU3zKODEm8UQZFhmJmDeWVJ36nGrGZHL4J5aTTaeFUJmmXDaJYiJ+K2/ioKgXqnXvltu0A9R8/LGy4nrTJRr4JMLuJFoUXvGm1gXQ70w2LSpk6yl71RNC0hCtsBe8BP8IhYCM0EP5jh7eCMQZNvM= nocomment\n" ,
2017-12-06 05:27:10 -05:00
"title" : "test-key" ,
2023-12-21 18:59:59 -05:00
} ) . AddTokenAuth ( token )
2022-12-01 22:39:42 -05:00
resp := MakeRequest ( t , req , http . StatusCreated )
2017-12-06 05:27:10 -05:00
var newPublicKey api . PublicKey
DecodeJSON ( t , resp , & newPublicKey )
2021-12-10 03:14:24 -05:00
unittest . AssertExistsAndLoadBean ( t , & asymkey_model . PublicKey {
2017-12-06 05:27:10 -05:00
ID : newPublicKey . ID ,
Name : newPublicKey . Title ,
Fingerprint : newPublicKey . Fingerprint ,
OwnerID : keyOwner . ID ,
} )
2023-12-21 18:59:59 -05:00
req = NewRequestf ( t , "DELETE" , "/api/v1/admin/users/%s/keys/%d" , keyOwner . Name , newPublicKey . ID ) .
AddTokenAuth ( token )
2022-12-01 22:39:42 -05:00
MakeRequest ( t , req , http . StatusNoContent )
2021-12-10 03:14:24 -05:00
unittest . AssertNotExistsBean ( t , & asymkey_model . PublicKey { ID : newPublicKey . ID } )
2017-12-06 05:27:10 -05:00
}
func TestAPIAdminDeleteMissingSSHKey ( t * testing . T ) {
2022-09-02 15:18:23 -04:00
defer tests . PrepareTestEnv ( t ) ( )
2017-12-06 05:27:10 -05:00
2022-12-01 22:39:42 -05:00
// user1 is an admin user
Redesign Scoped Access Tokens (#24767)
## 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>
2023-06-04 14:57:16 -04:00
token := getUserToken ( t , "user1" , auth_model . AccessTokenScopeWriteAdmin )
2023-12-21 18:59:59 -05:00
req := NewRequestf ( t , "DELETE" , "/api/v1/admin/users/user1/keys/%d" , unittest . NonexistentID ) .
AddTokenAuth ( token )
2022-12-01 22:39:42 -05:00
MakeRequest ( t , req , http . StatusNotFound )
2017-12-06 05:27:10 -05:00
}
func TestAPIAdminDeleteUnauthorizedKey ( t * testing . T ) {
2022-09-02 15:18:23 -04:00
defer tests . PrepareTestEnv ( t ) ( )
2017-12-06 05:27:10 -05:00
adminUsername := "user1"
normalUsername := "user2"
Redesign Scoped Access Tokens (#24767)
## 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>
2023-06-04 14:57:16 -04:00
token := getUserToken ( t , adminUsername , auth_model . AccessTokenScopeWriteAdmin )
2017-12-06 05:27:10 -05:00
2023-12-21 18:59:59 -05:00
urlStr := fmt . Sprintf ( "/api/v1/admin/users/%s/keys" , adminUsername )
2017-12-06 05:27:10 -05:00
req := NewRequestWithValues ( t , "POST" , urlStr , map [ string ] string {
2020-10-09 02:52:57 -04:00
"key" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQC4cn+iXnA4KvcQYSV88vGn0Yi91vG47t1P7okprVmhNTkipNRIHWr6WdCO4VDr/cvsRkuVJAsLO2enwjGWWueOO6BodiBgyAOZ/5t5nJNMCNuLGT5UIo/RI1b0WRQwxEZTRjt6mFNw6lH14wRd8ulsr9toSWBPMOGWoYs1PDeDL0JuTjL+tr1SZi/EyxCngpYszKdXllJEHyI79KQgeD0Vt3pTrkbNVTOEcCNqZePSVmUH8X8Vhugz3bnE0/iE9Pb5fkWO9c4AnM1FgI/8Bvp27Fw2ShryIXuR6kKvUqhVMTuOSDHwu6A8jLE5Owt3GAYugDpDYuwTVNGrHLXKpPzrGGPE/jPmaLCMZcsdkec95dYeU3zKODEm8UQZFhmJmDeWVJ36nGrGZHL4J5aTTaeFUJmmXDaJYiJ+K2/ioKgXqnXvltu0A9R8/LGy4nrTJRr4JMLuJFoUXvGm1gXQ70w2LSpk6yl71RNC0hCtsBe8BP8IhYCM0EP5jh7eCMQZNvM= nocomment\n" ,
2017-12-06 05:27:10 -05:00
"title" : "test-key" ,
2023-12-21 18:59:59 -05:00
} ) . AddTokenAuth ( token )
2022-12-01 22:39:42 -05:00
resp := MakeRequest ( t , req , http . StatusCreated )
2017-12-06 05:27:10 -05:00
var newPublicKey api . PublicKey
DecodeJSON ( t , resp , & newPublicKey )
2026-03-18 17:33:14 -04:00
token = getUserToken ( t , normalUsername , auth_model . AccessTokenScopeWriteAdmin )
2023-12-21 18:59:59 -05:00
req = NewRequestf ( t , "DELETE" , "/api/v1/admin/users/%s/keys/%d" , adminUsername , newPublicKey . ID ) .
AddTokenAuth ( token )
2022-12-01 22:39:42 -05:00
MakeRequest ( t , req , http . StatusForbidden )
2017-12-06 05:27:10 -05:00
}
2018-09-06 23:31:29 -04:00
func TestAPISudoUser ( t * testing . T ) {
2022-09-02 15:18:23 -04:00
defer tests . PrepareTestEnv ( t ) ( )
2018-09-06 23:31:29 -04:00
adminUsername := "user1"
normalUsername := "user2"
Redesign Scoped Access Tokens (#24767)
## 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>
2023-06-04 14:57:16 -04:00
token := getUserToken ( t , adminUsername , auth_model . AccessTokenScopeReadUser )
2018-09-06 23:31:29 -04:00
2023-12-21 18:59:59 -05:00
req := NewRequest ( t , "GET" , fmt . Sprintf ( "/api/v1/user?sudo=%s" , normalUsername ) ) .
AddTokenAuth ( token )
2022-12-01 22:39:42 -05:00
resp := MakeRequest ( t , req , http . StatusOK )
2018-09-06 23:31:29 -04:00
var user api . User
DecodeJSON ( t , resp , & user )
assert . Equal ( t , normalUsername , user . UserName )
}
feat: remove admin-level permissions from repo-specific & public-only access tokens (#11468)
This PR is part of a series (#11311).
If the user authenticating to an API call is a Forgejo site administrator, or a Forgejo repo administrator, a wide variety of permission and ownership checks in the API are either bypassed, or are bypassable. If a user has created an access token with restricted resources, I understand the intent of the user is to create a token which has a layer of risk reduction in the event that the token is lost/leaked to an attacker. For this reason, it makes sense to me that restricted scope access tokens shouldn't inherit the owner's administrator access.
My intent is that repo-specific access tokens [will only be able to access specific authorization scopes](https://codeberg.org/forgejo/design/issues/50#issuecomment-11093951), probably: `repository:read`, `repository:write`, `issue:read`, `issue:write`, (`organization:read` / `user:read` maybe). This means that *most* admin access is not intended to be affected by this because repo-specific access tokens won't have, for example, `admin:write` scope. However, administrative access still grants elevated permissions in some areas that are relevant to these scopes, and need to be restricted:
- The `?sudo=otheruser` query parameter allows site administrators to impersonate other users in the API.
- Repository management rules are different for a site administrator, allowing them to create repos for another user, create repos in another organization, migrate a repository to an arbitrary owner, and transfer a repository to a prviate organization.
- Administrators have access to extra data through some APIs which would be in scope: the detailed configuration of branch protection rules, the some details of repository deploy keys (which repo, and which scope -- seems odd), (user:read -- user SSH keys, activity feeds of private users, user profiles of private users, user webhook configurations).
- Pull request reviews have additional perms for repo administrators, including the ability to dismiss PR reviews, delete PR reviews, and view draft PR reviews.
- Repo admins and site admins can comment on locked issues, and related to comments can edit or delete other user's comments and attachments.
- Repo admins can manage and view logged time on behalf of other users.
A handful of these permissions may make sense for repo-specific access tokens, but most of them clearly exceed the risk that would be expected from creating a limited scope access token. I'd generally prefer to take a restrictive approach, and we can relax it if real-world use-cases come in -- users will have a workaround of creating an access token without repo-specific restrictions if they are blocked from needed access.
**Breaking:** The administration restrictions introduced in this PR affect both repo-specific access tokens, and existing public-only access tokens.
## Checklist
The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. There also are a few [conditions for merging Pull Requests in Forgejo repositories](https://codeberg.org/forgejo/governance/src/branch/main/PullRequestsAgreement.md). You are also welcome to join the [Forgejo development chatroom](https://matrix.to/#/#forgejo-development:matrix.org).
### Tests for Go changes
(can be removed for JavaScript changes)
- I added test coverage for Go changes...
- [x] in their respective `*_test.go` for unit tests.
- [x] in the `tests/integration` directory if it involves interactions with a live Forgejo server.
- I ran...
- [x] `make pr-go` before pushing
### Documentation
- [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change.
- [x] I did not document these changes and I do not expect someone else to do it.
### Release notes
- [x] This change will be noticed by a Forgejo user or admin (feature, bug fix, performance, etc.). I suggest to include a release note for this change.
- Although repo-specific access tokens are not yet exposed to end users, the breaking changes to public-only tokens will be visible to users and require release notes.
- [ ] This change is not visible to a Forgejo user or admin (refactor, dependency upgrade, etc.). I think there is no need to add a release note for this change.
Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/11468
Reviewed-by: Andreas Ahlenstorf <aahlenst@noreply.codeberg.org>
Co-authored-by: Mathieu Fenniak <mathieu@fenniak.net>
Co-committed-by: Mathieu Fenniak <mathieu@fenniak.net>
2026-03-04 10:17:41 -05:00
// Variation of TestAPISudoUser which verifies the usability of `sudo` with various access token restrictions.
func TestAPISudoUserAuthorizationReducer ( t * testing . T ) {
defer tests . PrepareTestEnv ( t ) ( )
adminUsername := "user1"
normalUsername := "user2"
session := loginUser ( t , adminUsername )
test := func ( t * testing . T , token string , expectedStatus int ) {
req := NewRequest ( t , "GET" , fmt . Sprintf ( "/api/v1/user?sudo=%s" , normalUsername ) ) .
AddTokenAuth ( token )
resp := MakeRequest ( t , req , expectedStatus )
if expectedStatus == http . StatusOK {
var user api . User
DecodeJSON ( t , resp , & user )
assert . Equal ( t , normalUsername , user . UserName )
}
}
t . Run ( "all access token" , func ( t * testing . T ) {
allToken := getTokenForLoggedInUser ( t , session , auth_model . AccessTokenScopeReadUser )
test ( t , allToken , http . StatusOK )
} )
t . Run ( "public-only access token" , func ( t * testing . T ) {
publicOnlyToken := getTokenForLoggedInUser ( t , session , auth_model . AccessTokenScopePublicOnly , auth_model . AccessTokenScopeReadUser )
test ( t , publicOnlyToken , http . StatusForbidden )
} )
t . Run ( "specific repo access token" , func ( t * testing . T ) {
repo2OnlyToken := createFineGrainedRepoAccessToken ( t , adminUsername ,
[ ] auth_model . AccessTokenScope { auth_model . AccessTokenScopeReadUser } ,
[ ] int64 { 2 } ,
)
test ( t , repo2OnlyToken , http . StatusForbidden )
} )
}
2018-09-06 23:31:29 -04:00
func TestAPISudoUserForbidden ( t * testing . T ) {
2022-09-02 15:18:23 -04:00
defer tests . PrepareTestEnv ( t ) ( )
2018-09-06 23:31:29 -04:00
adminUsername := "user1"
normalUsername := "user2"
Redesign Scoped Access Tokens (#24767)
## 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>
2023-06-04 14:57:16 -04:00
token := getUserToken ( t , normalUsername , auth_model . AccessTokenScopeReadAdmin )
2023-12-21 18:59:59 -05:00
req := NewRequest ( t , "GET" , fmt . Sprintf ( "/api/v1/user?sudo=%s" , adminUsername ) ) .
AddTokenAuth ( token )
2022-12-01 22:39:42 -05:00
MakeRequest ( t , req , http . StatusForbidden )
2018-09-06 23:31:29 -04:00
}
2019-04-15 12:36:59 -04:00
func TestAPIListUsers ( t * testing . T ) {
2022-09-02 15:18:23 -04:00
defer tests . PrepareTestEnv ( t ) ( )
2019-04-15 12:36:59 -04:00
adminUsername := "user1"
Redesign Scoped Access Tokens (#24767)
## 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>
2023-06-04 14:57:16 -04:00
token := getUserToken ( t , adminUsername , auth_model . AccessTokenScopeReadAdmin )
2019-04-15 12:36:59 -04:00
2023-12-21 18:59:59 -05:00
req := NewRequest ( t , "GET" , "/api/v1/admin/users" ) .
AddTokenAuth ( token )
2022-12-01 22:39:42 -05:00
resp := MakeRequest ( t , req , http . StatusOK )
2019-04-15 12:36:59 -04:00
var users [ ] api . User
DecodeJSON ( t , resp , & users )
found := false
for _ , user := range users {
if user . UserName == adminUsername {
found = true
}
}
assert . True ( t , found )
2025-09-29 09:35:40 -04:00
numberOfUsers := unittest . GetCount ( t , & user_model . User { } , "type = 0" ) +
unittest . GetCount ( t , & user_model . User { } , "type = 5" )
2023-04-22 17:56:27 -04:00
assert . Len ( t , users , numberOfUsers )
2019-04-15 12:36:59 -04:00
}
2019-05-08 15:17:32 -04:00
func TestAPIListUsersNotLoggedIn ( t * testing . T ) {
2022-09-02 15:18:23 -04:00
defer tests . PrepareTestEnv ( t ) ( )
2019-05-08 15:17:32 -04:00
req := NewRequest ( t , "GET" , "/api/v1/admin/users" )
MakeRequest ( t , req , http . StatusUnauthorized )
}
func TestAPIListUsersNonAdmin ( t * testing . T ) {
2022-09-02 15:18:23 -04:00
defer tests . PrepareTestEnv ( t ) ( )
2019-05-08 15:17:32 -04:00
nonAdminUsername := "user2"
2026-03-18 17:33:14 -04:00
token := getUserToken ( t , nonAdminUsername , auth_model . AccessTokenScopeReadAdmin )
2023-12-21 18:59:59 -05:00
req := NewRequest ( t , "GET" , "/api/v1/admin/users" ) .
AddTokenAuth ( token )
2022-12-01 22:39:42 -05:00
MakeRequest ( t , req , http . StatusForbidden )
2019-05-08 15:17:32 -04:00
}
2020-11-14 11:53:43 -05:00
func TestAPICreateUserInvalidEmail ( t * testing . T ) {
2022-09-02 15:18:23 -04:00
defer tests . PrepareTestEnv ( t ) ( )
2020-11-14 11:53:43 -05:00
adminUsername := "user1"
Redesign Scoped Access Tokens (#24767)
## 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>
2023-06-04 14:57:16 -04:00
token := getUserToken ( t , adminUsername , auth_model . AccessTokenScopeWriteAdmin )
2023-12-21 18:59:59 -05:00
req := NewRequestWithValues ( t , "POST" , "/api/v1/admin/users" , map [ string ] string {
2020-11-14 11:53:43 -05:00
"email" : "invalid_email@domain.com\r\n" ,
"full_name" : "invalid user" ,
"login_name" : "invalidUser" ,
"must_change_password" : "true" ,
"password" : "password" ,
"send_notify" : "true" ,
"source_id" : "0" ,
"username" : "invalidUser" ,
2023-12-21 18:59:59 -05:00
} ) . AddTokenAuth ( token )
2022-12-01 22:39:42 -05:00
MakeRequest ( t , req , http . StatusUnprocessableEntity )
2020-11-14 11:53:43 -05:00
}
2020-11-19 20:56:42 -05:00
2022-10-17 12:23:27 -04:00
func TestAPICreateAndDeleteUser ( t * testing . T ) {
defer tests . PrepareTestEnv ( t ) ( )
adminUsername := "user1"
Redesign Scoped Access Tokens (#24767)
## 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>
2023-06-04 14:57:16 -04:00
token := getUserToken ( t , adminUsername , auth_model . AccessTokenScopeWriteAdmin )
2022-10-17 12:23:27 -04:00
req := NewRequestWithValues (
t ,
"POST" ,
2023-12-21 18:59:59 -05:00
"/api/v1/admin/users" ,
2022-10-17 12:23:27 -04:00
map [ string ] string {
"email" : "deleteme@domain.com" ,
"full_name" : "delete me" ,
"login_name" : "deleteme" ,
"must_change_password" : "true" ,
"password" : "password" ,
"send_notify" : "true" ,
"source_id" : "0" ,
"username" : "deleteme" ,
} ,
2023-12-21 18:59:59 -05:00
) . AddTokenAuth ( token )
2022-10-17 12:23:27 -04:00
MakeRequest ( t , req , http . StatusCreated )
2023-12-21 18:59:59 -05:00
req = NewRequest ( t , "DELETE" , "/api/v1/admin/users/deleteme" ) .
AddTokenAuth ( token )
2022-10-17 12:23:27 -04:00
MakeRequest ( t , req , http . StatusNoContent )
}
2020-11-19 20:56:42 -05:00
func TestAPIEditUser ( t * testing . T ) {
2022-09-02 15:18:23 -04:00
defer tests . PrepareTestEnv ( t ) ( )
2020-11-19 20:56:42 -05:00
adminUsername := "user1"
Redesign Scoped Access Tokens (#24767)
## 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>
2023-06-04 14:57:16 -04:00
token := getUserToken ( t , adminUsername , auth_model . AccessTokenScopeWriteAdmin )
2023-12-21 18:59:59 -05:00
urlStr := fmt . Sprintf ( "/api/v1/admin/users/%s" , "user2" )
2020-11-19 20:56:42 -05:00
2024-05-04 22:10:20 -04:00
fullNameToChange := "Full Name User 2"
2020-11-19 20:56:42 -05:00
req := NewRequestWithValues ( t , "PATCH" , urlStr , map [ string ] string {
2024-05-04 22:10:20 -04:00
"full_name" : fullNameToChange ,
2023-12-21 18:59:59 -05:00
} ) . AddTokenAuth ( token )
2022-12-01 22:39:42 -05:00
MakeRequest ( t , req , http . StatusOK )
2024-05-04 22:10:20 -04:00
user2 := unittest . AssertExistsAndLoadBean ( t , & user_model . User { LoginName : "user2" } )
assert . Equal ( t , fullNameToChange , user2 . FullName )
2020-11-19 20:56:42 -05:00
empty := ""
req = NewRequestWithJSON ( t , "PATCH" , urlStr , api . EditUserOption {
2024-04-16 19:25:20 -04:00
Email : & empty ,
2023-12-21 18:59:59 -05:00
} ) . AddTokenAuth ( token )
2024-02-04 08:29:09 -05:00
resp := MakeRequest ( t , req , http . StatusBadRequest )
2020-11-19 20:56:42 -05:00
2023-07-04 14:36:08 -04:00
errMap := make ( map [ string ] any )
2020-11-19 20:56:42 -05:00
json . Unmarshal ( resp . Body . Bytes ( ) , & errMap )
2025-03-28 18:22:21 -04:00
assert . Equal ( t , "e-mail invalid [email: ]" , errMap [ "message" ] . ( string ) )
2021-02-18 03:25:35 -05:00
2024-05-04 22:10:20 -04:00
user2 = unittest . AssertExistsAndLoadBean ( t , & user_model . User { LoginName : "user2" } )
2021-06-07 01:27:09 -04:00
assert . False ( t , user2 . IsRestricted )
2021-02-18 03:25:35 -05:00
bTrue := true
req = NewRequestWithJSON ( t , "PATCH" , urlStr , api . EditUserOption {
Restricted : & bTrue ,
2023-12-21 18:59:59 -05:00
} ) . AddTokenAuth ( token )
2022-12-01 22:39:42 -05:00
MakeRequest ( t , req , http . StatusOK )
2022-08-15 22:22:25 -04:00
user2 = unittest . AssertExistsAndLoadBean ( t , & user_model . User { LoginName : "user2" } )
2021-06-07 01:27:09 -04:00
assert . True ( t , user2 . IsRestricted )
2025-10-14 21:21:15 -04:00
// Test hide_email functionality
user2 = unittest . AssertExistsAndLoadBean ( t , & user_model . User { LoginName : "user2" } )
assert . True ( t , user2 . KeepEmailPrivate ) // user2 starts with keep_email_private: true in fixtures
// Test setting hide_email to false
bFalse := false
req = NewRequestWithJSON ( t , "PATCH" , urlStr , api . EditUserOption {
HideEmail : & bFalse ,
} ) . AddTokenAuth ( token )
MakeRequest ( t , req , http . StatusOK )
user2 = unittest . AssertExistsAndLoadBean ( t , & user_model . User { LoginName : "user2" } )
assert . False ( t , user2 . KeepEmailPrivate )
// Test setting hide_email back to true
bTrue = true
req = NewRequestWithJSON ( t , "PATCH" , urlStr , api . EditUserOption {
HideEmail : & bTrue ,
} ) . AddTokenAuth ( token )
MakeRequest ( t , req , http . StatusOK )
user2 = unittest . AssertExistsAndLoadBean ( t , & user_model . User { LoginName : "user2" } )
assert . True ( t , user2 . KeepEmailPrivate )
2020-11-19 20:56:42 -05:00
}
2022-10-17 12:23:27 -04:00
2024-04-16 19:25:20 -04:00
func TestAPIEditUserWithLoginName ( t * testing . T ) {
defer tests . PrepareTestEnv ( t ) ( )
adminUsername := "user1"
token := getUserToken ( t , adminUsername , auth_model . AccessTokenScopeWriteAdmin )
urlStr := fmt . Sprintf ( "/api/v1/admin/users/%s" , "user2" )
loginName := "user2"
loginSource := int64 ( 0 )
t . Run ( "login_name only" , func ( t * testing . T ) {
defer tests . PrintCurrentTest ( t ) ( )
req := NewRequestWithJSON ( t , "PATCH" , urlStr , api . EditUserOption {
LoginName : & loginName ,
} ) . AddTokenAuth ( token )
MakeRequest ( t , req , http . StatusUnprocessableEntity )
} )
t . Run ( "source_id only" , func ( t * testing . T ) {
defer tests . PrintCurrentTest ( t ) ( )
req := NewRequestWithJSON ( t , "PATCH" , urlStr , api . EditUserOption {
SourceID : & loginSource ,
} ) . AddTokenAuth ( token )
MakeRequest ( t , req , http . StatusUnprocessableEntity )
} )
t . Run ( "login_name & source_id" , func ( t * testing . T ) {
defer tests . PrintCurrentTest ( t ) ( )
req := NewRequestWithJSON ( t , "PATCH" , urlStr , api . EditUserOption {
LoginName : & loginName ,
SourceID : & loginSource ,
} ) . AddTokenAuth ( token )
MakeRequest ( t , req , http . StatusOK )
} )
}
2022-10-17 12:23:27 -04:00
func TestAPICreateRepoForUser ( t * testing . T ) {
defer tests . PrepareTestEnv ( t ) ( )
adminUsername := "user1"
Redesign Scoped Access Tokens (#24767)
## 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>
2023-06-04 14:57:16 -04:00
token := getUserToken ( t , adminUsername , auth_model . AccessTokenScopeWriteAdmin )
2022-10-17 12:23:27 -04:00
req := NewRequestWithJSON (
t ,
"POST" ,
2023-12-21 18:59:59 -05:00
fmt . Sprintf ( "/api/v1/admin/users/%s/repos" , adminUsername ) ,
2022-10-17 12:23:27 -04:00
& api . CreateRepoOption {
Name : "admincreatedrepo" ,
} ,
2023-12-21 18:59:59 -05:00
) . AddTokenAuth ( token )
2022-10-17 12:23:27 -04:00
MakeRequest ( t , req , http . StatusCreated )
}
2023-05-21 11:13:47 -04:00
func TestAPIRenameUser ( t * testing . T ) {
defer tests . PrepareTestEnv ( t ) ( )
adminUsername := "user1"
Redesign Scoped Access Tokens (#24767)
## 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>
2023-06-04 14:57:16 -04:00
token := getUserToken ( t , adminUsername , auth_model . AccessTokenScopeWriteAdmin )
2023-12-21 18:59:59 -05:00
urlStr := fmt . Sprintf ( "/api/v1/admin/users/%s/rename" , "user2" )
2023-05-21 11:13:47 -04:00
req := NewRequestWithValues ( t , "POST" , urlStr , map [ string ] string {
// required
"new_name" : "User2" ,
2023-12-21 18:59:59 -05:00
} ) . AddTokenAuth ( token )
2024-02-04 08:29:09 -05:00
MakeRequest ( t , req , http . StatusNoContent )
2023-05-21 11:13:47 -04:00
2023-12-21 18:59:59 -05:00
urlStr = fmt . Sprintf ( "/api/v1/admin/users/%s/rename" , "User2" )
2023-05-21 11:13:47 -04:00
req = NewRequestWithValues ( t , "POST" , urlStr , map [ string ] string {
// required
"new_name" : "User2-2-2" ,
2023-12-21 18:59:59 -05:00
} ) . AddTokenAuth ( token )
2024-02-04 08:29:09 -05:00
MakeRequest ( t , req , http . StatusNoContent )
2023-05-21 11:13:47 -04:00
req = NewRequestWithValues ( t , "POST" , urlStr , map [ string ] string {
// required
"new_name" : "user1" ,
2023-12-21 18:59:59 -05:00
} ) . AddTokenAuth ( token )
2023-05-21 11:13:47 -04:00
// the old user name still be used by with a redirect
MakeRequest ( t , req , http . StatusTemporaryRedirect )
2023-12-21 18:59:59 -05:00
urlStr = fmt . Sprintf ( "/api/v1/admin/users/%s/rename" , "User2-2-2" )
2023-05-21 11:13:47 -04:00
req = NewRequestWithValues ( t , "POST" , urlStr , map [ string ] string {
// required
"new_name" : "user1" ,
2023-12-21 18:59:59 -05:00
} ) . AddTokenAuth ( token )
2023-05-21 11:13:47 -04:00
MakeRequest ( t , req , http . StatusUnprocessableEntity )
req = NewRequestWithValues ( t , "POST" , urlStr , map [ string ] string {
// required
"new_name" : "user2" ,
2023-12-21 18:59:59 -05:00
} ) . AddTokenAuth ( token )
2024-02-04 08:29:09 -05:00
MakeRequest ( t , req , http . StatusNoContent )
2023-05-21 11:13:47 -04:00
}
2023-10-11 03:28:16 -04:00
func TestAPICron ( t * testing . T ) {
defer tests . PrepareTestEnv ( t ) ( )
// user1 is an admin user
session := loginUser ( t , "user1" )
t . Run ( "List" , func ( t * testing . T ) {
defer tests . PrintCurrentTest ( t ) ( )
token := getTokenForLoggedInUser ( t , session , auth_model . AccessTokenScopeReadAdmin )
2023-12-21 18:59:59 -05:00
req := NewRequest ( t , "GET" , "/api/v1/admin/cron" ) .
AddTokenAuth ( token )
2023-10-11 03:28:16 -04:00
resp := MakeRequest ( t , req , http . StatusOK )
2025-11-18 12:59:01 -05:00
assert . Equal ( t , "31" , resp . Header ( ) . Get ( "X-Total-Count" ) )
2023-10-11 03:28:16 -04:00
var crons [ ] api . Cron
DecodeJSON ( t , resp , & crons )
2025-11-18 12:59:01 -05:00
assert . Len ( t , crons , 31 )
2023-10-11 03:28:16 -04:00
} )
t . Run ( "Execute" , func ( t * testing . T ) {
defer tests . PrintCurrentTest ( t ) ( )
now := time . Now ( )
token := getTokenForLoggedInUser ( t , session , auth_model . AccessTokenScopeWriteAdmin )
// Archive cleanup is harmless, because in the test environment there are none
// and is thus an NOOP operation and therefore doesn't interfere with any other
// tests.
2023-12-21 18:59:59 -05:00
req := NewRequest ( t , "POST" , "/api/v1/admin/cron/archive_cleanup" ) .
AddTokenAuth ( token )
2023-10-11 03:28:16 -04:00
MakeRequest ( t , req , http . StatusNoContent )
// Check for the latest run time for this cron, to ensure it has been run.
2023-12-21 18:59:59 -05:00
req = NewRequest ( t , "GET" , "/api/v1/admin/cron" ) .
AddTokenAuth ( token )
2023-10-11 03:28:16 -04:00
resp := MakeRequest ( t , req , http . StatusOK )
var crons [ ] api . Cron
DecodeJSON ( t , resp , & crons )
for _ , cron := range crons {
if cron . Name == "archive_cleanup" {
assert . True ( t , now . Before ( cron . Prev ) )
}
}
} )
}
2024-03-05 00:55:47 -05:00
func TestAPICreateUser_NotAllowedEmailDomain ( t * testing . T ) {
defer tests . PrepareTestEnv ( t ) ( )
setting . Service . EmailDomainAllowList = [ ] glob . Glob { glob . MustCompile ( "example.org" ) }
defer func ( ) {
setting . Service . EmailDomainAllowList = [ ] glob . Glob { }
} ( )
adminUsername := "user1"
token := getUserToken ( t , adminUsername , auth_model . AccessTokenScopeWriteAdmin )
req := NewRequestWithValues ( t , "POST" , "/api/v1/admin/users" , map [ string ] string {
"email" : "allowedUser1@example1.org" ,
"login_name" : "allowedUser1" ,
"username" : "allowedUser1" ,
"password" : "allowedUser1_pass" ,
"must_change_password" : "true" ,
} ) . AddTokenAuth ( token )
2024-03-11 02:07:36 -04:00
resp := MakeRequest ( t , req , http . StatusCreated )
assert . Equal ( t , "the domain of user email allowedUser1@example1.org conflicts with EMAIL_DOMAIN_ALLOWLIST or EMAIL_DOMAIN_BLOCKLIST" , resp . Header ( ) . Get ( "X-Gitea-Warning" ) )
2024-03-05 00:55:47 -05:00
req = NewRequest ( t , "DELETE" , "/api/v1/admin/users/allowedUser1" ) . AddTokenAuth ( token )
MakeRequest ( t , req , http . StatusNoContent )
}
2024-03-05 11:51:56 -05:00
func TestAPIEditUser_NotAllowedEmailDomain ( t * testing . T ) {
defer tests . PrepareTestEnv ( t ) ( )
setting . Service . EmailDomainAllowList = [ ] glob . Glob { glob . MustCompile ( "example.org" ) }
defer func ( ) {
setting . Service . EmailDomainAllowList = [ ] glob . Glob { }
} ( )
adminUsername := "user1"
token := getUserToken ( t , adminUsername , auth_model . AccessTokenScopeWriteAdmin )
urlStr := fmt . Sprintf ( "/api/v1/admin/users/%s" , "user2" )
newEmail := "user2@example1.com"
req := NewRequestWithJSON ( t , "PATCH" , urlStr , api . EditUserOption {
2024-04-16 19:25:20 -04:00
Email : & newEmail ,
2024-03-05 11:51:56 -05:00
} ) . AddTokenAuth ( token )
2024-03-11 02:07:36 -04:00
resp := MakeRequest ( t , req , http . StatusOK )
assert . Equal ( t , "the domain of user email user2@example1.com conflicts with EMAIL_DOMAIN_ALLOWLIST or EMAIL_DOMAIN_BLOCKLIST" , resp . Header ( ) . Get ( "X-Gitea-Warning" ) )
2024-03-05 11:51:56 -05:00
originalEmail := "user2@example.com"
req = NewRequestWithJSON ( t , "PATCH" , urlStr , api . EditUserOption {
2024-04-16 19:25:20 -04:00
Email : & originalEmail ,
2024-03-05 11:51:56 -05:00
} ) . AddTokenAuth ( token )
MakeRequest ( t , req , http . StatusOK )
}
2025-10-28 10:52:37 -04:00
func TestAPIAdminListUserEmails ( t * testing . T ) {
defer tests . PrepareTestEnv ( t ) ( )
adminUsername := "user1"
token := getUserToken ( t , adminUsername , auth_model . AccessTokenScopeWriteAdmin )
urlStr := fmt . Sprintf ( "/api/v1/admin/users/%s/emails" , "user2" )
req := NewRequest ( t , "GET" , urlStr ) . AddTokenAuth ( token )
resp := MakeRequest ( t , req , http . StatusOK )
var emails [ ] * api . Email
DecodeJSON ( t , resp , & emails )
// user2 should have at least one email (primary)
assert . GreaterOrEqual ( t , len ( emails ) , 1 )
// Check that we get the expected email structure
for _ , email := range emails {
assert . NotEmpty ( t , email . Email )
}
}
func TestAPIAdminDeleteUserEmails ( t * testing . T ) {
defer tests . PrepareTestEnv ( t ) ( )
adminUsername := "user1"
token := getUserToken ( t , adminUsername , auth_model . AccessTokenScopeWriteAdmin )
urlStr := fmt . Sprintf ( "/api/v1/admin/users/%s/emails" , "user2" )
// Test deleting a non-primary email
emailToDelete := "user2-2@example.com"
deleteReq := NewRequestWithJSON ( t , "DELETE" , urlStr , api . DeleteEmailOption {
Emails : [ ] string { emailToDelete } ,
} ) . AddTokenAuth ( token )
MakeRequest ( t , deleteReq , http . StatusNoContent )
// Verify the email was deleted by listing emails again
req := NewRequest ( t , "GET" , urlStr ) . AddTokenAuth ( token )
resp := MakeRequest ( t , req , http . StatusOK )
var remainingEmails [ ] * api . Email
DecodeJSON ( t , resp , & remainingEmails )
// The deleted email should not be in the list
for _ , email := range remainingEmails {
assert . NotEqual ( t , emailToDelete , email . Email )
}
}
func TestAPIAdminDeleteUserEmailsPrimary ( t * testing . T ) {
defer tests . PrepareTestEnv ( t ) ( )
adminUsername := "user1"
token := getUserToken ( t , adminUsername , auth_model . AccessTokenScopeWriteAdmin )
urlStr := fmt . Sprintf ( "/api/v1/admin/users/%s/emails" , "user2" )
// Test deleting the primary email - this should fail
deleteReq := NewRequestWithJSON ( t , "DELETE" , urlStr , api . DeleteEmailOption {
Emails : [ ] string { "user2@example.com" } ,
} ) . AddTokenAuth ( token )
resp := MakeRequest ( t , deleteReq , http . StatusUnprocessableEntity )
// Verify we get an error response
var errorResp map [ string ] any
DecodeJSON ( t , resp , & errorResp )
assert . Contains ( t , errorResp , "message" )
}
func TestAPIAdminDeleteUserEmailsMultiple ( t * testing . T ) {
defer tests . PrepareTestEnv ( t ) ( )
adminUsername := "user1"
token := getUserToken ( t , adminUsername , auth_model . AccessTokenScopeWriteAdmin )
urlStr := fmt . Sprintf ( "/api/v1/admin/users/%s/emails" , "user1" )
// Verify initial state: user1 should have 3 emails
req := NewRequest ( t , "GET" , urlStr ) . AddTokenAuth ( token )
resp := MakeRequest ( t , req , http . StatusOK )
var initialEmails [ ] * api . Email
DecodeJSON ( t , resp , & initialEmails )
assert . Len ( t , initialEmails , 3 )
// Test deleting multiple emails in one API call
emailsToDelete := [ ] string { "user1-2@example.com" , "user1-3@example.com" }
deleteReq := NewRequestWithJSON ( t , "DELETE" , urlStr , api . DeleteEmailOption {
Emails : emailsToDelete ,
} ) . AddTokenAuth ( token )
MakeRequest ( t , deleteReq , http . StatusNoContent )
// Verify final state: only primary email should remain
req = NewRequest ( t , "GET" , urlStr ) . AddTokenAuth ( token )
resp = MakeRequest ( t , req , http . StatusOK )
var remainingEmails [ ] * api . Email
DecodeJSON ( t , resp , & remainingEmails )
assert . Len ( t , remainingEmails , 1 , "Only 1 email should remain after deletion" )
assert . Equal ( t , "user1@example.com" , remainingEmails [ 0 ] . Email , "Only primary email should remain" )
assert . True ( t , remainingEmails [ 0 ] . Primary , "Remaining email should be primary" )
}
2025-11-05 18:08:13 -05:00
func TestAPIAdminListHooksPagination ( t * testing . T ) {
defer tests . PrepareTestEnv ( t ) ( )
token := getUserToken ( t , "user1" , auth_model . AccessTokenScopeWriteAdmin )
for i := range 20 {
req := NewRequestWithJSON ( t , "POST" , "/api/v1/admin/hooks" , api . CreateHookOption {
Config : api . CreateHookOptionConfig {
"url" : fmt . Sprintf ( "http://localhost/hook-%d" , i ) ,
"content_type" : "json" ,
"is_system_webhook" : "true" ,
} ,
Type : "forgejo" ,
} ) . AddTokenAuth ( token )
MakeRequest ( t , req , http . StatusCreated )
}
req := NewRequest ( t , "GET" , "/api/v1/admin/hooks?page=1&limit=10" ) . AddTokenAuth ( token )
resp := MakeRequest ( t , req , http . StatusOK )
var hooksList [ ] api . Hook
t . Logf ( "got response %s" , resp . Body )
DecodeJSON ( t , resp , & hooksList )
assert . Len ( t , hooksList , 10 , "page length should equal `limit` param" )
assert . Equal ( t , "20" , resp . Header ( ) . Get ( "X-Total-Count" ) )
}