Beautiful, AI-native markdown IDE and LLM wiki
TypeScript 2nd-brainagent-skillsclaudecodexcompany-braindocsknowledge-knowledge-baseknowledge-managementllmllm-wikillm-wiki-karpathymarkdownmarkdown-editormdmdxnotespkmsecond-brainskills
fix(ok): add a desktop CSP and take the visimer 1.1.3 Escape fix (#6544)
Dimitri POSTOLOV38c1008543a8
diff --git a/.changeset/desktop-file-protocol-csp.md b/.changeset/desktop-file-protocol-csp.mdnew file mode 100644index 000000000..a61e79c15--- /dev/null+++ b/.changeset/desktop-file-protocol-csp.md@@ -0,0 +1,5 @@+---+"@inkeep/open-knowledge": patch+---++OpenKnowledge Desktop's editor, note, navigator and terminal windows now apply a Content-Security-Policy and refuse to load local files from outside the app bundle, which stops scripts injected into the page from running.diff --git a/.changeset/mermaid-escape-label-restore.md b/.changeset/mermaid-escape-label-restore.mdnew file mode 100644index 000000000..98dbf49f7--- /dev/null+++ b/.changeset/mermaid-escape-label-restore.md@@ -0,0 +1,5 @@+---+"@inkeep/open-knowledge": patch+---++Cancelling a Mermaid label edit with Escape now restores the label exactly as the diagram showed it. Before, the editor read the label's source text as HTML, which skipped Mermaid's sanitizer.diff --git a/THIRD_PARTY_NOTICES.md b/THIRD_PARTY_NOTICES.mdindex 997d05207..b1bd7e102 100644--- a/THIRD_PARTY_NOTICES.md+++ b/THIRD_PARTY_NOTICES.md@@ -6689,12 +6689,12 @@ Copyright (c) 1991 - 1995, Stichting Mathematisch Centrum Amsterdam,The packages below are authored and published by Inkeep and are licensed under GPL-3.0-or-later, the same license as OpenKnowledge itself (see the repository LICENSE for the full text). They are listed for completeness; they are not third-party material.-### `@visimer/[email protected]`+### `@visimer/[email protected]`Homepage: https://github.com/inkeep/visimer#readmeCopyright (c) 2026 Inkeep-### `@visimer/[email protected]`+### `@visimer/[email protected]`Homepage: https://github.com/inkeep/visimer#readmeCopyright (c) 2026 Inkeepdiff --git a/packages/app/package.json b/packages/app/package.jsonindex 709179986..d7b5735d5 100644--- a/packages/app/package.json+++ b/packages/app/package.json@@ -137,8 +137,8 @@"@tiptap/suggestion": "^3.22.3","@tiptap/y-tiptap": "3.0.3","@u-wave/react-vimeo": "^0.9.12",- "@visimer/core": "^1.1.2",- "@visimer/dom": "^1.1.2",+ "@visimer/core": "^1.1.3",+ "@visimer/dom": "^1.1.3","@xterm/addon-fit": "0.11.0","@xterm/addon-unicode11": "0.9.0","@xterm/addon-web-links": "0.12.0",diff --git a/packages/app/tests/stress/mermaid-canvas-edit.e2e.ts b/packages/app/tests/stress/mermaid-canvas-edit.e2e.tsindex 61ce35ce4..ef8296f5d 100644--- a/packages/app/tests/stress/mermaid-canvas-edit.e2e.ts+++ b/packages/app/tests/stress/mermaid-canvas-edit.e2e.ts@@ -1,6 +1,6 @@import { randomUUID } from 'node:crypto';import type { Page } from '@playwright/test';-import { expect, test, waitForActiveProviderSynced } from './_helpers';+import { type ApiHelpers, expect, test, waitForActiveProviderSynced } from './_helpers';async function readDocumentContent(page: Page, docName: string): Promise<string> {const response = await page.request.get(`/api/document?docName=${encodeURIComponent(docName)}`);@@ -9,21 +9,20 @@ async function readDocumentContent(page: Page, docName: string): Promise<string>return body.content ?? '';}+async function openDiagram(page: Page, api: ApiHelpers, docName: string, flowchart: string) {+ await api.createPage(`${docName}.md`);+ await api.replaceDoc(docName, `# Diagram\n\n\`\`\`mermaid\n${flowchart}\n\`\`\`\n`);+ await page.goto(`/#/${docName}`);+ await waitForActiveProviderSynced(page, { timeout: 15_000 });+ return page.locator('[data-component-type="mermaid"].mermaid-ready');+}+test('mermaid canvas renders a flowchart and Escape cancels an in-place label edit', async ({page,api,}) => {const docName = `mermaid-${randomUUID().slice(0, 8)}`;- await api.createPage(`${docName}.md`);- await api.replaceDoc(- docName,- '# Diagram\n\n```mermaid\nflowchart TD\n A[Start] --> B[Finish]\n```\n',- );-- await page.goto(`/#/${docName}`);- await waitForActiveProviderSynced(page, { timeout: 15_000 });-- const diagram = page.locator('[data-component-type="mermaid"].mermaid-ready');+ const diagram = await openDiagram(page, api, docName, 'flowchart TD\n A[Start] --> B[Finish]');const startLabel = diagram.locator('.nodeLabel', { hasText: 'Start' });await expect(startLabel).toBeVisible();await expect(diagram.locator('.nodeLabel', { hasText: 'Finish' })).toBeVisible();@@ -45,3 +44,22 @@ test('mermaid canvas renders a flowchart and Escape cancels an in-place label ed.not.toContain('Cancelled');expect(await readDocumentContent(page, docName)).toContain('A[Start] --> B[Finish]');});++test('Escape restores a formatted label exactly as mermaid rendered it', async ({ page, api }) => {+ const diagram = await openDiagram(+ page,+ api,+ `mermaid-formatted-${randomUUID().slice(0, 8)}`,+ 'flowchart TD\n A["`**bold** text`"] --> B[Finish]',+ );+ const label = diagram.locator('.nodeLabel', { hasText: 'bold text' });+ await expect(label.locator('strong')).toHaveText('bold');++ await label.dblclick();+ await expect(diagram.locator('[contenteditable="true"]')).toHaveCount(1);+ await page.keyboard.press('Escape');++ await expect(diagram.locator('[contenteditable="true"]')).toHaveCount(0);+ await expect(label).toHaveText('bold text');+ await expect(label.locator('strong')).toHaveText('bold');+});diff --git a/packages/server/src/http/shell-csp.test.ts b/packages/core/src/app-shell-csp.test.tssimilarity index 66%rename from packages/server/src/http/shell-csp.test.tsrename to packages/core/src/app-shell-csp.test.tsindex 631b2e9e8..2e3621c64 100644--- a/packages/server/src/http/shell-csp.test.ts+++ b/packages/core/src/app-shell-csp.test.ts@@ -10,12 +10,10 @@ import {utimesSync,writeFileSync,} from 'node:fs';-import { IncomingMessage, ServerResponse } from 'node:http';-import { Socket } from 'node:net';import { tmpdir } from 'node:os';import { join } from 'node:path';import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest';-import { createShellHeaderSetter } from './shell-csp.ts';+import { createAppShellPolicies } from './app-shell-csp.ts';vi.mock('node:fs', async (importOriginal) => {const fs = await importOriginal<typeof import('node:fs')>();@@ -32,7 +30,7 @@ function denied(): never {const SHELL_SCRIPT = 'window.shellBooted = true;';-describe('createShellHeaderSetter', () => {+describe('createAppShellPolicies', () => {let dist: string;beforeEach(() => {@@ -52,22 +50,28 @@ describe('createShellHeaderSetter', () => {afterEach(() => {vi.mocked(readFileSync).mockReset();vi.mocked(readdirSync).mockReset();+ onFailure.mockReset();rmSync(dist, { recursive: true, force: true });});- function serve(setHeaders: ReturnType<typeof createShellHeaderSetter>, file: string) {- const res = new ServerResponse(new IncomingMessage(new Socket()));- setHeaders(res, '/the-request-path-is-not-used', statSync(join(dist, file)));- return res.getHeader('content-security-policy');+ const onFailure = vi.fn();++ function policies() {+ return createAppShellPolicies(dist, onFailure);+ }++ function serve(policyFor: ReturnType<typeof createAppShellPolicies>, file: string) {+ const path = join(dist, file);+ return policyFor(statSync(path), path);}test('each served document gets its own policy, and other files get none', () => {- const setHeaders = createShellHeaderSetter(dist);- expect(serve(setHeaders, 'index.html')).toContain(scriptHash(SHELL_SCRIPT));- expect(serve(setHeaders, 'assets/preview-frame.html')).toBe(+ const policyFor = policies();+ expect(serve(policyFor, 'index.html')).toContain(scriptHash(SHELL_SCRIPT));+ expect(serve(policyFor, 'assets/preview-frame.html')).toBe("sandbox allow-scripts; frame-ancestors 'self'",);- expect(serve(setHeaders, 'assets/app.js')).toBeUndefined();+ expect(serve(policyFor, 'assets/app.js')).toBeUndefined();});function setFolderTimes(time: Date) {@@ -76,46 +80,53 @@ describe('createShellHeaderSetter', () => {test('a document added to a subfolder after the first scan gets its policy', () => {setFolderTimes(new Date('2020-01-01T00:00:00Z'));- const setHeaders = createShellHeaderSetter(dist);- serve(setHeaders, 'index.html');+ const policyFor = policies();+ serve(policyFor, 'index.html');writeFileSync(join(dist, 'assets', 'late.html'), '<script>window.late = true;</script>');const assetsTouched = new Date('2021-01-01T00:00:00Z');utimesSync(join(dist, 'assets'), assetsTouched, assetsTouched);- expect(serve(setHeaders, 'assets/late.html')).toContain(scriptHash('window.late = true;'));+ expect(serve(policyFor, 'assets/late.html')).toContain(scriptHash('window.late = true;'));});test('a listing of recently changed folders is taken again even if no mtime moves', () => {const recent = new Date(Date.now() - 500);setFolderTimes(recent);- const setHeaders = createShellHeaderSetter(dist);- serve(setHeaders, 'index.html');+ const policyFor = policies();+ serve(policyFor, 'index.html');writeFileSync(join(dist, 'assets', 'late.html'), '<script>window.late = true;</script>');setFolderTimes(recent);- expect(serve(setHeaders, 'assets/late.html')).toContain(scriptHash('window.late = true;'));+ expect(serve(policyFor, 'assets/late.html')).toContain(scriptHash('window.late = true;'));});test('a served file that matches two documents blocks inline scripts', () => {linkSync(join(dist, 'index.html'), join(dist, 'assets', 'index-copy.html'));- const policy = serve(createShellHeaderSetter(dist), 'index.html');+ const policy = serve(policies(), 'index.html');expect(policy).toContain("script-src 'self'");expect(policy).not.toContain('sha256-');+ expect(onFailure).toHaveBeenCalledTimes(1);+ expect(onFailure).toHaveBeenCalledWith(+ expect.objectContaining({ file: join(dist, 'index.html') }),+ expect.any(String),+ );});test('a failed document read blocks inline scripts once and is not remembered', () => {- const setHeaders = createShellHeaderSetter(dist);+ const policyFor = policies();vi.mocked(readFileSync).mockImplementationOnce(denied);- const failed = serve(setHeaders, 'index.html');+ const failed = serve(policyFor, 'index.html');expect(failed).toContain("script-src 'self'");expect(failed).not.toContain('sha256-');- expect(serve(setHeaders, 'index.html')).toContain(scriptHash(SHELL_SCRIPT));+ expect(onFailure).toHaveBeenCalledTimes(1);+ expect(serve(policyFor, 'index.html')).toContain(scriptHash(SHELL_SCRIPT));});test('a failed scan blocks inline scripts once and is not remembered', () => {- const setHeaders = createShellHeaderSetter(dist);+ const policyFor = policies();vi.mocked(readdirSync).mockImplementationOnce(denied);- const failed = serve(setHeaders, 'index.html');+ const failed = serve(policyFor, 'index.html');expect(failed).toContain("script-src 'self'");expect(failed).not.toContain('sha256-');- expect(serve(setHeaders, 'index.html')).toContain(scriptHash(SHELL_SCRIPT));+ expect(onFailure).toHaveBeenCalledTimes(1);+ expect(serve(policyFor, 'index.html')).toContain(scriptHash(SHELL_SCRIPT));});});diff --git a/packages/core/src/app-shell-csp.ts b/packages/core/src/app-shell-csp.tsnew file mode 100644index 000000000..d176e849b--- /dev/null+++ b/packages/core/src/app-shell-csp.ts@@ -0,0 +1,144 @@+import { createHash } from 'node:crypto';+import { readdirSync, readFileSync, type Stats, statSync } from 'node:fs';+import { extname, join, resolve } from 'node:path';++// WARN: packages/app ships this page as public/assets/preview-frame.html and loads it from preview-iframe-header.ts; keep the paths in step.+const PREVIEW_FRAME_FILE = 'assets/preview-frame.html';++const PREVIEW_FRAME_CSP = "sandbox allow-scripts; frame-ancestors 'self'";++const INLINE_SCRIPT = /<script(?![^>]*\ssrc\s*=)[^>]*>([\s\S]*?)<\/script>/gi;++function appShellContentSecurityPolicy(html: string): string {+ const scriptHashes = [...html.matchAll(INLINE_SCRIPT)].map(+ (match) =>+ `'sha256-${createHash('sha256')+ .update(match[1] ?? '')+ .digest('base64')}'`,+ );+ return [+ ["script-src 'self' 'unsafe-eval' 'wasm-unsafe-eval'", ...scriptHashes].join(' '),+ "worker-src 'self' blob:",+ "object-src 'none'",+ "base-uri 'self'",+ ].join('; ');+}++const NO_INLINE_SCRIPT_POLICY = appShellContentSecurityPolicy('');++const HTML_EXTENSIONS = new Set(['.html', '.htm']);++const RECENT_CHANGE_MS = 2_000;++interface BundleListing {+ documents: string[];+ folders: Map<string, number>;+ settled: boolean;+}++function listBundle(root: string): BundleListing {+ const listedAt = Date.now();+ const entries = readdirSync(root, { recursive: true, withFileTypes: true });+ const folders = [+ root,+ ...entries+ .filter((entry) => entry.isDirectory())+ .map((entry) => join(entry.parentPath, entry.name)),+ ];+ const folderMtimes = new Map(folders.map((folder) => [folder, statSync(folder).mtimeMs]));+ const recentFrom = listedAt - RECENT_CHANGE_MS;+ const recentUntil = Date.now() + RECENT_CHANGE_MS;+ return {+ documents: entries+ .filter((entry) => entry.isFile() && HTML_EXTENSIONS.has(extname(entry.name).toLowerCase()))+ .map((entry) => join(entry.parentPath, entry.name)),+ folders: folderMtimes,+ settled: ![...folderMtimes.values()].some(+ (mtimeMs) => mtimeMs >= recentFrom && mtimeMs <= recentUntil,+ ),+ };+}++function folderChanged([folder, mtimeMs]: [string, number]): boolean {+ try {+ return statSync(folder).mtimeMs !== mtimeMs;+ } catch {+ return true;+ }+}++function fileIdentity(stats: Stats): string {+ return [stats.dev, stats.ino, stats.size, stats.mtimeMs].join(':');+}++function currentIdentity(file: string): string | undefined {+ try {+ return fileIdentity(statSync(file));+ } catch (err) {+ if ((err as NodeJS.ErrnoException).code === 'ENOENT') return undefined;+ throw err;+ }+}++export interface AppShellPolicyFailure {+ err: unknown;+ root: string;+ file?: string;+}++export function createAppShellPolicies(+ bundleDir: string,+ onFailure: (failure: AppShellPolicyFailure, message: string) => void,+): (served: Stats, servedPath?: string) => string | undefined {+ const root = resolve(bundleDir);+ const previewFrame = resolve(root, PREVIEW_FRAME_FILE);+ let listing: BundleListing | undefined;+ const policies = new Map<string, { mtimeMs: number; policy: string }>();++ function currentListing(): BundleListing {+ if (listing === undefined || !listing.settled || [...listing.folders].some(folderChanged)) {+ listing = listBundle(root);+ }+ return listing;+ }++ function servedDocument(served: Stats): string | undefined {+ const identity = fileIdentity(served);+ const matches = currentListing().documents.filter((file) => currentIdentity(file) === identity);+ if (matches.length > 1) {+ throw new Error(`the served file matches more than one document: ${matches.join(', ')}`);+ }+ return matches[0];+ }++ function documentPolicy(file: string, mtimeMs: number): string {+ const cached = policies.get(file);+ if (cached?.mtimeMs === mtimeMs) return cached.policy;+ try {+ const policy = appShellContentSecurityPolicy(readFileSync(file, 'utf8'));+ policies.set(file, { mtimeMs, policy });+ return policy;+ } catch (err) {+ onFailure(+ { err, root, file },+ 'could not read an app shell document; serving it with a policy that allows no inline script',+ );+ return NO_INLINE_SCRIPT_POLICY;+ }+ }++ return (served, servedPath) => {+ let file: string | undefined;+ try {+ file = servedDocument(served);+ } catch (err) {+ onFailure(+ { err, root, file: servedPath },+ 'could not identify the app shell file being served; sending a policy that allows no inline script',+ );+ return NO_INLINE_SCRIPT_POLICY;+ }+ if (file === undefined) return undefined;+ return file === previewFrame ? PREVIEW_FRAME_CSP : documentPolicy(file, served.mtimeMs);+ };+}diff --git a/packages/core/src/server.ts b/packages/core/src/server.tsindex c9f1d9355..f3bebd7a9 100644--- a/packages/core/src/server.ts+++ b/packages/core/src/server.ts@@ -1,3 +1,4 @@+export { type AppShellPolicyFailure, createAppShellPolicies } from './app-shell-csp.ts';export {type CollectConfigDiagnosticsOptions,collectConfigDiagnostics,diff --git a/packages/desktop/src/main/index.ts b/packages/desktop/src/main/index.tsindex 7865d377a..cd1f53804 100644--- a/packages/desktop/src/main/index.ts+++ b/packages/desktop/src/main/index.ts@@ -440,6 +440,7 @@ import {} from './reduced-transparency-handler.ts';import { removeGitFolder } from './remove-git-folder.ts';import { attachRendererConsoleCapture } from './renderer-console-capture.ts';+import { installRendererFileProtocol } from './renderer-file-protocol.ts';import { createRendererReadySink, type RendererReadySink } from './renderer-ready-sink.ts';import { createRendererRecovery, type RendererRecovery } from './renderer-recovery.ts';import { resolveDetachedSpawnArgs } from './resolve-detached-spawn-args.ts';@@ -1357,11 +1358,13 @@ function readPositiveIntEnv(envVar: string): number | undefined {return parsed;}+function rendererRoot(): string {+ return app.isPackaged ? join(process.resourcesPath, 'app') : join(__dirname, '../renderer');+}+function ensureWindowManager() {if (wm) return;- const rendererEntryPath = app.isPackaged- ? join(process.resourcesPath, 'app', 'index.html')- : join(__dirname, '../renderer/index.html');+ const rendererEntryPath = join(rendererRoot(), 'index.html');const utilityEntryPath = join(__dirname, 'utility/server-entry.js');const bundleCliMjsPath = app.isPackaged@@ -1688,9 +1691,7 @@ function openNavigator(pendingPayload?: ShareNavigatorPayload) {attachSpellcheckMenuToWindow(win);return win as unknown as BrowserWindowLike;},- rendererEntryPath: app.isPackaged- ? join(process.resourcesPath, 'app', 'index.html')- : join(__dirname, '../renderer/index.html'),+ rendererEntryPath: join(rendererRoot(), 'index.html'),rendererDevUrl,appVersion: app.getVersion(),productName: DESKTOP_VARIANT.productName,@@ -3273,9 +3274,7 @@ function openTerminalWindow(): void {terminal: focused ? getTerminalWindowContext(focused.id) : undefined,note: focused ? getNoteWindowContext(focused.id) : undefined,});- const rendererEntryPath = app.isPackaged- ? join(process.resourcesPath, 'app', 'index.html')- : join(__dirname, '../renderer/index.html');+ const rendererEntryPath = join(rendererRoot(), 'index.html');createTerminalWindow({createWindow: (opts) => {const win = new BrowserWindow({@@ -3401,9 +3400,7 @@ function openNoteWindowForDoc(args: {});if (!project) return { ok: false, reason: 'no-project' };- const rendererEntryPath = app.isPackaged- ? join(process.resourcesPath, 'app', 'index.html')- : join(__dirname, '../renderer/index.html');+ const rendererEntryPath = join(rendererRoot(), 'index.html');const nativeChrome = noteWindowNativeChromeOptions(process.platform);const result = openNoteWindow({@@ -6542,6 +6539,7 @@ function bootPrimaryInstance(): void {.whenReady().then(async () => {startupWaterfall.mark('appReady');+ installRendererFileProtocol(session.defaultSession.protocol, rendererRoot());startupWaterfall.otelEnabled = beginRoot();desktopProcessObservability?.start();logBootAccessibilityPosture();diff --git a/packages/desktop/src/main/renderer-file-protocol.ts b/packages/desktop/src/main/renderer-file-protocol.tsnew file mode 100644index 000000000..49b8bb059--- /dev/null+++ b/packages/desktop/src/main/renderer-file-protocol.ts@@ -0,0 +1,74 @@+import type { Stats } from 'node:fs';+import { stat } from 'node:fs/promises';+import { resolve, sep } from 'node:path';+import { fileURLToPath } from 'node:url';+import { createAppShellPolicies } from '@inkeep/open-knowledge-core/server';+import { net, type Protocol } from 'electron';+import { getLogger } from './desktop-logger.ts';++const MAX_REMEMBERED_WARNINGS = 256;++function causeOf(err: unknown): string {+ if (err === undefined) return '';+ return err instanceof Error ? err.message : String(err);+}++export function installRendererFileProtocol(protocol: Protocol, rendererRoot: string): void {+ const root = resolve(rendererRoot);+ const log = getLogger('renderer-file-protocol');+ const warned = new Set<string>();++ function warnOnce(key: string, context: Record<string, unknown>, message: string): void {+ if (warned.has(key)) return;+ if (warned.size >= MAX_REMEMBERED_WARNINGS) warned.clear();+ warned.add(key);+ log.warn({ root, ...context }, message);+ }++ const policyFor = createAppShellPolicies(root, ({ err, file }, message) =>+ warnOnce([message, file ?? '', causeOf(err)].join('\u0000'), { err, file }, message),+ );++ function refuse(status: number, target: string, reason: string, err?: unknown): Response {+ warnOnce(+ [reason, target, causeOf(err)].join('\u0000'),+ { err, target, reason },+ 'refused a renderer file request',+ );+ return new Response(null, { status });+ }++ protocol.handle('file', async (request) => {+ let file: string;+ try {+ file = resolve(fileURLToPath(request.url));+ } catch (err) {+ return refuse(400, request.url, 'not a file path', err);+ }+ if (!file.startsWith(root + sep)) return refuse(404, file, 'outside the renderer bundle');+ let served: Stats;+ try {+ served = await stat(file);+ } catch (err) {+ if ((err as NodeJS.ErrnoException).code === 'ENOENT')+ return refuse(404, file, 'no such file');+ return refuse(500, file, 'could not stat the file', err);+ }+ if (served.isDirectory()) return refuse(404, file, 'a folder');+ let response: Response;+ try {+ response = await net.fetch(request, { bypassCustomProtocolHandlers: true });+ } catch (err) {+ return refuse(500, file, 'could not load the file', err);+ }+ const policy = response.ok ? policyFor(served, file) : undefined;+ if (policy === undefined) return response;+ const headers = new Headers(response.headers);+ headers.set('Content-Security-Policy', policy);+ return new Response(response.body, {+ status: response.status,+ statusText: response.statusText,+ headers,+ });+ });+}diff --git a/packages/desktop/tests/smoke/_helpers/platform-gate.ts b/packages/desktop/tests/smoke/_helpers/platform-gate.tsindex ce86fed16..0d72b0e30 100644--- a/packages/desktop/tests/smoke/_helpers/platform-gate.ts+++ b/packages/desktop/tests/smoke/_helpers/platform-gate.ts@@ -38,6 +38,7 @@ export const SPEC_PLATFORM_GATES = {'okf-rule-toggle.e2e.ts': ['!DARWIN'],'qa-create-new-extended.e2e.ts': ['!PLATFORM_SUPPORTED'],'rename-divergence-probe.e2e.ts': ['!PLATFORM_SUPPORTED'],+ 'renderer-file-protocol.e2e.ts': ['!DARWIN'],'report-bug.e2e.ts': ['!PLATFORM_SUPPORTED'],'saved-theme-paint.e2e.ts': ['!PLATFORM_SUPPORTED'],'share-receive-miss-terminal.e2e.ts': ['!PLATFORM_SUPPORTED'],diff --git a/packages/desktop/tests/smoke/renderer-file-protocol.e2e.ts b/packages/desktop/tests/smoke/renderer-file-protocol.e2e.tsnew file mode 100644index 000000000..474485f5b--- /dev/null+++ b/packages/desktop/tests/smoke/renderer-file-protocol.e2e.ts@@ -0,0 +1,125 @@+import { existsSync, mkdirSync, mkdtempSync, writeFileSync } from 'node:fs';+import { tmpdir } from 'node:os';+import { dirname, join, resolve } from 'node:path';+import { setTimeout as wait } from 'node:timers/promises';+import { fileURLToPath, pathToFileURL } from 'node:url';+import type { ElectronApplication, Page } from '@playwright/test';+import { launchDesktopInHome } from './_helpers/launch-in-home';+import { expect, test } from './_helpers/smoke-test';++const __dirname = dirname(fileURLToPath(import.meta.url));+const MAIN_ENTRY = resolve(__dirname, '..', '..', 'out', 'main', 'index.js');++const SMOKE_ENABLED = process.env.OK_DESKTOP_E2E_SMOKE === '1';+const DARWIN = process.platform === 'darwin';+const BUILD_EXISTS = existsSync(MAIN_ENTRY);++async function projectWindow(app: ElectronApplication, docName: string): Promise<Page> {+ for (let attempt = 0; attempt < 60; attempt++) {+ for (const page of app.windows()) {+ const hash = await page.evaluate(() => window.location.hash).catch(() => '');+ if (hash.includes(docName)) return page;+ }+ await wait(500);+ }+ throw new Error('project window never mounted from the argv deep-link');+}++test.describe('renderer file protocol', () => {+ test.skip(!SMOKE_ENABLED, 'Set OK_DESKTOP_E2E_SMOKE=1 to run Electron smoke tests.');+ test.skip(!DARWIN, 'Deep-link project open is macOS-only in v0.');+ test.skip(!BUILD_EXISTS, `Main build missing at ${MAIN_ENTRY} — run "pnpm run build:desktop".`);++ test('the renderer refuses injected handlers and files outside its bundle, and previews still run', async ({+ captureStderrFor,+ }) => {+ const tmpHome = mkdtempSync(join(tmpdir(), 'ok-file-protocol-home-'));+ const projectDir = mkdtempSync(join(tmpdir(), 'ok-file-protocol-'));+ mkdirSync(join(projectDir, '.ok'), { recursive: true });+ writeFileSync(+ join(projectDir, '.ok', 'config.yml'),+ "content:\n dir: '.'\n include: ['**/*.md']\n exclude: []\n",+ );+ writeFileSync(+ join(projectDir, 'note.md'),+ [+ '# Note',+ '',+ '```html preview',+ '<div id="probe">before</div>',+ "<script>document.getElementById('probe').textContent = 'ran';</script>",+ '```',+ '',+ ].join('\n'),+ );+ const outsideFile = join(projectDir, 'outside.html');+ writeFileSync(outsideFile, '<!doctype html><p id="outside">outside</p>');++ const userDataDir = join(tmpHome, 'electron-userdata');+ mkdirSync(userDataDir, { recursive: true });+ const deepLink = `openknowledge://open?project=${encodeURIComponent(projectDir)}&doc=note`;++ const app = await launchDesktopInHome(tmpHome, {+ args: [MAIN_ENTRY, deepLink, `--user-data-dir=${userDataDir}`],+ timeout: 30_000,+ });+ captureStderrFor(app, { cleanupDirs: [projectDir, tmpHome] });+ await app.firstWindow({ timeout: 15_000 });+ const page = await projectWindow(app, 'note');++ await expect(page.locator('iframe[title="HTML preview"]')).toBeVisible({ timeout: 30_000 });+ await expect(page.frameLocator('iframe[title="HTML preview"]').locator('#probe')).toHaveText(+ 'ran',+ );++ const handler = await page.evaluate(+ () =>+ new Promise<{ ran: boolean; directive: string }>((settle) => {+ const probe = window as Window & { injectedHandlerRan?: boolean };+ const timer = setTimeout(+ () => settle({ ran: Boolean(probe.injectedHandlerRan), directive: '' }),+ 5_000,+ );+ document.addEventListener(+ 'securitypolicyviolation',+ (event) => {+ clearTimeout(timer);+ settle({+ ran: Boolean(probe.injectedHandlerRan),+ directive: event.effectiveDirective,+ });+ },+ { once: true },+ );+ const host = document.createElement('div');+ host.innerHTML = '<img src="data:," alt="" onerror="window.injectedHandlerRan = true">';+ document.body.append(host);+ }),+ );+ expect(handler.ran).toBe(false);+ expect(handler.directive).toMatch(/^script-src/);++ const outside = await page.evaluate(async (url) => {+ try {+ const response = await fetch(url);+ return `status ${response.status}`;+ } catch {+ return 'refused';+ }+ }, pathToFileURL(outsideFile).href);+ expect(outside).not.toBe('status 200');++ const upperCaseShell = await page.evaluate(async () => {+ const url = new URL(window.location.href);+ url.hash = '';+ url.pathname = url.pathname.replace(/index\.html$/, 'INDEX.HTML');+ const response = await fetch(url);+ return {+ status: response.status,+ policy: response.headers.get('content-security-policy') ?? '',+ };+ });+ expect(upperCaseShell.status).toBe(200);+ expect(upperCaseShell.policy).toMatch(/^script-src 'self'/);+ });+});diff --git a/packages/server/src/http/shell-csp.ts b/packages/server/src/http/shell-csp.tsindex cdff40f02..1a5870a9e 100644--- a/packages/server/src/http/shell-csp.ts+++ b/packages/server/src/http/shell-csp.ts@@ -1,144 +1,14 @@-import { createHash } from 'node:crypto';-import { readdirSync, readFileSync, type Stats, statSync } from 'node:fs';+import type { Stats } from 'node:fs';import type { ServerResponse } from 'node:http';-import { extname, join, resolve } from 'node:path';+import { createAppShellPolicies } from '@inkeep/open-knowledge-core/server';import { getLogger } from '../logger.ts';-// WARN: packages/app ships this page as public/assets/preview-frame.html and loads it from preview-iframe-header.ts; keep the paths in step.-const PREVIEW_FRAME_FILE = join('assets', 'preview-frame.html');--const PREVIEW_FRAME_CSP = "sandbox allow-scripts; frame-ancestors 'self'";--const INLINE_SCRIPT = /<script(?![^>]*\ssrc\s*=)[^>]*>([\s\S]*?)<\/script>/gi;--function inlineScriptHashes(html: string): string[] {- return [...html.matchAll(INLINE_SCRIPT)].map(- (match) =>- `'sha256-${createHash('sha256')- .update(match[1] ?? '')- .digest('base64')}'`,- );-}--function shellContentSecurityPolicy(scriptHashes: readonly string[]): string {- return [- ["script-src 'self' 'unsafe-eval' 'wasm-unsafe-eval'", ...scriptHashes].join(' '),- "worker-src 'self' blob:",- "object-src 'none'",- "base-uri 'self'",- ].join('; ');-}--const NO_INLINE_SCRIPT_POLICY = shellContentSecurityPolicy([]);--const HTML_EXTENSIONS = new Set(['.html', '.htm']);--const RECENT_CHANGE_MS = 2_000;--interface DistListing {- documents: string[];- folders: Map<string, number>;- settled: boolean;-}--function listDist(root: string): DistListing {- const listedAt = Date.now();- const entries = readdirSync(root, { recursive: true, withFileTypes: true });- const folders = [- root,- ...entries- .filter((entry) => entry.isDirectory())- .map((entry) => join(entry.parentPath, entry.name)),- ];- const folderMtimes = new Map(folders.map((folder) => [folder, statSync(folder).mtimeMs]));- const recentFrom = listedAt - RECENT_CHANGE_MS;- const recentUntil = Date.now() + RECENT_CHANGE_MS;- return {- documents: entries- .filter((entry) => entry.isFile() && HTML_EXTENSIONS.has(extname(entry.name).toLowerCase()))- .map((entry) => join(entry.parentPath, entry.name)),- folders: folderMtimes,- settled: ![...folderMtimes.values()].some(- (mtimeMs) => mtimeMs >= recentFrom && mtimeMs <= recentUntil,- ),- };-}--function folderChanged([folder, mtimeMs]: [string, number]): boolean {- try {- return statSync(folder).mtimeMs !== mtimeMs;- } catch {- return true;- }-}--function fileIdentity(stats: Stats): string {- return [stats.dev, stats.ino, stats.size, stats.mtimeMs].join(':');-}--function currentIdentity(file: string): string | undefined {- try {- return fileIdentity(statSync(file));- } catch (err) {- if ((err as NodeJS.ErrnoException).code === 'ENOENT') return undefined;- throw err;- }-}-export function createShellHeaderSetter(distDir: string) {- const root = resolve(distDir);- const previewFrame = resolve(root, PREVIEW_FRAME_FILE);- let listing: DistListing | undefined;- const policies = new Map<string, { mtimeMs: number; policy: string }>();-- function currentListing(): DistListing {- if (listing === undefined || !listing.settled || [...listing.folders].some(folderChanged)) {- listing = listDist(root);- }- return listing;- }-- function servedDocument(stats: Stats): string | undefined {- const served = fileIdentity(stats);- const matches = currentListing().documents.filter((file) => currentIdentity(file) === served);- if (matches.length > 1) {- throw new Error(`the served file matches more than one document: ${matches.join(', ')}`);- }- return matches[0];- }-- function documentPolicy(file: string, mtimeMs: number): string {- const cached = policies.get(file);- if (cached?.mtimeMs === mtimeMs) return cached.policy;- try {- const policy = shellContentSecurityPolicy(inlineScriptHashes(readFileSync(file, 'utf8')));- policies.set(file, { mtimeMs, policy });- return policy;- } catch (err) {- getLogger('shell-csp').warn(- { err, file },- 'could not read an app shell document; serving it with a policy that allows no inline script',- );- return NO_INLINE_SCRIPT_POLICY;- }- }-+ const policyFor = createAppShellPolicies(distDir, ({ err, root, file }, message) =>+ getLogger('shell-csp').warn({ err, root, file }, message),+ );return (res: ServerResponse, _pathname: string, stats: Stats): void => {- let file: string | undefined;- try {- file = servedDocument(stats);- } catch (err) {- getLogger('shell-csp').warn(- { err, root },- 'could not identify the app shell file being served; sending a policy that allows no inline script',- );- res.setHeader('Content-Security-Policy', NO_INLINE_SCRIPT_POLICY);- return;- }- if (file === undefined) return;- res.setHeader(- 'Content-Security-Policy',- file === previewFrame ? PREVIEW_FRAME_CSP : documentPolicy(file, stats.mtimeMs),- );+ const policy = policyFor(stats);+ if (policy !== undefined) res.setHeader('Content-Security-Policy', policy);};}diff --git a/pnpm-lock.yaml b/pnpm-lock.yamlindex d218f1d5d..7e4ff2865 100644--- a/pnpm-lock.yaml+++ b/pnpm-lock.yaml@@ -543,11 +543,11 @@ importers:specifier: ^0.9.12version: 0.9.12([email protected])'@visimer/core':- specifier: ^1.1.2- version: 1.1.2+ specifier: ^1.1.3+ version: 1.1.3'@visimer/dom':- specifier: ^1.1.2- version: 1.1.2+ specifier: ^1.1.3+ version: 1.1.3'@xterm/addon-fit':specifier: 0.11.0version: 0.11.0@@ -6423,11 +6423,11 @@ packages:'@vimeo/[email protected]':resolution: {integrity: sha512-M8m1UAhJSb+KCWuXDLWHViwj+3YY/0ogwFquRfMHs9e9LYjXT9iB7n+sOCKwUusbiXuU2HKmXx+FEGHtYZfUSg==}- '@visimer/[email protected]':- resolution: {integrity: sha512-do8MDqlLQeDRI1fy2PUTVnzBkLrzpaq260UX1WrtE/3XtSoLge4T5oY+cvSXFyINhYiYKB9tgetkx+o14LFrjA==}+ '@visimer/[email protected]':+ resolution: {integrity: sha512-Kp0Wnb3Y7g/OpeIYEwH9Q01LPhFKDYJ3CSCpsK4XqofarVPakUaXEx55wCZ2QSC0CMxlgNlzPFdx2mByK/xvaA==}- '@visimer/[email protected]':- resolution: {integrity: sha512-Ir+Nl5vRgZA8rQwjGEQrC9ijOkdR0BmD3EjjqU/VedgK0lxleo5dKj8YIoHiocEDS1hlQwmzRZKIKg8MuV2FJw==}+ '@visimer/[email protected]':+ resolution: {integrity: sha512-mcGw+BCGznqcgaP+BZMsSGI5LQu9bj34BPIhW8ljwtNkfuNZLqXaSXwly8og9ycMbGSln7hb+l7i8Wvx17lSpg==}'@vitejs/[email protected]':resolution: {integrity: sha512-l9X/E3cDb+xY3SWzlG1MOGt2usfEHGMNIaegaUGFsLkb3RCn/k8/TOXBcab+OndDI4TBtktT8/9BwwW8Vi9KUQ==}@@ -17247,11 +17247,11 @@ snapshots:native-promise-only: 0.8.1weakmap-polyfill: 2.0.4- '@visimer/[email protected]': {}+ '@visimer/[email protected]': {}- '@visimer/[email protected]':+ '@visimer/[email protected]':dependencies:- '@visimer/core': 1.1.2+ '@visimer/core': 1.1.3'@vitejs/[email protected](@rolldown/[email protected](@babel/[email protected]([email protected]))(@babel/[email protected])([email protected])([email protected](@types/[email protected])([email protected])([email protected])([email protected])([email protected])))([email protected])([email protected](@types/[email protected])([email protected])([email protected])([email protected])([email protected]))':dependencies: