2021-04-10 14:12:38 +08:00
// Copyright 2021 The Gitea Authors. All rights reserved.
2022-11-27 13:20:29 -05:00
// SPDX-License-Identifier: MIT
2021-04-10 14:12:38 +08:00
2022-09-02 15:18:23 -04:00
package integration
2021-04-10 14:12:38 +08:00
import (
"net/http"
"testing"
2023-01-17 16:46:03 -05:00
auth_model "code.gitea.io/gitea/models/auth"
2021-04-10 14:12:38 +08:00
api "code.gitea.io/gitea/modules/structs"
2022-09-02 15:18:23 -04:00
"code.gitea.io/gitea/tests"
2021-04-10 14:12:38 +08:00
"github.com/stretchr/testify/assert"
)
func TestAPIListEmails ( t * testing . T ) {
2022-09-02 15:18:23 -04:00
defer tests . PrepareTestEnv ( t ) ( )
2021-04-10 14:12:38 +08:00
normalUsername := "user2"
session := loginUser ( t , normalUsername )
2023-01-17 16:46:03 -05:00
token := getTokenForLoggedInUser ( t , session , auth_model . AccessTokenScopeReadUser )
2021-04-10 14:12:38 +08:00
req := NewRequest ( t , "GET" , "/api/v1/user/emails?token=" + token )
2022-12-02 11:39:42 +08:00
resp := MakeRequest ( t , req , http . StatusOK )
2021-04-10 14:12:38 +08:00
var emails [ ] * api . Email
DecodeJSON ( t , resp , & emails )
assert . EqualValues ( t , [ ] * api . Email {
{
Email : "user2@example.com" ,
Verified : true ,
Primary : true ,
} ,
{
2021-06-08 11:52:51 +08:00
Email : "user2-2@example.com" ,
2021-04-10 14:12:38 +08:00
Verified : false ,
Primary : false ,
} ,
} , emails )
}
func TestAPIAddEmail ( t * testing . T ) {
2022-09-02 15:18:23 -04:00
defer tests . PrepareTestEnv ( t ) ( )
2021-04-10 14:12:38 +08:00
normalUsername := "user2"
session := loginUser ( t , normalUsername )
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 . AccessTokenScopeWriteUser )
2021-04-10 14:12:38 +08:00
opts := api . CreateEmailOption {
Emails : [ ] string { "user101@example.com" } ,
}
req := NewRequestWithJSON ( t , "POST" , "/api/v1/user/emails?token=" + token , & opts )
2022-12-02 11:39:42 +08:00
MakeRequest ( t , req , http . StatusUnprocessableEntity )
2021-04-10 14:12:38 +08:00
opts = api . CreateEmailOption {
2021-06-08 11:52:51 +08:00
Emails : [ ] string { "user2-3@example.com" } ,
2021-04-10 14:12:38 +08:00
}
req = NewRequestWithJSON ( t , "POST" , "/api/v1/user/emails?token=" + token , & opts )
2022-12-02 11:39:42 +08:00
resp := MakeRequest ( t , req , http . StatusCreated )
2021-04-10 14:12:38 +08:00
var emails [ ] * api . Email
DecodeJSON ( t , resp , & emails )
assert . EqualValues ( t , [ ] * api . Email {
{
2021-06-08 11:52:51 +08:00
Email : "user2-3@example.com" ,
2021-04-10 14:12:38 +08:00
Verified : true ,
Primary : false ,
} ,
} , emails )
2022-04-20 21:39:30 +00:00
opts = api . CreateEmailOption {
Emails : [ ] string { "notAEmail" } ,
}
req = NewRequestWithJSON ( t , "POST" , "/api/v1/user/emails?token=" + token , & opts )
2022-12-02 11:39:42 +08:00
MakeRequest ( t , req , http . StatusUnprocessableEntity )
2021-04-10 14:12:38 +08:00
}
func TestAPIDeleteEmail ( t * testing . T ) {
2022-09-02 15:18:23 -04:00
defer tests . PrepareTestEnv ( t ) ( )
2021-04-10 14:12:38 +08:00
normalUsername := "user2"
session := loginUser ( t , normalUsername )
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 . AccessTokenScopeWriteUser )
2021-04-10 14:12:38 +08:00
opts := api . DeleteEmailOption {
2021-06-08 11:52:51 +08:00
Emails : [ ] string { "user2-3@example.com" } ,
2021-04-10 14:12:38 +08:00
}
req := NewRequestWithJSON ( t , "DELETE" , "/api/v1/user/emails?token=" + token , & opts )
2022-12-02 11:39:42 +08:00
MakeRequest ( t , req , http . StatusNotFound )
2021-04-10 14:12:38 +08:00
opts = api . DeleteEmailOption {
2021-06-08 11:52:51 +08:00
Emails : [ ] string { "user2-2@example.com" } ,
2021-04-10 14:12:38 +08:00
}
req = NewRequestWithJSON ( t , "DELETE" , "/api/v1/user/emails?token=" + token , & opts )
2022-12-02 11:39:42 +08:00
MakeRequest ( t , req , http . StatusNoContent )
2021-04-10 14:12:38 +08:00
req = NewRequest ( t , "GET" , "/api/v1/user/emails?token=" + token )
2022-12-02 11:39:42 +08:00
resp := MakeRequest ( t , req , http . StatusOK )
2021-04-10 14:12:38 +08:00
var emails [ ] * api . Email
DecodeJSON ( t , resp , & emails )
assert . EqualValues ( t , [ ] * api . Email {
{
Email : "user2@example.com" ,
Verified : true ,
Primary : true ,
} ,
} , emails )
}