2022-12-09 09:35:56 +03:00
// Copyright 2021 The Gitea Authors. All rights reserved.
2024-04-17 12:40:35 +03:00
// SPDX-License-Identifier: MIT
2022-12-09 09:35:56 +03:00
package integration
import (
"bytes"
"fmt"
"io"
"mime/multipart"
"net/http"
"testing"
2023-01-18 00:46:03 +03:00
auth_model "code.gitea.io/gitea/models/auth"
2022-12-09 09:35:56 +03:00
"code.gitea.io/gitea/models/db"
issues_model "code.gitea.io/gitea/models/issues"
repo_model "code.gitea.io/gitea/models/repo"
"code.gitea.io/gitea/models/unittest"
user_model "code.gitea.io/gitea/models/user"
api "code.gitea.io/gitea/modules/structs"
2022-12-29 05:57:15 +03:00
"code.gitea.io/gitea/services/convert"
2022-12-09 09:35:56 +03:00
"code.gitea.io/gitea/tests"
"github.com/stretchr/testify/assert"
)
func TestAPIGetCommentAttachment ( t * testing . T ) {
defer tests . PrepareTestEnv ( t ) ( )
comment := unittest . AssertExistsAndLoadBean ( t , & issues_model . Comment { ID : 2 } )
assert . NoError ( t , comment . LoadIssue ( db . DefaultContext ) )
assert . NoError ( t , comment . LoadAttachments ( db . DefaultContext ) )
attachment := unittest . AssertExistsAndLoadBean ( t , & repo_model . Attachment { ID : comment . Attachments [ 0 ] . ID } )
repo := unittest . AssertExistsAndLoadBean ( t , & repo_model . Repository { ID : comment . Issue . RepoID } )
repoOwner := unittest . AssertExistsAndLoadBean ( t , & user_model . User { ID : repo . OwnerID } )
2023-11-25 20:21:21 +03:00
t . Run ( "UnrelatedCommentID" , func ( t * testing . T ) {
repo := unittest . AssertExistsAndLoadBean ( t , & repo_model . Repository { ID : 4 } )
repoOwner := unittest . AssertExistsAndLoadBean ( t , & user_model . User { ID : repo . OwnerID } )
token := getUserToken ( t , repoOwner . Name , auth_model . AccessTokenScopeWriteIssue )
2023-12-22 02:59:59 +03:00
req := NewRequestf ( t , "GET" , "/api/v1/repos/%s/%s/issues/comments/%d/assets/%d" , repoOwner . Name , repo . Name , comment . ID , attachment . ID ) .
AddTokenAuth ( token )
2023-11-25 20:21:21 +03:00
MakeRequest ( t , req , http . StatusNotFound )
} )
2022-12-09 09:35:56 +03:00
session := loginUser ( t , repoOwner . 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 21:57:16 +03:00
token := getTokenForLoggedInUser ( t , session , auth_model . AccessTokenScopeReadIssue )
2023-12-22 02:59:59 +03:00
req := NewRequestf ( t , "GET" , "/api/v1/repos/%s/%s/issues/comments/%d/assets/%d" , repoOwner . Name , repo . Name , comment . ID , attachment . ID ) .
AddTokenAuth ( token )
2022-12-09 09:35:56 +03:00
session . MakeRequest ( t , req , http . StatusOK )
2023-12-22 02:59:59 +03:00
req = NewRequestf ( t , "GET" , "/api/v1/repos/%s/%s/issues/comments/%d/assets/%d" , repoOwner . Name , repo . Name , comment . ID , attachment . ID ) .
AddTokenAuth ( token )
2022-12-09 09:35:56 +03:00
resp := session . MakeRequest ( t , req , http . StatusOK )
var apiAttachment api . Attachment
DecodeJSON ( t , resp , & apiAttachment )
2023-07-10 12:31:19 +03:00
expect := convert . ToAPIAttachment ( repo , attachment )
2022-12-09 09:35:56 +03:00
assert . Equal ( t , expect . ID , apiAttachment . ID )
assert . Equal ( t , expect . Name , apiAttachment . Name )
assert . Equal ( t , expect . UUID , apiAttachment . UUID )
assert . Equal ( t , expect . Created . Unix ( ) , apiAttachment . Created . Unix ( ) )
2023-07-10 12:31:19 +03:00
assert . Equal ( t , expect . DownloadURL , apiAttachment . DownloadURL )
2022-12-09 09:35:56 +03:00
}
func TestAPIListCommentAttachments ( t * testing . T ) {
defer tests . PrepareTestEnv ( t ) ( )
comment := unittest . AssertExistsAndLoadBean ( t , & issues_model . Comment { ID : 2 } )
issue := unittest . AssertExistsAndLoadBean ( t , & issues_model . Issue { ID : comment . IssueID } )
repo := unittest . AssertExistsAndLoadBean ( t , & repo_model . Repository { ID : issue . RepoID } )
repoOwner := unittest . AssertExistsAndLoadBean ( t , & user_model . User { ID : repo . OwnerID } )
session := loginUser ( t , repoOwner . 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 21:57:16 +03:00
token := getTokenForLoggedInUser ( t , session , auth_model . AccessTokenScopeReadIssue )
2023-12-22 02:59:59 +03:00
req := NewRequestf ( t , "GET" , "/api/v1/repos/%s/%s/issues/comments/%d/assets" , repoOwner . Name , repo . Name , comment . ID ) .
AddTokenAuth ( token )
2022-12-09 09:35:56 +03:00
resp := session . MakeRequest ( t , req , http . StatusOK )
var apiAttachments [ ] * api . Attachment
DecodeJSON ( t , resp , & apiAttachments )
expectedCount := unittest . GetCount ( t , & repo_model . Attachment { CommentID : comment . ID } )
2023-04-23 00:56:27 +03:00
assert . Len ( t , apiAttachments , expectedCount )
2022-12-09 09:35:56 +03:00
unittest . AssertExistsAndLoadBean ( t , & repo_model . Attachment { ID : apiAttachments [ 0 ] . ID , CommentID : comment . ID } )
}
func TestAPICreateCommentAttachment ( t * testing . T ) {
defer tests . PrepareTestEnv ( t ) ( )
comment := unittest . AssertExistsAndLoadBean ( t , & issues_model . Comment { ID : 2 } )
issue := unittest . AssertExistsAndLoadBean ( t , & issues_model . Issue { ID : comment . IssueID } )
repo := unittest . AssertExistsAndLoadBean ( t , & repo_model . Repository { ID : issue . RepoID } )
repoOwner := unittest . AssertExistsAndLoadBean ( t , & user_model . User { ID : repo . OwnerID } )
session := loginUser ( t , repoOwner . 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 21:57:16 +03:00
token := getTokenForLoggedInUser ( t , session , auth_model . AccessTokenScopeWriteIssue )
2022-12-09 09:35:56 +03:00
filename := "image.png"
buff := generateImg ( )
body := & bytes . Buffer { }
// Setup multi-part
writer := multipart . NewWriter ( body )
part , err := writer . CreateFormFile ( "attachment" , filename )
assert . NoError ( t , err )
_ , err = io . Copy ( part , & buff )
assert . NoError ( t , err )
err = writer . Close ( )
assert . NoError ( t , err )
2023-12-22 02:59:59 +03:00
req := NewRequestWithBody ( t , "POST" , fmt . Sprintf ( "/api/v1/repos/%s/%s/issues/comments/%d/assets" , repoOwner . Name , repo . Name , comment . ID ) , body ) .
AddTokenAuth ( token ) .
SetHeader ( "Content-Type" , writer . FormDataContentType ( ) )
2022-12-09 09:35:56 +03:00
resp := session . MakeRequest ( t , req , http . StatusCreated )
apiAttachment := new ( api . Attachment )
DecodeJSON ( t , resp , & apiAttachment )
unittest . AssertExistsAndLoadBean ( t , & repo_model . Attachment { ID : apiAttachment . ID , CommentID : comment . ID } )
}
2024-05-02 19:33:31 +03:00
func TestAPICreateCommentAttachmentWithUnallowedFile ( t * testing . T ) {
defer tests . PrepareTestEnv ( t ) ( )
comment := unittest . AssertExistsAndLoadBean ( t , & issues_model . Comment { ID : 2 } )
issue := unittest . AssertExistsAndLoadBean ( t , & issues_model . Issue { ID : comment . IssueID } )
repo := unittest . AssertExistsAndLoadBean ( t , & repo_model . Repository { ID : issue . RepoID } )
repoOwner := unittest . AssertExistsAndLoadBean ( t , & user_model . User { ID : repo . OwnerID } )
session := loginUser ( t , repoOwner . Name )
token := getTokenForLoggedInUser ( t , session , auth_model . AccessTokenScopeWriteIssue )
filename := "file.bad"
body := & bytes . Buffer { }
// Setup multi-part.
writer := multipart . NewWriter ( body )
_ , err := writer . CreateFormFile ( "attachment" , filename )
assert . NoError ( t , err )
err = writer . Close ( )
assert . NoError ( t , err )
req := NewRequestWithBody ( t , "POST" , fmt . Sprintf ( "/api/v1/repos/%s/%s/issues/comments/%d/assets" , repoOwner . Name , repo . Name , comment . ID ) , body ) .
AddTokenAuth ( token ) .
SetHeader ( "Content-Type" , writer . FormDataContentType ( ) )
session . MakeRequest ( t , req , http . StatusUnprocessableEntity )
}
2022-12-09 09:35:56 +03:00
func TestAPIEditCommentAttachment ( t * testing . T ) {
defer tests . PrepareTestEnv ( t ) ( )
2024-11-07 00:34:32 +03:00
const newAttachmentName = "newAttachmentName.txt"
2022-12-09 09:35:56 +03:00
attachment := unittest . AssertExistsAndLoadBean ( t , & repo_model . Attachment { ID : 6 } )
comment := unittest . AssertExistsAndLoadBean ( t , & issues_model . Comment { ID : attachment . CommentID } )
issue := unittest . AssertExistsAndLoadBean ( t , & issues_model . Issue { ID : comment . IssueID } )
repo := unittest . AssertExistsAndLoadBean ( t , & repo_model . Repository { ID : issue . RepoID } )
repoOwner := unittest . AssertExistsAndLoadBean ( t , & user_model . User { ID : repo . OwnerID } )
session := loginUser ( t , repoOwner . 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 21:57:16 +03:00
token := getTokenForLoggedInUser ( t , session , auth_model . AccessTokenScopeWriteIssue )
2023-12-22 02:59:59 +03:00
urlStr := fmt . Sprintf ( "/api/v1/repos/%s/%s/issues/comments/%d/assets/%d" ,
repoOwner . Name , repo . Name , comment . ID , attachment . ID )
2022-12-09 09:35:56 +03:00
req := NewRequestWithValues ( t , "PATCH" , urlStr , map [ string ] string {
"name" : newAttachmentName ,
2023-12-22 02:59:59 +03:00
} ) . AddTokenAuth ( token )
2022-12-09 09:35:56 +03:00
resp := session . MakeRequest ( t , req , http . StatusCreated )
apiAttachment := new ( api . Attachment )
DecodeJSON ( t , resp , & apiAttachment )
unittest . AssertExistsAndLoadBean ( t , & repo_model . Attachment { ID : apiAttachment . ID , CommentID : comment . ID , Name : apiAttachment . Name } )
}
2024-11-07 00:34:32 +03:00
func TestAPIEditCommentAttachmentWithUnallowedFile ( t * testing . T ) {
defer tests . PrepareTestEnv ( t ) ( )
attachment := unittest . AssertExistsAndLoadBean ( t , & repo_model . Attachment { ID : 6 } )
comment := unittest . AssertExistsAndLoadBean ( t , & issues_model . Comment { ID : attachment . CommentID } )
issue := unittest . AssertExistsAndLoadBean ( t , & issues_model . Issue { ID : comment . IssueID } )
repo := unittest . AssertExistsAndLoadBean ( t , & repo_model . Repository { ID : issue . RepoID } )
repoOwner := unittest . AssertExistsAndLoadBean ( t , & user_model . User { ID : repo . OwnerID } )
session := loginUser ( t , repoOwner . Name )
token := getTokenForLoggedInUser ( t , session , auth_model . AccessTokenScopeWriteIssue )
filename := "file.bad"
urlStr := fmt . Sprintf ( "/api/v1/repos/%s/%s/issues/comments/%d/assets/%d" ,
repoOwner . Name , repo . Name , comment . ID , attachment . ID )
req := NewRequestWithValues ( t , "PATCH" , urlStr , map [ string ] string {
"name" : filename ,
} ) . AddTokenAuth ( token )
session . MakeRequest ( t , req , http . StatusUnprocessableEntity )
}
2022-12-09 09:35:56 +03:00
func TestAPIDeleteCommentAttachment ( t * testing . T ) {
defer tests . PrepareTestEnv ( t ) ( )
attachment := unittest . AssertExistsAndLoadBean ( t , & repo_model . Attachment { ID : 6 } )
comment := unittest . AssertExistsAndLoadBean ( t , & issues_model . Comment { ID : attachment . CommentID } )
issue := unittest . AssertExistsAndLoadBean ( t , & issues_model . Issue { ID : comment . IssueID } )
repo := unittest . AssertExistsAndLoadBean ( t , & repo_model . Repository { ID : issue . RepoID } )
repoOwner := unittest . AssertExistsAndLoadBean ( t , & user_model . User { ID : repo . OwnerID } )
session := loginUser ( t , repoOwner . 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 21:57:16 +03:00
token := getTokenForLoggedInUser ( t , session , auth_model . AccessTokenScopeWriteIssue )
2022-12-09 09:35:56 +03:00
2023-12-22 02:59:59 +03:00
req := NewRequest ( t , "DELETE" , fmt . Sprintf ( "/api/v1/repos/%s/%s/issues/comments/%d/assets/%d" , repoOwner . Name , repo . Name , comment . ID , attachment . ID ) ) .
AddTokenAuth ( token )
2022-12-09 09:35:56 +03:00
session . MakeRequest ( t , req , http . StatusNoContent )
unittest . AssertNotExistsBean ( t , & repo_model . Attachment { ID : attachment . ID , CommentID : comment . ID } )
}