mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-12-25 00:44:15 -05:00
de484e86bc
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
197 lines
6.9 KiB
Go
197 lines
6.9 KiB
Go
// Copyright 2019 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package integration
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
"testing"
|
|
|
|
auth_model "code.gitea.io/gitea/models/auth"
|
|
repo_model "code.gitea.io/gitea/models/repo"
|
|
"code.gitea.io/gitea/models/unittest"
|
|
user_model "code.gitea.io/gitea/models/user"
|
|
api "code.gitea.io/gitea/modules/structs"
|
|
"code.gitea.io/gitea/tests"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
const testHookContent = `#!/bin/bash
|
|
|
|
echo Hello, World!
|
|
`
|
|
|
|
func TestAPIListGitHooks(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 37})
|
|
owner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID})
|
|
|
|
// user1 is an admin user
|
|
session := loginUser(t, "user1")
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeReadRepoHook)
|
|
req := NewRequestf(t, "GET", "/api/v1/repos/%s/%s/hooks/git?token=%s",
|
|
owner.Name, repo.Name, token)
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
var apiGitHooks []*api.GitHook
|
|
DecodeJSON(t, resp, &apiGitHooks)
|
|
assert.Len(t, apiGitHooks, 3)
|
|
for _, apiGitHook := range apiGitHooks {
|
|
if apiGitHook.Name == "pre-receive" {
|
|
assert.True(t, apiGitHook.IsActive)
|
|
assert.Equal(t, testHookContent, apiGitHook.Content)
|
|
} else {
|
|
assert.False(t, apiGitHook.IsActive)
|
|
assert.Empty(t, apiGitHook.Content)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestAPIListGitHooksNoHooks(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 1})
|
|
owner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID})
|
|
|
|
// user1 is an admin user
|
|
session := loginUser(t, "user1")
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeReadRepoHook)
|
|
req := NewRequestf(t, "GET", "/api/v1/repos/%s/%s/hooks/git?token=%s",
|
|
owner.Name, repo.Name, token)
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
var apiGitHooks []*api.GitHook
|
|
DecodeJSON(t, resp, &apiGitHooks)
|
|
assert.Len(t, apiGitHooks, 3)
|
|
for _, apiGitHook := range apiGitHooks {
|
|
assert.False(t, apiGitHook.IsActive)
|
|
assert.Empty(t, apiGitHook.Content)
|
|
}
|
|
}
|
|
|
|
func TestAPIListGitHooksNoAccess(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 1})
|
|
owner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID})
|
|
|
|
session := loginUser(t, owner.Name)
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeReadRepoHook)
|
|
req := NewRequestf(t, "GET", "/api/v1/repos/%s/%s/hooks/git?token=%s",
|
|
owner.Name, repo.Name, token)
|
|
MakeRequest(t, req, http.StatusForbidden)
|
|
}
|
|
|
|
func TestAPIGetGitHook(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 37})
|
|
owner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID})
|
|
|
|
// user1 is an admin user
|
|
session := loginUser(t, "user1")
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeReadRepoHook)
|
|
req := NewRequestf(t, "GET", "/api/v1/repos/%s/%s/hooks/git/pre-receive?token=%s",
|
|
owner.Name, repo.Name, token)
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
var apiGitHook *api.GitHook
|
|
DecodeJSON(t, resp, &apiGitHook)
|
|
assert.True(t, apiGitHook.IsActive)
|
|
assert.Equal(t, testHookContent, apiGitHook.Content)
|
|
}
|
|
|
|
func TestAPIGetGitHookNoAccess(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 1})
|
|
owner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID})
|
|
|
|
session := loginUser(t, owner.Name)
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeReadRepoHook)
|
|
req := NewRequestf(t, "GET", "/api/v1/repos/%s/%s/hooks/git/pre-receive?token=%s",
|
|
owner.Name, repo.Name, token)
|
|
MakeRequest(t, req, http.StatusForbidden)
|
|
}
|
|
|
|
func TestAPIEditGitHook(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 1})
|
|
owner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID})
|
|
|
|
// user1 is an admin user
|
|
session := loginUser(t, "user1")
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeAdminRepoHook)
|
|
|
|
urlStr := fmt.Sprintf("/api/v1/repos/%s/%s/hooks/git/pre-receive?token=%s",
|
|
owner.Name, repo.Name, token)
|
|
req := NewRequestWithJSON(t, "PATCH", urlStr, &api.EditGitHookOption{
|
|
Content: testHookContent,
|
|
})
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
var apiGitHook *api.GitHook
|
|
DecodeJSON(t, resp, &apiGitHook)
|
|
assert.True(t, apiGitHook.IsActive)
|
|
assert.Equal(t, testHookContent, apiGitHook.Content)
|
|
|
|
req = NewRequestf(t, "GET", "/api/v1/repos/%s/%s/hooks/git/pre-receive?token=%s",
|
|
owner.Name, repo.Name, token)
|
|
resp = MakeRequest(t, req, http.StatusOK)
|
|
var apiGitHook2 *api.GitHook
|
|
DecodeJSON(t, resp, &apiGitHook2)
|
|
assert.True(t, apiGitHook2.IsActive)
|
|
assert.Equal(t, testHookContent, apiGitHook2.Content)
|
|
}
|
|
|
|
func TestAPIEditGitHookNoAccess(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 1})
|
|
owner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID})
|
|
|
|
session := loginUser(t, owner.Name)
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteRepoHook)
|
|
urlStr := fmt.Sprintf("/api/v1/repos/%s/%s/hooks/git/pre-receive?token=%s",
|
|
owner.Name, repo.Name, token)
|
|
req := NewRequestWithJSON(t, "PATCH", urlStr, &api.EditGitHookOption{
|
|
Content: testHookContent,
|
|
})
|
|
MakeRequest(t, req, http.StatusForbidden)
|
|
}
|
|
|
|
func TestAPIDeleteGitHook(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 37})
|
|
owner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID})
|
|
|
|
// user1 is an admin user
|
|
session := loginUser(t, "user1")
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeAdminRepoHook)
|
|
|
|
req := NewRequestf(t, "DELETE", "/api/v1/repos/%s/%s/hooks/git/pre-receive?token=%s",
|
|
owner.Name, repo.Name, token)
|
|
MakeRequest(t, req, http.StatusNoContent)
|
|
|
|
req = NewRequestf(t, "GET", "/api/v1/repos/%s/%s/hooks/git/pre-receive?token=%s",
|
|
owner.Name, repo.Name, token)
|
|
resp := MakeRequest(t, req, http.StatusOK)
|
|
var apiGitHook2 *api.GitHook
|
|
DecodeJSON(t, resp, &apiGitHook2)
|
|
assert.False(t, apiGitHook2.IsActive)
|
|
assert.Empty(t, apiGitHook2.Content)
|
|
}
|
|
|
|
func TestAPIDeleteGitHookNoAccess(t *testing.T) {
|
|
defer tests.PrepareTestEnv(t)()
|
|
|
|
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 1})
|
|
owner := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: repo.OwnerID})
|
|
|
|
session := loginUser(t, owner.Name)
|
|
token := getTokenForLoggedInUser(t, session, auth_model.AccessTokenScopeWriteRepoHook)
|
|
req := NewRequestf(t, "DELETE", "/api/v1/repos/%s/%s/hooks/git/pre-receive?token=%s",
|
|
owner.Name, repo.Name, token)
|
|
MakeRequest(t, req, http.StatusForbidden)
|
|
}
|