2021-03-18 16:58:47 +03:00
// Copyright 2021 The Gitea Authors. All rights reserved.
2022-11-27 21:20:29 +03:00
// SPDX-License-Identifier: MIT
2021-03-18 16:58:47 +03:00
2022-09-02 22:18:23 +03:00
package integration
2021-03-18 16:58:47 +03:00
import (
2023-12-05 18:43:35 +03:00
"context"
2022-07-04 15:36:24 +03:00
"fmt"
"net/http"
"net/url"
2021-03-18 16:58:47 +03:00
"os"
2022-09-04 18:14:53 +03:00
"path/filepath"
2021-03-18 16:58:47 +03:00
"testing"
2023-01-18 00:46:03 +03:00
auth_model "code.gitea.io/gitea/models/auth"
2023-12-31 08:00:35 +03:00
"code.gitea.io/gitea/models/db"
issues_model "code.gitea.io/gitea/models/issues"
2022-07-04 15:36:24 +03:00
repo_model "code.gitea.io/gitea/models/repo"
2021-11-16 18:25:33 +03:00
"code.gitea.io/gitea/models/unittest"
2021-11-24 12:49:20 +03:00
user_model "code.gitea.io/gitea/models/user"
2021-03-18 16:58:47 +03:00
"code.gitea.io/gitea/modules/setting"
2022-07-04 15:36:24 +03:00
"code.gitea.io/gitea/modules/structs"
2021-11-16 18:25:33 +03:00
"code.gitea.io/gitea/services/migrations"
2023-12-05 18:43:35 +03:00
"code.gitea.io/gitea/services/repository"
2021-03-18 16:58:47 +03:00
"github.com/stretchr/testify/assert"
)
func TestMigrateLocalPath ( t * testing . T ) {
2021-11-12 17:36:47 +03:00
assert . NoError ( t , unittest . PrepareTestDatabase ( ) )
2021-03-18 16:58:47 +03:00
2022-08-16 05:22:25 +03:00
adminUser := unittest . AssertExistsAndLoadBean ( t , & user_model . User { Name : "user1" } )
2021-03-18 16:58:47 +03:00
old := setting . ImportLocalPaths
setting . ImportLocalPaths = true
2022-09-04 18:14:53 +03:00
basePath := t . TempDir ( )
lowercasePath := filepath . Join ( basePath , "lowercase" )
err := os . Mkdir ( lowercasePath , 0 o700 )
2021-03-18 16:58:47 +03:00
assert . NoError ( t , err )
err = migrations . IsMigrateURLAllowed ( lowercasePath , adminUser )
assert . NoError ( t , err , "case lowercase path" )
2022-09-04 18:14:53 +03:00
mixedcasePath := filepath . Join ( basePath , "mIxeDCaSe" )
err = os . Mkdir ( mixedcasePath , 0 o700 )
2021-03-18 16:58:47 +03:00
assert . NoError ( t , err )
err = migrations . IsMigrateURLAllowed ( mixedcasePath , adminUser )
assert . NoError ( t , err , "case mixedcase path" )
setting . ImportLocalPaths = old
}
2022-07-04 15:36:24 +03:00
2023-12-05 18:43:35 +03:00
func TestMigrate ( t * testing . T ) {
2022-07-04 15:36:24 +03:00
onGiteaRun ( t , func ( t * testing . T , u * url . URL ) {
AllowLocalNetworks := setting . Migrations . AllowLocalNetworks
setting . Migrations . AllowLocalNetworks = true
AppVer := setting . AppVer
// Gitea SDK (go-sdk) need to parse the AppVer from server response, so we must set it to a valid version string.
setting . AppVer = "1.16.0"
defer func ( ) {
setting . Migrations . AllowLocalNetworks = AllowLocalNetworks
setting . AppVer = AppVer
migrations . Init ( )
} ( )
assert . NoError ( t , migrations . Init ( ) )
ownerName := "user2"
repoName := "repo1"
2022-08-16 05:22:25 +03:00
repoOwner := unittest . AssertExistsAndLoadBean ( t , & user_model . User { Name : ownerName } )
2022-07-04 15:36:24 +03:00
session := loginUser ( t , ownerName )
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 , auth_model . AccessTokenScopeReadMisc )
2022-07-04 15:36:24 +03:00
2023-12-05 18:43:35 +03:00
for _ , s := range [ ] struct {
svc structs . GitServiceType
} {
{ svc : structs . GiteaService } ,
{ svc : structs . ForgejoService } ,
} {
// Step 0: verify the repo is available
req := NewRequestf ( t , "GET" , fmt . Sprintf ( "/%s/%s" , ownerName , repoName ) )
_ = session . MakeRequest ( t , req , http . StatusOK )
// Step 1: get the Gitea migration form
req = NewRequestf ( t , "GET" , "/repo/migrate/?service_type=%d" , s . svc )
resp := session . MakeRequest ( t , req , http . StatusOK )
// Step 2: load the form
htmlDoc := NewHTMLParser ( t , resp . Body )
link , exists := htmlDoc . doc . Find ( ` form.ui.form[action^="/repo/migrate"] ` ) . Attr ( "action" )
assert . True ( t , exists , "The template has changed" )
// Step 4: submit the migration to only migrate issues
migratedRepoName := "otherrepo"
req = NewRequestWithValues ( t , "POST" , link , map [ string ] string {
"_csrf" : htmlDoc . GetCSRF ( ) ,
"service" : fmt . Sprintf ( "%d" , s . svc ) ,
"clone_addr" : fmt . Sprintf ( "%s%s/%s" , u , ownerName , repoName ) ,
"auth_token" : token ,
"issues" : "on" ,
"repo_name" : migratedRepoName ,
"description" : "" ,
"uid" : fmt . Sprintf ( "%d" , repoOwner . ID ) ,
} )
resp = session . MakeRequest ( t , req , http . StatusSeeOther )
// Step 5: a redirection displays the migrated repository
loc := resp . Header ( ) . Get ( "Location" )
assert . EqualValues ( t , fmt . Sprintf ( "/%s/%s" , ownerName , migratedRepoName ) , loc )
// Step 6: check the repo was created
repo := unittest . AssertExistsAndLoadBean ( t , & repo_model . Repository { Name : migratedRepoName } )
// Step 7: delete the repository, so we can test with other services
err := repository . DeleteRepository ( context . Background ( ) , repoOwner , repo , false )
assert . NoError ( t , err )
}
2022-07-04 15:36:24 +03:00
} )
}
2023-12-31 08:00:35 +03:00
func Test_UpdateCommentsMigrationsByType ( t * testing . T ) {
assert . NoError ( t , unittest . PrepareTestDatabase ( ) )
err := issues_model . UpdateCommentsMigrationsByType ( db . DefaultContext , structs . GithubService , "1" , 1 )
assert . NoError ( t , err )
}