5 changes: 5 additions & 0 deletions .changeset/witty-parks-attack.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': minor
---

Adds Content Security Policy (CSP) nonce support to the Cloudflare Turnstile
229 changes: 228 additions & 1 deletion packages/clerk-js/src/utils/__tests__/captcha.spec.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { describe, expect, it } from 'vitest';
import { beforeEach, describe, expect, it, vi } from 'vitest';

import { shouldRetryTurnstileErrorCode } from '../captcha/turnstile';
import type { CaptchaOptions } from '../captcha/types';

describe('shouldRetryTurnstileErrorCode', () => {
it.each([
Expand All@@ -23,3 +24,229 @@ describe('shouldRetryTurnstileErrorCode', () => {
expect(shouldRetryTurnstileErrorCode(str)).toBe(expected);
});
});

describe('Nonce support', () => {
beforeEach(() => {
vi.clearAllMocks();
vi.resetModules();
});

describe('retrieveCaptchaInfo', () => {
it('should extract nonce from clerk options when available', async () => {
// Mock clerk instance with internal options
const mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
__internal_getOption: vi.fn().mockReturnValue('test-nonce-123'),
};

const { retrieveCaptchaInfo } = await import('../captcha/retrieveCaptchaInfo');
const result = retrieveCaptchaInfo(mockClerk as any);

expect(mockClerk.__internal_getOption).toHaveBeenCalledWith('nonce');
expect(result.nonce).toBe('test-nonce-123');
expect(result.captchaSiteKey).toBe('test-site-key');
expect(result.captchaProvider).toBe('turnstile');
});

it('should return undefined nonce when not available in clerk options', async () => {
const mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
__internal_getOption: vi.fn().mockReturnValue(undefined),
};

const { retrieveCaptchaInfo } = await import('../captcha/retrieveCaptchaInfo');
const result = retrieveCaptchaInfo(mockClerk as any);

expect(result.nonce).toBeUndefined();
});

it('should handle clerk instance without __internal_getOption method', async () => {
const mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
// No __internal_getOption method
};

const { retrieveCaptchaInfo } = await import('../captcha/retrieveCaptchaInfo');
const result = retrieveCaptchaInfo(mockClerk as any);

expect(result.nonce).toBeUndefined();
});
});

describe('CaptchaOptions type support', () => {
it('should accept nonce in CaptchaOptions type definition', () => {
// This test verifies that the CaptchaOptions type includes the nonce field
const validOptions: CaptchaOptions = {
action: 'signup',
captchaProvider: 'turnstile',
closeModal: async () => {},
invisibleSiteKey: 'test-invisible-key',
modalContainerQuerySelector: '.modal',
modalWrapperQuerySelector: '.wrapper',
nonce: 'test-nonce-from-csp',
openModal: async () => {},
siteKey: 'test-site-key',
widgetType: 'invisible',
};

// If this compiles without TypeScript errors, the test passes
expect(validOptions.nonce).toBe('test-nonce-from-csp');
});

it('should allow undefined nonce in CaptchaOptions', () => {
const validOptionsWithoutNonce: CaptchaOptions = {
action: 'signup',
captchaProvider: 'turnstile',
invisibleSiteKey: 'test-invisible-key',
siteKey: 'test-site-key',
widgetType: 'invisible',
// nonce is optional
};

expect(validOptionsWithoutNonce.nonce).toBeUndefined();
});
});

describe('CaptchaChallenge nonce integration', () => {
let mockClerk: any;

beforeEach(async () => {
// Mock clerk instance
mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
__internal_getOption: vi.fn().mockReturnValue('clerk-nonce-789'),
};

// Mock getCaptchaToken
vi.doMock('../captcha/getCaptchaToken', () => ({
getCaptchaToken: vi.fn().mockResolvedValue({
captchaToken: 'mock-token',
captchaWidgetType: 'invisible',
}),
}));
});

it('should use nonce from clerk options in invisible challenge', async () => {
const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(mockClerk);
await challenge.invisible({ action: 'signup' });

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: 'clerk-nonce-789',
captchaProvider: 'turnstile',
siteKey: 'test-invisible-key',
widgetType: 'invisible',
}),
);
});

it('should use nonce from clerk options in managedOrInvisible challenge', async () => {
const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(mockClerk);
await challenge.managedOrInvisible({ action: 'verify' });

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: 'clerk-nonce-789',
captchaProvider: 'turnstile',
siteKey: 'test-site-key',
widgetType: 'managed',
}),
);
});

it('should prefer explicit nonce over clerk options nonce', async () => {
const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(mockClerk);
await challenge.invisible({
action: 'signup',
nonce: 'explicit-nonce-override',
});

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: 'explicit-nonce-override',
}),
);
});

