Build your personal knowledge base with Trilium Notes
TypeScript electronelectron-appknowledge-baseknowledge-graphknowledge-managementknowledge-management-graphlocal-firstnote-managmentnote-takernote-takingnotebooknotesnotes-apppersonal-knowledge-basepersonal-wikiscriptableself-hostedself-hostingwiki
import { parseSecuritySettings, type SecuritySettings } from "@triliumnext/commons";
import dataDirs from "@triliumnext/server/src/services/data_dir.js";
import electron from "electron";
import fs from "fs";
import { t } from "i18next";
import path from "path";
const SECURITY_JSON_PATH = path.join(dataDirs.TRILIUM_DATA_DIR, "security.json");
function readSettings(): SecuritySettings {
try {
if (fs.existsSync(SECURITY_JSON_PATH)) {
return parseSecuritySettings(fs.readFileSync(SECURITY_JSON_PATH, "utf-8"));
}
} catch {
// Corrupted or unreadable — treat as defaults
}
return {};
}
function writeSettings(settings: SecuritySettings): void {
fs.writeFileSync(SECURITY_JSON_PATH, JSON.stringify(settings, null, 2), "utf-8");
}
/**
* Reads security settings from `data_dir/security.json`.
* Called at startup to inject into the server config.
*/
export function getSecuritySettings(): SecuritySettings {
return readSettings();
}
interface ConfirmResult {
confirmed: boolean;
suppressFurtherDialogs: boolean;
}
async function confirmEnable(settingLabel: string, warning: string): Promise<ConfirmResult> {
const result = await electron.dialog.showMessageBox({
type: "warning",
buttons: [t("security-dialog.cancel"), t("security-dialog.enable")],
defaultId: 0,
cancelId: 0,
checkboxLabel: t("security-dialog.dont-ask-again"),
title: t("security-dialog.enable-title", { settingLabel }),
message: t("security-dialog.enable-message", { settingLabel }),
detail: t("security-dialog.enable-detail", { warning })
});
return { confirmed: result.response === 1, suppressFurtherDialogs: result.checkboxChecked };
}
async function confirmDisable(settingLabel: string): Promise<ConfirmResult> {
const result = await electron.dialog.showMessageBox({
type: "info",
buttons: [t("security-dialog.cancel"), t("security-dialog.disable")],
defaultId: 1,
cancelId: 0,
checkboxLabel: t("security-dialog.dont-ask-again"),
title: t("security-dialog.disable-title", { settingLabel }),
message: t("security-dialog.disable-message", { settingLabel }),
detail: t("security-dialog.disable-detail")
});
return { confirmed: result.response === 1, suppressFurtherDialogs: result.checkboxChecked };
}
// Prevents malicious frontend scripts from spamming the confirmation dialog to
// fatigue the user into clicking "Enable". The user can tick "Don't ask again"
// to suppress all security dialogs for the rest of the session. Resets on restart.
let suppressedForSession = false;
/**
* Registers an IPC handler that gates a single security toggle behind a
* confirmation dialog and persists it to `security.json`. `labelKey` and
* `warningKey` are i18next keys resolved at invocation time so the dialog
* follows runtime language changes.
*/
function registerToggleHandler(
channel: string,
settingKey: keyof SecuritySettings,
labelKey: string,
warningKey: string
): void {
electron.ipcMain.handle(channel, async (_event, enabled: boolean) => {
if (suppressedForSession) {
return false;
}
const settingLabel = t(labelKey);
const { confirmed, suppressFurtherDialogs } = enabled
? await confirmEnable(settingLabel, t(warningKey))
: await confirmDisable(settingLabel);
// Latch the session-wide suppression flag; never clears it once set.
suppressedForSession = suppressFurtherDialogs || suppressedForSession;
if (!confirmed) {
return false;
}
const settings = readSettings();
settings[settingKey] = enabled;
writeSettings(settings);
return true;
});
}
export function registerSecurityIpcHandlers(): void {
registerToggleHandler(
"security-set-backend-scripting",
"backendScriptingEnabled",
"security-dialog.backend-scripting",
"security-dialog.backend-scripting-warning"
);
registerToggleHandler(
"security-set-sql-console",
"sqlConsoleEnabled",
"security-dialog.sql-console",
"security-dialog.sql-console-warning"
);
registerToggleHandler(
"security-set-lan-access",
"allowLanAccess",
"security-dialog.lan-access",
"security-dialog.lan-access-warning"
);
}