2021-10-25 06:43:40 +03:00
// Copyright 2021 The Gitea Authors. All rights reserved.
2022-11-27 21:20:29 +03:00
// SPDX-License-Identifier: MIT
2021-10-25 06:43:40 +03:00
2022-09-02 22:18:23 +03:00
package integration
2021-10-25 06:43:40 +03:00
import (
"encoding/base64"
"fmt"
"net/http"
"testing"
2023-01-18 00:46:03 +03:00
auth_model "code.gitea.io/gitea/models/auth"
2021-10-25 06:43:40 +03:00
api "code.gitea.io/gitea/modules/structs"
2022-09-02 22:18:23 +03:00
"code.gitea.io/gitea/tests"
2021-10-25 06:43:40 +03:00
"github.com/stretchr/testify/assert"
)
func TestAPIGetWikiPage ( t * testing . T ) {
2022-09-02 22:18:23 +03:00
defer tests . PrepareTestEnv ( t ) ( )
2021-10-25 06:43:40 +03:00
username := "user2"
urlStr := fmt . Sprintf ( "/api/v1/repos/%s/%s/wiki/page/Home" , username , "repo1" )
req := NewRequest ( t , "GET" , urlStr )
2022-12-02 06:39:42 +03:00
resp := MakeRequest ( t , req , http . StatusOK )
2021-10-25 06:43:40 +03:00
var page * api . WikiPage
DecodeJSON ( t , resp , & page )
assert . Equal ( t , & api . WikiPage {
WikiPageMetaData : & api . WikiPageMetaData {
Title : "Home" ,
HTMLURL : page . HTMLURL ,
SubURL : "Home" ,
LastCommit : & api . WikiCommit {
ID : "2c54faec6c45d31c1abfaecdab471eac6633738a" ,
Author : & api . CommitUser {
Identity : api . Identity {
Name : "Ethan Koenig" ,
Email : "ethantkoenig@gmail.com" ,
} ,
Date : "2017-11-27T04:31:18Z" ,
} ,
Committer : & api . CommitUser {
Identity : api . Identity {
Name : "Ethan Koenig" ,
Email : "ethantkoenig@gmail.com" ,
} ,
Date : "2017-11-27T04:31:18Z" ,
} ,
Message : "Add Home.md\n" ,
} ,
} ,
ContentBase64 : base64 . RawStdEncoding . EncodeToString (
[ ] byte ( "# Home page\n\nThis is the home page!\n" ) ,
) ,
CommitCount : 1 ,
Sidebar : "" ,
Footer : "" ,
} , page )
}
func TestAPIListWikiPages ( t * testing . T ) {
2022-09-02 22:18:23 +03:00
defer tests . PrepareTestEnv ( t ) ( )
2021-10-25 06:43:40 +03:00
username := "user2"
urlStr := fmt . Sprintf ( "/api/v1/repos/%s/%s/wiki/pages" , username , "repo1" )
req := NewRequest ( t , "GET" , urlStr )
2022-12-02 06:39:42 +03:00
resp := MakeRequest ( t , req , http . StatusOK )
2021-10-25 06:43:40 +03:00
var meta [ ] * api . WikiPageMetaData
DecodeJSON ( t , resp , & meta )
dummymeta := [ ] * api . WikiPageMetaData {
{
Title : "Home" ,
HTMLURL : meta [ 0 ] . HTMLURL ,
SubURL : "Home" ,
LastCommit : & api . WikiCommit {
ID : "2c54faec6c45d31c1abfaecdab471eac6633738a" ,
Author : & api . CommitUser {
Identity : api . Identity {
Name : "Ethan Koenig" ,
Email : "ethantkoenig@gmail.com" ,
} ,
Date : "2017-11-27T04:31:18Z" ,
} ,
Committer : & api . CommitUser {
Identity : api . Identity {
Name : "Ethan Koenig" ,
Email : "ethantkoenig@gmail.com" ,
} ,
Date : "2017-11-27T04:31:18Z" ,
} ,
Message : "Add Home.md\n" ,
} ,
} ,
{
Title : "Page With Image" ,
HTMLURL : meta [ 1 ] . HTMLURL ,
SubURL : "Page-With-Image" ,
LastCommit : & api . WikiCommit {
ID : "0cf15c3f66ec8384480ed9c3cf87c9e97fbb0ec3" ,
Author : & api . CommitUser {
Identity : api . Identity {
Name : "Gabriel Silva Simões" ,
Email : "simoes.sgabriel@gmail.com" ,
} ,
Date : "2019-01-25T01:41:55Z" ,
} ,
Committer : & api . CommitUser {
Identity : api . Identity {
Name : "Gabriel Silva Simões" ,
Email : "simoes.sgabriel@gmail.com" ,
} ,
Date : "2019-01-25T01:41:55Z" ,
} ,
Message : "Add jpeg.jpg and page with image\n" ,
} ,
} ,
{
Title : "Page With Spaced Name" ,
HTMLURL : meta [ 2 ] . HTMLURL ,
SubURL : "Page-With-Spaced-Name" ,
LastCommit : & api . WikiCommit {
ID : "c10d10b7e655b3dab1f53176db57c8219a5488d6" ,
Author : & api . CommitUser {
Identity : api . Identity {
Name : "Gabriel Silva Simões" ,
Email : "simoes.sgabriel@gmail.com" ,
} ,
Date : "2019-01-25T01:39:51Z" ,
} ,
Committer : & api . CommitUser {
Identity : api . Identity {
Name : "Gabriel Silva Simões" ,
Email : "simoes.sgabriel@gmail.com" ,
} ,
Date : "2019-01-25T01:39:51Z" ,
} ,
Message : "Add page with spaced name\n" ,
} ,
} ,
{
Title : "Unescaped File" ,
HTMLURL : meta [ 3 ] . HTMLURL ,
SubURL : "Unescaped-File" ,
LastCommit : & api . WikiCommit {
ID : "0dca5bd9b5d7ef937710e056f575e86c0184ba85" ,
Author : & api . CommitUser {
Identity : api . Identity {
Name : "6543" ,
Email : "6543@obermui.de" ,
} ,
Date : "2021-07-19T16:42:46Z" ,
} ,
Committer : & api . CommitUser {
Identity : api . Identity {
Name : "6543" ,
Email : "6543@obermui.de" ,
} ,
Date : "2021-07-19T16:42:46Z" ,
} ,
Message : "add unescaped file\n" ,
} ,
} ,
}
assert . Equal ( t , dummymeta , meta )
}
func TestAPINewWikiPage ( t * testing . T ) {
for _ , title := range [ ] string {
"New page" ,
"&&&&" ,
} {
2022-09-02 22:18:23 +03:00
defer tests . PrepareTestEnv ( t ) ( )
2021-10-25 06:43:40 +03:00
username := "user2"
session := loginUser ( t , username )
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
token := getTokenForLoggedInUser ( t , session , auth_model . AccessTokenScopeWriteRepository )
2021-10-25 06:43:40 +03:00
2023-12-22 02:59:59 +03:00
urlStr := fmt . Sprintf ( "/api/v1/repos/%s/%s/wiki/new" , username , "repo1" )
2021-10-25 06:43:40 +03:00
req := NewRequestWithJSON ( t , "POST" , urlStr , & api . CreateWikiPageOptions {
Title : title ,
ContentBase64 : base64 . StdEncoding . EncodeToString ( [ ] byte ( "Wiki page content for API unit tests" ) ) ,
Message : "" ,
2023-12-22 02:59:59 +03:00
} ) . AddTokenAuth ( token )
2022-12-02 06:39:42 +03:00
MakeRequest ( t , req , http . StatusCreated )
2021-10-25 06:43:40 +03:00
}
}
func TestAPIEditWikiPage ( t * testing . T ) {
2022-09-02 22:18:23 +03:00
defer tests . PrepareTestEnv ( t ) ( )
2021-10-25 06:43:40 +03:00
username := "user2"
session := loginUser ( t , username )
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
token := getTokenForLoggedInUser ( t , session , auth_model . AccessTokenScopeWriteRepository )
2021-10-25 06:43:40 +03:00
2023-12-22 02:59:59 +03:00
urlStr := fmt . Sprintf ( "/api/v1/repos/%s/%s/wiki/page/Page-With-Spaced-Name" , username , "repo1" )
2021-10-25 06:43:40 +03:00
req := NewRequestWithJSON ( t , "PATCH" , urlStr , & api . CreateWikiPageOptions {
Title : "edited title" ,
ContentBase64 : base64 . StdEncoding . EncodeToString ( [ ] byte ( "Edited wiki page content for API unit tests" ) ) ,
Message : "" ,
2023-12-22 02:59:59 +03:00
} ) . AddTokenAuth ( token )
2022-12-02 06:39:42 +03:00
MakeRequest ( t , req , http . StatusOK )
2021-10-25 06:43:40 +03:00
}
func TestAPIListPageRevisions ( t * testing . T ) {
2022-09-02 22:18:23 +03:00
defer tests . PrepareTestEnv ( t ) ( )
2021-10-25 06:43:40 +03:00
username := "user2"
urlStr := fmt . Sprintf ( "/api/v1/repos/%s/%s/wiki/revisions/Home" , username , "repo1" )
req := NewRequest ( t , "GET" , urlStr )
2022-12-02 06:39:42 +03:00
resp := MakeRequest ( t , req , http . StatusOK )
2021-10-25 06:43:40 +03:00
var revisions * api . WikiCommitList
DecodeJSON ( t , resp , & revisions )
dummyrevisions := & api . WikiCommitList {
WikiCommits : [ ] * api . WikiCommit {
{
ID : "2c54faec6c45d31c1abfaecdab471eac6633738a" ,
Author : & api . CommitUser {
Identity : api . Identity {
Name : "Ethan Koenig" ,
Email : "ethantkoenig@gmail.com" ,
} ,
Date : "2017-11-27T04:31:18Z" ,
} ,
Committer : & api . CommitUser {
Identity : api . Identity {
Name : "Ethan Koenig" ,
Email : "ethantkoenig@gmail.com" ,
} ,
Date : "2017-11-27T04:31:18Z" ,
} ,
Message : "Add Home.md\n" ,
} ,
} ,
Count : 1 ,
}
assert . Equal ( t , dummyrevisions , revisions )
}