Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fine-results-crash.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/electron': patch
---

Validate that token-cache and OAuth-transport IPC requests originate from a top-level window's main frame. This prevents untrusted content in subframes or `<webview>`s that share the Clerk preload from reading the persisted client JWT or driving the OAuth transport.
54 changes: 52 additions & 2 deletions packages/electron/src/main/__tests__/create-clerk-bridge.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,11 @@ vi.mock('@clerk/electron-passkeys', () => ({
},
}));

const mainFrame = {};
const windowSender = { mainFrame, getType: () => 'window' };
const mainFrameEvent = { sender: windowSender, senderFrame: mainFrame } as unknown as Electron.IpcMainInvokeEvent;
const subframeEvent = { sender: windowSender, senderFrame: {} } as unknown as Electron.IpcMainInvokeEvent;

describe('createClerkBridge', () => {
const missingStorage = {} as Parameters<typeof createClerkBridge>[0];
const storage: TokenStorage = {
Expand DownExpand Up@@ -264,7 +269,52 @@ describe('createClerkBridge', () => {
return channel === OAUTH_TRANSPORT_CHANNELS.getRedirectUrl;
})?.[1];

expect(getRedirectUrlHandler?.({} as Electron.IpcMainInvokeEvent)).toBe('my-app://renderer/');
expect(getRedirectUrlHandler?.(mainFrameEvent)).toBe('my-app://renderer/');
});

it('rejects OAuth transport requests that do not originate from the main frame', async () => {
vi.mocked(shell.openExternal).mockResolvedValue(undefined);
createClerkBridge({
storage,
renderer: {
host: 'renderer',
scheme: 'my-app',
},
});

const findHandler = (channel: string) =>
vi.mocked(ipcMain.handle).mock.calls.find(([registered]) => registered === channel)?.[1];

expect(() => findHandler(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl)?.(subframeEvent)).toThrow('main frame');
await expect(
findHandler(OAUTH_TRANSPORT_CHANNELS.open)?.(subframeEvent, 'https://accounts.example.com/oauth'),
).rejects.toThrow('main frame');
expect(shell.openExternal).not.toHaveBeenCalled();
});

it('rejects OAuth transport requests from a <webview> whose top frame mimics the main frame', async () => {
vi.mocked(shell.openExternal).mockResolvedValue(undefined);
createClerkBridge({
storage,
renderer: {
host: 'renderer',
scheme: 'my-app',
},
});

const findHandler = (channel: string) =>
vi.mocked(ipcMain.handle).mock.calls.find(([registered]) => registered === channel)?.[1];

const webviewEvent = {
sender: { mainFrame, getType: () => 'webview' },
senderFrame: mainFrame,
} as unknown as Electron.IpcMainInvokeEvent;

expect(() => findHandler(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl)?.(webviewEvent)).toThrow('main frame');
await expect(
findHandler(OAUTH_TRANSPORT_CHANNELS.open)?.(webviewEvent, 'https://accounts.example.com/oauth'),
).rejects.toThrow('main frame');
expect(shell.openExternal).not.toHaveBeenCalled();
});

it('opens OAuth URLs externally and resolves with the matching deep-link callback URL', async () => {
Expand All@@ -280,7 +330,7 @@ describe('createClerkBridge', () => {
const openHandler = vi.mocked(ipcMain.handle).mock.calls.find(([channel]) => {
return channel === OAUTH_TRANSPORT_CHANNELS.open;
})?.[1];
const openPromise = openHandler?.({} as Electron.IpcMainInvokeEvent, 'https://accounts.example.com/oauth');
const openPromise = openHandler?.(mainFrameEvent, 'https://accounts.example.com/oauth');
const openUrlListener = vi.mocked(app.on).mock.calls.find(([event]) => event === 'open-url')?.[1] as (
event: Electron.Event,
url: string,
Expand Down
42 changes: 41 additions & 1 deletion packages/electron/src/main/__tests__/ipc-handlers.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,15 @@ import { TOKEN_CACHE_CHANNELS } from '../../shared/ipc';
import type { TokenStorage } from '../../shared/types';
import { setupTokenCacheIpcHandlers } from '../ipc-handlers';

const ipcEvent = {} as Electron.IpcMainInvokeEvent;
const mainFrame = {};
const windowSender = { mainFrame, getType: () => 'window' };
const ipcEvent = { sender: windowSender, senderFrame: mainFrame } as unknown as Electron.IpcMainInvokeEvent;
const subframeEvent = { sender: windowSender, senderFrame: {} } as unknown as Electron.IpcMainInvokeEvent;
// A <webview> is a separate WebContents whose top document satisfies senderFrame === mainFrame.
const webviewEvent = {
sender: { mainFrame, getType: () => 'webview' },
senderFrame: mainFrame,
} as unknown as Electron.IpcMainInvokeEvent;

vi.mock('electron', () => ({
ipcMain: {
Expand DownExpand Up@@ -51,6 +59,38 @@ describe('setupTokenCacheIpcHandlers', () => {
expect(storage.removeItem).toHaveBeenCalledWith('token-key');
});

it('rejects token operations that do not originate from the main frame', () => {
setupTokenCacheIpcHandlers(storage);

const getTokenHandler = vi.mocked(ipcMain.handle).mock.calls[0][1];
const saveTokenHandler = vi.mocked(ipcMain.handle).mock.calls[1][1];
const clearTokenHandler = vi.mocked(ipcMain.handle).mock.calls[2][1];

expect(() => getTokenHandler(subframeEvent, 'token-key')).toThrow('main frame');
expect(() => saveTokenHandler(subframeEvent, 'token-key', 'jwt')).toThrow('main frame');
expect(() => clearTokenHandler(subframeEvent, 'token-key')).toThrow('main frame');

expect(storage.getItem).not.toHaveBeenCalled();
expect(storage.setItem).not.toHaveBeenCalled();
expect(storage.removeItem).not.toHaveBeenCalled();
});

it('rejects token operations from a <webview> whose top frame mimics the main frame', () => {
setupTokenCacheIpcHandlers(storage);

const getTokenHandler = vi.mocked(ipcMain.handle).mock.calls[0][1];
const saveTokenHandler = vi.mocked(ipcMain.handle).mock.calls[1][1];
const clearTokenHandler = vi.mocked(ipcMain.handle).mock.calls[2][1];

expect(() => getTokenHandler(webviewEvent, 'token-key')).toThrow('main frame');
expect(() => saveTokenHandler(webviewEvent, 'token-key', 'jwt')).toThrow('main frame');
expect(() => clearTokenHandler(webviewEvent, 'token-key')).toThrow('main frame');

expect(storage.getItem).not.toHaveBeenCalled();
expect(storage.setItem).not.toHaveBeenCalled();
expect(storage.removeItem).not.toHaveBeenCalled();
});

it('removes registered handlers on cleanup', () => {
const cleanup = setupTokenCacheIpcHandlers(storage);

Expand Down
10 changes: 8 additions & 2 deletions packages/electron/src/main/__tests__/passkey-handlers.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,10 @@ const getHandler = (channel: string): Handler => {

const windowHandle = Buffer.from([1, 2, 3, 4]);
const mainFrame = {};
const event = { sender: { mainFrame }, senderFrame: mainFrame } as unknown as IpcMainInvokeEvent;
const event = {
sender: { mainFrame, getType: () => 'window' },
senderFrame: mainFrame,
} as unknown as IpcMainInvokeEvent;

const creationOptions = { challenge: 'abc', rp: { id: 'example.com', name: 'Example' } };
const registrationJSON = { id: 'cred', rawId: 'cred', type: 'public-key', response: {} };
Expand DownExpand Up@@ -98,7 +101,10 @@ describe('setupPasskeysMain', () => {
it('rejects requests that do not originate from the main frame', async () => {
setupPasskeysMain();

const subframeEvent = { sender: { mainFrame }, senderFrame: {} } as unknown as IpcMainInvokeEvent;
const subframeEvent = {
sender: { mainFrame, getType: () => 'window' },
senderFrame: {},
} as unknown as IpcMainInvokeEvent;
const result = await getHandler(PASSKEY_CHANNELS.create)(subframeEvent, creationOptions);

expect(result).toMatchObject({ ok: false, error: { code: 'unknown' } });
Expand Down
17 changes: 14 additions & 3 deletions packages/electron/src/main/ipc-handlers.ts
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,29 @@
import type { IpcMainInvokeEvent } from 'electron';
import { ipcMain } from 'electron';

import { TOKEN_CACHE_CHANNELS } from '../shared/ipc';
import type { TokenStorage } from '../shared/types';
import { isMainFrameEvent } from './validate-sender';

function assertMainFrameSender(event: IpcMainInvokeEvent): void {
if (!isMainFrameEvent(event)) {
throw new Error("Clerk: token-cache request did not originate from a window's main frame.");
}
}

export function setupTokenCacheIpcHandlers(storage: TokenStorage): () => void {
ipcMain.handle(TOKEN_CACHE_CHANNELS.getToken, (_event, key: string) => {
ipcMain.handle(TOKEN_CACHE_CHANNELS.getToken, (event, key: string) => {
assertMainFrameSender(event);
return storage.getItem(key);
});

ipcMain.handle(TOKEN_CACHE_CHANNELS.saveToken, (_event, key: string, value: string) => {
ipcMain.handle(TOKEN_CACHE_CHANNELS.saveToken, (event, key: string, value: string) => {
assertMainFrameSender(event);
return storage.setItem(key, value);
});

ipcMain.handle(TOKEN_CACHE_CHANNELS.clearToken, (_event, key: string) => {
ipcMain.handle(TOKEN_CACHE_CHANNELS.clearToken, (event, key: string) => {
assertMainFrameSender(event);
return storage.removeItem(key);
});

Expand Down
12 changes: 10 additions & 2 deletions packages/electron/src/main/oauth-transport.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { app, ipcMain, shell } from 'electron';

import { OAUTH_TRANSPORT_CHANNELS } from '../shared/ipc';
import type { RendererSchemeOptions } from '../shared/types';
import { isMainFrameEvent } from './validate-sender';

const CALLBACK_TIMEOUT_MS = 3 * 60 * 1000;

Expand DownExpand Up@@ -91,11 +92,18 @@ export function setupOAuthTransportIpcHandlers(options: OAuthTransportOptions):
app.on('open-url', openUrlListener);
app.on('second-instance', secondInstanceListener);

ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl, () => {
ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl, event => {
if (!isMainFrameEvent(event)) {
throw new Error("Clerk: OAuth request did not originate from a window's main frame.");
}
return redirectUrl;
});

ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.open, async (_event, url: string) => {
ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.open, async (event, url: string) => {
if (!isMainFrameEvent(event)) {
throw new Error("Clerk: OAuth request did not originate from a window's main frame.");
}

if (pendingOAuthFlow) {
throw new Error('Clerk: an OAuth flow is already pending.');
}
Expand Down
3 changes: 2 additions & 1 deletion packages/electron/src/main/passkey-handlers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import type {
SerializedPublicKeyCredentialRequestOptions,
SetupPasskeysMainReturn,
} from '../shared/types';
import { isMainFrameEvent } from './validate-sender';

/**
* Optional native module. Ceremony failures resolve as JSON envelopes so error
Expand DownExpand Up@@ -77,7 +78,7 @@ async function invokeNative<T>(

// Subframes and webviews can host third-party content that must not be able
// to run credential ceremonies for the app's RP ID.
if (!event.senderFrame || event.senderFrame !== event.sender.mainFrame) {
if (!isMainFrameEvent(event)) {
return {
ok: false,
error: { code: 'unknown', message: "The passkey request did not originate from a window's main frame." },
Expand Down
10 changes: 10 additions & 0 deletions packages/electron/src/main/validate-sender.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import type { IpcMainInvokeEvent } from 'electron';

// Restricts privileged IPC to a top-level BrowserWindow's main frame. The frame check alone
// only proves the sender is the top document of *its own* WebContents, so a <webview> (a separate
// WebContents) sharing the Clerk preload would still pass; requiring getType() === 'window' rejects
// <webview> guests and BrowserViews, and the frame check rejects in-page iframes.
export function isMainFrameEvent(event: IpcMainInvokeEvent): boolean {
const { sender, senderFrame } = event;
return sender.getType() === 'window' && Boolean(senderFrame) && senderFrame === sender.mainFrame;
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fine-results-crash.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/electron': patch
---

Validate that token-cache and OAuth-transport IPC requests originate from a top-level window's main frame. This prevents untrusted content in subframes or `<webview>`s that share the Clerk preload from reading the persisted client JWT or driving the OAuth transport.
54 changes: 52 additions & 2 deletions packages/electron/src/main/__tests__/create-clerk-bridge.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,11 @@ vi.mock('@clerk/electron-passkeys', () => ({
},
}));

const mainFrame = {};
const windowSender = { mainFrame, getType: () => 'window' };
const mainFrameEvent = { sender: windowSender, senderFrame: mainFrame } as unknown as Electron.IpcMainInvokeEvent;
const subframeEvent = { sender: windowSender, senderFrame: {} } as unknown as Electron.IpcMainInvokeEvent;

describe('createClerkBridge', () => {
const missingStorage = {} as Parameters<typeof createClerkBridge>[0];
const storage: TokenStorage = {
Expand DownExpand Up@@ -264,7 +269,52 @@ describe('createClerkBridge', () => {
return channel === OAUTH_TRANSPORT_CHANNELS.getRedirectUrl;
})?.[1];

expect(getRedirectUrlHandler?.({} as Electron.IpcMainInvokeEvent)).toBe('my-app://renderer/');
expect(getRedirectUrlHandler?.(mainFrameEvent)).toBe('my-app://renderer/');
});

it('rejects OAuth transport requests that do not originate from the main frame', async () => {
vi.mocked(shell.openExternal).mockResolvedValue(undefined);
createClerkBridge({
storage,
renderer: {
host: 'renderer',
scheme: 'my-app',
},
});

const findHandler = (channel: string) =>
vi.mocked(ipcMain.handle).mock.calls.find(([registered]) => registered === channel)?.[1];

expect(() => findHandler(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl)?.(subframeEvent)).toThrow('main frame');
await expect(
findHandler(OAUTH_TRANSPORT_CHANNELS.open)?.(subframeEvent, 'https://accounts.example.com/oauth'),
).rejects.toThrow('main frame');
expect(shell.openExternal).not.toHaveBeenCalled();
});

it('rejects OAuth transport requests from a <webview> whose top frame mimics the main frame', async () => {
vi.mocked(shell.openExternal).mockResolvedValue(undefined);
createClerkBridge({
storage,
renderer: {
host: 'renderer',
scheme: 'my-app',
},
});

const findHandler = (channel: string) =>
vi.mocked(ipcMain.handle).mock.calls.find(([registered]) => registered === channel)?.[1];

const webviewEvent = {
sender: { mainFrame, getType: () => 'webview' },
senderFrame: mainFrame,
} as unknown as Electron.IpcMainInvokeEvent;

expect(() => findHandler(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl)?.(webviewEvent)).toThrow('main frame');
await expect(
findHandler(OAUTH_TRANSPORT_CHANNELS.open)?.(webviewEvent, 'https://accounts.example.com/oauth'),
).rejects.toThrow('main frame');
expect(shell.openExternal).not.toHaveBeenCalled();
});

it('opens OAuth URLs externally and resolves with the matching deep-link callback URL', async () => {
Expand All@@ -280,7 +330,7 @@ describe('createClerkBridge', () => {
const openHandler = vi.mocked(ipcMain.handle).mock.calls.find(([channel]) => {
return channel === OAUTH_TRANSPORT_CHANNELS.open;
})?.[1];
const openPromise = openHandler?.({} as Electron.IpcMainInvokeEvent, 'https://accounts.example.com/oauth');
const openPromise = openHandler?.(mainFrameEvent, 'https://accounts.example.com/oauth');
const openUrlListener = vi.mocked(app.on).mock.calls.find(([event]) => event === 'open-url')?.[1] as (
event: Electron.Event,
url: string,
Expand Down
42 changes: 41 additions & 1 deletion packages/electron/src/main/__tests__/ipc-handlers.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,15 @@ import { TOKEN_CACHE_CHANNELS } from '../../shared/ipc';
import type { TokenStorage } from '../../shared/types';
import { setupTokenCacheIpcHandlers } from '../ipc-handlers';

const ipcEvent = {} as Electron.IpcMainInvokeEvent;
const mainFrame = {};
const windowSender = { mainFrame, getType: () => 'window' };
const ipcEvent = { sender: windowSender, senderFrame: mainFrame } as unknown as Electron.IpcMainInvokeEvent;
const subframeEvent = { sender: windowSender, senderFrame: {} } as unknown as Electron.IpcMainInvokeEvent;
// A <webview> is a separate WebContents whose top document satisfies senderFrame === mainFrame.
const webviewEvent = {
sender: { mainFrame, getType: () => 'webview' },
senderFrame: mainFrame,
} as unknown as Electron.IpcMainInvokeEvent;

vi.mock('electron', () => ({
ipcMain: {
Expand DownExpand Up@@ -51,6 +59,38 @@ describe('setupTokenCacheIpcHandlers', () => {
expect(storage.removeItem).toHaveBeenCalledWith('token-key');
});

it('rejects token operations that do not originate from the main frame', () => {
setupTokenCacheIpcHandlers(storage);

const getTokenHandler = vi.mocked(ipcMain.handle).mock.calls[0][1];
const saveTokenHandler = vi.mocked(ipcMain.handle).mock.calls[1][1];
const clearTokenHandler = vi.mocked(ipcMain.handle).mock.calls[2][1];

expect(() => getTokenHandler(subframeEvent, 'token-key')).toThrow('main frame');
expect(() => saveTokenHandler(subframeEvent, 'token-key', 'jwt')).toThrow('main frame');
expect(() => clearTokenHandler(subframeEvent, 'token-key')).toThrow('main frame');

expect(storage.getItem).not.toHaveBeenCalled();
expect(storage.setItem).not.toHaveBeenCalled();
expect(storage.removeItem).not.toHaveBeenCalled();
});

it('rejects token operations from a <webview> whose top frame mimics the main frame', () => {
setupTokenCacheIpcHandlers(storage);

const getTokenHandler = vi.mocked(ipcMain.handle).mock.calls[0][1];
const saveTokenHandler = vi.mocked(ipcMain.handle).mock.calls[1][1];
const clearTokenHandler = vi.mocked(ipcMain.handle).mock.calls[2][1];

expect(() => getTokenHandler(webviewEvent, 'token-key')).toThrow('main frame');
expect(() => saveTokenHandler(webviewEvent, 'token-key', 'jwt')).toThrow('main frame');
expect(() => clearTokenHandler(webviewEvent, 'token-key')).toThrow('main frame');

expect(storage.getItem).not.toHaveBeenCalled();
expect(storage.setItem).not.toHaveBeenCalled();
expect(storage.removeItem).not.toHaveBeenCalled();
});

it('removes registered handlers on cleanup', () => {
const cleanup = setupTokenCacheIpcHandlers(storage);

Expand Down
10 changes: 8 additions & 2 deletions packages/electron/src/main/__tests__/passkey-handlers.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,10 @@ const getHandler = (channel: string): Handler => {

const windowHandle = Buffer.from([1, 2, 3, 4]);
const mainFrame = {};
const event = { sender: { mainFrame }, senderFrame: mainFrame } as unknown as IpcMainInvokeEvent;
const event = {
sender: { mainFrame, getType: () => 'window' },
senderFrame: mainFrame,
} as unknown as IpcMainInvokeEvent;

const creationOptions = { challenge: 'abc', rp: { id: 'example.com', name: 'Example' } };
const registrationJSON = { id: 'cred', rawId: 'cred', type: 'public-key', response: {} };
Expand DownExpand Up@@ -98,7 +101,10 @@ describe('setupPasskeysMain', () => {
it('rejects requests that do not originate from the main frame', async () => {
setupPasskeysMain();

const subframeEvent = { sender: { mainFrame }, senderFrame: {} } as unknown as IpcMainInvokeEvent;
const subframeEvent = {
sender: { mainFrame, getType: () => 'window' },
senderFrame: {},
} as unknown as IpcMainInvokeEvent;
const result = await getHandler(PASSKEY_CHANNELS.create)(subframeEvent, creationOptions);

expect(result).toMatchObject({ ok: false, error: { code: 'unknown' } });
Expand Down
17 changes: 14 additions & 3 deletions packages/electron/src/main/ipc-handlers.ts
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,29 @@
import type { IpcMainInvokeEvent } from 'electron';
import { ipcMain } from 'electron';

import { TOKEN_CACHE_CHANNELS } from '../shared/ipc';
import type { TokenStorage } from '../shared/types';
import { isMainFrameEvent } from './validate-sender';

function assertMainFrameSender(event: IpcMainInvokeEvent): void {
if (!isMainFrameEvent(event)) {
throw new Error("Clerk: token-cache request did not originate from a window's main frame.");
}
}

export function setupTokenCacheIpcHandlers(storage: TokenStorage): () => void {
ipcMain.handle(TOKEN_CACHE_CHANNELS.getToken, (_event, key: string) => {
ipcMain.handle(TOKEN_CACHE_CHANNELS.getToken, (event, key: string) => {
assertMainFrameSender(event);
return storage.getItem(key);
});

ipcMain.handle(TOKEN_CACHE_CHANNELS.saveToken, (_event, key: string, value: string) => {
ipcMain.handle(TOKEN_CACHE_CHANNELS.saveToken, (event, key: string, value: string) => {
assertMainFrameSender(event);
return storage.setItem(key, value);
});

ipcMain.handle(TOKEN_CACHE_CHANNELS.clearToken, (_event, key: string) => {
ipcMain.handle(TOKEN_CACHE_CHANNELS.clearToken, (event, key: string) => {
assertMainFrameSender(event);
return storage.removeItem(key);
});

Expand Down
12 changes: 10 additions & 2 deletions packages/electron/src/main/oauth-transport.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { app, ipcMain, shell } from 'electron';

import { OAUTH_TRANSPORT_CHANNELS } from '../shared/ipc';
import type { RendererSchemeOptions } from '../shared/types';
import { isMainFrameEvent } from './validate-sender';

const CALLBACK_TIMEOUT_MS = 3 * 60 * 1000;

Expand DownExpand Up@@ -91,11 +92,18 @@ export function setupOAuthTransportIpcHandlers(options: OAuthTransportOptions):
app.on('open-url', openUrlListener);
app.on('second-instance', secondInstanceListener);

ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl, () => {
ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl, event => {
if (!isMainFrameEvent(event)) {
throw new Error("Clerk: OAuth request did not originate from a window's main frame.");
}
return redirectUrl;
});

ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.open, async (_event, url: string) => {
ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.open, async (event, url: string) => {
if (!isMainFrameEvent(event)) {
throw new Error("Clerk: OAuth request did not originate from a window's main frame.");
}

if (pendingOAuthFlow) {
throw new Error('Clerk: an OAuth flow is already pending.');
}
Expand Down
3 changes: 2 additions & 1 deletion packages/electron/src/main/passkey-handlers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import type {
SerializedPublicKeyCredentialRequestOptions,
SetupPasskeysMainReturn,
} from '../shared/types';
import { isMainFrameEvent } from './validate-sender';

/**
* Optional native module. Ceremony failures resolve as JSON envelopes so error
Expand DownExpand Up@@ -77,7 +78,7 @@ async function invokeNative<T>(

// Subframes and webviews can host third-party content that must not be able
// to run credential ceremonies for the app's RP ID.
if (!event.senderFrame || event.senderFrame !== event.sender.mainFrame) {
if (!isMainFrameEvent(event)) {
return {
ok: false,
error: { code: 'unknown', message: "The passkey request did not originate from a window's main frame." },
Expand Down
10 changes: 10 additions & 0 deletions packages/electron/src/main/validate-sender.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import type { IpcMainInvokeEvent } from 'electron';

// Restricts privileged IPC to a top-level BrowserWindow's main frame. The frame check alone
// only proves the sender is the top document of *its own* WebContents, so a <webview> (a separate
// WebContents) sharing the Clerk preload would still pass; requiring getType() === 'window' rejects
// <webview> guests and BrowserViews, and the frame check rejects in-page iframes.
export function isMainFrameEvent(event: IpcMainInvokeEvent): boolean {
const { sender, senderFrame } = event;
return sender.getType() === 'window' && Boolean(senderFrame) && senderFrame === sender.mainFrame;
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fine-results-crash.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/electron': patch
---

Validate that token-cache and OAuth-transport IPC requests originate from a top-level window's main frame. This prevents untrusted content in subframes or `<webview>`s that share the Clerk preload from reading the persisted client JWT or driving the OAuth transport.
54 changes: 52 additions & 2 deletions packages/electron/src/main/__tests__/create-clerk-bridge.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,11 @@ vi.mock('@clerk/electron-passkeys', () => ({
},
}));

const mainFrame = {};
const windowSender = { mainFrame, getType: () => 'window' };
const mainFrameEvent = { sender: windowSender, senderFrame: mainFrame } as unknown as Electron.IpcMainInvokeEvent;
const subframeEvent = { sender: windowSender, senderFrame: {} } as unknown as Electron.IpcMainInvokeEvent;

describe('createClerkBridge', () => {
const missingStorage = {} as Parameters<typeof createClerkBridge>[0];
const storage: TokenStorage = {
Expand DownExpand Up@@ -264,7 +269,52 @@ describe('createClerkBridge', () => {
return channel === OAUTH_TRANSPORT_CHANNELS.getRedirectUrl;
})?.[1];

expect(getRedirectUrlHandler?.({} as Electron.IpcMainInvokeEvent)).toBe('my-app://renderer/');
expect(getRedirectUrlHandler?.(mainFrameEvent)).toBe('my-app://renderer/');
});

it('rejects OAuth transport requests that do not originate from the main frame', async () => {
vi.mocked(shell.openExternal).mockResolvedValue(undefined);
createClerkBridge({
storage,
renderer: {
host: 'renderer',
scheme: 'my-app',
},
});

const findHandler = (channel: string) =>
vi.mocked(ipcMain.handle).mock.calls.find(([registered]) => registered === channel)?.[1];

expect(() => findHandler(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl)?.(subframeEvent)).toThrow('main frame');
await expect(
findHandler(OAUTH_TRANSPORT_CHANNELS.open)?.(subframeEvent, 'https://accounts.example.com/oauth'),
).rejects.toThrow('main frame');
expect(shell.openExternal).not.toHaveBeenCalled();
});

it('rejects OAuth transport requests from a <webview> whose top frame mimics the main frame', async () => {
vi.mocked(shell.openExternal).mockResolvedValue(undefined);
createClerkBridge({
storage,
renderer: {
host: 'renderer',
scheme: 'my-app',
},
});

const findHandler = (channel: string) =>
vi.mocked(ipcMain.handle).mock.calls.find(([registered]) => registered === channel)?.[1];

const webviewEvent = {
sender: { mainFrame, getType: () => 'webview' },
senderFrame: mainFrame,
} as unknown as Electron.IpcMainInvokeEvent;

expect(() => findHandler(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl)?.(webviewEvent)).toThrow('main frame');
await expect(
findHandler(OAUTH_TRANSPORT_CHANNELS.open)?.(webviewEvent, 'https://accounts.example.com/oauth'),
).rejects.toThrow('main frame');
expect(shell.openExternal).not.toHaveBeenCalled();
});

it('opens OAuth URLs externally and resolves with the matching deep-link callback URL', async () => {
Expand All@@ -280,7 +330,7 @@ describe('createClerkBridge', () => {
const openHandler = vi.mocked(ipcMain.handle).mock.calls.find(([channel]) => {
return channel === OAUTH_TRANSPORT_CHANNELS.open;
})?.[1];
const openPromise = openHandler?.({} as Electron.IpcMainInvokeEvent, 'https://accounts.example.com/oauth');
const openPromise = openHandler?.(mainFrameEvent, 'https://accounts.example.com/oauth');
const openUrlListener = vi.mocked(app.on).mock.calls.find(([event]) => event === 'open-url')?.[1] as (
event: Electron.Event,
url: string,
Expand Down
42 changes: 41 additions & 1 deletion packages/electron/src/main/__tests__/ipc-handlers.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,15 @@ import { TOKEN_CACHE_CHANNELS } from '../../shared/ipc';
import type { TokenStorage } from '../../shared/types';
import { setupTokenCacheIpcHandlers } from '../ipc-handlers';

const ipcEvent = {} as Electron.IpcMainInvokeEvent;
const mainFrame = {};
const windowSender = { mainFrame, getType: () => 'window' };
const ipcEvent = { sender: windowSender, senderFrame: mainFrame } as unknown as Electron.IpcMainInvokeEvent;
const subframeEvent = { sender: windowSender, senderFrame: {} } as unknown as Electron.IpcMainInvokeEvent;
// A <webview> is a separate WebContents whose top document satisfies senderFrame === mainFrame.
const webviewEvent = {
sender: { mainFrame, getType: () => 'webview' },
senderFrame: mainFrame,
} as unknown as Electron.IpcMainInvokeEvent;

vi.mock('electron', () => ({
ipcMain: {
Expand DownExpand Up@@ -51,6 +59,38 @@ describe('setupTokenCacheIpcHandlers', () => {
expect(storage.removeItem).toHaveBeenCalledWith('token-key');
});

it('rejects token operations that do not originate from the main frame', () => {
setupTokenCacheIpcHandlers(storage);

const getTokenHandler = vi.mocked(ipcMain.handle).mock.calls[0][1];
const saveTokenHandler = vi.mocked(ipcMain.handle).mock.calls[1][1];
const clearTokenHandler = vi.mocked(ipcMain.handle).mock.calls[2][1];

expect(() => getTokenHandler(subframeEvent, 'token-key')).toThrow('main frame');
expect(() => saveTokenHandler(subframeEvent, 'token-key', 'jwt')).toThrow('main frame');
expect(() => clearTokenHandler(subframeEvent, 'token-key')).toThrow('main frame');

expect(storage.getItem).not.toHaveBeenCalled();
expect(storage.setItem).not.toHaveBeenCalled();
expect(storage.removeItem).not.toHaveBeenCalled();
});

it('rejects token operations from a <webview> whose top frame mimics the main frame', () => {
setupTokenCacheIpcHandlers(storage);

const getTokenHandler = vi.mocked(ipcMain.handle).mock.calls[0][1];
const saveTokenHandler = vi.mocked(ipcMain.handle).mock.calls[1][1];
const clearTokenHandler = vi.mocked(ipcMain.handle).mock.calls[2][1];

expect(() => getTokenHandler(webviewEvent, 'token-key')).toThrow('main frame');
expect(() => saveTokenHandler(webviewEvent, 'token-key', 'jwt')).toThrow('main frame');
expect(() => clearTokenHandler(webviewEvent, 'token-key')).toThrow('main frame');

expect(storage.getItem).not.toHaveBeenCalled();
expect(storage.setItem).not.toHaveBeenCalled();
expect(storage.removeItem).not.toHaveBeenCalled();
});

it('removes registered handlers on cleanup', () => {
const cleanup = setupTokenCacheIpcHandlers(storage);

Expand Down
10 changes: 8 additions & 2 deletions packages/electron/src/main/__tests__/passkey-handlers.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,10 @@ const getHandler = (channel: string): Handler => {

const windowHandle = Buffer.from([1, 2, 3, 4]);
const mainFrame = {};
const event = { sender: { mainFrame }, senderFrame: mainFrame } as unknown as IpcMainInvokeEvent;
const event = {
sender: { mainFrame, getType: () => 'window' },
senderFrame: mainFrame,
} as unknown as IpcMainInvokeEvent;

const creationOptions = { challenge: 'abc', rp: { id: 'example.com', name: 'Example' } };
const registrationJSON = { id: 'cred', rawId: 'cred', type: 'public-key', response: {} };
Expand DownExpand Up@@ -98,7 +101,10 @@ describe('setupPasskeysMain', () => {
it('rejects requests that do not originate from the main frame', async () => {
setupPasskeysMain();

const subframeEvent = { sender: { mainFrame }, senderFrame: {} } as unknown as IpcMainInvokeEvent;
const subframeEvent = {
sender: { mainFrame, getType: () => 'window' },
senderFrame: {},
} as unknown as IpcMainInvokeEvent;
const result = await getHandler(PASSKEY_CHANNELS.create)(subframeEvent, creationOptions);

expect(result).toMatchObject({ ok: false, error: { code: 'unknown' } });
Expand Down
17 changes: 14 additions & 3 deletions packages/electron/src/main/ipc-handlers.ts
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,29 @@
import type { IpcMainInvokeEvent } from 'electron';
import { ipcMain } from 'electron';

import { TOKEN_CACHE_CHANNELS } from '../shared/ipc';
import type { TokenStorage } from '../shared/types';
import { isMainFrameEvent } from './validate-sender';

function assertMainFrameSender(event: IpcMainInvokeEvent): void {
if (!isMainFrameEvent(event)) {
throw new Error("Clerk: token-cache request did not originate from a window's main frame.");
}
}

export function setupTokenCacheIpcHandlers(storage: TokenStorage): () => void {
ipcMain.handle(TOKEN_CACHE_CHANNELS.getToken, (_event, key: string) => {
ipcMain.handle(TOKEN_CACHE_CHANNELS.getToken, (event, key: string) => {
assertMainFrameSender(event);
return storage.getItem(key);
});

ipcMain.handle(TOKEN_CACHE_CHANNELS.saveToken, (_event, key: string, value: string) => {
ipcMain.handle(TOKEN_CACHE_CHANNELS.saveToken, (event, key: string, value: string) => {
assertMainFrameSender(event);
return storage.setItem(key, value);
});

ipcMain.handle(TOKEN_CACHE_CHANNELS.clearToken, (_event, key: string) => {
ipcMain.handle(TOKEN_CACHE_CHANNELS.clearToken, (event, key: string) => {
assertMainFrameSender(event);
return storage.removeItem(key);
});

Expand Down
12 changes: 10 additions & 2 deletions packages/electron/src/main/oauth-transport.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { app, ipcMain, shell } from 'electron';

import { OAUTH_TRANSPORT_CHANNELS } from '../shared/ipc';
import type { RendererSchemeOptions } from '../shared/types';
import { isMainFrameEvent } from './validate-sender';

const CALLBACK_TIMEOUT_MS = 3 * 60 * 1000;

Expand DownExpand Up@@ -91,11 +92,18 @@ export function setupOAuthTransportIpcHandlers(options: OAuthTransportOptions):
app.on('open-url', openUrlListener);
app.on('second-instance', secondInstanceListener);

ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl, () => {
ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl, event => {
if (!isMainFrameEvent(event)) {
throw new Error("Clerk: OAuth request did not originate from a window's main frame.");
}
return redirectUrl;
});

ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.open, async (_event, url: string) => {
ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.open, async (event, url: string) => {
if (!isMainFrameEvent(event)) {
throw new Error("Clerk: OAuth request did not originate from a window's main frame.");
}

if (pendingOAuthFlow) {
throw new Error('Clerk: an OAuth flow is already pending.');
}
Expand Down
3 changes: 2 additions & 1 deletion packages/electron/src/main/passkey-handlers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import type {
SerializedPublicKeyCredentialRequestOptions,
SetupPasskeysMainReturn,
} from '../shared/types';
import { isMainFrameEvent } from './validate-sender';

/**
* Optional native module. Ceremony failures resolve as JSON envelopes so error
Expand DownExpand Up@@ -77,7 +78,7 @@ async function invokeNative<T>(

// Subframes and webviews can host third-party content that must not be able
// to run credential ceremonies for the app's RP ID.
if (!event.senderFrame || event.senderFrame !== event.sender.mainFrame) {
if (!isMainFrameEvent(event)) {
return {
ok: false,
error: { code: 'unknown', message: "The passkey request did not originate from a window's main frame." },
Expand Down
10 changes: 10 additions & 0 deletions packages/electron/src/main/validate-sender.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import type { IpcMainInvokeEvent } from 'electron';

// Restricts privileged IPC to a top-level BrowserWindow's main frame. The frame check alone
// only proves the sender is the top document of *its own* WebContents, so a <webview> (a separate
// WebContents) sharing the Clerk preload would still pass; requiring getType() === 'window' rejects
// <webview> guests and BrowserViews, and the frame check rejects in-page iframes.
export function isMainFrameEvent(event: IpcMainInvokeEvent): boolean {
const { sender, senderFrame } = event;
return sender.getType() === 'window' && Boolean(senderFrame) && senderFrame === sender.mainFrame;
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fine-results-crash.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/electron': patch
---

Validate that token-cache and OAuth-transport IPC requests originate from a top-level window's main frame. This prevents untrusted content in subframes or `<webview>`s that share the Clerk preload from reading the persisted client JWT or driving the OAuth transport.
54 changes: 52 additions & 2 deletions packages/electron/src/main/__tests__/create-clerk-bridge.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,11 @@ vi.mock('@clerk/electron-passkeys', () => ({
},
}));

const mainFrame = {};
const windowSender = { mainFrame, getType: () => 'window' };
const mainFrameEvent = { sender: windowSender, senderFrame: mainFrame } as unknown as Electron.IpcMainInvokeEvent;
const subframeEvent = { sender: windowSender, senderFrame: {} } as unknown as Electron.IpcMainInvokeEvent;

describe('createClerkBridge', () => {
const missingStorage = {} as Parameters<typeof createClerkBridge>[0];
const storage: TokenStorage = {
Expand DownExpand Up@@ -264,7 +269,52 @@ describe('createClerkBridge', () => {
return channel === OAUTH_TRANSPORT_CHANNELS.getRedirectUrl;
})?.[1];

expect(getRedirectUrlHandler?.({} as Electron.IpcMainInvokeEvent)).toBe('my-app://renderer/');
expect(getRedirectUrlHandler?.(mainFrameEvent)).toBe('my-app://renderer/');
});

it('rejects OAuth transport requests that do not originate from the main frame', async () => {
vi.mocked(shell.openExternal).mockResolvedValue(undefined);
createClerkBridge({
storage,
renderer: {
host: 'renderer',
scheme: 'my-app',
},
});

const findHandler = (channel: string) =>
vi.mocked(ipcMain.handle).mock.calls.find(([registered]) => registered === channel)?.[1];

expect(() => findHandler(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl)?.(subframeEvent)).toThrow('main frame');
await expect(
findHandler(OAUTH_TRANSPORT_CHANNELS.open)?.(subframeEvent, 'https://accounts.example.com/oauth'),
).rejects.toThrow('main frame');
expect(shell.openExternal).not.toHaveBeenCalled();
});

it('rejects OAuth transport requests from a <webview> whose top frame mimics the main frame', async () => {
vi.mocked(shell.openExternal).mockResolvedValue(undefined);
createClerkBridge({
storage,
renderer: {
host: 'renderer',
scheme: 'my-app',
},
});

const findHandler = (channel: string) =>
vi.mocked(ipcMain.handle).mock.calls.find(([registered]) => registered === channel)?.[1];

const webviewEvent = {
sender: { mainFrame, getType: () => 'webview' },
senderFrame: mainFrame,
} as unknown as Electron.IpcMainInvokeEvent;

expect(() => findHandler(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl)?.(webviewEvent)).toThrow('main frame');
await expect(
findHandler(OAUTH_TRANSPORT_CHANNELS.open)?.(webviewEvent, 'https://accounts.example.com/oauth'),
).rejects.toThrow('main frame');
expect(shell.openExternal).not.toHaveBeenCalled();
});

it('opens OAuth URLs externally and resolves with the matching deep-link callback URL', async () => {
Expand All@@ -280,7 +330,7 @@ describe('createClerkBridge', () => {
const openHandler = vi.mocked(ipcMain.handle).mock.calls.find(([channel]) => {
return channel === OAUTH_TRANSPORT_CHANNELS.open;
})?.[1];
const openPromise = openHandler?.({} as Electron.IpcMainInvokeEvent, 'https://accounts.example.com/oauth');
const openPromise = openHandler?.(mainFrameEvent, 'https://accounts.example.com/oauth');
const openUrlListener = vi.mocked(app.on).mock.calls.find(([event]) => event === 'open-url')?.[1] as (
event: Electron.Event,
url: string,
Expand Down
42 changes: 41 additions & 1 deletion packages/electron/src/main/__tests__/ipc-handlers.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,15 @@ import { TOKEN_CACHE_CHANNELS } from '../../shared/ipc';
import type { TokenStorage } from '../../shared/types';
import { setupTokenCacheIpcHandlers } from '../ipc-handlers';

const ipcEvent = {} as Electron.IpcMainInvokeEvent;
const mainFrame = {};
const windowSender = { mainFrame, getType: () => 'window' };
const ipcEvent = { sender: windowSender, senderFrame: mainFrame } as unknown as Electron.IpcMainInvokeEvent;
const subframeEvent = { sender: windowSender, senderFrame: {} } as unknown as Electron.IpcMainInvokeEvent;
// A <webview> is a separate WebContents whose top document satisfies senderFrame === mainFrame.
const webviewEvent = {
sender: { mainFrame, getType: () => 'webview' },
senderFrame: mainFrame,
} as unknown as Electron.IpcMainInvokeEvent;

vi.mock('electron', () => ({
ipcMain: {
Expand DownExpand Up@@ -51,6 +59,38 @@ describe('setupTokenCacheIpcHandlers', () => {
expect(storage.removeItem).toHaveBeenCalledWith('token-key');
});

it('rejects token operations that do not originate from the main frame', () => {
setupTokenCacheIpcHandlers(storage);

const getTokenHandler = vi.mocked(ipcMain.handle).mock.calls[0][1];
const saveTokenHandler = vi.mocked(ipcMain.handle).mock.calls[1][1];
const clearTokenHandler = vi.mocked(ipcMain.handle).mock.calls[2][1];

expect(() => getTokenHandler(subframeEvent, 'token-key')).toThrow('main frame');
expect(() => saveTokenHandler(subframeEvent, 'token-key', 'jwt')).toThrow('main frame');
expect(() => clearTokenHandler(subframeEvent, 'token-key')).toThrow('main frame');

expect(storage.getItem).not.toHaveBeenCalled();
expect(storage.setItem).not.toHaveBeenCalled();
expect(storage.removeItem).not.toHaveBeenCalled();
});

it('rejects token operations from a <webview> whose top frame mimics the main frame', () => {
setupTokenCacheIpcHandlers(storage);

const getTokenHandler = vi.mocked(ipcMain.handle).mock.calls[0][1];
const saveTokenHandler = vi.mocked(ipcMain.handle).mock.calls[1][1];
const clearTokenHandler = vi.mocked(ipcMain.handle).mock.calls[2][1];

expect(() => getTokenHandler(webviewEvent, 'token-key')).toThrow('main frame');
expect(() => saveTokenHandler(webviewEvent, 'token-key', 'jwt')).toThrow('main frame');
expect(() => clearTokenHandler(webviewEvent, 'token-key')).toThrow('main frame');

expect(storage.getItem).not.toHaveBeenCalled();
expect(storage.setItem).not.toHaveBeenCalled();
expect(storage.removeItem).not.toHaveBeenCalled();
});

it('removes registered handlers on cleanup', () => {
const cleanup = setupTokenCacheIpcHandlers(storage);

Expand Down
10 changes: 8 additions & 2 deletions packages/electron/src/main/__tests__/passkey-handlers.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,10 @@ const getHandler = (channel: string): Handler => {

const windowHandle = Buffer.from([1, 2, 3, 4]);
const mainFrame = {};
const event = { sender: { mainFrame }, senderFrame: mainFrame } as unknown as IpcMainInvokeEvent;
const event = {
sender: { mainFrame, getType: () => 'window' },
senderFrame: mainFrame,
} as unknown as IpcMainInvokeEvent;

const creationOptions = { challenge: 'abc', rp: { id: 'example.com', name: 'Example' } };
const registrationJSON = { id: 'cred', rawId: 'cred', type: 'public-key', response: {} };
Expand DownExpand Up@@ -98,7 +101,10 @@ describe('setupPasskeysMain', () => {
it('rejects requests that do not originate from the main frame', async () => {
setupPasskeysMain();

const subframeEvent = { sender: { mainFrame }, senderFrame: {} } as unknown as IpcMainInvokeEvent;
const subframeEvent = {
sender: { mainFrame, getType: () => 'window' },
senderFrame: {},
} as unknown as IpcMainInvokeEvent;
const result = await getHandler(PASSKEY_CHANNELS.create)(subframeEvent, creationOptions);

expect(result).toMatchObject({ ok: false, error: { code: 'unknown' } });
Expand Down
17 changes: 14 additions & 3 deletions packages/electron/src/main/ipc-handlers.ts
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,29 @@
import type { IpcMainInvokeEvent } from 'electron';
import { ipcMain } from 'electron';

import { TOKEN_CACHE_CHANNELS } from '../shared/ipc';
import type { TokenStorage } from '../shared/types';
import { isMainFrameEvent } from './validate-sender';

function assertMainFrameSender(event: IpcMainInvokeEvent): void {
if (!isMainFrameEvent(event)) {
throw new Error("Clerk: token-cache request did not originate from a window's main frame.");
}
}

export function setupTokenCacheIpcHandlers(storage: TokenStorage): () => void {
ipcMain.handle(TOKEN_CACHE_CHANNELS.getToken, (_event, key: string) => {
ipcMain.handle(TOKEN_CACHE_CHANNELS.getToken, (event, key: string) => {
assertMainFrameSender(event);
return storage.getItem(key);
});

ipcMain.handle(TOKEN_CACHE_CHANNELS.saveToken, (_event, key: string, value: string) => {
ipcMain.handle(TOKEN_CACHE_CHANNELS.saveToken, (event, key: string, value: string) => {
assertMainFrameSender(event);
return storage.setItem(key, value);
});

ipcMain.handle(TOKEN_CACHE_CHANNELS.clearToken, (_event, key: string) => {
ipcMain.handle(TOKEN_CACHE_CHANNELS.clearToken, (event, key: string) => {
assertMainFrameSender(event);
return storage.removeItem(key);
});

Expand Down
12 changes: 10 additions & 2 deletions packages/electron/src/main/oauth-transport.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { app, ipcMain, shell } from 'electron';

import { OAUTH_TRANSPORT_CHANNELS } from '../shared/ipc';
import type { RendererSchemeOptions } from '../shared/types';
import { isMainFrameEvent } from './validate-sender';

const CALLBACK_TIMEOUT_MS = 3 * 60 * 1000;

Expand DownExpand Up@@ -91,11 +92,18 @@ export function setupOAuthTransportIpcHandlers(options: OAuthTransportOptions):
app.on('open-url', openUrlListener);
app.on('second-instance', secondInstanceListener);

ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl, () => {
ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl, event => {
if (!isMainFrameEvent(event)) {
throw new Error("Clerk: OAuth request did not originate from a window's main frame.");
}
return redirectUrl;
});

ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.open, async (_event, url: string) => {
ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.open, async (event, url: string) => {
if (!isMainFrameEvent(event)) {
throw new Error("Clerk: OAuth request did not originate from a window's main frame.");
}

if (pendingOAuthFlow) {
throw new Error('Clerk: an OAuth flow is already pending.');
}
Expand Down
3 changes: 2 additions & 1 deletion packages/electron/src/main/passkey-handlers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import type {
SerializedPublicKeyCredentialRequestOptions,
SetupPasskeysMainReturn,
} from '../shared/types';
import { isMainFrameEvent } from './validate-sender';

/**
* Optional native module. Ceremony failures resolve as JSON envelopes so error
Expand DownExpand Up@@ -77,7 +78,7 @@ async function invokeNative<T>(

// Subframes and webviews can host third-party content that must not be able
// to run credential ceremonies for the app's RP ID.
if (!event.senderFrame || event.senderFrame !== event.sender.mainFrame) {
if (!isMainFrameEvent(event)) {
return {
ok: false,
error: { code: 'unknown', message: "The passkey request did not originate from a window's main frame." },
Expand Down
10 changes: 10 additions & 0 deletions packages/electron/src/main/validate-sender.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import type { IpcMainInvokeEvent } from 'electron';

// Restricts privileged IPC to a top-level BrowserWindow's main frame. The frame check alone
// only proves the sender is the top document of *its own* WebContents, so a <webview> (a separate
// WebContents) sharing the Clerk preload would still pass; requiring getType() === 'window' rejects
// <webview> guests and BrowserViews, and the frame check rejects in-page iframes.
export function isMainFrameEvent(event: IpcMainInvokeEvent): boolean {
const { sender, senderFrame } = event;
return sender.getType() === 'window' && Boolean(senderFrame) && senderFrame === sender.mainFrame;
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fine-results-crash.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/electron': patch
---

Validate that token-cache and OAuth-transport IPC requests originate from a top-level window's main frame. This prevents untrusted content in subframes or `<webview>`s that share the Clerk preload from reading the persisted client JWT or driving the OAuth transport.
54 changes: 52 additions & 2 deletions packages/electron/src/main/__tests__/create-clerk-bridge.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,11 @@ vi.mock('@clerk/electron-passkeys', () => ({
},
}));

const mainFrame = {};
const windowSender = { mainFrame, getType: () => 'window' };
const mainFrameEvent = { sender: windowSender, senderFrame: mainFrame } as unknown as Electron.IpcMainInvokeEvent;
const subframeEvent = { sender: windowSender, senderFrame: {} } as unknown as Electron.IpcMainInvokeEvent;

describe('createClerkBridge', () => {
const missingStorage = {} as Parameters<typeof createClerkBridge>[0];
const storage: TokenStorage = {
Expand DownExpand Up@@ -264,7 +269,52 @@ describe('createClerkBridge', () => {
return channel === OAUTH_TRANSPORT_CHANNELS.getRedirectUrl;
})?.[1];

expect(getRedirectUrlHandler?.({} as Electron.IpcMainInvokeEvent)).toBe('my-app://renderer/');
expect(getRedirectUrlHandler?.(mainFrameEvent)).toBe('my-app://renderer/');
});

it('rejects OAuth transport requests that do not originate from the main frame', async () => {
vi.mocked(shell.openExternal).mockResolvedValue(undefined);
createClerkBridge({
storage,
renderer: {
host: 'renderer',
scheme: 'my-app',
},
});

const findHandler = (channel: string) =>
vi.mocked(ipcMain.handle).mock.calls.find(([registered]) => registered === channel)?.[1];

expect(() => findHandler(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl)?.(subframeEvent)).toThrow('main frame');
await expect(
findHandler(OAUTH_TRANSPORT_CHANNELS.open)?.(subframeEvent, 'https://accounts.example.com/oauth'),
).rejects.toThrow('main frame');
expect(shell.openExternal).not.toHaveBeenCalled();
});

it('rejects OAuth transport requests from a <webview> whose top frame mimics the main frame', async () => {
vi.mocked(shell.openExternal).mockResolvedValue(undefined);
createClerkBridge({
storage,
renderer: {
host: 'renderer',
scheme: 'my-app',
},
});

const findHandler = (channel: string) =>
vi.mocked(ipcMain.handle).mock.calls.find(([registered]) => registered === channel)?.[1];

const webviewEvent = {
sender: { mainFrame, getType: () => 'webview' },
senderFrame: mainFrame,
} as unknown as Electron.IpcMainInvokeEvent;

expect(() => findHandler(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl)?.(webviewEvent)).toThrow('main frame');
await expect(
findHandler(OAUTH_TRANSPORT_CHANNELS.open)?.(webviewEvent, 'https://accounts.example.com/oauth'),
).rejects.toThrow('main frame');
expect(shell.openExternal).not.toHaveBeenCalled();
});

it('opens OAuth URLs externally and resolves with the matching deep-link callback URL', async () => {
Expand All@@ -280,7 +330,7 @@ describe('createClerkBridge', () => {
const openHandler = vi.mocked(ipcMain.handle).mock.calls.find(([channel]) => {
return channel === OAUTH_TRANSPORT_CHANNELS.open;
})?.[1];
const openPromise = openHandler?.({} as Electron.IpcMainInvokeEvent, 'https://accounts.example.com/oauth');
const openPromise = openHandler?.(mainFrameEvent, 'https://accounts.example.com/oauth');
const openUrlListener = vi.mocked(app.on).mock.calls.find(([event]) => event === 'open-url')?.[1] as (
event: Electron.Event,
url: string,
Expand Down
42 changes: 41 additions & 1 deletion packages/electron/src/main/__tests__/ipc-handlers.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,15 @@ import { TOKEN_CACHE_CHANNELS } from '../../shared/ipc';
import type { TokenStorage } from '../../shared/types';
import { setupTokenCacheIpcHandlers } from '../ipc-handlers';

const ipcEvent = {} as Electron.IpcMainInvokeEvent;
const mainFrame = {};
const windowSender = { mainFrame, getType: () => 'window' };
const ipcEvent = { sender: windowSender, senderFrame: mainFrame } as unknown as Electron.IpcMainInvokeEvent;
const subframeEvent = { sender: windowSender, senderFrame: {} } as unknown as Electron.IpcMainInvokeEvent;
// A <webview> is a separate WebContents whose top document satisfies senderFrame === mainFrame.
const webviewEvent = {
sender: { mainFrame, getType: () => 'webview' },
senderFrame: mainFrame,
} as unknown as Electron.IpcMainInvokeEvent;

vi.mock('electron', () => ({
ipcMain: {
Expand DownExpand Up@@ -51,6 +59,38 @@ describe('setupTokenCacheIpcHandlers', () => {
expect(storage.removeItem).toHaveBeenCalledWith('token-key');
});

it('rejects token operations that do not originate from the main frame', () => {
setupTokenCacheIpcHandlers(storage);

const getTokenHandler = vi.mocked(ipcMain.handle).mock.calls[0][1];
const saveTokenHandler = vi.mocked(ipcMain.handle).mock.calls[1][1];
const clearTokenHandler = vi.mocked(ipcMain.handle).mock.calls[2][1];

expect(() => getTokenHandler(subframeEvent, 'token-key')).toThrow('main frame');
expect(() => saveTokenHandler(subframeEvent, 'token-key', 'jwt')).toThrow('main frame');
expect(() => clearTokenHandler(subframeEvent, 'token-key')).toThrow('main frame');

expect(storage.getItem).not.toHaveBeenCalled();
expect(storage.setItem).not.toHaveBeenCalled();
expect(storage.removeItem).not.toHaveBeenCalled();
});

it('rejects token operations from a <webview> whose top frame mimics the main frame', () => {
setupTokenCacheIpcHandlers(storage);

const getTokenHandler = vi.mocked(ipcMain.handle).mock.calls[0][1];
const saveTokenHandler = vi.mocked(ipcMain.handle).mock.calls[1][1];
const clearTokenHandler = vi.mocked(ipcMain.handle).mock.calls[2][1];

expect(() => getTokenHandler(webviewEvent, 'token-key')).toThrow('main frame');
expect(() => saveTokenHandler(webviewEvent, 'token-key', 'jwt')).toThrow('main frame');
expect(() => clearTokenHandler(webviewEvent, 'token-key')).toThrow('main frame');

expect(storage.getItem).not.toHaveBeenCalled();
expect(storage.setItem).not.toHaveBeenCalled();
expect(storage.removeItem).not.toHaveBeenCalled();
});

it('removes registered handlers on cleanup', () => {
const cleanup = setupTokenCacheIpcHandlers(storage);

Expand Down
10 changes: 8 additions & 2 deletions packages/electron/src/main/__tests__/passkey-handlers.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,10 @@ const getHandler = (channel: string): Handler => {

const windowHandle = Buffer.from([1, 2, 3, 4]);
const mainFrame = {};
const event = { sender: { mainFrame }, senderFrame: mainFrame } as unknown as IpcMainInvokeEvent;
const event = {
sender: { mainFrame, getType: () => 'window' },
senderFrame: mainFrame,
} as unknown as IpcMainInvokeEvent;

const creationOptions = { challenge: 'abc', rp: { id: 'example.com', name: 'Example' } };
const registrationJSON = { id: 'cred', rawId: 'cred', type: 'public-key', response: {} };
Expand DownExpand Up@@ -98,7 +101,10 @@ describe('setupPasskeysMain', () => {
it('rejects requests that do not originate from the main frame', async () => {
setupPasskeysMain();

const subframeEvent = { sender: { mainFrame }, senderFrame: {} } as unknown as IpcMainInvokeEvent;
const subframeEvent = {
sender: { mainFrame, getType: () => 'window' },
senderFrame: {},
} as unknown as IpcMainInvokeEvent;
const result = await getHandler(PASSKEY_CHANNELS.create)(subframeEvent, creationOptions);

expect(result).toMatchObject({ ok: false, error: { code: 'unknown' } });
Expand Down
17 changes: 14 additions & 3 deletions packages/electron/src/main/ipc-handlers.ts
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,29 @@
import type { IpcMainInvokeEvent } from 'electron';
import { ipcMain } from 'electron';

import { TOKEN_CACHE_CHANNELS } from '../shared/ipc';
import type { TokenStorage } from '../shared/types';
import { isMainFrameEvent } from './validate-sender';

function assertMainFrameSender(event: IpcMainInvokeEvent): void {
if (!isMainFrameEvent(event)) {
throw new Error("Clerk: token-cache request did not originate from a window's main frame.");
}
}

export function setupTokenCacheIpcHandlers(storage: TokenStorage): () => void {
ipcMain.handle(TOKEN_CACHE_CHANNELS.getToken, (_event, key: string) => {
ipcMain.handle(TOKEN_CACHE_CHANNELS.getToken, (event, key: string) => {
assertMainFrameSender(event);
return storage.getItem(key);
});

ipcMain.handle(TOKEN_CACHE_CHANNELS.saveToken, (_event, key: string, value: string) => {
ipcMain.handle(TOKEN_CACHE_CHANNELS.saveToken, (event, key: string, value: string) => {
assertMainFrameSender(event);
return storage.setItem(key, value);
});

ipcMain.handle(TOKEN_CACHE_CHANNELS.clearToken, (_event, key: string) => {
ipcMain.handle(TOKEN_CACHE_CHANNELS.clearToken, (event, key: string) => {
assertMainFrameSender(event);
return storage.removeItem(key);
});

Expand Down
12 changes: 10 additions & 2 deletions packages/electron/src/main/oauth-transport.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { app, ipcMain, shell } from 'electron';

import { OAUTH_TRANSPORT_CHANNELS } from '../shared/ipc';
import type { RendererSchemeOptions } from '../shared/types';
import { isMainFrameEvent } from './validate-sender';

const CALLBACK_TIMEOUT_MS = 3 * 60 * 1000;

Expand DownExpand Up@@ -91,11 +92,18 @@ export function setupOAuthTransportIpcHandlers(options: OAuthTransportOptions):
app.on('open-url', openUrlListener);
app.on('second-instance', secondInstanceListener);

ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl, () => {
ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl, event => {
if (!isMainFrameEvent(event)) {
throw new Error("Clerk: OAuth request did not originate from a window's main frame.");
}
return redirectUrl;
});

ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.open, async (_event, url: string) => {
ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.open, async (event, url: string) => {
if (!isMainFrameEvent(event)) {
throw new Error("Clerk: OAuth request did not originate from a window's main frame.");
}

if (pendingOAuthFlow) {
throw new Error('Clerk: an OAuth flow is already pending.');
}
Expand Down
3 changes: 2 additions & 1 deletion packages/electron/src/main/passkey-handlers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import type {
SerializedPublicKeyCredentialRequestOptions,
SetupPasskeysMainReturn,
} from '../shared/types';
import { isMainFrameEvent } from './validate-sender';

/**
* Optional native module. Ceremony failures resolve as JSON envelopes so error
Expand DownExpand Up@@ -77,7 +78,7 @@ async function invokeNative<T>(

// Subframes and webviews can host third-party content that must not be able
// to run credential ceremonies for the app's RP ID.
if (!event.senderFrame || event.senderFrame !== event.sender.mainFrame) {
if (!isMainFrameEvent(event)) {
return {
ok: false,
error: { code: 'unknown', message: "The passkey request did not originate from a window's main frame." },
Expand Down
10 changes: 10 additions & 0 deletions packages/electron/src/main/validate-sender.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import type { IpcMainInvokeEvent } from 'electron';

// Restricts privileged IPC to a top-level BrowserWindow's main frame. The frame check alone
// only proves the sender is the top document of *its own* WebContents, so a <webview> (a separate
// WebContents) sharing the Clerk preload would still pass; requiring getType() === 'window' rejects
// <webview> guests and BrowserViews, and the frame check rejects in-page iframes.
export function isMainFrameEvent(event: IpcMainInvokeEvent): boolean {
const { sender, senderFrame } = event;
return sender.getType() === 'window' && Boolean(senderFrame) && senderFrame === sender.mainFrame;
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fine-results-crash.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/electron': patch
---

Validate that token-cache and OAuth-transport IPC requests originate from a top-level window's main frame. This prevents untrusted content in subframes or `<webview>`s that share the Clerk preload from reading the persisted client JWT or driving the OAuth transport.
54 changes: 52 additions & 2 deletions packages/electron/src/main/__tests__/create-clerk-bridge.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,11 @@ vi.mock('@clerk/electron-passkeys', () => ({
},
}));

const mainFrame = {};
const windowSender = { mainFrame, getType: () => 'window' };
const mainFrameEvent = { sender: windowSender, senderFrame: mainFrame } as unknown as Electron.IpcMainInvokeEvent;
const subframeEvent = { sender: windowSender, senderFrame: {} } as unknown as Electron.IpcMainInvokeEvent;

describe('createClerkBridge', () => {
const missingStorage = {} as Parameters<typeof createClerkBridge>[0];
const storage: TokenStorage = {
Expand DownExpand Up@@ -264,7 +269,52 @@ describe('createClerkBridge', () => {
return channel === OAUTH_TRANSPORT_CHANNELS.getRedirectUrl;
})?.[1];

expect(getRedirectUrlHandler?.({} as Electron.IpcMainInvokeEvent)).toBe('my-app://renderer/');
expect(getRedirectUrlHandler?.(mainFrameEvent)).toBe('my-app://renderer/');
});

it('rejects OAuth transport requests that do not originate from the main frame', async () => {
vi.mocked(shell.openExternal).mockResolvedValue(undefined);
createClerkBridge({
storage,
renderer: {
host: 'renderer',
scheme: 'my-app',
},
});

const findHandler = (channel: string) =>
vi.mocked(ipcMain.handle).mock.calls.find(([registered]) => registered === channel)?.[1];

expect(() => findHandler(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl)?.(subframeEvent)).toThrow('main frame');
await expect(
findHandler(OAUTH_TRANSPORT_CHANNELS.open)?.(subframeEvent, 'https://accounts.example.com/oauth'),
).rejects.toThrow('main frame');
expect(shell.openExternal).not.toHaveBeenCalled();
});

it('rejects OAuth transport requests from a <webview> whose top frame mimics the main frame', async () => {
vi.mocked(shell.openExternal).mockResolvedValue(undefined);
createClerkBridge({
storage,
renderer: {
host: 'renderer',
scheme: 'my-app',
},
});

const findHandler = (channel: string) =>
vi.mocked(ipcMain.handle).mock.calls.find(([registered]) => registered === channel)?.[1];

const webviewEvent = {
sender: { mainFrame, getType: () => 'webview' },
senderFrame: mainFrame,
} as unknown as Electron.IpcMainInvokeEvent;

expect(() => findHandler(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl)?.(webviewEvent)).toThrow('main frame');
await expect(
findHandler(OAUTH_TRANSPORT_CHANNELS.open)?.(webviewEvent, 'https://accounts.example.com/oauth'),
).rejects.toThrow('main frame');
expect(shell.openExternal).not.toHaveBeenCalled();
});

it('opens OAuth URLs externally and resolves with the matching deep-link callback URL', async () => {
Expand All@@ -280,7 +330,7 @@ describe('createClerkBridge', () => {
const openHandler = vi.mocked(ipcMain.handle).mock.calls.find(([channel]) => {
return channel === OAUTH_TRANSPORT_CHANNELS.open;
})?.[1];
const openPromise = openHandler?.({} as Electron.IpcMainInvokeEvent, 'https://accounts.example.com/oauth');
const openPromise = openHandler?.(mainFrameEvent, 'https://accounts.example.com/oauth');
const openUrlListener = vi.mocked(app.on).mock.calls.find(([event]) => event === 'open-url')?.[1] as (
event: Electron.Event,
url: string,
Expand Down
42 changes: 41 additions & 1 deletion packages/electron/src/main/__tests__/ipc-handlers.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,15 @@ import { TOKEN_CACHE_CHANNELS } from '../../shared/ipc';
import type { TokenStorage } from '../../shared/types';
import { setupTokenCacheIpcHandlers } from '../ipc-handlers';

const ipcEvent = {} as Electron.IpcMainInvokeEvent;
const mainFrame = {};
const windowSender = { mainFrame, getType: () => 'window' };
const ipcEvent = { sender: windowSender, senderFrame: mainFrame } as unknown as Electron.IpcMainInvokeEvent;
const subframeEvent = { sender: windowSender, senderFrame: {} } as unknown as Electron.IpcMainInvokeEvent;
// A <webview> is a separate WebContents whose top document satisfies senderFrame === mainFrame.
const webviewEvent = {
sender: { mainFrame, getType: () => 'webview' },
senderFrame: mainFrame,
} as unknown as Electron.IpcMainInvokeEvent;

vi.mock('electron', () => ({
ipcMain: {
Expand DownExpand Up@@ -51,6 +59,38 @@ describe('setupTokenCacheIpcHandlers', () => {
expect(storage.removeItem).toHaveBeenCalledWith('token-key');
});

it('rejects token operations that do not originate from the main frame', () => {
setupTokenCacheIpcHandlers(storage);

const getTokenHandler = vi.mocked(ipcMain.handle).mock.calls[0][1];
const saveTokenHandler = vi.mocked(ipcMain.handle).mock.calls[1][1];
const clearTokenHandler = vi.mocked(ipcMain.handle).mock.calls[2][1];

expect(() => getTokenHandler(subframeEvent, 'token-key')).toThrow('main frame');
expect(() => saveTokenHandler(subframeEvent, 'token-key', 'jwt')).toThrow('main frame');
expect(() => clearTokenHandler(subframeEvent, 'token-key')).toThrow('main frame');

expect(storage.getItem).not.toHaveBeenCalled();
expect(storage.setItem).not.toHaveBeenCalled();
expect(storage.removeItem).not.toHaveBeenCalled();
});

it('rejects token operations from a <webview> whose top frame mimics the main frame', () => {
setupTokenCacheIpcHandlers(storage);

const getTokenHandler = vi.mocked(ipcMain.handle).mock.calls[0][1];
const saveTokenHandler = vi.mocked(ipcMain.handle).mock.calls[1][1];
const clearTokenHandler = vi.mocked(ipcMain.handle).mock.calls[2][1];

expect(() => getTokenHandler(webviewEvent, 'token-key')).toThrow('main frame');
expect(() => saveTokenHandler(webviewEvent, 'token-key', 'jwt')).toThrow('main frame');
expect(() => clearTokenHandler(webviewEvent, 'token-key')).toThrow('main frame');

expect(storage.getItem).not.toHaveBeenCalled();
expect(storage.setItem).not.toHaveBeenCalled();
expect(storage.removeItem).not.toHaveBeenCalled();
});

it('removes registered handlers on cleanup', () => {
const cleanup = setupTokenCacheIpcHandlers(storage);

Expand Down
10 changes: 8 additions & 2 deletions packages/electron/src/main/__tests__/passkey-handlers.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,10 @@ const getHandler = (channel: string): Handler => {

const windowHandle = Buffer.from([1, 2, 3, 4]);
const mainFrame = {};
const event = { sender: { mainFrame }, senderFrame: mainFrame } as unknown as IpcMainInvokeEvent;
const event = {
sender: { mainFrame, getType: () => 'window' },
senderFrame: mainFrame,
} as unknown as IpcMainInvokeEvent;

const creationOptions = { challenge: 'abc', rp: { id: 'example.com', name: 'Example' } };
const registrationJSON = { id: 'cred', rawId: 'cred', type: 'public-key', response: {} };
Expand DownExpand Up@@ -98,7 +101,10 @@ describe('setupPasskeysMain', () => {
it('rejects requests that do not originate from the main frame', async () => {
setupPasskeysMain();

const subframeEvent = { sender: { mainFrame }, senderFrame: {} } as unknown as IpcMainInvokeEvent;
const subframeEvent = {
sender: { mainFrame, getType: () => 'window' },
senderFrame: {},
} as unknown as IpcMainInvokeEvent;
const result = await getHandler(PASSKEY_CHANNELS.create)(subframeEvent, creationOptions);

expect(result).toMatchObject({ ok: false, error: { code: 'unknown' } });
Expand Down
17 changes: 14 additions & 3 deletions packages/electron/src/main/ipc-handlers.ts
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,29 @@
import type { IpcMainInvokeEvent } from 'electron';
import { ipcMain } from 'electron';

import { TOKEN_CACHE_CHANNELS } from '../shared/ipc';
import type { TokenStorage } from '../shared/types';
import { isMainFrameEvent } from './validate-sender';

function assertMainFrameSender(event: IpcMainInvokeEvent): void {
if (!isMainFrameEvent(event)) {
throw new Error("Clerk: token-cache request did not originate from a window's main frame.");
}
}

export function setupTokenCacheIpcHandlers(storage: TokenStorage): () => void {
ipcMain.handle(TOKEN_CACHE_CHANNELS.getToken, (_event, key: string) => {
ipcMain.handle(TOKEN_CACHE_CHANNELS.getToken, (event, key: string) => {
assertMainFrameSender(event);
return storage.getItem(key);
});

ipcMain.handle(TOKEN_CACHE_CHANNELS.saveToken, (_event, key: string, value: string) => {
ipcMain.handle(TOKEN_CACHE_CHANNELS.saveToken, (event, key: string, value: string) => {
assertMainFrameSender(event);
return storage.setItem(key, value);
});

ipcMain.handle(TOKEN_CACHE_CHANNELS.clearToken, (_event, key: string) => {
ipcMain.handle(TOKEN_CACHE_CHANNELS.clearToken, (event, key: string) => {
assertMainFrameSender(event);
return storage.removeItem(key);
});

Expand Down
12 changes: 10 additions & 2 deletions packages/electron/src/main/oauth-transport.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { app, ipcMain, shell } from 'electron';

import { OAUTH_TRANSPORT_CHANNELS } from '../shared/ipc';
import type { RendererSchemeOptions } from '../shared/types';
import { isMainFrameEvent } from './validate-sender';

const CALLBACK_TIMEOUT_MS = 3 * 60 * 1000;

Expand DownExpand Up@@ -91,11 +92,18 @@ export function setupOAuthTransportIpcHandlers(options: OAuthTransportOptions):
app.on('open-url', openUrlListener);
app.on('second-instance', secondInstanceListener);

ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl, () => {
ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl, event => {
if (!isMainFrameEvent(event)) {
throw new Error("Clerk: OAuth request did not originate from a window's main frame.");
}
return redirectUrl;
});

ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.open, async (_event, url: string) => {
ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.open, async (event, url: string) => {
if (!isMainFrameEvent(event)) {
throw new Error("Clerk: OAuth request did not originate from a window's main frame.");
}

if (pendingOAuthFlow) {
throw new Error('Clerk: an OAuth flow is already pending.');
}
Expand Down
3 changes: 2 additions & 1 deletion packages/electron/src/main/passkey-handlers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import type {
SerializedPublicKeyCredentialRequestOptions,
SetupPasskeysMainReturn,
} from '../shared/types';
import { isMainFrameEvent } from './validate-sender';

/**
* Optional native module. Ceremony failures resolve as JSON envelopes so error
Expand DownExpand Up@@ -77,7 +78,7 @@ async function invokeNative<T>(

// Subframes and webviews can host third-party content that must not be able
// to run credential ceremonies for the app's RP ID.
if (!event.senderFrame || event.senderFrame !== event.sender.mainFrame) {
if (!isMainFrameEvent(event)) {
return {
ok: false,
error: { code: 'unknown', message: "The passkey request did not originate from a window's main frame." },
Expand Down
10 changes: 10 additions & 0 deletions packages/electron/src/main/validate-sender.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import type { IpcMainInvokeEvent } from 'electron';

// Restricts privileged IPC to a top-level BrowserWindow's main frame. The frame check alone
// only proves the sender is the top document of *its own* WebContents, so a <webview> (a separate
// WebContents) sharing the Clerk preload would still pass; requiring getType() === 'window' rejects
// <webview> guests and BrowserViews, and the frame check rejects in-page iframes.
export function isMainFrameEvent(event: IpcMainInvokeEvent): boolean {
const { sender, senderFrame } = event;
return sender.getType() === 'window' && Boolean(senderFrame) && senderFrame === sender.mainFrame;
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fine-results-crash.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/electron': patch
---

Validate that token-cache and OAuth-transport IPC requests originate from a top-level window's main frame. This prevents untrusted content in subframes or `<webview>`s that share the Clerk preload from reading the persisted client JWT or driving the OAuth transport.
54 changes: 52 additions & 2 deletions packages/electron/src/main/__tests__/create-clerk-bridge.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,11 @@ vi.mock('@clerk/electron-passkeys', () => ({
},
}));

const mainFrame = {};
const windowSender = { mainFrame, getType: () => 'window' };
const mainFrameEvent = { sender: windowSender, senderFrame: mainFrame } as unknown as Electron.IpcMainInvokeEvent;
const subframeEvent = { sender: windowSender, senderFrame: {} } as unknown as Electron.IpcMainInvokeEvent;

describe('createClerkBridge', () => {
const missingStorage = {} as Parameters<typeof createClerkBridge>[0];
const storage: TokenStorage = {
Expand DownExpand Up@@ -264,7 +269,52 @@ describe('createClerkBridge', () => {
return channel === OAUTH_TRANSPORT_CHANNELS.getRedirectUrl;
})?.[1];

expect(getRedirectUrlHandler?.({} as Electron.IpcMainInvokeEvent)).toBe('my-app://renderer/');
expect(getRedirectUrlHandler?.(mainFrameEvent)).toBe('my-app://renderer/');
});

it('rejects OAuth transport requests that do not originate from the main frame', async () => {
vi.mocked(shell.openExternal).mockResolvedValue(undefined);
createClerkBridge({
storage,
renderer: {
host: 'renderer',
scheme: 'my-app',
},
});

const findHandler = (channel: string) =>
vi.mocked(ipcMain.handle).mock.calls.find(([registered]) => registered === channel)?.[1];

expect(() => findHandler(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl)?.(subframeEvent)).toThrow('main frame');
await expect(
findHandler(OAUTH_TRANSPORT_CHANNELS.open)?.(subframeEvent, 'https://accounts.example.com/oauth'),
).rejects.toThrow('main frame');
expect(shell.openExternal).not.toHaveBeenCalled();
});

it('rejects OAuth transport requests from a <webview> whose top frame mimics the main frame', async () => {
vi.mocked(shell.openExternal).mockResolvedValue(undefined);
createClerkBridge({
storage,
renderer: {
host: 'renderer',
scheme: 'my-app',
},
});

const findHandler = (channel: string) =>
vi.mocked(ipcMain.handle).mock.calls.find(([registered]) => registered === channel)?.[1];

const webviewEvent = {
sender: { mainFrame, getType: () => 'webview' },
senderFrame: mainFrame,
} as unknown as Electron.IpcMainInvokeEvent;

expect(() => findHandler(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl)?.(webviewEvent)).toThrow('main frame');
await expect(
findHandler(OAUTH_TRANSPORT_CHANNELS.open)?.(webviewEvent, 'https://accounts.example.com/oauth'),
).rejects.toThrow('main frame');
expect(shell.openExternal).not.toHaveBeenCalled();
});

it('opens OAuth URLs externally and resolves with the matching deep-link callback URL', async () => {
Expand All@@ -280,7 +330,7 @@ describe('createClerkBridge', () => {
const openHandler = vi.mocked(ipcMain.handle).mock.calls.find(([channel]) => {
return channel === OAUTH_TRANSPORT_CHANNELS.open;
})?.[1];
const openPromise = openHandler?.({} as Electron.IpcMainInvokeEvent, 'https://accounts.example.com/oauth');
const openPromise = openHandler?.(mainFrameEvent, 'https://accounts.example.com/oauth');
const openUrlListener = vi.mocked(app.on).mock.calls.find(([event]) => event === 'open-url')?.[1] as (
event: Electron.Event,
url: string,
Expand Down
42 changes: 41 additions & 1 deletion packages/electron/src/main/__tests__/ipc-handlers.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,15 @@ import { TOKEN_CACHE_CHANNELS } from '../../shared/ipc';
import type { TokenStorage } from '../../shared/types';
import { setupTokenCacheIpcHandlers } from '../ipc-handlers';

const ipcEvent = {} as Electron.IpcMainInvokeEvent;
const mainFrame = {};
const windowSender = { mainFrame, getType: () => 'window' };
const ipcEvent = { sender: windowSender, senderFrame: mainFrame } as unknown as Electron.IpcMainInvokeEvent;
const subframeEvent = { sender: windowSender, senderFrame: {} } as unknown as Electron.IpcMainInvokeEvent;
// A <webview> is a separate WebContents whose top document satisfies senderFrame === mainFrame.
const webviewEvent = {
sender: { mainFrame, getType: () => 'webview' },
senderFrame: mainFrame,
} as unknown as Electron.IpcMainInvokeEvent;

vi.mock('electron', () => ({
ipcMain: {
Expand DownExpand Up@@ -51,6 +59,38 @@ describe('setupTokenCacheIpcHandlers', () => {
expect(storage.removeItem).toHaveBeenCalledWith('token-key');
});

it('rejects token operations that do not originate from the main frame', () => {
setupTokenCacheIpcHandlers(storage);

const getTokenHandler = vi.mocked(ipcMain.handle).mock.calls[0][1];
const saveTokenHandler = vi.mocked(ipcMain.handle).mock.calls[1][1];
const clearTokenHandler = vi.mocked(ipcMain.handle).mock.calls[2][1];

expect(() => getTokenHandler(subframeEvent, 'token-key')).toThrow('main frame');
expect(() => saveTokenHandler(subframeEvent, 'token-key', 'jwt')).toThrow('main frame');
expect(() => clearTokenHandler(subframeEvent, 'token-key')).toThrow('main frame');

expect(storage.getItem).not.toHaveBeenCalled();
expect(storage.setItem).not.toHaveBeenCalled();
expect(storage.removeItem).not.toHaveBeenCalled();
});

it('rejects token operations from a <webview> whose top frame mimics the main frame', () => {
setupTokenCacheIpcHandlers(storage);

const getTokenHandler = vi.mocked(ipcMain.handle).mock.calls[0][1];
const saveTokenHandler = vi.mocked(ipcMain.handle).mock.calls[1][1];
const clearTokenHandler = vi.mocked(ipcMain.handle).mock.calls[2][1];

expect(() => getTokenHandler(webviewEvent, 'token-key')).toThrow('main frame');
expect(() => saveTokenHandler(webviewEvent, 'token-key', 'jwt')).toThrow('main frame');
expect(() => clearTokenHandler(webviewEvent, 'token-key')).toThrow('main frame');

expect(storage.getItem).not.toHaveBeenCalled();
expect(storage.setItem).not.toHaveBeenCalled();
expect(storage.removeItem).not.toHaveBeenCalled();
});

it('removes registered handlers on cleanup', () => {
const cleanup = setupTokenCacheIpcHandlers(storage);

Expand Down
10 changes: 8 additions & 2 deletions packages/electron/src/main/__tests__/passkey-handlers.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,10 @@ const getHandler = (channel: string): Handler => {

const windowHandle = Buffer.from([1, 2, 3, 4]);
const mainFrame = {};
const event = { sender: { mainFrame }, senderFrame: mainFrame } as unknown as IpcMainInvokeEvent;
const event = {
sender: { mainFrame, getType: () => 'window' },
senderFrame: mainFrame,
} as unknown as IpcMainInvokeEvent;

const creationOptions = { challenge: 'abc', rp: { id: 'example.com', name: 'Example' } };
const registrationJSON = { id: 'cred', rawId: 'cred', type: 'public-key', response: {} };
Expand DownExpand Up@@ -98,7 +101,10 @@ describe('setupPasskeysMain', () => {
it('rejects requests that do not originate from the main frame', async () => {
setupPasskeysMain();

const subframeEvent = { sender: { mainFrame }, senderFrame: {} } as unknown as IpcMainInvokeEvent;
const subframeEvent = {
sender: { mainFrame, getType: () => 'window' },
senderFrame: {},
} as unknown as IpcMainInvokeEvent;
const result = await getHandler(PASSKEY_CHANNELS.create)(subframeEvent, creationOptions);

expect(result).toMatchObject({ ok: false, error: { code: 'unknown' } });
Expand Down
17 changes: 14 additions & 3 deletions packages/electron/src/main/ipc-handlers.ts
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,29 @@
import type { IpcMainInvokeEvent } from 'electron';
import { ipcMain } from 'electron';

import { TOKEN_CACHE_CHANNELS } from '../shared/ipc';
import type { TokenStorage } from '../shared/types';
import { isMainFrameEvent } from './validate-sender';

function assertMainFrameSender(event: IpcMainInvokeEvent): void {
if (!isMainFrameEvent(event)) {
throw new Error("Clerk: token-cache request did not originate from a window's main frame.");
}
}

export function setupTokenCacheIpcHandlers(storage: TokenStorage): () => void {
ipcMain.handle(TOKEN_CACHE_CHANNELS.getToken, (_event, key: string) => {
ipcMain.handle(TOKEN_CACHE_CHANNELS.getToken, (event, key: string) => {
assertMainFrameSender(event);
return storage.getItem(key);
});

ipcMain.handle(TOKEN_CACHE_CHANNELS.saveToken, (_event, key: string, value: string) => {
ipcMain.handle(TOKEN_CACHE_CHANNELS.saveToken, (event, key: string, value: string) => {
assertMainFrameSender(event);
return storage.setItem(key, value);
});

ipcMain.handle(TOKEN_CACHE_CHANNELS.clearToken, (_event, key: string) => {
ipcMain.handle(TOKEN_CACHE_CHANNELS.clearToken, (event, key: string) => {
assertMainFrameSender(event);
return storage.removeItem(key);
});

Expand Down
12 changes: 10 additions & 2 deletions packages/electron/src/main/oauth-transport.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { app, ipcMain, shell } from 'electron';

import { OAUTH_TRANSPORT_CHANNELS } from '../shared/ipc';
import type { RendererSchemeOptions } from '../shared/types';
import { isMainFrameEvent } from './validate-sender';

const CALLBACK_TIMEOUT_MS = 3 * 60 * 1000;

Expand DownExpand Up@@ -91,11 +92,18 @@ export function setupOAuthTransportIpcHandlers(options: OAuthTransportOptions):
app.on('open-url', openUrlListener);
app.on('second-instance', secondInstanceListener);

ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl, () => {
ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl, event => {
if (!isMainFrameEvent(event)) {
throw new Error("Clerk: OAuth request did not originate from a window's main frame.");
}
return redirectUrl;
});

ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.open, async (_event, url: string) => {
ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.open, async (event, url: string) => {
if (!isMainFrameEvent(event)) {
throw new Error("Clerk: OAuth request did not originate from a window's main frame.");
}

if (pendingOAuthFlow) {
throw new Error('Clerk: an OAuth flow is already pending.');
}
Expand Down
3 changes: 2 additions & 1 deletion packages/electron/src/main/passkey-handlers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import type {
SerializedPublicKeyCredentialRequestOptions,
SetupPasskeysMainReturn,
} from '../shared/types';
import { isMainFrameEvent } from './validate-sender';

/**
* Optional native module. Ceremony failures resolve as JSON envelopes so error
Expand DownExpand Up@@ -77,7 +78,7 @@ async function invokeNative<T>(

// Subframes and webviews can host third-party content that must not be able
// to run credential ceremonies for the app's RP ID.
if (!event.senderFrame || event.senderFrame !== event.sender.mainFrame) {
if (!isMainFrameEvent(event)) {
return {
ok: false,
error: { code: 'unknown', message: "The passkey request did not originate from a window's main frame." },
Expand Down
10 changes: 10 additions & 0 deletions packages/electron/src/main/validate-sender.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import type { IpcMainInvokeEvent } from 'electron';

// Restricts privileged IPC to a top-level BrowserWindow's main frame. The frame check alone
// only proves the sender is the top document of *its own* WebContents, so a <webview> (a separate
// WebContents) sharing the Clerk preload would still pass; requiring getType() === 'window' rejects
// <webview> guests and BrowserViews, and the frame check rejects in-page iframes.
export function isMainFrameEvent(event: IpcMainInvokeEvent): boolean {
const { sender, senderFrame } = event;
return sender.getType() === 'window' && Boolean(senderFrame) && senderFrame === sender.mainFrame;
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fine-results-crash.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/electron': patch
---

Validate that token-cache and OAuth-transport IPC requests originate from a top-level window's main frame. This prevents untrusted content in subframes or `<webview>`s that share the Clerk preload from reading the persisted client JWT or driving the OAuth transport.
54 changes: 52 additions & 2 deletions packages/electron/src/main/__tests__/create-clerk-bridge.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,11 @@ vi.mock('@clerk/electron-passkeys', () => ({
},
}));

const mainFrame = {};
const windowSender = { mainFrame, getType: () => 'window' };
const mainFrameEvent = { sender: windowSender, senderFrame: mainFrame } as unknown as Electron.IpcMainInvokeEvent;
const subframeEvent = { sender: windowSender, senderFrame: {} } as unknown as Electron.IpcMainInvokeEvent;

describe('createClerkBridge', () => {
const missingStorage = {} as Parameters<typeof createClerkBridge>[0];
const storage: TokenStorage = {
Expand DownExpand Up@@ -264,7 +269,52 @@ describe('createClerkBridge', () => {
return channel === OAUTH_TRANSPORT_CHANNELS.getRedirectUrl;
})?.[1];

expect(getRedirectUrlHandler?.({} as Electron.IpcMainInvokeEvent)).toBe('my-app://renderer/');
expect(getRedirectUrlHandler?.(mainFrameEvent)).toBe('my-app://renderer/');
});

it('rejects OAuth transport requests that do not originate from the main frame', async () => {
vi.mocked(shell.openExternal).mockResolvedValue(undefined);
createClerkBridge({
storage,
renderer: {
host: 'renderer',
scheme: 'my-app',
},
});

const findHandler = (channel: string) =>
vi.mocked(ipcMain.handle).mock.calls.find(([registered]) => registered === channel)?.[1];

expect(() => findHandler(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl)?.(subframeEvent)).toThrow('main frame');
await expect(
findHandler(OAUTH_TRANSPORT_CHANNELS.open)?.(subframeEvent, 'https://accounts.example.com/oauth'),
).rejects.toThrow('main frame');
expect(shell.openExternal).not.toHaveBeenCalled();
});

it('rejects OAuth transport requests from a <webview> whose top frame mimics the main frame', async () => {
vi.mocked(shell.openExternal).mockResolvedValue(undefined);
createClerkBridge({
storage,
renderer: {
host: 'renderer',
scheme: 'my-app',
},
});

const findHandler = (channel: string) =>
vi.mocked(ipcMain.handle).mock.calls.find(([registered]) => registered === channel)?.[1];

const webviewEvent = {
sender: { mainFrame, getType: () => 'webview' },
senderFrame: mainFrame,
} as unknown as Electron.IpcMainInvokeEvent;

expect(() => findHandler(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl)?.(webviewEvent)).toThrow('main frame');
await expect(
findHandler(OAUTH_TRANSPORT_CHANNELS.open)?.(webviewEvent, 'https://accounts.example.com/oauth'),
).rejects.toThrow('main frame');
expect(shell.openExternal).not.toHaveBeenCalled();
});

it('opens OAuth URLs externally and resolves with the matching deep-link callback URL', async () => {
Expand All@@ -280,7 +330,7 @@ describe('createClerkBridge', () => {
const openHandler = vi.mocked(ipcMain.handle).mock.calls.find(([channel]) => {
return channel === OAUTH_TRANSPORT_CHANNELS.open;
})?.[1];
const openPromise = openHandler?.({} as Electron.IpcMainInvokeEvent, 'https://accounts.example.com/oauth');
const openPromise = openHandler?.(mainFrameEvent, 'https://accounts.example.com/oauth');
const openUrlListener = vi.mocked(app.on).mock.calls.find(([event]) => event === 'open-url')?.[1] as (
event: Electron.Event,
url: string,
Expand Down
42 changes: 41 additions & 1 deletion packages/electron/src/main/__tests__/ipc-handlers.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,15 @@ import { TOKEN_CACHE_CHANNELS } from '../../shared/ipc';
import type { TokenStorage } from '../../shared/types';
import { setupTokenCacheIpcHandlers } from '../ipc-handlers';

const ipcEvent = {} as Electron.IpcMainInvokeEvent;
const mainFrame = {};
const windowSender = { mainFrame, getType: () => 'window' };
const ipcEvent = { sender: windowSender, senderFrame: mainFrame } as unknown as Electron.IpcMainInvokeEvent;
const subframeEvent = { sender: windowSender, senderFrame: {} } as unknown as Electron.IpcMainInvokeEvent;
// A <webview> is a separate WebContents whose top document satisfies senderFrame === mainFrame.
const webviewEvent = {
sender: { mainFrame, getType: () => 'webview' },
senderFrame: mainFrame,
} as unknown as Electron.IpcMainInvokeEvent;

vi.mock('electron', () => ({
ipcMain: {
Expand DownExpand Up@@ -51,6 +59,38 @@ describe('setupTokenCacheIpcHandlers', () => {
expect(storage.removeItem).toHaveBeenCalledWith('token-key');
});

it('rejects token operations that do not originate from the main frame', () => {
setupTokenCacheIpcHandlers(storage);

const getTokenHandler = vi.mocked(ipcMain.handle).mock.calls[0][1];
const saveTokenHandler = vi.mocked(ipcMain.handle).mock.calls[1][1];
const clearTokenHandler = vi.mocked(ipcMain.handle).mock.calls[2][1];

expect(() => getTokenHandler(subframeEvent, 'token-key')).toThrow('main frame');
expect(() => saveTokenHandler(subframeEvent, 'token-key', 'jwt')).toThrow('main frame');
expect(() => clearTokenHandler(subframeEvent, 'token-key')).toThrow('main frame');

expect(storage.getItem).not.toHaveBeenCalled();
expect(storage.setItem).not.toHaveBeenCalled();
expect(storage.removeItem).not.toHaveBeenCalled();
});

it('rejects token operations from a <webview> whose top frame mimics the main frame', () => {
setupTokenCacheIpcHandlers(storage);

const getTokenHandler = vi.mocked(ipcMain.handle).mock.calls[0][1];
const saveTokenHandler = vi.mocked(ipcMain.handle).mock.calls[1][1];
const clearTokenHandler = vi.mocked(ipcMain.handle).mock.calls[2][1];

expect(() => getTokenHandler(webviewEvent, 'token-key')).toThrow('main frame');
expect(() => saveTokenHandler(webviewEvent, 'token-key', 'jwt')).toThrow('main frame');
expect(() => clearTokenHandler(webviewEvent, 'token-key')).toThrow('main frame');

expect(storage.getItem).not.toHaveBeenCalled();
expect(storage.setItem).not.toHaveBeenCalled();
expect(storage.removeItem).not.toHaveBeenCalled();
});

it('removes registered handlers on cleanup', () => {
const cleanup = setupTokenCacheIpcHandlers(storage);

Expand Down
10 changes: 8 additions & 2 deletions packages/electron/src/main/__tests__/passkey-handlers.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,10 @@ const getHandler = (channel: string): Handler => {

const windowHandle = Buffer.from([1, 2, 3, 4]);
const mainFrame = {};
const event = { sender: { mainFrame }, senderFrame: mainFrame } as unknown as IpcMainInvokeEvent;
const event = {
sender: { mainFrame, getType: () => 'window' },
senderFrame: mainFrame,
} as unknown as IpcMainInvokeEvent;

const creationOptions = { challenge: 'abc', rp: { id: 'example.com', name: 'Example' } };
const registrationJSON = { id: 'cred', rawId: 'cred', type: 'public-key', response: {} };
Expand DownExpand Up@@ -98,7 +101,10 @@ describe('setupPasskeysMain', () => {
it('rejects requests that do not originate from the main frame', async () => {
setupPasskeysMain();

const subframeEvent = { sender: { mainFrame }, senderFrame: {} } as unknown as IpcMainInvokeEvent;
const subframeEvent = {
sender: { mainFrame, getType: () => 'window' },
senderFrame: {},
} as unknown as IpcMainInvokeEvent;
const result = await getHandler(PASSKEY_CHANNELS.create)(subframeEvent, creationOptions);

expect(result).toMatchObject({ ok: false, error: { code: 'unknown' } });
Expand Down
17 changes: 14 additions & 3 deletions packages/electron/src/main/ipc-handlers.ts
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,29 @@
import type { IpcMainInvokeEvent } from 'electron';
import { ipcMain } from 'electron';

import { TOKEN_CACHE_CHANNELS } from '../shared/ipc';
import type { TokenStorage } from '../shared/types';
import { isMainFrameEvent } from './validate-sender';

function assertMainFrameSender(event: IpcMainInvokeEvent): void {
if (!isMainFrameEvent(event)) {
throw new Error("Clerk: token-cache request did not originate from a window's main frame.");
}
}

export function setupTokenCacheIpcHandlers(storage: TokenStorage): () => void {
ipcMain.handle(TOKEN_CACHE_CHANNELS.getToken, (_event, key: string) => {
ipcMain.handle(TOKEN_CACHE_CHANNELS.getToken, (event, key: string) => {
assertMainFrameSender(event);
return storage.getItem(key);
});

ipcMain.handle(TOKEN_CACHE_CHANNELS.saveToken, (_event, key: string, value: string) => {
ipcMain.handle(TOKEN_CACHE_CHANNELS.saveToken, (event, key: string, value: string) => {
assertMainFrameSender(event);
return storage.setItem(key, value);
});

ipcMain.handle(TOKEN_CACHE_CHANNELS.clearToken, (_event, key: string) => {
ipcMain.handle(TOKEN_CACHE_CHANNELS.clearToken, (event, key: string) => {
assertMainFrameSender(event);
return storage.removeItem(key);
});

Expand Down
12 changes: 10 additions & 2 deletions packages/electron/src/main/oauth-transport.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { app, ipcMain, shell } from 'electron';

import { OAUTH_TRANSPORT_CHANNELS } from '../shared/ipc';
import type { RendererSchemeOptions } from '../shared/types';
import { isMainFrameEvent } from './validate-sender';

const CALLBACK_TIMEOUT_MS = 3 * 60 * 1000;

Expand DownExpand Up@@ -91,11 +92,18 @@ export function setupOAuthTransportIpcHandlers(options: OAuthTransportOptions):
app.on('open-url', openUrlListener);
app.on('second-instance', secondInstanceListener);

ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl, () => {
ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.getRedirectUrl, event => {
if (!isMainFrameEvent(event)) {
throw new Error("Clerk: OAuth request did not originate from a window's main frame.");
}
return redirectUrl;
});

ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.open, async (_event, url: string) => {
ipcMain.handle(OAUTH_TRANSPORT_CHANNELS.open, async (event, url: string) => {
if (!isMainFrameEvent(event)) {
throw new Error("Clerk: OAuth request did not originate from a window's main frame.");
}

if (pendingOAuthFlow) {
throw new Error('Clerk: an OAuth flow is already pending.');
}
Expand Down
3 changes: 2 additions & 1 deletion packages/electron/src/main/passkey-handlers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ import type {
SerializedPublicKeyCredentialRequestOptions,
SetupPasskeysMainReturn,
} from '../shared/types';
import { isMainFrameEvent } from './validate-sender';

/**
* Optional native module. Ceremony failures resolve as JSON envelopes so error
Expand DownExpand Up@@ -77,7 +78,7 @@ async function invokeNative<T>(

// Subframes and webviews can host third-party content that must not be able
// to run credential ceremonies for the app's RP ID.
if (!event.senderFrame || event.senderFrame !== event.sender.mainFrame) {
if (!isMainFrameEvent(event)) {
return {
ok: false,
error: { code: 'unknown', message: "The passkey request did not originate from a window's main frame." },
Expand Down
10 changes: 10 additions & 0 deletions packages/electron/src/main/validate-sender.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import type { IpcMainInvokeEvent } from 'electron';

// Restricts privileged IPC to a top-level BrowserWindow's main frame. The frame check alone
// only proves the sender is the top document of *its own* WebContents, so a <webview> (a separate
// WebContents) sharing the Clerk preload would still pass; requiring getType() === 'window' rejects
// <webview> guests and BrowserViews, and the frame check rejects in-page iframes.
export function isMainFrameEvent(event: IpcMainInvokeEvent): boolean {
const { sender, senderFrame } = event;
return sender.getType() === 'window' && Boolean(senderFrame) && senderFrame === sender.mainFrame;
}
Loading