2017-07-27 12:23:38 +03:00
// Copyright 2017 The Gitea Authors. All rights reserved.
2022-11-27 21:20:29 +03:00
// SPDX-License-Identifier: MIT
2017-07-27 12:23:38 +03:00
2022-09-02 22:18:23 +03:00
package integration
2017-07-27 12:23:38 +03:00
import (
2023-04-19 16:40:42 +03:00
"bytes"
2023-04-27 04:36:26 +03:00
"encoding/base64"
2024-05-21 20:00:35 +03:00
"fmt"
2023-04-19 16:40:42 +03:00
"io"
"mime/multipart"
2017-07-27 12:23:38 +03:00
"net/http"
2024-05-21 20:00:35 +03:00
"net/http/httptest"
2017-07-27 12:23:38 +03:00
"testing"
2023-04-27 04:36:26 +03:00
auth_model "code.gitea.io/gitea/models/auth"
2021-12-10 04:27:50 +03:00
repo_model "code.gitea.io/gitea/models/repo"
2021-11-16 11:53:21 +03:00
"code.gitea.io/gitea/models/unittest"
2021-11-24 12:49:20 +03:00
user_model "code.gitea.io/gitea/models/user"
2023-04-19 16:40:42 +03:00
"code.gitea.io/gitea/modules/json"
"code.gitea.io/gitea/modules/setting"
2023-04-27 04:36:26 +03:00
api "code.gitea.io/gitea/modules/structs"
2023-04-19 16:40:42 +03:00
"code.gitea.io/gitea/modules/test"
2022-09-02 22:18:23 +03:00
"code.gitea.io/gitea/tests"
2022-12-23 21:34:51 +03:00
"github.com/stretchr/testify/assert"
2017-07-27 12:23:38 +03:00
)
2024-05-21 20:00:35 +03:00
func testAPINewFile ( t * testing . T , session * TestSession , user , repo , branch , treePath , content string ) * httptest . ResponseRecorder {
url := fmt . Sprintf ( "/%s/%s/_new/%s" , user , repo , branch )
req := NewRequestWithValues ( t , "POST" , url , map [ string ] string {
2024-10-10 06:48:21 +03:00
"_csrf" : GetUserCSRFToken ( t , session ) ,
2024-05-21 20:00:35 +03:00
"commit_choice" : "direct" ,
"tree_path" : treePath ,
"content" : content ,
} )
return session . MakeRequest ( t , req , http . StatusSeeOther )
}
2019-01-18 03:01:04 +03:00
func TestEmptyRepo ( t * testing . T ) {
2022-09-02 22:18:23 +03:00
defer tests . PrepareTestEnv ( t ) ( )
2023-04-19 16:40:42 +03:00
subPaths := [ ] string {
2017-07-27 12:23:38 +03:00
"commits/master" ,
"raw/foo" ,
"commit/1ae57b34ccf7e18373" ,
"graph" ,
}
2023-07-01 05:52:52 +03:00
emptyRepo := unittest . AssertExistsAndLoadBean ( t , & repo_model . Repository { ID : 6 } )
2022-12-23 21:34:51 +03:00
assert . True ( t , emptyRepo . IsEmpty )
2022-08-16 05:22:25 +03:00
owner := unittest . AssertExistsAndLoadBean ( t , & user_model . User { ID : emptyRepo . OwnerID } )
2023-04-19 16:40:42 +03:00
for _ , subPath := range subPaths {
req := NewRequestf ( t , "GET" , "/%s/%s/%s" , owner . Name , emptyRepo . Name , subPath )
2017-07-27 12:23:38 +03:00
MakeRequest ( t , req , http . StatusNotFound )
}
}
2023-04-19 16:40:42 +03:00
func TestEmptyRepoAddFile ( t * testing . T ) {
defer tests . PrepareTestEnv ( t ) ( )
session := loginUser ( t , "user30" )
req := NewRequest ( t , "GET" , "/user30/empty/_new/" + setting . Repository . DefaultBranch )
resp := session . MakeRequest ( t , req , http . StatusOK )
doc := NewHTMLParser ( t , resp . Body ) . Find ( ` input[name="commit_choice"] ` )
2023-04-23 00:56:27 +03:00
assert . Empty ( t , doc . AttrOr ( "checked" , "_no_" ) )
2023-04-19 16:40:42 +03:00
req = NewRequestWithValues ( t , "POST" , "/user30/empty/_new/" + setting . Repository . DefaultBranch , map [ string ] string {
2024-10-10 06:48:21 +03:00
"_csrf" : GetUserCSRFToken ( t , session ) ,
2023-04-19 16:40:42 +03:00
"commit_choice" : "direct" ,
"tree_path" : "test-file.md" ,
"content" : "newly-added-test-file" ,
} )
resp = session . MakeRequest ( t , req , http . StatusSeeOther )
redirect := test . RedirectURL ( resp )
assert . Equal ( t , "/user30/empty/src/branch/" + setting . Repository . DefaultBranch + "/test-file.md" , redirect )
req = NewRequest ( t , "GET" , redirect )
resp = session . MakeRequest ( t , req , http . StatusOK )
assert . Contains ( t , resp . Body . String ( ) , "newly-added-test-file" )
}
func TestEmptyRepoUploadFile ( t * testing . T ) {
defer tests . PrepareTestEnv ( t ) ( )
session := loginUser ( t , "user30" )
req := NewRequest ( t , "GET" , "/user30/empty/_new/" + setting . Repository . DefaultBranch )
resp := session . MakeRequest ( t , req , http . StatusOK )
doc := NewHTMLParser ( t , resp . Body ) . Find ( ` input[name="commit_choice"] ` )
2023-04-23 00:56:27 +03:00
assert . Empty ( t , doc . AttrOr ( "checked" , "_no_" ) )
2023-04-19 16:40:42 +03:00
body := & bytes . Buffer { }
mpForm := multipart . NewWriter ( body )
2024-10-10 06:48:21 +03:00
_ = mpForm . WriteField ( "_csrf" , GetUserCSRFToken ( t , session ) )
2023-04-19 16:40:42 +03:00
file , _ := mpForm . CreateFormFile ( "file" , "uploaded-file.txt" )
_ , _ = io . Copy ( file , bytes . NewBufferString ( "newly-uploaded-test-file" ) )
_ = mpForm . Close ( )
req = NewRequestWithBody ( t , "POST" , "/user30/empty/upload-file" , body )
req . Header . Add ( "Content-Type" , mpForm . FormDataContentType ( ) )
resp = session . MakeRequest ( t , req , http . StatusOK )
respMap := map [ string ] string { }
assert . NoError ( t , json . Unmarshal ( resp . Body . Bytes ( ) , & respMap ) )
req = NewRequestWithValues ( t , "POST" , "/user30/empty/_upload/" + setting . Repository . DefaultBranch , map [ string ] string {
2024-10-10 06:48:21 +03:00
"_csrf" : GetUserCSRFToken ( t , session ) ,
2023-04-19 16:40:42 +03:00
"commit_choice" : "direct" ,
"files" : respMap [ "uuid" ] ,
"tree_path" : "" ,
} )
resp = session . MakeRequest ( t , req , http . StatusSeeOther )
redirect := test . RedirectURL ( resp )
assert . Equal ( t , "/user30/empty/src/branch/" + setting . Repository . DefaultBranch + "/" , redirect )
req = NewRequest ( t , "GET" , redirect )
resp = session . MakeRequest ( t , req , http . StatusOK )
assert . Contains ( t , resp . Body . String ( ) , "uploaded-file.txt" )
}
2023-04-27 04:36:26 +03:00
func TestEmptyRepoAddFileByAPI ( t * testing . T ) {
defer tests . PrepareTestEnv ( t ) ( )
session := loginUser ( t , "user30" )
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 )
2023-04-27 04:36:26 +03:00
2023-12-22 02:59:59 +03:00
req := NewRequestWithJSON ( t , "POST" , "/api/v1/repos/user30/empty/contents/new-file.txt" , & api . CreateFileOptions {
2023-04-27 04:36:26 +03:00
FileOptions : api . FileOptions {
NewBranchName : "new_branch" ,
Message : "init" ,
} ,
2023-07-18 21:14:47 +03:00
ContentBase64 : base64 . StdEncoding . EncodeToString ( [ ] byte ( "newly-added-api-file" ) ) ,
2023-12-22 02:59:59 +03:00
} ) . AddTokenAuth ( token )
2023-04-27 04:36:26 +03:00
resp := MakeRequest ( t , req , http . StatusCreated )
var fileResponse api . FileResponse
DecodeJSON ( t , resp , & fileResponse )
expectedHTMLURL := setting . AppURL + "user30/empty/src/branch/new_branch/new-file.txt"
assert . EqualValues ( t , expectedHTMLURL , * fileResponse . Content . HTMLURL )
req = NewRequest ( t , "GET" , "/user30/empty/src/branch/new_branch/new-file.txt" )
resp = session . MakeRequest ( t , req , http . StatusOK )
assert . Contains ( t , resp . Body . String ( ) , "newly-added-api-file" )
2023-05-31 12:07:51 +03:00
2023-12-22 02:59:59 +03:00
req = NewRequest ( t , "GET" , "/api/v1/repos/user30/empty" ) .
AddTokenAuth ( token )
2023-05-31 12:07:51 +03:00
resp = session . MakeRequest ( t , req , http . StatusOK )
var apiRepo api . Repository
DecodeJSON ( t , resp , & apiRepo )
assert . Equal ( t , "new_branch" , apiRepo . DefaultBranch )
2023-04-27 04:36:26 +03:00
}