Skip to content

Modern Docker Management, Designed for Everyone

fix: allow saving compose files with includes outside the project directory (#3556)

Kyle Mendell60d5e73e895f
diff --git a/backend/internal/project/project_update.go b/backend/internal/project/project_update.go
index ce14c6107..59c98c36c 100644
--- a/backend/internal/project/project_update.go
+++ b/backend/internal/project/project_update.go
@@ -522,22 +522,14 @@ func validateComposeContentForUpdate(ctx context.Context, projectsDirectory, pro
return envErr
}
- if err := projects.ValidateIncludePathsForContent(projectPath, composeContent, fullEnvMap); err != nil {
- return err
- }
-
validationProjectName := projects.NormalizeProjectName(projectName)
configFiles := []composetypes.ConfigFile{
{Filename: filepath.Join(projectPath, "compose.yaml"), Content: []byte(composeContent)},
}
// When an override is supplied, validate the *merged* config as `docker
- // compose` would deploy it. Overrides can add services and introduce their
- // own include: paths, so they get the same traversal check as the base and
- // are layered on top (listed after the base so the override wins).
+ // compose` would deploy it. Overrides can add services and are layered on
+ // top (listed after the base so the override wins).
if overrideContent != nil {
- if err := projects.ValidateIncludePathsForContent(projectPath, *overrideContent, fullEnvMap); err != nil {
- return err
- }
overrideName := strings.TrimSpace(overrideFileName)
if overrideName == "" {
overrideName = projects.DefaultComposeOverrideFileName
diff --git a/backend/internal/project/service_test.go b/backend/internal/project/service_test.go
index b226728e4..52d4c843d 100644
--- a/backend/internal/project/service_test.go
+++ b/backend/internal/project/service_test.go
@@ -2087,7 +2087,7 @@ services:
}
-func TestProjectService_CreateProject_RejectsExternalInclude(t *testing.T) {
+func TestProjectService_CreateProject_AllowsExternalInclude(t *testing.T) {
db := setupProjectTestDB(t)
ctx := context.Background()
@@ -2099,31 +2099,26 @@ func TestProjectService_CreateProject_RejectsExternalInclude(t *testing.T) {
eventService := event.NewEventService(db, nil, nil)
svc := NewProjectService(db, settingsService, eventService, nil, nil, nil, nil, nil, config.Load())
- require.NoError(t, os.WriteFile(filepath.Join(projectsDir, "metadata.yaml"), []byte("services: {}\n"), 0o644))
+ require.NoError(t, os.WriteFile(filepath.Join(projectsDir, "shared.yaml"), []byte("services: {}\n"), 0o644))
compose := `include:
- - ../metadata.yaml
+ - ../shared.yaml
services:
app:
image: nginx:alpine
`
- project, err := svc.CreateProject(ctx, "evil", compose, nil, projecttypes.CreateProjectWorkspaceManifest{}, nil, models.User{
+ project, err := svc.CreateProject(ctx, "with-external-include", compose, nil, projecttypes.CreateProjectWorkspaceManifest{}, nil, models.User{
BaseModel: models.BaseModel{ID: "u1"},
Username: "tester",
})
- require.Error(t, err)
- assert.Nil(t, project)
- assert.Contains(t, err.Error(), "invalid compose file")
- assert.NoDirExists(t, filepath.Join(projectsDir, "evil"))
- assert.FileExists(t, filepath.Join(projectsDir, "metadata.yaml"))
-
- var count int64
- require.NoError(t, db.Model(&models.Project{}).Where("name = ?", "evil").Count(&count).Error)
- assert.Zero(t, count)
+ require.NoError(t, err)
+ require.NotNil(t, project)
+ assert.DirExists(t, filepath.Join(projectsDir, "with-external-include"))
+ assert.FileExists(t, filepath.Join(projectsDir, "shared.yaml"))
}
-func TestProjectService_CreateProject_RejectsArrayPathInclude(t *testing.T) {
+func TestProjectService_UpdateProject_AllowsExternalInclude(t *testing.T) {
db := setupProjectTestDB(t)
ctx := context.Background()
@@ -2135,30 +2130,38 @@ func TestProjectService_CreateProject_RejectsArrayPathInclude(t *testing.T) {
eventService := event.NewEventService(db, nil, nil)
svc := NewProjectService(db, settingsService, eventService, nil, nil, nil, nil, nil, config.Load())
- require.NoError(t, os.WriteFile(filepath.Join(projectsDir, "metadata.yaml"), []byte("services: {}\n"), 0o644))
+
+ dirName := "external-include"
+ projectPath := filepath.Join(projectsDir, dirName)
+ require.NoError(t, os.MkdirAll(projectPath, 0o755))
+ require.NoError(t, os.WriteFile(filepath.Join(projectsDir, "shared.yaml"), []byte("services: {}\n"), 0o644))
+
+ project := &models.Project{
+ BaseModel: models.BaseModel{ID: "proj-external-include"},
+ Name: "external-include",
+ DirName: &dirName,
+ Path: projectPath,
+ Status: models.ProjectStatusStopped,
+ }
+ require.NoError(t, db.Create(project).Error)
+
+ user := models.User{BaseModel: models.BaseModel{ID: "u1"}, Username: "tester"}
compose := `include:
- - path:
- - ./local.yaml
- - ../metadata.yaml
+ - ../shared.yaml
services:
app:
image: nginx:alpine
`
+ updated, err := svc.UpdateProject(ctx, project.ID, nil, ptr(compose), nil, nil, user)
+ require.NoError(t, err)
+ require.NotNil(t, updated)
- project, err := svc.CreateProject(ctx, "evil-array", compose, nil, projecttypes.CreateProjectWorkspaceManifest{}, nil, models.User{
- BaseModel: models.BaseModel{ID: "u1"},
- Username: "tester",
- })
- require.Error(t, err)
- assert.Nil(t, project)
- assert.Contains(t, err.Error(), "invalid compose file")
- assert.NoDirExists(t, filepath.Join(projectsDir, "evil-array"))
- assert.FileExists(t, filepath.Join(projectsDir, "metadata.yaml"))
-
- var count int64
- require.NoError(t, db.Model(&models.Project{}).Where("name = ?", "evil-array").Count(&count).Error)
- assert.Zero(t, count)
+ override := `include:
+ - ../shared.yaml
+`
+ _, err = svc.UpdateProject(ctx, project.ID, nil, nil, nil, ptr(override), user)
+ require.NoError(t, err)
}
func TestProjectService_CreateProject_CommitsWorkspaceAndConfigurationTogether(t *testing.T) {
diff --git a/backend/pkg/projects/env_validation.go b/backend/pkg/projects/env_validation.go
index 56c7ced6d..742970f89 100644
--- a/backend/pkg/projects/env_validation.go
+++ b/backend/pkg/projects/env_validation.go
@@ -80,18 +80,3 @@ func ParseValidationEnvContent(content string, contextEnv EnvMap) (EnvMap, error
return envMap, nil
}
-
-// ValidateIncludePathsForContent rejects compose content whose includes resolve
-// outside the project directory.
-func ValidateIncludePathsForContent(projectPath, composeContent string, envMap EnvMap) error {
- includes, err := ParseIncludesFromContent(filepath.Join(projectPath, "compose.yaml"), []byte(composeContent), envMap, false)
- if err != nil {
- return err
- }
- for _, inc := range includes {
- if _, err := ValidateIncludePathForWrite(projectPath, inc.Path); err != nil {
- return errors.WrapIff(err, "include path %q is outside project directory", inc.RelativePath)
- }
- }
- return nil
-}