2018-11-15 04:00:04 +03:00
// Copyright 2018 The Gogs Authors. All rights reserved.
2022-11-27 21:20:29 +03:00
// SPDX-License-Identifier: MIT
2018-11-15 04:00:04 +03:00
2021-01-26 18:36:53 +03:00
package forms
2018-11-15 04:00:04 +03:00
import (
2023-01-18 00:46:03 +03:00
"strconv"
2018-11-15 04:00:04 +03:00
"testing"
2023-01-18 00:46:03 +03:00
auth_model "code.gitea.io/gitea/models/auth"
2018-11-15 04:00:04 +03:00
"code.gitea.io/gitea/modules/setting"
2023-05-22 03:05:44 +03:00
"github.com/gobwas/glob"
2018-11-15 04:00:04 +03:00
"github.com/stretchr/testify/assert"
)
2021-02-15 02:31:29 +03:00
func TestRegisterForm_IsDomainAllowed_Empty ( t * testing . T ) {
2023-05-22 03:05:44 +03:00
oldService := setting . Service
defer func ( ) {
setting . Service = oldService
} ( )
2018-11-15 04:00:04 +03:00
2023-05-22 03:05:44 +03:00
setting . Service . EmailDomainAllowList = nil
2018-11-15 04:00:04 +03:00
form := RegisterForm { }
2021-02-15 02:31:29 +03:00
assert . True ( t , form . IsEmailDomainAllowed ( ) )
2018-11-15 04:00:04 +03:00
}
2021-02-15 02:31:29 +03:00
func TestRegisterForm_IsDomainAllowed_InvalidEmail ( t * testing . T ) {
2023-05-22 03:05:44 +03:00
oldService := setting . Service
defer func ( ) {
setting . Service = oldService
} ( )
2018-11-15 04:00:04 +03:00
2023-05-22 03:05:44 +03:00
setting . Service . EmailDomainAllowList = [ ] glob . Glob { glob . MustCompile ( "gitea.io" ) }
2018-11-15 04:00:04 +03:00
tt := [ ] struct {
email string
} {
2023-05-22 03:05:44 +03:00
{ "invalid-email" } ,
{ "gitea.io" } ,
2018-11-15 04:00:04 +03:00
}
for _ , v := range tt {
form := RegisterForm { Email : v . email }
2021-02-15 02:31:29 +03:00
assert . False ( t , form . IsEmailDomainAllowed ( ) )
2018-11-15 04:00:04 +03:00
}
}
2023-05-22 03:05:44 +03:00
func TestRegisterForm_IsDomainAllowed_AllowedEmail ( t * testing . T ) {
oldService := setting . Service
defer func ( ) {
setting . Service = oldService
} ( )
2018-11-15 04:00:04 +03:00
2023-05-22 03:05:44 +03:00
setting . Service . EmailDomainAllowList = [ ] glob . Glob { glob . MustCompile ( "gitea.io" ) , glob . MustCompile ( "*.allow" ) }
2018-11-15 04:00:04 +03:00
tt := [ ] struct {
email string
valid bool
} {
{ "security@gitea.io" , true } ,
{ "security@gITea.io" , true } ,
2023-05-22 03:05:44 +03:00
{ "invalid" , false } ,
2018-11-15 04:00:04 +03:00
{ "seee@example.com" , false } ,
2023-05-22 03:05:44 +03:00
{ "user@my.allow" , true } ,
{ "user@my.allow1" , false } ,
2018-11-15 04:00:04 +03:00
}
for _ , v := range tt {
form := RegisterForm { Email : v . email }
2021-02-15 02:31:29 +03:00
assert . Equal ( t , v . valid , form . IsEmailDomainAllowed ( ) )
}
}
2023-05-22 03:05:44 +03:00
func TestRegisterForm_IsDomainAllowed_BlockedEmail ( t * testing . T ) {
oldService := setting . Service
defer func ( ) {
setting . Service = oldService
} ( )
2021-02-15 02:31:29 +03:00
2023-05-22 03:05:44 +03:00
setting . Service . EmailDomainAllowList = nil
setting . Service . EmailDomainBlockList = [ ] glob . Glob { glob . MustCompile ( "gitea.io" ) , glob . MustCompile ( "*.block" ) }
2021-02-15 02:31:29 +03:00
tt := [ ] struct {
email string
valid bool
} {
{ "security@gitea.io" , false } ,
{ "security@gitea.example" , true } ,
2023-05-22 03:05:44 +03:00
{ "invalid" , true } ,
{ "user@my.block" , false } ,
{ "user@my.block1" , true } ,
2021-02-15 02:31:29 +03:00
}
for _ , v := range tt {
form := RegisterForm { Email : v . email }
assert . Equal ( t , v . valid , form . IsEmailDomainAllowed ( ) )
2018-11-15 04:00:04 +03:00
}
}
2023-01-18 00:46:03 +03:00
func TestNewAccessTokenForm_GetScope ( t * testing . T ) {
tests := [ ] struct {
form NewAccessTokenForm
scope auth_model . AccessTokenScope
expectedErr error
} {
{
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 21:57:16 +03:00
form : NewAccessTokenForm { Name : "test" , Scope : [ ] string { "read:repository" } } ,
scope : "read:repository" ,
2023-01-18 00:46:03 +03: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 21:57:16 +03:00
form : NewAccessTokenForm { Name : "test" , Scope : [ ] string { "read:repository" , "write:user" } } ,
scope : "read:repository,write:user" ,
2023-01-18 00:46:03 +03:00
} ,
}
for i , test := range tests {
t . Run ( strconv . Itoa ( i ) , func ( t * testing . T ) {
scope , err := test . form . GetScope ( )
assert . Equal ( t , test . expectedErr , err )
assert . Equal ( t , test . scope , scope )
} )
}
}