From d6cc81ed8787994a1a37e1df2587c90067095da5 Mon Sep 17 00:00:00 2001 From: smail Date: Tue, 8 Sep 2026 17:16:09 +0800 Subject: [PATCH] =?UTF-8?q?=E5=88=86=E7=A6=BB=E4=BA=94=E9=A1=B9=E9=85=8D?= =?UTF-8?q?=E7=BD=AE=E4=B8=8E=E8=BF=90=E8=A1=8C=E6=95=B0=E6=8D=AE=E5=B9=B6?= =?UTF-8?q?=E5=AE=9E=E7=8E=B0=E6=97=A0=E6=8D=9F=E7=9B=AE=E5=BD=95=E8=BF=81?= =?UTF-8?q?=E7=A7=BB?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 1 + backend/cmd/smail-config/main.go | 23 ++ backend/config/audit_store.go | 3 +- backend/config/config.go | 11 +- backend/config/data_paths.go | 12 + backend/config/loader.go | 1 + backend/config/manager.go | 3 +- backend/config/manager_security_test.go | 8 +- backend/config/manager_v2_test.go | 26 +- backend/config/migrate.go | 16 +- backend/config/migrate_test.go | 11 +- backend/config/partitioned_compatibility.go | 7 +- .../config/partitioned_compatibility_test.go | 4 +- backend/config/ssl_custom.go | 5 +- backend/config/ssl_storage.go | 6 +- backend/config/ssl_storage_test.go | 6 +- backend/config/transaction.go | 16 +- backend/dto/parsemail/dkim.go | 2 +- backend/dto/parsemail/dkim_security_test.go | 2 +- backend/internal/app/app.go | 4 + .../listen/smtp_server/read_content_test.go | 2 +- backend/res_init/directories_test.go | 8 +- backend/res_init/init.go | 4 +- backend/services/auth/auth.go | 2 +- backend/services/dbmigration/portable_test.go | 12 +- backend/services/dbmigration/service_test.go | 2 +- .../services/dbmigration/sqlite_executor.go | 2 +- .../dbmigration/sqlite_executor_test.go | 30 +- backend/services/externalemail/vault.go | 11 +- backend/services/setup/db.go | 6 +- backend/services/setup/ssl/ssl.go | 6 +- backend/services/setup/ssl/storage.go | 4 +- backend/services/setup/ssl/storage_test.go | 10 +- .../setup/ssl/user_certificate_test.go | 2 +- backend/utils/credential/encryption.go | 10 +- backend/utils/credential/encryption_test.go | 8 +- backend/utils/credential/vault_test.go | 4 +- backend/utils/runtimepath/layout.go | 257 ++++++++++++++++++ deploy/install-windows.ps1 | 1 + deploy/start-dev.ps1 | 2 +- docs/运行目录迁移说明.md | 47 ++++ frontend/.env.development | 4 +- frontend/README.md | 2 +- frontend/src/i18n/i18n.js | 6 +- frontend/src/views/Setup/Setup.js | 10 +- .../ConfigSettings/ConfigForm/ConfigForm.js | 4 +- frontend/vite.config.js | 11 +- test/backend/data_paths_test.go | 128 +++++++++ test/backend/runtime_layout_test.go | 156 +++++++++++ test/backend/ssl_custom_test.go | 4 +- test/frontend/setup-ssl-proxy.test.mjs | 4 +- test/run.mjs | 2 + test/runtime_data_check.py | 108 ++++++++ 53 files changed, 909 insertions(+), 127 deletions(-) create mode 100644 backend/config/data_paths.go create mode 100644 backend/utils/runtimepath/layout.go create mode 100644 docs/运行目录迁移说明.md create mode 100644 test/backend/data_paths_test.go create mode 100644 test/backend/runtime_layout_test.go create mode 100644 test/runtime_data_check.py diff --git a/.gitignore b/.gitignore index bfbd2de1..34369bbd 100644 --- a/.gitignore +++ b/.gitignore @@ -8,6 +8,7 @@ # 本机运行根目录与人工证书输入,不匹配源码中的同名目录 /config/ +/data/ /ssl/ # 后端配置目录混放源码与运行数据:只放行代码、文档和脱敏示例 diff --git a/backend/cmd/smail-config/main.go b/backend/cmd/smail-config/main.go index e62ed72e..09002c87 100644 --- a/backend/cmd/smail-config/main.go +++ b/backend/cmd/smail-config/main.go @@ -7,6 +7,7 @@ import ( "path/filepath" "git.pcux.cn/xuans/Smail/config" + "git.pcux.cn/xuans/Smail/utils/runtimepath" ) // main 提供部署端显式配置迁移,不在网页或普通启动中自动改写配置。 @@ -21,6 +22,7 @@ func run(args []string) error { flags := flag.NewFlagSet("smail-config", flag.ContinueOnError) root := flags.String("root", "", "Smail 服务根目录,包含 config 子目录") apply := flags.Bool("apply", false, "确认已停止后端,备份并执行迁移;默认只检查") + runtimeData := flags.Bool("runtime-data", false, "将运行数据迁到 data,保留当前五个配置文件") if err := flags.Parse(args); err != nil { return err } @@ -32,6 +34,27 @@ func run(args []string) error { return fmt.Errorf("服务根目录无效") } options := config.RuntimeValidationOptions{HasSuperAdmin: true, Production: true} + if *runtimeData { + moves, err := runtimepath.Plan(absolute) + if err != nil { + return err + } + if !*apply { + fmt.Printf("检查通过,共 %d 项待迁移;停止后端后加 --apply 执行。\n", len(moves)) + return nil + } + if _, err := config.NewConfigLoader(absolute, config.ConfigLoaderOptions{Validation: options}).Load(); err != nil { + // 旧单文件部署先搬运行数据,再执行原有的分区配置迁移。 + if _, legacyErr := config.PlanLegacyMigration(absolute, options); legacyErr != nil { + return fmt.Errorf("当前配置校验失败,未执行迁移") + } + } + if _, err := runtimepath.Migrate(absolute); err != nil { + return err + } + fmt.Printf("运行数据迁移完成,共 %d 项;当前五个配置文件未改写,废弃配置保留在 data/legacy-config。\n", len(moves)) + return nil + } plan, err := config.PlanLegacyMigration(absolute, options) if err != nil { // 不输出配置原文、未知字段或底层错误,避免凭据进入终端记录。 diff --git a/backend/config/audit_store.go b/backend/config/audit_store.go index 00f61931..9915c8e2 100644 --- a/backend/config/audit_store.go +++ b/backend/config/audit_store.go @@ -17,6 +17,7 @@ import ( "time" "git.pcux.cn/xuans/Smail/utils/atomicfile" + "git.pcux.cn/xuans/Smail/utils/runtimepath" ) const ConfigAuditRetention = 365 * 24 * time.Hour @@ -45,7 +46,7 @@ func NewFileAuditWriter(root string) (*FileAuditWriter, error) { if strings.TrimSpace(root) == "" { return nil, ErrAuditStorageUnavailable } - directory, err := secureManagerConfigDirectory(root) + directory, err := runtimepath.Directory(root) if err != nil { return nil, err } diff --git a/backend/config/config.go b/backend/config/config.go index 10702cb5..4899eb01 100644 --- a/backend/config/config.go +++ b/backend/config/config.go @@ -8,6 +8,7 @@ import ( "git.pcux.cn/xuans/Smail/utils/context" "git.pcux.cn/xuans/Smail/utils/credential" "git.pcux.cn/xuans/Smail/utils/errors" + "git.pcux.cn/xuans/Smail/utils/runtimepath" log "github.com/sirupsen/logrus" "os" "path/filepath" @@ -275,7 +276,7 @@ func legacyInitReady() bool { } func ReadPrivateKey() (*ecdsa.PrivateKey, bool, error) { - privateKey, created, err := loadOrCreateACMEPrivateKey(filepath.Join(ROOT_PATH, "config", "ssl"), "account_private.pem") + privateKey, created, err := loadOrCreateACMEPrivateKey(filepath.Join(ROOT_PATH, "data", "ssl"), "account_private.pem") if err != nil { return nil, false, err } @@ -331,9 +332,9 @@ func ReadConfig() (*Config, error) { func readConfig() (*Config, error) { configData := Config{ - DkimPrivateKeyPath: ROOT_PATH + "config/dkim/dkim.priv", - SSLPrivateKeyPath: ROOT_PATH + "config/ssl/private.key", - SSLPublicKeyPath: ROOT_PATH + "config/ssl/public.crt", + DkimPrivateKeyPath: ROOT_PATH + "data/dkim/dkim.priv", + SSLPrivateKeyPath: ROOT_PATH + "data/ssl/private.key", + SSLPublicKeyPath: ROOT_PATH + "data/ssl/public.crt", VerificationEnabled: true, ExternalRecoveryEnabled: true, LoginPolicy: "new_device", @@ -445,7 +446,7 @@ func persistControlledSSLPath(value string) string { } func resolvePath(value string) string { - value = strings.TrimSpace(value) + value = runtimepath.LegacyReference(strings.TrimSpace(value)) if value == "" { return "" } diff --git a/backend/config/data_paths.go b/backend/config/data_paths.go new file mode 100644 index 00000000..db961b26 --- /dev/null +++ b/backend/config/data_paths.go @@ -0,0 +1,12 @@ +package config + +import "git.pcux.cn/xuans/Smail/utils/runtimepath" + +// normalizeSSLDataReferences 在原始摘要校验后兼容旧引用,不修改历史备份的字节及摘要。 +func normalizeSSLDataReferences(ssl SSLConfig) SSLConfig { + ssl.DefaultDirectory = runtimepath.LegacyReference(ssl.DefaultDirectory) + ssl.CustomDirectory = runtimepath.LegacyReference(ssl.CustomDirectory) + ssl.CertificateRef = runtimepath.LegacyReference(ssl.CertificateRef) + ssl.PrivateKeyRef = runtimepath.LegacyReference(ssl.PrivateKeyRef) + return ssl +} diff --git a/backend/config/loader.go b/backend/config/loader.go index 3ecaba7b..dc2748e0 100644 --- a/backend/config/loader.go +++ b/backend/config/loader.go @@ -89,6 +89,7 @@ func (l *ConfigLoader) Load() (RuntimeConfig, error) { if err := ValidateRuntimeConfig(runtime, l.options.Validation); err != nil { return RuntimeConfig{}, err } + runtime.SSL.TLS = normalizeSSLDataReferences(runtime.SSL.TLS) return cloneRuntimeConfig(runtime), nil } diff --git a/backend/config/manager.go b/backend/config/manager.go index a717850f..44361145 100644 --- a/backend/config/manager.go +++ b/backend/config/manager.go @@ -13,6 +13,7 @@ import ( "git.pcux.cn/xuans/Smail/utils/atomicfile" fileutil "git.pcux.cn/xuans/Smail/utils/file" + "git.pcux.cn/xuans/Smail/utils/runtimepath" ) var ( @@ -335,7 +336,7 @@ func secureManagerConfigDirectory(root string) (string, error) { } func secureBackupDirectory(root string) (string, error) { - configDirectory, err := secureManagerConfigDirectory(root) + configDirectory, err := runtimepath.Directory(root) if err != nil { return "", err } diff --git a/backend/config/manager_security_test.go b/backend/config/manager_security_test.go index 3bb59ee4..0089a75d 100644 --- a/backend/config/manager_security_test.go +++ b/backend/config/manager_security_test.go @@ -141,10 +141,10 @@ func TestLoadManagerRejectsSymlinkConfigFile(t *testing.T) { func TestBackupRejectsSymlinkDirectoryAndEntry(t *testing.T) { t.Run("directory", func(t *testing.T) { root := t.TempDir() - if err := os.MkdirAll(filepath.Join(root, "config"), 0700); err != nil { + if err := os.MkdirAll(filepath.Join(root, "data"), 0700); err != nil { t.Fatal(err) } - if err := os.Symlink(t.TempDir(), filepath.Join(root, "config", "backups")); err != nil { + if err := os.Symlink(t.TempDir(), filepath.Join(root, "data", "backups")); err != nil { t.Skipf("symlink is unavailable: %v", err) } if _, err := BackupConfig(root, RuntimeSnapshot{Config: testRootConfig(), Generation: 1}, time.Now()); err == nil { @@ -153,7 +153,7 @@ func TestBackupRejectsSymlinkDirectoryAndEntry(t *testing.T) { }) t.Run("entry", func(t *testing.T) { root := t.TempDir() - directory := filepath.Join(root, "config", "backups") + directory := filepath.Join(root, "data", "backups") if err := os.MkdirAll(directory, 0700); err != nil { t.Fatal(err) } @@ -196,7 +196,7 @@ func TestBackupRetentionKeepsExactlyFourRecentManagedFiles(t *testing.T) { t.Fatal(err) } } - entries, err := os.ReadDir(filepath.Join(root, "config", "backups")) + entries, err := os.ReadDir(filepath.Join(root, "data", "backups")) if err != nil { t.Fatal(err) } diff --git a/backend/config/manager_v2_test.go b/backend/config/manager_v2_test.go index b1b153cb..886c3293 100644 --- a/backend/config/manager_v2_test.go +++ b/backend/config/manager_v2_test.go @@ -810,11 +810,11 @@ func TestConfigBackupRejectsTamperedPartition(t *testing.T) { if _, err := store.CreateBackup(runtime); err != nil { t.Fatal(err) } - entries, err := os.ReadDir(filepath.Join(root, "config", "backups-v2")) + entries, err := os.ReadDir(filepath.Join(root, "data", "backups-v2")) if err != nil || len(entries) != 1 { t.Fatalf("backup entries = %v, err = %v", entries, err) } - path := filepath.Join(root, "config", "backups-v2", entries[0].Name(), "files", "email.json") + path := filepath.Join(root, "data", "backups-v2", entries[0].Name(), "files", "email.json") data, err := os.ReadFile(path) if err != nil { t.Fatal(err) @@ -853,11 +853,11 @@ func TestConfigManagerRejectsUndecryptableRollbackBackup(t *testing.T) { t.Fatal(err) } - entries, err := os.ReadDir(filepath.Join(root, "config", "backups-v2")) + entries, err := os.ReadDir(filepath.Join(root, "data", "backups-v2")) if err != nil || len(entries) != 1 { t.Fatalf("backup entries = %v, err = %v", entries, err) } - backupDirectory := filepath.Join(root, "config", "backups-v2", entries[0].Name()) + backupDirectory := filepath.Join(root, "data", "backups-v2", entries[0].Name()) rootPath := filepath.Join(backupDirectory, "files", "config.json") rootData, err := os.ReadFile(rootPath) if err != nil { @@ -925,7 +925,7 @@ func TestConfigBackupRetentionKeepsFourRecentBackups(t *testing.T) { t.Fatal(err) } } - entries, err := os.ReadDir(filepath.Join(root, "config", "backups-v2")) + entries, err := os.ReadDir(filepath.Join(root, "data", "backups-v2")) if err != nil { t.Fatal(err) } @@ -1303,14 +1303,14 @@ func containsAny(value string, terms ...string) bool { func findTransactionDirectory(t *testing.T, root string) string { t.Helper() - entries, err := os.ReadDir(filepath.Join(root, "config", "transaction")) + entries, err := os.ReadDir(filepath.Join(root, "data", "transaction")) if err != nil { t.Fatal(err) } if len(entries) != 1 || !entries[0].IsDir() { t.Fatalf("transaction entries = %+v", entries) } - return filepath.Join(root, "config", "transaction", entries[0].Name()) + return filepath.Join(root, "data", "transaction", entries[0].Name()) } func TestTransactionRecoveryRejectsTamperedArtifacts(t *testing.T) { @@ -1462,7 +1462,7 @@ func TestConfigBackupScheduleUsesSevenDayInterval(t *testing.T) { if err != nil || !created || atDue == path { t.Fatalf("at due path=%q created=%v err=%v, want new backup", atDue, created, err) } - entries, err := os.ReadDir(filepath.Join(root, "config", "backups-v2")) + entries, err := os.ReadDir(filepath.Join(root, "data", "backups-v2")) if err != nil { t.Fatal(err) } @@ -1484,7 +1484,7 @@ func TestConfigBackupScheduleCreatesSameGenerationBackupWhenDue(t *testing.T) { if err != nil || !created || secondPath == "" || secondPath == firstPath { t.Fatalf("due backup path=%q created=%v err=%v, want a new backup", secondPath, created, err) } - entries, err := os.ReadDir(filepath.Join(root, "config", "backups-v2")) + entries, err := os.ReadDir(filepath.Join(root, "data", "backups-v2")) if err != nil { t.Fatal(err) } @@ -1500,7 +1500,7 @@ func TestConfigBackupListingAndLoadingIgnoreTemporaryDirectories(t *testing.T) { if _, err := store.CreateBackup(runtime); err != nil { t.Fatal(err) } - backupDirectory := filepath.Join(root, "config", "backups-v2") + backupDirectory := filepath.Join(root, "data", "backups-v2") if err := os.Mkdir(filepath.Join(backupDirectory, ".interrupted.tmp"), 0700); err != nil { t.Fatal(err) } @@ -1528,7 +1528,7 @@ func TestConfigBackupCleanupKeepsOnlyExpiredValidBackup(t *testing.T) { if _, err := store.createBackupAt(runtime, createdAt); err != nil { t.Fatal(err) } - backupDirectory := filepath.Join(root, "config", "backups-v2") + backupDirectory := filepath.Join(root, "data", "backups-v2") if err := cleanupConfigBackups(backupDirectory, createdAt.Add(configBackupMaxAge+time.Nanosecond), store.validation); err != nil { t.Fatal(err) } @@ -1553,7 +1553,7 @@ func TestConfigBackupRetentionHonorsThirtyDayBoundary(t *testing.T) { if _, err := store.createBackupAt(second, base.Add(configBackupMaxAge)); err != nil { t.Fatal(err) } - backupDirectory := filepath.Join(root, "config", "backups-v2") + backupDirectory := filepath.Join(root, "data", "backups-v2") entries, err := os.ReadDir(backupDirectory) if err != nil { t.Fatal(err) @@ -1596,7 +1596,7 @@ func TestConfigBackupFailureDoesNotDeleteExistingValidBackup(t *testing.T) { if _, err := store.LoadBackup(runtime.Generation); err != nil { t.Fatalf("existing valid backup was removed after failure: %v", err) } - entries, err := os.ReadDir(filepath.Join(root, "config", "backups-v2")) + entries, err := os.ReadDir(filepath.Join(root, "data", "backups-v2")) if err != nil { t.Fatal(err) } diff --git a/backend/config/migrate.go b/backend/config/migrate.go index 6e6d53ce..93f04421 100644 --- a/backend/config/migrate.go +++ b/backend/config/migrate.go @@ -20,6 +20,7 @@ import ( "git.pcux.cn/xuans/Smail/plugins/catalog" "git.pcux.cn/xuans/Smail/utils/atomicfile" "git.pcux.cn/xuans/Smail/utils/credential" + "git.pcux.cn/xuans/Smail/utils/runtimepath" ) var ( @@ -178,11 +179,15 @@ func MigrateLegacyConfig(root string, options RuntimeValidationOptions) (LegacyM if err := ValidateRuntimeConfig(runtime, options); err != nil { return LegacyMigrationResult{}, err } - backupPath, err := writeLegacyMigrationBackup(directory, legacyData, time.Now().UTC()) + dataDirectory, err := runtimepath.Directory(root) if err != nil { return LegacyMigrationResult{}, err } - if err := preserveLegacyMigrationSource(directory, legacyData); err != nil { + backupPath, err := writeLegacyMigrationBackup(dataDirectory, legacyData, time.Now().UTC()) + if err != nil { + return LegacyMigrationResult{}, err + } + if err := preserveLegacyMigrationSource(dataDirectory, legacyData); err != nil { return LegacyMigrationResult{}, err } files, err := marshalRuntimeFilesWithPluginSecrets(runtime, true) @@ -614,6 +619,7 @@ func legacySQLiteLocalRef(value string) (string, bool) { value = filepath.ToSlash(value) value = strings.TrimPrefix(value, "./") value = strings.TrimPrefix(value, "config/") + value = strings.TrimPrefix(value, "data/") if value == "" || strings.HasPrefix(value, "../") || value == ".." || strings.Contains(value, "/../") || strings.Contains(value, "\\") || strings.Contains(value, ":") { return "", false } @@ -736,7 +742,9 @@ func legacySMTPConfig(root string, vault *credential.Vault, legacy legacyMigrati func legacySSLConfig(legacy legacyMigrationConfig) (SSLConfig, []string) { certificateRef, certificateOK := legacyControlledReference(legacy.SSLPublicKeyPath) privateKeyRef, privateKeyOK := legacyControlledReference(legacy.SSLPrivateKeyPath) - ssl := SSLConfig{Management: SSLManagementProject, Mode: ManagedSSLModeDefault, DefaultDirectory: "config/ssl"} + certificateRef = runtimepath.LegacyReference(certificateRef) + privateKeyRef = runtimepath.LegacyReference(privateKeyRef) + ssl := SSLConfig{Management: SSLManagementProject, Mode: ManagedSSLModeDefault, DefaultDirectory: "data/ssl"} switch legacy.SSLType { case SSLTypeAutoDNS: ssl.Challenge = SSLChallengeDNS @@ -749,7 +757,7 @@ func legacySSLConfig(legacy legacyMigrationConfig) (SSLConfig, []string) { ssl.Management = SSLManagementWebServer } ssl.Mode = ManagedSSLModeUpload - ssl.CustomDirectory = "config/ssl" + ssl.CustomDirectory = "data/ssl" } if legacy.SSLPublicKeyPath == "" && legacy.SSLPrivateKeyPath == "" { return ssl, nil diff --git a/backend/config/migrate_test.go b/backend/config/migrate_test.go index b99f4737..da57afa2 100644 --- a/backend/config/migrate_test.go +++ b/backend/config/migrate_test.go @@ -64,7 +64,7 @@ func TestMigrateLegacyConfigPreservesBackupAndLoadsPartitions(t *testing.T) { if !bytes.Equal(backup, original) { t.Fatal("legacy backup does not match the original configuration") } - legacyCopy, err := os.ReadFile(filepath.Join(root, "config", legacyMigrationSourceCopy)) + legacyCopy, err := os.ReadFile(filepath.Join(root, "data", legacyMigrationSourceCopy)) if err != nil { t.Fatal(err) } @@ -206,7 +206,7 @@ func TestMigrateLegacyConfigResumesAfterNonSecretPartitionWrite(t *testing.T) { if _, err := NewConfigManager(root, ConfigLoaderOptions{Validation: RuntimeValidationOptions{HasSuperAdmin: true, Production: true}}); err != nil { t.Fatal(err) } - legacyCopy, err := os.ReadFile(filepath.Join(directory, legacyMigrationSourceCopy)) + legacyCopy, err := os.ReadFile(filepath.Join(root, "data", legacyMigrationSourceCopy)) if err != nil { t.Fatal(err) } @@ -357,7 +357,10 @@ func TestMigrateLegacyConfigRejectsConflictingPreservedSource(t *testing.T) { "httpPort": 80, "httpsPort": 443, }) - legacyCopyPath := filepath.Join(root, "config", legacyMigrationSourceCopy) + if err := os.MkdirAll(filepath.Join(root, "data"), 0700); err != nil { + t.Fatal(err) + } + legacyCopyPath := filepath.Join(root, "data", legacyMigrationSourceCopy) conflictingCopy := []byte(`{"dbDSN":"different.db","dbType":"sqlite"}`) if err := os.WriteFile(legacyCopyPath, conflictingCopy, 0600); err != nil { t.Fatal(err) @@ -419,7 +422,7 @@ func TestMigrateLegacyConfigRejectsRepeatedMigrationAfterSuccess(t *testing.T) { if !bytes.Equal(after, migrated) { t.Fatal("repeated migration changed the partitioned root") } - legacyCopy, err := os.ReadFile(filepath.Join(root, "config", legacyMigrationSourceCopy)) + legacyCopy, err := os.ReadFile(filepath.Join(root, "data", legacyMigrationSourceCopy)) if err != nil { t.Fatal(err) } diff --git a/backend/config/partitioned_compatibility.go b/backend/config/partitioned_compatibility.go index 09d1d343..331afad3 100644 --- a/backend/config/partitioned_compatibility.go +++ b/backend/config/partitioned_compatibility.go @@ -58,7 +58,7 @@ func runtimeCompatibility(runtime RuntimeConfig) (*Config, error) { HttpPort: root.HTTP.Port, HttpsPort: root.HTTP.HTTPSPort, HttpsEnabled: 2, TLSMode: root.HTTP.TLSMode, TrustedProxyCIDRs: append([]string(nil), root.HTTP.TrustedProxyCIDRs...), - DkimPrivateKeyPath: filepath.Join(ROOT_PATH, "config", "dkim", "dkim.priv"), + DkimPrivateKeyPath: filepath.Join(ROOT_PATH, "data", "dkim", "dkim.priv"), SSLType: SSLTypeUser, SpamFilterLevel: runtime.Email.Policy.SpamFilterLevel, LoginPolicy: runtime.SMTP.Relay.LoginPolicy, @@ -77,7 +77,7 @@ func runtimeCompatibility(runtime RuntimeConfig) (*Config, error) { return nil, err } } - tls := runtime.SSL.TLS + tls := normalizeSSLDataReferences(runtime.SSL.TLS) if EffectiveSSLManagement(tls) == SSLManagementProject { if tls.Challenge == SSLChallengeDNS { cfg.SSLType = SSLTypeAutoDNS @@ -97,7 +97,8 @@ func runtimeCompatibility(runtime RuntimeConfig) (*Config, error) { func compatibilityDatabase(database DatabaseConfig, vault *credential.Vault) (string, string, error) { if database.Type == DatabaseTypeSQLite { - return DBTypeSQLite, filepath.Join(ROOT_PATH, "config", database.LocalRef), nil + path := filepath.Join(ROOT_PATH, "data", database.LocalRef) + return DBTypeSQLite, path, nil } password, err := OpenStoredSecret(vault, database.Password) if err != nil { diff --git a/backend/config/partitioned_compatibility_test.go b/backend/config/partitioned_compatibility_test.go index 2bea4091..c806ef9e 100644 --- a/backend/config/partitioned_compatibility_test.go +++ b/backend/config/partitioned_compatibility_test.go @@ -73,10 +73,10 @@ func TestPartitionedCompatibilityStartupAndWriteProtection(t *testing.T) { t.Fatal(err) } cfg := CurrentConfig() - if !cfg.IsSetupReady() || cfg.DbType != DBTypeSQLite || cfg.DbDSN != filepath.Join(root, "config", "existing.db") { + if !cfg.IsSetupReady() || cfg.DbType != DBTypeSQLite || cfg.DbDSN != filepath.Join(root, "data", "existing.db") { t.Fatal("partitioned startup lost initialization or database identity") } - if cfg.WebDomain != "mail.example.com" || cfg.SSLPublicKeyPath != filepath.Join(root, "config", "ssl", "site.crt") { + if cfg.WebDomain != "mail.example.com" || cfg.SSLPublicKeyPath != filepath.Join(root, "data", "ssl", "site.crt") { t.Fatal("partitioned startup lost domain or certificate path") } } diff --git a/backend/config/ssl_custom.go b/backend/config/ssl_custom.go index f8abb386..53056692 100644 --- a/backend/config/ssl_custom.go +++ b/backend/config/ssl_custom.go @@ -18,6 +18,7 @@ type customSSLMaterial struct { } func prepareCustomSSLPaths(root string, candidate *RuntimeConfig) (*customSSLMaterial, error) { + candidate.SSL.TLS = normalizeSSLDataReferences(candidate.SSL.TLS) ssl := &candidate.SSL.TLS if EffectiveSSLManagement(*ssl) != SSLManagementCustom { return nil, nil @@ -56,8 +57,8 @@ func prepareCustomSSLPaths(root string, candidate *RuntimeConfig) (*customSSLMat return nil, err } ssl.Mode = ManagedSSLModeUpload - ssl.DefaultDirectory = "config/ssl" - ssl.CustomDirectory = "config/ssl" + ssl.DefaultDirectory = "data/ssl" + ssl.CustomDirectory = "data/ssl" // 仅在内存中使用合法占位引用完成跨分区校验,最终候选必须换成独立版本。 ssl.CertificateRef = managedSSLReference(ManagedSSLModeUpload, "public.crt") ssl.PrivateKeyRef = managedSSLReference(ManagedSSLModeUpload, "private.key") diff --git a/backend/config/ssl_storage.go b/backend/config/ssl_storage.go index dfa23bb5..aa744d5f 100644 --- a/backend/config/ssl_storage.go +++ b/backend/config/ssl_storage.go @@ -16,6 +16,7 @@ import ( "time" "git.pcux.cn/xuans/Smail/utils/atomicfile" + "git.pcux.cn/xuans/Smail/utils/runtimepath" ) const ( @@ -25,7 +26,7 @@ const ( SSLManagementProject = "project" SSLManagementCustom = "custom" - managedSSLRelativeRoot = "config/ssl/managed" + managedSSLRelativeRoot = "data/ssl/managed" maxManagedSSLFileSize = 1 << 20 ) @@ -207,6 +208,7 @@ func ResolveManagedSSLReferences(ssl SSLConfig) (ManagedSSLReference, error) { } func resolveManagedSSLReferencesAtRoot(root string, ssl SSLConfig) (ManagedSSLReference, error) { + ssl = normalizeSSLDataReferences(ssl) if !validManagedSSLMode(ssl.Mode) { return ManagedSSLReference{}, ErrInvalidSSLMode } @@ -402,7 +404,7 @@ func resolveManagedReference(rootPath, reference, expectedName string) (string, } func resolveManagedReferenceAtRoot(root, rootPath, reference, expectedName string) (string, error) { - rawReference := strings.TrimSpace(reference) + rawReference := runtimepath.LegacyReference(strings.TrimSpace(reference)) if rawReference == "" || strings.Contains(rawReference, `\`) || filepath.IsAbs(rawReference) || isWindowsAbsolute(rawReference) { return "", ErrInvalidSSLReference } diff --git a/backend/config/ssl_storage_test.go b/backend/config/ssl_storage_test.go index 925dacdf..65394428 100644 --- a/backend/config/ssl_storage_test.go +++ b/backend/config/ssl_storage_test.go @@ -29,7 +29,7 @@ func TestImportManagedSSLUsesInternalReferencesAndAtomicCurrent(t *testing.T) { if filepath.IsAbs(first.CertificateRef) || filepath.IsAbs(first.PrivateKeyRef) { t.Fatal("SSL 内部引用不应为绝对路径") } - if first.CertificateRef != "config/ssl/managed/default/current/public.crt" || first.PrivateKeyRef != "config/ssl/managed/default/current/private.key" { + if first.CertificateRef != "data/ssl/managed/default/current/public.crt" || first.PrivateKeyRef != "data/ssl/managed/default/current/private.key" { t.Fatalf("内部引用不符合预期: %+v", first) } resolved, err := ResolveManagedSSLReferences(SSLConfig{Mode: ManagedSSLModeDefault, DefaultDirectory: "config/ssl", CertificateRef: first.CertificateRef, PrivateKeyRef: first.PrivateKeyRef}) @@ -236,7 +236,7 @@ func TestPrepareCustomSSLPathsImportsExternalFilesOnlyWhenSaving(t *testing.T) { if runtime.SSL.TLS.CertificateRef == certificatePath || runtime.SSL.TLS.PrivateKeyRef == privateKeyPath { t.Fatal("仅校验阶段不应保留外部证书路径") } - managedRoot := filepath.Join(root, "config", "ssl", "managed", "upload") + managedRoot := filepath.Join(root, "data", "ssl", "managed", "upload") if _, err := os.Stat(managedRoot); !os.IsNotExist(err) { t.Fatalf("仅校验阶段不应创建受管目录,error = %v", err) } @@ -247,7 +247,7 @@ func TestPrepareCustomSSLPathsImportsExternalFilesOnlyWhenSaving(t *testing.T) { if runtime.SSL.TLS.CertificateRef == certificatePath || runtime.SSL.TLS.PrivateKeyRef == privateKeyPath { t.Fatal("保存后不应继续使用外部证书路径") } - if !strings.HasPrefix(runtime.SSL.TLS.CertificateRef, "config/ssl/managed/upload/version-") { + if !strings.HasPrefix(runtime.SSL.TLS.CertificateRef, "data/ssl/managed/upload/version-") { t.Fatalf("证书引用未切换到受管版本: %q", runtime.SSL.TLS.CertificateRef) } if _, err := ResolveManagedSSLReferences(runtime.SSL.TLS); err != nil { diff --git a/backend/config/transaction.go b/backend/config/transaction.go index 36550691..6c6015e1 100644 --- a/backend/config/transaction.go +++ b/backend/config/transaction.go @@ -15,6 +15,7 @@ import ( "git.pcux.cn/xuans/Smail/utils/atomicfile" fileutil "git.pcux.cn/xuans/Smail/utils/file" + "git.pcux.cn/xuans/Smail/utils/runtimepath" ) type TransactionPhase string @@ -518,7 +519,11 @@ func validateTransactionManifest(manifest TransactionManifest) error { } func secureTransactionDirectory(configDirectory string) (string, error) { - directory := filepath.Join(configDirectory, "transaction") + dataDirectory, err := runtimepath.Directory(filepath.Dir(configDirectory)) + if err != nil { + return "", err + } + directory := filepath.Join(dataDirectory, "transaction") if err := os.MkdirAll(directory, 0700); err != nil { return "", err } @@ -595,7 +600,7 @@ func (s *TransactionStore) CreateBackupIfDue(runtime RuntimeConfig, now time.Tim return "", false, err } if found && now.Before(latest.CreatedAt.Add(configBackupInterval)) { - return filepath.Join(s.root, "config", "backups-v2", latest.ID), false, nil + return filepath.Join(s.root, "data", "backups-v2", latest.ID), false, nil } path, err := s.createBackupAt(runtime, now) return path, true, err @@ -757,7 +762,11 @@ func (s *TransactionStore) LoadBackup(generation uint64) (RuntimeConfig, error) } func secureConfigBackupDirectory(configDirectory string) (string, error) { - directory := filepath.Join(configDirectory, "backups-v2") + dataDirectory, err := runtimepath.Directory(filepath.Dir(configDirectory)) + if err != nil { + return "", err + } + directory := filepath.Join(dataDirectory, "backups-v2") if err := os.MkdirAll(directory, 0700); err != nil { return "", err } @@ -862,6 +871,7 @@ func parseRuntimeFiles(files map[string][]byte, validation RuntimeValidationOpti if err := ValidateRuntimeConfig(runtime, validation); err != nil { return RuntimeConfig{}, err } + runtime.SSL.TLS = normalizeSSLDataReferences(runtime.SSL.TLS) return runtime, nil } diff --git a/backend/dto/parsemail/dkim.go b/backend/dto/parsemail/dkim.go index fb22a9e6..6427efc6 100644 --- a/backend/dto/parsemail/dkim.go +++ b/backend/dto/parsemail/dkim.go @@ -41,7 +41,7 @@ func Init() error { } func loadPrivateKey(path string) (crypto.Signer, error) { - basePath := filepath.Join(config.ROOT_PATH, "config", "dkim") + basePath := filepath.Join(config.ROOT_PATH, "data", "dkim") privateName, err := securefile.ControlledRelativePath(basePath, path) if err != nil { return nil, err diff --git a/backend/dto/parsemail/dkim_security_test.go b/backend/dto/parsemail/dkim_security_test.go index 1344c1fc..42ffae3e 100644 --- a/backend/dto/parsemail/dkim_security_test.go +++ b/backend/dto/parsemail/dkim_security_test.go @@ -93,7 +93,7 @@ func prepareDKIMTestDirectory(t *testing.T) (string, string) { oldRoot := config.ROOT_PATH root := t.TempDir() t.Cleanup(func() { config.ROOT_PATH = oldRoot }) - directory := filepath.Join(root, "config", "dkim") + directory := filepath.Join(root, "data", "dkim") if err := os.MkdirAll(directory, 0700); err != nil { t.Fatal(err) } diff --git a/backend/internal/app/app.go b/backend/internal/app/app.go index 2011782a..0f102eda 100644 --- a/backend/internal/app/app.go +++ b/backend/internal/app/app.go @@ -8,11 +8,15 @@ import ( "git.pcux.cn/xuans/Smail/internal/buildinfo" "git.pcux.cn/xuans/Smail/listen/cron_server" "git.pcux.cn/xuans/Smail/res_init" + "git.pcux.cn/xuans/Smail/utils/runtimepath" log "github.com/sirupsen/logrus" ) // Run 启动 Smail 主服务。 func Run() error { + if err := runtimepath.CheckReady(config.ROOT_PATH); err != nil { + return err + } if err := config.Init(); err != nil { return err } diff --git a/backend/listen/smtp_server/read_content_test.go b/backend/listen/smtp_server/read_content_test.go index 29a5c4a0..b65b5a2e 100644 --- a/backend/listen/smtp_server/read_content_test.go +++ b/backend/listen/smtp_server/read_content_test.go @@ -46,7 +46,7 @@ func testInit(t *testing.T) { Domains: []string{"test.domain"}, DbType: config.DBTypeSQLite, DbDSN: filepath.Join(t.TempDir(), "smtp.db"), - DkimPrivateKeyPath: filepath.Join(config.ROOT_PATH, "config", "dkim", "dkim.priv"), + DkimPrivateKeyPath: filepath.Join(config.ROOT_PATH, "data", "dkim", "dkim.priv"), IsInit: true, } if _, err := auth.DkimGen(); err != nil { diff --git a/backend/res_init/directories_test.go b/backend/res_init/directories_test.go index c292d63e..a32f30b7 100644 --- a/backend/res_init/directories_test.go +++ b/backend/res_init/directories_test.go @@ -20,7 +20,7 @@ func TestDirInitUsesRuntimeRoot(t *testing.T) { if err := dirInit(); err != nil { t.Fatal(err) } - for _, name := range []string{"config", "config/dkim", "config/ssl"} { + for _, name := range []string{"config", "data", "data/dkim", "data/ssl"} { info, err := os.Stat(filepath.Join(root, name)) if err != nil || !info.IsDir() { t.Fatalf("运行目录未创建: %s", name) @@ -40,7 +40,7 @@ func TestDirInitPreservesExistingFiles(t *testing.T) { if err := dirInit(); err != nil { t.Fatal(err) } - files := []string{"config/config.json", "config/smail.db", "config/credential.key", "config/dkim/dkim.priv", "config/ssl/private.key"} + files := []string{"config/config.json", "data/smail.db", "data/credential.key", "data/dkim/dkim.priv", "data/ssl/private.key"} data := []byte("existing-runtime-fixture") for _, name := range files { if err := os.WriteFile(filepath.Join(root, name), data, 0600); err != nil { @@ -63,10 +63,10 @@ func TestDirInitRejectsFileAsDirectory(t *testing.T) { previous := config.ROOT_PATH config.ROOT_PATH = root t.Cleanup(func() { config.ROOT_PATH = previous }) - if err := os.Mkdir(filepath.Join(root, "config"), 0700); err != nil { + if err := os.Mkdir(filepath.Join(root, "data"), 0700); err != nil { t.Fatal(err) } - if err := os.WriteFile(filepath.Join(root, "config", "dkim"), []byte("blocked"), 0600); err != nil { + if err := os.WriteFile(filepath.Join(root, "data", "dkim"), []byte("blocked"), 0600); err != nil { t.Fatal(err) } if err := dirInit(); err == nil { diff --git a/backend/res_init/init.go b/backend/res_init/init.go index 6c39d665..2d973787 100644 --- a/backend/res_init/init.go +++ b/backend/res_init/init.go @@ -438,8 +438,8 @@ func stopAdminResetControl() { func dirInit() error { // 初始化与配置读写使用同一个运行根目录,不依赖启动时的工作目录。 - root := filepath.Join(config.ROOT_PATH, "config") - for _, directory := range []string{root, filepath.Join(root, "dkim"), filepath.Join(root, "ssl")} { + root := filepath.Join(config.ROOT_PATH, "data") + for _, directory := range []string{filepath.Join(config.ROOT_PATH, "config"), root, filepath.Join(root, "dkim"), filepath.Join(root, "ssl")} { if err := os.MkdirAll(directory, 0700); err != nil { return fmt.Errorf("创建运行配置目录失败: %w", err) } diff --git a/backend/services/auth/auth.go b/backend/services/auth/auth.go index 782adf43..fb6a226d 100644 --- a/backend/services/auth/auth.go +++ b/backend/services/auth/auth.go @@ -117,7 +117,7 @@ func HasAuth(ctx *context.Context, email *models.Email) bool { } func DkimGen() (string, error) { - basePath := filepath.Join(config.ROOT_PATH, "config", "dkim") + basePath := filepath.Join(config.ROOT_PATH, "data", "dkim") cfg := config.CurrentConfig() if cfg == nil { return "", fmt.Errorf("runtime configuration is unavailable") diff --git a/backend/services/dbmigration/portable_test.go b/backend/services/dbmigration/portable_test.go index 8dac0918..f5133c0d 100644 --- a/backend/services/dbmigration/portable_test.go +++ b/backend/services/dbmigration/portable_test.go @@ -19,10 +19,10 @@ import ( func portableFixture(t *testing.T) (string, config.DatabaseConfig) { t.Helper() root := t.TempDir() - if err := os.Mkdir(filepath.Join(root, "config"), 0700); err != nil { + if err := os.Mkdir(filepath.Join(root, "data"), 0700); err != nil { t.Fatal(err) } - database, err := sql.Open("sqlite", filepath.Join(root, "config", "source.db")) + database, err := sql.Open("sqlite", filepath.Join(root, "data", "source.db")) if err != nil { t.Fatal(err) } @@ -57,7 +57,7 @@ func TestPortableSQLiteCopyPreservesDataAndLocksUntilRestart(t *testing.T) { if err := executor.Preview(context.Background(), plan); err != nil { t.Fatal(err) } - if _, err := os.Stat(filepath.Join(root, "config", "target.db")); !os.IsNotExist(err) { + if _, err := os.Stat(filepath.Join(root, "data", "target.db")); !os.IsNotExist(err) { t.Fatal("preview created target") } if err := executor.Run(context.Background(), plan, func(Status) error { return nil }); err != nil { @@ -87,7 +87,7 @@ func TestPortableSQLiteCopyPreservesDataAndLocksUntilRestart(t *testing.T) { if err := target.QueryRow(`SELECT id FROM "user" WHERE account='next'`).Scan(&next); err != nil || next <= 40 { t.Fatal("identity sequence not advanced") } - old, err := sql.Open("sqlite", filepath.Join(root, "config", "source.db")+"?_pragma=busy_timeout(1)") + old, err := sql.Open("sqlite", filepath.Join(root, "data", "source.db")+"?_pragma=busy_timeout(1)") if err != nil { t.Fatal(err) } @@ -113,7 +113,7 @@ func TestPortableSwitchFailurePreservesSourceAndTarget(t *testing.T) { t.Fatal("rejected switch kept write lock") } for _, name := range []string{"source.db", "target.db"} { - if _, err := os.Stat(filepath.Join(root, "config", name)); err != nil { + if _, err := os.Stat(filepath.Join(root, "data", name)); err != nil { t.Fatal("database removed") } } @@ -205,7 +205,7 @@ func TestPortableRejectsCustomObjectsBeforeCreatingTarget(t *testing.T) { if err := executor.Run(context.Background(), plan, func(Status) error { return nil }); !errors.Is(err, ErrSQLUnsupportedObject) { t.Fatalf("custom view accepted: %v", err) } - if _, err := os.Stat(filepath.Join(root, "config", "target.db")); !os.IsNotExist(err) { + if _, err := os.Stat(filepath.Join(root, "data", "target.db")); !os.IsNotExist(err) { t.Fatal("unsupported source created target") } } diff --git a/backend/services/dbmigration/service_test.go b/backend/services/dbmigration/service_test.go index bbb57a78..4d7450e2 100644 --- a/backend/services/dbmigration/service_test.go +++ b/backend/services/dbmigration/service_test.go @@ -241,7 +241,7 @@ func TestExecuteAuthorizedPassesActorToSQLiteSwitch(t *testing.T) { root = t.TempDir() executor = NewAuthorizedSQLiteExecutor(root, switchConfig) service = NewService(executor) - configDirectory := filepath.Join(root, "config") + configDirectory := filepath.Join(root, "data") if err := os.Mkdir(configDirectory, 0700); err != nil { t.Fatal(err) } diff --git a/backend/services/dbmigration/sqlite_executor.go b/backend/services/dbmigration/sqlite_executor.go index bb85e365..7bb755ed 100644 --- a/backend/services/dbmigration/sqlite_executor.go +++ b/backend/services/dbmigration/sqlite_executor.go @@ -152,7 +152,7 @@ func (e *SQLiteExecutor) resolveReference(reference string) (string, error) { if err != nil { return "", ErrInvalidTargetName } - configDirectory := filepath.Join(root, "config") + configDirectory := filepath.Join(root, "data") info, err := os.Lstat(configDirectory) if err != nil || info.Mode()&os.ModeSymlink != 0 || !info.IsDir() { return "", ErrInvalidTargetName diff --git a/backend/services/dbmigration/sqlite_executor_test.go b/backend/services/dbmigration/sqlite_executor_test.go index 70314296..7997808b 100644 --- a/backend/services/dbmigration/sqlite_executor_test.go +++ b/backend/services/dbmigration/sqlite_executor_test.go @@ -17,7 +17,7 @@ import ( func newSQLiteMigrationFixture(t *testing.T, switchConfig SQLiteSwitch) (*Service, string) { t.Helper() root := t.TempDir() - configDirectory := filepath.Join(root, "config") + configDirectory := filepath.Join(root, "data") if err := os.Mkdir(configDirectory, 0700); err != nil { t.Fatal(err) } @@ -57,7 +57,7 @@ func TestSQLiteExecutorCopiesDatabaseAndSwitchesConfiguration(t *testing.T) { if switched.LocalRef != "smail-next.db" || switched.Type != config.DatabaseTypeSQLite { t.Fatalf("unexpected switched configuration: %+v", switched) } - database, err := sql.Open("sqlite", filepath.Join(root, "config", "smail-next.db")) + database, err := sql.Open("sqlite", filepath.Join(root, "data", "smail-next.db")) if err != nil { t.Fatal(err) } @@ -69,7 +69,7 @@ func TestSQLiteExecutorCopiesDatabaseAndSwitchesConfiguration(t *testing.T) { if body != "测试邮件" { t.Fatalf("copied row = %q, want copied content", body) } - info, err := os.Stat(filepath.Join(root, "config", "smail-next.db")) + info, err := os.Stat(filepath.Join(root, "data", "smail-next.db")) if err != nil { t.Fatal(err) } @@ -84,10 +84,10 @@ func TestSQLiteExecutorSupportsNestedReferences(t *testing.T) { switched = candidate return nil }) - if err := os.MkdirAll(filepath.Join(root, "config", "archive"), 0700); err != nil { + if err := os.MkdirAll(filepath.Join(root, "data", "archive"), 0700); err != nil { t.Fatal(err) } - if err := os.Rename(filepath.Join(root, "config", "smail.db"), filepath.Join(root, "config", "archive", "review.db")); err != nil { + if err := os.Rename(filepath.Join(root, "data", "smail.db"), filepath.Join(root, "data", "archive", "review.db")); err != nil { t.Fatal(err) } record, token, err := service.Preview(context.Background(), config.DatabaseConfig{Type: config.DatabaseTypeSQLite, LocalRef: "archive/review.db"}, 1, "archive/next.db") @@ -101,14 +101,14 @@ func TestSQLiteExecutorSupportsNestedReferences(t *testing.T) { if switched.LocalRef != "archive/next.db" { t.Fatalf("switched localRef = %q, want archive/next.db", switched.LocalRef) } - if _, err := os.Stat(filepath.Join(root, "config", "archive", "next.db")); err != nil { + if _, err := os.Stat(filepath.Join(root, "data", "archive", "next.db")); err != nil { t.Fatal(err) } } func TestSQLiteExecutorRejectsExistingTarget(t *testing.T) { service, root := newSQLiteMigrationFixture(t, func(context.Context, config.DatabaseConfig) error { return nil }) - if err := os.WriteFile(filepath.Join(root, "config", "smail-next.db"), []byte("existing"), 0600); err != nil { + if err := os.WriteFile(filepath.Join(root, "data", "smail-next.db"), []byte("existing"), 0600); err != nil { t.Fatal(err) } record, token, err := service.Preview(context.Background(), config.DatabaseConfig{Type: config.DatabaseTypeSQLite, LocalRef: "smail.db"}, 1, "smail-next.db") @@ -126,10 +126,10 @@ func TestSQLiteExecutorRejectsExistingTarget(t *testing.T) { func TestSQLiteExecutorRejectsCorruptSource(t *testing.T) { root := t.TempDir() - if err := os.Mkdir(filepath.Join(root, "config"), 0700); err != nil { + if err := os.Mkdir(filepath.Join(root, "data"), 0700); err != nil { t.Fatal(err) } - if err := os.WriteFile(filepath.Join(root, "config", "smail.db"), []byte("not sqlite"), 0600); err != nil { + if err := os.WriteFile(filepath.Join(root, "data", "smail.db"), []byte("not sqlite"), 0600); err != nil { t.Fatal(err) } executor := NewSQLiteExecutor(root, func(context.Context, config.DatabaseConfig) error { return nil }) @@ -162,7 +162,7 @@ func TestSQLiteExecutorRequiresConfigurationSwitch(t *testing.T) { if failed.ErrorCode != "SWITCH_UNAVAILABLE" { t.Fatalf("error code = %q, want SWITCH_UNAVAILABLE", failed.ErrorCode) } - if _, err := os.Stat(filepath.Join(root, "config", "next.db")); !errors.Is(err, os.ErrNotExist) { + if _, err := os.Stat(filepath.Join(root, "data", "next.db")); !errors.Is(err, os.ErrNotExist) { t.Fatalf("target database remained after switch failure, stat error = %v", err) } } @@ -179,7 +179,7 @@ func TestSQLiteExecutorCleansTargetForKnownConfigurationSwitchRejection(t *testi if !errors.Is(err, config.ErrGenerationConflict) || errors.Is(err, ErrSwitchOutcomeUnknown) { t.Fatalf("known switch rejection = %v, record = %+v", err, failed) } - if _, statErr := os.Stat(filepath.Join(root, "config", "known-rejection.db")); !errors.Is(statErr, os.ErrNotExist) { + if _, statErr := os.Stat(filepath.Join(root, "data", "known-rejection.db")); !errors.Is(statErr, os.ErrNotExist) { t.Fatalf("target database remained after known switch rejection, stat error = %v", statErr) } } @@ -199,7 +199,7 @@ func TestSQLiteExecutorPreservesTargetWhenConfigurationSwitchOutcomeIsUnknown(t if !errors.Is(err, ErrSwitchOutcomeUnknown) { t.Fatalf("switch failure error = %v, want unknown switch outcome", err) } - if _, statErr := os.Stat(filepath.Join(root, "config", "next.db")); statErr != nil { + if _, statErr := os.Stat(filepath.Join(root, "data", "next.db")); statErr != nil { t.Fatalf("target database was removed after unknown switch outcome: %v", statErr) } } @@ -209,8 +209,8 @@ func TestSQLiteExecutorRejectsTargetSymlink(t *testing.T) { t.Skip("Windows 创建符号链接需要额外权限") } service, root := newSQLiteMigrationFixture(t, func(context.Context, config.DatabaseConfig) error { return nil }) - target := filepath.Join(root, "config", "next.db") - if err := os.Symlink(filepath.Join(root, "config", "smail.db"), target); err != nil { + target := filepath.Join(root, "data", "next.db") + if err := os.Symlink(filepath.Join(root, "data", "smail.db"), target); err != nil { t.Fatal(err) } record, token, err := service.Preview(context.Background(), config.DatabaseConfig{Type: config.DatabaseTypeSQLite, LocalRef: "smail.db"}, 1, "next.db") @@ -267,7 +267,7 @@ func TestSQLiteExecutorReportsOrderedStatuses(t *testing.T) { if len(statuses) != 2 || statuses[0] != StatusVerifying || statuses[1] != StatusSwitching { t.Fatalf("statuses = %v, want verifying then switching", statuses) } - if _, err := os.Stat(filepath.Join(root, "config", "next.db")); err != nil { + if _, err := os.Stat(filepath.Join(root, "data", "next.db")); err != nil { t.Fatal(err) } } diff --git a/backend/services/externalemail/vault.go b/backend/services/externalemail/vault.go index fa4ca9b3..cb15240b 100644 --- a/backend/services/externalemail/vault.go +++ b/backend/services/externalemail/vault.go @@ -16,6 +16,8 @@ import ( "runtime" "strings" "sync" + + "git.pcux.cn/xuans/Smail/utils/runtimepath" ) const ( @@ -41,8 +43,13 @@ func NewVault(root string) (*Vault, error) { if strings.TrimSpace(root) == "" { return nil, ErrVaultUnavailable } - configDir := filepath.Join(root, "config") - if err := os.MkdirAll(configDir, 0700); err != nil { + for _, name := range []string{"external-email-encryption.key", "external-email-fingerprint.key"} { + if _, err := os.Lstat(filepath.Join(root, "config", name)); err == nil || !os.IsNotExist(err) { + return nil, ErrVaultUnavailable + } + } + configDir, err := runtimepath.Directory(root) + if err != nil { return nil, ErrVaultUnavailable } encryptionKey, err := loadKey(filepath.Join(configDir, "external-email-encryption.key")) diff --git a/backend/services/setup/db.go b/backend/services/setup/db.go index df2d1094..9734a84b 100644 --- a/backend/services/setup/db.go +++ b/backend/services/setup/db.go @@ -80,7 +80,7 @@ func GetDatabaseSettings(ctx *context.Context) (string, string, error) { return "", "", errors.Wrap(err) } if configData.DbType == "" && configData.DbDSN == "" { - return config.DBTypeSQLite, config.ROOT_PATH + "./config/smail.db", nil + return config.DBTypeSQLite, config.ROOT_PATH + "./data/smail.db", nil } return configData.DbType, configData.DbDSN, nil } @@ -98,7 +98,7 @@ func GetDatabaseSettingsDetail(ctx *context.Context) (map[string]string, error) } if dbType == config.DBTypeSQLite { if strings.TrimSpace(result["db_dsn"]) == "" { - result["db_dsn"] = config.ROOT_PATH + "./config/smail.db" + result["db_dsn"] = config.ROOT_PATH + "./data/smail.db" } return result, nil } @@ -238,7 +238,7 @@ func SetDatabaseSettingsWithOptions(ctx *context.Context, settings DatabaseSetti } if dbType == config.DBTypeSQLite { if dbDSN == "" { - dbDSN = config.ROOT_PATH + "./config/smail.db" + dbDSN = config.ROOT_PATH + "./data/smail.db" } if err = prepareSQLiteDatabase(dbDSN); err != nil { return databaseError("准备 SQLite 数据文件失败", err) diff --git a/backend/services/setup/ssl/ssl.go b/backend/services/setup/ssl/ssl.go index b5696188..b9e7a73a 100644 --- a/backend/services/setup/ssl/ssl.go +++ b/backend/services/setup/ssl/ssl.go @@ -116,7 +116,7 @@ func SetSSL(sslType, priKey, crtKey string) error { cfg.SSL = config.SSLConfig{ Management: config.SSLManagementProject, Mode: config.ManagedSSLModeDefault, - DefaultDirectory: "config/ssl", + DefaultDirectory: "data/ssl", } if cfg.SSLType == config.SSLTypeAutoDNS { cfg.SSL.Challenge = config.SSLChallengeDNS @@ -190,12 +190,12 @@ func applyManagedSSLReference(cfg *config.Config, reference config.ManagedSSLRef cfg.SSL = config.SSLConfig{ Management: management, Mode: reference.Mode, - DefaultDirectory: "config/ssl", + DefaultDirectory: "data/ssl", CertificateRef: reference.CertificateRef, PrivateKeyRef: reference.PrivateKeyRef, } if reference.Mode == config.ManagedSSLModeUpload { - cfg.SSL.CustomDirectory = "config/ssl/managed/upload" + cfg.SSL.CustomDirectory = "data/ssl/managed/upload" } else if cfg.SSLType == config.SSLTypeAutoDNS { cfg.SSL.Challenge = config.SSLChallengeDNS } else { diff --git a/backend/services/setup/ssl/storage.go b/backend/services/setup/ssl/storage.go index d0729b3b..0c791be4 100644 --- a/backend/services/setup/ssl/storage.go +++ b/backend/services/setup/ssl/storage.go @@ -31,7 +31,7 @@ func writeCertificateBundle(cfg *config.Config, privateKey, certificate, issuer return err } defer workspaceRoot.Close() - baseRelative := filepath.Join("config", "ssl") + baseRelative := filepath.Join("data", "ssl") if err := ensureSecureRootDirectory(workspaceRoot, baseRelative); err != nil { return err } @@ -57,7 +57,7 @@ func writeCertificateBundle(cfg *config.Config, privateKey, certificate, issuer } relativePath, err := securefile.ControlledRelativePath(basePath, item.path) if err != nil { - return errors.New("SSL file path must stay inside config/ssl") + return errors.New("SSL file path must stay inside data/ssl") } if _, exists := seen[relativePath]; exists { return errors.New("SSL file paths must be unique") diff --git a/backend/services/setup/ssl/storage_test.go b/backend/services/setup/ssl/storage_test.go index c066de88..f80fbed3 100644 --- a/backend/services/setup/ssl/storage_test.go +++ b/backend/services/setup/ssl/storage_test.go @@ -17,7 +17,7 @@ func TestWriteCertificateBundleUsesRestrictedAtomicStorage(t *testing.T) { root := t.TempDir() config.ROOT_PATH = root + string(os.PathSeparator) t.Cleanup(func() { config.ROOT_PATH = oldRoot }) - basePath := filepath.Join(root, "config", "ssl") + basePath := filepath.Join(root, "data", "ssl") cfg := &config.Config{ SSLPrivateKeyPath: filepath.Join(basePath, "private.key"), SSLPublicKeyPath: filepath.Join(basePath, "public.crt"), @@ -52,7 +52,7 @@ func TestWriteCertificateBundleUsesRestrictedAtomicStorage(t *testing.T) { } } if runtime.GOOS != "windows" { - for _, directory := range []string{filepath.Join(root, "config"), basePath} { + for _, directory := range []string{filepath.Join(root, "data"), basePath} { info, err := os.Stat(directory) if err != nil { t.Fatal(err) @@ -79,7 +79,7 @@ func TestWriteCertificateBundleRejectsSymlinkDirectory(t *testing.T) { root := t.TempDir() config.ROOT_PATH = root + string(os.PathSeparator) t.Cleanup(func() { config.ROOT_PATH = oldRoot }) - configDirectory := filepath.Join(root, "config") + configDirectory := filepath.Join(root, "data") if err := os.Mkdir(configDirectory, 0700); err != nil { t.Fatal(err) } @@ -103,7 +103,7 @@ func TestWriteCertificateBundleRejectsSymlinkFile(t *testing.T) { root := t.TempDir() config.ROOT_PATH = root + string(os.PathSeparator) t.Cleanup(func() { config.ROOT_PATH = oldRoot }) - basePath := filepath.Join(root, "config", "ssl") + basePath := filepath.Join(root, "data", "ssl") if err := os.MkdirAll(basePath, 0700); err != nil { t.Fatal(err) } @@ -139,7 +139,7 @@ func TestWriteCertificateBundleRejectsMismatchedPair(t *testing.T) { root := t.TempDir() config.ROOT_PATH = root + string(os.PathSeparator) t.Cleanup(func() { config.ROOT_PATH = oldRoot }) - basePath := filepath.Join(root, "config", "ssl") + basePath := filepath.Join(root, "data", "ssl") cfg := &config.Config{ SSLPrivateKeyPath: filepath.Join(basePath, "private.key"), SSLPublicKeyPath: filepath.Join(basePath, "public.crt"), diff --git a/backend/services/setup/ssl/user_certificate_test.go b/backend/services/setup/ssl/user_certificate_test.go index 8a428d57..15e368d5 100644 --- a/backend/services/setup/ssl/user_certificate_test.go +++ b/backend/services/setup/ssl/user_certificate_test.go @@ -94,7 +94,7 @@ func TestApplyManagedSSLReferenceDoesNotPersistLegacyPaths(t *testing.T) { if cfg.SSL.Mode != config.ManagedSSLModeUpload || cfg.SSL.CertificateRef != reference.CertificateRef || cfg.SSL.PrivateKeyRef != reference.PrivateKeyRef { t.Fatalf("受控 SSL 内部引用写入错误: %+v", cfg.SSL) } - if cfg.SSL.CustomDirectory != "config/ssl/managed/upload" { + if cfg.SSL.CustomDirectory != "data/ssl/managed/upload" { t.Fatalf("自定义受控目录写入错误: %s", cfg.SSL.CustomDirectory) } } diff --git a/backend/utils/credential/encryption.go b/backend/utils/credential/encryption.go index 05b1bf56..bb454af1 100644 --- a/backend/utils/credential/encryption.go +++ b/backend/utils/credential/encryption.go @@ -85,7 +85,7 @@ func loadOrCreateKey(root string) ([]byte, error) { if !os.IsNotExist(err) { return nil, err } - directory := filepath.Join(root, "config") + directory := filepath.Join(root, "data") if err := os.MkdirAll(directory, 0700); err != nil { return nil, err } @@ -158,7 +158,13 @@ func newCredentialKeyTemporaryName() (string, error) { } func readKey(root string) ([]byte, error) { - directory := filepath.Join(root, "config") + // 旧密钥尚未迁移时拒绝生成新密钥,避免现有密文永久失去读取能力。 + if _, err := os.Lstat(filepath.Join(root, "config", "credential.key")); err == nil { + return nil, errors.New("凭据密钥尚未迁移到 data") + } else if !os.IsNotExist(err) { + return nil, err + } + directory := filepath.Join(root, "data") if err := validateKeyDirectory(directory); err != nil { return nil, err } diff --git a/backend/utils/credential/encryption_test.go b/backend/utils/credential/encryption_test.go index 07686dee..1bef3c07 100644 --- a/backend/utils/credential/encryption_test.go +++ b/backend/utils/credential/encryption_test.go @@ -22,7 +22,7 @@ func TestEncryptDecrypt(t *testing.T) { if err != nil || decrypted != "secret-value" { t.Fatal("credential could not be decrypted") } - info, err := os.Stat(filepath.Join(root, "config", "credential.key")) + info, err := os.Stat(filepath.Join(root, "data", "credential.key")) if err != nil { t.Fatal(err) } @@ -95,7 +95,7 @@ func TestReadKeyRejectsDirectorySymlink(t *testing.T) { if err := os.WriteFile(filepath.Join(target, "credential.key"), make([]byte, 32), 0600); err != nil { t.Fatal(err) } - if err := os.Symlink(target, filepath.Join(root, "config")); err != nil { + if err := os.Symlink(target, filepath.Join(root, "data")); err != nil { t.Skipf("symlink is unavailable: %v", err) } if _, err := readKey(root); err == nil { @@ -105,7 +105,7 @@ func TestReadKeyRejectsDirectorySymlink(t *testing.T) { func TestReadKeyRejectsKeySymlink(t *testing.T) { root := t.TempDir() - configDir := filepath.Join(root, "config") + configDir := filepath.Join(root, "data") if err := os.MkdirAll(configDir, 0700); err != nil { t.Fatal(err) } @@ -151,7 +151,7 @@ func TestConcurrentEncryptUsesSingleCompleteKey(t *testing.T) { t.Fatalf("concurrent credential could not be decrypted: %v", err) } } - entries, err := os.ReadDir(filepath.Join(root, "config")) + entries, err := os.ReadDir(filepath.Join(root, "data")) if err != nil { t.Fatal(err) } diff --git a/backend/utils/credential/vault_test.go b/backend/utils/credential/vault_test.go index 2bfba1b3..2634f405 100644 --- a/backend/utils/credential/vault_test.go +++ b/backend/utils/credential/vault_test.go @@ -34,7 +34,7 @@ func TestVaultRejectsBroadKeyPermissions(t *testing.T) { t.Skip("POSIX permission bits are unavailable") } root := t.TempDir() - configDir := filepath.Join(root, "config") + configDir := filepath.Join(root, "data") if err := os.Mkdir(configDir, 0700); err != nil { t.Fatal(err) } @@ -51,7 +51,7 @@ func TestVaultRejectsBroadDirectoryPermissions(t *testing.T) { t.Skip("POSIX permission bits are unavailable") } root := t.TempDir() - configDir := filepath.Join(root, "config") + configDir := filepath.Join(root, "data") if err := os.Mkdir(configDir, 0755); err != nil { t.Fatal(err) } diff --git a/backend/utils/runtimepath/layout.go b/backend/utils/runtimepath/layout.go new file mode 100644 index 00000000..3974d6d9 --- /dev/null +++ b/backend/utils/runtimepath/layout.go @@ -0,0 +1,257 @@ +// Package runtimepath 统一运行数据目录;配置文件仍固定保存在 config 中。 +package runtimepath + +import ( + "encoding/json" + "errors" + "fmt" + "os" + "path/filepath" + "strings" +) + +var ErrMigrationRequired = errors.New("运行数据仍在 config 中,请停止服务并运行 smail-config --runtime-data --apply") + +const migrationLock = ".runtime-migration.lock" + +// Directory 创建受保护的数据目录,拒绝符号链接及普通文件。 +func Directory(root string) (string, error) { + if strings.TrimSpace(root) == "" { + return "", errors.New("运行根目录为空") + } + directory := filepath.Join(root, "data") + if err := os.Mkdir(directory, 0700); err != nil && !os.IsExist(err) { + return "", err + } + info, err := os.Lstat(directory) + if err != nil || !info.IsDir() || info.Mode()&os.ModeSymlink != 0 { + return "", errors.New("运行数据目录无效") + } + if err := os.Chmod(directory, 0700); err != nil { + return "", err + } + return directory, nil +} + +// LegacyReference 只转换旧运行目录的相对引用,不放宽路径安全检查。 +func LegacyReference(value string) string { + valueWithoutDot := strings.TrimPrefix(value, "./") + for _, prefix := range []string{"config/ssl", "config/dkim"} { + if valueWithoutDot == prefix || strings.HasPrefix(valueWithoutDot, prefix+"/") { + return "data/" + strings.TrimPrefix(valueWithoutDot, "config/") + } + } + return value +} + +var configurationFiles = map[string]bool{ + "config.json": true, "smtp.json": true, "email.json": true, + "ssl.json": true, "plugins.json": true, +} + +var runtimeEntries = map[string]bool{ + "credential.key": true, "external-email-encryption.key": true, + "external-email-fingerprint.key": true, "config-audit-v2.jsonl": true, + "ssl": true, "dkim": true, "backups": true, "backups-v2": true, + "migration-backups": true, "transaction": true, +} + +var obsoleteFiles = map[string]bool{ + "config.dev.json": true, "config_mysql.json": true, "config.json.legacy": true, +} + +type Move struct { + Source string + Target string +} + +// Plan 检查整个迁移集合,未知文件、目标冲突或链接均拒绝自动处理。 +func Plan(root string) ([]Move, error) { + absolute, err := filepath.Abs(root) + if err != nil { + return nil, err + } + configDirectory := filepath.Join(absolute, "config") + if err := safeTree(configDirectory); err != nil { + if os.IsNotExist(err) { + return nil, nil + } + return nil, err + } + dataDirectory := filepath.Join(absolute, "data") + // 只检查目标父目录,不在每次启动时遍历全部邮件备份和证书历史。 + if err := safeDirectory(dataDirectory); err != nil && !os.IsNotExist(err) { + return nil, err + } + entries, err := os.ReadDir(configDirectory) + if err != nil { + return nil, err + } + var moves []Move + for _, entry := range entries { + name := entry.Name() + if configurationFiles[name] && !entry.IsDir() { + continue + } + target := filepath.Join(absolute, "data", name) + switch { + case obsoleteFiles[name] && !entry.IsDir(): + target = filepath.Join(absolute, "data", "legacy-config", name) + case runtimeEntries[name], !entry.IsDir() && databaseFile(name): + default: + return nil, fmt.Errorf("config 中存在未识别项目,请人工核对:%s", name) + } + if err := safeDirectory(filepath.Dir(target)); err != nil && !os.IsNotExist(err) { + return nil, err + } + if _, err := os.Lstat(target); err == nil { + return nil, fmt.Errorf("迁移目标已存在,拒绝覆盖:%s", name) + } else if !os.IsNotExist(err) { + return nil, err + } + moves = append(moves, Move{Source: filepath.Join(configDirectory, name), Target: target}) + } + return moves, nil +} + +func databaseFile(name string) bool { + for _, suffix := range []string{"-wal", "-shm", "-journal"} { + name = strings.TrimSuffix(name, suffix) + } + switch filepath.Ext(name) { + case ".db", ".sqlite", ".sqlite3": + return true + } + return false +} + +func safeTree(path string) error { + return filepath.WalkDir(path, func(_ string, entry os.DirEntry, err error) error { + if err != nil { + return err + } + if entry.Type()&os.ModeSymlink != 0 || (!entry.IsDir() && !entry.Type().IsRegular()) { + return errors.New("迁移目录中存在链接或特殊文件") + } + return nil + }) +} + +func safeDirectory(path string) error { + info, err := os.Lstat(path) + if err != nil { + return err + } + if !info.IsDir() || info.Mode()&os.ModeSymlink != 0 { + return errors.New("运行目录必须是实际目录,不能是链接或普通文件") + } + return nil +} + +// CheckReady 防止遗漏迁移时创建空账号库或重新生成加密密钥。 +func CheckReady(root string) error { + if _, err := os.Lstat(filepath.Join(root, "data", migrationLock)); err == nil || !os.IsNotExist(err) { + return errors.New("运行目录迁移尚未结束,请保留现场并核对迁移锁") + } + moves, err := Plan(root) + if err != nil { + return err + } + if len(moves) != 0 { + return ErrMigrationRequired + } + // 已初始化部署缺失账号库或加密密钥时必须报错,不能按首次安装处理。 + raw, err := os.ReadFile(filepath.Join(root, "config", "config.json")) + if os.IsNotExist(err) { + return nil + } + if err != nil { + return err + } + var config struct { + SetupState string `json:"setupState"` + Database struct { + Type string `json:"type"` + LocalRef string `json:"localRef"` + } `json:"database"` + } + if err := json.Unmarshal(raw, &config); err != nil { + return err + } + if config.SetupState != "ready" { + return nil + } + required := []string{"credential.key", "external-email-encryption.key", "external-email-fingerprint.key"} + if config.Database.Type == "sqlite" { + if !filepath.IsLocal(config.Database.LocalRef) { + return errors.New("SQLite 本地引用无效") + } + required = append(required, config.Database.LocalRef) + } + for _, name := range required { + parent := filepath.Dir(name) + for parent != "." { + if err := safeDirectory(filepath.Join(root, "data", parent)); err != nil { + return err + } + parent = filepath.Dir(parent) + } + info, err := os.Lstat(filepath.Join(root, "data", name)) + if err != nil || !info.Mode().IsRegular() || info.Size() == 0 { + return fmt.Errorf("已初始化部署缺少必要运行文件,拒绝重新创建:%s", name) + } + } + return nil +} + +// Migrate 必须停服调用;同卷重命名保留文件内容,失败逆序回滚,重试保持幂等。 +func Migrate(root string) ([]Move, error) { + return migrate(root, os.Rename) +} + +func migrate(root string, rename func(string, string) error) ([]Move, error) { + moves, err := Plan(root) + if err != nil { + return moves, err + } + directory, err := Directory(root) + if err != nil { + return nil, err + } + lockPath := filepath.Join(directory, migrationLock) + lock, err := os.OpenFile(lockPath, os.O_WRONLY|os.O_CREATE|os.O_EXCL, 0600) + if err != nil { + return nil, errors.New("无法取得迁移锁;请确认没有其他迁移进程,并人工核对中断现场") + } + if err := lock.Close(); err != nil { + return nil, err + } + keepLock := false + defer func() { + if !keepLock { + _ = os.Remove(lockPath) + } + }() + // 取得独占锁后重新检查,避免两个迁移进程使用同一份旧计划。 + moves, err = Plan(root) + if err != nil { + return nil, err + } + var completed []Move + for _, move := range moves { + if err = os.MkdirAll(filepath.Dir(move.Target), 0700); err == nil { + err = rename(move.Source, move.Target) + } + if err != nil { + for index := len(completed) - 1; index >= 0; index-- { + item := completed[index] + rollbackErr := rename(item.Target, item.Source) + keepLock = keepLock || rollbackErr != nil + err = errors.Join(err, rollbackErr) + } + return nil, fmt.Errorf("运行数据迁移失败,已尝试回滚:%w", err) + } + completed = append(completed, move) + } + return completed, nil +} diff --git a/deploy/install-windows.ps1 b/deploy/install-windows.ps1 index 56368c42..c3d0a754 100644 --- a/deploy/install-windows.ps1 +++ b/deploy/install-windows.ps1 @@ -117,6 +117,7 @@ $adminSource = Resolve-PackageFile -Candidates @( $resolvedInstallRoot = [IO.Path]::GetFullPath($InstallRoot) New-Item -ItemType Directory -Path $resolvedInstallRoot -Force | Out-Null New-Item -ItemType Directory -Path (Join-Path $resolvedInstallRoot "config") -Force | Out-Null +New-Item -ItemType Directory -Path (Join-Path $resolvedInstallRoot "data") -Force | Out-Null $transactionRoot = Join-Path $resolvedInstallRoot (".upgrade-" + [Guid]::NewGuid().ToString("N")) $backupRoot = Join-Path $resolvedInstallRoot (".backup-" + [Guid]::NewGuid().ToString("N")) New-Item -ItemType Directory -Path $transactionRoot -Force | Out-Null diff --git a/deploy/start-dev.ps1 b/deploy/start-dev.ps1 index 311c2696..a2488ecc 100644 --- a/deploy/start-dev.ps1 +++ b/deploy/start-dev.ps1 @@ -41,7 +41,7 @@ try { $arguments = @('--dev-disable-admin-reset') Write-Output '开发启动:后端 API 仅监听 5201;沿用 config/config.json 和现有数据库;明确停用管理员恢复通道,不请求权限提升。' if ($SkipBuild) { Write-Warning '已跳过编译,请自行确认二进制与当前源码一致。' } - # 插件从 out/plugins 加载;账号、配置和密钥仍通过 SMAIL_ROOT 定位到根目录 config。 + # 插件从 out/plugins 加载;SMAIL_ROOT 下 config 保存配置,data 保存账号、密钥和证书。 foreach ($name in @('spam_block.exe', 'pmail_telegram_push.exe', 'wechat_push.exe')) { if (-not (Test-Path -LiteralPath (Join-Path $root "out\plugins\$name") -PathType Leaf)) { throw '内置插件产物不完整,请先运行 deploy/build.ps1' diff --git a/docs/运行目录迁移说明.md b/docs/运行目录迁移说明.md new file mode 100644 index 00000000..e0ce8cbd --- /dev/null +++ b/docs/运行目录迁移说明.md @@ -0,0 +1,47 @@ +# 运行目录迁移说明 + +`SMAIL_ROOT` 始终指向服务根目录,不能指向 `config`、`data` 或编译输出目录。 + +```text +服务根目录/ +├── config/ # 仅五个当前配置文件 +│ ├── config.json +│ ├── smtp.json +│ ├── email.json +│ ├── ssl.json +│ └── plugins.json +└── data/ # 必须与配置一起备份,不得上传 Git + ├── *.db # SQLite 数据库及其附属文件 + ├── *.key # 原加密密钥,不可重新生成或替换 + ├── ssl/ # 证书、私钥、签发账号、受管版本 + ├── dkim/ # 邮件签名密钥 + ├── backups-v2/ # 分区配置历史备份 + ├── transaction/ # 配置事务与故障恢复 + ├── migration-backups/ # 旧配置迁移备份 + ├── config-audit-v2.jsonl + └── legacy-config/ # 待验收后人工清理的废弃配置 +``` + +## 升级旧部署 + +1. 停止后端及自动重启服务,确认没有其他进程读写数据库;关闭前端开发服务器。 +2. 将整个旧 `config` 目录备份到受保护位置,包括数据库的 WAL、SHM 和日志文件。不要使用历史配置备份替换当前配置。 +3. 编译配置工具:在 `backend` 中运行 `go build -o ../out/backend/smail-config.exe ./cmd/smail-config`。Linux 去掉 `.exe`。 +4. 只读检查:`smail-config --root 服务根目录 --runtime-data`。 +5. 确认已停服后执行:`smail-config --root 服务根目录 --runtime-data --apply`。 +6. 核对迁移清单及文件哈希,启动新版后端,然后启动前端。Windows 开发入口为 `deploy/start-dev.ps1`,后端仍是 5201,前端仍是 80/443。 +7. 验证登录、证书、配置保存、备份及审计。通过后才能清理 `data/legacy-config` 中明确废弃的文件;数据库、密钥和证书不能删除。 + +工具不会覆盖目标文件。未知项目、符号链接或目标冲突会阻止迁移。操作失败时逆序回滚已移动项目;回滚失败时保留现场和原始备份,禁止启动旧后端或新建数据库。迁移独占锁为 `data/.runtime-migration.lock`;进程崩溃或回滚失败后会保留锁并阻止启动,管理员必须先确认没有运行进程、核对源和目标文件与备份一致,再移除残留锁并重新检查。已移动项目不会重复覆盖。嵌套 SQLite 目录须根据 `database.localRef` 人工核对,未知目录不会被自动处理。 + +若升级前只有旧格式 `config.json`,先执行运行目录迁移,再执行 `smail-config --root 服务根目录 --apply` 转换为五个分区配置。不要先生成新密钥,也不要用旧格式配置覆盖现有分区配置。迁移工具不自动备份整个数据库目录,也不自动停止服务;停服和完整备份是执行前提。 + +迁移只移动运行文件,不改写五个配置的字节、代次和摘要。旧 `config/ssl` 相对引用先通过原摘要校验,再在运行态解析到 `data/ssl`;下一次正常保存会写入新引用。历史备份不改写摘要,恢复时沿用同一兼容规则。 + +## 权限与回退 + +- Linux:`config`、`data` 由专用服务账号拥有,目录 0700、敏感文件 0600;不要给普通账号开放读取权限。 +- Windows:正式服务由安装脚本设置服务账户和受保护 ACL;开发模式仍明确停用管理员恢复通道,不提升普通邮件业务权限。 +- 加密密钥必须与数据库及配置一同迁移,不能只复制 JSON。已初始化部署缺少数据库或关键密钥时,新后端拒绝启动,不会默默生成空库。 +- 需要回退时先停服,使用迁移前的完整备份与对应旧二进制成套恢复;若迁移后已经收信或修改账号,先备份最新数据并制定数据回迁方案,不能直接覆盖。 +- 前端开发证书默认读取 `data/ssl/xuans.com.crt` 与 `data/ssl/xuans.com.key`;自定义环境变量指向旧位置时需要同步修改。 diff --git a/frontend/.env.development b/frontend/.env.development index 1221c08d..b7318a15 100644 --- a/frontend/.env.development +++ b/frontend/.env.development @@ -1,5 +1,5 @@ VITE_DEV_BACKEND_URL=http://127.0.0.1:5201 VITE_DEV_BACKEND_ORIGIN=https://xuans.com VITE_DEV_FRONTEND_ORIGIN=https://xuans.com -SMAIL_DEV_TLS_CERTIFICATE=../config/ssl/xuans.com.crt -SMAIL_DEV_TLS_PRIVATE_KEY=../config/ssl/xuans.com.key +SMAIL_DEV_TLS_CERTIFICATE=../data/ssl/xuans.com.crt +SMAIL_DEV_TLS_PRIVATE_KEY=../data/ssl/xuans.com.key diff --git a/frontend/README.md b/frontend/README.md index d30e7141..9bf3f4fb 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -18,7 +18,7 @@ yarn dev VITE_DEV_BACKEND_URL=http://127.0.0.1:5201 ``` -前端开发服务使用 `config/ssl` 下的证书提供 HTTPS,HTTP `80` 只负责跳转到 HTTPS。生产环境应使用有效证书,并由正式 Web 服务器承载前端入口。 +前端开发服务使用 `data/ssl` 下的证书提供 HTTPS,HTTP `80` 只负责跳转到 HTTPS。生产环境应使用有效证书,并由正式 Web 服务器承载前端入口。生产构建不读取本机开发证书。 ### 生产构建 diff --git a/frontend/src/i18n/i18n.js b/frontend/src/i18n/i18n.js index 550b6067..79a2c359 100644 --- a/frontend/src/i18n/i18n.js +++ b/frontend/src/i18n/i18n.js @@ -131,9 +131,9 @@ const lang = { "ssl_crt_path": "SSL 证书路径", "ssl_auto_storage_title": "自动证书保存位置", "ssl_auto_storage_desc": "自动申请成功后,证书由系统统一保存和轮换,不需要手动填写证书路径。", - "ssl_auto_certificate_path": "证书:./config/ssl/managed/default/current/public.crt", - "ssl_auto_private_key_path": "私钥:./config/ssl/managed/default/current/private.key", - "ssl_auto_account_key_path": "ACME 账户密钥:./config/ssl/account_private.pem", + "ssl_auto_certificate_path": "证书:./data/ssl/managed/default/current/public.crt", + "ssl_auto_private_key_path": "私钥:./data/ssl/managed/default/current/private.key", + "ssl_auto_account_key_path": "ACME 账户密钥:./data/ssl/account_private.pem", "ssl_manual_key_desc": "可填写服务器上任意可读取的完整路径,也可填写相对于 Smail 目录的路径;系统校验后会导入受控目录。", "ssl_manual_crt_desc": "可填写服务器上任意可读取的完整路径,也可填写相对于 Smail 目录的路径;证书必须与私钥匹配。", "ssl_dns_title": "DNS验证记录", diff --git a/frontend/src/views/Setup/Setup.js b/frontend/src/views/Setup/Setup.js index 9b70f788..62b10360 100644 --- a/frontend/src/views/Setup/Setup.js +++ b/frontend/src/views/Setup/Setup.js @@ -74,7 +74,7 @@ export function usePage() { const dbSettings = reactive({ "type": "sqlite", - "dsn": "./config/smail.db", + "dsn": "./data/smail.db", "mode": "fields", "user": "", "host": "127.0.0.1", @@ -92,8 +92,8 @@ export function usePage() { const sslSettings = reactive({ "type": "0", "challenge": "", - "key_path": "./config/ssl/private.key", - "crt_path": "./config/ssl/public.crt", + "key_path": "./data/ssl/private.key", + "crt_path": "./data/ssl/public.crt", "paramsList": [], }) @@ -223,7 +223,7 @@ export function usePage() { databaseError.value = "" if (dbSettings.type === "sqlite" && !dbSettings.dsn) { - dbSettings.dsn = "./config/smail.db"; + dbSettings.dsn = "./data/smail.db"; } const usesStructuredFields = dbSettings.type === "mysql" || dbSettings.type === "postgres" @@ -295,7 +295,7 @@ export function usePage() { dbSettings.name = "smail" } else { dbSettings.mode = "dsn" - dbSettings.dsn = "./config/smail.db" + dbSettings.dsn = "./data/smail.db" dbSettings.host = "127.0.0.1" dbSettings.port = "" dbSettings.name = "" diff --git a/frontend/src/views/components/ConfigSettings/ConfigForm/ConfigForm.js b/frontend/src/views/components/ConfigSettings/ConfigForm/ConfigForm.js index d2eede8a..4fb18023 100644 --- a/frontend/src/views/components/ConfigSettings/ConfigForm/ConfigForm.js +++ b/frontend/src/views/components/ConfigSettings/ConfigForm/ConfigForm.js @@ -181,13 +181,13 @@ const sslGroups = [ field('tls.certificateRef', '证书文件', 'text', { wide: true, show: externalManagedCertificate, - placeholder: 'config/ssl/example.com/fullchain.pem', + placeholder: 'data/ssl/example.com/fullchain.pem', hint: '填写后端服务器上的 PEM 证书路径。自定义模式支持绝对路径或相对运行根目录的路径,保存后显示导入后的受管路径;Web 服务器管理模式填写已有受管证书的相对路径。' }), field('tls.privateKeyRef', '私钥文件', 'text', { wide: true, show: externalManagedCertificate, - placeholder: 'config/ssl/example.com/privkey.pem', + placeholder: 'data/ssl/example.com/privkey.pem', hint: '填写与证书匹配的 PEM 私钥文件路径,不是私钥内容。文件必须可被后端运行用户读取;自定义模式保存后显示受管副本的路径。' }) ]) diff --git a/frontend/vite.config.js b/frontend/vite.config.js index d2e1d6ee..cb21e531 100644 --- a/frontend/vite.config.js +++ b/frontend/vite.config.js @@ -32,13 +32,13 @@ const developmentHTTPRedirect = (frontendOrigin, host = '127.0.0.1', port = 80) }) // https://vitejs.dev/config/ -export default defineConfig(({ mode }) => { +export default defineConfig(({ mode, command }) => { const env = loadEnv(mode, process.cwd(), '') const backendUrl = (env.VITE_DEV_BACKEND_URL || 'http://127.0.0.1:5201').replace(/\/$/, '') const backendOrigin = (env.VITE_DEV_BACKEND_ORIGIN || 'https://xuans.com').replace(/\/$/, '') const frontendOrigin = (env.VITE_DEV_FRONTEND_ORIGIN || 'https://xuans.com').replace(/\/$/, '') - const certificatePath = path.resolve(process.cwd(), env.SMAIL_DEV_TLS_CERTIFICATE || '../config/ssl/xuans.com.crt') - const privateKeyPath = path.resolve(process.cwd(), env.SMAIL_DEV_TLS_PRIVATE_KEY || '../config/ssl/xuans.com.key') + const certificatePath = path.resolve(process.cwd(), env.SMAIL_DEV_TLS_CERTIFICATE || '../data/ssl/xuans.com.crt') + const privateKeyPath = path.resolve(process.cwd(), env.SMAIL_DEV_TLS_PRIVATE_KEY || '../data/ssl/xuans.com.key') return { plugins: [ @@ -60,10 +60,11 @@ export default defineConfig(({ mode }) => { host: '127.0.0.1', port: 443, strictPort: true, - https: { + // 生产构建不依赖本机开发证书,只有开发服务器启动时才读取私钥。 + https: command === 'serve' ? { cert: readFileSync(certificatePath), key: readFileSync(privateKeyPath) - }, + } : undefined, cors: true, proxy: { "/api": { diff --git a/test/backend/data_paths_test.go b/test/backend/data_paths_test.go new file mode 100644 index 00000000..830ba60b --- /dev/null +++ b/test/backend/data_paths_test.go @@ -0,0 +1,128 @@ +package config + +import ( + "bytes" + "context" + "os" + "path/filepath" + "strings" + "testing" + "time" + + "git.pcux.cn/xuans/Smail/services/externalemail" + "git.pcux.cn/xuans/Smail/utils/credential" + "git.pcux.cn/xuans/Smail/utils/runtimepath" +) + +func TestDataMigrationKeepsSecretsCertificatesAndBackupRestorable(t *testing.T) { + root := t.TempDir() + runtime := validMySQLRuntimeConfig(t, root) + vault, err := credential.NewVault(root) + if err != nil { + t.Fatal(err) + } + external, err := externalemail.NewVault(root) + if err != nil { + t.Fatal(err) + } + emailCipher, _ := external.Encrypt("test@example.com") + fingerprint, _ := external.Fingerprint("test@example.com") + private, certificate := testManagedCertificate(t, "example.com", time.Now().Add(-time.Hour), time.Now().Add(time.Hour), 2048) + reference, err := stageManagedSSLAtRoot(root, ManagedSSLModeUpload, private, certificate, nil, []string{"example.com"}) + if err != nil { + t.Fatal(err) + } + runtime.SSL.TLS = SSLConfig{ + Mode: ManagedSSLModeUpload, Management: SSLManagementCustom, + DefaultDirectory: "config/ssl", CustomDirectory: "config/ssl", + CertificateRef: strings.Replace(reference.CertificateRef, "data/", "config/", 1), + PrivateKeyRef: strings.Replace(reference.PrivateKeyRef, "data/", "config/", 1), + } + writeRuntimeFixture(t, root, runtime) + validation := RuntimeValidationOptions{HasSuperAdmin: true} + store := NewTransactionStore(root, validation) + if _, err := store.CreateBackup(runtime); err != nil { + t.Fatal(err) + } + writer, err := NewFileAuditWriter(root) + if err != nil { + t.Fatal(err) + } + if err := writer.WriteConfigAudit(context.Background(), ConfigAuditEvent{ + Operation: ConfigOperationUpdate, Section: SectionSMTP, ActorID: "1", ActorRole: "super_admin", + FromGeneration: 1, ToGeneration: 2, Result: "success", CreatedAt: time.Now().UTC(), + }); err != nil { + t.Fatal(err) + } + // 构造旧版磁盘布局;文件内容及密文均来自真实实现,而不是手写假密钥。 + entries, _ := os.ReadDir(filepath.Join(root, "data")) + for _, entry := range entries { + if err := os.Rename(filepath.Join(root, "data", entry.Name()), filepath.Join(root, "config", entry.Name())); err != nil { + t.Fatal(err) + } + } + before, _ := os.ReadFile(filepath.Join(root, "config", "ssl.json")) + if _, err := credential.NewVault(root); err == nil { + t.Fatal("未迁移的旧密钥必须阻止生成新密钥") + } + if _, err := runtimepath.Migrate(root); err != nil { + t.Fatal(err) + } + after, _ := os.ReadFile(filepath.Join(root, "config", "ssl.json")) + if !bytes.Equal(before, after) { + t.Fatal("目录迁移不得篡改当前配置代次或摘要") + } + newVault, err := credential.NewVault(root) + if err != nil { + t.Fatal(err) + } + secret, err := OpenStoredSecret(newVault, runtime.Root.Database.Password) + expected, _ := OpenStoredSecret(vault, runtime.Root.Database.Password) + if err != nil || secret != expected { + t.Fatal("配置密文无法继续解密") + } + newExternal, err := externalemail.NewVault(root) + if err != nil { + t.Fatal(err) + } + plain, err := newExternal.Decrypt(emailCipher) + newFingerprint, _ := newExternal.Fingerprint("test@example.com") + if err != nil || plain != "test@example.com" || newFingerprint != fingerprint { + t.Fatal("外部邮箱密文或指纹发生改变") + } + loaded, err := NewConfigLoader(root, ConfigLoaderOptions{Validation: validation}).Load() + if err != nil || !strings.HasPrefix(loaded.SSL.TLS.CertificateRef, "data/") { + t.Fatalf("旧配置未兼容新目录:%v", err) + } + resolved, err := resolveManagedSSLReferencesAtRoot(root, loaded.SSL.TLS) + if err != nil { + t.Fatal(err) + } + material, _ := os.ReadFile(resolved.CertificatePath) + if !bytes.Equal(material, certificate) { + t.Fatal("证书发生改变") + } + backup, err := store.LoadBackup(runtime.Generation) + if err != nil { + t.Fatal(err) + } + if _, err := resolveManagedSSLReferencesAtRoot(root, backup.SSL.TLS); err != nil { + t.Fatal("历史备份中的旧证书引用无法使用") + } + setCandidateGeneration(&backup, loaded.Generation+1) + if err := store.Commit(loaded, backup); err != nil { + t.Fatal(err) + } + writer, err = NewFileAuditWriter(root) + if err != nil { + t.Fatal(err) + } + items, err := writer.Query(context.Background(), ConfigAuditQuery{}) + if err != nil || len(items) != 1 { + t.Fatal("历史审计丢失") + } + entries, _ = os.ReadDir(filepath.Join(root, "config")) + if len(entries) != 5 { + t.Fatal("保存或备份恢复又向 config 写入了运行文件") + } +} diff --git a/test/backend/runtime_layout_test.go b/test/backend/runtime_layout_test.go new file mode 100644 index 00000000..f56730fe --- /dev/null +++ b/test/backend/runtime_layout_test.go @@ -0,0 +1,156 @@ +package runtimepath + +import ( + "bytes" + "errors" + "os" + "path/filepath" + "testing" +) + +func put(t *testing.T, root, name string, data []byte) { + t.Helper() + path := filepath.Join(root, name) + if err := os.MkdirAll(filepath.Dir(path), 0700); err != nil { + t.Fatal(err) + } + if err := os.WriteFile(path, data, 0600); err != nil { + t.Fatal(err) + } +} + +func TestRuntimeMigrationPreservesFilesAndIsIdempotent(t *testing.T) { + root := t.TempDir() + for name := range configurationFiles { + put(t, root, "config/"+name, []byte(`{"generation":21}`)) + } + for _, name := range []string{"credential.key", "external-email-encryption.key", "external-email-fingerprint.key", "smail.db", "smail.db-wal", "smail.db-shm", "ssl/managed/upload/current/private.key", "dkim/dkim.priv", "backups-v2/old/files/config.json", "transaction/pending/manifest.json", "config-audit-v2.jsonl", "config.dev.json"} { + put(t, root, "config/"+name, []byte("preserved:"+name)) + } + if !errors.Is(CheckReady(root), ErrMigrationRequired) { + t.Fatal("旧目录应阻止启动") + } + plan, err := Plan(root) + if err != nil { + t.Fatal(err) + } + original := map[string][]byte{} + for _, item := range plan { + if info, _ := os.Stat(item.Source); info.Mode().IsRegular() { + original[item.Target], _ = os.ReadFile(item.Source) + } + } + if _, err := Migrate(root); err != nil { + t.Fatal(err) + } + for path, expected := range original { + actual, err := os.ReadFile(path) + if err != nil || !bytes.Equal(actual, expected) { + t.Fatal("迁移改变了文件内容") + } + } + entries, _ := os.ReadDir(filepath.Join(root, "config")) + if len(entries) != 5 { + t.Fatal("config 必须恰好保留五个文件") + } + for _, entry := range entries { + data, _ := os.ReadFile(filepath.Join(root, "config", entry.Name())) + if string(data) != `{"generation":21}` { + t.Fatal("当前配置被覆盖") + } + } + if moves, err := Migrate(root); err != nil || len(moves) != 0 { + t.Fatal("重复迁移不应改动文件") + } +} + +func TestRuntimeMigrationRejectsConflictAndUnknownFilesBeforeMoving(t *testing.T) { + for _, conflict := range []bool{false, true} { + root := t.TempDir() + put(t, root, "config/credential.key", []byte("old")) + if conflict { + put(t, root, "data/credential.key", []byte("new")) + } else { + put(t, root, "config/unknown", []byte("unknown")) + } + if _, err := Migrate(root); err == nil { + t.Fatal("冲突或未知文件应拒绝自动迁移") + } + data, _ := os.ReadFile(filepath.Join(root, "config", "credential.key")) + if string(data) != "old" { + t.Fatal("检查失败不应移动密钥") + } + } +} + +func TestRuntimeMigrationRejectsLinks(t *testing.T) { + root, outside := t.TempDir(), t.TempDir() + if err := os.Symlink(outside, filepath.Join(root, "config")); err != nil { + t.Skipf("当前环境不支持符号链接:%v", err) + } + if _, err := Migrate(root); err == nil { + t.Fatal("符号链接必须被拒绝") + } +} + +func TestReadyDeploymentCannotCreateNewDatabaseOrKeys(t *testing.T) { + root := t.TempDir() + put(t, root, "config/config.json", []byte(`{"setupState":"ready","database":{"type":"sqlite","localRef":"mail.db"}}`)) + if err := CheckReady(root); err == nil { + t.Fatal("必要文件缺失必须阻止启动") + } + if _, err := os.Stat(filepath.Join(root, "data")); !os.IsNotExist(err) { + t.Fatal("只读启动检查不应生成空数据库或密钥") + } +} + +func TestRuntimeMigrationRollsBackOnMoveFailure(t *testing.T) { + root := t.TempDir() + put(t, root, "config/credential.key", []byte("original-key")) + put(t, root, "config/smail.db", []byte("original-database")) + calls := 0 + _, err := migrate(root, func(source, target string) error { + calls++ + if calls == 2 { + return errors.New("模拟迁移中途失败") + } + return os.Rename(source, target) + }) + if err == nil || calls != 3 { + t.Fatal("应执行逆序回滚") + } + for name, expected := range map[string]string{"credential.key": "original-key", "smail.db": "original-database"} { + data, err := os.ReadFile(filepath.Join(root, "config", name)) + if err != nil || string(data) != expected { + t.Fatal("回滚后原文件应完整保留") + } + } + if _, err := Migrate(root); err != nil { + t.Fatal("正常回滚后应能重新迁移", err) + } +} + +func TestRuntimeMigrationLockBlocksConcurrentMigrationAndStartup(t *testing.T) { + root := t.TempDir() + put(t, root, "data/"+migrationLock, nil) + if _, err := Migrate(root); err == nil { + t.Fatal("并发迁移或中断现场必须拒绝继续") + } + if err := CheckReady(root); err == nil { + t.Fatal("迁移锁必须阻止主服务启动") + } +} + +func TestLegacyReferenceOnlyChangesKnownRelativeDirectories(t *testing.T) { + for input, expected := range map[string]string{ + "./config/ssl/public.crt": "data/ssl/public.crt", + "config/dkim/dkim.priv": "data/dkim/dkim.priv", + "/config/ssl/public.crt": "/config/ssl/public.crt", + "config/ssl-other/key": "config/ssl-other/key", + "../config/ssl/key": "../config/ssl/key", + } { + if actual := LegacyReference(input); actual != expected { + t.Fatalf("相对目录转换错误:%q", input) + } + } +} diff --git a/test/backend/ssl_custom_test.go b/test/backend/ssl_custom_test.go index dcca85a8..cf2c8397 100644 --- a/test/backend/ssl_custom_test.go +++ b/test/backend/ssl_custom_test.go @@ -66,7 +66,7 @@ func customSSLFixture(t *testing.T) (string, *ConfigManager, UpdateRequest, []by func assertNoCustomSSLVersions(t *testing.T, root string) { t.Helper() - if _, err := os.Stat(filepath.Join(root, "config", "ssl", "managed", "upload")); !os.IsNotExist(err) { + if _, err := os.Stat(filepath.Join(root, "data", "ssl", "managed", "upload")); !os.IsNotExist(err) { t.Fatalf("失败或只读操作产生了证书存储副作用: %v", err) } } @@ -101,7 +101,7 @@ func TestCustomSSLManagerValidateSaveApplyReload(t *testing.T) { if manager.Snapshot().Generation != request.ExpectedGeneration { t.Fatal("暂存提前切换了当前配置") } - if !strings.HasPrefix(updated.Candidate.SSL.TLS.CertificateRef, "config/ssl/managed/upload/version-") { + if !strings.HasPrefix(updated.Candidate.SSL.TLS.CertificateRef, "data/ssl/managed/upload/version-") { t.Fatal("候选未使用独立受管引用") } currentBytes, err := os.ReadFile(oldReference.CertificatePath) diff --git a/test/frontend/setup-ssl-proxy.test.mjs b/test/frontend/setup-ssl-proxy.test.mjs index 555df952..7bfab99f 100644 --- a/test/frontend/setup-ssl-proxy.test.mjs +++ b/test/frontend/setup-ssl-proxy.test.mjs @@ -94,8 +94,8 @@ test('初始化模板能编译,实际渲染按反代策略隐藏自动选项 if (tlsMode === 'proxy') { assert.doesNotMatch(html, /data-label="自动申请证书"|ssl-challenge-select-row|ssl-storage-card|ssl-port-warning/) assert.match(html, /外部续期后也需重新导入并应用/) - assert.match(html, /modelvalue="\.\/config\/ssl\/private\.key"/) - assert.match(html, /modelvalue="\.\/config\/ssl\/public\.crt"/) + assert.match(html, /modelvalue="\.\/data\/ssl\/private\.key"/) + assert.match(html, /modelvalue="\.\/data\/ssl\/public\.crt"/) } else { assert.match(html, /data-label="自动申请证书"/) assert.match(html, /ssl-challenge-select-row|ssl-storage-card/) diff --git a/test/run.mjs b/test/run.mjs index 9318be9b..d2353897 100644 --- a/test/run.mjs +++ b/test/run.mjs @@ -42,6 +42,8 @@ if (suite !== 'frontend' && result === 0) { const args = extra[0] === '--' ? extra.slice(1) : extra // 独立回归源码集中放在 test/backend,通过 overlay 保留同包测试语义。 const replacements = { + 'backend/utils/runtimepath/layout_test.go': 'test/backend/runtime_layout_test.go', + 'backend/config/data_paths_test.go': 'test/backend/data_paths_test.go', 'backend/config/ssl_custom_regression_test.go': 'test/backend/ssl_custom_test.go', 'backend/config/webauthn_defaults_test.go': 'test/backend/webauthn_config_test.go', 'backend/res_init/webauthn_runtime_test.go': 'test/backend/webauthn_runtime_test.go', diff --git a/test/runtime_data_check.py b/test/runtime_data_check.py new file mode 100644 index 00000000..b23defb7 --- /dev/null +++ b/test/runtime_data_check.py @@ -0,0 +1,108 @@ +"""只读核对运行目录迁移前后的文件及 SQLite 内容,不输出用户数据或密钥。""" + +import argparse +import hashlib +import json +import sqlite3 +from pathlib import Path + + +CONFIG_FILES = {"config.json", "smtp.json", "email.json", "ssl.json", "plugins.json"} +LEGACY_FILES = {"config.dev.json", "config_mysql.json", "config.json.legacy"} + + +def digest_file(path): + digest = hashlib.sha256() + with path.open("rb") as stream: + for chunk in iter(lambda: stream.read(1024 * 1024), b""): + digest.update(chunk) + return digest.hexdigest() + + +def database_snapshot(path): + # 必须停服调用。只读连接不会创建空库,不使用会忽略 WAL 的 immutable 模式。 + connection = sqlite3.connect(path.resolve().as_uri() + "?mode=ro", uri=True) + try: + connection.execute("PRAGMA query_only = ON") + connection.execute("BEGIN") + if connection.execute("PRAGMA integrity_check").fetchall() != [("ok",)]: + raise RuntimeError("数据库完整性检查失败") + tables = {} + for (name,) in connection.execute( + "SELECT name FROM sqlite_master WHERE type='table' ORDER BY name" + ).fetchall(): + quoted = '"' + name.replace('"', '""') + '"' + rows = [] + for row in connection.execute(f"SELECT * FROM {quoted}"): + encoded = [ + {"blob": value.hex()} if isinstance(value, bytes) else value + for value in row + ] + payload = json.dumps(encoded, ensure_ascii=False, separators=(",", ":")) + rows.append(hashlib.sha256(payload.encode("utf-8")).hexdigest()) + tables[name] = { + "rows": len(rows), + "sha256": hashlib.sha256("".join(sorted(rows)).encode("ascii")).hexdigest(), + } + return {"integrity": "ok", "tables": tables} + finally: + connection.close() + + +def snapshot(root, layout): + config = root / "config" + files = {} + databases = {} + source = config if layout == "old" else root / "data" + for path in sorted(source.rglob("*")): + if path.is_symlink(): + raise RuntimeError("拒绝跟随运行目录符号链接") + if not path.is_file(): + continue + relative = path.relative_to(source).as_posix() + # 完整迁移前备份是新建的独立副本,已单独核对,不属于待迁移的原始集合。 + if layout == "new" and path.relative_to(source).parts[0] == "runtime-migration-backups": + continue + if layout == "old": + if relative in CONFIG_FILES: + key = "config/" + relative + elif relative in LEGACY_FILES: + key = "data/legacy-config/" + relative + else: + key = "data/" + relative + else: + key = "data/" + relative + files[key] = {"size": path.stat().st_size, "sha256": digest_file(path)} + if path.suffix in {".db", ".sqlite", ".sqlite3"}: + databases[key] = database_snapshot(path) + if layout == "new": + if {path.name for path in config.iterdir()} != CONFIG_FILES: + raise RuntimeError("config 目录必须恰好包含五个配置文件") + for name in sorted(CONFIG_FILES): + path = config / name + files["config/" + name] = {"size": path.stat().st_size, "sha256": digest_file(path)} + generation = json.loads((config / "config.json").read_text(encoding="utf-8"))["generation"] + return {"generation": generation, "files": files, "databases": databases} + + +def main(): + parser = argparse.ArgumentParser(description=__doc__) + parser.add_argument("--root", required=True, type=Path) + parser.add_argument("--layout", required=True, choices=("old", "new")) + parser.add_argument("--output", required=True, type=Path) + parser.add_argument("--baseline", type=Path) + args = parser.parse_args() + result = snapshot(args.root.resolve(strict=True), args.layout) + if args.baseline: + before = json.loads(args.baseline.read_text(encoding="utf-8")) + if before != result: + raise RuntimeError("迁移前后文件或数据库内容不一致,请保留现场") + # 不覆盖既有证据。 + with args.output.open("x", encoding="utf-8") as stream: + json.dump(result, stream, ensure_ascii=False, indent=2) + stream.write("\n") + print(f"核对通过:配置代次 {result['generation']},文件 {len(result['files'])} 个,数据库 {len(result['databases'])} 个") + + +if __name__ == "__main__": + main()