@botiverse/porthole 0.15.3 → 0.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +58 -0
- package/dist/bridge/bridge.d.ts +1 -8
- package/dist/bridge/bridge.js +0 -7
- package/dist/check/page-source.js +1 -1
- package/dist/check/page.js +1 -1
- package/dist/compile/policy.d.ts +0 -7
- package/dist/compile/policy.js +1 -10
- package/dist/config/capabilities.d.ts +8 -14
- package/dist/config/capabilities.js +4 -5
- package/dist/config/schema.d.ts +2 -13
- package/dist/config/validate.js +0 -24
- package/dist/conformance/behavior.js +26 -37
- package/dist/conformance/clipboard.js +47 -1
- package/dist/conformance/harness-source.js +1 -1
- package/dist/displays/displays.js +1 -3
- package/dist/guide/limits.js +1 -1
- package/dist/guide/runtime.js +1 -1
- package/dist/host/create-host.d.ts +1 -1
- package/dist/host/create-host.js +6 -51
- package/dist/host/door.d.ts +1 -1
- package/dist/host/locate.d.ts +1 -1
- package/dist/host/locate.js +2 -2
- package/dist/host/outcome.d.ts +5 -12
- package/dist/host/outcome.js +8 -16
- package/dist/host/types.d.ts +6 -22
- package/dist/index.d.ts +2 -4
- package/dist/index.js +2 -4
- package/dist/isolation/served.d.ts +4 -14
- package/dist/isolation/served.js +7 -28
- package/dist/isolation/types.d.ts +2 -25
- package/dist/isolation/types.js +0 -23
- package/dist/platform/focus-field.d.ts +11 -0
- package/dist/platform/focus-field.js +18 -0
- package/dist/platform/types.d.ts +6 -22
- package/dist/platform/web.js +8 -106
- package/dist/presets/presets.d.ts +0 -2
- package/dist/presets/presets.js +0 -1
- package/dist/react/frame.d.ts +0 -8
- package/dist/react/frame.js +0 -4
- package/dist/runtime/contract.d.ts +2 -2
- package/dist/runtime/contract.js +2 -2
- package/dist/runtime/types.generated.js +6 -6
- package/dist/server/files.js +7 -23
- package/dist/server/host.d.ts +1 -1
- package/dist/server/index.d.ts +1 -1
- package/dist/server/index.js +4 -6
- package/dist/server/naming.js +1 -1
- package/dist/server/server.js +28 -166
- package/dist/server/types.d.ts +7 -7
- package/dist/shell/plan.d.ts +0 -5
- package/dist/shell/plan.js +2 -4
- package/dist/shell/runtime.js +1 -268
- package/docs/ADOPTING.md +42 -138
- package/docs/ARCHITECTURE.md +0 -33
- package/docs/DECISIONS.md +115 -10
- package/docs/DESIGN.md +27 -64
- package/docs/THREAT_MODEL.md +128 -255
- package/package.json +1 -1
- package/src/bridge/bridge.ts +1 -17
- package/src/check/page.ts +1 -1
- package/src/compile/policy.ts +1 -11
- package/src/config/capabilities.ts +8 -14
- package/src/config/schema.ts +2 -13
- package/src/config/validate.ts +0 -28
- package/src/conformance/behavior.ts +50 -52
- package/src/conformance/clipboard.ts +56 -1
- package/src/displays/displays.ts +1 -3
- package/src/guide/limits.ts +1 -1
- package/src/guide/runtime.ts +1 -1
- package/src/host/create-host.ts +6 -52
- package/src/host/door.ts +1 -1
- package/src/host/locate.ts +2 -2
- package/src/host/outcome.ts +8 -21
- package/src/host/types.ts +6 -20
- package/src/index.ts +2 -4
- package/src/isolation/served.ts +6 -34
- package/src/isolation/types.ts +2 -31
- package/src/platform/focus-field.ts +18 -0
- package/src/platform/types.ts +6 -21
- package/src/platform/web.ts +8 -129
- package/src/presets/presets.ts +0 -3
- package/src/react/frame.tsx +0 -10
- package/src/runtime/contract.ts +4 -4
- package/src/runtime/types.generated.ts +6 -6
- package/src/server/files.ts +4 -19
- package/src/server/host.ts +1 -1
- package/src/server/index.ts +4 -16
- package/src/server/naming.ts +1 -1
- package/src/server/server.ts +29 -189
- package/src/server/types.ts +7 -7
- package/src/shell/plan.ts +2 -9
- package/src/shell/runtime.ts +1 -268
- package/types/runtime/v1/artifact.d.ts +2 -3
- package/types/runtime/v1/assets.d.ts +1 -1
- package/types/runtime/v1/chat.d.ts +2 -2
- package/types/runtime/v1/comments.d.ts +1 -1
- package/types/runtime/v1/downloads.d.ts +2 -2
- package/types/runtime/v1/links.d.ts +2 -2
- package/dist/platform/focus-guard.d.ts +0 -288
- package/dist/platform/focus-guard.js +0 -838
- package/dist/server/nested.d.ts +0 -66
- package/dist/server/nested.js +0 -121
- package/dist/shell/frame.d.ts +0 -28
- package/dist/shell/frame.js +0 -407
- package/src/platform/focus-guard.ts +0 -1114
- package/src/server/nested.ts +0 -157
- package/src/shell/frame.ts +0 -444
|
@@ -3,16 +3,16 @@
|
|
|
3
3
|
// contract every capability shares).
|
|
4
4
|
export const RUNTIME_TYPES: Readonly<Record<string, Readonly<Record<string, string>>>> = {
|
|
5
5
|
"1": {
|
|
6
|
-
"artifact": "// Porthole capability runtime, contract 1: artifact (this artifact itself). Declare it: { artifact: {} }.\n// Use it when the page is the record: a checklist, a plan, a document someone edits in place.\n\ninterface PortholeArtifactFile {\n readonly path: string;\n readonly size: number;\n readonly sha256: string;\n}\n\ninterface PortholeArtifactVersion {\n /** The version's id: what a publish names as its base. */\n readonly version: string;\n readonly number?: number;\n /** The page it opens at (\"index.html\"). */\n readonly entry: string;\n readonly files: readonly PortholeArtifactFile[];\n}\n\ninterface PortholeArtifactPublish {\n /** The version you read and changed (from get()). If it moved, publish rejects with conflict. */\n readonly base: string;\n /**\n * A patch on base's files, by path: text, bytes (a Blob, an ArrayBuffer, a typed array), or\n * null to remove one; files not named are kept. A page sends its whole document, as it should\n * be served. At most 255 files.\n */\n readonly files: Readonly<Record<string, string | Blob | ArrayBuffer | ArrayBufferView | null>>;\n readonly entry?: string;\n /** At most 60 characters. */\n readonly label?: string;\n /** At most 500 characters. */\n readonly note?: string;\n}\n\ninterface PortholeArtifact {\n /** The current version and its files (fetch a file by its relative path). Level: view. */\n get(): Promise<PortholeArtifactVersion>;\n /**\n * Publishes a new version of this artifact
|
|
7
|
-
"assets": "// Porthole capability runtime, contract 1: assets (the artifact's asset library). Declare it: { assets: {} }.\n// Assets live outside every version, at \"/_blob/<id>\" on the page's own origin: keep that url (or\n// the id) in your data, and show it with assets.url(id). Images, media and fonts load; scripts and\n// stylesheets only where the app lets only admins upload, and only those an admin added. Not for\n// files that version with the page: publish those with it.\n\ninterface PortholeAsset {\n /** 32 hex characters. */\n readonly id: string;\n /** \"/_blob/<id>\": use it as given. */\n readonly url: string;\n readonly name: string;\n /** Porthole's type for the name's extension. */\n readonly type: string;\n readonly size: number;\n}\n\ninterface PortholeAssets {\n /** The library, people's uploads through the page included. Level: view. */\n list(): Promise<readonly PortholeAsset[]>;\n /**\n * Adds a file (a File from an <input type=\"file\">, a Blob, bytes) under its name (a File's own,\n * or options.name): an image, media, a font, a PDF, text or data, never HTML; a script or a\n * stylesheet only where uploads are the admins'. The app may ask the person first. Level: admin,\n * unless the app lets people who interact upload.\n */\n upload(\n file: Blob | ArrayBuffer | ArrayBufferView,\n options?: { readonly name?: string },\n ): Promise<PortholeAsset>;\n /**\n * The address that loads an asset in this page now: put it in src or href when you show it.\n * Store the id (or \"/_blob/<id>\"), never this: it carries this page's access. A \"/_blob/<id>\"\n * written in the page loads too, except in some browsers' frames (Safari's); this always does.\n */\n url(id: string): string;\n /** Removes one
|
|
8
|
-
"chat": "// Porthole capability runtime, contract 1: chat. Declare it: { chat: {} }.\n\ninterface PortholeChat {\n /**\n * Sends text to the agent as the person's message (\"explain this point\")
|
|
6
|
+
"artifact": "// Porthole capability runtime, contract 1: artifact (this artifact itself). Declare it: { artifact: {} }.\n// Use it when the page is the record: a checklist, a plan, a document someone edits in place.\n\ninterface PortholeArtifactFile {\n readonly path: string;\n readonly size: number;\n readonly sha256: string;\n}\n\ninterface PortholeArtifactVersion {\n /** The version's id: what a publish names as its base. */\n readonly version: string;\n readonly number?: number;\n /** The page it opens at (\"index.html\"). */\n readonly entry: string;\n readonly files: readonly PortholeArtifactFile[];\n}\n\ninterface PortholeArtifactPublish {\n /** The version you read and changed (from get()). If it moved, publish rejects with conflict. */\n readonly base: string;\n /**\n * A patch on base's files, by path: text, bytes (a Blob, an ArrayBuffer, a typed array), or\n * null to remove one; files not named are kept. A page sends its whole document, as it should\n * be served. At most 255 files.\n */\n readonly files: Readonly<Record<string, string | Blob | ArrayBuffer | ArrayBufferView | null>>;\n readonly entry?: string;\n /** At most 60 characters. */\n readonly label?: string;\n /** At most 500 characters. */\n readonly note?: string;\n}\n\ninterface PortholeArtifact {\n /** The current version and its files (fetch a file by its relative path). Level: view. */\n get(): Promise<PortholeArtifactVersion>;\n /**\n * Publishes a new version of this artifact; the app asks the person first. The page can't\n * change what it declares. On conflict: get() again, merge, publish again. Level: admin.\n */\n publish(\n change: PortholeArtifactPublish,\n ): Promise<{ readonly version: string; readonly number?: number }>;\n}\n\ninterface PortholeCapabilities {\n artifact: PortholeArtifact;\n}\n",
|
|
7
|
+
"assets": "// Porthole capability runtime, contract 1: assets (the artifact's asset library). Declare it: { assets: {} }.\n// Assets live outside every version, at \"/_blob/<id>\" on the page's own origin: keep that url (or\n// the id) in your data, and show it with assets.url(id). Images, media and fonts load; scripts and\n// stylesheets only where the app lets only admins upload, and only those an admin added. Not for\n// files that version with the page: publish those with it.\n\ninterface PortholeAsset {\n /** 32 hex characters. */\n readonly id: string;\n /** \"/_blob/<id>\": use it as given. */\n readonly url: string;\n readonly name: string;\n /** Porthole's type for the name's extension. */\n readonly type: string;\n readonly size: number;\n}\n\ninterface PortholeAssets {\n /** The library, people's uploads through the page included. Level: view. */\n list(): Promise<readonly PortholeAsset[]>;\n /**\n * Adds a file (a File from an <input type=\"file\">, a Blob, bytes) under its name (a File's own,\n * or options.name): an image, media, a font, a PDF, text or data, never HTML; a script or a\n * stylesheet only where uploads are the admins'. The app may ask the person first. Level: admin,\n * unless the app lets people who interact upload.\n */\n upload(\n file: Blob | ArrayBuffer | ArrayBufferView,\n options?: { readonly name?: string },\n ): Promise<PortholeAsset>;\n /**\n * The address that loads an asset in this page now: put it in src or href when you show it.\n * Store the id (or \"/_blob/<id>\"), never this: it carries this page's access. A \"/_blob/<id>\"\n * written in the page loads too, except in some browsers' frames (Safari's); this always does.\n */\n url(id: string): string;\n /** Removes one; the app asks the person first. Level: admin. */\n delete(id: string): Promise<boolean>;\n}\n\ninterface PortholeCapabilities {\n assets: PortholeAssets;\n}\n",
|
|
8
|
+
"chat": "// Porthole capability runtime, contract 1: chat. Declare it: { chat: {} }.\n\ninterface PortholeChat {\n /**\n * Sends text to the agent as the person's message (\"explain this point\"); the app asks them\n * first. Resolves true if it was sent. Level: interact.\n */\n send(text: string): Promise<boolean>;\n}\n\ninterface PortholeCapabilities {\n chat: PortholeChat;\n}\n",
|
|
9
9
|
"clipboard": "// Porthole capability runtime, contract 1: clipboard. Built in: never declare it.\n\ninterface PortholeClipboard {\n /**\n * Copies text to the person's clipboard (at most 20,000 characters); the app shows them what\n * was copied. Nothing else in the page can write the clipboard. Call it from a click.\n * Resolves true if it was copied. Level: view.\n */\n copy(text: string): Promise<boolean>;\n}\n\ninterface PortholeCapabilities {\n clipboard: PortholeClipboard;\n}\n",
|
|
10
|
-
"comments": "// Porthole capability runtime, contract 1: comments. Built in: never declare it.\n\n/** Where a comment goes, in the page's own words. */\ninterface PortholeCommentAnchor {\n /** A stable name the page chose: \"slide-3\", \"refs/a.md#L12\" (at most 256 characters). */\n readonly name: string;\n /** What the app shows for it (at most 200; what a person can't see is taken out). */\n readonly label?: string;\n /** The text the comment is about (at most 2,000; what a person can't see is taken out). */\n readonly quote?: string;\n}\n\n/** How the composer opens. */\ninterface PortholeCommentOptions {\n /**\n * Text the composer starts with (at most 2,000 characters): a draft the person edits, posts\n * or discards in the app. It is never posted without them. Visible text only: new lines and\n * tabs are fine (at most 32 blanks in a row, two blank lines in a row), and so are U+200C and\n * U+200D between two letters or marks (Persian, the Indic scripts); a draft with zero-width\n * characters, a joiner anywhere else (an emoji joined with U+200D too; ❤️ is fine), bidi or tag\n * characters, or a line or paragraph separator (U+2028, U+2029) is refused.\n */\n readonly draft?: string;\n}\n\ninterface PortholeComments {\n /**\n * Opens the app's comment composer at the anchor (a name alone is { name }), starting with\n * `options.draft` if given. The person writes and posts it in the app. Resolves true if the\n * composer opened, false if it didn't (the app may refuse while the person is writing).\n * Write-only: a page never reads comments.
|
|
10
|
+
"comments": "// Porthole capability runtime, contract 1: comments. Built in: never declare it.\n\n/** Where a comment goes, in the page's own words. */\ninterface PortholeCommentAnchor {\n /** A stable name the page chose: \"slide-3\", \"refs/a.md#L12\" (at most 256 characters). */\n readonly name: string;\n /** What the app shows for it (at most 200; what a person can't see is taken out). */\n readonly label?: string;\n /** The text the comment is about (at most 2,000; what a person can't see is taken out). */\n readonly quote?: string;\n}\n\n/** How the composer opens. */\ninterface PortholeCommentOptions {\n /**\n * Text the composer starts with (at most 2,000 characters): a draft the person edits, posts\n * or discards in the app. It is never posted without them. Visible text only: new lines and\n * tabs are fine (at most 32 blanks in a row, two blank lines in a row), and so are U+200C and\n * U+200D between two letters or marks (Persian, the Indic scripts); a draft with zero-width\n * characters, a joiner anywhere else (an emoji joined with U+200D too; ❤️ is fine), bidi or tag\n * characters, or a line or paragraph separator (U+2028, U+2029) is refused.\n */\n readonly draft?: string;\n}\n\ninterface PortholeComments {\n /**\n * Opens the app's comment composer at the anchor (a name alone is { name }), starting with\n * `options.draft` if given. The person writes and posts it in the app. Resolves true if the\n * composer opened, false if it didn't (the app may refuse while the person is writing).\n * Write-only: a page never reads comments. Level: view.\n */\n open(anchor: PortholeCommentAnchor | string, options?: PortholeCommentOptions): Promise<boolean>;\n}\n\ninterface PortholeCapabilities {\n comments: PortholeComments;\n}\n",
|
|
11
11
|
"context": "// Porthole capability runtime, contract 1: context. Declare it: { context: {} }.\n\ninterface PortholeContextUpdate {\n /**\n * MCP text blocks only: [{ type: \"text\", text: \"…\" }]. Visible characters only, here and in\n * structuredContent: no zero-width or bidi controls, variation selectors, tag or private-use\n * characters, or controls other than new lines and tabs (refused), but the selectors and\n * joiners inside real emoji (☀️, 👨👩👧, 1️⃣), and a joiner or non-joiner between two letters of\n * a script it shapes (Arabic, Persian, the Indic scripts, Myanmar…).\n */\n readonly content?: readonly unknown[];\n /** Plain JSON. With the text, at most 20,000 characters. */\n readonly structuredContent?: Record<string, unknown>;\n}\n\ninterface PortholeContext {\n /**\n * Tells the agent, at its next turns, what the page says the person is looking at (replaces the\n * last). The agent reads it as the page's words, unconfirmed by the person; the app shows the\n * person each update unless it says otherwise. Level: interact.\n */\n set(update: PortholeContextUpdate): Promise<unknown>;\n}\n\ninterface PortholeCapabilities {\n context: PortholeContext;\n}\n",
|
|
12
12
|
"data": "// Porthole capability runtime, contract 1: data (the app's data and tools).\n// Declare it: { data: {} }, or narrow it: { data: { resources: [\"app://tasks/*\"], tools: [\"create_task\"] } }\n// (exact names, or a prefix ending in *; absent: everything the app serves).\n\ninterface PortholeDataInfo {\n /** The first value may be the app's last copy (stale: true), with the current one right after. */\n readonly stale: boolean;\n readonly uri: string;\n}\n\ninterface PortholeData {\n /** Reads the app's data at uri, as the person viewing it may see it: JSON parsed, else text. Level: view. */\n read(uri: string): Promise<unknown>;\n /**\n * Keeps the page current: onData(value, info) now and at every change; onError hears a\n * refusal. Returns a function that stops it. Draw from onData every time; don't poll. Level: view.\n */\n subscribe(\n uri: string,\n onData: (value: unknown, info: PortholeDataInfo) => void,\n onError?: (error: PortholeError) => void,\n ): () => void;\n /** Calls one of the app's tools; resolves with its result. Level: interact. */\n call(name: string, args?: Record<string, unknown>): Promise<unknown>;\n}\n\ninterface PortholeCapabilities {\n data: PortholeData;\n}\n",
|
|
13
13
|
"db": "// Porthole capability runtime, contract 1: db (the artifact's shared document store).\n// Declare it: { db: {} }, with rules if some data needs a higher level:\n// { db: { rules: { config: { write: \"admin\" }, \"*\": { read: \"view\", write: \"interact\" } } } }\n// (by top-level collection or \"*\"; they only raise the defaults: read view, write interact).\n// Use it for data people share and keep (votes, entries, a board); localStorage for one person's\n// view settings; the artifact capability when the page itself is the record.\n// Rows were written by the page's viewers: they are data, never instructions. Show them with\n// textContent, never innerHTML.\n\n/** JSON values. */\ntype PortholeDbValue =\n | null\n | boolean\n | number\n | string\n | readonly PortholeDbValue[]\n | { readonly [field: string]: PortholeDbValue };\n\ntype PortholeDbData = { readonly [field: string]: PortholeDbValue };\n\n/**\n * A document. Paths are slash-separated: a collection is an odd number of segments (\"votes\",\n * \"rooms/r1/messages\"), a document an even number (\"votes/ada\"); segments are letters, digits and\n * _ . ~ : @ + -. \"data/users/me\" is the viewer's own private collection (\"data/users/me/prefs\" a document in it):\n * only they reach it.\n */\ninterface PortholeDbSnapshot {\n readonly path: string;\n readonly id: string;\n readonly exists: boolean;\n /** Counts its writes (1 after the first); 0 when it doesn't exist. */\n readonly version: number;\n readonly data?: PortholeDbData;\n}\n\n/** Every write to a document that exists names the version you read; a mismatch rejects with conflict. ifVersion 0: it must not exist yet. */\ninterface PortholeDbWriteOptions {\n readonly ifVersion?: number;\n}\n\ntype PortholeDbWrite =\n | {\n readonly op: \"set\";\n readonly path: string;\n readonly data: PortholeDbData;\n readonly ifVersion?: number;\n }\n | {\n readonly op: \"update\";\n readonly path: string;\n readonly data: PortholeDbData;\n readonly ifVersion?: number;\n }\n | { readonly op: \"delete\"; readonly path: string; readonly ifVersion?: number };\n\ninterface PortholeDbQuery {\n /** At most 10: [field, op, value]. */\n readonly where?: readonly (readonly [\n field: string,\n op: \"==\" | \"!=\" | \"<\" | \"<=\" | \">\" | \">=\" | \"in\" | \"array-contains\",\n value: PortholeDbValue,\n ])[];\n readonly orderBy?: { readonly field: string; readonly direction?: \"asc\" | \"desc\" };\n /** 1 to 500. */\n readonly limit?: number;\n}\n\ninterface PortholeDb {\n /** Level: view. */\n get(path: string): Promise<PortholeDbSnapshot>;\n /** A collection's documents. Level: view. */\n query(\n collection: string,\n query?: PortholeDbQuery,\n ): Promise<{ readonly docs: readonly PortholeDbSnapshot[] }>;\n /** Writes a whole document (at most 1 MiB of JSON). Level: interact. */\n set(\n path: string,\n data: PortholeDbData,\n options?: PortholeDbWriteOptions,\n ): Promise<{ readonly version: number }>;\n /** Merges fields over a document's. Level: interact. */\n update(\n path: string,\n data: PortholeDbData,\n options?: PortholeDbWriteOptions,\n ): Promise<{ readonly version: number }>;\n /** Level: interact. */\n delete(path: string, options?: PortholeDbWriteOptions): Promise<null>;\n /**\n * Up to 50 writes to different documents, all or none. Each write's new version (null for a\n * delete). Each write at its own level.\n */\n batch(\n writes: readonly PortholeDbWrite[],\n ): Promise<{ readonly versions: readonly (number | null)[] }>;\n /**\n * Follows a document (a snapshot) or a collection ({ docs }) now and at every change. Returns a\n * function that stops it. Draw from onData; don't poll. Level: view.\n */\n onSnapshot(\n path: string,\n onData: (state: PortholeDbSnapshot | { readonly docs: readonly PortholeDbSnapshot[] }) => void,\n onError?: (error: PortholeError) => void,\n ): () => void;\n}\n\ninterface PortholeCapabilities {\n db: PortholeDb;\n}\n",
|
|
14
|
-
"downloads": "// Porthole capability runtime, contract 1: downloads. Built in: never declare it.\n\n/** A file to hand the person: its name, and its text or bytes. */\ninterface PortholeDownload {\n /** A file name, no slashes: \"report.csv\". Its extension gives its type unless `type` says. */\n readonly name: string;\n readonly type?: string;\n readonly text?: string;\n readonly data?: Blob | ArrayBuffer | ArrayBufferView;\n}\n\ninterface PortholeDownloads {\n /**\n * Hands the person a file to save (<a download> and script-driven saves don't work here)
|
|
15
|
-
"links": "// Porthole capability runtime, contract 1: links. Built in: never declare it.\n\ninterface PortholeLinks {\n /**\n * Opens an http(s) link outside the page (a click on an <a href> does the same)
|
|
14
|
+
"downloads": "// Porthole capability runtime, contract 1: downloads. Built in: never declare it.\n\n/** A file to hand the person: its name, and its text or bytes. */\ninterface PortholeDownload {\n /** A file name, no slashes: \"report.csv\". Its extension gives its type unless `type` says. */\n readonly name: string;\n readonly type?: string;\n readonly text?: string;\n readonly data?: Blob | ArrayBuffer | ArrayBufferView;\n}\n\ninterface PortholeDownloads {\n /**\n * Hands the person a file to save (<a download> and script-driven saves don't work here);\n * the app asks them first. Resolves true if the download started. Level: view.\n */\n save(file: PortholeDownload): Promise<boolean>;\n}\n\ninterface PortholeCapabilities {\n downloads: PortholeDownloads;\n}\n",
|
|
15
|
+
"links": "// Porthole capability runtime, contract 1: links. Built in: never declare it.\n\ninterface PortholeLinks {\n /**\n * Opens an http(s) link outside the page (a click on an <a href> does the same); the app asks\n * the person first. Resolves true if it opened. Level: view.\n */\n open(url: string): Promise<boolean>;\n}\n\ninterface PortholeCapabilities {\n links: PortholeLinks;\n}\n",
|
|
16
16
|
"porthole": "// Porthole capability runtime, contract 1: the call contract (how a page reaches any capability).\n\n/**\n * Why a call was refused: branch on it; show `message` (a sentence for the person) where the\n * result would be. Never retry in a loop.\n * - consent_required: the person hasn't allowed it yet.\n * - denied: the person said no.\n * - rate_limited: too many calls this minute.\n * - not_allowed: not available here (some places show the page without it).\n * - failed: the app tried and couldn't.\n * - forbidden: this person may see the page but not do this (their level).\n * - conflict: what you change moved since you read it: read it again, then write.\n * - too_large: past a limit.\n */\ntype PortholeErrorCode =\n | \"consent_required\"\n | \"denied\"\n | \"rate_limited\"\n | \"not_allowed\"\n | \"failed\"\n | \"forbidden\"\n | \"conflict\"\n | \"too_large\";\n\n/** What every capability method rejects with. */\ninterface PortholeError extends Error {\n readonly code: PortholeErrorCode;\n}\n\n/** Each capability's namespace, by the name `use` takes (each capability's own file adds its own). */\ninterface PortholeCapabilities {}\n\ninterface PortholeRuntime {\n /**\n * The capability's namespace, frozen; or null when it isn't there for this page: the app\n * doesn't offer it, the page didn't declare it, or no app is showing the page (a tab, a\n * preview). The reasons are indistinguishable: draw the page without it. `use` never rejects;\n * permission problems come when you call a method (a rejected promise, `PortholeError`).\n */\n use<N extends keyof PortholeCapabilities>(name: N): Promise<PortholeCapabilities[N] | null>;\n}\n\n/** The page's one global. Nothing else is added to `window`. */\ndeclare const porthole: PortholeRuntime;\n",
|
|
17
17
|
"user": "// Porthole capability runtime, contract 1: user. Declare it: { user: {} }.\n\n/** Who is viewing, as the app says. */\ninterface PortholeUserInfo {\n /** The app's id for this person (whose data \"data/users/me\" is), or null if it gives none. */\n readonly id: string | null;\n readonly name: string | null;\n /** What they may do here: view < interact < admin < owner. */\n readonly level: \"view\" | \"interact\" | \"admin\" | \"owner\";\n}\n\ninterface PortholeUser {\n /** Level: view. */\n get(): Promise<PortholeUserInfo>;\n}\n\ninterface PortholeCapabilities {\n user: PortholeUser;\n}\n",
|
|
18
18
|
},
|
package/src/server/files.ts
CHANGED
|
@@ -12,7 +12,6 @@ import { DEFAULT_ENTRY, lookupFile, requestFilePath, type FileLookup } from "../
|
|
|
12
12
|
import { fileTypeOf } from "../files/types.ts";
|
|
13
13
|
import { isCodeAsset } from "../runtime/requests.ts";
|
|
14
14
|
import { sha256, utf8 } from "./crypto.ts";
|
|
15
|
-
import { NESTED_FILE_HEADERS, nestedFileCsp } from "./nested.ts";
|
|
16
15
|
import type { FileBody, StoredAsset, StoredFiles } from "./types.ts";
|
|
17
16
|
|
|
18
17
|
/**
|
|
@@ -260,8 +259,6 @@ export async function serveFile(serving: FileServing): Promise<Response> {
|
|
|
260
259
|
return nothing(serving, 404, method);
|
|
261
260
|
}
|
|
262
261
|
const { type, role } = fileTypeOf(found.path);
|
|
263
|
-
// A nested page (P111): in its shell's child, an opaque origin.
|
|
264
|
-
const nested = serving.compiled.config.nested === true;
|
|
265
262
|
// In a frame, the version's files are at a sealed address (P083), which their own loads of the
|
|
266
263
|
// artifact's assets carry as their `Referer` (P091): to this origin only, never another.
|
|
267
264
|
const referrer =
|
|
@@ -283,13 +280,8 @@ export async function serveFile(serving: FileServing): Promise<Response> {
|
|
|
283
280
|
// A page and a script (a worker's policy is its script's) get the page's CSP, a page with its
|
|
284
281
|
// frame's sandbox, on a tab of its own too (P099); anything else runs nothing when opened on
|
|
285
282
|
// its own.
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
// origin. Pages run their scripts, opaque; anything else runs nothing (a file's is inert already,
|
|
289
|
-
// a script's gets one too).
|
|
290
|
-
const csp = nested
|
|
291
|
-
? nestedFileCsp(role, directives)
|
|
292
|
-
: role === "file"
|
|
283
|
+
const csp =
|
|
284
|
+
role === "file"
|
|
293
285
|
? INERT_FILE_CSP
|
|
294
286
|
: role === "page"
|
|
295
287
|
? servedDocumentCsp(serving.compiled.config, directives)
|
|
@@ -309,8 +301,7 @@ export async function serveFile(serving: FileServing): Promise<Response> {
|
|
|
309
301
|
if (role === "page") {
|
|
310
302
|
// Every page of the set in the shell (P081): its hardening, its host functions, its theme.
|
|
311
303
|
const html = serving.compiled.shellDocument({
|
|
312
|
-
|
|
313
|
-
origins: nested ? [serving.origin] : serving.hostOrigins,
|
|
304
|
+
origins: serving.hostOrigins,
|
|
314
305
|
document: await textOf(body),
|
|
315
306
|
cspMeta: false,
|
|
316
307
|
...(referrer === "same-origin" ? { referrer } : {}),
|
|
@@ -350,14 +341,8 @@ export async function serveFile(serving: FileServing): Promise<Response> {
|
|
|
350
341
|
serving.pinned ? `private, max-age=${YEAR}, immutable` : "private, no-cache",
|
|
351
342
|
);
|
|
352
343
|
// Only this origin's own pages load it: no other content origin (a sibling, same-site without
|
|
353
|
-
// the public suffix list) can embed it with the viewer's cookie.
|
|
354
|
-
// opaque, and its files carry their access in their path, never a cookie (P111).
|
|
344
|
+
// the public suffix list) can embed it with the viewer's cookie.
|
|
355
345
|
headers.set("cross-origin-resource-policy", "same-origin");
|
|
356
|
-
if (nested) {
|
|
357
|
-
for (const [name, value] of Object.entries(NESTED_FILE_HEADERS)) {
|
|
358
|
-
headers.set(name, value);
|
|
359
|
-
}
|
|
360
|
-
}
|
|
361
346
|
headers.set("accept-ranges", "bytes");
|
|
362
347
|
if (role === "file" && type === "application/octet-stream") {
|
|
363
348
|
headers.set("content-disposition", "attachment");
|
package/src/server/host.ts
CHANGED
|
@@ -113,7 +113,7 @@ export interface ContentHostOptions<V> {
|
|
|
113
113
|
/**
|
|
114
114
|
* Origins of an outer page that frame the app itself (P141): each may be an ancestor of every frame
|
|
115
115
|
* the app shows, above an app origin's page, so it is in every `frame-ancestors` Porthole sends
|
|
116
|
-
* (content,
|
|
116
|
+
* (content, doors, status and entry pages, the authorize route's pages) after
|
|
117
117
|
* `appOrigins`, and nowhere else. Never an origin a frame hears or tells, never an app origin for
|
|
118
118
|
* redirect entry or the handoff; the app's own page must still be the frame's parent. Exact https
|
|
119
119
|
* origins (`http://` on loopback), none an app origin, none the content domain's site. The app's
|
package/src/server/index.ts
CHANGED
|
@@ -70,27 +70,15 @@ export {
|
|
|
70
70
|
type D1StatementLike,
|
|
71
71
|
} from "./tickets.ts";
|
|
72
72
|
export { DOOR_PATH, FRAME_STATUS_METHOD } from "../isolation/types.ts";
|
|
73
|
-
// A served display's door (P125): `/server` serves it for a shell, a page
|
|
73
|
+
// A served display's door (P125): `/server` serves it for a shell, a page and the
|
|
74
74
|
// sandbox proxy; a content Worker of a host's own answers the same at `DOOR_PATH<key>`, after
|
|
75
75
|
// taking the door's own ticket (`TicketRecord.door`) and running the checks its content's address
|
|
76
76
|
// runs (docs/ADOPTING.md, "The door"). A host that signs its own tickets answers it with
|
|
77
77
|
// `PortholeServer.doorAnswer` once it has admitted the request itself (P126).
|
|
78
78
|
export { doorResponse, doorStatusResponse, type DoorOptions } from "./pages.ts";
|
|
79
|
-
//
|
|
80
|
-
//
|
|
81
|
-
|
|
82
|
-
// pages").
|
|
83
|
-
export {
|
|
84
|
-
isNestedLabel,
|
|
85
|
-
NESTED_FILE_HEADERS,
|
|
86
|
-
NESTED_FILES_PREFIX,
|
|
87
|
-
nestedAncestors,
|
|
88
|
-
nestedFileCsp,
|
|
89
|
-
nestedLabelOf,
|
|
90
|
-
nestedShellCsp,
|
|
91
|
-
nestedShellResponse,
|
|
92
|
-
PORTHOLE_LABEL_PREFIX,
|
|
93
|
-
} from "./nested.ts";
|
|
79
|
+
// Labels that start so are Porthole's own (its health label; until 0.16.0 a nested page's shell's,
|
|
80
|
+
// P114): no host's naming makes one.
|
|
81
|
+
export { PORTHOLE_LABEL_PREFIX } from "../isolation/served.ts";
|
|
94
82
|
export { isHostLabel, prefixedName, type Naming } from "./naming.ts";
|
|
95
83
|
// The page an app serves in conformance test mode (P071).
|
|
96
84
|
export { conformancePage } from "../conformance/page.ts";
|
package/src/server/naming.ts
CHANGED
|
@@ -42,7 +42,7 @@ export function prefixedName(prefix: string): Naming & {
|
|
|
42
42
|
"A name prefix is a lowercase letter, then letters or digits, then '-' (a-)",
|
|
43
43
|
);
|
|
44
44
|
}
|
|
45
|
-
// Porthole's own labels
|
|
45
|
+
// Porthole's own labels are never a scope's.
|
|
46
46
|
if (prefix === "porthole-") {
|
|
47
47
|
throw new TypeError("The name prefix porthole- is Porthole's own: choose another (a-)");
|
|
48
48
|
}
|
package/src/server/server.ts
CHANGED
|
@@ -28,15 +28,8 @@ import {
|
|
|
28
28
|
tabOnlyPage,
|
|
29
29
|
} from "./pages.ts";
|
|
30
30
|
import { libraryFile } from "./libraries.ts";
|
|
31
|
-
import {
|
|
32
|
-
import {
|
|
33
|
-
isNestedLabel,
|
|
34
|
-
nestedAncestors,
|
|
35
|
-
nestedLabelOf,
|
|
36
|
-
nestedFileCsp,
|
|
37
|
-
nestedShellResponse,
|
|
38
|
-
PORTHOLE_LABEL_PREFIX,
|
|
39
|
-
} from "./nested.ts";
|
|
31
|
+
import { ownLoad, serveAsset, serveFile, ticketPage } from "./files.ts";
|
|
32
|
+
import { PORTHOLE_LABEL_PREFIX } from "../isolation/served.ts";
|
|
40
33
|
import { DEFAULT_ENTRY } from "../files/paths.ts";
|
|
41
34
|
import { isPagePath } from "../files/types.ts";
|
|
42
35
|
import { isPortholeCookie, setsPortholeCookie } from "./proxy.ts";
|
|
@@ -95,10 +88,8 @@ const BASE = /^\/(?:(?!\.{1,2}\/)[A-Za-z0-9._:~-]{1,200}\/){0,16}$/u;
|
|
|
95
88
|
const ENTER_PATH = "/__porthole/enter";
|
|
96
89
|
/** Where a redirect entry's code is redeemed, before its clean address (P068). */
|
|
97
90
|
const ENTRY_PATH = "/__porthole/entry";
|
|
98
|
-
/** How long a nested page's ticket from its clean address to its shell's label lasts (P114). */
|
|
99
|
-
const HOP_SECONDS = 60;
|
|
100
91
|
/**
|
|
101
|
-
* A path below a file set's base, as a
|
|
92
|
+
* A path below a file set's base, as a ticket carries it (a page of a set, P125): a relative path of URL path
|
|
102
93
|
* characters, no empty segment but a last one, no dot segment (encoded or not), no query.
|
|
103
94
|
*/
|
|
104
95
|
const isPageRest = (rest: unknown): rest is string =>
|
|
@@ -373,32 +364,13 @@ export function createServer(options: ServerOptions): PortholeServer {
|
|
|
373
364
|
}
|
|
374
365
|
return label;
|
|
375
366
|
};
|
|
376
|
-
/**
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
* Every other display of the scope runs agent-made content on the scope's origin with
|
|
380
|
-
* `allow-same-origin`: on that origin, the shell's realm (its word to the host, the page's
|
|
381
|
-
* sealed address) would be theirs.
|
|
382
|
-
*/
|
|
383
|
-
const labelFor = (instance: InstanceRef): string => {
|
|
384
|
-
const label = nameOf(instance.scope);
|
|
385
|
-
if (instance.document.kind !== "artifact" || compiledFor(instance)?.config.nested !== true) {
|
|
386
|
-
return label;
|
|
387
|
-
}
|
|
388
|
-
const own = nestedLabelOf(label);
|
|
389
|
-
if (isReserved(own)) {
|
|
390
|
-
throw new TypeError(
|
|
391
|
-
`content.reserved holds ${own}, a nested page's shell's label: reserve no ${PORTHOLE_LABEL_PREFIX} label`,
|
|
392
|
-
);
|
|
393
|
-
}
|
|
394
|
-
return own;
|
|
395
|
-
};
|
|
396
|
-
/** Whether a request's label may be one this server named (a nested page's shell's, P114). */
|
|
367
|
+
/** The label an instance is served on: its scope's. */
|
|
368
|
+
const labelFor = (instance: InstanceRef): string => nameOf(instance.scope);
|
|
369
|
+
/** Whether a request's label may be one this server named: never one of Porthole's own. */
|
|
397
370
|
const ours = (label: string): boolean =>
|
|
398
371
|
!isReserved(label) &&
|
|
399
|
-
(
|
|
400
|
-
|
|
401
|
-
(content.name === undefined ? LABEL.test(label) : isHostLabel(label))));
|
|
372
|
+
!label.startsWith(PORTHOLE_LABEL_PREFIX) &&
|
|
373
|
+
(content.name === undefined ? LABEL.test(label) : isHostLabel(label));
|
|
402
374
|
const secure = content.scheme === "https";
|
|
403
375
|
const defaultPort = secure ? 443 : 80;
|
|
404
376
|
const portPart =
|
|
@@ -408,7 +380,6 @@ export function createServer(options: ServerOptions): PortholeServer {
|
|
|
408
380
|
const contentSource = `${content.scheme}://*.${domain}${portPart}`;
|
|
409
381
|
const sampleHost = `${keys.label("")}.${domain}`;
|
|
410
382
|
const sampleOrigin = originOfLabel(keys.label(""));
|
|
411
|
-
const sampleNestedOrigin = originOfLabel(nestedLabelOf(keys.label("")));
|
|
412
383
|
const authorize = options.authorize;
|
|
413
384
|
const authorizeTtl = authorize?.ttlSeconds ?? 0;
|
|
414
385
|
if (!Number.isInteger(authorizeTtl) || authorizeTtl < 0 || authorizeTtl > 300) {
|
|
@@ -618,13 +589,7 @@ export function createServer(options: ServerOptions): PortholeServer {
|
|
|
618
589
|
`The config ${JSON.stringify(name)} (${config.mode}, ${config.isolation}) can't serve a ${kind}: it needs ${MODES[kind].join(" or ")} mode with domain isolation`,
|
|
619
590
|
);
|
|
620
591
|
}
|
|
621
|
-
|
|
622
|
-
const samples = config.nested === true ? [sampleOrigin, sampleNestedOrigin] : [sampleOrigin];
|
|
623
|
-
if (
|
|
624
|
-
!samples.every((sample) =>
|
|
625
|
-
config.contentOrigins.some((source) => originMatchesSource(sample, source)),
|
|
626
|
-
)
|
|
627
|
-
) {
|
|
592
|
+
if (!config.contentOrigins.some((source) => originMatchesSource(sampleOrigin, source))) {
|
|
628
593
|
throw new TypeError(
|
|
629
594
|
`The config ${JSON.stringify(name)}'s contentOrigins don't include this server's (${contentSource})`,
|
|
630
595
|
);
|
|
@@ -679,8 +644,6 @@ export function createServer(options: ServerOptions): PortholeServer {
|
|
|
679
644
|
): Promise<
|
|
680
645
|
| {
|
|
681
646
|
readonly html: string;
|
|
682
|
-
/** An artifact's own page, before the shell (a nested page's is made apart, P111). */
|
|
683
|
-
readonly document?: string;
|
|
684
647
|
readonly compiled: CompiledConfig;
|
|
685
648
|
/** Whether its CSP opens its artifact's asset library (P089): an artifact's page. */
|
|
686
649
|
readonly assets: boolean;
|
|
@@ -715,7 +678,6 @@ export function createServer(options: ServerOptions): PortholeServer {
|
|
|
715
678
|
}
|
|
716
679
|
return {
|
|
717
680
|
html: config.shellDocument({ origins, document: stored.html, cspMeta: false }),
|
|
718
|
-
document: stored.html,
|
|
719
681
|
compiled: config,
|
|
720
682
|
assets: true,
|
|
721
683
|
};
|
|
@@ -977,8 +939,8 @@ export function createServer(options: ServerOptions): PortholeServer {
|
|
|
977
939
|
}
|
|
978
940
|
|
|
979
941
|
/**
|
|
980
|
-
* A taken ticket, if it is good for `label`'s origin: its instance's own
|
|
981
|
-
*
|
|
942
|
+
* A taken ticket, if it is good for `label`'s origin: its instance's own, or for an entry code
|
|
943
|
+
* (`entry`) its scope's, where a clean address is.
|
|
982
944
|
*/
|
|
983
945
|
async function take(
|
|
984
946
|
ticket: string | null,
|
|
@@ -1149,23 +1111,20 @@ export function createServer(options: ServerOptions): PortholeServer {
|
|
|
1149
1111
|
true,
|
|
1150
1112
|
);
|
|
1151
1113
|
}
|
|
1152
|
-
// In a nested page's frame (P111) its shell frames it and hears it, on this origin; a
|
|
1153
|
-
// config without nesting never frames this address but at the host.
|
|
1154
1114
|
return statusPage(
|
|
1155
1115
|
401,
|
|
1156
1116
|
"This has ended",
|
|
1157
1117
|
"Content here opens for a while. Open it again from the app that showed it.",
|
|
1158
|
-
|
|
1118
|
+
frameAncestors,
|
|
1159
1119
|
method,
|
|
1160
1120
|
"session",
|
|
1161
|
-
|
|
1121
|
+
options.hostOrigins,
|
|
1162
1122
|
);
|
|
1163
1123
|
}
|
|
1164
1124
|
// An asset of this artifact's library, at the frame's own sealed address (P091): every engine
|
|
1165
1125
|
// sends a frame's path, where some send no Referer that names it.
|
|
1166
1126
|
const blob = SEALED_ASSET.exec(rest)?.[1];
|
|
1167
1127
|
if (blob !== undefined) {
|
|
1168
|
-
// A nested page loads no assets (its config refuses them): none on its shell's label (P114).
|
|
1169
1128
|
const none = () =>
|
|
1170
1129
|
page(
|
|
1171
1130
|
404,
|
|
@@ -1176,7 +1135,7 @@ export function createServer(options: ServerOptions): PortholeServer {
|
|
|
1176
1135
|
undefined,
|
|
1177
1136
|
access.embed === true,
|
|
1178
1137
|
);
|
|
1179
|
-
if (options.assets === undefined
|
|
1138
|
+
if (options.assets === undefined) {
|
|
1180
1139
|
return none();
|
|
1181
1140
|
}
|
|
1182
1141
|
return (await assetFor(request, label, access, blob)) ?? none();
|
|
@@ -1270,7 +1229,7 @@ export function createServer(options: ServerOptions): PortholeServer {
|
|
|
1270
1229
|
"session",
|
|
1271
1230
|
);
|
|
1272
1231
|
}
|
|
1273
|
-
//
|
|
1232
|
+
// The page below its base the ticket was issued for (a page of a set, P125).
|
|
1274
1233
|
const asked = cookie === null ? undefined : record?.page;
|
|
1275
1234
|
const rest = isPageRest(asked) ? asked : undefined;
|
|
1276
1235
|
return serveAccess(request, access, cookie, undefined, rest);
|
|
@@ -1290,8 +1249,7 @@ export function createServer(options: ServerOptions): PortholeServer {
|
|
|
1290
1249
|
/**
|
|
1291
1250
|
* A served display's door (P125): its own ticket's, taken once, for this instance on this
|
|
1292
1251
|
* origin; then the door's answer for that ticket's grant (`answerDoor`, the one `doorAnswer`
|
|
1293
|
-
* gives, P126). No other ticket opens it
|
|
1294
|
-
* (`serveShellLabel`).
|
|
1252
|
+
* gives, P126). No other ticket opens it.
|
|
1295
1253
|
*/
|
|
1296
1254
|
async function serveDoor(
|
|
1297
1255
|
request: Request,
|
|
@@ -1312,8 +1270,7 @@ export function createServer(options: ServerOptions): PortholeServer {
|
|
|
1312
1270
|
record.embed === true ||
|
|
1313
1271
|
record.entry !== undefined ||
|
|
1314
1272
|
record.instance.document.kind === "external" ||
|
|
1315
|
-
keys.instanceKey(record.instance) !== key
|
|
1316
|
-
compiledFor(record.instance)?.config.nested === true
|
|
1273
|
+
keys.instanceKey(record.instance) !== key
|
|
1317
1274
|
) {
|
|
1318
1275
|
return doorSays(401, "session", method);
|
|
1319
1276
|
}
|
|
@@ -1382,7 +1339,7 @@ export function createServer(options: ServerOptions): PortholeServer {
|
|
|
1382
1339
|
access: Access,
|
|
1383
1340
|
cookie: string | null,
|
|
1384
1341
|
at?: FilesAt,
|
|
1385
|
-
/**
|
|
1342
|
+
/** The page below its files' base its ticket was issued for (a page of a set, P125). */
|
|
1386
1343
|
pageAt?: string,
|
|
1387
1344
|
): Promise<Response> {
|
|
1388
1345
|
const method = request.method.toUpperCase();
|
|
@@ -1420,55 +1377,8 @@ export function createServer(options: ServerOptions): PortholeServer {
|
|
|
1420
1377
|
) {
|
|
1421
1378
|
return missing();
|
|
1422
1379
|
}
|
|
1423
|
-
//
|
|
1424
|
-
|
|
1425
|
-
// that address, below the sealed prefix, answers the page and its files, without a cookie.
|
|
1426
|
-
const nested = served.compiled.config.nested === true;
|
|
1427
|
-
const sealedAt = at !== undefined && at.base.startsWith(FILES_PREFIX);
|
|
1428
|
-
if (nested && !sealedAt) {
|
|
1429
|
-
if (!isNavigation(request)) {
|
|
1430
|
-
return page(404, "Not found", "This page's files are at its own address.", method);
|
|
1431
|
-
}
|
|
1432
|
-
// Its shell is served on its own label alone (P114): a clean address, entered on the scope's
|
|
1433
|
-
// label (P068), goes there with a one-time ticket of its own, for what is left of its session.
|
|
1434
|
-
const own = originOfLabel(labelFor(access.instance));
|
|
1435
|
-
if (access.origin !== own) {
|
|
1436
|
-
return hop(access, own, "files" in served && at !== undefined ? at.rest : "");
|
|
1437
|
-
}
|
|
1438
|
-
const sealed = await sealFiles(access);
|
|
1439
|
-
let rest = "";
|
|
1440
|
-
if ("files" in served) {
|
|
1441
|
-
const entry = served.files.entry ?? DEFAULT_ENTRY;
|
|
1442
|
-
rest =
|
|
1443
|
-
pageAt !== undefined
|
|
1444
|
-
? pageAt
|
|
1445
|
-
: at !== undefined && at.rest !== ""
|
|
1446
|
-
? at.rest
|
|
1447
|
-
: entry.includes("/")
|
|
1448
|
-
? entry
|
|
1449
|
-
.split("/")
|
|
1450
|
-
.map((segment) => encodeURIComponent(segment))
|
|
1451
|
-
.join("/")
|
|
1452
|
-
: "";
|
|
1453
|
-
}
|
|
1454
|
-
const shell = nestedShellResponse(served.compiled, {
|
|
1455
|
-
origin: access.origin,
|
|
1456
|
-
origins: options.hostOrigins,
|
|
1457
|
-
framedBy,
|
|
1458
|
-
page: `${access.origin}${sealed.base}${rest}`,
|
|
1459
|
-
renew: { url: `${access.origin}${sealed.base}__porthole/renew`, expires: sealed.expires },
|
|
1460
|
-
method,
|
|
1461
|
-
});
|
|
1462
|
-
if (cookie !== null) {
|
|
1463
|
-
shell.headers.set("set-cookie", cookie);
|
|
1464
|
-
}
|
|
1465
|
-
return shell;
|
|
1466
|
-
}
|
|
1467
|
-
// Below the sealed prefix, a nested page and its files are framed by its shell too. An embed
|
|
1468
|
-
// session is never nested (`issue`): its answers are framed by any page (P143).
|
|
1469
|
-
const ancestors = nested
|
|
1470
|
-
? nestedAncestors(access.origin, frameAncestors)
|
|
1471
|
-
: ancestorsFor(access);
|
|
1380
|
+
// An embed session's answers are framed by any page (P143).
|
|
1381
|
+
const ancestors = ancestorsFor(access);
|
|
1472
1382
|
// Whom its pages hear and tell: the host origins, or no one for an embed session (P143).
|
|
1473
1383
|
const hostOrigins = embed ? [] : options.hostOrigins;
|
|
1474
1384
|
if ("files" in served) {
|
|
@@ -1523,55 +1433,14 @@ export function createServer(options: ServerOptions): PortholeServer {
|
|
|
1523
1433
|
? assetCspDirectives(config, cspDirectives, access.origin)
|
|
1524
1434
|
: cspDirectives;
|
|
1525
1435
|
const headers = documentHeaders(
|
|
1526
|
-
|
|
1436
|
+
servedDocumentCsp(config, directives),
|
|
1527
1437
|
servedPermissionsPolicy(config),
|
|
1528
1438
|
ancestors,
|
|
1529
1439
|
);
|
|
1530
1440
|
if (cookie !== null) {
|
|
1531
1441
|
headers.set("set-cookie", cookie);
|
|
1532
1442
|
}
|
|
1533
|
-
|
|
1534
|
-
const html = nested
|
|
1535
|
-
? served.compiled.shellDocument({
|
|
1536
|
-
origins: [access.origin],
|
|
1537
|
-
document: served.document ?? "",
|
|
1538
|
-
cspMeta: false,
|
|
1539
|
-
})
|
|
1540
|
-
: served.html;
|
|
1541
|
-
return new Response(method === "HEAD" ? null : html, { status: 200, headers });
|
|
1542
|
-
}
|
|
1543
|
-
|
|
1544
|
-
/**
|
|
1545
|
-
* A nested page entered at its clean address (P114), whose shell is never served there: on to the
|
|
1546
|
-
* shell's own label, with a one-time ticket for the same access (its viewer, its subject, what is
|
|
1547
|
-
* left of its session) and the path below its base it was entered at. Only this server's own
|
|
1548
|
-
* answer carries the ticket, as `issue`'s frame address does; the host's check already let the
|
|
1549
|
-
* request in.
|
|
1550
|
-
*/
|
|
1551
|
-
async function hop(access: Access, own: string, rest: string): Promise<Response> {
|
|
1552
|
-
const now = Date.now();
|
|
1553
|
-
const ticket = newTicket();
|
|
1554
|
-
await tickets.put(ticketId(ticket), {
|
|
1555
|
-
instance: access.instance,
|
|
1556
|
-
viewer: access.viewer,
|
|
1557
|
-
expiresAt: now + HOP_SECONDS * 1_000,
|
|
1558
|
-
sessionSeconds: Math.min(
|
|
1559
|
-
MAX_SESSION_SECONDS,
|
|
1560
|
-
Math.max(1, Math.floor((access.expiresAt - now) / 1_000)),
|
|
1561
|
-
),
|
|
1562
|
-
...(access.anonymous === true ? { anonymous: true } : {}),
|
|
1563
|
-
...(access.subject === undefined ? {} : { subject: access.subject }),
|
|
1564
|
-
...(isPageRest(rest) ? { page: rest } : {}),
|
|
1565
|
-
});
|
|
1566
|
-
return new Response(null, {
|
|
1567
|
-
status: 303,
|
|
1568
|
-
headers: {
|
|
1569
|
-
location: `${own}${PREFIX}d/${keys.instanceKey(access.instance)}?ticket=${ticket}`,
|
|
1570
|
-
"cache-control": "no-store",
|
|
1571
|
-
"referrer-policy": "no-referrer",
|
|
1572
|
-
"x-robots-tag": "noindex, nofollow",
|
|
1573
|
-
},
|
|
1574
|
-
});
|
|
1443
|
+
return new Response(method === "HEAD" ? null : served.html, { status: 200, headers });
|
|
1575
1444
|
}
|
|
1576
1445
|
|
|
1577
1446
|
/**
|
|
@@ -2035,29 +1904,6 @@ export function createServer(options: ServerOptions): PortholeServer {
|
|
|
2035
1904
|
}
|
|
2036
1905
|
}
|
|
2037
1906
|
|
|
2038
|
-
/**
|
|
2039
|
-
* A nested page's shell's own label (P114): Porthole's shell at a frame's address, its page and
|
|
2040
|
-
* that page's files below the sealed prefix, and Porthole's status pages (and their script).
|
|
2041
|
-
* Nothing else: no clean address, entry, asset, library or app, so no agent-made content ever
|
|
2042
|
-
* runs on this origin with it (every file below the prefix carries a sandbox without it).
|
|
2043
|
-
*/
|
|
2044
|
-
async function serveShellLabel(request: Request, url: URL, label: string): Promise<Response> {
|
|
2045
|
-
const method = request.method.toUpperCase();
|
|
2046
|
-
const script = pageScript(url.pathname);
|
|
2047
|
-
if (script !== null) {
|
|
2048
|
-
return script;
|
|
2049
|
-
}
|
|
2050
|
-
const document = DOCUMENT_PATH.exec(url.pathname);
|
|
2051
|
-
if (document?.[1] !== undefined) {
|
|
2052
|
-
return serveDocument(request, url, label, document[1]);
|
|
2053
|
-
}
|
|
2054
|
-
const sealed = FILES_PATH.exec(url.pathname);
|
|
2055
|
-
if (sealed?.[1] !== undefined) {
|
|
2056
|
-
return serveSealed(request, url, label, sealed[1], sealed[2]);
|
|
2057
|
-
}
|
|
2058
|
-
return page(404, "Nothing here", "This address names no content.", method);
|
|
2059
|
-
}
|
|
2060
|
-
|
|
2061
1907
|
/** A grant, checked for an instance (`issue`'s rules, and `doorAnswer`'s, P126). */
|
|
2062
1908
|
function checkGrant(
|
|
2063
1909
|
clean: InstanceRef,
|
|
@@ -2066,7 +1912,7 @@ export function createServer(options: ServerOptions): PortholeServer {
|
|
|
2066
1912
|
const anonymous = grant.anonymous === true;
|
|
2067
1913
|
// An embedded document (P143): a public page with no host, which any page may frame. Only
|
|
2068
1914
|
// where the host opted in, and only as narrow as that: anonymous, no level, no user, an
|
|
2069
|
-
// artifact's page
|
|
1915
|
+
// artifact's page.
|
|
2070
1916
|
// Read as given: a host's grant is checked here, not trusted to its type.
|
|
2071
1917
|
const asked: unknown = grant.embed;
|
|
2072
1918
|
const embed = asked !== undefined;
|
|
@@ -2084,9 +1930,9 @@ export function createServer(options: ServerOptions): PortholeServer {
|
|
|
2084
1930
|
"An embed grant is anonymous, with no viewer, level or user: it has no host to give them to (P143)",
|
|
2085
1931
|
);
|
|
2086
1932
|
}
|
|
2087
|
-
if (clean.document.kind !== "artifact"
|
|
1933
|
+
if (clean.document.kind !== "artifact") {
|
|
2088
1934
|
throw new TypeError(
|
|
2089
|
-
"An embed grant opens an artifact's page
|
|
1935
|
+
"An embed grant opens an artifact's page: never a url-mode app, a served shell or the sandbox proxy (P143)",
|
|
2090
1936
|
);
|
|
2091
1937
|
}
|
|
2092
1938
|
}
|
|
@@ -2182,11 +2028,11 @@ export function createServer(options: ServerOptions): PortholeServer {
|
|
|
2182
2028
|
|
|
2183
2029
|
/**
|
|
2184
2030
|
* Whether an instance's frame has a door (P125): a document framed on its scope's origin, where
|
|
2185
|
-
* the scope's other displays run content (a served shell, a page
|
|
2186
|
-
*
|
|
2031
|
+
* the scope's other displays run content (a served shell, a page, the sandbox proxy). A
|
|
2032
|
+
* url-mode app has none.
|
|
2187
2033
|
*/
|
|
2188
2034
|
function hasDoor(instance: InstanceRef): boolean {
|
|
2189
|
-
return instance.document.kind !== "external"
|
|
2035
|
+
return instance.document.kind !== "external";
|
|
2190
2036
|
}
|
|
2191
2037
|
|
|
2192
2038
|
const underDomain = (host: string): boolean => host === domain || host.endsWith(`.${domain}`);
|
|
@@ -2250,7 +2096,6 @@ export function createServer(options: ServerOptions): PortholeServer {
|
|
|
2250
2096
|
);
|
|
2251
2097
|
}
|
|
2252
2098
|
const { clean, key, ticket, door } = await mint(instance, grant, undefined, below);
|
|
2253
|
-
// A nested page's frame is its shell, on the shell's own label (P114).
|
|
2254
2099
|
const origin = originOfLabel(labelFor(clean));
|
|
2255
2100
|
const path =
|
|
2256
2101
|
clean.document.kind === "external"
|
|
@@ -2274,9 +2119,7 @@ export function createServer(options: ServerOptions): PortholeServer {
|
|
|
2274
2119
|
const clean = cleanInstance(instance);
|
|
2275
2120
|
check(clean);
|
|
2276
2121
|
if (!hasDoor(clean)) {
|
|
2277
|
-
throw new TypeError(
|
|
2278
|
-
"This instance has no door (P125): a nested page's frame is its shell, a url-mode app has none",
|
|
2279
|
-
);
|
|
2122
|
+
throw new TypeError("This instance has no door (P125): a url-mode app has none");
|
|
2280
2123
|
}
|
|
2281
2124
|
const below = at.page;
|
|
2282
2125
|
if (below !== undefined && (!isPageRest(below) || clean.document.kind !== "artifact")) {
|
|
@@ -2435,9 +2278,6 @@ export function createServer(options: ServerOptions): PortholeServer {
|
|
|
2435
2278
|
if (!ours(label)) {
|
|
2436
2279
|
return page(404, "Nothing here", "This address names no content.", method);
|
|
2437
2280
|
}
|
|
2438
|
-
if (isNestedLabel(label)) {
|
|
2439
|
-
return await serveShellLabel(request, url, label);
|
|
2440
|
-
}
|
|
2441
2281
|
if (url.pathname === ENTER_PATH) {
|
|
2442
2282
|
return await enter(request, url, label);
|
|
2443
2283
|
}
|
package/src/server/types.ts
CHANGED
|
@@ -80,8 +80,8 @@ export type Grant = (
|
|
|
80
80
|
/**
|
|
81
81
|
* An embedded document (P143): a public page that any site may frame, with no host. Only where
|
|
82
82
|
* the server opted in (`ServerOptions.embeds`), only with `anonymous: true` and no `level` or
|
|
83
|
-
* `user`, and only for an artifact's page
|
|
84
|
-
*
|
|
83
|
+
* `user`, and only for an artifact's page (never a url-mode app, a served shell or the sandbox
|
|
84
|
+
* proxy); anything else throws at `issue`. Carried signed in the
|
|
85
85
|
* session (and in a frame's sealed files' address), so it is never added to a session or taken
|
|
86
86
|
* from one. Every answer of such a session says `frame-ancestors *` (no other session's changes),
|
|
87
87
|
* its shell's plan names no host (it asks no host, hears none and tells no parent anything; the
|
|
@@ -113,14 +113,14 @@ export interface TicketRecord {
|
|
|
113
113
|
readonly pinned?: boolean;
|
|
114
114
|
};
|
|
115
115
|
/**
|
|
116
|
-
*
|
|
117
|
-
*
|
|
116
|
+
* The page below its files' base the ticket was issued for (a page of a set, P125): the entry
|
|
117
|
+
* page when absent.
|
|
118
118
|
*/
|
|
119
119
|
readonly page?: string;
|
|
120
120
|
/**
|
|
121
121
|
* A door's ticket (P125): `issue` mints one beside the content's, for the same grant and as
|
|
122
|
-
* long, for a display whose frame is on its scope's origin (a served shell, a page
|
|
123
|
-
*
|
|
122
|
+
* long, for a display whose frame is on its scope's origin (a served shell, a page, the sandbox
|
|
123
|
+
* proxy). Taken only at the door (`/__porthole/door/<key>`), never at the
|
|
124
124
|
* content's address; the door takes no other.
|
|
125
125
|
*/
|
|
126
126
|
readonly door?: true;
|
|
@@ -396,7 +396,7 @@ export interface PortholeServer {
|
|
|
396
396
|
* is what `authorize.check` is handed (and gives the method: HEAD has no body, a method other
|
|
397
397
|
* than GET or HEAD is 405); default, a GET of the door on the instance's origin. Throws, as
|
|
398
398
|
* `issue` does, for an instance or grant `issue` would refuse, and for an instance with no door
|
|
399
|
-
* (a
|
|
399
|
+
* (a url-mode app).
|
|
400
400
|
*/
|
|
401
401
|
doorAnswer(
|
|
402
402
|
instance: InstanceRef,
|