The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
harden host event listener access across membrane (#81036)
Jakub Chodorowicz7eba2629f29e
diff --git a/e2e/test/scenarios/visualizations-charts/custom-viz.cy.spec.ts b/e2e/test/scenarios/visualizations-charts/custom-viz.cy.spec.tsindex bbbc1bf9029..7b4adaf0d04 100644--- a/e2e/test/scenarios/visualizations-charts/custom-viz.cy.spec.ts+++ b/e2e/test/scenarios/visualizations-charts/custom-viz.cy.spec.ts@@ -1801,6 +1801,18 @@ describe("sandbox", () => {/addEventListener for global event type: storage/,),},+ {+ // The `on*` IDL setters reach the same global event types as+ // addEventListener, so they are gated on the property path too.+ name: "document.onkeydown setter",+ payload: "document.onkeydown = function () {};",+ errorPattern: blockedPattern(/API call: Document\.set onkeydown/),+ },+ {+ name: "document.onpaste setter",+ payload: "document.onpaste = function () {};",+ errorPattern: blockedPattern(/API call: Document\.set onpaste/),+ },{name: 'setAttribute("onclick", ...)',payload: 'document.body.setAttribute("onclick", "alert(1)");',diff --git a/frontend/src/metabase/utils/scripts-sandbox/distortions-blocked-apis.ts b/frontend/src/metabase/utils/scripts-sandbox/distortions-blocked-apis.tsindex f54f5010ec2..db1e22c21c2 100644--- a/frontend/src/metabase/utils/scripts-sandbox/distortions-blocked-apis.ts+++ b/frontend/src/metabase/utils/scripts-sandbox/distortions-blocked-apis.ts@@ -1,3 +1,5 @@+import { GLOBAL_BLOCKED_EVENT_TYPES } from "./distortions-event";+export const BLOCKED_NATIVE_REFS = new Map<object, string>();const method = (proto: object, key: string): object | undefined =>@@ -103,6 +105,13 @@ if (window.CookieStore) {block(method(window.CookieStore.prototype, "delete"), "CookieStore.delete");}+// Global event-handler IDL setters — the property-path twin of the `addEventListener` block.+for (const eventType of GLOBAL_BLOCKED_EVENT_TYPES) {+ const handler = `on${eventType}`;+ block(setter(Document.prototype, handler), `Document.set ${handler}`);+ block(setter(Window.prototype, handler), `Window.set ${handler}`);+}+// Referrer — URL of the page that linked here, which can leak internal// admin URLs or embed-link query params. Unlike `location.href`, the// sandboxed script has no other way to read this.diff --git a/frontend/src/metabase/utils/scripts-sandbox/distortions-event.ts b/frontend/src/metabase/utils/scripts-sandbox/distortions-event.tsindex 133d9cf9b03..9dc4873ec9a 100644--- a/frontend/src/metabase/utils/scripts-sandbox/distortions-event.ts+++ b/frontend/src/metabase/utils/scripts-sandbox/distortions-event.ts@@ -5,7 +5,7 @@ export const ADD_EVENT_LISTENER = EventTarget.prototype.addEventListener;// legitimate reason for it to listen for typed text or clipboard activity// outside its own subtree — listening on script-owned elements still// works, and that's where the script's own UI events live.-const GLOBAL_BLOCKED_EVENT_TYPES = new Set([+export const GLOBAL_BLOCKED_EVENT_TYPES = new Set(["keydown","keyup","keypress",diff --git a/frontend/src/metabase/utils/scripts-sandbox/distortions-event.unit.spec.ts b/frontend/src/metabase/utils/scripts-sandbox/distortions-event.unit.spec.tsnew file mode 100644index 00000000000..f3c4692aab7--- /dev/null+++ b/frontend/src/metabase/utils/scripts-sandbox/distortions-event.unit.spec.ts@@ -0,0 +1,69 @@+import { makeSandboxDistortionCallback } from "./distortions";+import { GLOBAL_BLOCKED_EVENT_TYPES } from "./distortions-event";++const setterOf = (proto: object, key: string) =>+ Object.getOwnPropertyDescriptor(proto, key)?.set;++const GLOBAL_TARGETS = [+ { name: "Document", proto: Document.prototype },+ { name: "Window", proto: Window.prototype },+];++describe("scripts-sandbox global event-handler setter distortions", () => {+ it("distorts addEventListener('keydown') on document (reference boundary)", () => {+ const distort = makeSandboxDistortionCallback("plugin 1");+ const addEventListener = distort(EventTarget.prototype.addEventListener);++ expect(() =>+ addEventListener.call(document, "keydown", () => {}, true),+ ).toThrow(/blocked addEventListener for global event type: keydown/);+ });++ it("distorts the Document.cookie setter (reference boundary)", () => {+ const distort = makeSandboxDistortionCallback("plugin 1");+ const cookieSetter = setterOf(Document.prototype, "cookie");+ if (!cookieSetter) {+ throw new Error("expected a Document.cookie setter");+ }++ expect(distort(cookieSetter)).not.toBe(cookieSetter);+ });++ it("distorts every on* setter that mirrors a blocked global event type", () => {+ const distort = makeSandboxDistortionCallback("plugin 1");++ // filter out the event types that don't have an on* setter in this environment+ const results = [...GLOBAL_BLOCKED_EVENT_TYPES].flatMap((type) =>+ GLOBAL_TARGETS.flatMap(({ name, proto }) => {+ const setter = setterOf(proto, `on${type}`);+ // filter out the event types that don't have an on* setter in this environment+ return setter+ ? [+ {+ label: `${name}.on${type}`,+ distorted: distort(setter) !== setter,+ },+ ]+ : [];+ }),+ );++ const undistorted = results.filter((r) => !r.distorted).map((r) => r.label);+ expect(undistorted).toEqual([]);+ // make sure that at least some setter in the env were found+ expect(results.length).toBeGreaterThan(0);+ });++ it("replaces the Document.onkeydown setter with a distortion that refuses the assignment", () => {+ const distort = makeSandboxDistortionCallback("plugin 1");+ const onkeydownSetter = setterOf(Document.prototype, "onkeydown");+ if (!onkeydownSetter) {+ throw new Error("expected a Document.onkeydown setter");+ }++ const distorted = distort(onkeydownSetter);+ expect(distorted).not.toBe(onkeydownSetter);++ expect(() => distorted.call(document, () => {})).toThrow();+ });+});diff --git a/frontend/src/metabase/utils/scripts-sandbox/distortions.ts b/frontend/src/metabase/utils/scripts-sandbox/distortions.tsindex f5ca4457688..821cd8522eb 100644--- a/frontend/src/metabase/utils/scripts-sandbox/distortions.ts+++ b/frontend/src/metabase/utils/scripts-sandbox/distortions.ts@@ -179,10 +179,12 @@ export function makeSandboxDistortionCallback(return value;};- return function distortionCallback(value: object): object {+ return function distortionCallback<T extends object>(value: T): T {if (typeof value !== "function") {if (isHostStorageInstance(value)) {- return makeBlockedStorageDecoy(errorPrefix);+ // The decoy impersonates the host storage instance it replaces, so+ // assert it as `T` for the caller.+ return makeBlockedStorageDecoy(errorPrefix) as T;}return value;@@ -191,7 +193,9 @@ export function makeSandboxDistortionCallback(const distorted = resolveDistortion(value);// Only wrap when we actually distorted `value`; pass-through values are- // returned untouched so we never log on a non-blocked call.- return distorted === value ? value : reportThrows(distorted);+ // returned untouched so we never log on a non-blocked call. `resolveDistortion`+ // erases the type to `object`, but the distortion has `value`'s call+ // signature, so restore `T` for the caller.+ return (distorted === value ? value : reportThrows(distorted)) as T;};}