it('should handle missing nonce gracefully', async () => {
// Mock clerk without nonce
const clerkWithoutNonce = {
...mockClerk,
__internal_getOption: vi.fn().mockReturnValue(undefined),
};

const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(clerkWithoutNonce);
await challenge.invisible({ action: 'signup' });

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: undefined,
}),
);
});
});
});
16 changes: 9 additions & 7 deletions packages/clerk-js/src/utils/captcha/CaptchaChallenge.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,15 +12,16 @@ export class CaptchaChallenge {
* always use the fallback key.
*/
public async invisible(opts?: Partial<CaptchaOptions>) {
const { captchaSiteKey, canUseCaptcha, captchaPublicKeyInvisible } = retrieveCaptchaInfo(this.clerk);
const { captchaSiteKey, canUseCaptcha, captchaPublicKeyInvisible, nonce } = retrieveCaptchaInfo(this.clerk);

if (canUseCaptcha && captchaSiteKey && captchaPublicKeyInvisible) {
const captchaResult = await getCaptchaToken({
siteKey: captchaPublicKeyInvisible,
action: opts?.action,
captchaProvider: 'turnstile',
invisibleSiteKey: captchaPublicKeyInvisible,
nonce: opts?.nonce || nonce || undefined,
siteKey: captchaPublicKeyInvisible,
widgetType: 'invisible',
captchaProvider: 'turnstile',
action: opts?.action,
}).catch(e => {
if (e.captchaError) {
return { captchaError: e.captchaError };
Expand All@@ -42,15 +43,16 @@ export class CaptchaChallenge {
* Managed challenged start as non-interactive and escalate to interactive if necessary.
*/
public async managedOrInvisible(opts?: Partial<CaptchaOptions>) {
const { captchaSiteKey, canUseCaptcha, captchaWidgetType, captchaProvider, captchaPublicKeyInvisible } =
const { captchaSiteKey, canUseCaptcha, captchaWidgetType, captchaProvider, captchaPublicKeyInvisible, nonce } =
retrieveCaptchaInfo(this.clerk);

if (canUseCaptcha && captchaSiteKey && captchaPublicKeyInvisible) {
const captchaResult = await getCaptchaToken({
captchaProvider,
invisibleSiteKey: captchaPublicKeyInvisible,
nonce: nonce || undefined,
siteKey: captchaSiteKey,
widgetType: captchaWidgetType,
invisibleSiteKey: captchaPublicKeyInvisible,
captchaProvider,
...opts,
}).catch(e => {
if (e.captchaError) {
Expand Down
4 changes: 4 additions & 0 deletions packages/clerk-js/src/utils/captcha/retrieveCaptchaInfo.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,15 @@ export const retrieveCaptchaInfo = (clerk: Clerk) => {
const _environment = clerk.__unstable__environment;
const captchaProvider = _environment ? _environment.displayConfig.captchaProvider : 'turnstile';

// Access nonce via internal options - casting to any since nonce is in IsomorphicClerkOptions but not ClerkOptions
const nonce = (clerk as any).__internal_getOption?.('nonce') as string | undefined;

return {
captchaSiteKey: _environment ? _environment.displayConfig.captchaPublicKey : null,
captchaWidgetType: _environment ? _environment.displayConfig.captchaWidgetType : null,
captchaProvider,
captchaPublicKeyInvisible: _environment ? _environment.displayConfig.captchaPublicKeyInvisible : null,
canUseCaptcha: _environment ? _environment.userSettings.signUp.captcha_enabled && clerk.isStandardBrowser : null,
nonce: nonce || undefined,
};
};
12 changes: 6 additions & 6 deletions packages/clerk-js/src/utils/captcha/turnstile.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,23 +26,23 @@ export const shouldRetryTurnstileErrorCode = (errorCode: string) => {
return !!codesWithRetries.find(w => errorCode.startsWith(w));
};

async function loadCaptcha() {
async function loadCaptcha(nonce?: string) {
if (!window.turnstile) {
await loadCaptchaFromCloudflareURL().catch(() => {
await loadCaptchaFromCloudflareURL(nonce).catch(() => {
// eslint-disable-next-line @typescript-eslint/only-throw-error
throw { captchaError: 'captcha_script_failed_to_load' };
});
}
return window.turnstile;
}

async function loadCaptchaFromCloudflareURL() {
async function loadCaptchaFromCloudflareURL(nonce?: string) {
try {
if (__BUILD_DISABLE_RHC__) {
return Promise.reject(new Error('Captcha not supported in this environment'));
}

return await loadScript(CLOUDFLARE_TURNSTILE_ORIGINAL_URL, { defer: true });
return await loadScript(CLOUDFLARE_TURNSTILE_ORIGINAL_URL, { defer: true, nonce });
} catch (err) {
console.warn(
'Clerk: Failed to load the CAPTCHA script from Cloudflare. If you see a CSP error in your browser, please add the necessary CSP rules to your app. Visit https://clerk.com/docs/security/clerk-csp for more information.',
Expand DownExpand Up@@ -71,9 +71,9 @@ function getCaptchaAttibutesFromElemenet(element: HTMLElement): CaptchaAttribute
* not exist, the invisibleSiteKey is used as a fallback and the widget is rendered in a hidden div at the bottom of the body.
*/
export const getTurnstileToken = async (opts: CaptchaOptions) => {
const { siteKey, widgetType, invisibleSiteKey } = opts;
const { siteKey, widgetType, invisibleSiteKey, nonce } = opts;
const { modalContainerQuerySelector, modalWrapperQuerySelector, closeModal, openModal } = opts;
const captcha: Turnstile.Turnstile = await loadCaptcha();
const captcha: Turnstile.Turnstile = await loadCaptcha(nonce);
const errorCodes: (string | number)[] = [];

let captchaToken = '';
Expand Down
11 changes: 6 additions & 5 deletions packages/clerk-js/src/utils/captcha/types.ts
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
import type { CaptchaProvider, CaptchaWidgetType } from '@clerk/types';

export type CaptchaOptions = {
siteKey: string;
widgetType: CaptchaWidgetType;
invisibleSiteKey: string;
action?: 'verify' | 'signup' | 'heartbeat';
captchaProvider: CaptchaProvider;
closeModal?: () => Promise<unknown>;
invisibleSiteKey: string;
modalContainerQuerySelector?: string;
modalWrapperQuerySelector?: string;
nonce?: string;
openModal?: () => Promise<unknown>;
closeModal?: () => Promise<unknown>;
action?: 'verify' | 'signup' | 'heartbeat';
siteKey: string;
widgetType: CaptchaWidgetType;
};

export type GetCaptchaTokenReturn = {
Expand Down
, '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
5 changes: 5 additions & 0 deletions .changeset/witty-parks-attack.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': minor
---

Adds Content Security Policy (CSP) nonce support to the Cloudflare Turnstile
229 changes: 228 additions & 1 deletion packages/clerk-js/src/utils/__tests__/captcha.spec.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { describe, expect, it } from 'vitest';
import { beforeEach, describe, expect, it, vi } from 'vitest';

import { shouldRetryTurnstileErrorCode } from '../captcha/turnstile';
import type { CaptchaOptions } from '../captcha/types';

describe('shouldRetryTurnstileErrorCode', () => {
it.each([
Expand All@@ -23,3 +24,229 @@ describe('shouldRetryTurnstileErrorCode', () => {
expect(shouldRetryTurnstileErrorCode(str)).toBe(expected);
});
});

describe('Nonce support', () => {
beforeEach(() => {
vi.clearAllMocks();
vi.resetModules();
});

describe('retrieveCaptchaInfo', () => {
it('should extract nonce from clerk options when available', async () => {
// Mock clerk instance with internal options
const mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
__internal_getOption: vi.fn().mockReturnValue('test-nonce-123'),
};

const { retrieveCaptchaInfo } = await import('../captcha/retrieveCaptchaInfo');
const result = retrieveCaptchaInfo(mockClerk as any);

expect(mockClerk.__internal_getOption).toHaveBeenCalledWith('nonce');
expect(result.nonce).toBe('test-nonce-123');
expect(result.captchaSiteKey).toBe('test-site-key');
expect(result.captchaProvider).toBe('turnstile');
});

it('should return undefined nonce when not available in clerk options', async () => {
const mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
__internal_getOption: vi.fn().mockReturnValue(undefined),
};

const { retrieveCaptchaInfo } = await import('../captcha/retrieveCaptchaInfo');
const result = retrieveCaptchaInfo(mockClerk as any);

expect(result.nonce).toBeUndefined();
});

it('should handle clerk instance without __internal_getOption method', async () => {
const mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
// No __internal_getOption method
};

const { retrieveCaptchaInfo } = await import('../captcha/retrieveCaptchaInfo');
const result = retrieveCaptchaInfo(mockClerk as any);

expect(result.nonce).toBeUndefined();
});
});

describe('CaptchaOptions type support', () => {
it('should accept nonce in CaptchaOptions type definition', () => {
// This test verifies that the CaptchaOptions type includes the nonce field
const validOptions: CaptchaOptions = {
action: 'signup',
captchaProvider: 'turnstile',
closeModal: async () => {},
invisibleSiteKey: 'test-invisible-key',
modalContainerQuerySelector: '.modal',
modalWrapperQuerySelector: '.wrapper',
nonce: 'test-nonce-from-csp',
openModal: async () => {},
siteKey: 'test-site-key',
widgetType: 'invisible',
};

// If this compiles without TypeScript errors, the test passes
expect(validOptions.nonce).toBe('test-nonce-from-csp');
});

it('should allow undefined nonce in CaptchaOptions', () => {
const validOptionsWithoutNonce: CaptchaOptions = {
action: 'signup',
captchaProvider: 'turnstile',
invisibleSiteKey: 'test-invisible-key',
siteKey: 'test-site-key',
widgetType: 'invisible',
// nonce is optional
};

expect(validOptionsWithoutNonce.nonce).toBeUndefined();
});
});

describe('CaptchaChallenge nonce integration', () => {
let mockClerk: any;

beforeEach(async () => {
// Mock clerk instance
mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
__internal_getOption: vi.fn().mockReturnValue('clerk-nonce-789'),
};

// Mock getCaptchaToken
vi.doMock('../captcha/getCaptchaToken', () => ({
getCaptchaToken: vi.fn().mockResolvedValue({
captchaToken: 'mock-token',
captchaWidgetType: 'invisible',
}),
}));
});

it('should use nonce from clerk options in invisible challenge', async () => {
const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(mockClerk);
await challenge.invisible({ action: 'signup' });

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: 'clerk-nonce-789',
captchaProvider: 'turnstile',
siteKey: 'test-invisible-key',
widgetType: 'invisible',
}),
);
});

it('should use nonce from clerk options in managedOrInvisible challenge', async () => {
const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(mockClerk);
await challenge.managedOrInvisible({ action: 'verify' });

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: 'clerk-nonce-789',
captchaProvider: 'turnstile',
siteKey: 'test-site-key',
widgetType: 'managed',
}),
);
});

it('should prefer explicit nonce over clerk options nonce', async () => {
const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(mockClerk);
await challenge.invisible({
action: 'signup',
nonce: 'explicit-nonce-override',
});

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: 'explicit-nonce-override',
}),
);
});

it('should handle missing nonce gracefully', async () => {
// Mock clerk without nonce
const clerkWithoutNonce = {
...mockClerk,
__internal_getOption: vi.fn().mockReturnValue(undefined),
};

const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(clerkWithoutNonce);
await challenge.invisible({ action: 'signup' });

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: undefined,
}),
);
});
});
});
16 changes: 9 additions & 7 deletions packages/clerk-js/src/utils/captcha/CaptchaChallenge.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,15 +12,16 @@ export class CaptchaChallenge {
* always use the fallback key.
*/
public async invisible(opts?: Partial<CaptchaOptions>) {
const { captchaSiteKey, canUseCaptcha, captchaPublicKeyInvisible } = retrieveCaptchaInfo(this.clerk);
const { captchaSiteKey, canUseCaptcha, captchaPublicKeyInvisible, nonce } = retrieveCaptchaInfo(this.clerk);

if (canUseCaptcha && captchaSiteKey && captchaPublicKeyInvisible) {
const captchaResult = await getCaptchaToken({
siteKey: captchaPublicKeyInvisible,
action: opts?.action,
captchaProvider: 'turnstile',
invisibleSiteKey: captchaPublicKeyInvisible,
nonce: opts?.nonce || nonce || undefined,
siteKey: captchaPublicKeyInvisible,
widgetType: 'invisible',
captchaProvider: 'turnstile',
action: opts?.action,
}).catch(e => {
if (e.captchaError) {
return { captchaError: e.captchaError };
Expand All@@ -42,15 +43,16 @@ export class CaptchaChallenge {
* Managed challenged start as non-interactive and escalate to interactive if necessary.
*/
public async managedOrInvisible(opts?: Partial<CaptchaOptions>) {
const { captchaSiteKey, canUseCaptcha, captchaWidgetType, captchaProvider, captchaPublicKeyInvisible } =
const { captchaSiteKey, canUseCaptcha, captchaWidgetType, captchaProvider, captchaPublicKeyInvisible, nonce } =
retrieveCaptchaInfo(this.clerk);

if (canUseCaptcha && captchaSiteKey && captchaPublicKeyInvisible) {
const captchaResult = await getCaptchaToken({
captchaProvider,
invisibleSiteKey: captchaPublicKeyInvisible,
nonce: nonce || undefined,
siteKey: captchaSiteKey,
widgetType: captchaWidgetType,
invisibleSiteKey: captchaPublicKeyInvisible,
captchaProvider,
...opts,
}).catch(e => {
if (e.captchaError) {
Expand Down
4 changes: 4 additions & 0 deletions packages/clerk-js/src/utils/captcha/retrieveCaptchaInfo.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,15 @@ export const retrieveCaptchaInfo = (clerk: Clerk) => {
const _environment = clerk.__unstable__environment;
const captchaProvider = _environment ? _environment.displayConfig.captchaProvider : 'turnstile';

// Access nonce via internal options - casting to any since nonce is in IsomorphicClerkOptions but not ClerkOptions
const nonce = (clerk as any).__internal_getOption?.('nonce') as string | undefined;

return {
captchaSiteKey: _environment ? _environment.displayConfig.captchaPublicKey : null,
captchaWidgetType: _environment ? _environment.displayConfig.captchaWidgetType : null,
captchaProvider,
captchaPublicKeyInvisible: _environment ? _environment.displayConfig.captchaPublicKeyInvisible : null,
canUseCaptcha: _environment ? _environment.userSettings.signUp.captcha_enabled && clerk.isStandardBrowser : null,
nonce: nonce || undefined,
};
};
12 changes: 6 additions & 6 deletions packages/clerk-js/src/utils/captcha/turnstile.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,23 +26,23 @@ export const shouldRetryTurnstileErrorCode = (errorCode: string) => {
return !!codesWithRetries.find(w => errorCode.startsWith(w));
};

async function loadCaptcha() {
async function loadCaptcha(nonce?: string) {
if (!window.turnstile) {
await loadCaptchaFromCloudflareURL().catch(() => {
await loadCaptchaFromCloudflareURL(nonce).catch(() => {
// eslint-disable-next-line @typescript-eslint/only-throw-error
throw { captchaError: 'captcha_script_failed_to_load' };
});
}
return window.turnstile;
}

async function loadCaptchaFromCloudflareURL() {
async function loadCaptchaFromCloudflareURL(nonce?: string) {
try {
if (__BUILD_DISABLE_RHC__) {
return Promise.reject(new Error('Captcha not supported in this environment'));
}

return await loadScript(CLOUDFLARE_TURNSTILE_ORIGINAL_URL, { defer: true });
return await loadScript(CLOUDFLARE_TURNSTILE_ORIGINAL_URL, { defer: true, nonce });
} catch (err) {
console.warn(
'Clerk: Failed to load the CAPTCHA script from Cloudflare. If you see a CSP error in your browser, please add the necessary CSP rules to your app. Visit https://clerk.com/docs/security/clerk-csp for more information.',
Expand DownExpand Up@@ -71,9 +71,9 @@ function getCaptchaAttibutesFromElemenet(element: HTMLElement): CaptchaAttribute
* not exist, the invisibleSiteKey is used as a fallback and the widget is rendered in a hidden div at the bottom of the body.
*/
export const getTurnstileToken = async (opts: CaptchaOptions) => {
const { siteKey, widgetType, invisibleSiteKey } = opts;
const { siteKey, widgetType, invisibleSiteKey, nonce } = opts;
const { modalContainerQuerySelector, modalWrapperQuerySelector, closeModal, openModal } = opts;
const captcha: Turnstile.Turnstile = await loadCaptcha();
const captcha: Turnstile.Turnstile = await loadCaptcha(nonce);
const errorCodes: (string | number)[] = [];

let captchaToken = '';
Expand Down
11 changes: 6 additions & 5 deletions packages/clerk-js/src/utils/captcha/types.ts
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
import type { CaptchaProvider, CaptchaWidgetType } from '@clerk/types';

export type CaptchaOptions = {
siteKey: string;
widgetType: CaptchaWidgetType;
invisibleSiteKey: string;
action?: 'verify' | 'signup' | 'heartbeat';
captchaProvider: CaptchaProvider;
closeModal?: () => Promise<unknown>;
invisibleSiteKey: string;
modalContainerQuerySelector?: string;
modalWrapperQuerySelector?: string;
nonce?: string;
openModal?: () => Promise<unknown>;
closeModal?: () => Promise<unknown>;
action?: 'verify' | 'signup' | 'heartbeat';
siteKey: string;
widgetType: CaptchaWidgetType;
};

export type GetCaptchaTokenReturn = {
Expand Down
, '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
5 changes: 5 additions & 0 deletions .changeset/witty-parks-attack.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': minor
---

Adds Content Security Policy (CSP) nonce support to the Cloudflare Turnstile
229 changes: 228 additions & 1 deletion packages/clerk-js/src/utils/__tests__/captcha.spec.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { describe, expect, it } from 'vitest';
import { beforeEach, describe, expect, it, vi } from 'vitest';

import { shouldRetryTurnstileErrorCode } from '../captcha/turnstile';
import type { CaptchaOptions } from '../captcha/types';

describe('shouldRetryTurnstileErrorCode', () => {
it.each([
Expand All@@ -23,3 +24,229 @@ describe('shouldRetryTurnstileErrorCode', () => {
expect(shouldRetryTurnstileErrorCode(str)).toBe(expected);
});
});

describe('Nonce support', () => {
beforeEach(() => {
vi.clearAllMocks();
vi.resetModules();
});

describe('retrieveCaptchaInfo', () => {
it('should extract nonce from clerk options when available', async () => {
// Mock clerk instance with internal options
const mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
__internal_getOption: vi.fn().mockReturnValue('test-nonce-123'),
};

const { retrieveCaptchaInfo } = await import('../captcha/retrieveCaptchaInfo');
const result = retrieveCaptchaInfo(mockClerk as any);

expect(mockClerk.__internal_getOption).toHaveBeenCalledWith('nonce');
expect(result.nonce).toBe('test-nonce-123');
expect(result.captchaSiteKey).toBe('test-site-key');
expect(result.captchaProvider).toBe('turnstile');
});

it('should return undefined nonce when not available in clerk options', async () => {
const mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
__internal_getOption: vi.fn().mockReturnValue(undefined),
};

const { retrieveCaptchaInfo } = await import('../captcha/retrieveCaptchaInfo');
const result = retrieveCaptchaInfo(mockClerk as any);

expect(result.nonce).toBeUndefined();
});

it('should handle clerk instance without __internal_getOption method', async () => {
const mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
// No __internal_getOption method
};

const { retrieveCaptchaInfo } = await import('../captcha/retrieveCaptchaInfo');
const result = retrieveCaptchaInfo(mockClerk as any);

expect(result.nonce).toBeUndefined();
});
});

describe('CaptchaOptions type support', () => {
it('should accept nonce in CaptchaOptions type definition', () => {
// This test verifies that the CaptchaOptions type includes the nonce field
const validOptions: CaptchaOptions = {
action: 'signup',
captchaProvider: 'turnstile',
closeModal: async () => {},
invisibleSiteKey: 'test-invisible-key',
modalContainerQuerySelector: '.modal',
modalWrapperQuerySelector: '.wrapper',
nonce: 'test-nonce-from-csp',
openModal: async () => {},
siteKey: 'test-site-key',
widgetType: 'invisible',
};

// If this compiles without TypeScript errors, the test passes
expect(validOptions.nonce).toBe('test-nonce-from-csp');
});

it('should allow undefined nonce in CaptchaOptions', () => {
const validOptionsWithoutNonce: CaptchaOptions = {
action: 'signup',
captchaProvider: 'turnstile',
invisibleSiteKey: 'test-invisible-key',
siteKey: 'test-site-key',
widgetType: 'invisible',
// nonce is optional
};

expect(validOptionsWithoutNonce.nonce).toBeUndefined();
});
});

describe('CaptchaChallenge nonce integration', () => {
let mockClerk: any;

beforeEach(async () => {
// Mock clerk instance
mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
__internal_getOption: vi.fn().mockReturnValue('clerk-nonce-789'),
};

// Mock getCaptchaToken
vi.doMock('../captcha/getCaptchaToken', () => ({
getCaptchaToken: vi.fn().mockResolvedValue({
captchaToken: 'mock-token',
captchaWidgetType: 'invisible',
}),
}));
});

it('should use nonce from clerk options in invisible challenge', async () => {
const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(mockClerk);
await challenge.invisible({ action: 'signup' });

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: 'clerk-nonce-789',
captchaProvider: 'turnstile',
siteKey: 'test-invisible-key',
widgetType: 'invisible',
}),
);
});

it('should use nonce from clerk options in managedOrInvisible challenge', async () => {
const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(mockClerk);
await challenge.managedOrInvisible({ action: 'verify' });

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: 'clerk-nonce-789',
captchaProvider: 'turnstile',
siteKey: 'test-site-key',
widgetType: 'managed',
}),
);
});

it('should prefer explicit nonce over clerk options nonce', async () => {
const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(mockClerk);
await challenge.invisible({
action: 'signup',
nonce: 'explicit-nonce-override',
});

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: 'explicit-nonce-override',
}),
);
});

it('should handle missing nonce gracefully', async () => {
// Mock clerk without nonce
const clerkWithoutNonce = {
...mockClerk,
__internal_getOption: vi.fn().mockReturnValue(undefined),
};

const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(clerkWithoutNonce);
await challenge.invisible({ action: 'signup' });

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: undefined,
}),
);
});
});
});
16 changes: 9 additions & 7 deletions packages/clerk-js/src/utils/captcha/CaptchaChallenge.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,15 +12,16 @@ export class CaptchaChallenge {
* always use the fallback key.
*/
public async invisible(opts?: Partial<CaptchaOptions>) {
const { captchaSiteKey, canUseCaptcha, captchaPublicKeyInvisible } = retrieveCaptchaInfo(this.clerk);
const { captchaSiteKey, canUseCaptcha, captchaPublicKeyInvisible, nonce } = retrieveCaptchaInfo(this.clerk);

if (canUseCaptcha && captchaSiteKey && captchaPublicKeyInvisible) {
const captchaResult = await getCaptchaToken({
siteKey: captchaPublicKeyInvisible,
action: opts?.action,
captchaProvider: 'turnstile',
invisibleSiteKey: captchaPublicKeyInvisible,
nonce: opts?.nonce || nonce || undefined,
siteKey: captchaPublicKeyInvisible,
widgetType: 'invisible',
captchaProvider: 'turnstile',
action: opts?.action,
}).catch(e => {
if (e.captchaError) {
return { captchaError: e.captchaError };
Expand All@@ -42,15 +43,16 @@ export class CaptchaChallenge {
* Managed challenged start as non-interactive and escalate to interactive if necessary.
*/
public async managedOrInvisible(opts?: Partial<CaptchaOptions>) {
const { captchaSiteKey, canUseCaptcha, captchaWidgetType, captchaProvider, captchaPublicKeyInvisible } =
const { captchaSiteKey, canUseCaptcha, captchaWidgetType, captchaProvider, captchaPublicKeyInvisible, nonce } =
retrieveCaptchaInfo(this.clerk);

if (canUseCaptcha && captchaSiteKey && captchaPublicKeyInvisible) {
const captchaResult = await getCaptchaToken({
captchaProvider,
invisibleSiteKey: captchaPublicKeyInvisible,
nonce: nonce || undefined,
siteKey: captchaSiteKey,
widgetType: captchaWidgetType,
invisibleSiteKey: captchaPublicKeyInvisible,
captchaProvider,
...opts,
}).catch(e => {
if (e.captchaError) {
Expand Down
4 changes: 4 additions & 0 deletions packages/clerk-js/src/utils/captcha/retrieveCaptchaInfo.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,15 @@ export const retrieveCaptchaInfo = (clerk: Clerk) => {
const _environment = clerk.__unstable__environment;
const captchaProvider = _environment ? _environment.displayConfig.captchaProvider : 'turnstile';

// Access nonce via internal options - casting to any since nonce is in IsomorphicClerkOptions but not ClerkOptions
const nonce = (clerk as any).__internal_getOption?.('nonce') as string | undefined;

return {
captchaSiteKey: _environment ? _environment.displayConfig.captchaPublicKey : null,
captchaWidgetType: _environment ? _environment.displayConfig.captchaWidgetType : null,
captchaProvider,
captchaPublicKeyInvisible: _environment ? _environment.displayConfig.captchaPublicKeyInvisible : null,
canUseCaptcha: _environment ? _environment.userSettings.signUp.captcha_enabled && clerk.isStandardBrowser : null,
nonce: nonce || undefined,
};
};
12 changes: 6 additions & 6 deletions packages/clerk-js/src/utils/captcha/turnstile.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,23 +26,23 @@ export const shouldRetryTurnstileErrorCode = (errorCode: string) => {
return !!codesWithRetries.find(w => errorCode.startsWith(w));
};

async function loadCaptcha() {
async function loadCaptcha(nonce?: string) {
if (!window.turnstile) {
await loadCaptchaFromCloudflareURL().catch(() => {
await loadCaptchaFromCloudflareURL(nonce).catch(() => {
// eslint-disable-next-line @typescript-eslint/only-throw-error
throw { captchaError: 'captcha_script_failed_to_load' };
});
}
return window.turnstile;
}

async function loadCaptchaFromCloudflareURL() {
async function loadCaptchaFromCloudflareURL(nonce?: string) {
try {
if (__BUILD_DISABLE_RHC__) {
return Promise.reject(new Error('Captcha not supported in this environment'));
}

return await loadScript(CLOUDFLARE_TURNSTILE_ORIGINAL_URL, { defer: true });
return await loadScript(CLOUDFLARE_TURNSTILE_ORIGINAL_URL, { defer: true, nonce });
} catch (err) {
console.warn(
'Clerk: Failed to load the CAPTCHA script from Cloudflare. If you see a CSP error in your browser, please add the necessary CSP rules to your app. Visit https://clerk.com/docs/security/clerk-csp for more information.',
Expand DownExpand Up@@ -71,9 +71,9 @@ function getCaptchaAttibutesFromElemenet(element: HTMLElement): CaptchaAttribute
* not exist, the invisibleSiteKey is used as a fallback and the widget is rendered in a hidden div at the bottom of the body.
*/
export const getTurnstileToken = async (opts: CaptchaOptions) => {
const { siteKey, widgetType, invisibleSiteKey } = opts;
const { siteKey, widgetType, invisibleSiteKey, nonce } = opts;
const { modalContainerQuerySelector, modalWrapperQuerySelector, closeModal, openModal } = opts;
const captcha: Turnstile.Turnstile = await loadCaptcha();
const captcha: Turnstile.Turnstile = await loadCaptcha(nonce);
const errorCodes: (string | number)[] = [];

let captchaToken = '';
Expand Down
11 changes: 6 additions & 5 deletions packages/clerk-js/src/utils/captcha/types.ts
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
import type { CaptchaProvider, CaptchaWidgetType } from '@clerk/types';

export type CaptchaOptions = {
siteKey: string;
widgetType: CaptchaWidgetType;
invisibleSiteKey: string;
action?: 'verify' | 'signup' | 'heartbeat';
captchaProvider: CaptchaProvider;
closeModal?: () => Promise<unknown>;
invisibleSiteKey: string;
modalContainerQuerySelector?: string;
modalWrapperQuerySelector?: string;
nonce?: string;
openModal?: () => Promise<unknown>;
closeModal?: () => Promise<unknown>;
action?: 'verify' | 'signup' | 'heartbeat';
siteKey: string;
widgetType: CaptchaWidgetType;
};

export type GetCaptchaTokenReturn = {
Expand Down
, '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
5 changes: 5 additions & 0 deletions .changeset/witty-parks-attack.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': minor
---

Adds Content Security Policy (CSP) nonce support to the Cloudflare Turnstile
229 changes: 228 additions & 1 deletion packages/clerk-js/src/utils/__tests__/captcha.spec.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { describe, expect, it } from 'vitest';
import { beforeEach, describe, expect, it, vi } from 'vitest';

import { shouldRetryTurnstileErrorCode } from '../captcha/turnstile';
import type { CaptchaOptions } from '../captcha/types';

describe('shouldRetryTurnstileErrorCode', () => {
it.each([
Expand All@@ -23,3 +24,229 @@ describe('shouldRetryTurnstileErrorCode', () => {
expect(shouldRetryTurnstileErrorCode(str)).toBe(expected);
});
});

describe('Nonce support', () => {
beforeEach(() => {
vi.clearAllMocks();
vi.resetModules();
});

describe('retrieveCaptchaInfo', () => {
it('should extract nonce from clerk options when available', async () => {
// Mock clerk instance with internal options
const mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
__internal_getOption: vi.fn().mockReturnValue('test-nonce-123'),
};

const { retrieveCaptchaInfo } = await import('../captcha/retrieveCaptchaInfo');
const result = retrieveCaptchaInfo(mockClerk as any);

expect(mockClerk.__internal_getOption).toHaveBeenCalledWith('nonce');
expect(result.nonce).toBe('test-nonce-123');
expect(result.captchaSiteKey).toBe('test-site-key');
expect(result.captchaProvider).toBe('turnstile');
});

it('should return undefined nonce when not available in clerk options', async () => {
const mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
__internal_getOption: vi.fn().mockReturnValue(undefined),
};

const { retrieveCaptchaInfo } = await import('../captcha/retrieveCaptchaInfo');
const result = retrieveCaptchaInfo(mockClerk as any);

expect(result.nonce).toBeUndefined();
});

it('should handle clerk instance without __internal_getOption method', async () => {
const mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
// No __internal_getOption method
};

const { retrieveCaptchaInfo } = await import('../captcha/retrieveCaptchaInfo');
const result = retrieveCaptchaInfo(mockClerk as any);

expect(result.nonce).toBeUndefined();
});
});

describe('CaptchaOptions type support', () => {
it('should accept nonce in CaptchaOptions type definition', () => {
// This test verifies that the CaptchaOptions type includes the nonce field
const validOptions: CaptchaOptions = {
action: 'signup',
captchaProvider: 'turnstile',
closeModal: async () => {},
invisibleSiteKey: 'test-invisible-key',
modalContainerQuerySelector: '.modal',
modalWrapperQuerySelector: '.wrapper',
nonce: 'test-nonce-from-csp',
openModal: async () => {},
siteKey: 'test-site-key',
widgetType: 'invisible',
};

// If this compiles without TypeScript errors, the test passes
expect(validOptions.nonce).toBe('test-nonce-from-csp');
});

it('should allow undefined nonce in CaptchaOptions', () => {
const validOptionsWithoutNonce: CaptchaOptions = {
action: 'signup',
captchaProvider: 'turnstile',
invisibleSiteKey: 'test-invisible-key',
siteKey: 'test-site-key',
widgetType: 'invisible',
// nonce is optional
};

expect(validOptionsWithoutNonce.nonce).toBeUndefined();
});
});

describe('CaptchaChallenge nonce integration', () => {
let mockClerk: any;

beforeEach(async () => {
// Mock clerk instance
mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
__internal_getOption: vi.fn().mockReturnValue('clerk-nonce-789'),
};

// Mock getCaptchaToken
vi.doMock('../captcha/getCaptchaToken', () => ({
getCaptchaToken: vi.fn().mockResolvedValue({
captchaToken: 'mock-token',
captchaWidgetType: 'invisible',
}),
}));
});

it('should use nonce from clerk options in invisible challenge', async () => {
const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(mockClerk);
await challenge.invisible({ action: 'signup' });

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: 'clerk-nonce-789',
captchaProvider: 'turnstile',
siteKey: 'test-invisible-key',
widgetType: 'invisible',
}),
);
});

it('should use nonce from clerk options in managedOrInvisible challenge', async () => {
const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(mockClerk);
await challenge.managedOrInvisible({ action: 'verify' });

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: 'clerk-nonce-789',
captchaProvider: 'turnstile',
siteKey: 'test-site-key',
widgetType: 'managed',
}),
);
});

it('should prefer explicit nonce over clerk options nonce', async () => {
const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(mockClerk);
await challenge.invisible({
action: 'signup',
nonce: 'explicit-nonce-override',
});

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: 'explicit-nonce-override',
}),
);
});

it('should handle missing nonce gracefully', async () => {
// Mock clerk without nonce
const clerkWithoutNonce = {
...mockClerk,
__internal_getOption: vi.fn().mockReturnValue(undefined),
};

const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(clerkWithoutNonce);
await challenge.invisible({ action: 'signup' });

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: undefined,
}),
);
});
});
});
16 changes: 9 additions & 7 deletions packages/clerk-js/src/utils/captcha/CaptchaChallenge.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,15 +12,16 @@ export class CaptchaChallenge {
* always use the fallback key.
*/
public async invisible(opts?: Partial<CaptchaOptions>) {
const { captchaSiteKey, canUseCaptcha, captchaPublicKeyInvisible } = retrieveCaptchaInfo(this.clerk);
const { captchaSiteKey, canUseCaptcha, captchaPublicKeyInvisible, nonce } = retrieveCaptchaInfo(this.clerk);

if (canUseCaptcha && captchaSiteKey && captchaPublicKeyInvisible) {
const captchaResult = await getCaptchaToken({
siteKey: captchaPublicKeyInvisible,
action: opts?.action,
captchaProvider: 'turnstile',
invisibleSiteKey: captchaPublicKeyInvisible,
nonce: opts?.nonce || nonce || undefined,
siteKey: captchaPublicKeyInvisible,
widgetType: 'invisible',
captchaProvider: 'turnstile',
action: opts?.action,
}).catch(e => {
if (e.captchaError) {
return { captchaError: e.captchaError };
Expand All@@ -42,15 +43,16 @@ export class CaptchaChallenge {
* Managed challenged start as non-interactive and escalate to interactive if necessary.
*/
public async managedOrInvisible(opts?: Partial<CaptchaOptions>) {
const { captchaSiteKey, canUseCaptcha, captchaWidgetType, captchaProvider, captchaPublicKeyInvisible } =
const { captchaSiteKey, canUseCaptcha, captchaWidgetType, captchaProvider, captchaPublicKeyInvisible, nonce } =
retrieveCaptchaInfo(this.clerk);

if (canUseCaptcha && captchaSiteKey && captchaPublicKeyInvisible) {
const captchaResult = await getCaptchaToken({
captchaProvider,
invisibleSiteKey: captchaPublicKeyInvisible,
nonce: nonce || undefined,
siteKey: captchaSiteKey,
widgetType: captchaWidgetType,
invisibleSiteKey: captchaPublicKeyInvisible,
captchaProvider,
...opts,
}).catch(e => {
if (e.captchaError) {
Expand Down
4 changes: 4 additions & 0 deletions packages/clerk-js/src/utils/captcha/retrieveCaptchaInfo.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,15 @@ export const retrieveCaptchaInfo = (clerk: Clerk) => {
const _environment = clerk.__unstable__environment;
const captchaProvider = _environment ? _environment.displayConfig.captchaProvider : 'turnstile';

// Access nonce via internal options - casting to any since nonce is in IsomorphicClerkOptions but not ClerkOptions
const nonce = (clerk as any).__internal_getOption?.('nonce') as string | undefined;

return {
captchaSiteKey: _environment ? _environment.displayConfig.captchaPublicKey : null,
captchaWidgetType: _environment ? _environment.displayConfig.captchaWidgetType : null,
captchaProvider,
captchaPublicKeyInvisible: _environment ? _environment.displayConfig.captchaPublicKeyInvisible : null,
canUseCaptcha: _environment ? _environment.userSettings.signUp.captcha_enabled && clerk.isStandardBrowser : null,
nonce: nonce || undefined,
};
};
12 changes: 6 additions & 6 deletions packages/clerk-js/src/utils/captcha/turnstile.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,23 +26,23 @@ export const shouldRetryTurnstileErrorCode = (errorCode: string) => {
return !!codesWithRetries.find(w => errorCode.startsWith(w));
};

async function loadCaptcha() {
async function loadCaptcha(nonce?: string) {
if (!window.turnstile) {
await loadCaptchaFromCloudflareURL().catch(() => {
await loadCaptchaFromCloudflareURL(nonce).catch(() => {
// eslint-disable-next-line @typescript-eslint/only-throw-error
throw { captchaError: 'captcha_script_failed_to_load' };
});
}
return window.turnstile;
}

async function loadCaptchaFromCloudflareURL() {
async function loadCaptchaFromCloudflareURL(nonce?: string) {
try {
if (__BUILD_DISABLE_RHC__) {
return Promise.reject(new Error('Captcha not supported in this environment'));
}

return await loadScript(CLOUDFLARE_TURNSTILE_ORIGINAL_URL, { defer: true });
return await loadScript(CLOUDFLARE_TURNSTILE_ORIGINAL_URL, { defer: true, nonce });
} catch (err) {
console.warn(
'Clerk: Failed to load the CAPTCHA script from Cloudflare. If you see a CSP error in your browser, please add the necessary CSP rules to your app. Visit https://clerk.com/docs/security/clerk-csp for more information.',
Expand DownExpand Up@@ -71,9 +71,9 @@ function getCaptchaAttibutesFromElemenet(element: HTMLElement): CaptchaAttribute
* not exist, the invisibleSiteKey is used as a fallback and the widget is rendered in a hidden div at the bottom of the body.
*/
export const getTurnstileToken = async (opts: CaptchaOptions) => {
const { siteKey, widgetType, invisibleSiteKey } = opts;
const { siteKey, widgetType, invisibleSiteKey, nonce } = opts;
const { modalContainerQuerySelector, modalWrapperQuerySelector, closeModal, openModal } = opts;
const captcha: Turnstile.Turnstile = await loadCaptcha();
const captcha: Turnstile.Turnstile = await loadCaptcha(nonce);
const errorCodes: (string | number)[] = [];

let captchaToken = '';
Expand Down
11 changes: 6 additions & 5 deletions packages/clerk-js/src/utils/captcha/types.ts
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
import type { CaptchaProvider, CaptchaWidgetType } from '@clerk/types';

export type CaptchaOptions = {
siteKey: string;
widgetType: CaptchaWidgetType;
invisibleSiteKey: string;
action?: 'verify' | 'signup' | 'heartbeat';
captchaProvider: CaptchaProvider;
closeModal?: () => Promise<unknown>;
invisibleSiteKey: string;
modalContainerQuerySelector?: string;
modalWrapperQuerySelector?: string;
nonce?: string;
openModal?: () => Promise<unknown>;
closeModal?: () => Promise<unknown>;
action?: 'verify' | 'signup' | 'heartbeat';
siteKey: string;
widgetType: CaptchaWidgetType;
};

export type GetCaptchaTokenReturn = {
Expand Down
, '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
5 changes: 5 additions & 0 deletions .changeset/witty-parks-attack.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': minor
---

Adds Content Security Policy (CSP) nonce support to the Cloudflare Turnstile
229 changes: 228 additions & 1 deletion packages/clerk-js/src/utils/__tests__/captcha.spec.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { describe, expect, it } from 'vitest';
import { beforeEach, describe, expect, it, vi } from 'vitest';

import { shouldRetryTurnstileErrorCode } from '../captcha/turnstile';
import type { CaptchaOptions } from '../captcha/types';

describe('shouldRetryTurnstileErrorCode', () => {
it.each([
Expand All@@ -23,3 +24,229 @@ describe('shouldRetryTurnstileErrorCode', () => {
expect(shouldRetryTurnstileErrorCode(str)).toBe(expected);
});
});

describe('Nonce support', () => {
beforeEach(() => {
vi.clearAllMocks();
vi.resetModules();
});

describe('retrieveCaptchaInfo', () => {
it('should extract nonce from clerk options when available', async () => {
// Mock clerk instance with internal options
const mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
__internal_getOption: vi.fn().mockReturnValue('test-nonce-123'),
};

const { retrieveCaptchaInfo } = await import('../captcha/retrieveCaptchaInfo');
const result = retrieveCaptchaInfo(mockClerk as any);

expect(mockClerk.__internal_getOption).toHaveBeenCalledWith('nonce');
expect(result.nonce).toBe('test-nonce-123');
expect(result.captchaSiteKey).toBe('test-site-key');
expect(result.captchaProvider).toBe('turnstile');
});

it('should return undefined nonce when not available in clerk options', async () => {
const mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
__internal_getOption: vi.fn().mockReturnValue(undefined),
};

const { retrieveCaptchaInfo } = await import('../captcha/retrieveCaptchaInfo');
const result = retrieveCaptchaInfo(mockClerk as any);

expect(result.nonce).toBeUndefined();
});

it('should handle clerk instance without __internal_getOption method', async () => {
const mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
// No __internal_getOption method
};

const { retrieveCaptchaInfo } = await import('../captcha/retrieveCaptchaInfo');
const result = retrieveCaptchaInfo(mockClerk as any);

expect(result.nonce).toBeUndefined();
});
});

describe('CaptchaOptions type support', () => {
it('should accept nonce in CaptchaOptions type definition', () => {
// This test verifies that the CaptchaOptions type includes the nonce field
const validOptions: CaptchaOptions = {
action: 'signup',
captchaProvider: 'turnstile',
closeModal: async () => {},
invisibleSiteKey: 'test-invisible-key',
modalContainerQuerySelector: '.modal',
modalWrapperQuerySelector: '.wrapper',
nonce: 'test-nonce-from-csp',
openModal: async () => {},
siteKey: 'test-site-key',
widgetType: 'invisible',
};

// If this compiles without TypeScript errors, the test passes
expect(validOptions.nonce).toBe('test-nonce-from-csp');
});

it('should allow undefined nonce in CaptchaOptions', () => {
const validOptionsWithoutNonce: CaptchaOptions = {
action: 'signup',
captchaProvider: 'turnstile',
invisibleSiteKey: 'test-invisible-key',
siteKey: 'test-site-key',
widgetType: 'invisible',
// nonce is optional
};

expect(validOptionsWithoutNonce.nonce).toBeUndefined();
});
});

describe('CaptchaChallenge nonce integration', () => {
let mockClerk: any;

beforeEach(async () => {
// Mock clerk instance
mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
__internal_getOption: vi.fn().mockReturnValue('clerk-nonce-789'),
};

// Mock getCaptchaToken
vi.doMock('../captcha/getCaptchaToken', () => ({
getCaptchaToken: vi.fn().mockResolvedValue({
captchaToken: 'mock-token',
captchaWidgetType: 'invisible',
}),
}));
});

it('should use nonce from clerk options in invisible challenge', async () => {
const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(mockClerk);
await challenge.invisible({ action: 'signup' });

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: 'clerk-nonce-789',
captchaProvider: 'turnstile',
siteKey: 'test-invisible-key',
widgetType: 'invisible',
}),
);
});

it('should use nonce from clerk options in managedOrInvisible challenge', async () => {
const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(mockClerk);
await challenge.managedOrInvisible({ action: 'verify' });

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: 'clerk-nonce-789',
captchaProvider: 'turnstile',
siteKey: 'test-site-key',
widgetType: 'managed',
}),
);
});

it('should prefer explicit nonce over clerk options nonce', async () => {
const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(mockClerk);
await challenge.invisible({
action: 'signup',
nonce: 'explicit-nonce-override',
});

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: 'explicit-nonce-override',
}),
);
});

it('should handle missing nonce gracefully', async () => {
// Mock clerk without nonce
const clerkWithoutNonce = {
...mockClerk,
__internal_getOption: vi.fn().mockReturnValue(undefined),
};

const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(clerkWithoutNonce);
await challenge.invisible({ action: 'signup' });

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: undefined,
}),
);
});
});
});
16 changes: 9 additions & 7 deletions packages/clerk-js/src/utils/captcha/CaptchaChallenge.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,15 +12,16 @@ export class CaptchaChallenge {
* always use the fallback key.
*/
public async invisible(opts?: Partial<CaptchaOptions>) {
const { captchaSiteKey, canUseCaptcha, captchaPublicKeyInvisible } = retrieveCaptchaInfo(this.clerk);
const { captchaSiteKey, canUseCaptcha, captchaPublicKeyInvisible, nonce } = retrieveCaptchaInfo(this.clerk);

if (canUseCaptcha && captchaSiteKey && captchaPublicKeyInvisible) {
const captchaResult = await getCaptchaToken({
siteKey: captchaPublicKeyInvisible,
action: opts?.action,
captchaProvider: 'turnstile',
invisibleSiteKey: captchaPublicKeyInvisible,
nonce: opts?.nonce || nonce || undefined,
siteKey: captchaPublicKeyInvisible,
widgetType: 'invisible',
captchaProvider: 'turnstile',
action: opts?.action,
}).catch(e => {
if (e.captchaError) {
return { captchaError: e.captchaError };
Expand All@@ -42,15 +43,16 @@ export class CaptchaChallenge {
* Managed challenged start as non-interactive and escalate to interactive if necessary.
*/
public async managedOrInvisible(opts?: Partial<CaptchaOptions>) {
const { captchaSiteKey, canUseCaptcha, captchaWidgetType, captchaProvider, captchaPublicKeyInvisible } =
const { captchaSiteKey, canUseCaptcha, captchaWidgetType, captchaProvider, captchaPublicKeyInvisible, nonce } =
retrieveCaptchaInfo(this.clerk);

if (canUseCaptcha && captchaSiteKey && captchaPublicKeyInvisible) {
const captchaResult = await getCaptchaToken({
captchaProvider,
invisibleSiteKey: captchaPublicKeyInvisible,
nonce: nonce || undefined,
siteKey: captchaSiteKey,
widgetType: captchaWidgetType,
invisibleSiteKey: captchaPublicKeyInvisible,
captchaProvider,
...opts,
}).catch(e => {
if (e.captchaError) {
Expand Down
4 changes: 4 additions & 0 deletions packages/clerk-js/src/utils/captcha/retrieveCaptchaInfo.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,15 @@ export const retrieveCaptchaInfo = (clerk: Clerk) => {
const _environment = clerk.__unstable__environment;
const captchaProvider = _environment ? _environment.displayConfig.captchaProvider : 'turnstile';

// Access nonce via internal options - casting to any since nonce is in IsomorphicClerkOptions but not ClerkOptions
const nonce = (clerk as any).__internal_getOption?.('nonce') as string | undefined;

return {
captchaSiteKey: _environment ? _environment.displayConfig.captchaPublicKey : null,
captchaWidgetType: _environment ? _environment.displayConfig.captchaWidgetType : null,
captchaProvider,
captchaPublicKeyInvisible: _environment ? _environment.displayConfig.captchaPublicKeyInvisible : null,
canUseCaptcha: _environment ? _environment.userSettings.signUp.captcha_enabled && clerk.isStandardBrowser : null,
nonce: nonce || undefined,
};
};
12 changes: 6 additions & 6 deletions packages/clerk-js/src/utils/captcha/turnstile.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,23 +26,23 @@ export const shouldRetryTurnstileErrorCode = (errorCode: string) => {
return !!codesWithRetries.find(w => errorCode.startsWith(w));
};

async function loadCaptcha() {
async function loadCaptcha(nonce?: string) {
if (!window.turnstile) {
await loadCaptchaFromCloudflareURL().catch(() => {
await loadCaptchaFromCloudflareURL(nonce).catch(() => {
// eslint-disable-next-line @typescript-eslint/only-throw-error
throw { captchaError: 'captcha_script_failed_to_load' };
});
}
return window.turnstile;
}

async function loadCaptchaFromCloudflareURL() {
async function loadCaptchaFromCloudflareURL(nonce?: string) {
try {
if (__BUILD_DISABLE_RHC__) {
return Promise.reject(new Error('Captcha not supported in this environment'));
}

return await loadScript(CLOUDFLARE_TURNSTILE_ORIGINAL_URL, { defer: true });
return await loadScript(CLOUDFLARE_TURNSTILE_ORIGINAL_URL, { defer: true, nonce });
} catch (err) {
console.warn(
'Clerk: Failed to load the CAPTCHA script from Cloudflare. If you see a CSP error in your browser, please add the necessary CSP rules to your app. Visit https://clerk.com/docs/security/clerk-csp for more information.',
Expand DownExpand Up@@ -71,9 +71,9 @@ function getCaptchaAttibutesFromElemenet(element: HTMLElement): CaptchaAttribute
* not exist, the invisibleSiteKey is used as a fallback and the widget is rendered in a hidden div at the bottom of the body.
*/
export const getTurnstileToken = async (opts: CaptchaOptions) => {
const { siteKey, widgetType, invisibleSiteKey } = opts;
const { siteKey, widgetType, invisibleSiteKey, nonce } = opts;
const { modalContainerQuerySelector, modalWrapperQuerySelector, closeModal, openModal } = opts;
const captcha: Turnstile.Turnstile = await loadCaptcha();
const captcha: Turnstile.Turnstile = await loadCaptcha(nonce);
const errorCodes: (string | number)[] = [];

let captchaToken = '';
Expand Down
11 changes: 6 additions & 5 deletions packages/clerk-js/src/utils/captcha/types.ts
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
import type { CaptchaProvider, CaptchaWidgetType } from '@clerk/types';

export type CaptchaOptions = {
siteKey: string;
widgetType: CaptchaWidgetType;
invisibleSiteKey: string;
action?: 'verify' | 'signup' | 'heartbeat';
captchaProvider: CaptchaProvider;
closeModal?: () => Promise<unknown>;
invisibleSiteKey: string;
modalContainerQuerySelector?: string;
modalWrapperQuerySelector?: string;
nonce?: string;
openModal?: () => Promise<unknown>;
closeModal?: () => Promise<unknown>;
action?: 'verify' | 'signup' | 'heartbeat';
siteKey: string;
widgetType: CaptchaWidgetType;
};

export type GetCaptchaTokenReturn = {
Expand Down
, '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
5 changes: 5 additions & 0 deletions .changeset/witty-parks-attack.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': minor
---

Adds Content Security Policy (CSP) nonce support to the Cloudflare Turnstile
229 changes: 228 additions & 1 deletion packages/clerk-js/src/utils/__tests__/captcha.spec.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { describe, expect, it } from 'vitest';
import { beforeEach, describe, expect, it, vi } from 'vitest';

import { shouldRetryTurnstileErrorCode } from '../captcha/turnstile';
import type { CaptchaOptions } from '../captcha/types';

describe('shouldRetryTurnstileErrorCode', () => {
it.each([
Expand All@@ -23,3 +24,229 @@ describe('shouldRetryTurnstileErrorCode', () => {
expect(shouldRetryTurnstileErrorCode(str)).toBe(expected);
});
});

describe('Nonce support', () => {
beforeEach(() => {
vi.clearAllMocks();
vi.resetModules();
});

describe('retrieveCaptchaInfo', () => {
it('should extract nonce from clerk options when available', async () => {
// Mock clerk instance with internal options
const mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
__internal_getOption: vi.fn().mockReturnValue('test-nonce-123'),
};

const { retrieveCaptchaInfo } = await import('../captcha/retrieveCaptchaInfo');
const result = retrieveCaptchaInfo(mockClerk as any);

expect(mockClerk.__internal_getOption).toHaveBeenCalledWith('nonce');
expect(result.nonce).toBe('test-nonce-123');
expect(result.captchaSiteKey).toBe('test-site-key');
expect(result.captchaProvider).toBe('turnstile');
});

it('should return undefined nonce when not available in clerk options', async () => {
const mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
__internal_getOption: vi.fn().mockReturnValue(undefined),
};

const { retrieveCaptchaInfo } = await import('../captcha/retrieveCaptchaInfo');
const result = retrieveCaptchaInfo(mockClerk as any);

expect(result.nonce).toBeUndefined();
});

it('should handle clerk instance without __internal_getOption method', async () => {
const mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
// No __internal_getOption method
};

const { retrieveCaptchaInfo } = await import('../captcha/retrieveCaptchaInfo');
const result = retrieveCaptchaInfo(mockClerk as any);

expect(result.nonce).toBeUndefined();
});
});

describe('CaptchaOptions type support', () => {
it('should accept nonce in CaptchaOptions type definition', () => {
// This test verifies that the CaptchaOptions type includes the nonce field
const validOptions: CaptchaOptions = {
action: 'signup',
captchaProvider: 'turnstile',
closeModal: async () => {},
invisibleSiteKey: 'test-invisible-key',
modalContainerQuerySelector: '.modal',
modalWrapperQuerySelector: '.wrapper',
nonce: 'test-nonce-from-csp',
openModal: async () => {},
siteKey: 'test-site-key',
widgetType: 'invisible',
};

// If this compiles without TypeScript errors, the test passes
expect(validOptions.nonce).toBe('test-nonce-from-csp');
});

it('should allow undefined nonce in CaptchaOptions', () => {
const validOptionsWithoutNonce: CaptchaOptions = {
action: 'signup',
captchaProvider: 'turnstile',
invisibleSiteKey: 'test-invisible-key',
siteKey: 'test-site-key',
widgetType: 'invisible',
// nonce is optional
};

expect(validOptionsWithoutNonce.nonce).toBeUndefined();
});
});

describe('CaptchaChallenge nonce integration', () => {
let mockClerk: any;

beforeEach(async () => {
// Mock clerk instance
mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
__internal_getOption: vi.fn().mockReturnValue('clerk-nonce-789'),
};

// Mock getCaptchaToken
vi.doMock('../captcha/getCaptchaToken', () => ({
getCaptchaToken: vi.fn().mockResolvedValue({
captchaToken: 'mock-token',
captchaWidgetType: 'invisible',
}),
}));
});

it('should use nonce from clerk options in invisible challenge', async () => {
const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(mockClerk);
await challenge.invisible({ action: 'signup' });

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: 'clerk-nonce-789',
captchaProvider: 'turnstile',
siteKey: 'test-invisible-key',
widgetType: 'invisible',
}),
);
});

it('should use nonce from clerk options in managedOrInvisible challenge', async () => {
const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(mockClerk);
await challenge.managedOrInvisible({ action: 'verify' });

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: 'clerk-nonce-789',
captchaProvider: 'turnstile',
siteKey: 'test-site-key',
widgetType: 'managed',
}),
);
});

it('should prefer explicit nonce over clerk options nonce', async () => {
const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(mockClerk);
await challenge.invisible({
action: 'signup',
nonce: 'explicit-nonce-override',
});

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: 'explicit-nonce-override',
}),
);
});

it('should handle missing nonce gracefully', async () => {
// Mock clerk without nonce
const clerkWithoutNonce = {
...mockClerk,
__internal_getOption: vi.fn().mockReturnValue(undefined),
};

const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(clerkWithoutNonce);
await challenge.invisible({ action: 'signup' });

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: undefined,
}),
);
});
});
});
16 changes: 9 additions & 7 deletions packages/clerk-js/src/utils/captcha/CaptchaChallenge.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,15 +12,16 @@ export class CaptchaChallenge {
* always use the fallback key.
*/
public async invisible(opts?: Partial<CaptchaOptions>) {
const { captchaSiteKey, canUseCaptcha, captchaPublicKeyInvisible } = retrieveCaptchaInfo(this.clerk);
const { captchaSiteKey, canUseCaptcha, captchaPublicKeyInvisible, nonce } = retrieveCaptchaInfo(this.clerk);

if (canUseCaptcha && captchaSiteKey && captchaPublicKeyInvisible) {
const captchaResult = await getCaptchaToken({
siteKey: captchaPublicKeyInvisible,
action: opts?.action,
captchaProvider: 'turnstile',
invisibleSiteKey: captchaPublicKeyInvisible,
nonce: opts?.nonce || nonce || undefined,
siteKey: captchaPublicKeyInvisible,
widgetType: 'invisible',
captchaProvider: 'turnstile',
action: opts?.action,
}).catch(e => {
if (e.captchaError) {
return { captchaError: e.captchaError };
Expand All@@ -42,15 +43,16 @@ export class CaptchaChallenge {
* Managed challenged start as non-interactive and escalate to interactive if necessary.
*/
public async managedOrInvisible(opts?: Partial<CaptchaOptions>) {
const { captchaSiteKey, canUseCaptcha, captchaWidgetType, captchaProvider, captchaPublicKeyInvisible } =
const { captchaSiteKey, canUseCaptcha, captchaWidgetType, captchaProvider, captchaPublicKeyInvisible, nonce } =
retrieveCaptchaInfo(this.clerk);

if (canUseCaptcha && captchaSiteKey && captchaPublicKeyInvisible) {
const captchaResult = await getCaptchaToken({
captchaProvider,
invisibleSiteKey: captchaPublicKeyInvisible,
nonce: nonce || undefined,
siteKey: captchaSiteKey,
widgetType: captchaWidgetType,
invisibleSiteKey: captchaPublicKeyInvisible,
captchaProvider,
...opts,
}).catch(e => {
if (e.captchaError) {
Expand Down
4 changes: 4 additions & 0 deletions packages/clerk-js/src/utils/captcha/retrieveCaptchaInfo.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,15 @@ export const retrieveCaptchaInfo = (clerk: Clerk) => {
const _environment = clerk.__unstable__environment;
const captchaProvider = _environment ? _environment.displayConfig.captchaProvider : 'turnstile';

// Access nonce via internal options - casting to any since nonce is in IsomorphicClerkOptions but not ClerkOptions
const nonce = (clerk as any).__internal_getOption?.('nonce') as string | undefined;

return {
captchaSiteKey: _environment ? _environment.displayConfig.captchaPublicKey : null,
captchaWidgetType: _environment ? _environment.displayConfig.captchaWidgetType : null,
captchaProvider,
captchaPublicKeyInvisible: _environment ? _environment.displayConfig.captchaPublicKeyInvisible : null,
canUseCaptcha: _environment ? _environment.userSettings.signUp.captcha_enabled && clerk.isStandardBrowser : null,
nonce: nonce || undefined,
};
};
12 changes: 6 additions & 6 deletions packages/clerk-js/src/utils/captcha/turnstile.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,23 +26,23 @@ export const shouldRetryTurnstileErrorCode = (errorCode: string) => {
return !!codesWithRetries.find(w => errorCode.startsWith(w));
};

async function loadCaptcha() {
async function loadCaptcha(nonce?: string) {
if (!window.turnstile) {
await loadCaptchaFromCloudflareURL().catch(() => {
await loadCaptchaFromCloudflareURL(nonce).catch(() => {
// eslint-disable-next-line @typescript-eslint/only-throw-error
throw { captchaError: 'captcha_script_failed_to_load' };
});
}
return window.turnstile;
}

async function loadCaptchaFromCloudflareURL() {
async function loadCaptchaFromCloudflareURL(nonce?: string) {
try {
if (__BUILD_DISABLE_RHC__) {
return Promise.reject(new Error('Captcha not supported in this environment'));
}

return await loadScript(CLOUDFLARE_TURNSTILE_ORIGINAL_URL, { defer: true });
return await loadScript(CLOUDFLARE_TURNSTILE_ORIGINAL_URL, { defer: true, nonce });
} catch (err) {
console.warn(
'Clerk: Failed to load the CAPTCHA script from Cloudflare. If you see a CSP error in your browser, please add the necessary CSP rules to your app. Visit https://clerk.com/docs/security/clerk-csp for more information.',
Expand DownExpand Up@@ -71,9 +71,9 @@ function getCaptchaAttibutesFromElemenet(element: HTMLElement): CaptchaAttribute
* not exist, the invisibleSiteKey is used as a fallback and the widget is rendered in a hidden div at the bottom of the body.
*/
export const getTurnstileToken = async (opts: CaptchaOptions) => {
const { siteKey, widgetType, invisibleSiteKey } = opts;
const { siteKey, widgetType, invisibleSiteKey, nonce } = opts;
const { modalContainerQuerySelector, modalWrapperQuerySelector, closeModal, openModal } = opts;
const captcha: Turnstile.Turnstile = await loadCaptcha();
const captcha: Turnstile.Turnstile = await loadCaptcha(nonce);
const errorCodes: (string | number)[] = [];

let captchaToken = '';
Expand Down
11 changes: 6 additions & 5 deletions packages/clerk-js/src/utils/captcha/types.ts
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
import type { CaptchaProvider, CaptchaWidgetType } from '@clerk/types';

export type CaptchaOptions = {
siteKey: string;
widgetType: CaptchaWidgetType;
invisibleSiteKey: string;
action?: 'verify' | 'signup' | 'heartbeat';
captchaProvider: CaptchaProvider;
closeModal?: () => Promise<unknown>;
invisibleSiteKey: string;
modalContainerQuerySelector?: string;
modalWrapperQuerySelector?: string;
nonce?: string;
openModal?: () => Promise<unknown>;
closeModal?: () => Promise<unknown>;
action?: 'verify' | 'signup' | 'heartbeat';
siteKey: string;
widgetType: CaptchaWidgetType;
};

export type GetCaptchaTokenReturn = {
Expand Down
, '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
5 changes: 5 additions & 0 deletions .changeset/witty-parks-attack.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': minor
---

Adds Content Security Policy (CSP) nonce support to the Cloudflare Turnstile
229 changes: 228 additions & 1 deletion packages/clerk-js/src/utils/__tests__/captcha.spec.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { describe, expect, it } from 'vitest';
import { beforeEach, describe, expect, it, vi } from 'vitest';

import { shouldRetryTurnstileErrorCode } from '../captcha/turnstile';
import type { CaptchaOptions } from '../captcha/types';

describe('shouldRetryTurnstileErrorCode', () => {
it.each([
Expand All@@ -23,3 +24,229 @@ describe('shouldRetryTurnstileErrorCode', () => {
expect(shouldRetryTurnstileErrorCode(str)).toBe(expected);
});
});

describe('Nonce support', () => {
beforeEach(() => {
vi.clearAllMocks();
vi.resetModules();
});

describe('retrieveCaptchaInfo', () => {
it('should extract nonce from clerk options when available', async () => {
// Mock clerk instance with internal options
const mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
__internal_getOption: vi.fn().mockReturnValue('test-nonce-123'),
};

const { retrieveCaptchaInfo } = await import('../captcha/retrieveCaptchaInfo');
const result = retrieveCaptchaInfo(mockClerk as any);

expect(mockClerk.__internal_getOption).toHaveBeenCalledWith('nonce');
expect(result.nonce).toBe('test-nonce-123');
expect(result.captchaSiteKey).toBe('test-site-key');
expect(result.captchaProvider).toBe('turnstile');
});

it('should return undefined nonce when not available in clerk options', async () => {
const mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
__internal_getOption: vi.fn().mockReturnValue(undefined),
};

const { retrieveCaptchaInfo } = await import('../captcha/retrieveCaptchaInfo');
const result = retrieveCaptchaInfo(mockClerk as any);

expect(result.nonce).toBeUndefined();
});

it('should handle clerk instance without __internal_getOption method', async () => {
const mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
// No __internal_getOption method
};

const { retrieveCaptchaInfo } = await import('../captcha/retrieveCaptchaInfo');
const result = retrieveCaptchaInfo(mockClerk as any);

expect(result.nonce).toBeUndefined();
});
});

describe('CaptchaOptions type support', () => {
it('should accept nonce in CaptchaOptions type definition', () => {
// This test verifies that the CaptchaOptions type includes the nonce field
const validOptions: CaptchaOptions = {
action: 'signup',
captchaProvider: 'turnstile',
closeModal: async () => {},
invisibleSiteKey: 'test-invisible-key',
modalContainerQuerySelector: '.modal',
modalWrapperQuerySelector: '.wrapper',
nonce: 'test-nonce-from-csp',
openModal: async () => {},
siteKey: 'test-site-key',
widgetType: 'invisible',
};

// If this compiles without TypeScript errors, the test passes
expect(validOptions.nonce).toBe('test-nonce-from-csp');
});

it('should allow undefined nonce in CaptchaOptions', () => {
const validOptionsWithoutNonce: CaptchaOptions = {
action: 'signup',
captchaProvider: 'turnstile',
invisibleSiteKey: 'test-invisible-key',
siteKey: 'test-site-key',
widgetType: 'invisible',
// nonce is optional
};

expect(validOptionsWithoutNonce.nonce).toBeUndefined();
});
});

describe('CaptchaChallenge nonce integration', () => {
let mockClerk: any;

beforeEach(async () => {
// Mock clerk instance
mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
__internal_getOption: vi.fn().mockReturnValue('clerk-nonce-789'),
};

// Mock getCaptchaToken
vi.doMock('../captcha/getCaptchaToken', () => ({
getCaptchaToken: vi.fn().mockResolvedValue({
captchaToken: 'mock-token',
captchaWidgetType: 'invisible',
}),
}));
});

it('should use nonce from clerk options in invisible challenge', async () => {
const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(mockClerk);
await challenge.invisible({ action: 'signup' });

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: 'clerk-nonce-789',
captchaProvider: 'turnstile',
siteKey: 'test-invisible-key',
widgetType: 'invisible',
}),
);
});

it('should use nonce from clerk options in managedOrInvisible challenge', async () => {
const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(mockClerk);
await challenge.managedOrInvisible({ action: 'verify' });

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: 'clerk-nonce-789',
captchaProvider: 'turnstile',
siteKey: 'test-site-key',
widgetType: 'managed',
}),
);
});

it('should prefer explicit nonce over clerk options nonce', async () => {
const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(mockClerk);
await challenge.invisible({
action: 'signup',
nonce: 'explicit-nonce-override',
});

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: 'explicit-nonce-override',
}),
);
});

it('should handle missing nonce gracefully', async () => {
// Mock clerk without nonce
const clerkWithoutNonce = {
...mockClerk,
__internal_getOption: vi.fn().mockReturnValue(undefined),
};

const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(clerkWithoutNonce);
await challenge.invisible({ action: 'signup' });

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: undefined,
}),
);
});
});
});
16 changes: 9 additions & 7 deletions packages/clerk-js/src/utils/captcha/CaptchaChallenge.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,15 +12,16 @@ export class CaptchaChallenge {
* always use the fallback key.
*/
public async invisible(opts?: Partial<CaptchaOptions>) {
const { captchaSiteKey, canUseCaptcha, captchaPublicKeyInvisible } = retrieveCaptchaInfo(this.clerk);
const { captchaSiteKey, canUseCaptcha, captchaPublicKeyInvisible, nonce } = retrieveCaptchaInfo(this.clerk);

if (canUseCaptcha && captchaSiteKey && captchaPublicKeyInvisible) {
const captchaResult = await getCaptchaToken({
siteKey: captchaPublicKeyInvisible,
action: opts?.action,
captchaProvider: 'turnstile',
invisibleSiteKey: captchaPublicKeyInvisible,
nonce: opts?.nonce || nonce || undefined,
siteKey: captchaPublicKeyInvisible,
widgetType: 'invisible',
captchaProvider: 'turnstile',
action: opts?.action,
}).catch(e => {
if (e.captchaError) {
return { captchaError: e.captchaError };
Expand All@@ -42,15 +43,16 @@ export class CaptchaChallenge {
* Managed challenged start as non-interactive and escalate to interactive if necessary.
*/
public async managedOrInvisible(opts?: Partial<CaptchaOptions>) {
const { captchaSiteKey, canUseCaptcha, captchaWidgetType, captchaProvider, captchaPublicKeyInvisible } =
const { captchaSiteKey, canUseCaptcha, captchaWidgetType, captchaProvider, captchaPublicKeyInvisible, nonce } =
retrieveCaptchaInfo(this.clerk);

if (canUseCaptcha && captchaSiteKey && captchaPublicKeyInvisible) {
const captchaResult = await getCaptchaToken({
captchaProvider,
invisibleSiteKey: captchaPublicKeyInvisible,
nonce: nonce || undefined,
siteKey: captchaSiteKey,
widgetType: captchaWidgetType,
invisibleSiteKey: captchaPublicKeyInvisible,
captchaProvider,
...opts,
}).catch(e => {
if (e.captchaError) {
Expand Down
4 changes: 4 additions & 0 deletions packages/clerk-js/src/utils/captcha/retrieveCaptchaInfo.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,15 @@ export const retrieveCaptchaInfo = (clerk: Clerk) => {
const _environment = clerk.__unstable__environment;
const captchaProvider = _environment ? _environment.displayConfig.captchaProvider : 'turnstile';

// Access nonce via internal options - casting to any since nonce is in IsomorphicClerkOptions but not ClerkOptions
const nonce = (clerk as any).__internal_getOption?.('nonce') as string | undefined;

return {
captchaSiteKey: _environment ? _environment.displayConfig.captchaPublicKey : null,
captchaWidgetType: _environment ? _environment.displayConfig.captchaWidgetType : null,
captchaProvider,
captchaPublicKeyInvisible: _environment ? _environment.displayConfig.captchaPublicKeyInvisible : null,
canUseCaptcha: _environment ? _environment.userSettings.signUp.captcha_enabled && clerk.isStandardBrowser : null,
nonce: nonce || undefined,
};
};
12 changes: 6 additions & 6 deletions packages/clerk-js/src/utils/captcha/turnstile.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,23 +26,23 @@ export const shouldRetryTurnstileErrorCode = (errorCode: string) => {
return !!codesWithRetries.find(w => errorCode.startsWith(w));
};

async function loadCaptcha() {
async function loadCaptcha(nonce?: string) {
if (!window.turnstile) {
await loadCaptchaFromCloudflareURL().catch(() => {
await loadCaptchaFromCloudflareURL(nonce).catch(() => {
// eslint-disable-next-line @typescript-eslint/only-throw-error
throw { captchaError: 'captcha_script_failed_to_load' };
});
}
return window.turnstile;
}

async function loadCaptchaFromCloudflareURL() {
async function loadCaptchaFromCloudflareURL(nonce?: string) {
try {
if (__BUILD_DISABLE_RHC__) {
return Promise.reject(new Error('Captcha not supported in this environment'));
}

return await loadScript(CLOUDFLARE_TURNSTILE_ORIGINAL_URL, { defer: true });
return await loadScript(CLOUDFLARE_TURNSTILE_ORIGINAL_URL, { defer: true, nonce });
} catch (err) {
console.warn(
'Clerk: Failed to load the CAPTCHA script from Cloudflare. If you see a CSP error in your browser, please add the necessary CSP rules to your app. Visit https://clerk.com/docs/security/clerk-csp for more information.',
Expand DownExpand Up@@ -71,9 +71,9 @@ function getCaptchaAttibutesFromElemenet(element: HTMLElement): CaptchaAttribute
* not exist, the invisibleSiteKey is used as a fallback and the widget is rendered in a hidden div at the bottom of the body.
*/
export const getTurnstileToken = async (opts: CaptchaOptions) => {
const { siteKey, widgetType, invisibleSiteKey } = opts;
const { siteKey, widgetType, invisibleSiteKey, nonce } = opts;
const { modalContainerQuerySelector, modalWrapperQuerySelector, closeModal, openModal } = opts;
const captcha: Turnstile.Turnstile = await loadCaptcha();
const captcha: Turnstile.Turnstile = await loadCaptcha(nonce);
const errorCodes: (string | number)[] = [];

let captchaToken = '';
Expand Down
11 changes: 6 additions & 5 deletions packages/clerk-js/src/utils/captcha/types.ts
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
import type { CaptchaProvider, CaptchaWidgetType } from '@clerk/types';

export type CaptchaOptions = {
siteKey: string;
widgetType: CaptchaWidgetType;
invisibleSiteKey: string;
action?: 'verify' | 'signup' | 'heartbeat';
captchaProvider: CaptchaProvider;
closeModal?: () => Promise<unknown>;
invisibleSiteKey: string;
modalContainerQuerySelector?: string;
modalWrapperQuerySelector?: string;
nonce?: string;
openModal?: () => Promise<unknown>;
closeModal?: () => Promise<unknown>;
action?: 'verify' | 'signup' | 'heartbeat';
siteKey: string;
widgetType: CaptchaWidgetType;
};

export type GetCaptchaTokenReturn = {
Expand Down
, '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
5 changes: 5 additions & 0 deletions .changeset/witty-parks-attack.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': minor
---

Adds Content Security Policy (CSP) nonce support to the Cloudflare Turnstile
229 changes: 228 additions & 1 deletion packages/clerk-js/src/utils/__tests__/captcha.spec.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { describe, expect, it } from 'vitest';
import { beforeEach, describe, expect, it, vi } from 'vitest';

import { shouldRetryTurnstileErrorCode } from '../captcha/turnstile';
import type { CaptchaOptions } from '../captcha/types';

describe('shouldRetryTurnstileErrorCode', () => {
it.each([
Expand All@@ -23,3 +24,229 @@ describe('shouldRetryTurnstileErrorCode', () => {
expect(shouldRetryTurnstileErrorCode(str)).toBe(expected);
});
});

describe('Nonce support', () => {
beforeEach(() => {
vi.clearAllMocks();
vi.resetModules();
});

describe('retrieveCaptchaInfo', () => {
it('should extract nonce from clerk options when available', async () => {
// Mock clerk instance with internal options
const mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
__internal_getOption: vi.fn().mockReturnValue('test-nonce-123'),
};

const { retrieveCaptchaInfo } = await import('../captcha/retrieveCaptchaInfo');
const result = retrieveCaptchaInfo(mockClerk as any);

expect(mockClerk.__internal_getOption).toHaveBeenCalledWith('nonce');
expect(result.nonce).toBe('test-nonce-123');
expect(result.captchaSiteKey).toBe('test-site-key');
expect(result.captchaProvider).toBe('turnstile');
});

it('should return undefined nonce when not available in clerk options', async () => {
const mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
__internal_getOption: vi.fn().mockReturnValue(undefined),
};

const { retrieveCaptchaInfo } = await import('../captcha/retrieveCaptchaInfo');
const result = retrieveCaptchaInfo(mockClerk as any);

expect(result.nonce).toBeUndefined();
});

it('should handle clerk instance without __internal_getOption method', async () => {
const mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
// No __internal_getOption method
};

const { retrieveCaptchaInfo } = await import('../captcha/retrieveCaptchaInfo');
const result = retrieveCaptchaInfo(mockClerk as any);

expect(result.nonce).toBeUndefined();
});
});

describe('CaptchaOptions type support', () => {
it('should accept nonce in CaptchaOptions type definition', () => {
// This test verifies that the CaptchaOptions type includes the nonce field
const validOptions: CaptchaOptions = {
action: 'signup',
captchaProvider: 'turnstile',
closeModal: async () => {},
invisibleSiteKey: 'test-invisible-key',
modalContainerQuerySelector: '.modal',
modalWrapperQuerySelector: '.wrapper',
nonce: 'test-nonce-from-csp',
openModal: async () => {},
siteKey: 'test-site-key',
widgetType: 'invisible',
};

// If this compiles without TypeScript errors, the test passes
expect(validOptions.nonce).toBe('test-nonce-from-csp');
});

it('should allow undefined nonce in CaptchaOptions', () => {
const validOptionsWithoutNonce: CaptchaOptions = {
action: 'signup',
captchaProvider: 'turnstile',
invisibleSiteKey: 'test-invisible-key',
siteKey: 'test-site-key',
widgetType: 'invisible',
// nonce is optional
};

expect(validOptionsWithoutNonce.nonce).toBeUndefined();
});
});

describe('CaptchaChallenge nonce integration', () => {
let mockClerk: any;

beforeEach(async () => {
// Mock clerk instance
mockClerk = {
__unstable__environment: {
displayConfig: {
captchaProvider: 'turnstile',
captchaPublicKey: 'test-site-key',
captchaWidgetType: 'managed',
captchaPublicKeyInvisible: 'test-invisible-key',
},
userSettings: {
signUp: {
captcha_enabled: true,
},
},
},
isStandardBrowser: true,
__internal_getOption: vi.fn().mockReturnValue('clerk-nonce-789'),
};

// Mock getCaptchaToken
vi.doMock('../captcha/getCaptchaToken', () => ({
getCaptchaToken: vi.fn().mockResolvedValue({
captchaToken: 'mock-token',
captchaWidgetType: 'invisible',
}),
}));
});

it('should use nonce from clerk options in invisible challenge', async () => {
const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(mockClerk);
await challenge.invisible({ action: 'signup' });

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: 'clerk-nonce-789',
captchaProvider: 'turnstile',
siteKey: 'test-invisible-key',
widgetType: 'invisible',
}),
);
});

it('should use nonce from clerk options in managedOrInvisible challenge', async () => {
const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(mockClerk);
await challenge.managedOrInvisible({ action: 'verify' });

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: 'clerk-nonce-789',
captchaProvider: 'turnstile',
siteKey: 'test-site-key',
widgetType: 'managed',
}),
);
});

it('should prefer explicit nonce over clerk options nonce', async () => {
const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(mockClerk);
await challenge.invisible({
action: 'signup',
nonce: 'explicit-nonce-override',
});

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: 'explicit-nonce-override',
}),
);
});

it('should handle missing nonce gracefully', async () => {
// Mock clerk without nonce
const clerkWithoutNonce = {
...mockClerk,
__internal_getOption: vi.fn().mockReturnValue(undefined),
};

const { getCaptchaToken } = await import('../captcha/getCaptchaToken');
const { CaptchaChallenge } = await import('../captcha/CaptchaChallenge');

const challenge = new CaptchaChallenge(clerkWithoutNonce);
await challenge.invisible({ action: 'signup' });

expect(getCaptchaToken).toHaveBeenCalledWith(
expect.objectContaining({
nonce: undefined,
}),
);
});
});
});
16 changes: 9 additions & 7 deletions packages/clerk-js/src/utils/captcha/CaptchaChallenge.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,15 +12,16 @@ export class CaptchaChallenge {
* always use the fallback key.
*/
public async invisible(opts?: Partial<CaptchaOptions>) {
const { captchaSiteKey, canUseCaptcha, captchaPublicKeyInvisible } = retrieveCaptchaInfo(this.clerk);
const { captchaSiteKey, canUseCaptcha, captchaPublicKeyInvisible, nonce } = retrieveCaptchaInfo(this.clerk);

if (canUseCaptcha && captchaSiteKey && captchaPublicKeyInvisible) {
const captchaResult = await getCaptchaToken({
siteKey: captchaPublicKeyInvisible,
action: opts?.action,
captchaProvider: 'turnstile',
invisibleSiteKey: captchaPublicKeyInvisible,
nonce: opts?.nonce || nonce || undefined,
siteKey: captchaPublicKeyInvisible,
widgetType: 'invisible',
captchaProvider: 'turnstile',
action: opts?.action,
}).catch(e => {
if (e.captchaError) {
return { captchaError: e.captchaError };
Expand All@@ -42,15 +43,16 @@ export class CaptchaChallenge {
* Managed challenged start as non-interactive and escalate to interactive if necessary.
*/
public async managedOrInvisible(opts?: Partial<CaptchaOptions>) {
const { captchaSiteKey, canUseCaptcha, captchaWidgetType, captchaProvider, captchaPublicKeyInvisible } =
const { captchaSiteKey, canUseCaptcha, captchaWidgetType, captchaProvider, captchaPublicKeyInvisible, nonce } =
retrieveCaptchaInfo(this.clerk);

if (canUseCaptcha && captchaSiteKey && captchaPublicKeyInvisible) {
const captchaResult = await getCaptchaToken({
captchaProvider,
invisibleSiteKey: captchaPublicKeyInvisible,
nonce: nonce || undefined,
siteKey: captchaSiteKey,
widgetType: captchaWidgetType,
invisibleSiteKey: captchaPublicKeyInvisible,
captchaProvider,
...opts,
}).catch(e => {
if (e.captchaError) {
Expand Down
4 changes: 4 additions & 0 deletions packages/clerk-js/src/utils/captcha/retrieveCaptchaInfo.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,15 @@ export const retrieveCaptchaInfo = (clerk: Clerk) => {
const _environment = clerk.__unstable__environment;
const captchaProvider = _environment ? _environment.displayConfig.captchaProvider : 'turnstile';

// Access nonce via internal options - casting to any since nonce is in IsomorphicClerkOptions but not ClerkOptions
const nonce = (clerk as any).__internal_getOption?.('nonce') as string | undefined;

return {
captchaSiteKey: _environment ? _environment.displayConfig.captchaPublicKey : null,
captchaWidgetType: _environment ? _environment.displayConfig.captchaWidgetType : null,
captchaProvider,
captchaPublicKeyInvisible: _environment ? _environment.displayConfig.captchaPublicKeyInvisible : null,
canUseCaptcha: _environment ? _environment.userSettings.signUp.captcha_enabled && clerk.isStandardBrowser : null,
nonce: nonce || undefined,
};
};
12 changes: 6 additions & 6 deletions packages/clerk-js/src/utils/captcha/turnstile.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,23 +26,23 @@ export const shouldRetryTurnstileErrorCode = (errorCode: string) => {
return !!codesWithRetries.find(w => errorCode.startsWith(w));
};

async function loadCaptcha() {
async function loadCaptcha(nonce?: string) {
if (!window.turnstile) {
await loadCaptchaFromCloudflareURL().catch(() => {
await loadCaptchaFromCloudflareURL(nonce).catch(() => {
// eslint-disable-next-line @typescript-eslint/only-throw-error
throw { captchaError: 'captcha_script_failed_to_load' };
});
}
return window.turnstile;
}

async function loadCaptchaFromCloudflareURL() {
async function loadCaptchaFromCloudflareURL(nonce?: string) {
try {
if (__BUILD_DISABLE_RHC__) {
return Promise.reject(new Error('Captcha not supported in this environment'));
}

return await loadScript(CLOUDFLARE_TURNSTILE_ORIGINAL_URL, { defer: true });
return await loadScript(CLOUDFLARE_TURNSTILE_ORIGINAL_URL, { defer: true, nonce });
} catch (err) {
console.warn(
'Clerk: Failed to load the CAPTCHA script from Cloudflare. If you see a CSP error in your browser, please add the necessary CSP rules to your app. Visit https://clerk.com/docs/security/clerk-csp for more information.',
Expand DownExpand Up@@ -71,9 +71,9 @@ function getCaptchaAttibutesFromElemenet(element: HTMLElement): CaptchaAttribute
* not exist, the invisibleSiteKey is used as a fallback and the widget is rendered in a hidden div at the bottom of the body.
*/
export const getTurnstileToken = async (opts: CaptchaOptions) => {
const { siteKey, widgetType, invisibleSiteKey } = opts;
const { siteKey, widgetType, invisibleSiteKey, nonce } = opts;
const { modalContainerQuerySelector, modalWrapperQuerySelector, closeModal, openModal } = opts;
const captcha: Turnstile.Turnstile = await loadCaptcha();
const captcha: Turnstile.Turnstile = await loadCaptcha(nonce);
const errorCodes: (string | number)[] = [];

let captchaToken = '';
Expand Down
11 changes: 6 additions & 5 deletions packages/clerk-js/src/utils/captcha/types.ts
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
import type { CaptchaProvider, CaptchaWidgetType } from '@clerk/types';

export type CaptchaOptions = {
siteKey: string;
widgetType: CaptchaWidgetType;
invisibleSiteKey: string;
action?: 'verify' | 'signup' | 'heartbeat';
captchaProvider: CaptchaProvider;
closeModal?: () => Promise<unknown>;
invisibleSiteKey: string;
modalContainerQuerySelector?: string;
modalWrapperQuerySelector?: string;
nonce?: string;
openModal?: () => Promise<unknown>;
closeModal?: () => Promise<unknown>;
action?: 'verify' | 'signup' | 'heartbeat';
siteKey: string;
widgetType: CaptchaWidgetType;
};

export type GetCaptchaTokenReturn = {
Expand Down