Modern Docker Management, Designed for Everyone
Go composecontainer-managementcontainersdockerdocker-composedocker-managementgoself-hostedsveltekittypescriptweb-ui
fix: restrict git repository management to admins and block credential reuse on URL changes (#2504)
Kyle Mendell7722068e5a43
diff --git a/backend/internal/huma/handlers/git_repositories.go b/backend/internal/huma/handlers/git_repositories.goindex 1270585da..7728752ff 100644--- a/backend/internal/huma/handlers/git_repositories.go+++ b/backend/internal/huma/handlers/git_repositories.go@@ -273,6 +273,10 @@ func (h *GitRepositoryHandler) CreateRepository(ctx context.Context, input *Creareturn nil, huma.Error500InternalServerError("service not available")}+ if err := checkAdmin(ctx); err != nil {+ return nil, err+ }+actor := models.User{}if currentUser, exists := humamw.GetCurrentUserFromContext(ctx); exists && currentUser != nil {actor = *currentUser@@ -328,6 +332,10 @@ func (h *GitRepositoryHandler) UpdateRepository(ctx context.Context, input *Updareturn nil, huma.Error500InternalServerError("service not available")}+ if err := checkAdmin(ctx); err != nil {+ return nil, err+ }+actor := models.User{}if currentUser, exists := humamw.GetCurrentUserFromContext(ctx); exists && currentUser != nil {actor = *currentUser@@ -358,6 +366,10 @@ func (h *GitRepositoryHandler) DeleteRepository(ctx context.Context, input *Delereturn nil, huma.Error500InternalServerError("service not available")}+ if err := checkAdmin(ctx); err != nil {+ return nil, err+ }+actor := models.User{}if currentUser, exists := humamw.GetCurrentUserFromContext(ctx); exists && currentUser != nil {actor = *currentUser@@ -384,6 +396,10 @@ func (h *GitRepositoryHandler) TestRepository(ctx context.Context, input *TestGireturn nil, huma.Error500InternalServerError("service not available")}+ if err := checkAdmin(ctx); err != nil {+ return nil, err+ }+actor := models.User{}if currentUser, exists := humamw.GetCurrentUserFromContext(ctx); exists && currentUser != nil {actor = *currentUserdiff --git a/backend/internal/huma/handlers/git_repositories_test.go b/backend/internal/huma/handlers/git_repositories_test.gonew file mode 100644index 000000000..73694452c--- /dev/null+++ b/backend/internal/huma/handlers/git_repositories_test.go@@ -0,0 +1,61 @@+package handlers++import (+ "context"+ "net/http"+ "testing"++ "github.com/danielgtaylor/huma/v2"+ "github.com/getarcaneapp/arcane/backend/internal/services"+ "github.com/stretchr/testify/require"+)++func TestGitRepositoryHandlers_RequireAdmin(t *testing.T) {+ handler := &GitRepositoryHandler{repoService: &services.GitRepositoryService{}}++ tests := []struct {+ name string+ call func() error+ }{+ {+ name: "create repository",+ call: func() error {+ _, err := handler.CreateRepository(context.Background(), &CreateGitRepositoryInput{})+ return err+ },+ },+ {+ name: "update repository",+ call: func() error {+ _, err := handler.UpdateRepository(context.Background(), &UpdateGitRepositoryInput{ID: "repo-1"})+ return err+ },+ },+ {+ name: "delete repository",+ call: func() error {+ _, err := handler.DeleteRepository(context.Background(), &DeleteGitRepositoryInput{ID: "repo-1"})+ return err+ },+ },+ {+ name: "test repository",+ call: func() error {+ _, err := handler.TestRepository(context.Background(), &TestGitRepositoryInput{ID: "repo-1", Branch: "main"})+ return err+ },+ },+ }++ for _, tt := range tests {+ t.Run(tt.name, func(t *testing.T) {+ err := tt.call()+ require.Error(t, err)++ var statusErr huma.StatusError+ require.ErrorAs(t, err, &statusErr)+ require.Equal(t, http.StatusForbidden, statusErr.GetStatus())+ require.Contains(t, statusErr.Error(), "admin access required")+ })+ }+}diff --git a/backend/internal/services/git_repository_service.go b/backend/internal/services/git_repository_service.goindex 6228fa925..e17d693c7 100644--- a/backend/internal/services/git_repository_service.go+++ b/backend/internal/services/git_repository_service.go@@ -182,6 +182,10 @@ func (s *GitRepositoryService) UpdateRepository(ctx context.Context, id string,return nil, err}+ if err := validateGitRepositoryCredentialChangeInternal(repository, req); err != nil {+ return nil, err+ }+updates := make(map[string]any)if req.Name != nil {@@ -252,6 +256,42 @@ func (s *GitRepositoryService) UpdateRepository(ctx context.Context, id string,return s.GetRepositoryByID(ctx, id)}+func validateGitRepositoryCredentialChangeInternal(repository *models.GitRepository, req models.UpdateGitRepositoryRequest) error {+ if repository == nil || req.URL == nil || *req.URL == repository.URL {+ return nil+ }++ missingFields := make([]string, 0, 2)+ missingCredentialLabels := make([]string, 0, 2)++ if repository.Token != "" && req.Token == nil {+ missingFields = append(missingFields, "token")+ missingCredentialLabels = append(missingCredentialLabels, "token")+ }++ if repository.SSHKey != "" && req.SSHKey == nil {+ missingFields = append(missingFields, "sshKey")+ missingCredentialLabels = append(missingCredentialLabels, "SSH key")+ }++ if len(missingFields) == 0 {+ return nil+ }++ if len(missingFields) == 1 {+ field := missingFields[0]+ return &models.ValidationError{Field: field, Message: fmt.Sprintf("Changing repository URL requires re-supplying or clearing the %s", missingCredentialLabels[0])}+ }++ return models.NewValidationError(+ fmt.Sprintf(+ "Changing repository URL requires re-supplying or clearing all stored credentials: %s",+ strings.Join(missingCredentialLabels, " and "),+ ),+ map[string]any{"fields": missingFields},+ )+}+func (s *GitRepositoryService) DeleteRepository(ctx context.Context, id string, actor models.User) error {// Check if repository is used by any syncsvar count int64diff --git a/backend/internal/services/git_repository_service_test.go b/backend/internal/services/git_repository_service_test.gonew file mode 100644index 000000000..007dcb4ec--- /dev/null+++ b/backend/internal/services/git_repository_service_test.go@@ -0,0 +1,203 @@+package services++import (+ "context"+ "fmt"+ "strings"+ "testing"++ glsqlite "github.com/glebarez/sqlite"+ "github.com/stretchr/testify/assert"+ "github.com/stretchr/testify/require"+ "gorm.io/gorm"++ "github.com/getarcaneapp/arcane/backend/internal/config"+ "github.com/getarcaneapp/arcane/backend/internal/database"+ "github.com/getarcaneapp/arcane/backend/internal/models"+ "github.com/getarcaneapp/arcane/backend/pkg/libarcane/crypto"+)++func setupGitRepositoryServiceTestInternal(t *testing.T) (*GitRepositoryService, *database.DB) {+ t.Helper()++ dsn := fmt.Sprintf("file:%s?mode=memory&cache=shared", strings.NewReplacer("/", "_", " ", "_").Replace(t.Name()))+ db, err := gorm.Open(glsqlite.Open(dsn), &gorm.Config{})+ require.NoError(t, err)+ require.NoError(t, db.AutoMigrate(+ &models.GitRepository{},+ &models.GitOpsSync{},+ &models.Event{},+ &models.SettingVariable{},+ ))++ sqlDB, err := db.DB()+ require.NoError(t, err)+ sqlDB.SetMaxOpenConns(1)+ sqlDB.SetMaxIdleConns(1)++ crypto.InitEncryption(&crypto.Config{+ EncryptionKey: "test-encryption-key-for-git-repos-32bytes-min",+ Environment: "test",+ })++ wrappedDB := &database.DB{DB: db}+ settingsService, err := NewSettingsService(context.Background(), wrappedDB)+ require.NoError(t, err)++ eventService := NewEventService(wrappedDB, &config.Config{}, nil)++ return NewGitRepositoryService(wrappedDB, t.TempDir(), eventService, settingsService), wrappedDB+}++func createGitRepositoryServiceTestRepoInternal(t *testing.T, svc *GitRepositoryService, req models.CreateGitRepositoryRequest) *models.GitRepository {+ t.Helper()++ repo, err := svc.CreateRepository(context.Background(), req, models.User{+ BaseModel: models.BaseModel{ID: "admin-1"},+ Username: "admin",+ })+ require.NoError(t, err)+ return repo+}++func gitRepositoryStringPtrInternal(value string) *string {+ return &value+}++func TestGitRepositoryService_UpdateRepository_RejectsURLChangeWhenStoredTokenWouldBeReused(t *testing.T) {+ svc, _ := setupGitRepositoryServiceTestInternal(t)+ repo := createGitRepositoryServiceTestRepoInternal(t, svc, models.CreateGitRepositoryRequest{+ Name: "prod-repo",+ URL: "https://github.com/acme/private.git",+ AuthType: "http",+ Username: "deploy",+ Token: "ghp_old_token",+ })++ _, err := svc.UpdateRepository(context.Background(), repo.ID, models.UpdateGitRepositoryRequest{+ URL: gitRepositoryStringPtrInternal("https://attacker.tld/repo.git"),+ }, models.User{})+ require.Error(t, err)++ var validationErr *models.ValidationError+ require.ErrorAs(t, err, &validationErr)+ assert.Equal(t, "token", validationErr.Field)+ assert.Contains(t, validationErr.Message, "re-supplying or clearing the token")++ stored, loadErr := svc.GetRepositoryByID(context.Background(), repo.ID)+ require.NoError(t, loadErr)+ assert.Equal(t, "https://github.com/acme/private.git", stored.URL)+ assert.Equal(t, repo.Token, stored.Token)+}++func TestGitRepositoryService_UpdateRepository_RejectsURLChangeWhenStoredSSHKeyWouldBeReused(t *testing.T) {+ svc, _ := setupGitRepositoryServiceTestInternal(t)+ repo := createGitRepositoryServiceTestRepoInternal(t, svc, models.CreateGitRepositoryRequest{+ Name: "infra-repo",+ URL: "[email protected]:acme/private.git",+ AuthType: "ssh",+ SSHKey: "-----BEGIN OPENSSH PRIVATE KEY-----\nkey-material\n-----END OPENSSH PRIVATE KEY-----",+ })++ _, err := svc.UpdateRepository(context.Background(), repo.ID, models.UpdateGitRepositoryRequest{+ URL: gitRepositoryStringPtrInternal("[email protected]:acme/private.git"),+ }, models.User{})+ require.Error(t, err)++ var validationErr *models.ValidationError+ require.ErrorAs(t, err, &validationErr)+ assert.Equal(t, "sshKey", validationErr.Field)+ assert.Contains(t, validationErr.Message, "re-supplying or clearing the SSH key")++ stored, loadErr := svc.GetRepositoryByID(context.Background(), repo.ID)+ require.NoError(t, loadErr)+ assert.Equal(t, "[email protected]:acme/private.git", stored.URL)+ assert.Equal(t, repo.SSHKey, stored.SSHKey)+}++func TestGitRepositoryService_UpdateRepository_RejectsURLChangeWhenStoredTokenAndSSHKeyWouldBeReused(t *testing.T) {+ svc, _ := setupGitRepositoryServiceTestInternal(t)+ repo := createGitRepositoryServiceTestRepoInternal(t, svc, models.CreateGitRepositoryRequest{+ Name: "hybrid-repo",+ URL: "https://github.com/acme/private.git",+ AuthType: "http",+ Username: "deploy",+ Token: "ghp_old_token",+ SSHKey: "-----BEGIN OPENSSH PRIVATE KEY-----\nkey-material\n-----END OPENSSH PRIVATE KEY-----",+ })++ _, err := svc.UpdateRepository(context.Background(), repo.ID, models.UpdateGitRepositoryRequest{+ URL: gitRepositoryStringPtrInternal("https://attacker.tld/repo.git"),+ }, models.User{})+ require.Error(t, err)++ var apiErr *models.APIError+ require.ErrorAs(t, err, &apiErr)+ assert.Equal(t, models.APIErrorCodeValidationError, apiErr.Code)+ assert.Contains(t, apiErr.Message, "token and SSH key")+ assert.Equal(t, map[string]any{"fields": []string{"token", "sshKey"}}, apiErr.Details)+}++func TestGitRepositoryService_UpdateRepository_AllowsURLChangeWhenTokenIsResupplied(t *testing.T) {+ svc, _ := setupGitRepositoryServiceTestInternal(t)+ repo := createGitRepositoryServiceTestRepoInternal(t, svc, models.CreateGitRepositoryRequest{+ Name: "prod-repo",+ URL: "https://github.com/acme/private.git",+ AuthType: "http",+ Username: "deploy",+ Token: "ghp_old_token",+ })++ updated, err := svc.UpdateRepository(context.Background(), repo.ID, models.UpdateGitRepositoryRequest{+ URL: gitRepositoryStringPtrInternal("https://github.com/acme/private-rotated.git"),+ Token: gitRepositoryStringPtrInternal("ghp_new_token"),+ }, models.User{})+ require.NoError(t, err)++ assert.Equal(t, "https://github.com/acme/private-rotated.git", updated.URL)+ decryptedToken, decryptErr := crypto.Decrypt(updated.Token)+ require.NoError(t, decryptErr)+ assert.Equal(t, "ghp_new_token", decryptedToken)+}++func TestGitRepositoryService_UpdateRepository_AllowsURLChangeWhenTokenIsCleared(t *testing.T) {+ svc, _ := setupGitRepositoryServiceTestInternal(t)+ repo := createGitRepositoryServiceTestRepoInternal(t, svc, models.CreateGitRepositoryRequest{+ Name: "prod-repo",+ URL: "https://github.com/acme/private.git",+ AuthType: "http",+ Username: "deploy",+ Token: "ghp_old_token",+ })++ updated, err := svc.UpdateRepository(context.Background(), repo.ID, models.UpdateGitRepositoryRequest{+ URL: gitRepositoryStringPtrInternal("https://github.com/acme/public.git"),+ Token: gitRepositoryStringPtrInternal(""),+ }, models.User{})+ require.NoError(t, err)++ assert.Equal(t, "https://github.com/acme/public.git", updated.URL)+ assert.Empty(t, updated.Token)+}++func TestGitRepositoryService_UpdateRepository_AllowsSameURLWithoutCredentialResupply(t *testing.T) {+ svc, _ := setupGitRepositoryServiceTestInternal(t)+ repo := createGitRepositoryServiceTestRepoInternal(t, svc, models.CreateGitRepositoryRequest{+ Name: "prod-repo",+ URL: "https://github.com/acme/private.git",+ AuthType: "http",+ Username: "deploy",+ Token: "ghp_old_token",+ })++ updated, err := svc.UpdateRepository(context.Background(), repo.ID, models.UpdateGitRepositoryRequest{+ URL: gitRepositoryStringPtrInternal("https://github.com/acme/private.git"),+ Username: gitRepositoryStringPtrInternal("deploy-bot"),+ }, models.User{})+ require.NoError(t, err)++ assert.Equal(t, "deploy-bot", updated.Username)+ decryptedToken, decryptErr := crypto.Decrypt(updated.Token)+ require.NoError(t, decryptErr)+ assert.Equal(t, "ghp_old_token", decryptedToken)+}