Skip to content

Modern Docker Management, Designed for Everyone

fix: add FILE_PERM and DIR_PERM env variables (#1334)

Kyle Mendell0be1977c0b8d
diff --git a/.env.example b/.env.example
index a3387ecce..5acdeeab7 100644
--- a/.env.example
+++ b/.env.example
@@ -12,6 +12,11 @@ APP_URL=https://your-domain.com
PUID=1000
PGID=1000
+# File and Directory Permissions (Octal)
+# Default: 0644 for files, 0755 for directories
+# FILE_PERM=0644
+# DIR_PERM=0755
+
# Security Settings
# IMPORTANT: Generate unique values for production!
ENCRYPTION_KEY=your-32-char-encryption-key-here
@@ -26,4 +31,4 @@ DATABASE_URL=file:data/arcane.db?_pragma=journal_mode(WAL)&_pragma=busy_timeout(
# Agent Configuration (optional)
# AGENT_MODE=true
-# AGENT_BOOTSTRAP_TOKEN=your-secure-bootstrap-token
\ No newline at end of file
+# AGENT_TOKEN=api-token
\ No newline at end of file
diff --git a/backend/internal/common/perms.go b/backend/internal/common/perms.go
new file mode 100644
index 000000000..9a5880223
--- /dev/null
+++ b/backend/internal/common/perms.go
@@ -0,0 +1,8 @@
+package common
+
+import "os"
+
+var (
+ FilePerm os.FileMode = 0644
+ DirPerm os.FileMode = 0755
+)
diff --git a/backend/internal/config/config.go b/backend/internal/config/config.go
index 5918b7177..dfbb80f5c 100644
--- a/backend/internal/config/config.go
+++ b/backend/internal/config/config.go
@@ -4,6 +4,8 @@ import (
"os"
"strconv"
"strings"
+
+ "github.com/getarcaneapp/arcane/backend/internal/common"
)
type AppEnvironment string
@@ -43,10 +45,13 @@ type Config struct {
AnalyticsDisabled bool
GPUMonitoringEnabled bool
GPUType string
+
+ FilePerm os.FileMode
+ DirPerm os.FileMode
}
func Load() *Config {
- return &Config{
+ cfg := &Config{
AppUrl: getEnvOrDefault("APP_URL", "http://localhost:3552"),
DatabaseURL: getEnvOrDefault("DATABASE_URL", defaultSqliteString),
Port: getEnvOrDefault("PORT", "3552"),
@@ -74,7 +79,15 @@ func Load() *Config {
AnalyticsDisabled: getBoolEnvOrDefault("ANALYTICS_DISABLED", false),
GPUMonitoringEnabled: getBoolEnvOrDefault("GPU_MONITORING_ENABLED", false),
GPUType: getEnvOrDefault("GPU_TYPE", "auto"),
+
+ FilePerm: getFileModeEnvOrDefault("FILE_PERM", 0644),
+ DirPerm: getFileModeEnvOrDefault("DIR_PERM", 0755),
}
+
+ common.FilePerm = cfg.FilePerm
+ common.DirPerm = cfg.DirPerm
+
+ return cfg
}
func getEnvOrDefault[T interface{ ~string }](key string, defaultValue T) T {
@@ -139,3 +152,13 @@ func getBoolEnvOrDefault(key string, defaultValue bool) bool {
}
return defaultValue
}
+
+func getFileModeEnvOrDefault(key string, defaultValue os.FileMode) os.FileMode {
+ if v, ok := os.LookupEnv(key); ok && v != "" {
+ v = trimQuotes(v)
+ if i, err := strconv.ParseUint(v, 8, 32); err == nil {
+ return os.FileMode(i)
+ }
+ }
+ return defaultValue
+}
diff --git a/backend/internal/config/config_test.go b/backend/internal/config/config_test.go
new file mode 100644
index 000000000..ec4a13d30
--- /dev/null
+++ b/backend/internal/config/config_test.go
@@ -0,0 +1,57 @@
+package config
+
+import (
+ "os"
+ "testing"
+
+ "github.com/getarcaneapp/arcane/backend/internal/common"
+ "github.com/stretchr/testify/assert"
+)
+
+func TestConfig_LoadPermissions(t *testing.T) {
+ // Save original env and common perms
+ origFilePerm := os.Getenv("FILE_PERM")
+ origDirPerm := os.Getenv("DIR_PERM")
+ origCommonFilePerm := common.FilePerm
+ origCommonDirPerm := common.DirPerm
+
+ defer func() {
+ os.Setenv("FILE_PERM", origFilePerm)
+ os.Setenv("DIR_PERM", origDirPerm)
+ common.FilePerm = origCommonFilePerm
+ common.DirPerm = origCommonDirPerm
+ }()
+
+ t.Run("Default permissions", func(t *testing.T) {
+ os.Unsetenv("FILE_PERM")
+ os.Unsetenv("DIR_PERM")
+
+ cfg := Load()
+ assert.Equal(t, os.FileMode(0644), cfg.FilePerm)
+ assert.Equal(t, os.FileMode(0755), cfg.DirPerm)
+ assert.Equal(t, os.FileMode(0644), common.FilePerm)
+ assert.Equal(t, os.FileMode(0755), common.DirPerm)
+ })
+
+ t.Run("Custom permissions", func(t *testing.T) {
+ os.Setenv("FILE_PERM", "0664")
+ os.Setenv("DIR_PERM", "0775")
+
+ cfg := Load()
+ assert.Equal(t, os.FileMode(0664), cfg.FilePerm)
+ assert.Equal(t, os.FileMode(0775), cfg.DirPerm)
+ assert.Equal(t, os.FileMode(0664), common.FilePerm)
+ assert.Equal(t, os.FileMode(0775), common.DirPerm)
+ })
+
+ t.Run("Restrictive permissions", func(t *testing.T) {
+ os.Setenv("FILE_PERM", "0600")
+ os.Setenv("DIR_PERM", "0700")
+
+ cfg := Load()
+ assert.Equal(t, os.FileMode(0600), cfg.FilePerm)
+ assert.Equal(t, os.FileMode(0700), cfg.DirPerm)
+ assert.Equal(t, os.FileMode(0600), common.FilePerm)
+ assert.Equal(t, os.FileMode(0700), common.DirPerm)
+ })
+}
diff --git a/backend/internal/services/project_service.go b/backend/internal/services/project_service.go
index 5799dca84..5c2488bf7 100644
--- a/backend/internal/services/project_service.go
+++ b/backend/internal/services/project_service.go
@@ -16,6 +16,7 @@ import (
composetypes "github.com/compose-spec/compose-go/v2/types"
"github.com/docker/compose/v5/pkg/api"
"github.com/docker/docker/api/types/container"
+ "github.com/getarcaneapp/arcane/backend/internal/common"
"github.com/getarcaneapp/arcane/backend/internal/database"
"github.com/getarcaneapp/arcane/backend/internal/models"
"github.com/getarcaneapp/arcane/backend/internal/utils"
@@ -719,7 +720,7 @@ func (s *ProjectService) CreateProject(ctx context.Context, name, composeContent
}
basePath := filepath.Join(projectsDirectory, sanitized)
- projectPath, folderName, err := fs.CreateUniqueDir(projectsDirectory, basePath, name, 0755)
+ projectPath, folderName, err := fs.CreateUniqueDir(projectsDirectory, basePath, name, common.DirPerm)
if err != nil {
return nil, fmt.Errorf("failed to create project directory: %w", err)
}
diff --git a/backend/internal/services/template_service.go b/backend/internal/services/template_service.go
index f1694afb2..a2c62e0dd 100644
--- a/backend/internal/services/template_service.go
+++ b/backend/internal/services/template_service.go
@@ -17,6 +17,7 @@ import (
composeloader "github.com/compose-spec/compose-go/v2/loader"
composetypes "github.com/compose-spec/compose-go/v2/types"
+ "github.com/getarcaneapp/arcane/backend/internal/common"
"github.com/getarcaneapp/arcane/backend/internal/database"
"github.com/getarcaneapp/arcane/backend/internal/models"
appfs "github.com/getarcaneapp/arcane/backend/internal/utils/fs"
@@ -976,7 +977,7 @@ func (s *TemplateService) UpdateGlobalVariables(ctx context.Context, vars []env.
}
projectsDirectory := filepath.Dir(envPath)
- if err := os.MkdirAll(projectsDirectory, 0755); err != nil {
+ if err := os.MkdirAll(projectsDirectory, common.DirPerm); err != nil {
return fmt.Errorf("failed to create projects directory: %w", err)
}
@@ -1000,7 +1001,7 @@ func (s *TemplateService) UpdateGlobalVariables(ctx context.Context, vars []env.
builder.WriteString(fmt.Sprintf("%s=%s\n", key, value))
}
- if err := appfs.WriteFileWithPerm(envPath, builder.String(), appfs.FilePerm); err != nil {
+ if err := appfs.WriteFileWithPerm(envPath, builder.String(), common.FilePerm); err != nil {
return fmt.Errorf("failed to write global variables file: %w", err)
}
@@ -1027,7 +1028,7 @@ func (s *TemplateService) ParseComposeServices(ctx context.Context, composeConte
// Create a dummy .env file to prevent env file errors
envPath := filepath.Join(tmpDir, ".env")
- if err := appfs.WriteFileWithPerm(envPath, "", appfs.FilePerm); err != nil {
+ if err := appfs.WriteFileWithPerm(envPath, "", common.FilePerm); err != nil {
slog.WarnContext(ctx, "Failed to create dummy env file", "error", err)
}
diff --git a/backend/internal/utils/fs/fs_templates.go b/backend/internal/utils/fs/fs_templates.go
index 747b393e6..a2a0940f6 100644
--- a/backend/internal/utils/fs/fs_templates.go
+++ b/backend/internal/utils/fs/fs_templates.go
@@ -7,6 +7,8 @@ import (
"path/filepath"
"regexp"
"strings"
+
+ "github.com/getarcaneapp/arcane/backend/internal/common"
)
func ReadFolderComposeTemplate(baseDir, folder string) (string, *string, string, bool, error) {
@@ -55,7 +57,7 @@ func EnsureTemplateDir(ctx context.Context, base string) (dir, composePath, envP
return "", "", "", fmt.Errorf("ensure templates dir: %w", derr)
}
dir = filepath.Join(baseDir, base)
- if err := os.MkdirAll(dir, 0755); err != nil {
+ if err := os.MkdirAll(dir, common.DirPerm); err != nil {
return "", "", "", fmt.Errorf("failed to create template directory: %w", err)
}
composePath = filepath.Join(dir, "compose.yaml")
diff --git a/backend/internal/utils/fs/fs_util.go b/backend/internal/utils/fs/fs_util.go
index a47973c02..0e8cf704a 100644
--- a/backend/internal/utils/fs/fs_util.go
+++ b/backend/internal/utils/fs/fs_util.go
@@ -8,6 +8,7 @@ import (
"path/filepath"
"strings"
+ "github.com/getarcaneapp/arcane/backend/internal/common"
"github.com/getarcaneapp/arcane/backend/internal/utils/projects"
)
@@ -18,7 +19,7 @@ func GetProjectsDirectory(ctx context.Context, projectsDir string) (string, erro
}
if _, err := os.Stat(projectsDirectory); os.IsNotExist(err) {
- if err := os.MkdirAll(projectsDirectory, 0755); err != nil {
+ if err := os.MkdirAll(projectsDirectory, common.DirPerm); err != nil {
return "", err
}
slog.InfoContext(ctx, "Created projects directory", "path", projectsDirectory)
@@ -45,7 +46,7 @@ func ReadProjectFiles(projectPath string) (composeContent, envContent string, er
func GetTemplatesDirectory(ctx context.Context) (string, error) {
templatesDir := filepath.Join("data", "templates")
if _, err := os.Stat(templatesDir); os.IsNotExist(err) {
- if err := os.MkdirAll(templatesDir, 0755); err != nil {
+ if err := os.MkdirAll(templatesDir, common.DirPerm); err != nil {
return "", err
}
slog.InfoContext(ctx, "Created templates directory", "path", templatesDir)
diff --git a/backend/internal/utils/fs/fs_writer.go b/backend/internal/utils/fs/fs_writer.go
index 307d01f5b..74dbbb0a2 100644
--- a/backend/internal/utils/fs/fs_writer.go
+++ b/backend/internal/utils/fs/fs_writer.go
@@ -4,11 +4,8 @@ import (
"fmt"
"os"
"path/filepath"
-)
-const (
- FilePerm = 0644
- DirPerm = 0755
+ "github.com/getarcaneapp/arcane/backend/internal/common"
)
var composeFileCandidates = []string{
@@ -52,7 +49,7 @@ func WriteComposeFile(projectsRoot, dirPath, content string) error {
return fmt.Errorf("refusing to write compose file: path outside projects root")
}
- if err := os.MkdirAll(dirPath, DirPerm); err != nil {
+ if err := os.MkdirAll(dirPath, common.DirPerm); err != nil {
return fmt.Errorf("failed to create directory: %w", err)
}
@@ -63,7 +60,7 @@ func WriteComposeFile(projectsRoot, dirPath, content string) error {
composePath = filepath.Join(dirPath, "compose.yaml")
}
- if err := os.WriteFile(composePath, []byte(content), FilePerm); err != nil {
+ if err := os.WriteFile(composePath, []byte(content), common.FilePerm); err != nil {
return fmt.Errorf("failed to write compose file: %w", err)
}
@@ -91,12 +88,12 @@ func WriteEnvFile(projectsRoot, dirPath, content string) error {
return fmt.Errorf("refusing to write env file: path outside projects root")
}
- if err := os.MkdirAll(dirPath, DirPerm); err != nil {
+ if err := os.MkdirAll(dirPath, common.DirPerm); err != nil {
return fmt.Errorf("failed to create directory: %w", err)
}
envPath := filepath.Join(dirPath, ".env")
- if err := os.WriteFile(envPath, []byte(content), FilePerm); err != nil {
+ if err := os.WriteFile(envPath, []byte(content), common.FilePerm); err != nil {
return fmt.Errorf("failed to write env file: %w", err)
}
@@ -127,11 +124,11 @@ func WriteProjectFiles(projectsRoot, dirPath, composeContent string, envContent
// WriteTemplateFile writes a template file (like .compose.template or .env.template)
func WriteTemplateFile(filePath, content string) error {
dir := filepath.Dir(filePath)
- if err := os.MkdirAll(dir, DirPerm); err != nil {
+ if err := os.MkdirAll(dir, common.DirPerm); err != nil {
return fmt.Errorf("failed to create template directory: %w", err)
}
- if err := os.WriteFile(filePath, []byte(content), FilePerm); err != nil {
+ if err := os.WriteFile(filePath, []byte(content), common.FilePerm); err != nil {
return fmt.Errorf("failed to write template file: %w", err)
}
@@ -141,7 +138,7 @@ func WriteTemplateFile(filePath, content string) error {
// WriteFileWithPerm is a generic file writer with custom permissions
func WriteFileWithPerm(filePath, content string, perm os.FileMode) error {
dir := filepath.Dir(filePath)
- if err := os.MkdirAll(dir, DirPerm); err != nil {
+ if err := os.MkdirAll(dir, common.DirPerm); err != nil {
return fmt.Errorf("failed to create directory: %w", err)
}
diff --git a/backend/internal/utils/fs/fs_writer_test.go b/backend/internal/utils/fs/fs_writer_test.go
new file mode 100644
index 000000000..08d9b6a1c
--- /dev/null
+++ b/backend/internal/utils/fs/fs_writer_test.go
@@ -0,0 +1,62 @@
+package fs
+
+import (
+ "os"
+ "path/filepath"
+ "runtime"
+ "testing"
+
+ "github.com/getarcaneapp/arcane/backend/internal/common"
+ "github.com/stretchr/testify/assert"
+ "github.com/stretchr/testify/require"
+)
+
+func TestWriteFilesPermissions(t *testing.T) {
+ // Save original perms
+ origFilePerm := common.FilePerm
+ origDirPerm := common.DirPerm
+ defer func() {
+ common.FilePerm = origFilePerm
+ common.DirPerm = origDirPerm
+ }()
+
+ tmpDir := t.TempDir()
+ projectsRoot := tmpDir
+ projectDir := filepath.Join(tmpDir, "test-project")
+
+ t.Run("WriteComposeFile uses custom permissions", func(t *testing.T) {
+ common.FilePerm = 0600
+ common.DirPerm = 0700
+
+ err := WriteComposeFile(projectsRoot, projectDir, "services: {}")
+ require.NoError(t, err)
+
+ composePath := filepath.Join(projectDir, "compose.yaml")
+ info, err := os.Stat(composePath)
+ require.NoError(t, err)
+
+ if runtime.GOOS != "windows" {
+ assert.Equal(t, os.FileMode(0600), info.Mode().Perm())
+
+ dirInfo, err := os.Stat(projectDir)
+ require.NoError(t, err)
+ assert.Equal(t, os.FileMode(0700), dirInfo.Mode().Perm())
+ }
+ })
+
+ t.Run("WriteEnvFile uses custom permissions", func(t *testing.T) {
+ common.FilePerm = 0600
+ common.DirPerm = 0700
+
+ err := WriteEnvFile(projectsRoot, projectDir, "VAR=VAL")
+ require.NoError(t, err)
+
+ envPath := filepath.Join(projectDir, ".env")
+ info, err := os.Stat(envPath)
+ require.NoError(t, err)
+
+ if runtime.GOOS != "windows" {
+ assert.Equal(t, os.FileMode(0600), info.Mode().Perm())
+ }
+ })
+}
diff --git a/backend/internal/utils/projects/env.go b/backend/internal/utils/projects/env.go
index 0b37ec882..1e0b1e9a4 100644
--- a/backend/internal/utils/projects/env.go
+++ b/backend/internal/utils/projects/env.go
@@ -10,10 +10,9 @@ import (
"time"
"github.com/compose-spec/compose-go/v2/dotenv"
+ "github.com/getarcaneapp/arcane/backend/internal/common"
)
-const filePerm = 0600
-
const (
globalEnvFileName = ".env.global"
projectEnvFileName = ".env"
@@ -79,10 +78,10 @@ func (l *EnvLoader) ensureGlobalEnvFile(ctx context.Context, path string) error
if _, err := os.Stat(path); os.IsNotExist(err) {
header := fmt.Sprintf(globalEnvHeader, time.Now().Format(time.RFC3339))
dir := filepath.Dir(path)
- if err := os.MkdirAll(dir, 0755); err != nil {
+ if err := os.MkdirAll(dir, common.DirPerm); err != nil {
return fmt.Errorf("create dir: %w", err)
}
- if werr := os.WriteFile(path, []byte(header), filePerm); werr != nil {
+ if werr := os.WriteFile(path, []byte(header), common.FilePerm); werr != nil {
return fmt.Errorf("write file: %w", werr)
}
slog.InfoContext(ctx, "Created global env file", "path", path)
diff --git a/backend/internal/utils/projects/env_test.go b/backend/internal/utils/projects/env_test.go
index 35903bf4b..9d831fc3e 100644
--- a/backend/internal/utils/projects/env_test.go
+++ b/backend/internal/utils/projects/env_test.go
@@ -6,6 +6,7 @@ import (
"path/filepath"
"testing"
+ "github.com/getarcaneapp/arcane/backend/internal/common"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
@@ -16,17 +17,17 @@ func TestLoadEnvironment(t *testing.T) {
projectsDir := filepath.Join(tmpDir, "projects")
workdir := filepath.Join(projectsDir, "myproject")
- err := os.MkdirAll(workdir, 0755)
+ err := os.MkdirAll(workdir, common.DirPerm)
require.NoError(t, err)
// Create .env.global
globalEnvContent := "GLOBAL_VAR=global_value\nSHARED_VAR=global_shared"
- err = os.WriteFile(filepath.Join(projectsDir, ".env.global"), []byte(globalEnvContent), 0600)
+ err = os.WriteFile(filepath.Join(projectsDir, ".env.global"), []byte(globalEnvContent), common.FilePerm)
require.NoError(t, err)
// Create .env
projectEnvContent := "PROJECT_VAR=project_value\nSHARED_VAR=project_shared"
- err = os.WriteFile(filepath.Join(workdir, ".env"), []byte(projectEnvContent), 0600)
+ err = os.WriteFile(filepath.Join(workdir, ".env"), []byte(projectEnvContent), common.FilePerm)
require.NoError(t, err)
t.Run("AutoInjectEnv=false", func(t *testing.T) {
diff --git a/backend/internal/utils/projects/includes.go b/backend/internal/utils/projects/includes.go
index b4292760f..4294fc9de 100644
--- a/backend/internal/utils/projects/includes.go
+++ b/backend/internal/utils/projects/includes.go
@@ -6,6 +6,7 @@ import (
"path/filepath"
"strings"
+ "github.com/getarcaneapp/arcane/backend/internal/common"
"github.com/goccy/go-yaml"
)
@@ -230,12 +231,12 @@ func WriteIncludeFile(projectDir, includePath, content string) error {
// Only create directory if it doesn't exist
if _, err := os.Stat(dir); os.IsNotExist(err) {
- if err := os.MkdirAll(dir, 0755); err != nil {
+ if err := os.MkdirAll(dir, common.DirPerm); err != nil {
return fmt.Errorf("failed to create directory: %w", err)
}
}
- if err := os.WriteFile(validatedPath, []byte(content), 0600); err != nil {
+ if err := os.WriteFile(validatedPath, []byte(content), common.FilePerm); err != nil {
return fmt.Errorf("failed to write include file: %w", err)
}
diff --git a/backend/internal/utils/projects/includes_test.go b/backend/internal/utils/projects/includes_test.go
index efd918108..e33f5df99 100644
--- a/backend/internal/utils/projects/includes_test.go
+++ b/backend/internal/utils/projects/includes_test.go
@@ -5,8 +5,54 @@ import (
"path/filepath"
"runtime"
"testing"
+
+ "github.com/getarcaneapp/arcane/backend/internal/common"
)
+func TestWriteIncludeFilePermissions(t *testing.T) {
+ // Save original perms
+ origFilePerm := common.FilePerm
+ origDirPerm := common.DirPerm
+ defer func() {
+ common.FilePerm = origFilePerm
+ common.DirPerm = origDirPerm
+ }()
+
+ projectDir := t.TempDir()
+ includePath := filepath.Join("includes", "config.yaml")
+ content := "services: {}\n"
+
+ t.Run("Uses custom permissions", func(t *testing.T) {
+ common.FilePerm = 0600
+ common.DirPerm = 0700
+
+ if err := WriteIncludeFile(projectDir, includePath, content); err != nil {
+ t.Fatalf("WriteIncludeFile() returned error: %v", err)
+ }
+
+ targetPath := filepath.Join(projectDir, includePath)
+ info, err := os.Stat(targetPath)
+ if err != nil {
+ t.Fatalf("failed to stat include file: %v", err)
+ }
+
+ // On Linux/macOS, we can check permissions. On Windows, it's more limited.
+ if runtime.GOOS != "windows" {
+ if info.Mode().Perm() != 0600 {
+ t.Errorf("unexpected file permissions: got %o, want %o", info.Mode().Perm(), 0600)
+ }
+
+ dirInfo, err := os.Stat(filepath.Dir(targetPath))
+ if err != nil {
+ t.Fatalf("failed to stat include directory: %v", err)
+ }
+ if dirInfo.Mode().Perm() != 0700 {
+ t.Errorf("unexpected directory permissions: got %o, want %o", dirInfo.Mode().Perm(), 0700)
+ }
+ }
+ })
+}
+
func TestWriteIncludeFileCreatesSafeDirectory(t *testing.T) {
t.Parallel()