2020-02-29 01:19:32 -05:00
|
|
|
// Copyright 2020 The Gitea Authors. All rights reserved.
|
2022-11-27 13:20:29 -05:00
|
|
|
// SPDX-License-Identifier: MIT
|
2020-02-29 01:19:32 -05:00
|
|
|
|
2022-09-02 15:18:23 -04:00
|
|
|
package integration
|
2020-02-29 01:19:32 -05:00
|
|
|
|
|
|
|
import (
|
|
|
|
"fmt"
|
|
|
|
"net/http"
|
|
|
|
"testing"
|
|
|
|
|
2023-01-17 16:46:03 -05:00
|
|
|
auth_model "code.gitea.io/gitea/models/auth"
|
2021-11-16 03:53:21 -05:00
|
|
|
"code.gitea.io/gitea/models/unittest"
|
2021-11-24 04:49:20 -05:00
|
|
|
user_model "code.gitea.io/gitea/models/user"
|
2020-02-29 01:19:32 -05:00
|
|
|
api "code.gitea.io/gitea/modules/structs"
|
2022-09-02 15:18:23 -04:00
|
|
|
"code.gitea.io/gitea/tests"
|
2020-02-29 01:19:32 -05:00
|
|
|
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
|
|
)
|
|
|
|
|
|
|
|
func TestOAuth2Application(t *testing.T) {
|
2022-09-02 15:18:23 -04:00
|
|
|
defer tests.PrepareTestEnv(t)()
|
2020-02-29 01:19:32 -05:00
|
|
|
testAPICreateOAuth2Application(t)
|
|
|
|
testAPIListOAuth2Applications(t)
|
2020-04-09 20:37:31 -04:00
|
|
|
testAPIGetOAuth2Application(t)
|
|
|
|
testAPIUpdateOAuth2Application(t)
|
2020-02-29 01:19:32 -05:00
|
|
|
testAPIDeleteOAuth2Application(t)
|
|
|
|
}
|
|
|
|
|
|
|
|
func testAPICreateOAuth2Application(t *testing.T) {
|
2022-08-15 22:22:25 -04:00
|
|
|
user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
|
2020-02-29 01:19:32 -05:00
|
|
|
appBody := api.CreateOAuth2ApplicationOptions{
|
|
|
|
Name: "test-app-1",
|
|
|
|
RedirectURIs: []string{
|
|
|
|
"http://www.google.com",
|
|
|
|
},
|
2022-10-24 03:59:24 -04:00
|
|
|
ConfidentialClient: true,
|
2020-02-29 01:19:32 -05:00
|
|
|
}
|
|
|
|
|
2023-12-21 18:59:59 -05:00
|
|
|
req := NewRequestWithJSON(t, "POST", "/api/v1/user/applications/oauth2", &appBody).
|
|
|
|
AddBasicAuth(user.Name)
|
2020-02-29 01:19:32 -05:00
|
|
|
resp := MakeRequest(t, req, http.StatusCreated)
|
|
|
|
|
|
|
|
var createdApp *api.OAuth2Application
|
|
|
|
DecodeJSON(t, resp, &createdApp)
|
|
|
|
|
|
|
|
assert.EqualValues(t, appBody.Name, createdApp.Name)
|
2022-02-04 12:03:15 -05:00
|
|
|
assert.Len(t, createdApp.ClientSecret, 56)
|
2020-02-29 01:19:32 -05:00
|
|
|
assert.Len(t, createdApp.ClientID, 36)
|
2022-10-24 03:59:24 -04:00
|
|
|
assert.True(t, createdApp.ConfidentialClient)
|
2020-02-29 01:19:32 -05:00
|
|
|
assert.NotEmpty(t, createdApp.Created)
|
|
|
|
assert.EqualValues(t, appBody.RedirectURIs[0], createdApp.RedirectURIs[0])
|
2023-01-17 16:46:03 -05:00
|
|
|
unittest.AssertExistsAndLoadBean(t, &auth_model.OAuth2Application{UID: user.ID, Name: createdApp.Name})
|
2020-02-29 01:19:32 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
func testAPIListOAuth2Applications(t *testing.T) {
|
2022-08-15 22:22:25 -04:00
|
|
|
user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
|
2020-02-29 01:19:32 -05:00
|
|
|
session := loginUser(t, user.Name)
|
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.AccessTokenScopeReadUser)
|
2020-02-29 01:19:32 -05:00
|
|
|
|
2023-01-17 16:46:03 -05:00
|
|
|
existApp := unittest.AssertExistsAndLoadBean(t, &auth_model.OAuth2Application{
|
2020-02-29 01:19:32 -05:00
|
|
|
UID: user.ID,
|
|
|
|
Name: "test-app-1",
|
|
|
|
RedirectURIs: []string{
|
|
|
|
"http://www.google.com",
|
|
|
|
},
|
2022-10-24 03:59:24 -04:00
|
|
|
ConfidentialClient: true,
|
2022-08-15 22:22:25 -04:00
|
|
|
})
|
2020-02-29 01:19:32 -05:00
|
|
|
|
2023-12-21 18:59:59 -05:00
|
|
|
req := NewRequest(t, "GET", "/api/v1/user/applications/oauth2").
|
|
|
|
AddTokenAuth(token)
|
2022-12-01 22:39:42 -05:00
|
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
2020-02-29 01:19:32 -05:00
|
|
|
|
|
|
|
var appList api.OAuth2ApplicationList
|
|
|
|
DecodeJSON(t, resp, &appList)
|
|
|
|
expectedApp := appList[0]
|
|
|
|
|
2024-07-30 15:41:10 -04:00
|
|
|
assert.EqualValues(t, expectedApp.Name, existApp.Name)
|
|
|
|
assert.EqualValues(t, expectedApp.ClientID, existApp.ClientID)
|
|
|
|
assert.Equal(t, expectedApp.ConfidentialClient, existApp.ConfidentialClient)
|
2020-02-29 01:19:32 -05:00
|
|
|
assert.Len(t, expectedApp.ClientID, 36)
|
|
|
|
assert.Empty(t, expectedApp.ClientSecret)
|
2024-07-30 15:41:10 -04:00
|
|
|
assert.EqualValues(t, expectedApp.RedirectURIs[0], existApp.RedirectURIs[0])
|
2023-01-17 16:46:03 -05:00
|
|
|
unittest.AssertExistsAndLoadBean(t, &auth_model.OAuth2Application{ID: expectedApp.ID, Name: expectedApp.Name})
|
2020-02-29 01:19:32 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
func testAPIDeleteOAuth2Application(t *testing.T) {
|
2022-08-15 22:22:25 -04:00
|
|
|
user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
|
2020-02-29 01:19:32 -05:00
|
|
|
session := loginUser(t, user.Name)
|
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)
|
2020-02-29 01:19:32 -05:00
|
|
|
|
2023-01-17 16:46:03 -05:00
|
|
|
oldApp := unittest.AssertExistsAndLoadBean(t, &auth_model.OAuth2Application{
|
2020-02-29 01:19:32 -05:00
|
|
|
UID: user.ID,
|
|
|
|
Name: "test-app-1",
|
2022-08-15 22:22:25 -04:00
|
|
|
})
|
2020-02-29 01:19:32 -05:00
|
|
|
|
2023-12-21 18:59:59 -05:00
|
|
|
urlStr := fmt.Sprintf("/api/v1/user/applications/oauth2/%d", oldApp.ID)
|
|
|
|
req := NewRequest(t, "DELETE", urlStr).
|
|
|
|
AddTokenAuth(token)
|
2022-12-01 22:39:42 -05:00
|
|
|
MakeRequest(t, req, http.StatusNoContent)
|
2020-02-29 01:19:32 -05:00
|
|
|
|
2023-01-17 16:46:03 -05:00
|
|
|
unittest.AssertNotExistsBean(t, &auth_model.OAuth2Application{UID: oldApp.UID, Name: oldApp.Name})
|
2021-04-10 16:49:10 -04:00
|
|
|
|
|
|
|
// Delete again will return not found
|
2023-12-21 18:59:59 -05:00
|
|
|
req = NewRequest(t, "DELETE", urlStr).
|
|
|
|
AddTokenAuth(token)
|
2022-12-01 22:39:42 -05:00
|
|
|
MakeRequest(t, req, http.StatusNotFound)
|
2020-02-29 01:19:32 -05:00
|
|
|
}
|
2020-04-09 20:37:31 -04:00
|
|
|
|
|
|
|
func testAPIGetOAuth2Application(t *testing.T) {
|
2022-08-15 22:22:25 -04:00
|
|
|
user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
|
2020-04-09 20:37:31 -04:00
|
|
|
session := loginUser(t, user.Name)
|
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.AccessTokenScopeReadUser)
|
2020-04-09 20:37:31 -04:00
|
|
|
|
2023-01-17 16:46:03 -05:00
|
|
|
existApp := unittest.AssertExistsAndLoadBean(t, &auth_model.OAuth2Application{
|
2020-04-09 20:37:31 -04:00
|
|
|
UID: user.ID,
|
|
|
|
Name: "test-app-1",
|
|
|
|
RedirectURIs: []string{
|
|
|
|
"http://www.google.com",
|
|
|
|
},
|
2022-10-24 03:59:24 -04:00
|
|
|
ConfidentialClient: true,
|
2022-08-15 22:22:25 -04:00
|
|
|
})
|
2020-04-09 20:37:31 -04:00
|
|
|
|
2023-12-21 18:59:59 -05:00
|
|
|
req := NewRequest(t, "GET", fmt.Sprintf("/api/v1/user/applications/oauth2/%d", existApp.ID)).
|
|
|
|
AddTokenAuth(token)
|
2022-12-01 22:39:42 -05:00
|
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
2020-04-09 20:37:31 -04:00
|
|
|
|
|
|
|
var app api.OAuth2Application
|
|
|
|
DecodeJSON(t, resp, &app)
|
|
|
|
expectedApp := app
|
|
|
|
|
2024-07-30 15:41:10 -04:00
|
|
|
assert.EqualValues(t, expectedApp.Name, existApp.Name)
|
|
|
|
assert.EqualValues(t, expectedApp.ClientID, existApp.ClientID)
|
|
|
|
assert.Equal(t, expectedApp.ConfidentialClient, existApp.ConfidentialClient)
|
2020-04-09 20:37:31 -04:00
|
|
|
assert.Len(t, expectedApp.ClientID, 36)
|
|
|
|
assert.Empty(t, expectedApp.ClientSecret)
|
2021-06-07 01:27:09 -04:00
|
|
|
assert.Len(t, expectedApp.RedirectURIs, 1)
|
2024-07-30 15:41:10 -04:00
|
|
|
assert.EqualValues(t, expectedApp.RedirectURIs[0], existApp.RedirectURIs[0])
|
2023-01-17 16:46:03 -05:00
|
|
|
unittest.AssertExistsAndLoadBean(t, &auth_model.OAuth2Application{ID: expectedApp.ID, Name: expectedApp.Name})
|
2020-04-09 20:37:31 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
func testAPIUpdateOAuth2Application(t *testing.T) {
|
2022-08-15 22:22:25 -04:00
|
|
|
user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
|
2020-04-09 20:37:31 -04:00
|
|
|
|
2023-01-17 16:46:03 -05:00
|
|
|
existApp := unittest.AssertExistsAndLoadBean(t, &auth_model.OAuth2Application{
|
2020-04-09 20:37:31 -04:00
|
|
|
UID: user.ID,
|
|
|
|
Name: "test-app-1",
|
|
|
|
RedirectURIs: []string{
|
|
|
|
"http://www.google.com",
|
|
|
|
},
|
2022-08-15 22:22:25 -04:00
|
|
|
})
|
2020-04-09 20:37:31 -04:00
|
|
|
|
|
|
|
appBody := api.CreateOAuth2ApplicationOptions{
|
|
|
|
Name: "test-app-1",
|
|
|
|
RedirectURIs: []string{
|
|
|
|
"http://www.google.com/",
|
|
|
|
"http://www.github.com/",
|
|
|
|
},
|
2022-10-24 03:59:24 -04:00
|
|
|
ConfidentialClient: true,
|
2020-04-09 20:37:31 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
urlStr := fmt.Sprintf("/api/v1/user/applications/oauth2/%d", existApp.ID)
|
2023-12-21 18:59:59 -05:00
|
|
|
req := NewRequestWithJSON(t, "PATCH", urlStr, &appBody).
|
|
|
|
AddBasicAuth(user.Name)
|
2020-04-09 20:37:31 -04:00
|
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
|
|
|
|
|
|
var app api.OAuth2Application
|
|
|
|
DecodeJSON(t, resp, &app)
|
|
|
|
expectedApp := app
|
|
|
|
|
2021-06-07 01:27:09 -04:00
|
|
|
assert.Len(t, expectedApp.RedirectURIs, 2)
|
2020-04-09 20:37:31 -04:00
|
|
|
assert.EqualValues(t, expectedApp.RedirectURIs[0], appBody.RedirectURIs[0])
|
|
|
|
assert.EqualValues(t, expectedApp.RedirectURIs[1], appBody.RedirectURIs[1])
|
2022-10-24 03:59:24 -04:00
|
|
|
assert.Equal(t, expectedApp.ConfidentialClient, appBody.ConfidentialClient)
|
2023-01-17 16:46:03 -05:00
|
|
|
unittest.AssertExistsAndLoadBean(t, &auth_model.OAuth2Application{ID: expectedApp.ID, Name: expectedApp.Name})
|
2020-04-09 20:37:31 -04:00
|
|
|
}
|