2020-05-12 01:04:08 +03:00
// Copyright 2020 The Gitea Authors. All rights reserved.
2022-11-27 21:20:29 +03:00
// SPDX-License-Identifier: MIT
2020-05-12 01:04:08 +03:00
2022-09-02 22:18:23 +03:00
package integration
2020-05-12 01:04:08 +03:00
import (
"net/url"
"strings"
"testing"
2023-01-18 00:46:03 +03:00
auth_model "code.gitea.io/gitea/models/auth"
2023-10-03 13:30:41 +03:00
"code.gitea.io/gitea/models/db"
2022-03-29 09:29:02 +03:00
"code.gitea.io/gitea/models/organization"
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"
2020-05-12 01:04:08 +03:00
api "code.gitea.io/gitea/modules/structs"
2021-11-17 15:34:35 +03:00
2020-05-12 01:04:08 +03:00
"github.com/stretchr/testify/assert"
)
func TestOrgCounts ( t * testing . T ) {
onGiteaRun ( t , testOrgCounts )
}
func testOrgCounts ( t * testing . T , u * url . URL ) {
orgOwner := "user2"
orgName := "testOrg"
orgCollaborator := "user4"
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
ctx := NewAPITestContext ( t , orgOwner , "repo1" , auth_model . AccessTokenScopeWriteOrganization )
2020-05-12 01:04:08 +03:00
var ownerCountRepos map [ string ] int
var collabCountRepos map [ string ] int
t . Run ( "GetTheOwnersNumRepos" , doCheckOrgCounts ( orgOwner , map [ string ] int { } ,
false ,
func ( _ * testing . T , calcOrgCounts map [ string ] int ) {
ownerCountRepos = calcOrgCounts
} ,
) )
t . Run ( "GetTheCollaboratorsNumRepos" , doCheckOrgCounts ( orgCollaborator , map [ string ] int { } ,
false ,
func ( _ * testing . T , calcOrgCounts map [ string ] int ) {
collabCountRepos = calcOrgCounts
} ,
) )
t . Run ( "CreatePublicTestOrganization" , doAPICreateOrganization ( ctx , & api . CreateOrgOption {
UserName : orgName ,
Visibility : "public" ,
} ) )
// Following the creation of the organization, the orgName must appear in the counts with 0 repos
ownerCountRepos [ orgName ] = 0
t . Run ( "AssertNumRepos0ForTestOrg" , doCheckOrgCounts ( orgOwner , ownerCountRepos , true ) )
// the collaborator is not a collaborator yet
t . Run ( "AssertNoTestOrgReposForCollaborator" , doCheckOrgCounts ( orgCollaborator , collabCountRepos , true ) )
t . Run ( "CreateOrganizationPrivateRepo" , doAPICreateOrganizationRepository ( ctx , orgName , & api . CreateRepoOption {
Name : "privateTestRepo" ,
AutoInit : true ,
Private : true ,
} ) )
ownerCountRepos [ orgName ] = 1
t . Run ( "AssertNumRepos1ForTestOrg" , doCheckOrgCounts ( orgOwner , ownerCountRepos , true ) )
t . Run ( "AssertNoTestOrgReposForCollaborator" , doCheckOrgCounts ( orgCollaborator , collabCountRepos , true ) )
var testTeam api . Team
t . Run ( "CreateTeamForPublicTestOrganization" , doAPICreateOrganizationTeam ( ctx , orgName , & api . CreateTeamOption {
Name : "test" ,
Permission : "read" ,
Units : [ ] string { "repo.code" , "repo.issues" , "repo.wiki" , "repo.pulls" , "repo.releases" } ,
CanCreateOrgRepo : true ,
} , func ( _ * testing . T , team api . Team ) {
testTeam = team
} ) )
t . Run ( "AssertNoTestOrgReposForCollaborator" , doCheckOrgCounts ( orgCollaborator , collabCountRepos , true ) )
t . Run ( "AddCollboratorToTeam" , doAPIAddUserToOrganizationTeam ( ctx , testTeam . ID , orgCollaborator ) )
collabCountRepos [ orgName ] = 0
t . Run ( "AssertNumRepos0ForTestOrgForCollaborator" , doCheckOrgCounts ( orgOwner , ownerCountRepos , true ) )
// Now create a Public Repo
t . Run ( "CreateOrganizationPublicRepo" , doAPICreateOrganizationRepository ( ctx , orgName , & api . CreateRepoOption {
Name : "publicTestRepo" ,
AutoInit : true ,
} ) )
ownerCountRepos [ orgName ] = 2
t . Run ( "AssertNumRepos2ForTestOrg" , doCheckOrgCounts ( orgOwner , ownerCountRepos , true ) )
collabCountRepos [ orgName ] = 1
t . Run ( "AssertNumRepos1ForTestOrgForCollaborator" , doCheckOrgCounts ( orgOwner , ownerCountRepos , true ) )
// Now add the testTeam to the privateRepo
t . Run ( "AddTestTeamToPrivateRepo" , doAPIAddRepoToOrganizationTeam ( ctx , testTeam . ID , orgName , "privateTestRepo" ) )
t . Run ( "AssertNumRepos2ForTestOrg" , doCheckOrgCounts ( orgOwner , ownerCountRepos , true ) )
collabCountRepos [ orgName ] = 2
t . Run ( "AssertNumRepos2ForTestOrgForCollaborator" , doCheckOrgCounts ( orgOwner , ownerCountRepos , true ) )
}
func doCheckOrgCounts ( username string , orgCounts map [ string ] int , strict bool , callback ... func ( * testing . T , map [ string ] int ) ) func ( t * testing . T ) {
canonicalCounts := make ( map [ string ] int , len ( orgCounts ) )
for key , value := range orgCounts {
newKey := strings . TrimSpace ( strings . ToLower ( key ) )
canonicalCounts [ newKey ] = value
}
return func ( t * testing . T ) {
2021-11-24 12:49:20 +03:00
user := unittest . AssertExistsAndLoadBean ( t , & user_model . User {
2020-05-12 01:04:08 +03:00
Name : username ,
2022-08-16 05:22:25 +03:00
} )
2020-05-12 01:04:08 +03:00
2023-11-24 06:49:41 +03:00
orgs , err := db . Find [ organization . Organization ] ( db . DefaultContext , organization . FindOrgOptions {
2021-11-22 16:51:45 +03:00
UserID : user . ID ,
IncludePrivate : true ,
} )
2021-06-18 20:00:53 +03:00
assert . NoError ( t , err )
2020-05-12 01:04:08 +03:00
calcOrgCounts := map [ string ] int { }
2021-06-18 20:00:53 +03:00
for _ , org := range orgs {
2020-05-12 01:04:08 +03:00
calcOrgCounts [ org . LowerName ] = org . NumRepos
count , ok := canonicalCounts [ org . LowerName ]
if ok {
assert . True ( t , count == org . NumRepos , "Number of Repos in %s is %d when we expected %d" , org . Name , org . NumRepos , count )
} else {
assert . False ( t , strict , "Did not expect to see %s with count %d" , org . Name , org . NumRepos )
}
}
for key , value := range orgCounts {
_ , seen := calcOrgCounts [ strings . TrimSpace ( strings . ToLower ( key ) ) ]
assert . True ( t , seen , "Expected to see %s with %d but did not" , key , value )
}
if len ( callback ) > 0 {
callback [ 0 ] ( t , calcOrgCounts )
}
}
}