2021-11-17 22:47:35 +03:00
// Copyright 2021 The Gitea Authors. All rights reserved.
2022-11-27 21:20:29 +03:00
// SPDX-License-Identifier: MIT
2021-11-17 22:47:35 +03:00
2022-09-02 22:18:23 +03:00
package integration
2021-11-17 22:47:35 +03:00
import (
"fmt"
"io"
"net/http"
"net/url"
"testing"
2023-01-18 00:46:03 +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-17 22:47:35 +03:00
"code.gitea.io/gitea/models/unittest"
2021-11-24 12:49:20 +03:00
user_model "code.gitea.io/gitea/models/user"
2022-09-02 22:18:23 +03:00
"code.gitea.io/gitea/tests"
2021-11-17 22:47:35 +03:00
"github.com/stretchr/testify/assert"
)
func TestAPIDownloadArchive ( t * testing . T ) {
2022-09-02 22:18:23 +03:00
defer tests . PrepareTestEnv ( t ) ( )
2021-11-17 22:47:35 +03:00
2022-08-16 05:22:25 +03:00
repo := unittest . AssertExistsAndLoadBean ( t , & repo_model . Repository { ID : 1 } )
user2 := unittest . AssertExistsAndLoadBean ( t , & user_model . User { ID : 2 } )
2021-11-17 22:47:35 +03:00
session := loginUser ( t , user2 . LowerName )
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 . AccessTokenScopeReadRepository )
2021-11-17 22:47:35 +03:00
link , _ := url . Parse ( fmt . Sprintf ( "/api/v1/repos/%s/%s/archive/master.zip" , user2 . Name , repo . Name ) )
2023-12-23 06:29:51 +03:00
resp := MakeRequest ( t , NewRequest ( t , "GET" , link . String ( ) ) . AddTokenAuth ( token ) , http . StatusOK )
2021-11-17 22:47:35 +03:00
bs , err := io . ReadAll ( resp . Body )
assert . NoError ( t , err )
2023-04-23 00:56:27 +03:00
assert . Len ( t , bs , 320 )
2024-01-19 03:14:49 +03:00
assert . EqualValues ( t , "application/zip" , resp . Header ( ) . Get ( "Content-Type" ) )
2021-11-17 22:47:35 +03:00
link , _ = url . Parse ( fmt . Sprintf ( "/api/v1/repos/%s/%s/archive/master.tar.gz" , user2 . Name , repo . Name ) )
2023-12-23 06:29:51 +03:00
resp = MakeRequest ( t , NewRequest ( t , "GET" , link . String ( ) ) . AddTokenAuth ( token ) , http . StatusOK )
2021-11-17 22:47:35 +03:00
bs , err = io . ReadAll ( resp . Body )
assert . NoError ( t , err )
2023-04-23 00:56:27 +03:00
assert . Len ( t , bs , 266 )
2024-01-19 03:14:49 +03:00
assert . EqualValues ( t , "application/gzip" , resp . Header ( ) . Get ( "Content-Type" ) )
2021-11-17 22:47:35 +03:00
link , _ = url . Parse ( fmt . Sprintf ( "/api/v1/repos/%s/%s/archive/master.bundle" , user2 . Name , repo . Name ) )
2023-12-23 06:29:51 +03:00
resp = MakeRequest ( t , NewRequest ( t , "GET" , link . String ( ) ) . AddTokenAuth ( token ) , http . StatusOK )
2021-11-17 22:47:35 +03:00
bs , err = io . ReadAll ( resp . Body )
assert . NoError ( t , err )
2023-04-23 00:56:27 +03:00
assert . Len ( t , bs , 382 )
2024-01-19 03:14:49 +03:00
assert . EqualValues ( t , "application/octet-stream" , resp . Header ( ) . Get ( "Content-Type" ) )
2021-11-17 22:47:35 +03:00
link , _ = url . Parse ( fmt . Sprintf ( "/api/v1/repos/%s/%s/archive/master" , user2 . Name , repo . Name ) )
2023-12-23 06:29:51 +03:00
MakeRequest ( t , NewRequest ( t , "GET" , link . String ( ) ) . AddTokenAuth ( token ) , http . StatusBadRequest )
2021-11-17 22:47:35 +03:00
}