From b4acc1a1da9b36e9e0e35e73e47697d6a59ed1ff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miguel=20=C3=81ngel?= Date: Tue, 17 Nov 2026 12:36:14 +0000 Subject: [PATCH] fix(studio-server): a project file is never served as a service worker's script (#8064) --- .../cli/src/utils/compositionServer.test.ts | 16 +++++++ packages/cli/src/utils/compositionServer.ts | 3 +- .../utils/staticProjectServer.host.test.ts | 23 ++++++++++ packages/cli/src/utils/staticProjectServer.ts | 12 ++++- packages/studio-server/src/createStudioApi.ts | 2 + .../src/helpers/serviceWorkerScripts.ts | 18 ++++++++ packages/studio-server/src/index.ts | 4 ++ .../src/routes/preview.serviceWorker.test.ts | 46 +++++++++++++++++++ 8 files changed, 121 insertions(+), 3 deletions(-) create mode 100644 packages/studio-server/src/helpers/serviceWorkerScripts.ts create mode 100644 packages/studio-server/src/routes/preview.serviceWorker.test.ts diff --git a/packages/cli/src/utils/compositionServer.test.ts b/packages/cli/src/utils/compositionServer.test.ts index 876a437e1a..05a8845bc5 100644 --- a/packages/cli/src/utils/compositionServer.test.ts +++ b/packages/cli/src/utils/compositionServer.test.ts @@ -6,6 +6,7 @@ import { Hono } from "hono"; import { buildRangeResponse, refuseUnknownHosts, + sandboxForAnotherSite, scriptsAfterWorkersDropped, } from "./compositionServer.js"; @@ -115,3 +116,18 @@ describe("scriptsAfterWorkersDropped", () => { expect(html.indexOf("")).toBe(html.length - "".length); }); }); + +describe("sandboxForAnotherSite", () => { + it("refuses a file under its path as a service worker's script, and serves it otherwise", async () => { + const app = new Hono(); + sandboxForAnotherSite(app, "/composition/*"); + app.get("/composition/*", (c) => c.text("self.onfetch = () => {};")); + const get = (headers: Record) => + app.request("/composition/worker.js", { + headers: { "sec-fetch-site": "same-origin", ...headers }, + }); + expect((await get({ "service-worker": "script" })).status).toBe(403); + expect((await get({ "sec-fetch-dest": "serviceworker" })).status).toBe(403); + expect((await get({ "sec-fetch-dest": "script" })).status).toBe(200); + }); +}); diff --git a/packages/cli/src/utils/compositionServer.ts b/packages/cli/src/utils/compositionServer.ts index 8f83a17d4f..4736a9fe54 100644 --- a/packages/cli/src/utils/compositionServer.ts +++ b/packages/cli/src/utils/compositionServer.ts @@ -6,7 +6,7 @@ import { createReadStream, existsSync, readFileSync, statSync } from "node:fs"; import { resolve, dirname } from "node:path"; import { Readable } from "node:stream"; import { fileURLToPath } from "node:url"; -import { getMimeType, openRangeEnd } from "@hyperframes/studio-server"; +import { getMimeType, openRangeEnd, refuseServiceWorkerScripts } from "@hyperframes/studio-server"; import { stripSdrPngColourTags } from "@hyperframes/core/compiler/png-colour-tags"; import { injectTagsAtHeadStart } from "@hyperframes/core/compiler/html-document"; import { @@ -233,6 +233,7 @@ async function markDocumentForAnotherSite(c: Context): Promise { /** Files under `path` that another site loads come back sandboxed, and documents marked so their runtime offers that site no editing port. */ export function sandboxForAnotherSite(app: Hono, path: string): void { + app.use(path, refuseServiceWorkerScripts); app.use(path, async function sandboxAnotherSiteLoad(c, next) { const anotherSite = documentFromAnotherSite({ fetchSite: c.req.header("sec-fetch-site"), diff --git a/packages/cli/src/utils/staticProjectServer.host.test.ts b/packages/cli/src/utils/staticProjectServer.host.test.ts index 761ba5e3fb..47e7f8d24a 100644 --- a/packages/cli/src/utils/staticProjectServer.host.test.ts +++ b/packages/cli/src/utils/staticProjectServer.host.test.ts @@ -72,4 +72,27 @@ describe("serveStaticProjectHtml Host and framing", () => { expect(page.headers["content-security-policy"]).toBe("frame-ancestors 'self'"); expect(page.headers["x-frame-options"]).toBe("SAMEORIGIN"); }); + + it("refuses a project file asked for as a service worker's script, and serves it as a script", async () => { + const { port } = await serve(); + writeFileSync(join(projectDir, "worker.js"), "self.onfetch = () => {};"); + const ask = (dest: string, worker?: string) => + new Promise((done, fail) => { + const headers = { + host: `127.0.0.1:${port}`, + "sec-fetch-site": "same-origin", + "sec-fetch-dest": dest, + ...(worker && { "service-worker": worker }), + }; + const req = request({ hostname: "127.0.0.1", port, path: "/worker.js", headers }, (res) => { + res.resume(); + done(res.statusCode ?? 0); + }); + req.on("error", fail); + req.end(); + }); + expect(await ask("serviceworker", "script")).toBe(403); + expect(await ask("serviceworker")).toBe(403); + expect(await ask("script")).toBe(200); + }); }); diff --git a/packages/cli/src/utils/staticProjectServer.ts b/packages/cli/src/utils/staticProjectServer.ts index a6888e7b54..2bdb2d987a 100644 --- a/packages/cli/src/utils/staticProjectServer.ts +++ b/packages/cli/src/utils/staticProjectServer.ts @@ -18,7 +18,11 @@ import { type PreviewProxyBox, } from "@hyperframes/core"; import { getMimeType } from "@hyperframes/core/studio-api"; -import { decodeWellFormedEscapes, openRangeEnd } from "@hyperframes/studio-server"; +import { + decodeWellFormedEscapes, + openRangeEnd, + serviceWorkerScriptFetch, +} from "@hyperframes/studio-server"; import { documentFromAnotherSite, requestFromAnotherSite, @@ -367,7 +371,11 @@ export async function serveStaticProjectHtml( // fallow-ignore-next-line complexity const server = createServer((req, res) => { res.setHeader("X-Content-Type-Options", "nosniff"); - if (!answersHost(req.headers.host)) { + const workerScript = serviceWorkerScriptFetch({ + serviceWorker: req.headers["service-worker"] as string | undefined, + fetchDest: req.headers["sec-fetch-dest"] as string | undefined, + }); + if (!answersHost(req.headers.host) || workerScript) { res.writeHead(403, { "Content-Type": "text/plain" }); res.end("Forbidden"); return; diff --git a/packages/studio-server/src/createStudioApi.ts b/packages/studio-server/src/createStudioApi.ts index c7b2448915..259a215f9b 100644 --- a/packages/studio-server/src/createStudioApi.ts +++ b/packages/studio-server/src/createStudioApi.ts @@ -33,6 +33,7 @@ import { requestHost, sameOriginPost, } from "./helpers/requestIdentity.js"; +import { refuseServiceWorkerScripts } from "./helpers/serviceWorkerScripts.js"; import { previewErrorPage } from "./helpers/previewErrorPage.js"; import type { CaptureSandboxOption } from "./helpers/captureLoads.js"; import { @@ -137,6 +138,7 @@ export interface StudioApiOptions extends CaptureSandboxOption { export function createStudioApi(adapter: StudioApiAdapter, options: StudioApiOptions = {}): Hono { const api = new Hono(); + api.use(refuseServiceWorkerScripts); const sandboxThumbnailCaptures = options.sandboxThumbnailCaptures ?? false; const frameTokens = createFrameTokens(); const resolveProjectId = (id: string) => diff --git a/packages/studio-server/src/helpers/serviceWorkerScripts.ts b/packages/studio-server/src/helpers/serviceWorkerScripts.ts new file mode 100644 index 0000000000..7aecedd6c0 --- /dev/null +++ b/packages/studio-server/src/helpers/serviceWorkerScripts.ts @@ -0,0 +1,18 @@ +import type { Context, Next } from "hono"; + +// A project file served as a worker's script would control the origin's pages after the project is gone. +export function serviceWorkerScriptFetch(headers: { + serviceWorker?: string; + fetchDest?: string; +}): boolean { + return headers.serviceWorker === "script" || headers.fetchDest === "serviceworker"; +} + +export async function refuseServiceWorkerScripts(c: Context, next: Next) { + const headers = { + serviceWorker: c.req.header("service-worker"), + fetchDest: c.req.header("sec-fetch-dest"), + }; + if (serviceWorkerScriptFetch(headers)) return c.text("Forbidden", 403); + await next(); +} diff --git a/packages/studio-server/src/index.ts b/packages/studio-server/src/index.ts index cbf23b1930..2dc7f03832 100644 --- a/packages/studio-server/src/index.ts +++ b/packages/studio-server/src/index.ts @@ -1,4 +1,8 @@ export { createStudioApi, type StudioApiOptions } from "./createStudioApi.js"; +export { + refuseServiceWorkerScripts, + serviceWorkerScriptFetch, +} from "./helpers/serviceWorkerScripts.js"; export { PREVIEW_ALLOWED_HOSTS_ENV, previewAllowedHostsFromEnv, diff --git a/packages/studio-server/src/routes/preview.serviceWorker.test.ts b/packages/studio-server/src/routes/preview.serviceWorker.test.ts new file mode 100644 index 0000000000..d6e394fa69 --- /dev/null +++ b/packages/studio-server/src/routes/preview.serviceWorker.test.ts @@ -0,0 +1,46 @@ +// @vitest-environment node +import { afterAll, describe, expect, it } from "vitest"; +import { mkdirSync, mkdtempSync, rmSync, writeFileSync } from "node:fs"; +import { tmpdir } from "node:os"; +import { join } from "node:path"; +import { createStudioApi } from "../createStudioApi"; +import type { StudioApiAdapter } from "../types"; + +const projectDir = mkdtempSync(join(tmpdir(), "hf-preview-worker-")); +writeFileSync(join(projectDir, "index.html"), '
'); +writeFileSync(join(projectDir, "worker.js"), "self.onfetch = () => {};"); +mkdirSync(join(projectDir, "comp")); +writeFileSync(join(projectDir, "comp", "worker.js"), "self.onfetch = () => {};"); +afterAll(() => rmSync(projectDir, { recursive: true, force: true })); + +const adapter: StudioApiAdapter = { + listProjects: () => [], + resolveProject: async (id: string) => ({ id, dir: projectDir }), + bundle: async () => null, + lint: async () => ({ findings: [] }), + runtimeUrl: "/api/runtime.js", + rendersDir: () => join(projectDir, "renders"), + startRender: () => ({ id: "job", status: "rendering", progress: 0, outputPath: "/tmp/out.mp4" }), +}; +const api = createStudioApi(adapter); +const get = (path: string, headers: Record) => + api.request(`http://localhost${path}`, { + headers: { "sec-fetch-site": "same-origin", ...headers }, + }); + +const paths = ["/projects/demo/preview/worker.js", "/projects/demo/preview/comp/worker.js"]; +const workerFetches = [{ "service-worker": "script" }, { "sec-fetch-dest": "serviceworker" }]; + +describe("a project file asked for as a service worker's script", () => { + it.each(paths)("is refused at %s, however the browser marks the fetch", async (path) => { + for (const headers of workerFetches) expect((await get(path, headers)).status).toBe(403); + }); + + it.each(paths)("still loads at %s as a page script, module or dedicated worker", async (path) => { + for (const dest of ["script", "worker", "empty"]) { + const res = await get(path, { "sec-fetch-dest": dest }); + expect(res.status).toBe(200); + expect(await res.text()).toContain("onfetch"); + } + }); +});