import { repairSnippetsNoteColumn } from "../../upgrade/snippets-schema-migration.js"; import { getErrorMessage } from "../../utils/error-message.js"; import { drizzle } from "drizzle-orm/better-sqlite3"; import Database from "better-sqlite3"; import * as schema from "./schema.js"; import fs from "fs"; import path from "path"; import { databaseLogger } from "../../utils/logger.js"; import { DatabaseFileEncryption } from "../../utils/database-file-encryption.js"; import { SystemCrypto } from "../../utils/system-crypto.js"; import { DatabaseMigration } from "../../utils/database-migration.js"; import { ensureSharedHostAuthOverrideProtocolSchema, migrateLegacySharedHostAuthOverrides, } from "../../utils/shared-host-auth-override-migration.js"; import { DatabaseSaveTrigger } from "../../utils/database-save-trigger.js"; import { migrateAuditRetention } from "../../utils/audit-retention-migration.js"; import { createPerformanceIndexes } from "./performance-indexes.js"; import { assertDataDirIsNotMisconfigured, DataDirMisconfiguredError, } from "../../utils/data-dir-guard.js"; import { resolveDatabaseDialect, type DatabaseDialect } from "./dialect.js"; import { SYSTEM_ROLE_DEFAULTS } from "../../utils/permission-catalog.js"; import { connectRemoteDatabase } from "./connect.js"; import { runRemoteMigrations } from "./migrate.js"; import { assertNotPre29Database } from "./upgrade-guard.js"; import { LEGACY_USERNAME_PLACEHOLDER_UPDATES, legacySudoMoves, RETIRED_COLUMNS, RETIRED_SETTINGS, REMOTE_RETIRED_COLUMNS, type LegacySudoRow, } from "./retired-columns.js"; import { sql, type SQL } from "drizzle-orm"; import type { PortableDatabase } from "../repositories/database-context.js"; const dataDir = process.env.DATA_DIR || "./db/data"; const dbDir = path.resolve(dataDir); if (!fs.existsSync(dbDir)) { fs.mkdirSync(dbDir, { recursive: true }); } const enableFileEncryption = process.env.DB_FILE_ENCRYPTION !== "false"; const dbPath = path.join(dataDir, "db.sqlite"); const encryptedDbPath = `${dbPath}.encrypted`; const actualDbPath = ":memory:"; let memoryDatabase: Database.Database; let isNewDatabase = false; let sqlite: Database.Database; function getRawSettingValue(key: string): string | null { const row = sqlite .prepare("SELECT value FROM settings WHERE key = ?") .get(key) as { value?: string } | undefined; return row?.value ?? null; } function setRawSettingValue(key: string, value: string): void { sqlite .prepare("INSERT OR REPLACE INTO settings (key, value) VALUES (?, ?)") .run(key, value); } function ensureRawSettingDefault(key: string, value: string): void { if (getRawSettingValue(key) === null) { sqlite .prepare("INSERT INTO settings (key, value) VALUES (?, ?)") .run(key, value); } } async function initializeDatabaseAsync(): Promise { const systemCrypto = SystemCrypto.getInstance(); await systemCrypto.getDatabaseKey(); if (enableFileEncryption) { try { if (DatabaseFileEncryption.isEncryptedDatabaseFile(encryptedDbPath)) { const decryptedBuffer = await DatabaseFileEncryption.decryptDatabaseToBuffer(encryptedDbPath); memoryDatabase = new Database(decryptedBuffer); try { memoryDatabase .prepare("SELECT COUNT(*) as count FROM sessions") .get() as { count: number }; } catch { // expected - sessions table may not exist yet } } else { const migration = new DatabaseMigration(dataDir); const migrationStatus = migration.checkMigrationStatus(); if (migrationStatus.needsMigration) { const migrationResult = await migration.migrateDatabase(); if (migrationResult.success) { migration.cleanupOldBackups(); if ( DatabaseFileEncryption.isEncryptedDatabaseFile(encryptedDbPath) ) { const decryptedBuffer = await DatabaseFileEncryption.decryptDatabaseToBuffer( encryptedDbPath, ); memoryDatabase = new Database(decryptedBuffer); isNewDatabase = false; } else { throw new Error( "Migration completed but encrypted database file not found", ); } } else { databaseLogger.error("Automatic database migration failed", null, { operation: "auto_migration_failed", error: migrationResult.error, migratedTables: migrationResult.migratedTables, migratedRows: migrationResult.migratedRows, duration: migrationResult.duration, backupPath: migrationResult.backupPath, }); throw new Error( `Database migration failed: ${migrationResult.error}. Backup available at: ${migrationResult.backupPath}`, ); } } else { assertDataDirIsNotMisconfigured(dataDir); memoryDatabase = new Database(":memory:"); isNewDatabase = true; } } } catch (error) { // Not a decryption problem: the database is fine, we are pointed at the // wrong directory. Surface that message as-is. if (error instanceof DataDirMisconfiguredError) throw error; databaseLogger.error("Failed to initialize memory database", error, { operation: "db_memory_init_failed", errorMessage: getErrorMessage(error), errorStack: error instanceof Error ? error.stack : undefined, encryptedDbExists: DatabaseFileEncryption.isEncryptedDatabaseFile(encryptedDbPath), databaseKeyAvailable: !!process.env.DATABASE_KEY, databaseKeyLength: process.env.DATABASE_KEY?.length || 0, }); try { const diagnosticInfo = DatabaseFileEncryption.getDiagnosticInfo(encryptedDbPath); databaseLogger.error( "Database encryption diagnostic completed - check logs above for details", null, { operation: "db_encryption_diagnostic_completed", filesConsistent: diagnosticInfo.validation.filesConsistent, sizeMismatch: diagnosticInfo.validation.sizeMismatch, }, ); } catch (diagError) { databaseLogger.warn("Failed to generate diagnostic information", { operation: "db_diagnostic_failed", error: getErrorMessage(diagError), }); } throw new Error( `Database decryption failed: ${getErrorMessage(error)}. This prevents data loss.`, { cause: error }, ); } } else { assertDataDirIsNotMisconfigured(dataDir); // The database still lives in memory and is serialised out on every write; // turning encryption off only changes whether that file is ciphertext. It // has to be read back, or each restart starts empty and silently discards // everything the previous run saved. const existing = readPlainDatabaseFile(); if (existing) { memoryDatabase = new Database(existing); databaseLogger.info("Loaded unencrypted database from disk", { operation: "db_load_plain", path: dbPath, bytes: existing.length, }); } else { memoryDatabase = new Database(":memory:"); isNewDatabase = true; } } } /** The plain database file, or null when there is nothing to restore. */ function readPlainDatabaseFile(): Buffer | null { try { const contents = fs.readFileSync(dbPath); return contents.length > 0 ? contents : null; } catch (error) { if ((error as NodeJS.ErrnoException).code === "ENOENT") return null; throw error; } } async function initializeCompleteDatabase(): Promise { await initializeDatabaseAsync(); databaseLogger.info(`Initializing SQLite database`, { operation: "db_init", path: actualDbPath, encrypted: enableFileEncryption && DatabaseFileEncryption.isEncryptedDatabaseFile(encryptedDbPath), inMemory: true, isNewDatabase, }); sqlite = memoryDatabase; sqlite.exec("PRAGMA foreign_keys = ON"); db = drizzle(sqlite, { schema }); await assertNotPre29Database( (name) => !!sqlite .prepare( "SELECT 1 FROM sqlite_master WHERE type = 'table' AND name = ?", ) .get(name), ); sqlite.exec(` CREATE TABLE IF NOT EXISTS users ( id TEXT PRIMARY KEY, username TEXT NOT NULL, password_hash TEXT NOT NULL, is_admin INTEGER NOT NULL DEFAULT 0, registered_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, donation_modal_dismissed INTEGER NOT NULL DEFAULT 0 ); CREATE TABLE IF NOT EXISTS settings ( key TEXT PRIMARY KEY, value TEXT NOT NULL ); CREATE TABLE IF NOT EXISTS sessions ( id TEXT PRIMARY KEY, user_id TEXT NOT NULL, jwt_token TEXT NOT NULL, device_type TEXT NOT NULL, device_info TEXT NOT NULL, created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, expires_at TEXT NOT NULL, last_active_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE CASCADE ); CREATE TABLE IF NOT EXISTS trusted_devices ( id TEXT PRIMARY KEY, user_id TEXT NOT NULL, device_fingerprint TEXT NOT NULL, device_type TEXT NOT NULL, device_info TEXT NOT NULL, created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, expires_at TEXT NOT NULL, last_used_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE CASCADE ); CREATE TABLE IF NOT EXISTS user_external_identities ( id INTEGER PRIMARY KEY AUTOINCREMENT, user_id TEXT NOT NULL, provider_id TEXT NOT NULL, subject TEXT NOT NULL, email TEXT, created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, UNIQUE (provider_id, subject), FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE CASCADE ); CREATE INDEX IF NOT EXISTS idx_user_external_identities_user ON user_external_identities (user_id); CREATE TABLE IF NOT EXISTS user_second_factors ( id INTEGER PRIMARY KEY AUTOINCREMENT, user_id TEXT NOT NULL, plugin_id TEXT NOT NULL, factor_id TEXT NOT NULL, enrolled_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, UNIQUE (user_id, plugin_id, factor_id), FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE CASCADE ); CREATE TABLE IF NOT EXISTS ssh_data ( id INTEGER PRIMARY KEY AUTOINCREMENT, user_id TEXT NOT NULL, name TEXT, ip TEXT NOT NULL, port INTEGER NOT NULL, username TEXT NOT NULL, folder TEXT, tags TEXT, pin INTEGER NOT NULL DEFAULT 0, sort_order INTEGER, auth_type TEXT NOT NULL, password TEXT, key TEXT, key_password TEXT, key_type TEXT, force_keyboard_interactive TEXT, status_check_enabled INTEGER NOT NULL DEFAULT 1, status_check_interval INTEGER, notes TEXT, use_socks5 INTEGER, socks5_host TEXT, socks5_port INTEGER, socks5_username TEXT, socks5_password TEXT, created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE CASCADE ); CREATE TABLE IF NOT EXISTS ssh_credentials ( id INTEGER PRIMARY KEY AUTOINCREMENT, user_id TEXT NOT NULL, name TEXT NOT NULL, description TEXT, folder TEXT, tags TEXT, auth_type TEXT NOT NULL, username TEXT, password TEXT, key TEXT, key_password TEXT, key_type TEXT, usage_count INTEGER NOT NULL DEFAULT 0, last_used TEXT, created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE CASCADE ); CREATE TABLE IF NOT EXISTS ssh_credential_usage ( id INTEGER PRIMARY KEY AUTOINCREMENT, credential_id INTEGER NOT NULL, host_id INTEGER NOT NULL, user_id TEXT NOT NULL, used_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, FOREIGN KEY (credential_id) REFERENCES ssh_credentials (id) ON DELETE CASCADE, FOREIGN KEY (host_id) REFERENCES ssh_data (id) ON DELETE CASCADE, FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE CASCADE ); CREATE TABLE IF NOT EXISTS ssh_folders ( id INTEGER PRIMARY KEY AUTOINCREMENT, user_id TEXT NOT NULL, name TEXT NOT NULL, color TEXT, icon TEXT, sort_order INTEGER, created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE CASCADE ); CREATE TABLE IF NOT EXISTS recent_activity ( id INTEGER PRIMARY KEY AUTOINCREMENT, user_id TEXT NOT NULL, type TEXT NOT NULL, host_id INTEGER NOT NULL, host_name TEXT, timestamp TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE CASCADE, FOREIGN KEY (host_id) REFERENCES ssh_data (id) ON DELETE CASCADE ); CREATE TABLE IF NOT EXISTS host_access ( id INTEGER PRIMARY KEY AUTOINCREMENT, host_id INTEGER NOT NULL, user_id TEXT, role_id INTEGER, granted_by TEXT NOT NULL, permission_level TEXT NOT NULL DEFAULT 'use', expires_at TEXT, created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, last_accessed_at TEXT, access_count INTEGER NOT NULL DEFAULT 0, FOREIGN KEY (host_id) REFERENCES ssh_data (id) ON DELETE CASCADE, FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE CASCADE, FOREIGN KEY (role_id) REFERENCES roles (id) ON DELETE CASCADE, FOREIGN KEY (granted_by) REFERENCES users (id) ON DELETE CASCADE ); CREATE TABLE IF NOT EXISTS roles ( id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT NOT NULL UNIQUE, display_name TEXT NOT NULL, description TEXT, is_system INTEGER NOT NULL DEFAULT 0, permissions TEXT, created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP ); CREATE TABLE IF NOT EXISTS user_roles ( id INTEGER PRIMARY KEY AUTOINCREMENT, user_id TEXT NOT NULL, role_id INTEGER NOT NULL, granted_by TEXT, granted_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, UNIQUE(user_id, role_id), FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE CASCADE, FOREIGN KEY (role_id) REFERENCES roles (id) ON DELETE CASCADE, FOREIGN KEY (granted_by) REFERENCES users (id) ON DELETE SET NULL ); CREATE TABLE IF NOT EXISTS audit_logs ( id INTEGER PRIMARY KEY AUTOINCREMENT, user_id TEXT, username TEXT NOT NULL, action TEXT NOT NULL, resource_type TEXT NOT NULL, resource_id TEXT, resource_name TEXT, details TEXT, ip_address TEXT, user_agent TEXT, success INTEGER NOT NULL, error_message TEXT, timestamp TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE SET NULL ); CREATE TABLE IF NOT EXISTS credential_access ( id INTEGER PRIMARY KEY AUTOINCREMENT, credential_id INTEGER NOT NULL, user_id TEXT, role_id INTEGER, granted_by TEXT NOT NULL, permission_level TEXT NOT NULL DEFAULT 'use', expires_at TEXT, created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, FOREIGN KEY (credential_id) REFERENCES ssh_credentials (id) ON DELETE CASCADE, FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE CASCADE, FOREIGN KEY (role_id) REFERENCES roles (id) ON DELETE CASCADE, FOREIGN KEY (granted_by) REFERENCES users (id) ON DELETE CASCADE ); CREATE INDEX IF NOT EXISTS idx_credential_access_user_id ON credential_access (user_id); CREATE INDEX IF NOT EXISTS idx_credential_access_role_id ON credential_access (role_id); CREATE INDEX IF NOT EXISTS idx_credential_access_credential_id ON credential_access (credential_id); CREATE TABLE IF NOT EXISTS shared_credential_secrets ( id INTEGER PRIMARY KEY AUTOINCREMENT, credential_access_id INTEGER NOT NULL, target_user_id TEXT NOT NULL, credential_id INTEGER NOT NULL, encrypted_username TEXT, auth_type TEXT NOT NULL DEFAULT 'password', encrypted_password TEXT, encrypted_key TEXT, encrypted_key_password TEXT, key_type TEXT, public_key TEXT, cert_public_key TEXT, created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, UNIQUE (credential_access_id, target_user_id), FOREIGN KEY (credential_access_id) REFERENCES credential_access (id) ON DELETE CASCADE, FOREIGN KEY (target_user_id) REFERENCES users (id) ON DELETE CASCADE, FOREIGN KEY (credential_id) REFERENCES ssh_credentials (id) ON DELETE CASCADE ); CREATE INDEX IF NOT EXISTS idx_shared_credential_secrets_target ON shared_credential_secrets (target_user_id, credential_id); CREATE TABLE IF NOT EXISTS folder_access ( id INTEGER PRIMARY KEY AUTOINCREMENT, owner_user_id TEXT NOT NULL, folder TEXT NOT NULL, user_id TEXT, role_id INTEGER, granted_by TEXT NOT NULL, permission_level TEXT NOT NULL DEFAULT 'connect', expires_at TEXT, created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, FOREIGN KEY (owner_user_id) REFERENCES users (id) ON DELETE CASCADE, FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE CASCADE, FOREIGN KEY (role_id) REFERENCES roles (id) ON DELETE CASCADE, FOREIGN KEY (granted_by) REFERENCES users (id) ON DELETE CASCADE ); CREATE INDEX IF NOT EXISTS idx_folder_access_owner_folder ON folder_access (owner_user_id, folder); CREATE TABLE IF NOT EXISTS plugins ( id TEXT PRIMARY KEY, name TEXT NOT NULL, version TEXT NOT NULL, tier TEXT NOT NULL DEFAULT 'available', source TEXT NOT NULL DEFAULT 'community', registry_id TEXT, state TEXT NOT NULL DEFAULT 'disabled', last_error TEXT, installed_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, auto_update INTEGER NOT NULL DEFAULT 0, pinned_version TEXT, manifest_json TEXT NOT NULL ); CREATE INDEX IF NOT EXISTS idx_plugins_registry_id ON plugins (registry_id); CREATE TABLE IF NOT EXISTS plugin_permission_grants ( id INTEGER PRIMARY KEY AUTOINCREMENT, plugin_id TEXT NOT NULL, capability TEXT NOT NULL, granted_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, -- Nullable: a bundled grant is made by the install, not by a user. granted_by TEXT, source TEXT NOT NULL DEFAULT 'admin', UNIQUE (plugin_id, capability), FOREIGN KEY (plugin_id) REFERENCES plugins (id) ON DELETE CASCADE, FOREIGN KEY (granted_by) REFERENCES users (id) ON DELETE CASCADE ); CREATE TABLE IF NOT EXISTS plugin_registries ( id TEXT PRIMARY KEY, name TEXT NOT NULL, url TEXT NOT NULL, kind TEXT NOT NULL DEFAULT 'community', enabled INTEGER NOT NULL DEFAULT 1, signing_key TEXT, last_checked_at TEXT, last_index_hash TEXT ); CREATE TABLE IF NOT EXISTS plugin_install_counts ( id INTEGER PRIMARY KEY AUTOINCREMENT, plugin_id TEXT NOT NULL, registry_id TEXT NOT NULL, count INTEGER NOT NULL DEFAULT 0, source TEXT NOT NULL DEFAULT 'aggregate-telemetry', updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, UNIQUE (plugin_id, registry_id) ); CREATE TABLE IF NOT EXISTS plugin_storage ( id INTEGER PRIMARY KEY AUTOINCREMENT, plugin_id TEXT NOT NULL, key TEXT NOT NULL, value TEXT NOT NULL, updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, UNIQUE (plugin_id, key), FOREIGN KEY (plugin_id) REFERENCES plugins (id) ON DELETE CASCADE ); CREATE TABLE IF NOT EXISTS plugin_migrations ( id INTEGER PRIMARY KEY AUTOINCREMENT, plugin_id TEXT NOT NULL, migration_id TEXT NOT NULL, checksum TEXT NOT NULL, applied_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, UNIQUE (plugin_id, migration_id), FOREIGN KEY (plugin_id) REFERENCES plugins (id) ON DELETE CASCADE ); CREATE TABLE IF NOT EXISTS plugin_settings ( id INTEGER PRIMARY KEY AUTOINCREMENT, plugin_id TEXT NOT NULL, scope TEXT NOT NULL, scope_id TEXT, key TEXT NOT NULL, value TEXT, encrypted INTEGER NOT NULL DEFAULT 0, updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, UNIQUE (plugin_id, scope, scope_id, key), FOREIGN KEY (plugin_id) REFERENCES plugins (id) ON DELETE CASCADE ); CREATE INDEX IF NOT EXISTS idx_plugin_settings_plugin_scope ON plugin_settings (plugin_id, scope); CREATE TABLE IF NOT EXISTS rbac_known_permissions ( id INTEGER PRIMARY KEY AUTOINCREMENT, permission TEXT NOT NULL, plugin_id TEXT, first_seen_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, UNIQUE (permission) ); CREATE TABLE IF NOT EXISTS rbac_applied_defaults ( id INTEGER PRIMARY KEY AUTOINCREMENT, role_name TEXT NOT NULL, permission TEXT NOT NULL, applied_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, UNIQUE (role_name, permission) ); CREATE TABLE IF NOT EXISTS api_keys ( id TEXT PRIMARY KEY, user_id TEXT NOT NULL, name TEXT NOT NULL, token_hash TEXT NOT NULL, token_prefix TEXT NOT NULL, created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, expires_at TEXT, last_used_at TEXT, is_active INTEGER NOT NULL DEFAULT 1, FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE CASCADE ); CREATE TABLE IF NOT EXISTS user_open_tabs ( id TEXT PRIMARY KEY, user_id TEXT NOT NULL, tab_type TEXT NOT NULL, host_id INTEGER, label TEXT NOT NULL, tab_order INTEGER NOT NULL DEFAULT 0, backend_session_id TEXT, created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE CASCADE, FOREIGN KEY (host_id) REFERENCES ssh_data (id) ON DELETE CASCADE ); CREATE TABLE IF NOT EXISTS user_preferences ( user_id TEXT PRIMARY KEY, reopen_tabs_on_login INTEGER NOT NULL DEFAULT 0, theme TEXT, font_size TEXT, accent_color TEXT, language TEXT, updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE CASCADE ); CREATE TABLE IF NOT EXISTS host_sidebar_preferences ( user_id TEXT PRIMARY KEY, data TEXT NOT NULL, updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE CASCADE ); CREATE TABLE IF NOT EXISTS credential_sidebar_preferences ( user_id TEXT PRIMARY KEY, data TEXT NOT NULL, updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE CASCADE ); CREATE TABLE IF NOT EXISTS ui_preferences ( user_id TEXT PRIMARY KEY, data TEXT NOT NULL, updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE CASCADE ); `); // Expired open tabs are dropped when the tab list is read, against the // terminal plugin's own session timeout. try { const result = sqlite .prepare("DELETE FROM sessions WHERE expires_at <= ?") .run(new Date().toISOString()); if (result.changes > 0) { databaseLogger.info("Expired sessions cleaned up on startup", { operation: "db_init_session_cleanup", deletedSessions: result.changes, }); } } catch (e) { databaseLogger.warn("Could not clear expired sessions on startup", { operation: "db_init_session_cleanup_failed", error: e, }); } // 2.9.1 added this fix, so a 2.9.0 install has not run it yet. It reads the // column migrateSchema drops. if (columnNames("users").includes("oidc_identifier")) { const { runSsoLegacyIdentityMigration } = await import("../../upgrade/sso-legacy-identity-migration.js"); await runSsoLegacyIdentityMigration(); } migrateSchema(); vacuumIfFreelistBloated(); try { ensureRawSettingDefault("allow_registration", "true"); } catch (e) { databaseLogger.warn("Could not initialize default settings", { operation: "db_init", error: e, }); } try { ensureRawSettingDefault("allow_password_login", "true"); } catch (e) { databaseLogger.warn("Could not initialize allow_password_login setting", { operation: "db_init", error: e, }); } } const addColumnIfNotExists = ( table: string, column: string, definition: string, ) => { try { sqlite .prepare( `SELECT "${column}" FROM ${table} LIMIT 1`, ) .get(); } catch { try { sqlite.exec(`ALTER TABLE ${table} ADD COLUMN "${column}" ${definition};`); } catch (alterError) { const message = alterError instanceof Error ? alterError.message : String(alterError); databaseLogger.warn( `Failed to add column ${column} to ${table}: ${message}`, { operation: "schema_migration", table, column, }, ); } } }; /** * Drops the NOT NULL on plugin_permission_grants.granted_by. * * A bundled grant is made by the install rather than by a person, so there is * no user id to record. SQLite cannot relax a constraint in place, so the * table is rebuilt; it only ever holds a handful of rows. */ const relaxPluginGrantGrantedBy = () => { try { const sql = sqlite .prepare( `SELECT sql FROM sqlite_master WHERE type = 'table' AND name = 'plugin_permission_grants'`, ) .get() as { sql?: string } | undefined; if (!sql?.sql || !/granted_by\s+TEXT\s+NOT\s+NULL/i.test(sql.sql)) { return; } sqlite.exec(` PRAGMA foreign_keys=OFF; BEGIN; CREATE TABLE plugin_permission_grants_new ( id INTEGER PRIMARY KEY AUTOINCREMENT, plugin_id TEXT NOT NULL, capability TEXT NOT NULL, granted_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, granted_by TEXT, source TEXT NOT NULL DEFAULT 'admin', UNIQUE (plugin_id, capability), FOREIGN KEY (plugin_id) REFERENCES plugins (id) ON DELETE CASCADE, FOREIGN KEY (granted_by) REFERENCES users (id) ON DELETE CASCADE ); INSERT INTO plugin_permission_grants_new (id, plugin_id, capability, granted_at, granted_by, source) SELECT id, plugin_id, capability, granted_at, granted_by, 'admin' FROM plugin_permission_grants; DROP TABLE plugin_permission_grants; ALTER TABLE plugin_permission_grants_new RENAME TO plugin_permission_grants; COMMIT; PRAGMA foreign_keys=ON; `); databaseLogger.info( "Relaxed plugin_permission_grants.granted_by to allow bundled grants", { operation: "schema_migration" }, ); } catch (error) { databaseLogger.warn( `Failed to relax plugin_permission_grants.granted_by: ${ error instanceof Error ? error.message : String(error) }`, { operation: "schema_migration" }, ); } }; const columnNames = (table: string): string[] => ( sqlite.prepare(`PRAGMA table_info(${table})`).all() as Array<{ name: string; }> ).map((col) => col.name); /** * ssh_folders.credential_id became the folder's auth default. It carries a * foreign key, which ALTER TABLE DROP COLUMN refuses, so the table is rebuilt. */ const dropFolderCredentialColumn = () => { const columns = columnNames("ssh_folders"); if (!columns.includes("credential_id")) return; const kept = [ "id", "user_id", "name", "color", "icon", "sort_order", "sync_id", "local_only", "created_at", "updated_at", ].filter((name) => columns.includes(name)); const list = kept.map((name) => `"${name}"`).join(", "); sqlite.exec("PRAGMA foreign_keys = OFF"); try { sqlite.exec(` BEGIN; CREATE TABLE ssh_folders_new ( id INTEGER PRIMARY KEY AUTOINCREMENT, user_id TEXT NOT NULL, name TEXT NOT NULL, color TEXT, icon TEXT, sort_order INTEGER, sync_id TEXT, local_only INTEGER NOT NULL DEFAULT 0, created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE CASCADE ); INSERT INTO ssh_folders_new (${list}) SELECT ${list} FROM ssh_folders; DROP TABLE ssh_folders; ALTER TABLE ssh_folders_new RENAME TO ssh_folders; CREATE UNIQUE INDEX IF NOT EXISTS idx_ssh_folders_sync_id ON ssh_folders(sync_id); COMMIT; `); } catch (error) { if (sqlite.inTransaction) sqlite.exec("ROLLBACK"); databaseLogger.warn("Failed to drop ssh_folders.credential_id", { operation: "schema_migration", error: getErrorMessage(error), }); } finally { sqlite.exec("PRAGMA foreign_keys = ON"); } }; const moveLegacySudoPasswords = () => { if (!columnNames("ssh_data").includes("terminal_config")) return; try { const rows = sqlite .prepare( "SELECT id, terminal_config, sudo_password FROM ssh_data WHERE terminal_config LIKE '%sudoPassword%'", ) .all() as LegacySudoRow[]; const update = sqlite.prepare( "UPDATE ssh_data SET sudo_password = ? WHERE id = ?", ); for (const move of legacySudoMoves(rows)) { update.run(move.sudoPassword, move.id); } } catch (error) { databaseLogger.warn("Failed to move legacy sudo passwords", { operation: "schema_migration", error: getErrorMessage(error), }); } }; const dropRetiredColumns = () => { moveLegacySudoPasswords(); for (const [table, retired] of Object.entries(RETIRED_COLUMNS)) { const columns = new Set(columnNames(table)); for (const column of retired) { if (!columns.has(column)) continue; try { sqlite.exec(`ALTER TABLE ${table} DROP COLUMN "${column}"`); } catch (error) { databaseLogger.warn(`Failed to drop ${table}.${column}`, { operation: "schema_migration", error: getErrorMessage(error), }); } } } dropFolderCredentialColumn(); // 2.8 spelled $external.username as $oidc.preferred_username. for (const statement of LEGACY_USERNAME_PLACEHOLDER_UPDATES) { try { sqlite.exec(statement); } catch (error) { databaseLogger.warn("Failed to rename a legacy username placeholder", { operation: "schema_migration", error: getErrorMessage(error), }); } } try { sqlite .prepare( `DELETE FROM settings WHERE key IN (${RETIRED_SETTINGS.map(() => "?").join(", ")})`, ) .run(...RETIRED_SETTINGS); } catch (error) { databaseLogger.warn("Failed to delete retired settings", { operation: "schema_migration", error: getErrorMessage(error), }); } }; const migrateSchema = () => { repairSnippetsNoteColumn(sqlite); addColumnIfNotExists("user_preferences", "theme", "TEXT"); addColumnIfNotExists("user_preferences", "font_size", "TEXT"); addColumnIfNotExists("user_preferences", "accent_color", "TEXT"); addColumnIfNotExists("user_preferences", "language", "TEXT"); addColumnIfNotExists("user_preferences", "storage_mode", "TEXT"); addColumnIfNotExists("user_preferences", "command_palette_enabled", "INTEGER"); addColumnIfNotExists("user_preferences", "show_host_tags", "INTEGER"); addColumnIfNotExists("user_preferences", "host_tray_on_click", "INTEGER"); addColumnIfNotExists("user_preferences", "pin_app_rail", "INTEGER"); addColumnIfNotExists( "user_preferences", "expand_app_rail_on_hover", "INTEGER", ); addColumnIfNotExists( "user_preferences", "show_pin_app_rail_button", "INTEGER", ); addColumnIfNotExists("user_preferences", "folders_collapsed", "INTEGER"); addColumnIfNotExists("user_preferences", "disable_update_check", "INTEGER"); addColumnIfNotExists("user_preferences", "confirm_tab_close", "INTEGER"); addColumnIfNotExists("user_preferences", "hidden_rail_tabs", "TEXT"); addColumnIfNotExists("user_preferences", "compact_host_view", "INTEGER"); addColumnIfNotExists("user_preferences", "status_color_scheme", "TEXT"); addColumnIfNotExists("user_preferences", "custom_keybindings", "TEXT"); addColumnIfNotExists("users", "is_admin", "INTEGER NOT NULL DEFAULT 0"); const hadRegisteredAtColumn = (() => { try { sqlite.prepare(`SELECT "registered_at" FROM users LIMIT 1`).get(); return true; } catch { return false; } })(); // SQLite's ALTER TABLE ADD COLUMN rejects non-constant defaults like // CURRENT_TIMESTAMP, so the column is added empty and backfilled below. addColumnIfNotExists("users", "registered_at", "TEXT"); if (!hadRegisteredAtColumn) { // Pre-existing users are backdated past the 30 day mark so they see the // donation modal immediately on upgrade instead of waiting a fresh // 30 days as if they had just registered. try { sqlite.exec( `UPDATE users SET registered_at = datetime('now', '-31 days') WHERE registered_at IS NULL`, ); } catch (backfillError) { databaseLogger.warn("Failed to backfill users.registered_at", { operation: "schema_migration", error: getErrorMessage(backfillError, String(backfillError)), }); } } else { try { sqlite.exec( `UPDATE users SET registered_at = CURRENT_TIMESTAMP WHERE registered_at IS NULL`, ); } catch (backfillError) { databaseLogger.warn( "Failed to backfill NULL users.registered_at values", { operation: "schema_migration", error: getErrorMessage(backfillError, String(backfillError)), }, ); } } addColumnIfNotExists( "users", "donation_modal_dismissed", "INTEGER NOT NULL DEFAULT 0", ); addColumnIfNotExists("sessions", "external_session_ref", "TEXT"); addColumnIfNotExists("ssh_data", "name", "TEXT"); addColumnIfNotExists("ssh_data", "folder", "TEXT"); addColumnIfNotExists("ssh_data", "tags", "TEXT"); addColumnIfNotExists("ssh_data", "pin", "INTEGER NOT NULL DEFAULT 0"); addColumnIfNotExists("ssh_data", "sort_order", "INTEGER"); addColumnIfNotExists("ssh_folders", "sort_order", "INTEGER"); addColumnIfNotExists( "ssh_data", "auth_type", 'TEXT NOT NULL DEFAULT "password"', ); addColumnIfNotExists("ssh_data", "password", "TEXT"); addColumnIfNotExists("ssh_data", "key", "TEXT"); addColumnIfNotExists("ssh_data", "key_password", "TEXT"); addColumnIfNotExists("ssh_data", "key_type", "TEXT"); addColumnIfNotExists("ssh_data", "jump_hosts", "TEXT"); addColumnIfNotExists( "ssh_data", "created_at", "TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP", ); addColumnIfNotExists( "ssh_data", "updated_at", "TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP", ); addColumnIfNotExists("ssh_data", "force_keyboard_interactive", "TEXT"); addColumnIfNotExists( "ssh_data", "credential_id", "INTEGER REFERENCES ssh_credentials(id) ON DELETE SET NULL", ); addColumnIfNotExists( "ssh_data", "override_credential_username", "INTEGER", ); addColumnIfNotExists( "ssh_data", "status_check_enabled", "INTEGER NOT NULL DEFAULT 1", ); addColumnIfNotExists("ssh_data", "status_check_interval", "INTEGER"); addColumnIfNotExists("ssh_data", "connection_type", 'TEXT NOT NULL DEFAULT "ssh"'); addColumnIfNotExists("ssh_data", "domain", "TEXT"); addColumnIfNotExists("ssh_data", "notes", "TEXT"); addColumnIfNotExists("ssh_data", "use_socks5", "INTEGER"); addColumnIfNotExists("ssh_data", "socks5_host", "TEXT"); addColumnIfNotExists("ssh_data", "socks5_port", "INTEGER"); addColumnIfNotExists("ssh_data", "socks5_username", "TEXT"); addColumnIfNotExists("ssh_data", "socks5_password", "TEXT"); addColumnIfNotExists("ssh_data", "socks5_proxy_chain", "TEXT"); addColumnIfNotExists("ssh_data", "host_key_fingerprint", "TEXT"); addColumnIfNotExists("ssh_data", "host_key_type", "TEXT"); addColumnIfNotExists("ssh_data", "host_key_algorithm", "TEXT DEFAULT 'sha256'"); addColumnIfNotExists("ssh_data", "host_key_first_seen", "TEXT"); addColumnIfNotExists("ssh_data", "host_key_last_verified", "TEXT"); addColumnIfNotExists("ssh_data", "host_key_changed_count", "INTEGER DEFAULT 0"); addColumnIfNotExists("ssh_credentials", "private_key", "TEXT"); addColumnIfNotExists("ssh_credentials", "public_key", "TEXT"); addColumnIfNotExists("ssh_credentials", "detected_key_type", "TEXT"); addColumnIfNotExists("ssh_credentials", "cert_public_key", "TEXT"); addColumnIfNotExists( "ssh_credentials", "pin", "INTEGER NOT NULL DEFAULT 0", ); addColumnIfNotExists("ssh_credentials", "sort_order", "INTEGER"); try { const tableInfo = sqlite.prepare("PRAGMA table_info(ssh_credentials)").all() as Array<{ cid: number; name: string; type: string; notnull: number; dflt_value: string | null; pk: number; }>; const usernameCol = tableInfo.find((col) => col.name === "username"); if (usernameCol && usernameCol.notnull === 1) { const tempTableName = "ssh_credentials_temp_migration"; const allColumns = tableInfo.map((col) => `"${col.name}"`).join(", "); // Derive the replacement table from the live definition instead of // restating it here. The table keeps gaining columns (cert_public_key, // pin, sort_order, sync_id, ...), and a second copy of the column list // falls behind every time one is added — leaving the copy narrower than // the table, so the INSERT below fails and the constraint stays put. const createSql = sqlite .prepare("SELECT sql FROM sqlite_master WHERE type = 'table' AND name = 'ssh_credentials'") .pluck() .get() as string | undefined; if (!createSql) { throw new Error("ssh_credentials has no stored table definition"); } // Only the table name is rewritten; replace() stops at the first match, // and in a CREATE TABLE statement that is the table being defined. const renamedSql = createSql.replace("ssh_credentials", tempTableName); const tempCreateSql = renamedSql.replace(/(["`[]?username["`\]]?\s+TEXT)\s+NOT\s+NULL/i, "$1"); if (tempCreateSql === renamedSql) { throw new Error("could not derive a nullable-username definition for ssh_credentials"); } // DROP TABLE takes the table's indexes with it, so replay them afterwards. const indexDefs = sqlite .prepare( "SELECT sql FROM sqlite_master WHERE type = 'index' AND tbl_name = 'ssh_credentials' AND sql IS NOT NULL", ) .pluck() .all() as string[]; sqlite.exec(`PRAGMA foreign_keys = OFF`); sqlite.exec(` ${tempCreateSql}; INSERT INTO ${tempTableName} (${allColumns}) SELECT ${allColumns} FROM ssh_credentials; DROP TABLE ssh_credentials; ALTER TABLE ${tempTableName} RENAME TO ssh_credentials; `); for (const indexSql of indexDefs) { sqlite.exec(indexSql); } sqlite.exec(`PRAGMA foreign_keys = ON`); databaseLogger.info("Successfully migrated ssh_credentials table to remove username NOT NULL constraint", { operation: "schema_migration_username_nullable", restoredIndexes: indexDefs.length, }); } } catch (migrationError) { databaseLogger.warn("Failed to migrate ssh_credentials username column", { operation: "schema_migration", error: migrationError, }); } try { const auditLogColumns = sqlite.prepare("PRAGMA table_info(audit_logs)").all() as Array<{ name: string; notnull: number; }>; const auditUserIdCol = auditLogColumns.find((col) => col.name === "user_id"); if (auditUserIdCol && auditUserIdCol.notnull === 1) { const tempTableName = "audit_logs_temp_migration"; const columns = [ "id", "user_id", "username", "action", "resource_type", "resource_id", "resource_name", "details", "ip_address", "user_agent", "success", "error_message", "timestamp", ].join(", "); sqlite.exec(`PRAGMA foreign_keys = OFF`); sqlite.exec(` CREATE TABLE ${tempTableName} ( id INTEGER PRIMARY KEY AUTOINCREMENT, user_id TEXT, username TEXT NOT NULL, action TEXT NOT NULL, resource_type TEXT NOT NULL, resource_id TEXT, resource_name TEXT, details TEXT, ip_address TEXT, user_agent TEXT, success INTEGER NOT NULL, error_message TEXT, timestamp TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE SET NULL ); INSERT INTO ${tempTableName} (${columns}) SELECT ${columns} FROM audit_logs; DROP TABLE audit_logs; ALTER TABLE ${tempTableName} RENAME TO audit_logs; `); sqlite.exec(`PRAGMA foreign_keys = ON`); databaseLogger.info("Successfully migrated audit_logs table to remove user_id NOT NULL constraint", { operation: "schema_migration_audit_user_id_nullable", }); } } catch (migrationError) { databaseLogger.warn("Failed to migrate audit_logs user_id column", { operation: "schema_migration", error: migrationError, }); } try { sqlite.prepare("SELECT role_id FROM host_access LIMIT 1").get(); } catch { try { sqlite.exec("ALTER TABLE host_access ADD COLUMN role_id INTEGER REFERENCES roles(id) ON DELETE CASCADE"); } catch (alterError) { databaseLogger.warn("Failed to add role_id column", { operation: "schema_migration", error: alterError, }); } } try { sqlite.prepare("SELECT override_credential_id FROM host_access LIMIT 1").get(); } catch { try { sqlite.exec("ALTER TABLE host_access ADD COLUMN override_credential_id INTEGER REFERENCES ssh_credentials(id) ON DELETE SET NULL"); } catch (alterError) { databaseLogger.warn("Failed to add override_credential_id column", { operation: "schema_migration", error: alterError, }); } } try { ensureSharedHostAuthOverrideProtocolSchema(sqlite); } catch (schemaError) { databaseLogger.warn("Failed to prepare shared_host_auth_overrides table", { operation: "schema_migration", error: schemaError, }); } try { migrateLegacySharedHostAuthOverrides( sqlite, getRawSettingValue, setRawSettingValue, ); } catch (migrateError) { databaseLogger.warn("Failed to migrate shared host auth overrides", { operation: "schema_migration", error: migrateError, }); } try { sqlite.prepare("SELECT sudo_password FROM ssh_data LIMIT 1").get(); } catch { try { sqlite.exec("ALTER TABLE ssh_data ADD COLUMN sudo_password TEXT"); } catch (alterError) { databaseLogger.warn("Failed to add sudo_password column", { operation: "schema_migration", error: alterError, }); } } const sshDataMigrations: Array<{ column: string; sql: string }> = [ { column: "connection_type", sql: "ALTER TABLE ssh_data ADD COLUMN connection_type TEXT NOT NULL DEFAULT 'ssh'" }, { column: "credential_id", sql: "ALTER TABLE ssh_data ADD COLUMN credential_id INTEGER" }, { column: "override_credential_username", sql: "ALTER TABLE ssh_data ADD COLUMN override_credential_username INTEGER" }, { column: "share_ssh_auth", sql: "ALTER TABLE ssh_data ADD COLUMN share_ssh_auth INTEGER NOT NULL DEFAULT 0" }, { column: "jump_hosts", sql: "ALTER TABLE ssh_data ADD COLUMN jump_hosts TEXT" }, { column: "socks5_proxy_chain", sql: "ALTER TABLE ssh_data ADD COLUMN socks5_proxy_chain TEXT" }, { column: "host_key_fingerprint", sql: "ALTER TABLE ssh_data ADD COLUMN host_key_fingerprint TEXT" }, { column: "host_key_type", sql: "ALTER TABLE ssh_data ADD COLUMN host_key_type TEXT" }, { column: "host_key_algorithm", sql: "ALTER TABLE ssh_data ADD COLUMN host_key_algorithm TEXT NOT NULL DEFAULT 'sha256'" }, { column: "host_key_first_seen", sql: "ALTER TABLE ssh_data ADD COLUMN host_key_first_seen TEXT" }, { column: "host_key_last_verified", sql: "ALTER TABLE ssh_data ADD COLUMN host_key_last_verified TEXT" }, { column: "host_key_changed_count", sql: "ALTER TABLE ssh_data ADD COLUMN host_key_changed_count INTEGER NOT NULL DEFAULT 0" }, { column: "port_knock_sequence", sql: "ALTER TABLE ssh_data ADD COLUMN port_knock_sequence TEXT" }, { column: "enable_ssh", sql: "ALTER TABLE ssh_data ADD COLUMN enable_ssh INTEGER NOT NULL DEFAULT 1" }, { column: "ssh_port", sql: "ALTER TABLE ssh_data ADD COLUMN ssh_port INTEGER DEFAULT 22" }, { column: "connection_origin", sql: "ALTER TABLE ssh_data ADD COLUMN connection_origin TEXT" }, { column: "parent_host_id", sql: "ALTER TABLE ssh_data ADD COLUMN parent_host_id INTEGER REFERENCES ssh_data(id) ON DELETE SET NULL" }, ]; for (const migration of sshDataMigrations) { try { sqlite.prepare(`SELECT ${migration.column} FROM ssh_data LIMIT 1`).get(); } catch { try { sqlite.exec(migration.sql); } catch (alterError) { databaseLogger.warn(`Failed to add ${migration.column} column`, { operation: "schema_migration", error: alterError, }); } } } // share_ssh_auth arrived with 2.6.1 and defaults to 0, but sharing a host // used to pass the owner's SSH authentication along unconditionally. Every // host shared before the upgrade therefore stopped supplying credentials to // its recipients the moment the column appeared, and they were left with // "No valid authentication method provided". // // Turn it on for hosts that are already shared, which is where the previous // behaviour was in effect and consented to. Hosts nobody has shared keep the // new default; the owner decides when they share one. try { if (getRawSettingValue("share_ssh_auth_backfill_v1") === null) { const backfilled = sqlite .prepare( `UPDATE ssh_data SET share_ssh_auth = 1 WHERE share_ssh_auth = 0 AND id IN (SELECT DISTINCT host_id FROM host_access)`, ) .run(); if (backfilled.changes > 0) { databaseLogger.info( `Restored shared SSH authentication for ${backfilled.changes} already-shared host(s)`, { operation: "share_ssh_auth_backfill_v1" }, ); } setRawSettingValue("share_ssh_auth_backfill_v1", "true"); } } catch (e) { databaseLogger.warn("Failed to backfill share_ssh_auth", { operation: "share_ssh_auth_backfill_v1", error: e, }); } try { sqlite.prepare("SELECT id FROM shared_host_secrets LIMIT 1").get(); } catch { try { sqlite.exec(` CREATE TABLE IF NOT EXISTS shared_host_secrets ( id INTEGER PRIMARY KEY AUTOINCREMENT, host_access_id INTEGER NOT NULL, target_user_id TEXT NOT NULL, protocol TEXT NOT NULL DEFAULT 'ssh', source_type TEXT NOT NULL DEFAULT 'credential', original_credential_id INTEGER, encrypted_username TEXT, encrypted_auth_type TEXT, encrypted_password TEXT, encrypted_key TEXT, encrypted_key_password TEXT, encrypted_key_type TEXT, encrypted_domain TEXT, created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, UNIQUE(host_access_id, target_user_id, protocol), FOREIGN KEY (host_access_id) REFERENCES host_access (id) ON DELETE CASCADE, FOREIGN KEY (original_credential_id) REFERENCES ssh_credentials (id) ON DELETE CASCADE, FOREIGN KEY (target_user_id) REFERENCES users (id) ON DELETE CASCADE ); `); } catch (createError) { databaseLogger.warn("Failed to create shared_host_secrets table", { operation: "schema_migration", error: createError, }); } } addColumnIfNotExists("shared_host_secrets", "encrypted_fields", "TEXT"); try { sqlite.exec(` CREATE TABLE IF NOT EXISTS host_protocol_auth ( id INTEGER PRIMARY KEY AUTOINCREMENT, host_id INTEGER NOT NULL, user_id TEXT NOT NULL, protocol TEXT NOT NULL, auth_type TEXT NOT NULL DEFAULT 'direct', credential_id INTEGER, username TEXT, password TEXT, fields TEXT, secret_fields TEXT, created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, FOREIGN KEY (host_id) REFERENCES ssh_data (id) ON DELETE CASCADE, FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE CASCADE, FOREIGN KEY (credential_id) REFERENCES ssh_credentials (id) ON DELETE SET NULL ); CREATE UNIQUE INDEX IF NOT EXISTS idx_host_protocol_auth_host_protocol ON host_protocol_auth (host_id, protocol); CREATE INDEX IF NOT EXISTS idx_host_protocol_auth_user ON host_protocol_auth (user_id); CREATE INDEX IF NOT EXISTS idx_host_protocol_auth_credential ON host_protocol_auth (credential_id); `); } catch (createError) { databaseLogger.warn("Failed to create host_protocol_auth table", { operation: "schema_migration", error: createError, }); } addColumnIfNotExists("ssh_data", "default_overrides", "TEXT"); try { sqlite.exec(` CREATE TABLE IF NOT EXISTS host_defaults ( id INTEGER PRIMARY KEY AUTOINCREMENT, level TEXT NOT NULL, scope_key TEXT NOT NULL, user_id TEXT, folder_id INTEGER, namespace TEXT NOT NULL, key TEXT NOT NULL, value TEXT, updated_by TEXT, updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, FOREIGN KEY (user_id) REFERENCES users (id) ON DELETE CASCADE, FOREIGN KEY (folder_id) REFERENCES ssh_folders (id) ON DELETE CASCADE ); CREATE UNIQUE INDEX IF NOT EXISTS idx_host_defaults_scope_key ON host_defaults (scope_key, namespace, key); CREATE INDEX IF NOT EXISTS idx_host_defaults_user ON host_defaults (user_id); CREATE INDEX IF NOT EXISTS idx_host_defaults_folder ON host_defaults (folder_id); `); } catch (createError) { databaseLogger.warn("Failed to create host_defaults table", { operation: "schema_migration", error: createError, }); } try { if (getRawSettingValue("rbac_permission_levels_v2") === null) { sqlite.exec( "UPDATE host_access SET permission_level = 'connect' WHERE permission_level = 'view'", ); setRawSettingValue("rbac_permission_levels_v2", "done"); } } catch (migrateError) { databaseLogger.warn("Failed to migrate legacy view permission level", { operation: "schema_migration", error: migrateError, }); } try { const existingRoles = sqlite.prepare("SELECT name, is_system FROM roles").all() as Array<{ name: string; is_system: number }>; try { const validSystemRoles = ['admin', 'user']; const unwantedRoleNames = ['superAdmin', 'powerUser', 'readonly', 'member']; const deleteByName = sqlite.prepare("DELETE FROM roles WHERE name = ?"); for (const roleName of unwantedRoleNames) { deleteByName.run(roleName); } const deleteOldSystemRole = sqlite.prepare("DELETE FROM roles WHERE name = ? AND is_system = 1"); for (const role of existingRoles) { if (role.is_system === 1 && !validSystemRoles.includes(role.name) && !unwantedRoleNames.includes(role.name)) { deleteOldSystemRole.run(role.name); } } } catch (cleanupError) { databaseLogger.warn("Failed to clean up old system roles", { operation: "schema_migration", error: cleanupError, }); } const systemRoles = Object.entries(SYSTEM_ROLE_DEFAULTS).map( ([name, defaults]) => ({ name, displayName: `rbac.roles.${name}`, description: defaults.description, permissions: JSON.stringify(defaults.permissions), }), ); // Route-level RBAC needs the permission lists to exist; roles seeded by // earlier versions carried NULL there. Backfill only NULL so an admin's // edits to these roles are never overwritten. const backfillPermissions = sqlite.prepare( "UPDATE roles SET permissions = ? WHERE name = ? AND is_system = 1 AND permissions IS NULL", ); for (const role of systemRoles) { backfillPermissions.run(role.permissions, role.name); } for (const role of systemRoles) { const existingRole = sqlite.prepare("SELECT id FROM roles WHERE name = ?").get(role.name); if (!existingRole) { try { sqlite.prepare(` INSERT INTO roles (name, display_name, description, is_system, permissions) VALUES (?, ?, ?, 1, ?) `).run(role.name, role.displayName, role.description, role.permissions); } catch (insertError) { databaseLogger.warn(`Failed to create system role: ${role.name}`, { operation: "schema_migration", error: insertError, }); } } } try { const adminUsers = sqlite.prepare("SELECT id FROM users WHERE is_admin = 1").all() as { id: string }[]; const normalUsers = sqlite.prepare("SELECT id FROM users WHERE is_admin = 0").all() as { id: string }[]; const adminRole = sqlite.prepare("SELECT id FROM roles WHERE name = 'admin'").get() as { id: number } | undefined; const userRole = sqlite.prepare("SELECT id FROM roles WHERE name = 'user'").get() as { id: number } | undefined; if (adminRole) { const insertUserRole = sqlite.prepare(` INSERT OR IGNORE INTO user_roles (user_id, role_id, granted_at) VALUES (?, ?, CURRENT_TIMESTAMP) `); for (const admin of adminUsers) { try { insertUserRole.run(admin.id, adminRole.id); } catch { // Ignore duplicate errors } } } if (userRole) { const insertUserRole = sqlite.prepare(` INSERT OR IGNORE INTO user_roles (user_id, role_id, granted_at) VALUES (?, ?, CURRENT_TIMESTAMP) `); for (const user of normalUsers) { try { insertUserRole.run(user.id, userRole.id); } catch { // Ignore duplicate errors } } } } catch (migrationError) { databaseLogger.warn("Failed to migrate existing users to roles", { operation: "schema_migration", error: migrationError, }); } } catch (seedError) { databaseLogger.warn("Failed to seed system roles", { operation: "schema_migration", error: seedError, }); } // --- alerts begin --- // alert_rules, alert_rule_channels and alert_firings were only ever created // here, never declared in schema.ts, so they never existed on Postgres or // MySQL at all. Automations replaced them; drop the SQLite leftovers. for (const table of [ "alert_firings", "alert_rule_channels", "alert_rules", ]) { try { sqlite.exec(`DROP TABLE IF EXISTS ${table};`); } catch (dropError) { databaseLogger.warn(`Failed to drop legacy ${table} table`, { operation: "schema_migration", error: dropError, }); } } // --- alerts end --- // --- sync begin --- // Stable per-row identity used to match rows across two independently- // seeded databases (the embedded desktop backend and a connected remote // server) during sync. Local autoincrement ids collide across instances, // so a randomly-generated id is the join key instead. SQLite refuses a // non-constant DEFAULT (e.g. randomblob()) on ALTER TABLE ADD COLUMN for // tables with existing constraints ("Cannot add a column with // non-constant default"), so the column is added as plain nullable TEXT; // repositories set syncId explicitly on insert going forward, and // existing rows are backfilled by the UPDATE loop below. addColumnIfNotExists("ssh_data", "sync_id", "TEXT"); addColumnIfNotExists("ssh_credentials", "sync_id", "TEXT"); addColumnIfNotExists("ssh_folders", "sync_id", "TEXT"); // Plugin runtime: lastError reports why a plugin is blocked or failed, and // grants record whether a capability came from an admin or from bundling. addColumnIfNotExists("plugins", "last_error", "TEXT"); addColumnIfNotExists("plugins", "pinned_version", "TEXT"); addColumnIfNotExists( "plugin_permission_grants", "source", "TEXT NOT NULL DEFAULT 'admin'", ); relaxPluginGrantGrantedBy(); const syncIdTables = ["ssh_data", "ssh_credentials", "ssh_folders"]; for (const table of syncIdTables) { try { const result = sqlite .prepare( `UPDATE ${table} SET sync_id = lower(hex(randomblob(16))) WHERE sync_id IS NULL`, ) .run(); if (result.changes > 0) { databaseLogger.info( `Backfilled sync_id for ${result.changes} row(s) in ${table}`, { operation: "sync_id_backfill", table }, ); } sqlite.exec( `CREATE UNIQUE INDEX IF NOT EXISTS idx_${table}_sync_id ON ${table}(sync_id)`, ); } catch (e) { const message = e instanceof Error ? e.message : String(e); databaseLogger.warn( `Failed to backfill sync_id for ${table}: ${message}`, { operation: "sync_id_backfill", table, }, ); } } addColumnIfNotExists( "ssh_data", "local_only", "INTEGER NOT NULL DEFAULT 0", ); addColumnIfNotExists("ssh_data", "shared_source", "TEXT"); addColumnIfNotExists("ssh_data", "ssh_options", "TEXT"); addColumnIfNotExists("ssh_credentials", "shared_source", "TEXT"); addColumnIfNotExists( "ssh_folders", "local_only", "INTEGER NOT NULL DEFAULT 0", ); try { sqlite.exec(` DROP TABLE IF EXISTS sync_tombstones; CREATE TABLE IF NOT EXISTS sync_records ( id INTEGER PRIMARY KEY AUTOINCREMENT, user_id TEXT NOT NULL REFERENCES users(id) ON DELETE CASCADE, entity_type TEXT NOT NULL, sync_id TEXT NOT NULL, revision INTEGER NOT NULL DEFAULT 0, seq INTEGER NOT NULL DEFAULT 0, hash TEXT, deleted INTEGER NOT NULL DEFAULT 0, error TEXT, error_hash TEXT, updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP ); CREATE UNIQUE INDEX IF NOT EXISTS idx_sync_records_user_entity_sync ON sync_records(user_id, entity_type, sync_id); CREATE INDEX IF NOT EXISTS idx_sync_records_user_seq ON sync_records(user_id, seq); CREATE TABLE IF NOT EXISTS sync_conflicts ( id INTEGER PRIMARY KEY AUTOINCREMENT, user_id TEXT NOT NULL REFERENCES users(id) ON DELETE CASCADE, entity_type TEXT NOT NULL, sync_id TEXT NOT NULL, local_row TEXT NOT NULL, server_revision INTEGER NOT NULL, created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP ); CREATE INDEX IF NOT EXISTS idx_sync_conflicts_user ON sync_conflicts(user_id); CREATE TABLE IF NOT EXISTS sync_link ( id INTEGER PRIMARY KEY AUTOINCREMENT, user_id TEXT NOT NULL REFERENCES users(id) ON DELETE CASCADE, server_url TEXT NOT NULL, server_name TEXT, server_version TEXT, session_token TEXT, custom_headers TEXT, basic_auth TEXT, allow_invalid_certificate INTEGER NOT NULL DEFAULT 0, remote_user_id TEXT, remote_username TEXT, account TEXT, scope TEXT, known_types TEXT, cursor INTEGER NOT NULL DEFAULT 0, status TEXT NOT NULL DEFAULT 'idle', last_error TEXT, linked_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP, last_sync_at TEXT ); `); } catch (createError) { databaseLogger.warn("Failed to create sync tables", { operation: "schema_migration", error: createError, }); } // --- sync end --- // Audit trails and session recordings used to be deleted along with the user // they referenced, which defeats the point of keeping them. migrateAuditRetention(sqlite); dropRetiredColumns(); // Runs last so every table and column added above already exists. createPerformanceIndexes(sqlite); databaseLogger.success("Schema migration completed", { operation: "schema_migration", }); }; // A trivial telemetry write forces `serialize()` to rewrite every free page // along with the live ones, so a database that has accumulated a large // freelist (from years of unbounded metrics/audit growth before retention // pruning existed) turns every future save into a multi-megabyte rewrite. // Reclaiming that space once at startup keeps steady-state saves cheap. const VACUUM_FREELIST_COUNT_THRESHOLD = 2000; const VACUUM_FREELIST_RATIO_THRESHOLD = 0.5; function vacuumIfFreelistBloated(): void { try { const pageCount = sqlite.pragma("page_count", { simple: true }) as number; const freelistCount = sqlite.pragma("freelist_count", { simple: true, }) as number; if (pageCount <= 0) return; const freelistRatio = freelistCount / pageCount; if ( freelistCount < VACUUM_FREELIST_COUNT_THRESHOLD || freelistRatio < VACUUM_FREELIST_RATIO_THRESHOLD ) { return; } databaseLogger.info("Reclaiming bloated SQLite freelist on startup", { operation: "db_startup_vacuum", pageCount, freelistCount, freelistRatio, }); sqlite.exec("VACUUM"); } catch (error) { databaseLogger.warn("Failed to vacuum database on startup", { operation: "db_startup_vacuum_failed", error: error instanceof Error ? error.message : String(error), }); } } async function saveMemoryDatabaseToFile(): Promise { if (!memoryDatabase) return; try { const buffer = memoryDatabase.serialize(); if (!fs.existsSync(dataDir)) { fs.mkdirSync(dataDir, { recursive: true }); } try { memoryDatabase .prepare("SELECT COUNT(*) as count FROM sessions") .get() as { count: number }; } catch { // expected - sessions table may not exist yet } if (enableFileEncryption) { await DatabaseFileEncryption.encryptDatabaseFromBuffer( buffer, encryptedDbPath, ); } else { fs.writeFileSync(dbPath, buffer); } DatabaseSaveTrigger.markClean(); } catch (error) { databaseLogger.error("Failed to save in-memory database", error, { operation: "memory_db_save_failed", enableFileEncryption, }); } } async function handlePostInitFileEncryption() { try { if (memoryDatabase) { DatabaseSaveTrigger.initialize(saveMemoryDatabaseToFile); if (enableFileEncryption) { await saveMemoryDatabaseToFile(); } setInterval(() => { if (DatabaseSaveTrigger.isDirty) { saveMemoryDatabaseToFile(); } }, 5 * 60 * 1000); } if (!enableFileEncryption) return; try { const migration = new DatabaseMigration(dataDir); migration.cleanupOldBackups(); } catch (cleanupError) { databaseLogger.warn("Failed to cleanup old migration files", { operation: "migration_cleanup_startup_failed", error: getErrorMessage(cleanupError), }); } } catch (error) { databaseLogger.error( "Failed to handle database file encryption setup", error, { operation: "db_encrypt_setup_failed", }, ); } } async function initializeDatabase(): Promise { const dialect = resolveDatabaseDialect(); if (dialect !== "sqlite") { await initializeRemoteDatabase(dialect); return; } await initializeCompleteDatabase(); await handlePostInitFileEncryption(); } /** * Startup against Postgres or MySQL. * * Shorter than the SQLite path because most of what that one does has no * counterpart here: there is no file to decrypt, no in-memory copy to keep in * step with disk, and the schema comes from drizzle-kit migrations instead of * the inline DDL below. * * What does carry over is the settings cache. 27 call sites read settings * synchronously, which better-sqlite3 allows and no remote driver does, so the * table is loaded once here before anything asks for it. */ function resultRows(result: unknown): T[] { // node-postgres returns { rows }, mysql2 returns [rows, fields]. if (Array.isArray(result)) return result[0] as T[]; return ((result as { rows?: unknown[] }).rows ?? []) as T[]; } async function moveRemoteLegacySudoPasswords(remote: { execute: (query: SQL) => Promise; }): Promise { let rows: LegacySudoRow[]; try { rows = resultRows( await remote.execute( sql`SELECT id, terminal_config, sudo_password FROM ssh_data WHERE terminal_config LIKE '%sudoPassword%'`, ), ); } catch { // A database created after the column left never had it. return; } for (const move of legacySudoMoves(rows)) { await remote.execute( sql`UPDATE ssh_data SET sudo_password = ${move.sudoPassword} WHERE id = ${move.id}`, ); } } /** * The columns 2.9.0 left in place without a drizzle migration, so drizzle no * longer knows them. Dropped by hand, only where they still exist. */ async function dropRemoteRetired( dialect: Exclude, remote: { execute: (query: SQL) => Promise }, ): Promise { const tables = Object.keys(REMOTE_RETIRED_COLUMNS); const schema = dialect === "postgres" ? sql`current_schema()` : sql`DATABASE()`; let present: Array<{ table_name: string; column_name: string }> = []; try { present = resultRows( await remote.execute( sql`SELECT table_name AS table_name, column_name AS column_name FROM information_schema.columns WHERE table_schema = ${schema} AND table_name IN (${sql.join( tables.map((table) => sql`${table}`), sql`, `, )})`, ), ); } catch (error) { databaseLogger.warn("Could not list retired columns", { operation: "schema_migration", error: getErrorMessage(error), }); return; } const existing = new Set( present.map((row) => `${row.table_name}.${row.column_name}`), ); for (const [table, columns] of Object.entries(REMOTE_RETIRED_COLUMNS)) { for (const column of columns) { if (!existing.has(`${table}.${column}`)) continue; try { await remote.execute( sql`ALTER TABLE ${sql.identifier(table)} DROP COLUMN ${sql.identifier(column)}`, ); } catch (error) { databaseLogger.warn(`Failed to drop ${table}.${column}`, { operation: "schema_migration", error: getErrorMessage(error), }); } } } try { await remote.execute( sql`DELETE FROM settings WHERE ${sql.identifier("key")} IN (${sql.join( RETIRED_SETTINGS.map((key) => sql`${key}`), sql`, `, )})`, ); } catch (error) { databaseLogger.warn("Failed to delete retired settings", { operation: "schema_migration", error: getErrorMessage(error), }); } } async function initializeRemoteDatabase( dialect: Exclude, ): Promise { databaseLogger.info(`Connecting to ${dialect} database`, { operation: "db_init", dialect, }); db = await connectRemoteDatabase(dialect); const remote = db as unknown as { execute: (query: SQL) => Promise }; await assertNotPre29Database(async (name) => { try { await remote.execute(sql`SELECT 1 FROM ${sql.identifier(name)} WHERE 1 = 0`); return true; } catch { return false; } }); await moveRemoteLegacySudoPasswords(remote); try { await remote.execute(sql`SELECT oidc_identifier FROM users WHERE 1 = 0`); const { runSsoLegacyIdentityMigration } = await import("../../upgrade/sso-legacy-identity-migration.js"); await runSsoLegacyIdentityMigration(); } catch { // The column is gone: the move ran before it was dropped. } await runRemoteMigrations(dialect, db); await dropRemoteRetired(dialect, remote); // Imported here rather than at the top: factory.ts imports getDb from this // module, and a static import would close the cycle at module-load time. const { primeCurrentSettingsCache, startSettingsCacheRefresh } = await import( "../repositories/factory.js" ); await primeCurrentSettingsCache(); startSettingsCacheRefresh(); // The SQLite bootstrap seeds system roles inline below; migrations for the // remote dialects never did, and route-level RBAC denies a user with no // usable role, so they are seeded (and backfilled) here. const { ensureSystemRoles } = await import("../../utils/system-roles.js"); await ensureSystemRoles(); databaseLogger.info(`${dialect} database ready`, { operation: "db_init_complete", dialect, }); } export { initializeDatabase }; async function cleanupDatabase() { if (memoryDatabase) { try { await saveMemoryDatabaseToFile(); } catch (error) { databaseLogger.error( "Failed to save in-memory database before shutdown", error, { operation: "shutdown_save_failed", }, ); } } try { if (sqlite) { sqlite.close(); } } catch (error) { databaseLogger.warn("Error closing database connection", { operation: "db_close_error", error: getErrorMessage(error), }); } try { const tempDir = path.join(dataDir, ".temp"); if (fs.existsSync(tempDir)) { const files = fs.readdirSync(tempDir); for (const file of files) { try { fs.unlinkSync(path.join(tempDir, file)); } catch { // expected - file cleanup best effort } } try { fs.rmdirSync(tempDir); } catch { // expected - dir cleanup best effort } } } catch { // expected - temp dir cleanup best effort } } process.on("exit", () => { if (sqlite) { try { sqlite.close(); } catch { // expected - database may already be closed } } }); process.on("SIGINT", async () => { databaseLogger.info("Received SIGINT, cleaning up...", { operation: "shutdown", }); await cleanupDatabase(); process.exit(0); }); process.on("SIGTERM", async () => { databaseLogger.info("Received SIGTERM, cleaning up...", { operation: "shutdown", }); await cleanupDatabase(); process.exit(0); }); let db: PortableDatabase; export function getDb(): PortableDatabase { if (!db) { throw new Error( "Database not initialized. Ensure initializeDatabase() is called before accessing db.", ); } return db; } export function getSqlite(): Database.Database { if (!sqlite) { const dialect = resolveDatabaseDialect(); if (dialect !== "sqlite") { throw new Error( `No SQLite handle: DATABASE_DIALECT is "${dialect}". This caller needs a ` + `synchronous query, which only SQLite offers — give it an async path instead.`, ); } throw new Error( "SQLite not initialized. Ensure initializeDatabase() is called before accessing sqlite.", ); } return sqlite; } export { saveMemoryDatabaseToFile }; export { DatabaseSaveTrigger };