2022-08-29 10:04:45 +03:00
// Copyright 2022 The Gitea Authors. All rights reserved.
2022-11-27 21:20:29 +03:00
// SPDX-License-Identifier: MIT
2022-08-29 10:04:45 +03:00
2022-09-02 22:18:23 +03:00
package integration
2022-08-29 10:04:45 +03:00
import (
"archive/tar"
"bytes"
"compress/gzip"
"fmt"
"net/http"
"strings"
"testing"
2023-04-27 03:24:03 +03:00
auth_model "code.gitea.io/gitea/models/auth"
2022-08-29 10:04:45 +03:00
"code.gitea.io/gitea/models/db"
"code.gitea.io/gitea/models/packages"
"code.gitea.io/gitea/models/unittest"
user_model "code.gitea.io/gitea/models/user"
"code.gitea.io/gitea/modules/json"
vagrant_module "code.gitea.io/gitea/modules/packages/vagrant"
2022-09-02 22:18:23 +03:00
"code.gitea.io/gitea/tests"
2022-08-29 10:04:45 +03:00
"github.com/stretchr/testify/assert"
)
func TestPackageVagrant ( t * testing . T ) {
2022-09-02 22:18:23 +03:00
defer tests . PrepareTestEnv ( t ) ( )
2022-08-29 10:04:45 +03:00
user := unittest . AssertExistsAndLoadBean ( t , & user_model . User { ID : 2 } )
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 := "Bearer " + getUserToken ( t , user . Name , auth_model . AccessTokenScopeWritePackage )
2022-08-29 10:04:45 +03:00
packageName := "test_package"
packageVersion := "1.0.1"
packageDescription := "Test Description"
packageProvider := "virtualbox"
filename := fmt . Sprintf ( "%s.box" , packageProvider )
infoContent , _ := json . Marshal ( map [ string ] string {
"description" : packageDescription ,
} )
var buf bytes . Buffer
zw := gzip . NewWriter ( & buf )
archive := tar . NewWriter ( zw )
archive . WriteHeader ( & tar . Header {
Name : "info.json" ,
Mode : 0 o600 ,
Size : int64 ( len ( infoContent ) ) ,
} )
archive . Write ( infoContent )
archive . Close ( )
zw . Close ( )
content := buf . Bytes ( )
root := fmt . Sprintf ( "/api/packages/%s/vagrant" , user . Name )
t . Run ( "Authenticate" , func ( t * testing . T ) {
2022-09-02 22:18:23 +03:00
defer tests . PrintCurrentTest ( t ) ( )
2022-08-29 10:04:45 +03:00
authenticateURL := fmt . Sprintf ( "%s/authenticate" , root )
req := NewRequest ( t , "GET" , authenticateURL )
MakeRequest ( t , req , http . StatusUnauthorized )
req = NewRequest ( t , "GET" , authenticateURL )
addTokenAuthHeader ( req , token )
MakeRequest ( t , req , http . StatusOK )
} )
boxURL := fmt . Sprintf ( "%s/%s" , root , packageName )
t . Run ( "Upload" , func ( t * testing . T ) {
2022-09-02 22:18:23 +03:00
defer tests . PrintCurrentTest ( t ) ( )
2022-08-29 10:04:45 +03:00
req := NewRequest ( t , "HEAD" , boxURL )
MakeRequest ( t , req , http . StatusNotFound )
uploadURL := fmt . Sprintf ( "%s/%s/%s" , boxURL , packageVersion , filename )
req = NewRequestWithBody ( t , "PUT" , uploadURL , bytes . NewReader ( content ) )
MakeRequest ( t , req , http . StatusUnauthorized )
req = NewRequestWithBody ( t , "PUT" , uploadURL , bytes . NewReader ( content ) )
addTokenAuthHeader ( req , token )
MakeRequest ( t , req , http . StatusCreated )
req = NewRequest ( t , "HEAD" , boxURL )
resp := MakeRequest ( t , req , http . StatusOK )
2022-12-03 01:06:23 +03:00
assert . True ( t , strings . HasPrefix ( resp . Header ( ) . Get ( "Content-Type" ) , "application/json" ) )
2022-08-29 10:04:45 +03:00
pvs , err := packages . GetVersionsByPackageType ( db . DefaultContext , user . ID , packages . TypeVagrant )
assert . NoError ( t , err )
assert . Len ( t , pvs , 1 )
pd , err := packages . GetPackageDescriptor ( db . DefaultContext , pvs [ 0 ] )
assert . NoError ( t , err )
assert . NotNil ( t , pd . SemVer )
assert . IsType ( t , & vagrant_module . Metadata { } , pd . Metadata )
assert . Equal ( t , packageName , pd . Package . Name )
assert . Equal ( t , packageVersion , pd . Version . Version )
pfs , err := packages . GetFilesByVersionID ( db . DefaultContext , pvs [ 0 ] . ID )
assert . NoError ( t , err )
assert . Len ( t , pfs , 1 )
assert . Equal ( t , filename , pfs [ 0 ] . Name )
assert . True ( t , pfs [ 0 ] . IsLead )
pb , err := packages . GetBlobByID ( db . DefaultContext , pfs [ 0 ] . BlobID )
assert . NoError ( t , err )
assert . Equal ( t , int64 ( len ( content ) ) , pb . Size )
req = NewRequestWithBody ( t , "PUT" , uploadURL , bytes . NewReader ( content ) )
addTokenAuthHeader ( req , token )
MakeRequest ( t , req , http . StatusConflict )
} )
t . Run ( "Download" , func ( t * testing . T ) {
2022-09-02 22:18:23 +03:00
defer tests . PrintCurrentTest ( t ) ( )
2022-08-29 10:04:45 +03:00
req := NewRequest ( t , "GET" , fmt . Sprintf ( "%s/%s/%s" , boxURL , packageVersion , filename ) )
resp := MakeRequest ( t , req , http . StatusOK )
assert . Equal ( t , content , resp . Body . Bytes ( ) )
} )
t . Run ( "EnumeratePackageVersions" , func ( t * testing . T ) {
2022-09-02 22:18:23 +03:00
defer tests . PrintCurrentTest ( t ) ( )
2022-08-29 10:04:45 +03:00
req := NewRequest ( t , "GET" , boxURL )
resp := MakeRequest ( t , req , http . StatusOK )
type providerData struct {
Name string ` json:"name" `
URL string ` json:"url" `
Checksum string ` json:"checksum" `
ChecksumType string ` json:"checksum_type" `
}
type versionMetadata struct {
Version string ` json:"version" `
Status string ` json:"status" `
DescriptionHTML string ` json:"description_html,omitempty" `
DescriptionMarkdown string ` json:"description_markdown,omitempty" `
Providers [ ] * providerData ` json:"providers" `
}
type packageMetadata struct {
Name string ` json:"name" `
Description string ` json:"description,omitempty" `
ShortDescription string ` json:"short_description,omitempty" `
Versions [ ] * versionMetadata ` json:"versions" `
}
var result packageMetadata
DecodeJSON ( t , resp , & result )
assert . Equal ( t , packageName , result . Name )
assert . Equal ( t , packageDescription , result . Description )
assert . Len ( t , result . Versions , 1 )
version := result . Versions [ 0 ]
assert . Equal ( t , packageVersion , version . Version )
assert . Equal ( t , "active" , version . Status )
assert . Len ( t , version . Providers , 1 )
provider := version . Providers [ 0 ]
assert . Equal ( t , packageProvider , provider . Name )
assert . Equal ( t , "sha512" , provider . ChecksumType )
assert . Equal ( t , "259bebd6160acad695016d22a45812e26f187aaf78e71a4c23ee3201528346293f991af3468a8c6c5d2a21d7d9e1bdc1bf79b87110b2fddfcc5a0d45963c7c30" , provider . Checksum )
} )
}