Skip to content

Open source website builder and Webflow alternative. Webstudio is an advanced visual builder that connects to any headless CMS, supports all CSS properties, and can be hosted anywhere, including with us.

feat: Add safe mode (#5612)

Oleg Isonen2a49a9f1fee2
diff --git a/apps/builder/app/builder/features/topbar/safe-mode.tsx b/apps/builder/app/builder/features/topbar/safe-mode.tsx
new file mode 100644
index 0000000000..e798a033f3
--- /dev/null
+++ b/apps/builder/app/builder/features/topbar/safe-mode.tsx
@@ -0,0 +1,58 @@
+import { useState } from "react";
+import { ShieldIcon } from "@webstudio-is/icons";
+import {
+ Popover,
+ PopoverTrigger,
+ PopoverContent,
+ theme,
+ ToolbarButton,
+ Button,
+ Text,
+ Flex,
+ rawTheme,
+} from "@webstudio-is/design-system";
+import { builderApi } from "~/shared/builder-api";
+
+export const SafeModeButton = () => {
+ const [open, setOpen] = useState(false);
+
+ if (!builderApi.isSafeMode()) {
+ return;
+ }
+
+ const handleExitSafeMode = () => {
+ const url = new URL(window.location.href);
+ url.searchParams.delete("safemode");
+ window.location.href = url.href;
+ };
+
+ return (
+ <Popover open={open} onOpenChange={setOpen}>
+ <PopoverTrigger asChild>
+ <ToolbarButton variant="subtle" tabIndex={0}>
+ <ShieldIcon stroke={rawTheme.colors.foregroundDestructive} />
+ </ToolbarButton>
+ </PopoverTrigger>
+ <PopoverContent>
+ <Flex
+ direction="column"
+ gap="2"
+ css={{
+ padding: theme.panel.padding,
+ width: theme.spacing[30],
+ }}
+ >
+ <Text variant="regularBold">Safe mode active</Text>
+ <Text>
+ Safe mode prevents all external JavaScript from executing. HTML
+ embeds will not run scripts even if "Run scripts on canvas" is
+ enabled.
+ </Text>
+ <Button color="destructive" onClick={handleExitSafeMode}>
+ Exit safe mode
+ </Button>
+ </Flex>
+ </PopoverContent>
+ </Popover>
+ );
+};
diff --git a/apps/builder/app/builder/features/topbar/topbar.tsx b/apps/builder/app/builder/features/topbar/topbar.tsx
index 237e66e089..859842e555 100644
--- a/apps/builder/app/builder/features/topbar/topbar.tsx
+++ b/apps/builder/app/builder/features/topbar/topbar.tsx
@@ -27,6 +27,7 @@ import type { ReactNode } from "react";
import { CloneButton } from "./clone";
import { $selectedPage } from "~/shared/awareness";
import { BuilderModeDropDown } from "./builder-mode";
+import { SafeModeButton } from "./safe-mode";
const PagesButton = () => {
const page = useStore($selectedPage);
@@ -106,6 +107,7 @@ export const Topbar = ({ project, css, loading }: TopbarProps) => {
width: theme.spacing[30],
}}
>
+ <SafeModeButton />
<ViewMode />
<SyncStatus />
diff --git a/apps/builder/app/canvas/canvas.tsx b/apps/builder/app/canvas/canvas.tsx
index c7016ac839..888edba39f 100644
--- a/apps/builder/app/canvas/canvas.tsx
+++ b/apps/builder/app/canvas/canvas.tsx
@@ -107,6 +107,7 @@ const handleError = (error: unknown) => {
};
const useElementsTree = (components: Components, instances: Instances) => {
+ const isSafeMode = builderApi.isSafeMode();
const page = useStore($selectedPage);
const isPreviewMode = useStore($isPreviewMode);
const breakpointsMap = useStore($breakpoints);
@@ -132,6 +133,7 @@ const useElementsTree = (components: Components, instances: Instances) => {
<ReactSdkContext.Provider
value={{
renderer: isPreviewMode ? "preview" : "canvas",
+ isSafeMode,
assetBaseUrl,
imageLoader: wsImageLoader,
videoLoader: wsVideoLoader,
@@ -152,7 +154,14 @@ const useElementsTree = (components: Components, instances: Instances) => {
})}
</ReactSdkContext.Provider>
);
- }, [instances, rootInstanceId, components, isPreviewMode, breakpoints]);
+ }, [
+ instances,
+ rootInstanceId,
+ components,
+ isPreviewMode,
+ breakpoints,
+ isSafeMode,
+ ]);
};
const DesignMode = () => {
diff --git a/apps/builder/app/dashboard/projects/project-menu.tsx b/apps/builder/app/dashboard/projects/project-menu.tsx
index 00699e1583..9b8dc96d3b 100644
--- a/apps/builder/app/dashboard/projects/project-menu.tsx
+++ b/apps/builder/app/dashboard/projects/project-menu.tsx
@@ -10,6 +10,7 @@ import {
import { EllipsesIcon } from "@webstudio-is/icons";
import type { DialogType } from "./project-dialogs";
import { useDuplicateProject } from "./project-dialogs";
+import { builderUrl } from "~/shared/router-utils";
type ProjectMenuProps = {
projectId: string;
@@ -20,6 +21,14 @@ export const ProjectMenu = ({ projectId, onOpenChange }: ProjectMenuProps) => {
const [isOpen, setIsOpen] = useState(false);
const handleDuplicateProject = useDuplicateProject(projectId);
+ const handleOpenInSafeMode = () => {
+ window.location.href = builderUrl({
+ origin: window.origin,
+ projectId,
+ safemode: true,
+ });
+ };
+
return (
<DropdownMenu open={isOpen} onOpenChange={setIsOpen}>
<DropdownMenuTrigger asChild>
@@ -41,14 +50,17 @@ export const ProjectMenu = ({ projectId, onOpenChange }: ProjectMenuProps) => {
<DropdownMenuItem onSelect={() => onOpenChange("share")}>
Share
</DropdownMenuItem>
+ <DropdownMenuItem onSelect={() => onOpenChange("delete")}>
+ Delete
+ </DropdownMenuItem>
<DropdownMenuItem onSelect={() => onOpenChange("tags")}>
Tags
</DropdownMenuItem>
<DropdownMenuItem onSelect={() => onOpenChange("settings")}>
Settings
</DropdownMenuItem>
- <DropdownMenuItem onSelect={() => onOpenChange("delete")}>
- Delete
+ <DropdownMenuItem onSelect={handleOpenInSafeMode}>
+ Open in safe mode
</DropdownMenuItem>
</DropdownMenuContent>
</DropdownMenu>
diff --git a/apps/builder/app/routes/auth.ws_.callback.ts b/apps/builder/app/routes/auth.ws_.callback.ts
index a13ce2fcd9..2922c6a0f7 100644
--- a/apps/builder/app/routes/auth.ws_.callback.ts
+++ b/apps/builder/app/routes/auth.ws_.callback.ts
@@ -26,7 +26,7 @@ export const loader: LoaderFunction = async ({ request }) => {
allowedDestinations(request, ["document"]);
// CSRF is not needed for document only routes
- const returnTo = (await returnToPath(request)) ?? builderPath({});
+ const returnTo = (await returnToPath(request)) ?? builderPath();
debug("Start exchanging the code for the access token");
diff --git a/apps/builder/app/shared/builder-api.ts b/apps/builder/app/shared/builder-api.ts
index 2d54858ea4..8317b8af8d 100644
--- a/apps/builder/app/shared/builder-api.ts
+++ b/apps/builder/app/shared/builder-api.ts
@@ -8,8 +8,16 @@ const apiWindowNamespace = "__webstudio__$__builderApi";
type ToastHandler = (message: string) => void;
+const isSafeMode = (() => {
+ if (typeof window === "undefined") {
+ return false;
+ }
+ return new URLSearchParams(window.location.search).get("safemode") === "true";
+})();
+
const _builderApi = {
isInitialized: () => true,
+ isSafeMode: () => isSafeMode,
toast: {
info: toast.info as ToastHandler,
warn: toast.warn as ToastHandler,
diff --git a/apps/builder/app/shared/pages/use-switch-page.ts b/apps/builder/app/shared/pages/use-switch-page.ts
index 96dc7e0074..e37913fdcc 100644
--- a/apps/builder/app/shared/pages/use-switch-page.ts
+++ b/apps/builder/app/shared/pages/use-switch-page.ts
@@ -90,8 +90,9 @@ export const useSyncPageUrl = () => {
const searParamsMode = isBuilderMode(searParamsModeRaw)
? searParamsModeRaw
: undefined;
+ const searchParamsSafemode = searchParams.get("safemode");
- // Do not navigate on popstate change
+ // Do not navigate on popstate change or if params match
if (
searchParamsPageId === page.id &&
searchParamsPageHash === pageHash.hash &&
@@ -106,6 +107,7 @@ export const useSyncPageUrl = () => {
authToken: $authToken.get(),
pageHash: pageHash.hash === "" ? undefined : pageHash.hash,
mode: builderMode === "design" ? undefined : builderMode,
+ safemode: searchParamsSafemode === "true",
})
);
}, [builderMode, navigate, page, pageHash]);
diff --git a/apps/builder/app/shared/router-utils/path-utils.ts b/apps/builder/app/shared/router-utils/path-utils.ts
index e7e0e19741..9606b7b842 100644
--- a/apps/builder/app/shared/router-utils/path-utils.ts
+++ b/apps/builder/app/shared/router-utils/path-utils.ts
@@ -19,17 +19,20 @@ export const builderPath = ({
authToken,
pageHash,
mode,
+ safemode = false,
}: {
pageId?: string;
authToken?: string;
pageHash?: string;
mode?: "preview" | "content";
-}) => {
+ safemode?: boolean;
+} = {}) => {
return `/${searchParams({
pageId,
authToken,
pageHash,
mode,
+ safemode: safemode ? "true" : undefined,
})}`;
};
@@ -39,11 +42,16 @@ export const builderUrl = (props: {
origin: string;
authToken?: string;
mode?: BuilderMode;
+ safemode?: boolean;
}) => {
const authServerOrigin = getAuthorizationServerOrigin(props.origin);
const url = new URL(
- builderPath({ pageId: props.pageId, authToken: props.authToken }),
+ builderPath({
+ pageId: props.pageId,
+ authToken: props.authToken,
+ safemode: props.safemode,
+ }),
authServerOrigin
);
diff --git a/packages/icons/icons/download.svg b/packages/icons/icons/download.svg
index cff86e4f9e..5c75527bde 100644
--- a/packages/icons/icons/download.svg
+++ b/packages/icons/icons/download.svg
@@ -1 +1,15 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-download-icon lucide-download"><path d="M12 15V3"/><path d="M21 15v4a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2v-4"/><path d="m7 10 5 5 5-5"/></svg>
+<svg
+ xmlns="http://www.w3.org/2000/svg"
+ width="24"
+ height="24"
+ viewBox="0 0 24 24"
+ fill="none"
+ stroke="currentColor"
+ stroke-width="2"
+ stroke-linecap="round"
+ stroke-linejoin="round"
+>
+ <path d="M12 15V3" />
+ <path d="M21 15v4a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2v-4" />
+ <path d="m7 10 5 5 5-5" />
+</svg>
diff --git a/packages/icons/icons/shield.svg b/packages/icons/icons/shield.svg
new file mode 100644
index 0000000000..0d6d20a128
--- /dev/null
+++ b/packages/icons/icons/shield.svg
@@ -0,0 +1,15 @@
+<svg
+ xmlns="http://www.w3.org/2000/svg"
+ width="16"
+ height="16"
+ viewBox="0 0 24 24"
+ fill="none"
+ stroke="currentColor"
+ stroke-width="1"
+ stroke-linecap="round"
+ stroke-linejoin="round"
+>
+ <path
+ d="M20 13c0 5-3.5 7.5-7.66 8.95a1 1 0 0 1-.67-.01C7.5 20.5 4 18 4 13V6a1 1 0 0 1 1-1c2 0 4.5-1.2 6.24-2.72a1.17 1.17 0 0 1 1.52 0C14.51 3.81 17 5 19 5a1 1 0 0 1 1 1z"
+ />
+</svg>
diff --git a/packages/icons/src/__generated__/components.tsx b/packages/icons/src/__generated__/components.tsx
index ddfff73570..b37508c3f5 100644
--- a/packages/icons/src/__generated__/components.tsx
+++ b/packages/icons/src/__generated__/components.tsx
@@ -2247,7 +2247,6 @@ export const DownloadIcon: IconComponent = forwardRef(
strokeLinecap="round"
strokeLinejoin="round"
strokeWidth="2"
- className="lucide lucide-download-icon lucide-download"
viewBox="0 0 24 24"
width={size}
height={size}
@@ -4636,6 +4635,28 @@ export const ShadowNormalIcon: IconComponent = forwardRef(
);
ShadowNormalIcon.displayName = "ShadowNormalIcon";
+export const ShieldIcon: IconComponent = forwardRef(
+ ({ fill = "none", size = 16, ...props }, forwardedRef) => {
+ return (
+ <svg
+ xmlns="http://www.w3.org/2000/svg"
+ stroke="currentColor"
+ strokeLinecap="round"
+ strokeLinejoin="round"
+ viewBox="0 0 24 24"
+ width={size}
+ height={size}
+ fill={fill}
+ {...props}
+ ref={forwardedRef}
+ >
+ <path d="M20 13c0 5-3.5 7.5-7.66 8.95a1 1 0 0 1-.67-.01C7.5 20.5 4 18 4 13V6a1 1 0 0 1 1-1c2 0 4.5-1.2 6.24-2.72a1.17 1.17 0 0 1 1.52 0C14.51 3.81 17 5 19 5a1 1 0 0 1 1 1z" />
+ </svg>
+ );
+ }
+);
+ShieldIcon.displayName = "ShieldIcon";
+
export const ShrinkIcon: IconComponent = forwardRef(
({ fill = "none", size = 16, ...props }, forwardedRef) => {
return (
diff --git a/packages/icons/src/__generated__/svg.ts b/packages/icons/src/__generated__/svg.ts
index cf0abf7eaf..e45d112c0f 100644
--- a/packages/icons/src/__generated__/svg.ts
+++ b/packages/icons/src/__generated__/svg.ts
@@ -342,6 +342,8 @@ export const ShadowInsetIcon = `<svg xmlns="http://www.w3.org/2000/svg" fill="no
export const ShadowNormalIcon = `<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 16 16" width="100%" height="100%" style="display: block;"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M8 12.327a5.5 5.5 0 1 0 0-11 5.5 5.5 0 0 0 0 11Z"/><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M15 10v0c-2.774 5.944-11.226 5.944-14 0v0"/></svg>`;
+export const ShieldIcon = `<svg xmlns="http://www.w3.org/2000/svg" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-shield-icon lucide-shield" viewBox="0 0 24 24" width="100%" height="100%" style="display: block;"><path d="M20 13c0 5-3.5 7.5-7.66 8.95a1 1 0 0 1-.67-.01C7.5 20.5 4 18 4 13V6a1 1 0 0 1 1-1c2 0 4.5-1.2 6.24-2.72a1.17 1.17 0 0 1 1.52 0C14.51 3.81 17 5 19 5a1 1 0 0 1 1 1z"/></svg>`;
+
export const ShrinkIcon = `<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 16 16" width="100%" height="100%" style="display: block;"><path fill="currentColor" fill-rule="evenodd" d="M8 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-1 0v-1A.5.5 0 0 1 8 1ZM1.333 7.5a.5.5 0 0 0 0 1h2.793L2.98 9.646a.5.5 0 0 0 .707.708l2-2a.499.499 0 0 0 .146-.351v-.006a.498.498 0 0 0-.146-.35l-2-2a.5.5 0 1 0-.707.707L4.126 7.5H1.333Zm8.834.503a.496.496 0 0 0 .146.35l2 2a.5.5 0 0 0 .707-.707L11.874 8.5h2.793a.5.5 0 1 0 0-1h-2.793l1.146-1.146a.5.5 0 1 0-.707-.708l-2 2a.498.498 0 0 0-.146.351v.006ZM8.5 5.5a.5.5 0 0 0-1 0v1a.5.5 0 0 0 1 0v-1ZM8 9a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-1 0v-1A.5.5 0 0 1 8 9Zm.5 4.5a.5.5 0 0 0-1 0v1a.5.5 0 0 0 1 0v-1Z" clip-rule="evenodd"/></svg>`;
export const SliderIcon = `<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 16 16" width="100%" height="100%" style="display: block;"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M14.015 8.265h-6M8.015 8.265h-6"/><rect width="3" height="3" x="4.026" y="6.5" fill="#fff" stroke="currentColor" rx="1.5"/></svg>`;
diff --git a/packages/react-sdk/src/context.tsx b/packages/react-sdk/src/context.tsx
index 0d76036167..4c7289e189 100644
--- a/packages/react-sdk/src/context.tsx
+++ b/packages/react-sdk/src/context.tsx
@@ -12,6 +12,12 @@ export type Params = {
* - preview is the preview mode in builder
*/
renderer?: "canvas" | "preview";
+ /**
+ * Safe mode prevents external JavaScript execution in HTML embeds.
+ * When enabled, all HTML embeds act as if "run scripts on canvas" is false,
+ * regardless of their actual settings.
+ */
+ isSafeMode?: boolean;
/**
* Base url or base path for any asset with ending slash.
* Used to load assets like fonts or images in styles
diff --git a/packages/sdk-components-react/src/html-embed.test.tsx b/packages/sdk-components-react/src/html-embed.test.tsx
index a083a9f2ab..34a551f6e9 100644
--- a/packages/sdk-components-react/src/html-embed.test.tsx
+++ b/packages/sdk-components-react/src/html-embed.test.tsx
@@ -336,4 +336,58 @@ describe("Builder renderer= canvas | preview", () => {
screen.queryByText(`Open the "Settings" panel to insert HTML code.`)
).toBeTruthy();
});
+
+ /**
+ * Test safe mode: when isSafeMode is true, scripts should never execute
+ * regardless of executeScriptOnCanvas setting or renderer mode.
+ */
+ test.each(
+ cartesian(
+ [true, false, undefined], //clientOnly
+ [true, false, undefined], //executeScriptOnCanvas
+ ["canvas", "preview"] //renderer
+ )
+ )(
+ "Safe mode prevents script execution when clientOnly=%p executeScriptOnCanvas=%p and renderer=%p",
+ async (clientOnly, executeScriptOnCanvas, renderer) => {
+ const AppWithSafeMode = () => {
+ const code = `
+ <script data-testid="${SCRIPT_TEST_ID}">console.log('hello')</script>
+ <div data-testid="${FRAGMENT_DIV_ID}">hello</div>
+ `;
+
+ return (
+ <ReactSdkContext.Provider
+ value={{
+ assetBaseUrl: "",
+ imageLoader: () => "",
+ renderer: renderer as "canvas" | "preview",
+ isSafeMode: true,
+ resources: {},
+ breakpoints: [],
+ onError: console.error,
+ }}
+ >
+ <HtmlEmbed
+ code={code}
+ clientOnly={clientOnly}
+ executeScriptOnCanvas={executeScriptOnCanvas}
+ />
+ </ReactSdkContext.Provider>
+ );
+ };
+
+ const ui = <AppWithSafeMode />;
+ const container = document.createElement("div");
+ document.body.appendChild(container);
+
+ render(ui, { container });
+ await Promise.resolve();
+
+ // In safe mode, scripts should not be processed (no SCRIPT_PROCESSED_TEST_ID)
+ expect(screen.queryByTestId(SCRIPT_TEST_ID)).toBeTruthy();
+ expect(screen.queryByTestId(SCRIPT_PROCESSED_TEST_ID)).not.toBeTruthy();
+ expect(screen.queryByTestId(FRAGMENT_DIV_ID)).toBeTruthy();
+ }
+ );
});
diff --git a/packages/sdk-components-react/src/html-embed.tsx b/packages/sdk-components-react/src/html-embed.tsx
index 9327d7db16..e6c9eb3a1c 100644
--- a/packages/sdk-components-react/src/html-embed.tsx
+++ b/packages/sdk-components-react/src/html-embed.tsx
@@ -224,7 +224,7 @@ export const HtmlEmbed = forwardRef<HTMLDivElement, HtmlEmbedProps>(
(props, ref) => {
const { code, executeScriptOnCanvas, clientOnly, children, ...rest } =
props;
- const { renderer } = useContext(ReactSdkContext);
+ const { renderer, isSafeMode } = useContext(ReactSdkContext);
const isServer = useIsServer();
@@ -250,6 +250,19 @@ export const HtmlEmbed = forwardRef<HTMLDivElement, HtmlEmbedProps>(
}
// We are or on canvas | preview | published site after client routing
+ // In safe mode, never execute scripts regardless of other settings
+ if (isSafeMode) {
+ return (
+ <ClientOnly>
+ <ClientEmbedWithNonExecutableScripts
+ innerRef={ref}
+ code={code}
+ {...rest}
+ />
+ </ClientOnly>
+ );
+ }
+
// The only case we need to prevent script execution if it's explicitly disabled on the canvas
if (renderer === "canvas" && executeScriptOnCanvas !== true) {
return (