2019-02-03 23:56:53 +00:00
// Copyright 2019 The Gitea Authors. All rights reserved.
2022-11-27 18:20:29 +00:00
// SPDX-License-Identifier: MIT
2019-02-03 23:56:53 +00:00
2022-09-02 19:18:23 +00:00
package integration
2019-02-03 23:56:53 +00:00
import (
"fmt"
"net/http"
"net/url"
2021-09-22 05:38:34 +00:00
"os"
2019-02-03 23:56:53 +00:00
"path/filepath"
"testing"
"time"
2023-01-17 21:46:03 +00:00
auth_model "code.gitea.io/gitea/models/auth"
2019-03-27 09:33:00 +00:00
"code.gitea.io/gitea/modules/git"
2019-05-11 10:21:34 +00:00
api "code.gitea.io/gitea/modules/structs"
2019-08-23 16:40:30 +00:00
2019-02-03 23:56:53 +00:00
"github.com/stretchr/testify/assert"
)
func doCheckRepositoryEmptyStatus ( ctx APITestContext , isEmpty bool ) func ( * testing . T ) {
return doAPIGetRepository ( ctx , func ( t * testing . T , repository api . Repository ) {
assert . Equal ( t , isEmpty , repository . Empty )
} )
}
func doAddChangesToCheckout ( dstPath , filename string ) func ( * testing . T ) {
return func ( t * testing . T ) {
2022-01-20 17:46:10 +00:00
assert . NoError ( t , os . WriteFile ( filepath . Join ( dstPath , filename ) , [ ] byte ( fmt . Sprintf ( "# Testing Repository\n\nOriginally created in: %s at time: %v" , dstPath , time . Now ( ) ) ) , 0 o644 ) )
2019-02-03 23:56:53 +00:00
assert . NoError ( t , git . AddChanges ( dstPath , true ) )
signature := git . Signature {
Email : "test@example.com" ,
Name : "test" ,
When : time . Now ( ) ,
}
assert . NoError ( t , git . CommitChanges ( dstPath , git . CommitChangesOptions {
Committer : & signature ,
Author : & signature ,
Message : "Initial Commit" ,
} ) )
}
}
func TestPushDeployKeyOnEmptyRepo ( t * testing . T ) {
onGiteaRun ( t , testPushDeployKeyOnEmptyRepo )
}
func testPushDeployKeyOnEmptyRepo ( t * testing . T , u * url . URL ) {
// OK login
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 18:57:16 +00:00
ctx := NewAPITestContext ( t , "user2" , "deploy-key-empty-repo-1" , auth_model . AccessTokenScopeWriteRepository , auth_model . AccessTokenScopeWriteUser )
ctxWithDeleteRepo := NewAPITestContext ( t , "user2" , "deploy-key-empty-repo-1" , auth_model . AccessTokenScopeWriteRepository , auth_model . AccessTokenScopeWriteUser )
2023-01-17 21:46:03 +00:00
2019-02-03 23:56:53 +00:00
keyname := fmt . Sprintf ( "%s-push" , ctx . Reponame )
u . Path = ctx . GitPath ( )
t . Run ( "CreateEmptyRepository" , doAPICreateRepository ( ctx , true ) )
t . Run ( "CheckIsEmpty" , doCheckRepositoryEmptyStatus ( ctx , true ) )
withKeyFile ( t , keyname , func ( keyFile string ) {
t . Run ( "CreatePushDeployKey" , doAPICreateDeployKey ( ctx , keyname , keyFile , false ) )
// Setup the testing repository
2022-09-04 15:14:53 +00:00
dstPath := t . TempDir ( )
2019-02-03 23:56:53 +00:00
t . Run ( "InitTestRepository" , doGitInitTestRepository ( dstPath ) )
2022-01-20 17:46:10 +00:00
// Setup remote link
2019-02-03 23:56:53 +00:00
sshURL := createSSHUrl ( ctx . GitPath ( ) , u )
t . Run ( "AddRemote" , doGitAddRemote ( dstPath , "origin" , sshURL ) )
t . Run ( "SSHPushTestRepository" , doGitPushTestRepository ( dstPath , "origin" , "master" ) )
t . Run ( "CheckIsNotEmpty" , doCheckRepositoryEmptyStatus ( ctx , false ) )
2023-01-17 21:46:03 +00:00
t . Run ( "DeleteRepository" , doAPIDeleteRepository ( ctxWithDeleteRepo ) )
2019-02-03 23:56:53 +00:00
} )
}
func TestKeyOnlyOneType ( t * testing . T ) {
onGiteaRun ( t , testKeyOnlyOneType )
}
func testKeyOnlyOneType ( t * testing . T , u * url . URL ) {
// Once a key is a user key we cannot use it as a deploy key
// If we delete it from the user we should be able to use it as a deploy key
reponame := "ssh-key-test-repo"
username := "user2"
u . Path = fmt . Sprintf ( "%s/%s.git" , username , reponame )
keyname := fmt . Sprintf ( "%s-push" , reponame )
// OK login
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 18:57:16 +00:00
ctx := NewAPITestContext ( t , username , reponame , auth_model . AccessTokenScopeWriteRepository , auth_model . AccessTokenScopeWriteUser )
ctxWithDeleteRepo := NewAPITestContext ( t , username , reponame , auth_model . AccessTokenScopeWriteRepository , auth_model . AccessTokenScopeWriteUser )
2019-02-03 23:56:53 +00:00
otherCtx := ctx
otherCtx . Reponame = "ssh-key-test-repo-2"
2023-01-17 21:46:03 +00:00
otherCtxWithDeleteRepo := ctxWithDeleteRepo
otherCtxWithDeleteRepo . Reponame = otherCtx . Reponame
2019-02-03 23:56:53 +00:00
failCtx := ctx
failCtx . ExpectedCode = http . StatusUnprocessableEntity
t . Run ( "CreateRepository" , doAPICreateRepository ( ctx , false ) )
t . Run ( "CreateOtherRepository" , doAPICreateRepository ( otherCtx , false ) )
withKeyFile ( t , keyname , func ( keyFile string ) {
var userKeyPublicKeyID int64
t . Run ( "KeyCanOnlyBeUser" , func ( t * testing . T ) {
2022-09-04 15:14:53 +00:00
dstPath := t . TempDir ( )
2019-02-03 23:56:53 +00:00
sshURL := createSSHUrl ( ctx . GitPath ( ) , u )
2020-04-28 08:32:23 +00:00
t . Run ( "FailToClone" , doGitCloneFail ( sshURL ) )
2019-02-03 23:56:53 +00:00
t . Run ( "CreateUserKey" , doAPICreateUserKey ( ctx , keyname , keyFile , func ( t * testing . T , publicKey api . PublicKey ) {
userKeyPublicKeyID = publicKey . ID
} ) )
t . Run ( "FailToAddReadOnlyDeployKey" , doAPICreateDeployKey ( failCtx , keyname , keyFile , true ) )
t . Run ( "FailToAddDeployKey" , doAPICreateDeployKey ( failCtx , keyname , keyFile , false ) )
t . Run ( "Clone" , doGitClone ( dstPath , sshURL ) )
t . Run ( "AddChanges" , doAddChangesToCheckout ( dstPath , "CHANGES1.md" ) )
t . Run ( "Push" , doGitPushTestRepository ( dstPath , "origin" , "master" ) )
t . Run ( "DeleteUserKey" , doAPIDeleteUserKey ( ctx , userKeyPublicKeyID ) )
} )
t . Run ( "KeyCanBeAnyDeployButNotUserAswell" , func ( t * testing . T ) {
2022-09-04 15:14:53 +00:00
dstPath := t . TempDir ( )
2019-02-03 23:56:53 +00:00
sshURL := createSSHUrl ( ctx . GitPath ( ) , u )
2020-04-28 08:32:23 +00:00
t . Run ( "FailToClone" , doGitCloneFail ( sshURL ) )
2019-02-03 23:56:53 +00:00
// Should now be able to add...
t . Run ( "AddReadOnlyDeployKey" , doAPICreateDeployKey ( ctx , keyname , keyFile , true ) )
t . Run ( "Clone" , doGitClone ( dstPath , sshURL ) )
t . Run ( "AddChanges" , doAddChangesToCheckout ( dstPath , "CHANGES2.md" ) )
t . Run ( "FailToPush" , doGitPushTestRepositoryFail ( dstPath , "origin" , "master" ) )
otherSSHURL := createSSHUrl ( otherCtx . GitPath ( ) , u )
2022-09-04 15:14:53 +00:00
dstOtherPath := t . TempDir ( )
2019-02-03 23:56:53 +00:00
t . Run ( "AddWriterDeployKeyToOther" , doAPICreateDeployKey ( otherCtx , keyname , keyFile , false ) )
t . Run ( "CloneOther" , doGitClone ( dstOtherPath , otherSSHURL ) )
t . Run ( "AddChangesToOther" , doAddChangesToCheckout ( dstOtherPath , "CHANGES3.md" ) )
t . Run ( "PushToOther" , doGitPushTestRepository ( dstOtherPath , "origin" , "master" ) )
t . Run ( "FailToCreateUserKey" , doAPICreateUserKey ( failCtx , keyname , keyFile ) )
} )
t . Run ( "DeleteRepositoryShouldReleaseKey" , func ( t * testing . T ) {
otherSSHURL := createSSHUrl ( otherCtx . GitPath ( ) , u )
2022-09-04 15:14:53 +00:00
dstOtherPath := t . TempDir ( )
2019-02-03 23:56:53 +00:00
2023-01-17 21:46:03 +00:00
t . Run ( "DeleteRepository" , doAPIDeleteRepository ( ctxWithDeleteRepo ) )
2019-02-03 23:56:53 +00:00
t . Run ( "FailToCreateUserKeyAsStillDeploy" , doAPICreateUserKey ( failCtx , keyname , keyFile ) )
t . Run ( "MakeSureCloneOtherStillWorks" , doGitClone ( dstOtherPath , otherSSHURL ) )
t . Run ( "AddChangesToOther" , doAddChangesToCheckout ( dstOtherPath , "CHANGES3.md" ) )
t . Run ( "PushToOther" , doGitPushTestRepository ( dstOtherPath , "origin" , "master" ) )
2023-01-17 21:46:03 +00:00
t . Run ( "DeleteOtherRepository" , doAPIDeleteRepository ( otherCtxWithDeleteRepo ) )
2019-02-03 23:56:53 +00:00
2023-01-17 21:46:03 +00:00
t . Run ( "RecreateRepository" , doAPICreateRepository ( ctxWithDeleteRepo , false ) )
2019-02-03 23:56:53 +00:00
t . Run ( "CreateUserKey" , doAPICreateUserKey ( ctx , keyname , keyFile , func ( t * testing . T , publicKey api . PublicKey ) {
userKeyPublicKeyID = publicKey . ID
} ) )
2022-09-04 15:14:53 +00:00
dstPath := t . TempDir ( )
2019-02-03 23:56:53 +00:00
sshURL := createSSHUrl ( ctx . GitPath ( ) , u )
t . Run ( "Clone" , doGitClone ( dstPath , sshURL ) )
t . Run ( "AddChanges" , doAddChangesToCheckout ( dstPath , "CHANGES1.md" ) )
t . Run ( "Push" , doGitPushTestRepository ( dstPath , "origin" , "master" ) )
} )
t . Run ( " DeleteUserKeyShouldRemoveAbilityToClone " , func ( t * testing . T ) {
sshURL := createSSHUrl ( ctx . GitPath ( ) , u )
t . Run ( "DeleteUserKey" , doAPIDeleteUserKey ( ctx , userKeyPublicKeyID ) )
2020-04-28 08:32:23 +00:00
t . Run ( "FailToClone" , doGitCloneFail ( sshURL ) )
2019-02-03 23:56:53 +00:00
} )
} )
}