mirror of
https://github.com/go-gitea/gitea
synced 2024-08-27 01:32:53 +02:00
This PR adds the support for scopes of access tokens, mimicking the design of GitHub OAuth scopes. The changes of the core logic are in `models/auth` that `AccessToken` struct will have a `Scope` field. The normalized (no duplication of scope), comma-separated scope string will be stored in `access_token` table in the database. In `services/auth`, the scope will be stored in context, which will be used by `reqToken` middleware in API calls. Only OAuth2 tokens will have granular token scopes, while others like BasicAuth will default to scope `all`. A large amount of work happens in `routers/api/v1/api.go` and the corresponding `tests/integration` tests, that is adding necessary scopes to each of the API calls as they fit. - [x] Add `Scope` field to `AccessToken` - [x] Add access control to all API endpoints - [x] Update frontend & backend for when creating tokens - [x] Add a database migration for `scope` column (enable 'all' access to past tokens) I'm aiming to complete it before Gitea 1.19 release. Fixes #4300
207 lines
6.7 KiB
Go
207 lines
6.7 KiB
Go
// Copyright 2019 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package integration
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
"net/url"
|
|
"os"
|
|
"path/filepath"
|
|
"testing"
|
|
"time"
|
|
|
|
auth_model "code.gitea.io/gitea/models/auth"
|
|
"code.gitea.io/gitea/modules/git"
|
|
api "code.gitea.io/gitea/modules/structs"
|
|
|
|
"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) {
|
|
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())), 0o644))
|
|
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
|
|
ctx := NewAPITestContext(t, "user2", "deploy-key-empty-repo-1", auth_model.AccessTokenScopeRepo)
|
|
ctxWithDeleteRepo := NewAPITestContext(t, "user2", "deploy-key-empty-repo-1", auth_model.AccessTokenScopeRepo, auth_model.AccessTokenScopeDeleteRepo)
|
|
|
|
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
|
|
dstPath := t.TempDir()
|
|
|
|
t.Run("InitTestRepository", doGitInitTestRepository(dstPath))
|
|
|
|
// Setup remote link
|
|
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))
|
|
|
|
t.Run("DeleteRepository", doAPIDeleteRepository(ctxWithDeleteRepo))
|
|
})
|
|
}
|
|
|
|
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
|
|
ctx := NewAPITestContext(t, username, reponame, auth_model.AccessTokenScopeRepo, auth_model.AccessTokenScopeAdminPublicKey)
|
|
ctxWithDeleteRepo := NewAPITestContext(t, username, reponame, auth_model.AccessTokenScopeRepo, auth_model.AccessTokenScopeAdminPublicKey, auth_model.AccessTokenScopeDeleteRepo)
|
|
|
|
otherCtx := ctx
|
|
otherCtx.Reponame = "ssh-key-test-repo-2"
|
|
otherCtxWithDeleteRepo := ctxWithDeleteRepo
|
|
otherCtxWithDeleteRepo.Reponame = otherCtx.Reponame
|
|
|
|
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) {
|
|
dstPath := t.TempDir()
|
|
|
|
sshURL := createSSHUrl(ctx.GitPath(), u)
|
|
|
|
t.Run("FailToClone", doGitCloneFail(sshURL))
|
|
|
|
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) {
|
|
dstPath := t.TempDir()
|
|
|
|
sshURL := createSSHUrl(ctx.GitPath(), u)
|
|
|
|
t.Run("FailToClone", doGitCloneFail(sshURL))
|
|
|
|
// 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)
|
|
dstOtherPath := t.TempDir()
|
|
|
|
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)
|
|
dstOtherPath := t.TempDir()
|
|
|
|
t.Run("DeleteRepository", doAPIDeleteRepository(ctxWithDeleteRepo))
|
|
|
|
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"))
|
|
|
|
t.Run("DeleteOtherRepository", doAPIDeleteRepository(otherCtxWithDeleteRepo))
|
|
|
|
t.Run("RecreateRepository", doAPICreateRepository(ctxWithDeleteRepo, false))
|
|
|
|
t.Run("CreateUserKey", doAPICreateUserKey(ctx, keyname, keyFile, func(t *testing.T, publicKey api.PublicKey) {
|
|
userKeyPublicKeyID = publicKey.ID
|
|
}))
|
|
|
|
dstPath := t.TempDir()
|
|
|
|
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))
|
|
|
|
t.Run("FailToClone", doGitCloneFail(sshURL))
|
|
})
|
|
})
|
|
}
|