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

Filter by extension

Filter by extension

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

Add logic to ensure that we consider the proxy_url when creating the frontendApi url.
279 changes: 279 additions & 0 deletions packages/backend/src/tokens/__tests__/handshake.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -179,6 +179,8 @@ describe('HandshakeService', () => {

it('should use proxy URL when available', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com';
// Simulate what parsePublishableKey does when proxy URL is provided
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
Expand All@@ -195,6 +197,7 @@ describe('HandshakeService', () => {

it('should handle proxy URL with trailing slash', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com/';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com/';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
Expand All@@ -205,6 +208,227 @@ describe('HandshakeService', () => {
expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
});

it('should handle proxy URL with multiple trailing slashes', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com//';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com//';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
expect(location).not.toContain('//v1/client/handshake');
});

it('should handle proxy URL with many trailing slashes', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com///';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com///';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
expect(location).not.toContain('//v1/client/handshake');
});

it('should handle proxy URL without trailing slash', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
});

it('should handle proxy URL with path and trailing slashes', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com/clerk-proxy//';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com/clerk-proxy//';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/clerk-proxy/v1/client/handshake');
expect(location).not.toContain('clerk-proxy//v1/client/handshake');
});

it('should handle non-HTTP frontendApi (domain only)', () => {
mockAuthenticateContext.frontendApi = 'api.clerk.com';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.protocol).toBe('https:');
expect(url.hostname).toBe('api.clerk.com');
expect(url.pathname).toBe('/v1/client/handshake');
});

it('should not include dev browser token in production mode', () => {
mockAuthenticateContext.instanceType = 'production';
mockAuthenticateContext.devBrowserToken = 'dev-token';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.DevBrowser)).toBeNull();
});

it('should not include dev browser token when not available in development', () => {
mockAuthenticateContext.instanceType = 'development';
mockAuthenticateContext.devBrowserToken = undefined;
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.DevBrowser)).toBeNull();
});

it('should handle usesSuffixedCookies returning false', () => {
mockAuthenticateContext.usesSuffixedCookies = vi.fn().mockReturnValue(false);
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.SuffixedCookies)).toBe('false');
});

it('should include organization sync parameters when organization target is found', () => {
// Mock the organization sync methods
const mockTarget = { type: 'organization', id: 'org_123' };
const mockParams = new Map([
['org_id', 'org_123'],
['org_slug', 'test-org'],
]);

vi.spyOn(handshakeService as any, 'getOrganizationSyncTarget').mockReturnValue(mockTarget);
vi.spyOn(handshakeService as any, 'getOrganizationSyncQueryParams').mockReturnValue(mockParams);

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get('org_id')).toBe('org_123');
expect(url.searchParams.get('org_slug')).toBe('test-org');
});

it('should not include organization sync parameters when no target is found', () => {
vi.spyOn(handshakeService as any, 'getOrganizationSyncTarget').mockReturnValue(null);

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get('org_id')).toBeNull();
expect(url.searchParams.get('org_slug')).toBeNull();
});

it('should handle different handshake reasons', () => {
const reasons = ['session-token-expired', 'dev-browser-sync', 'satellite-cookie-needs-syncing'];

reasons.forEach(reason => {
const headers = handshakeService.buildRedirectToHandshake(reason);
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.HandshakeReason)).toBe(reason);
});
});

it('should handle complex clerkUrl with query parameters and fragments', () => {
mockAuthenticateContext.clerkUrl = new URL('https://example.com/path?existing=param#fragment');

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

const redirectUrl = url.searchParams.get('redirect_url');
expect(redirectUrl).toBe('https://example.com/path?existing=param#fragment');
});

it('should create valid URLs with different frontend API formats', () => {
const frontendApiFormats = [
'api.clerk.com',
'https://api.clerk.com',
'https://api.clerk.com/',
'foo-bar-13.clerk.accounts.dev',
'https://foo-bar-13.clerk.accounts.dev',
'clerk.example.com',
'https://clerk.example.com/proxy-path',
];

frontendApiFormats.forEach(frontendApi => {
mockAuthenticateContext.frontendApi = frontendApi;

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);

expect(location).toBeDefined();
if (!location) {
throw new Error('Location header should be defined');
}
expect(() => new URL(location)).not.toThrow();

const url = new URL(location);
// Path should end with '/v1/client/handshake' (may have proxy path prefix)
expect(url.pathname).toMatch(/\/v1\/client\/handshake$/);
expect(url.searchParams.get(constants.QueryParameters.HandshakeReason)).toBe('test-reason');
});
});

it('should always include required query parameters', () => {
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

// Verify all required parameters are present
expect(url.searchParams.get('redirect_url')).toBeDefined();
expect(url.searchParams.get('__clerk_api_version')).toBe('2025-04-10');
expect(url.searchParams.get(constants.QueryParameters.SuffixedCookies)).toMatch(/^(true|false)$/);
expect(url.searchParams.get(constants.QueryParameters.HandshakeReason)).toBe('test-reason');
});
});

describe('handleTokenVerificationErrorInDevelopment', () => {
Expand DownExpand Up@@ -320,4 +544,59 @@ describe('HandshakeService', () => {
spy.mockRestore();
});
});

describe('URL construction edge cases', () => {
const trailingSlashTestCases = [
{ input: 'https://example.com', expected: 'https://example.com' },
{ input: 'https://example.com/', expected: 'https://example.com' },
{ input: 'https://example.com//', expected: 'https://example.com' },
{ input: 'https://example.com///', expected: 'https://example.com' },
{ input: 'https://example.com/path', expected: 'https://example.com/path' },
{ input: 'https://example.com/path/', expected: 'https://example.com/path' },
{ input: 'https://example.com/path//', expected: 'https://example.com/path' },
{ input: 'https://example.com/proxy-path///', expected: 'https://example.com/proxy-path' },
];

trailingSlashTestCases.forEach(({ input, expected }) => {
it(`should correctly handle trailing slashes: "${input}" -> "${expected}"`, () => {
const result = input.replace(/\/+$/, '');
expect(result).toBe(expected);
});
});

it('should construct valid handshake URLs with various proxy configurations', () => {
const proxyConfigs = [
'https://proxy.example.com',
'https://proxy.example.com/',
'https://proxy.example.com//',
'https://proxy.example.com/clerk',
'https://proxy.example.com/clerk/',
'https://proxy.example.com/clerk//',
'https://api.example.com/v1/clerk///',
];

proxyConfigs.forEach(proxyUrl => {
const isolatedContext = {
...mockAuthenticateContext,
proxyUrl: proxyUrl,
frontendApi: proxyUrl,
} as AuthenticateContext;

const isolatedHandshakeService = new HandshakeService(isolatedContext, mockOptions, mockOrganizationMatcher);

const headers = isolatedHandshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);

expect(location).toBeDefined();
if (!location) {
throw new Error('Location header should be defined');
}
expect(location).toContain('/v1/client/handshake');
expect(location).not.toContain('//v1/client/handshake'); // No double slashes

// Ensure URL is valid
expect(() => new URL(location)).not.toThrow();
});
});
});
});
38 changes: 27 additions & 11 deletions packages/backend/src/tokens/authenticateContext.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,31 +10,33 @@ import type { AuthenticateRequestOptions } from './types';

interface AuthenticateContext extends AuthenticateRequestOptions {
// header-based values
tokenInHeader: string | undefined;
origin: string | undefined;
host: string | undefined;
accept: string | undefined;
forwardedHost: string | undefined;
forwardedProto: string | undefined;
host: string | undefined;
origin: string | undefined;
referrer: string | undefined;
userAgent: string | undefined;
secFetchDest: string | undefined;
accept: string | undefined;
tokenInHeader: string | undefined;
userAgent: string | undefined;

// cookie-based values
sessionTokenInCookie: string | undefined;
refreshTokenInCookie: string | undefined;
clientUat: number;
refreshTokenInCookie: string | undefined;
sessionTokenInCookie: string | undefined;

// handshake-related values
devBrowserToken: string | undefined;
handshakeNonce: string | undefined;
handshakeToken: string | undefined;
handshakeRedirectLoopCounter: number;
handshakeToken: string | undefined;

// url derived from headers
clerkUrl: URL;
// enforce existence of the following props
publishableKey: string;
instanceType: string;
frontendApi: string;
instanceType: string;
publishableKey: string;
}

/**
Expand All@@ -44,6 +46,12 @@ interface AuthenticateContext extends AuthenticateRequestOptions {
* to perform a handshake.
*/
class AuthenticateContext implements AuthenticateContext {
/**
* The original Clerk frontend API URL, extracted from publishable key before proxy URL override.
* Used for backend operations like token validation and issuer checking.
*/
private originalFrontendApi: string = '';

/**
* Retrieves the session token from either the cookie or the header.
*
Expand DownExpand Up@@ -163,6 +171,13 @@ class AuthenticateContext implements AuthenticateContext {
assertValidPublishableKey(options.publishableKey);
this.publishableKey = options.publishableKey;

const originalPk = parsePublishableKey(this.publishableKey, {
fatal: true,
domain: options.domain,
isSatellite: options.isSatellite,
});
this.originalFrontendApi = originalPk.frontendApi;

const pk = parsePublishableKey(this.publishableKey, {
fatal: true,
proxyUrl: options.proxyUrl,
Expand DownExpand Up@@ -266,7 +281,8 @@ class AuthenticateContext implements AuthenticateContext {
return false;
}
const tokenIssuer = data.payload.iss.replace(/https?:\/\//gi, '');
return this.frontendApi === tokenIssuer;
// Use original frontend API for token validation since tokens are issued by the actual Clerk API, not proxy
return this.originalFrontendApi === tokenIssuer;
}
Comment on lines 283 to 286

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Issuer check ignores trailing slashes / “/v1” – could produce false negatives

iss values coming from Clerk tokens usually end with /v1/ (or at least /v1).
Comparing the raw host against originalFrontendApi therefore fails for perfectly valid tokens behind a proxy.

- const tokenIssuer = data.payload.iss.replace(/https?:\/\//gi, '');- return this.originalFrontendApi === tokenIssuer;+ const tokenIssuer = data.payload.iss+ .replace(/https?:\/\//gi, '')+ .replace(/\/+v1\/?$/, '') // strip “/v1” if present+ .replace(/\/+$/, ''); // strip trailing slash(es)++ return this.originalFrontendApi.replace(/\/+$/, '') === tokenIssuer;

This keeps proxy handling intact while tolerating the canonical Clerk issuer suffix.

📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
consttokenIssuer=data.payload.iss.replace(/https?:\/\//gi,'');
returnthis.frontendApi===tokenIssuer;
// Use original frontend API for token validation since tokens are issued by the actual Clerk API, not proxy
returnthis.originalFrontendApi===tokenIssuer;
}
consttokenIssuer=data.payload.iss
.replace(/https?:\/\//gi,'')
.replace(/\/+v1\/?$/,'')// strip “/v1” if present
.replace(/\/+$/,'');// strip trailing slash(es)
// Use original frontend API for token validation since tokens are issued by the actual Clerk API, not proxy
returnthis.originalFrontendApi
.replace(/\/+$/,'')===tokenIssuer;
}
🤖 Prompt for AI Agents
In packages/backend/src/tokens/authenticateContext.ts around lines 283 to 286,
the issuer check removes the protocol but does not account for trailing slashes
or path segments like "/v1", causing valid tokens to fail validation. Modify the
code to normalize the issuer by removing the protocol and any trailing slashes
or path suffixes such as "/v1" before comparing it to originalFrontendApi,
ensuring the comparison tolerates the canonical Clerk issuer suffix while
preserving proxy handling.


private sessionExpired(jwt: Jwt | undefined): boolean {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

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

Add logic to ensure that we consider the proxy_url when creating the frontendApi url.
279 changes: 279 additions & 0 deletions packages/backend/src/tokens/__tests__/handshake.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -179,6 +179,8 @@ describe('HandshakeService', () => {

it('should use proxy URL when available', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com';
// Simulate what parsePublishableKey does when proxy URL is provided
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
Expand All@@ -195,6 +197,7 @@ describe('HandshakeService', () => {

it('should handle proxy URL with trailing slash', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com/';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com/';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
Expand All@@ -205,6 +208,227 @@ describe('HandshakeService', () => {
expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
});

it('should handle proxy URL with multiple trailing slashes', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com//';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com//';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
expect(location).not.toContain('//v1/client/handshake');
});

it('should handle proxy URL with many trailing slashes', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com///';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com///';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
expect(location).not.toContain('//v1/client/handshake');
});

it('should handle proxy URL without trailing slash', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
});

it('should handle proxy URL with path and trailing slashes', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com/clerk-proxy//';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com/clerk-proxy//';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/clerk-proxy/v1/client/handshake');
expect(location).not.toContain('clerk-proxy//v1/client/handshake');
});

it('should handle non-HTTP frontendApi (domain only)', () => {
mockAuthenticateContext.frontendApi = 'api.clerk.com';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.protocol).toBe('https:');
expect(url.hostname).toBe('api.clerk.com');
expect(url.pathname).toBe('/v1/client/handshake');
});

it('should not include dev browser token in production mode', () => {
mockAuthenticateContext.instanceType = 'production';
mockAuthenticateContext.devBrowserToken = 'dev-token';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.DevBrowser)).toBeNull();
});

it('should not include dev browser token when not available in development', () => {
mockAuthenticateContext.instanceType = 'development';
mockAuthenticateContext.devBrowserToken = undefined;
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.DevBrowser)).toBeNull();
});

it('should handle usesSuffixedCookies returning false', () => {
mockAuthenticateContext.usesSuffixedCookies = vi.fn().mockReturnValue(false);
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.SuffixedCookies)).toBe('false');
});

it('should include organization sync parameters when organization target is found', () => {
// Mock the organization sync methods
const mockTarget = { type: 'organization', id: 'org_123' };
const mockParams = new Map([
['org_id', 'org_123'],
['org_slug', 'test-org'],
]);

vi.spyOn(handshakeService as any, 'getOrganizationSyncTarget').mockReturnValue(mockTarget);
vi.spyOn(handshakeService as any, 'getOrganizationSyncQueryParams').mockReturnValue(mockParams);

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get('org_id')).toBe('org_123');
expect(url.searchParams.get('org_slug')).toBe('test-org');
});

it('should not include organization sync parameters when no target is found', () => {
vi.spyOn(handshakeService as any, 'getOrganizationSyncTarget').mockReturnValue(null);

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get('org_id')).toBeNull();
expect(url.searchParams.get('org_slug')).toBeNull();
});

it('should handle different handshake reasons', () => {
const reasons = ['session-token-expired', 'dev-browser-sync', 'satellite-cookie-needs-syncing'];

reasons.forEach(reason => {
const headers = handshakeService.buildRedirectToHandshake(reason);
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.HandshakeReason)).toBe(reason);
});
});

it('should handle complex clerkUrl with query parameters and fragments', () => {
mockAuthenticateContext.clerkUrl = new URL('https://example.com/path?existing=param#fragment');

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

const redirectUrl = url.searchParams.get('redirect_url');
expect(redirectUrl).toBe('https://example.com/path?existing=param#fragment');
});

it('should create valid URLs with different frontend API formats', () => {
const frontendApiFormats = [
'api.clerk.com',
'https://api.clerk.com',
'https://api.clerk.com/',
'foo-bar-13.clerk.accounts.dev',
'https://foo-bar-13.clerk.accounts.dev',
'clerk.example.com',
'https://clerk.example.com/proxy-path',
];

frontendApiFormats.forEach(frontendApi => {
mockAuthenticateContext.frontendApi = frontendApi;

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);

expect(location).toBeDefined();
if (!location) {
throw new Error('Location header should be defined');
}
expect(() => new URL(location)).not.toThrow();

const url = new URL(location);
// Path should end with '/v1/client/handshake' (may have proxy path prefix)
expect(url.pathname).toMatch(/\/v1\/client\/handshake$/);
expect(url.searchParams.get(constants.QueryParameters.HandshakeReason)).toBe('test-reason');
});
});

it('should always include required query parameters', () => {
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

// Verify all required parameters are present
expect(url.searchParams.get('redirect_url')).toBeDefined();
expect(url.searchParams.get('__clerk_api_version')).toBe('2025-04-10');
expect(url.searchParams.get(constants.QueryParameters.SuffixedCookies)).toMatch(/^(true|false)$/);
expect(url.searchParams.get(constants.QueryParameters.HandshakeReason)).toBe('test-reason');
});
});

describe('handleTokenVerificationErrorInDevelopment', () => {
Expand DownExpand Up@@ -320,4 +544,59 @@ describe('HandshakeService', () => {
spy.mockRestore();
});
});

describe('URL construction edge cases', () => {
const trailingSlashTestCases = [
{ input: 'https://example.com', expected: 'https://example.com' },
{ input: 'https://example.com/', expected: 'https://example.com' },
{ input: 'https://example.com//', expected: 'https://example.com' },
{ input: 'https://example.com///', expected: 'https://example.com' },
{ input: 'https://example.com/path', expected: 'https://example.com/path' },
{ input: 'https://example.com/path/', expected: 'https://example.com/path' },
{ input: 'https://example.com/path//', expected: 'https://example.com/path' },
{ input: 'https://example.com/proxy-path///', expected: 'https://example.com/proxy-path' },
];

trailingSlashTestCases.forEach(({ input, expected }) => {
it(`should correctly handle trailing slashes: "${input}" -> "${expected}"`, () => {
const result = input.replace(/\/+$/, '');
expect(result).toBe(expected);
});
});

it('should construct valid handshake URLs with various proxy configurations', () => {
const proxyConfigs = [
'https://proxy.example.com',
'https://proxy.example.com/',
'https://proxy.example.com//',
'https://proxy.example.com/clerk',
'https://proxy.example.com/clerk/',
'https://proxy.example.com/clerk//',
'https://api.example.com/v1/clerk///',
];

proxyConfigs.forEach(proxyUrl => {
const isolatedContext = {
...mockAuthenticateContext,
proxyUrl: proxyUrl,
frontendApi: proxyUrl,
} as AuthenticateContext;

const isolatedHandshakeService = new HandshakeService(isolatedContext, mockOptions, mockOrganizationMatcher);

const headers = isolatedHandshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);

expect(location).toBeDefined();
if (!location) {
throw new Error('Location header should be defined');
}
expect(location).toContain('/v1/client/handshake');
expect(location).not.toContain('//v1/client/handshake'); // No double slashes

// Ensure URL is valid
expect(() => new URL(location)).not.toThrow();
});
});
});
});
38 changes: 27 additions & 11 deletions packages/backend/src/tokens/authenticateContext.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,31 +10,33 @@ import type { AuthenticateRequestOptions } from './types';

interface AuthenticateContext extends AuthenticateRequestOptions {
// header-based values
tokenInHeader: string | undefined;
origin: string | undefined;
host: string | undefined;
accept: string | undefined;
forwardedHost: string | undefined;
forwardedProto: string | undefined;
host: string | undefined;
origin: string | undefined;
referrer: string | undefined;
userAgent: string | undefined;
secFetchDest: string | undefined;
accept: string | undefined;
tokenInHeader: string | undefined;
userAgent: string | undefined;

// cookie-based values
sessionTokenInCookie: string | undefined;
refreshTokenInCookie: string | undefined;
clientUat: number;
refreshTokenInCookie: string | undefined;
sessionTokenInCookie: string | undefined;

// handshake-related values
devBrowserToken: string | undefined;
handshakeNonce: string | undefined;
handshakeToken: string | undefined;
handshakeRedirectLoopCounter: number;
handshakeToken: string | undefined;

// url derived from headers
clerkUrl: URL;
// enforce existence of the following props
publishableKey: string;
instanceType: string;
frontendApi: string;
instanceType: string;
publishableKey: string;
}

/**
Expand All@@ -44,6 +46,12 @@ interface AuthenticateContext extends AuthenticateRequestOptions {
* to perform a handshake.
*/
class AuthenticateContext implements AuthenticateContext {
/**
* The original Clerk frontend API URL, extracted from publishable key before proxy URL override.
* Used for backend operations like token validation and issuer checking.
*/
private originalFrontendApi: string = '';

/**
* Retrieves the session token from either the cookie or the header.
*
Expand DownExpand Up@@ -163,6 +171,13 @@ class AuthenticateContext implements AuthenticateContext {
assertValidPublishableKey(options.publishableKey);
this.publishableKey = options.publishableKey;

const originalPk = parsePublishableKey(this.publishableKey, {
fatal: true,
domain: options.domain,
isSatellite: options.isSatellite,
});
this.originalFrontendApi = originalPk.frontendApi;

const pk = parsePublishableKey(this.publishableKey, {
fatal: true,
proxyUrl: options.proxyUrl,
Expand DownExpand Up@@ -266,7 +281,8 @@ class AuthenticateContext implements AuthenticateContext {
return false;
}
const tokenIssuer = data.payload.iss.replace(/https?:\/\//gi, '');
return this.frontendApi === tokenIssuer;
// Use original frontend API for token validation since tokens are issued by the actual Clerk API, not proxy
return this.originalFrontendApi === tokenIssuer;
}
Comment on lines 283 to 286

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Issuer check ignores trailing slashes / “/v1” – could produce false negatives

iss values coming from Clerk tokens usually end with /v1/ (or at least /v1).
Comparing the raw host against originalFrontendApi therefore fails for perfectly valid tokens behind a proxy.

- const tokenIssuer = data.payload.iss.replace(/https?:\/\//gi, '');- return this.originalFrontendApi === tokenIssuer;+ const tokenIssuer = data.payload.iss+ .replace(/https?:\/\//gi, '')+ .replace(/\/+v1\/?$/, '') // strip “/v1” if present+ .replace(/\/+$/, ''); // strip trailing slash(es)++ return this.originalFrontendApi.replace(/\/+$/, '') === tokenIssuer;

This keeps proxy handling intact while tolerating the canonical Clerk issuer suffix.

📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
consttokenIssuer=data.payload.iss.replace(/https?:\/\//gi,'');
returnthis.frontendApi===tokenIssuer;
// Use original frontend API for token validation since tokens are issued by the actual Clerk API, not proxy
returnthis.originalFrontendApi===tokenIssuer;
}
consttokenIssuer=data.payload.iss
.replace(/https?:\/\//gi,'')
.replace(/\/+v1\/?$/,'')// strip “/v1” if present
.replace(/\/+$/,'');// strip trailing slash(es)
// Use original frontend API for token validation since tokens are issued by the actual Clerk API, not proxy
returnthis.originalFrontendApi
.replace(/\/+$/,'')===tokenIssuer;
}
🤖 Prompt for AI Agents
In packages/backend/src/tokens/authenticateContext.ts around lines 283 to 286,
the issuer check removes the protocol but does not account for trailing slashes
or path segments like "/v1", causing valid tokens to fail validation. Modify the
code to normalize the issuer by removing the protocol and any trailing slashes
or path suffixes such as "/v1" before comparing it to originalFrontendApi,
ensuring the comparison tolerates the canonical Clerk issuer suffix while
preserving proxy handling.


private sessionExpired(jwt: Jwt | undefined): boolean {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

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

Add logic to ensure that we consider the proxy_url when creating the frontendApi url.
279 changes: 279 additions & 0 deletions packages/backend/src/tokens/__tests__/handshake.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -179,6 +179,8 @@ describe('HandshakeService', () => {

it('should use proxy URL when available', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com';
// Simulate what parsePublishableKey does when proxy URL is provided
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
Expand All@@ -195,6 +197,7 @@ describe('HandshakeService', () => {

it('should handle proxy URL with trailing slash', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com/';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com/';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
Expand All@@ -205,6 +208,227 @@ describe('HandshakeService', () => {
expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
});

it('should handle proxy URL with multiple trailing slashes', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com//';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com//';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
expect(location).not.toContain('//v1/client/handshake');
});

it('should handle proxy URL with many trailing slashes', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com///';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com///';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
expect(location).not.toContain('//v1/client/handshake');
});

it('should handle proxy URL without trailing slash', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
});

it('should handle proxy URL with path and trailing slashes', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com/clerk-proxy//';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com/clerk-proxy//';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/clerk-proxy/v1/client/handshake');
expect(location).not.toContain('clerk-proxy//v1/client/handshake');
});

it('should handle non-HTTP frontendApi (domain only)', () => {
mockAuthenticateContext.frontendApi = 'api.clerk.com';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.protocol).toBe('https:');
expect(url.hostname).toBe('api.clerk.com');
expect(url.pathname).toBe('/v1/client/handshake');
});

it('should not include dev browser token in production mode', () => {
mockAuthenticateContext.instanceType = 'production';
mockAuthenticateContext.devBrowserToken = 'dev-token';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.DevBrowser)).toBeNull();
});

it('should not include dev browser token when not available in development', () => {
mockAuthenticateContext.instanceType = 'development';
mockAuthenticateContext.devBrowserToken = undefined;
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.DevBrowser)).toBeNull();
});

it('should handle usesSuffixedCookies returning false', () => {
mockAuthenticateContext.usesSuffixedCookies = vi.fn().mockReturnValue(false);
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.SuffixedCookies)).toBe('false');
});

it('should include organization sync parameters when organization target is found', () => {
// Mock the organization sync methods
const mockTarget = { type: 'organization', id: 'org_123' };
const mockParams = new Map([
['org_id', 'org_123'],
['org_slug', 'test-org'],
]);

vi.spyOn(handshakeService as any, 'getOrganizationSyncTarget').mockReturnValue(mockTarget);
vi.spyOn(handshakeService as any, 'getOrganizationSyncQueryParams').mockReturnValue(mockParams);

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get('org_id')).toBe('org_123');
expect(url.searchParams.get('org_slug')).toBe('test-org');
});

it('should not include organization sync parameters when no target is found', () => {
vi.spyOn(handshakeService as any, 'getOrganizationSyncTarget').mockReturnValue(null);

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get('org_id')).toBeNull();
expect(url.searchParams.get('org_slug')).toBeNull();
});

it('should handle different handshake reasons', () => {
const reasons = ['session-token-expired', 'dev-browser-sync', 'satellite-cookie-needs-syncing'];

reasons.forEach(reason => {
const headers = handshakeService.buildRedirectToHandshake(reason);
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.HandshakeReason)).toBe(reason);
});
});

it('should handle complex clerkUrl with query parameters and fragments', () => {
mockAuthenticateContext.clerkUrl = new URL('https://example.com/path?existing=param#fragment');

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

const redirectUrl = url.searchParams.get('redirect_url');
expect(redirectUrl).toBe('https://example.com/path?existing=param#fragment');
});

it('should create valid URLs with different frontend API formats', () => {
const frontendApiFormats = [
'api.clerk.com',
'https://api.clerk.com',
'https://api.clerk.com/',
'foo-bar-13.clerk.accounts.dev',
'https://foo-bar-13.clerk.accounts.dev',
'clerk.example.com',
'https://clerk.example.com/proxy-path',
];

frontendApiFormats.forEach(frontendApi => {
mockAuthenticateContext.frontendApi = frontendApi;

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);

expect(location).toBeDefined();
if (!location) {
throw new Error('Location header should be defined');
}
expect(() => new URL(location)).not.toThrow();

const url = new URL(location);
// Path should end with '/v1/client/handshake' (may have proxy path prefix)
expect(url.pathname).toMatch(/\/v1\/client\/handshake$/);
expect(url.searchParams.get(constants.QueryParameters.HandshakeReason)).toBe('test-reason');
});
});

it('should always include required query parameters', () => {
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

// Verify all required parameters are present
expect(url.searchParams.get('redirect_url')).toBeDefined();
expect(url.searchParams.get('__clerk_api_version')).toBe('2025-04-10');
expect(url.searchParams.get(constants.QueryParameters.SuffixedCookies)).toMatch(/^(true|false)$/);
expect(url.searchParams.get(constants.QueryParameters.HandshakeReason)).toBe('test-reason');
});
});

describe('handleTokenVerificationErrorInDevelopment', () => {
Expand DownExpand Up@@ -320,4 +544,59 @@ describe('HandshakeService', () => {
spy.mockRestore();
});
});

describe('URL construction edge cases', () => {
const trailingSlashTestCases = [
{ input: 'https://example.com', expected: 'https://example.com' },
{ input: 'https://example.com/', expected: 'https://example.com' },
{ input: 'https://example.com//', expected: 'https://example.com' },
{ input: 'https://example.com///', expected: 'https://example.com' },
{ input: 'https://example.com/path', expected: 'https://example.com/path' },
{ input: 'https://example.com/path/', expected: 'https://example.com/path' },
{ input: 'https://example.com/path//', expected: 'https://example.com/path' },
{ input: 'https://example.com/proxy-path///', expected: 'https://example.com/proxy-path' },
];

trailingSlashTestCases.forEach(({ input, expected }) => {
it(`should correctly handle trailing slashes: "${input}" -> "${expected}"`, () => {
const result = input.replace(/\/+$/, '');
expect(result).toBe(expected);
});
});

it('should construct valid handshake URLs with various proxy configurations', () => {
const proxyConfigs = [
'https://proxy.example.com',
'https://proxy.example.com/',
'https://proxy.example.com//',
'https://proxy.example.com/clerk',
'https://proxy.example.com/clerk/',
'https://proxy.example.com/clerk//',
'https://api.example.com/v1/clerk///',
];

proxyConfigs.forEach(proxyUrl => {
const isolatedContext = {
...mockAuthenticateContext,
proxyUrl: proxyUrl,
frontendApi: proxyUrl,
} as AuthenticateContext;

const isolatedHandshakeService = new HandshakeService(isolatedContext, mockOptions, mockOrganizationMatcher);

const headers = isolatedHandshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);

expect(location).toBeDefined();
if (!location) {
throw new Error('Location header should be defined');
}
expect(location).toContain('/v1/client/handshake');
expect(location).not.toContain('//v1/client/handshake'); // No double slashes

// Ensure URL is valid
expect(() => new URL(location)).not.toThrow();
});
});
});
});
38 changes: 27 additions & 11 deletions packages/backend/src/tokens/authenticateContext.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,31 +10,33 @@ import type { AuthenticateRequestOptions } from './types';

interface AuthenticateContext extends AuthenticateRequestOptions {
// header-based values
tokenInHeader: string | undefined;
origin: string | undefined;
host: string | undefined;
accept: string | undefined;
forwardedHost: string | undefined;
forwardedProto: string | undefined;
host: string | undefined;
origin: string | undefined;
referrer: string | undefined;
userAgent: string | undefined;
secFetchDest: string | undefined;
accept: string | undefined;
tokenInHeader: string | undefined;
userAgent: string | undefined;

// cookie-based values
sessionTokenInCookie: string | undefined;
refreshTokenInCookie: string | undefined;
clientUat: number;
refreshTokenInCookie: string | undefined;
sessionTokenInCookie: string | undefined;

// handshake-related values
devBrowserToken: string | undefined;
handshakeNonce: string | undefined;
handshakeToken: string | undefined;
handshakeRedirectLoopCounter: number;
handshakeToken: string | undefined;

// url derived from headers
clerkUrl: URL;
// enforce existence of the following props
publishableKey: string;
instanceType: string;
frontendApi: string;
instanceType: string;
publishableKey: string;
}

/**
Expand All@@ -44,6 +46,12 @@ interface AuthenticateContext extends AuthenticateRequestOptions {
* to perform a handshake.
*/
class AuthenticateContext implements AuthenticateContext {
/**
* The original Clerk frontend API URL, extracted from publishable key before proxy URL override.
* Used for backend operations like token validation and issuer checking.
*/
private originalFrontendApi: string = '';

/**
* Retrieves the session token from either the cookie or the header.
*
Expand DownExpand Up@@ -163,6 +171,13 @@ class AuthenticateContext implements AuthenticateContext {
assertValidPublishableKey(options.publishableKey);
this.publishableKey = options.publishableKey;

const originalPk = parsePublishableKey(this.publishableKey, {
fatal: true,
domain: options.domain,
isSatellite: options.isSatellite,
});
this.originalFrontendApi = originalPk.frontendApi;

const pk = parsePublishableKey(this.publishableKey, {
fatal: true,
proxyUrl: options.proxyUrl,
Expand DownExpand Up@@ -266,7 +281,8 @@ class AuthenticateContext implements AuthenticateContext {
return false;
}
const tokenIssuer = data.payload.iss.replace(/https?:\/\//gi, '');
return this.frontendApi === tokenIssuer;
// Use original frontend API for token validation since tokens are issued by the actual Clerk API, not proxy
return this.originalFrontendApi === tokenIssuer;
}
Comment on lines 283 to 286

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Issuer check ignores trailing slashes / “/v1” – could produce false negatives

iss values coming from Clerk tokens usually end with /v1/ (or at least /v1).
Comparing the raw host against originalFrontendApi therefore fails for perfectly valid tokens behind a proxy.

- const tokenIssuer = data.payload.iss.replace(/https?:\/\//gi, '');- return this.originalFrontendApi === tokenIssuer;+ const tokenIssuer = data.payload.iss+ .replace(/https?:\/\//gi, '')+ .replace(/\/+v1\/?$/, '') // strip “/v1” if present+ .replace(/\/+$/, ''); // strip trailing slash(es)++ return this.originalFrontendApi.replace(/\/+$/, '') === tokenIssuer;

This keeps proxy handling intact while tolerating the canonical Clerk issuer suffix.

📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
consttokenIssuer=data.payload.iss.replace(/https?:\/\//gi,'');
returnthis.frontendApi===tokenIssuer;
// Use original frontend API for token validation since tokens are issued by the actual Clerk API, not proxy
returnthis.originalFrontendApi===tokenIssuer;
}
consttokenIssuer=data.payload.iss
.replace(/https?:\/\//gi,'')
.replace(/\/+v1\/?$/,'')// strip “/v1” if present
.replace(/\/+$/,'');// strip trailing slash(es)
// Use original frontend API for token validation since tokens are issued by the actual Clerk API, not proxy
returnthis.originalFrontendApi
.replace(/\/+$/,'')===tokenIssuer;
}
🤖 Prompt for AI Agents
In packages/backend/src/tokens/authenticateContext.ts around lines 283 to 286,
the issuer check removes the protocol but does not account for trailing slashes
or path segments like "/v1", causing valid tokens to fail validation. Modify the
code to normalize the issuer by removing the protocol and any trailing slashes
or path suffixes such as "/v1" before comparing it to originalFrontendApi,
ensuring the comparison tolerates the canonical Clerk issuer suffix while
preserving proxy handling.


private sessionExpired(jwt: Jwt | undefined): boolean {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

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

Add logic to ensure that we consider the proxy_url when creating the frontendApi url.
279 changes: 279 additions & 0 deletions packages/backend/src/tokens/__tests__/handshake.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -179,6 +179,8 @@ describe('HandshakeService', () => {

it('should use proxy URL when available', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com';
// Simulate what parsePublishableKey does when proxy URL is provided
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
Expand All@@ -195,6 +197,7 @@ describe('HandshakeService', () => {

it('should handle proxy URL with trailing slash', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com/';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com/';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
Expand All@@ -205,6 +208,227 @@ describe('HandshakeService', () => {
expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
});

it('should handle proxy URL with multiple trailing slashes', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com//';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com//';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
expect(location).not.toContain('//v1/client/handshake');
});

it('should handle proxy URL with many trailing slashes', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com///';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com///';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
expect(location).not.toContain('//v1/client/handshake');
});

it('should handle proxy URL without trailing slash', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
});

it('should handle proxy URL with path and trailing slashes', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com/clerk-proxy//';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com/clerk-proxy//';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/clerk-proxy/v1/client/handshake');
expect(location).not.toContain('clerk-proxy//v1/client/handshake');
});

it('should handle non-HTTP frontendApi (domain only)', () => {
mockAuthenticateContext.frontendApi = 'api.clerk.com';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.protocol).toBe('https:');
expect(url.hostname).toBe('api.clerk.com');
expect(url.pathname).toBe('/v1/client/handshake');
});

it('should not include dev browser token in production mode', () => {
mockAuthenticateContext.instanceType = 'production';
mockAuthenticateContext.devBrowserToken = 'dev-token';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.DevBrowser)).toBeNull();
});

it('should not include dev browser token when not available in development', () => {
mockAuthenticateContext.instanceType = 'development';
mockAuthenticateContext.devBrowserToken = undefined;
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.DevBrowser)).toBeNull();
});

it('should handle usesSuffixedCookies returning false', () => {
mockAuthenticateContext.usesSuffixedCookies = vi.fn().mockReturnValue(false);
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.SuffixedCookies)).toBe('false');
});

it('should include organization sync parameters when organization target is found', () => {
// Mock the organization sync methods
const mockTarget = { type: 'organization', id: 'org_123' };
const mockParams = new Map([
['org_id', 'org_123'],
['org_slug', 'test-org'],
]);

vi.spyOn(handshakeService as any, 'getOrganizationSyncTarget').mockReturnValue(mockTarget);
vi.spyOn(handshakeService as any, 'getOrganizationSyncQueryParams').mockReturnValue(mockParams);

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get('org_id')).toBe('org_123');
expect(url.searchParams.get('org_slug')).toBe('test-org');
});

it('should not include organization sync parameters when no target is found', () => {
vi.spyOn(handshakeService as any, 'getOrganizationSyncTarget').mockReturnValue(null);

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get('org_id')).toBeNull();
expect(url.searchParams.get('org_slug')).toBeNull();
});

it('should handle different handshake reasons', () => {
const reasons = ['session-token-expired', 'dev-browser-sync', 'satellite-cookie-needs-syncing'];

reasons.forEach(reason => {
const headers = handshakeService.buildRedirectToHandshake(reason);
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.HandshakeReason)).toBe(reason);
});
});

it('should handle complex clerkUrl with query parameters and fragments', () => {
mockAuthenticateContext.clerkUrl = new URL('https://example.com/path?existing=param#fragment');

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

const redirectUrl = url.searchParams.get('redirect_url');
expect(redirectUrl).toBe('https://example.com/path?existing=param#fragment');
});

it('should create valid URLs with different frontend API formats', () => {
const frontendApiFormats = [
'api.clerk.com',
'https://api.clerk.com',
'https://api.clerk.com/',
'foo-bar-13.clerk.accounts.dev',
'https://foo-bar-13.clerk.accounts.dev',
'clerk.example.com',
'https://clerk.example.com/proxy-path',
];

frontendApiFormats.forEach(frontendApi => {
mockAuthenticateContext.frontendApi = frontendApi;

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);

expect(location).toBeDefined();
if (!location) {
throw new Error('Location header should be defined');
}
expect(() => new URL(location)).not.toThrow();

const url = new URL(location);
// Path should end with '/v1/client/handshake' (may have proxy path prefix)
expect(url.pathname).toMatch(/\/v1\/client\/handshake$/);
expect(url.searchParams.get(constants.QueryParameters.HandshakeReason)).toBe('test-reason');
});
});

it('should always include required query parameters', () => {
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

// Verify all required parameters are present
expect(url.searchParams.get('redirect_url')).toBeDefined();
expect(url.searchParams.get('__clerk_api_version')).toBe('2025-04-10');
expect(url.searchParams.get(constants.QueryParameters.SuffixedCookies)).toMatch(/^(true|false)$/);
expect(url.searchParams.get(constants.QueryParameters.HandshakeReason)).toBe('test-reason');
});
});

describe('handleTokenVerificationErrorInDevelopment', () => {
Expand DownExpand Up@@ -320,4 +544,59 @@ describe('HandshakeService', () => {
spy.mockRestore();
});
});

describe('URL construction edge cases', () => {
const trailingSlashTestCases = [
{ input: 'https://example.com', expected: 'https://example.com' },
{ input: 'https://example.com/', expected: 'https://example.com' },
{ input: 'https://example.com//', expected: 'https://example.com' },
{ input: 'https://example.com///', expected: 'https://example.com' },
{ input: 'https://example.com/path', expected: 'https://example.com/path' },
{ input: 'https://example.com/path/', expected: 'https://example.com/path' },
{ input: 'https://example.com/path//', expected: 'https://example.com/path' },
{ input: 'https://example.com/proxy-path///', expected: 'https://example.com/proxy-path' },
];

trailingSlashTestCases.forEach(({ input, expected }) => {
it(`should correctly handle trailing slashes: "${input}" -> "${expected}"`, () => {
const result = input.replace(/\/+$/, '');
expect(result).toBe(expected);
});
});

it('should construct valid handshake URLs with various proxy configurations', () => {
const proxyConfigs = [
'https://proxy.example.com',
'https://proxy.example.com/',
'https://proxy.example.com//',
'https://proxy.example.com/clerk',
'https://proxy.example.com/clerk/',
'https://proxy.example.com/clerk//',
'https://api.example.com/v1/clerk///',
];

proxyConfigs.forEach(proxyUrl => {
const isolatedContext = {
...mockAuthenticateContext,
proxyUrl: proxyUrl,
frontendApi: proxyUrl,
} as AuthenticateContext;

const isolatedHandshakeService = new HandshakeService(isolatedContext, mockOptions, mockOrganizationMatcher);

const headers = isolatedHandshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);

expect(location).toBeDefined();
if (!location) {
throw new Error('Location header should be defined');
}
expect(location).toContain('/v1/client/handshake');
expect(location).not.toContain('//v1/client/handshake'); // No double slashes

// Ensure URL is valid
expect(() => new URL(location)).not.toThrow();
});
});
});
});
38 changes: 27 additions & 11 deletions packages/backend/src/tokens/authenticateContext.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,31 +10,33 @@ import type { AuthenticateRequestOptions } from './types';

interface AuthenticateContext extends AuthenticateRequestOptions {
// header-based values
tokenInHeader: string | undefined;
origin: string | undefined;
host: string | undefined;
accept: string | undefined;
forwardedHost: string | undefined;
forwardedProto: string | undefined;
host: string | undefined;
origin: string | undefined;
referrer: string | undefined;
userAgent: string | undefined;
secFetchDest: string | undefined;
accept: string | undefined;
tokenInHeader: string | undefined;
userAgent: string | undefined;

// cookie-based values
sessionTokenInCookie: string | undefined;
refreshTokenInCookie: string | undefined;
clientUat: number;
refreshTokenInCookie: string | undefined;
sessionTokenInCookie: string | undefined;

// handshake-related values
devBrowserToken: string | undefined;
handshakeNonce: string | undefined;
handshakeToken: string | undefined;
handshakeRedirectLoopCounter: number;
handshakeToken: string | undefined;

// url derived from headers
clerkUrl: URL;
// enforce existence of the following props
publishableKey: string;
instanceType: string;
frontendApi: string;
instanceType: string;
publishableKey: string;
}

/**
Expand All@@ -44,6 +46,12 @@ interface AuthenticateContext extends AuthenticateRequestOptions {
* to perform a handshake.
*/
class AuthenticateContext implements AuthenticateContext {
/**
* The original Clerk frontend API URL, extracted from publishable key before proxy URL override.
* Used for backend operations like token validation and issuer checking.
*/
private originalFrontendApi: string = '';

/**
* Retrieves the session token from either the cookie or the header.
*
Expand DownExpand Up@@ -163,6 +171,13 @@ class AuthenticateContext implements AuthenticateContext {
assertValidPublishableKey(options.publishableKey);
this.publishableKey = options.publishableKey;

const originalPk = parsePublishableKey(this.publishableKey, {
fatal: true,
domain: options.domain,
isSatellite: options.isSatellite,
});
this.originalFrontendApi = originalPk.frontendApi;

const pk = parsePublishableKey(this.publishableKey, {
fatal: true,
proxyUrl: options.proxyUrl,
Expand DownExpand Up@@ -266,7 +281,8 @@ class AuthenticateContext implements AuthenticateContext {
return false;
}
const tokenIssuer = data.payload.iss.replace(/https?:\/\//gi, '');
return this.frontendApi === tokenIssuer;
// Use original frontend API for token validation since tokens are issued by the actual Clerk API, not proxy
return this.originalFrontendApi === tokenIssuer;
}
Comment on lines 283 to 286

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Issuer check ignores trailing slashes / “/v1” – could produce false negatives

iss values coming from Clerk tokens usually end with /v1/ (or at least /v1).
Comparing the raw host against originalFrontendApi therefore fails for perfectly valid tokens behind a proxy.

- const tokenIssuer = data.payload.iss.replace(/https?:\/\//gi, '');- return this.originalFrontendApi === tokenIssuer;+ const tokenIssuer = data.payload.iss+ .replace(/https?:\/\//gi, '')+ .replace(/\/+v1\/?$/, '') // strip “/v1” if present+ .replace(/\/+$/, ''); // strip trailing slash(es)++ return this.originalFrontendApi.replace(/\/+$/, '') === tokenIssuer;

This keeps proxy handling intact while tolerating the canonical Clerk issuer suffix.

📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
consttokenIssuer=data.payload.iss.replace(/https?:\/\//gi,'');
returnthis.frontendApi===tokenIssuer;
// Use original frontend API for token validation since tokens are issued by the actual Clerk API, not proxy
returnthis.originalFrontendApi===tokenIssuer;
}
consttokenIssuer=data.payload.iss
.replace(/https?:\/\//gi,'')
.replace(/\/+v1\/?$/,'')// strip “/v1” if present
.replace(/\/+$/,'');// strip trailing slash(es)
// Use original frontend API for token validation since tokens are issued by the actual Clerk API, not proxy
returnthis.originalFrontendApi
.replace(/\/+$/,'')===tokenIssuer;
}
🤖 Prompt for AI Agents
In packages/backend/src/tokens/authenticateContext.ts around lines 283 to 286,
the issuer check removes the protocol but does not account for trailing slashes
or path segments like "/v1", causing valid tokens to fail validation. Modify the
code to normalize the issuer by removing the protocol and any trailing slashes
or path suffixes such as "/v1" before comparing it to originalFrontendApi,
ensuring the comparison tolerates the canonical Clerk issuer suffix while
preserving proxy handling.


private sessionExpired(jwt: Jwt | undefined): boolean {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

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

Add logic to ensure that we consider the proxy_url when creating the frontendApi url.
279 changes: 279 additions & 0 deletions packages/backend/src/tokens/__tests__/handshake.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -179,6 +179,8 @@ describe('HandshakeService', () => {

it('should use proxy URL when available', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com';
// Simulate what parsePublishableKey does when proxy URL is provided
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
Expand All@@ -195,6 +197,7 @@ describe('HandshakeService', () => {

it('should handle proxy URL with trailing slash', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com/';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com/';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
Expand All@@ -205,6 +208,227 @@ describe('HandshakeService', () => {
expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
});

it('should handle proxy URL with multiple trailing slashes', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com//';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com//';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
expect(location).not.toContain('//v1/client/handshake');
});

it('should handle proxy URL with many trailing slashes', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com///';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com///';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
expect(location).not.toContain('//v1/client/handshake');
});

it('should handle proxy URL without trailing slash', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
});

it('should handle proxy URL with path and trailing slashes', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com/clerk-proxy//';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com/clerk-proxy//';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/clerk-proxy/v1/client/handshake');
expect(location).not.toContain('clerk-proxy//v1/client/handshake');
});

it('should handle non-HTTP frontendApi (domain only)', () => {
mockAuthenticateContext.frontendApi = 'api.clerk.com';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.protocol).toBe('https:');
expect(url.hostname).toBe('api.clerk.com');
expect(url.pathname).toBe('/v1/client/handshake');
});

it('should not include dev browser token in production mode', () => {
mockAuthenticateContext.instanceType = 'production';
mockAuthenticateContext.devBrowserToken = 'dev-token';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.DevBrowser)).toBeNull();
});

it('should not include dev browser token when not available in development', () => {
mockAuthenticateContext.instanceType = 'development';
mockAuthenticateContext.devBrowserToken = undefined;
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.DevBrowser)).toBeNull();
});

it('should handle usesSuffixedCookies returning false', () => {
mockAuthenticateContext.usesSuffixedCookies = vi.fn().mockReturnValue(false);
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.SuffixedCookies)).toBe('false');
});

it('should include organization sync parameters when organization target is found', () => {
// Mock the organization sync methods
const mockTarget = { type: 'organization', id: 'org_123' };
const mockParams = new Map([
['org_id', 'org_123'],
['org_slug', 'test-org'],
]);

vi.spyOn(handshakeService as any, 'getOrganizationSyncTarget').mockReturnValue(mockTarget);
vi.spyOn(handshakeService as any, 'getOrganizationSyncQueryParams').mockReturnValue(mockParams);

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get('org_id')).toBe('org_123');
expect(url.searchParams.get('org_slug')).toBe('test-org');
});

it('should not include organization sync parameters when no target is found', () => {
vi.spyOn(handshakeService as any, 'getOrganizationSyncTarget').mockReturnValue(null);

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get('org_id')).toBeNull();
expect(url.searchParams.get('org_slug')).toBeNull();
});

it('should handle different handshake reasons', () => {
const reasons = ['session-token-expired', 'dev-browser-sync', 'satellite-cookie-needs-syncing'];

reasons.forEach(reason => {
const headers = handshakeService.buildRedirectToHandshake(reason);
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.HandshakeReason)).toBe(reason);
});
});

it('should handle complex clerkUrl with query parameters and fragments', () => {
mockAuthenticateContext.clerkUrl = new URL('https://example.com/path?existing=param#fragment');

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

const redirectUrl = url.searchParams.get('redirect_url');
expect(redirectUrl).toBe('https://example.com/path?existing=param#fragment');
});

it('should create valid URLs with different frontend API formats', () => {
const frontendApiFormats = [
'api.clerk.com',
'https://api.clerk.com',
'https://api.clerk.com/',
'foo-bar-13.clerk.accounts.dev',
'https://foo-bar-13.clerk.accounts.dev',
'clerk.example.com',
'https://clerk.example.com/proxy-path',
];

frontendApiFormats.forEach(frontendApi => {
mockAuthenticateContext.frontendApi = frontendApi;

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);

expect(location).toBeDefined();
if (!location) {
throw new Error('Location header should be defined');
}
expect(() => new URL(location)).not.toThrow();

const url = new URL(location);
// Path should end with '/v1/client/handshake' (may have proxy path prefix)
expect(url.pathname).toMatch(/\/v1\/client\/handshake$/);
expect(url.searchParams.get(constants.QueryParameters.HandshakeReason)).toBe('test-reason');
});
});

it('should always include required query parameters', () => {
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

// Verify all required parameters are present
expect(url.searchParams.get('redirect_url')).toBeDefined();
expect(url.searchParams.get('__clerk_api_version')).toBe('2025-04-10');
expect(url.searchParams.get(constants.QueryParameters.SuffixedCookies)).toMatch(/^(true|false)$/);
expect(url.searchParams.get(constants.QueryParameters.HandshakeReason)).toBe('test-reason');
});
});

describe('handleTokenVerificationErrorInDevelopment', () => {
Expand DownExpand Up@@ -320,4 +544,59 @@ describe('HandshakeService', () => {
spy.mockRestore();
});
});

describe('URL construction edge cases', () => {
const trailingSlashTestCases = [
{ input: 'https://example.com', expected: 'https://example.com' },
{ input: 'https://example.com/', expected: 'https://example.com' },
{ input: 'https://example.com//', expected: 'https://example.com' },
{ input: 'https://example.com///', expected: 'https://example.com' },
{ input: 'https://example.com/path', expected: 'https://example.com/path' },
{ input: 'https://example.com/path/', expected: 'https://example.com/path' },
{ input: 'https://example.com/path//', expected: 'https://example.com/path' },
{ input: 'https://example.com/proxy-path///', expected: 'https://example.com/proxy-path' },
];

trailingSlashTestCases.forEach(({ input, expected }) => {
it(`should correctly handle trailing slashes: "${input}" -> "${expected}"`, () => {
const result = input.replace(/\/+$/, '');
expect(result).toBe(expected);
});
});

it('should construct valid handshake URLs with various proxy configurations', () => {
const proxyConfigs = [
'https://proxy.example.com',
'https://proxy.example.com/',
'https://proxy.example.com//',
'https://proxy.example.com/clerk',
'https://proxy.example.com/clerk/',
'https://proxy.example.com/clerk//',
'https://api.example.com/v1/clerk///',
];

proxyConfigs.forEach(proxyUrl => {
const isolatedContext = {
...mockAuthenticateContext,
proxyUrl: proxyUrl,
frontendApi: proxyUrl,
} as AuthenticateContext;

const isolatedHandshakeService = new HandshakeService(isolatedContext, mockOptions, mockOrganizationMatcher);

const headers = isolatedHandshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);

expect(location).toBeDefined();
if (!location) {
throw new Error('Location header should be defined');
}
expect(location).toContain('/v1/client/handshake');
expect(location).not.toContain('//v1/client/handshake'); // No double slashes

// Ensure URL is valid
expect(() => new URL(location)).not.toThrow();
});
});
});
});
38 changes: 27 additions & 11 deletions packages/backend/src/tokens/authenticateContext.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,31 +10,33 @@ import type { AuthenticateRequestOptions } from './types';

interface AuthenticateContext extends AuthenticateRequestOptions {
// header-based values
tokenInHeader: string | undefined;
origin: string | undefined;
host: string | undefined;
accept: string | undefined;
forwardedHost: string | undefined;
forwardedProto: string | undefined;
host: string | undefined;
origin: string | undefined;
referrer: string | undefined;
userAgent: string | undefined;
secFetchDest: string | undefined;
accept: string | undefined;
tokenInHeader: string | undefined;
userAgent: string | undefined;

// cookie-based values
sessionTokenInCookie: string | undefined;
refreshTokenInCookie: string | undefined;
clientUat: number;
refreshTokenInCookie: string | undefined;
sessionTokenInCookie: string | undefined;

// handshake-related values
devBrowserToken: string | undefined;
handshakeNonce: string | undefined;
handshakeToken: string | undefined;
handshakeRedirectLoopCounter: number;
handshakeToken: string | undefined;

// url derived from headers
clerkUrl: URL;
// enforce existence of the following props
publishableKey: string;
instanceType: string;
frontendApi: string;
instanceType: string;
publishableKey: string;
}

/**
Expand All@@ -44,6 +46,12 @@ interface AuthenticateContext extends AuthenticateRequestOptions {
* to perform a handshake.
*/
class AuthenticateContext implements AuthenticateContext {
/**
* The original Clerk frontend API URL, extracted from publishable key before proxy URL override.
* Used for backend operations like token validation and issuer checking.
*/
private originalFrontendApi: string = '';

/**
* Retrieves the session token from either the cookie or the header.
*
Expand DownExpand Up@@ -163,6 +171,13 @@ class AuthenticateContext implements AuthenticateContext {
assertValidPublishableKey(options.publishableKey);
this.publishableKey = options.publishableKey;

const originalPk = parsePublishableKey(this.publishableKey, {
fatal: true,
domain: options.domain,
isSatellite: options.isSatellite,
});
this.originalFrontendApi = originalPk.frontendApi;

const pk = parsePublishableKey(this.publishableKey, {
fatal: true,
proxyUrl: options.proxyUrl,
Expand DownExpand Up@@ -266,7 +281,8 @@ class AuthenticateContext implements AuthenticateContext {
return false;
}
const tokenIssuer = data.payload.iss.replace(/https?:\/\//gi, '');
return this.frontendApi === tokenIssuer;
// Use original frontend API for token validation since tokens are issued by the actual Clerk API, not proxy
return this.originalFrontendApi === tokenIssuer;
}
Comment on lines 283 to 286

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Issuer check ignores trailing slashes / “/v1” – could produce false negatives

iss values coming from Clerk tokens usually end with /v1/ (or at least /v1).
Comparing the raw host against originalFrontendApi therefore fails for perfectly valid tokens behind a proxy.

- const tokenIssuer = data.payload.iss.replace(/https?:\/\//gi, '');- return this.originalFrontendApi === tokenIssuer;+ const tokenIssuer = data.payload.iss+ .replace(/https?:\/\//gi, '')+ .replace(/\/+v1\/?$/, '') // strip “/v1” if present+ .replace(/\/+$/, ''); // strip trailing slash(es)++ return this.originalFrontendApi.replace(/\/+$/, '') === tokenIssuer;

This keeps proxy handling intact while tolerating the canonical Clerk issuer suffix.

📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
consttokenIssuer=data.payload.iss.replace(/https?:\/\//gi,'');
returnthis.frontendApi===tokenIssuer;
// Use original frontend API for token validation since tokens are issued by the actual Clerk API, not proxy
returnthis.originalFrontendApi===tokenIssuer;
}
consttokenIssuer=data.payload.iss
.replace(/https?:\/\//gi,'')
.replace(/\/+v1\/?$/,'')// strip “/v1” if present
.replace(/\/+$/,'');// strip trailing slash(es)
// Use original frontend API for token validation since tokens are issued by the actual Clerk API, not proxy
returnthis.originalFrontendApi
.replace(/\/+$/,'')===tokenIssuer;
}
🤖 Prompt for AI Agents
In packages/backend/src/tokens/authenticateContext.ts around lines 283 to 286,
the issuer check removes the protocol but does not account for trailing slashes
or path segments like "/v1", causing valid tokens to fail validation. Modify the
code to normalize the issuer by removing the protocol and any trailing slashes
or path suffixes such as "/v1" before comparing it to originalFrontendApi,
ensuring the comparison tolerates the canonical Clerk issuer suffix while
preserving proxy handling.


private sessionExpired(jwt: Jwt | undefined): boolean {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

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

Add logic to ensure that we consider the proxy_url when creating the frontendApi url.
279 changes: 279 additions & 0 deletions packages/backend/src/tokens/__tests__/handshake.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -179,6 +179,8 @@ describe('HandshakeService', () => {

it('should use proxy URL when available', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com';
// Simulate what parsePublishableKey does when proxy URL is provided
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
Expand All@@ -195,6 +197,7 @@ describe('HandshakeService', () => {

it('should handle proxy URL with trailing slash', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com/';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com/';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
Expand All@@ -205,6 +208,227 @@ describe('HandshakeService', () => {
expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
});

it('should handle proxy URL with multiple trailing slashes', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com//';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com//';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
expect(location).not.toContain('//v1/client/handshake');
});

it('should handle proxy URL with many trailing slashes', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com///';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com///';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
expect(location).not.toContain('//v1/client/handshake');
});

it('should handle proxy URL without trailing slash', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
});

it('should handle proxy URL with path and trailing slashes', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com/clerk-proxy//';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com/clerk-proxy//';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/clerk-proxy/v1/client/handshake');
expect(location).not.toContain('clerk-proxy//v1/client/handshake');
});

it('should handle non-HTTP frontendApi (domain only)', () => {
mockAuthenticateContext.frontendApi = 'api.clerk.com';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.protocol).toBe('https:');
expect(url.hostname).toBe('api.clerk.com');
expect(url.pathname).toBe('/v1/client/handshake');
});

it('should not include dev browser token in production mode', () => {
mockAuthenticateContext.instanceType = 'production';
mockAuthenticateContext.devBrowserToken = 'dev-token';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.DevBrowser)).toBeNull();
});

it('should not include dev browser token when not available in development', () => {
mockAuthenticateContext.instanceType = 'development';
mockAuthenticateContext.devBrowserToken = undefined;
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.DevBrowser)).toBeNull();
});

it('should handle usesSuffixedCookies returning false', () => {
mockAuthenticateContext.usesSuffixedCookies = vi.fn().mockReturnValue(false);
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.SuffixedCookies)).toBe('false');
});

it('should include organization sync parameters when organization target is found', () => {
// Mock the organization sync methods
const mockTarget = { type: 'organization', id: 'org_123' };
const mockParams = new Map([
['org_id', 'org_123'],
['org_slug', 'test-org'],
]);

vi.spyOn(handshakeService as any, 'getOrganizationSyncTarget').mockReturnValue(mockTarget);
vi.spyOn(handshakeService as any, 'getOrganizationSyncQueryParams').mockReturnValue(mockParams);

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get('org_id')).toBe('org_123');
expect(url.searchParams.get('org_slug')).toBe('test-org');
});

it('should not include organization sync parameters when no target is found', () => {
vi.spyOn(handshakeService as any, 'getOrganizationSyncTarget').mockReturnValue(null);

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get('org_id')).toBeNull();
expect(url.searchParams.get('org_slug')).toBeNull();
});

it('should handle different handshake reasons', () => {
const reasons = ['session-token-expired', 'dev-browser-sync', 'satellite-cookie-needs-syncing'];

reasons.forEach(reason => {
const headers = handshakeService.buildRedirectToHandshake(reason);
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.HandshakeReason)).toBe(reason);
});
});

it('should handle complex clerkUrl with query parameters and fragments', () => {
mockAuthenticateContext.clerkUrl = new URL('https://example.com/path?existing=param#fragment');

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

const redirectUrl = url.searchParams.get('redirect_url');
expect(redirectUrl).toBe('https://example.com/path?existing=param#fragment');
});

it('should create valid URLs with different frontend API formats', () => {
const frontendApiFormats = [
'api.clerk.com',
'https://api.clerk.com',
'https://api.clerk.com/',
'foo-bar-13.clerk.accounts.dev',
'https://foo-bar-13.clerk.accounts.dev',
'clerk.example.com',
'https://clerk.example.com/proxy-path',
];

frontendApiFormats.forEach(frontendApi => {
mockAuthenticateContext.frontendApi = frontendApi;

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);

expect(location).toBeDefined();
if (!location) {
throw new Error('Location header should be defined');
}
expect(() => new URL(location)).not.toThrow();

const url = new URL(location);
// Path should end with '/v1/client/handshake' (may have proxy path prefix)
expect(url.pathname).toMatch(/\/v1\/client\/handshake$/);
expect(url.searchParams.get(constants.QueryParameters.HandshakeReason)).toBe('test-reason');
});
});

it('should always include required query parameters', () => {
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

// Verify all required parameters are present
expect(url.searchParams.get('redirect_url')).toBeDefined();
expect(url.searchParams.get('__clerk_api_version')).toBe('2025-04-10');
expect(url.searchParams.get(constants.QueryParameters.SuffixedCookies)).toMatch(/^(true|false)$/);
expect(url.searchParams.get(constants.QueryParameters.HandshakeReason)).toBe('test-reason');
});
});

describe('handleTokenVerificationErrorInDevelopment', () => {
Expand DownExpand Up@@ -320,4 +544,59 @@ describe('HandshakeService', () => {
spy.mockRestore();
});
});

describe('URL construction edge cases', () => {
const trailingSlashTestCases = [
{ input: 'https://example.com', expected: 'https://example.com' },
{ input: 'https://example.com/', expected: 'https://example.com' },
{ input: 'https://example.com//', expected: 'https://example.com' },
{ input: 'https://example.com///', expected: 'https://example.com' },
{ input: 'https://example.com/path', expected: 'https://example.com/path' },
{ input: 'https://example.com/path/', expected: 'https://example.com/path' },
{ input: 'https://example.com/path//', expected: 'https://example.com/path' },
{ input: 'https://example.com/proxy-path///', expected: 'https://example.com/proxy-path' },
];

trailingSlashTestCases.forEach(({ input, expected }) => {
it(`should correctly handle trailing slashes: "${input}" -> "${expected}"`, () => {
const result = input.replace(/\/+$/, '');
expect(result).toBe(expected);
});
});

it('should construct valid handshake URLs with various proxy configurations', () => {
const proxyConfigs = [
'https://proxy.example.com',
'https://proxy.example.com/',
'https://proxy.example.com//',
'https://proxy.example.com/clerk',
'https://proxy.example.com/clerk/',
'https://proxy.example.com/clerk//',
'https://api.example.com/v1/clerk///',
];

proxyConfigs.forEach(proxyUrl => {
const isolatedContext = {
...mockAuthenticateContext,
proxyUrl: proxyUrl,
frontendApi: proxyUrl,
} as AuthenticateContext;

const isolatedHandshakeService = new HandshakeService(isolatedContext, mockOptions, mockOrganizationMatcher);

const headers = isolatedHandshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);

expect(location).toBeDefined();
if (!location) {
throw new Error('Location header should be defined');
}
expect(location).toContain('/v1/client/handshake');
expect(location).not.toContain('//v1/client/handshake'); // No double slashes

// Ensure URL is valid
expect(() => new URL(location)).not.toThrow();
});
});
});
});
38 changes: 27 additions & 11 deletions packages/backend/src/tokens/authenticateContext.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,31 +10,33 @@ import type { AuthenticateRequestOptions } from './types';

interface AuthenticateContext extends AuthenticateRequestOptions {
// header-based values
tokenInHeader: string | undefined;
origin: string | undefined;
host: string | undefined;
accept: string | undefined;
forwardedHost: string | undefined;
forwardedProto: string | undefined;
host: string | undefined;
origin: string | undefined;
referrer: string | undefined;
userAgent: string | undefined;
secFetchDest: string | undefined;
accept: string | undefined;
tokenInHeader: string | undefined;
userAgent: string | undefined;

// cookie-based values
sessionTokenInCookie: string | undefined;
refreshTokenInCookie: string | undefined;
clientUat: number;
refreshTokenInCookie: string | undefined;
sessionTokenInCookie: string | undefined;

// handshake-related values
devBrowserToken: string | undefined;
handshakeNonce: string | undefined;
handshakeToken: string | undefined;
handshakeRedirectLoopCounter: number;
handshakeToken: string | undefined;

// url derived from headers
clerkUrl: URL;
// enforce existence of the following props
publishableKey: string;
instanceType: string;
frontendApi: string;
instanceType: string;
publishableKey: string;
}

/**
Expand All@@ -44,6 +46,12 @@ interface AuthenticateContext extends AuthenticateRequestOptions {
* to perform a handshake.
*/
class AuthenticateContext implements AuthenticateContext {
/**
* The original Clerk frontend API URL, extracted from publishable key before proxy URL override.
* Used for backend operations like token validation and issuer checking.
*/
private originalFrontendApi: string = '';

/**
* Retrieves the session token from either the cookie or the header.
*
Expand DownExpand Up@@ -163,6 +171,13 @@ class AuthenticateContext implements AuthenticateContext {
assertValidPublishableKey(options.publishableKey);
this.publishableKey = options.publishableKey;

const originalPk = parsePublishableKey(this.publishableKey, {
fatal: true,
domain: options.domain,
isSatellite: options.isSatellite,
});
this.originalFrontendApi = originalPk.frontendApi;

const pk = parsePublishableKey(this.publishableKey, {
fatal: true,
proxyUrl: options.proxyUrl,
Expand DownExpand Up@@ -266,7 +281,8 @@ class AuthenticateContext implements AuthenticateContext {
return false;
}
const tokenIssuer = data.payload.iss.replace(/https?:\/\//gi, '');
return this.frontendApi === tokenIssuer;
// Use original frontend API for token validation since tokens are issued by the actual Clerk API, not proxy
return this.originalFrontendApi === tokenIssuer;
}
Comment on lines 283 to 286

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Issuer check ignores trailing slashes / “/v1” – could produce false negatives

iss values coming from Clerk tokens usually end with /v1/ (or at least /v1).
Comparing the raw host against originalFrontendApi therefore fails for perfectly valid tokens behind a proxy.

- const tokenIssuer = data.payload.iss.replace(/https?:\/\//gi, '');- return this.originalFrontendApi === tokenIssuer;+ const tokenIssuer = data.payload.iss+ .replace(/https?:\/\//gi, '')+ .replace(/\/+v1\/?$/, '') // strip “/v1” if present+ .replace(/\/+$/, ''); // strip trailing slash(es)++ return this.originalFrontendApi.replace(/\/+$/, '') === tokenIssuer;

This keeps proxy handling intact while tolerating the canonical Clerk issuer suffix.

📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
consttokenIssuer=data.payload.iss.replace(/https?:\/\//gi,'');
returnthis.frontendApi===tokenIssuer;
// Use original frontend API for token validation since tokens are issued by the actual Clerk API, not proxy
returnthis.originalFrontendApi===tokenIssuer;
}
consttokenIssuer=data.payload.iss
.replace(/https?:\/\//gi,'')
.replace(/\/+v1\/?$/,'')// strip “/v1” if present
.replace(/\/+$/,'');// strip trailing slash(es)
// Use original frontend API for token validation since tokens are issued by the actual Clerk API, not proxy
returnthis.originalFrontendApi
.replace(/\/+$/,'')===tokenIssuer;
}
🤖 Prompt for AI Agents
In packages/backend/src/tokens/authenticateContext.ts around lines 283 to 286,
the issuer check removes the protocol but does not account for trailing slashes
or path segments like "/v1", causing valid tokens to fail validation. Modify the
code to normalize the issuer by removing the protocol and any trailing slashes
or path suffixes such as "/v1" before comparing it to originalFrontendApi,
ensuring the comparison tolerates the canonical Clerk issuer suffix while
preserving proxy handling.


private sessionExpired(jwt: Jwt | undefined): boolean {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

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

Add logic to ensure that we consider the proxy_url when creating the frontendApi url.
279 changes: 279 additions & 0 deletions packages/backend/src/tokens/__tests__/handshake.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -179,6 +179,8 @@ describe('HandshakeService', () => {

it('should use proxy URL when available', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com';
// Simulate what parsePublishableKey does when proxy URL is provided
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
Expand All@@ -195,6 +197,7 @@ describe('HandshakeService', () => {

it('should handle proxy URL with trailing slash', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com/';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com/';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
Expand All@@ -205,6 +208,227 @@ describe('HandshakeService', () => {
expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
});

it('should handle proxy URL with multiple trailing slashes', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com//';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com//';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
expect(location).not.toContain('//v1/client/handshake');
});

it('should handle proxy URL with many trailing slashes', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com///';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com///';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
expect(location).not.toContain('//v1/client/handshake');
});

it('should handle proxy URL without trailing slash', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
});

it('should handle proxy URL with path and trailing slashes', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com/clerk-proxy//';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com/clerk-proxy//';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/clerk-proxy/v1/client/handshake');
expect(location).not.toContain('clerk-proxy//v1/client/handshake');
});

it('should handle non-HTTP frontendApi (domain only)', () => {
mockAuthenticateContext.frontendApi = 'api.clerk.com';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.protocol).toBe('https:');
expect(url.hostname).toBe('api.clerk.com');
expect(url.pathname).toBe('/v1/client/handshake');
});

it('should not include dev browser token in production mode', () => {
mockAuthenticateContext.instanceType = 'production';
mockAuthenticateContext.devBrowserToken = 'dev-token';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.DevBrowser)).toBeNull();
});

it('should not include dev browser token when not available in development', () => {
mockAuthenticateContext.instanceType = 'development';
mockAuthenticateContext.devBrowserToken = undefined;
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.DevBrowser)).toBeNull();
});

it('should handle usesSuffixedCookies returning false', () => {
mockAuthenticateContext.usesSuffixedCookies = vi.fn().mockReturnValue(false);
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.SuffixedCookies)).toBe('false');
});

it('should include organization sync parameters when organization target is found', () => {
// Mock the organization sync methods
const mockTarget = { type: 'organization', id: 'org_123' };
const mockParams = new Map([
['org_id', 'org_123'],
['org_slug', 'test-org'],
]);

vi.spyOn(handshakeService as any, 'getOrganizationSyncTarget').mockReturnValue(mockTarget);
vi.spyOn(handshakeService as any, 'getOrganizationSyncQueryParams').mockReturnValue(mockParams);

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get('org_id')).toBe('org_123');
expect(url.searchParams.get('org_slug')).toBe('test-org');
});

it('should not include organization sync parameters when no target is found', () => {
vi.spyOn(handshakeService as any, 'getOrganizationSyncTarget').mockReturnValue(null);

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get('org_id')).toBeNull();
expect(url.searchParams.get('org_slug')).toBeNull();
});

it('should handle different handshake reasons', () => {
const reasons = ['session-token-expired', 'dev-browser-sync', 'satellite-cookie-needs-syncing'];

reasons.forEach(reason => {
const headers = handshakeService.buildRedirectToHandshake(reason);
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.HandshakeReason)).toBe(reason);
});
});

it('should handle complex clerkUrl with query parameters and fragments', () => {
mockAuthenticateContext.clerkUrl = new URL('https://example.com/path?existing=param#fragment');

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

const redirectUrl = url.searchParams.get('redirect_url');
expect(redirectUrl).toBe('https://example.com/path?existing=param#fragment');
});

it('should create valid URLs with different frontend API formats', () => {
const frontendApiFormats = [
'api.clerk.com',
'https://api.clerk.com',
'https://api.clerk.com/',
'foo-bar-13.clerk.accounts.dev',
'https://foo-bar-13.clerk.accounts.dev',
'clerk.example.com',
'https://clerk.example.com/proxy-path',
];

frontendApiFormats.forEach(frontendApi => {
mockAuthenticateContext.frontendApi = frontendApi;

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);

expect(location).toBeDefined();
if (!location) {
throw new Error('Location header should be defined');
}
expect(() => new URL(location)).not.toThrow();

const url = new URL(location);
// Path should end with '/v1/client/handshake' (may have proxy path prefix)
expect(url.pathname).toMatch(/\/v1\/client\/handshake$/);
expect(url.searchParams.get(constants.QueryParameters.HandshakeReason)).toBe('test-reason');
});
});

it('should always include required query parameters', () => {
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

// Verify all required parameters are present
expect(url.searchParams.get('redirect_url')).toBeDefined();
expect(url.searchParams.get('__clerk_api_version')).toBe('2025-04-10');
expect(url.searchParams.get(constants.QueryParameters.SuffixedCookies)).toMatch(/^(true|false)$/);
expect(url.searchParams.get(constants.QueryParameters.HandshakeReason)).toBe('test-reason');
});
});

describe('handleTokenVerificationErrorInDevelopment', () => {
Expand DownExpand Up@@ -320,4 +544,59 @@ describe('HandshakeService', () => {
spy.mockRestore();
});
});

describe('URL construction edge cases', () => {
const trailingSlashTestCases = [
{ input: 'https://example.com', expected: 'https://example.com' },
{ input: 'https://example.com/', expected: 'https://example.com' },
{ input: 'https://example.com//', expected: 'https://example.com' },
{ input: 'https://example.com///', expected: 'https://example.com' },
{ input: 'https://example.com/path', expected: 'https://example.com/path' },
{ input: 'https://example.com/path/', expected: 'https://example.com/path' },
{ input: 'https://example.com/path//', expected: 'https://example.com/path' },
{ input: 'https://example.com/proxy-path///', expected: 'https://example.com/proxy-path' },
];

trailingSlashTestCases.forEach(({ input, expected }) => {
it(`should correctly handle trailing slashes: "${input}" -> "${expected}"`, () => {
const result = input.replace(/\/+$/, '');
expect(result).toBe(expected);
});
});

it('should construct valid handshake URLs with various proxy configurations', () => {
const proxyConfigs = [
'https://proxy.example.com',
'https://proxy.example.com/',
'https://proxy.example.com//',
'https://proxy.example.com/clerk',
'https://proxy.example.com/clerk/',
'https://proxy.example.com/clerk//',
'https://api.example.com/v1/clerk///',
];

proxyConfigs.forEach(proxyUrl => {
const isolatedContext = {
...mockAuthenticateContext,
proxyUrl: proxyUrl,
frontendApi: proxyUrl,
} as AuthenticateContext;

const isolatedHandshakeService = new HandshakeService(isolatedContext, mockOptions, mockOrganizationMatcher);

const headers = isolatedHandshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);

expect(location).toBeDefined();
if (!location) {
throw new Error('Location header should be defined');
}
expect(location).toContain('/v1/client/handshake');
expect(location).not.toContain('//v1/client/handshake'); // No double slashes

// Ensure URL is valid
expect(() => new URL(location)).not.toThrow();
});
});
});
});
38 changes: 27 additions & 11 deletions packages/backend/src/tokens/authenticateContext.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,31 +10,33 @@ import type { AuthenticateRequestOptions } from './types';

interface AuthenticateContext extends AuthenticateRequestOptions {
// header-based values
tokenInHeader: string | undefined;
origin: string | undefined;
host: string | undefined;
accept: string | undefined;
forwardedHost: string | undefined;
forwardedProto: string | undefined;
host: string | undefined;
origin: string | undefined;
referrer: string | undefined;
userAgent: string | undefined;
secFetchDest: string | undefined;
accept: string | undefined;
tokenInHeader: string | undefined;
userAgent: string | undefined;

// cookie-based values
sessionTokenInCookie: string | undefined;
refreshTokenInCookie: string | undefined;
clientUat: number;
refreshTokenInCookie: string | undefined;
sessionTokenInCookie: string | undefined;

// handshake-related values
devBrowserToken: string | undefined;
handshakeNonce: string | undefined;
handshakeToken: string | undefined;
handshakeRedirectLoopCounter: number;
handshakeToken: string | undefined;

// url derived from headers
clerkUrl: URL;
// enforce existence of the following props
publishableKey: string;
instanceType: string;
frontendApi: string;
instanceType: string;
publishableKey: string;
}

/**
Expand All@@ -44,6 +46,12 @@ interface AuthenticateContext extends AuthenticateRequestOptions {
* to perform a handshake.
*/
class AuthenticateContext implements AuthenticateContext {
/**
* The original Clerk frontend API URL, extracted from publishable key before proxy URL override.
* Used for backend operations like token validation and issuer checking.
*/
private originalFrontendApi: string = '';

/**
* Retrieves the session token from either the cookie or the header.
*
Expand DownExpand Up@@ -163,6 +171,13 @@ class AuthenticateContext implements AuthenticateContext {
assertValidPublishableKey(options.publishableKey);
this.publishableKey = options.publishableKey;

const originalPk = parsePublishableKey(this.publishableKey, {
fatal: true,
domain: options.domain,
isSatellite: options.isSatellite,
});
this.originalFrontendApi = originalPk.frontendApi;

const pk = parsePublishableKey(this.publishableKey, {
fatal: true,
proxyUrl: options.proxyUrl,
Expand DownExpand Up@@ -266,7 +281,8 @@ class AuthenticateContext implements AuthenticateContext {
return false;
}
const tokenIssuer = data.payload.iss.replace(/https?:\/\//gi, '');
return this.frontendApi === tokenIssuer;
// Use original frontend API for token validation since tokens are issued by the actual Clerk API, not proxy
return this.originalFrontendApi === tokenIssuer;
}
Comment on lines 283 to 286

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Issuer check ignores trailing slashes / “/v1” – could produce false negatives

iss values coming from Clerk tokens usually end with /v1/ (or at least /v1).
Comparing the raw host against originalFrontendApi therefore fails for perfectly valid tokens behind a proxy.

- const tokenIssuer = data.payload.iss.replace(/https?:\/\//gi, '');- return this.originalFrontendApi === tokenIssuer;+ const tokenIssuer = data.payload.iss+ .replace(/https?:\/\//gi, '')+ .replace(/\/+v1\/?$/, '') // strip “/v1” if present+ .replace(/\/+$/, ''); // strip trailing slash(es)++ return this.originalFrontendApi.replace(/\/+$/, '') === tokenIssuer;

This keeps proxy handling intact while tolerating the canonical Clerk issuer suffix.

📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
consttokenIssuer=data.payload.iss.replace(/https?:\/\//gi,'');
returnthis.frontendApi===tokenIssuer;
// Use original frontend API for token validation since tokens are issued by the actual Clerk API, not proxy
returnthis.originalFrontendApi===tokenIssuer;
}
consttokenIssuer=data.payload.iss
.replace(/https?:\/\//gi,'')
.replace(/\/+v1\/?$/,'')// strip “/v1” if present
.replace(/\/+$/,'');// strip trailing slash(es)
// Use original frontend API for token validation since tokens are issued by the actual Clerk API, not proxy
returnthis.originalFrontendApi
.replace(/\/+$/,'')===tokenIssuer;
}
🤖 Prompt for AI Agents
In packages/backend/src/tokens/authenticateContext.ts around lines 283 to 286,
the issuer check removes the protocol but does not account for trailing slashes
or path segments like "/v1", causing valid tokens to fail validation. Modify the
code to normalize the issuer by removing the protocol and any trailing slashes
or path suffixes such as "/v1" before comparing it to originalFrontendApi,
ensuring the comparison tolerates the canonical Clerk issuer suffix while
preserving proxy handling.


private sessionExpired(jwt: Jwt | undefined): boolean {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

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

Add logic to ensure that we consider the proxy_url when creating the frontendApi url.
279 changes: 279 additions & 0 deletions packages/backend/src/tokens/__tests__/handshake.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -179,6 +179,8 @@ describe('HandshakeService', () => {

it('should use proxy URL when available', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com';
// Simulate what parsePublishableKey does when proxy URL is provided
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
Expand All@@ -195,6 +197,7 @@ describe('HandshakeService', () => {

it('should handle proxy URL with trailing slash', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com/';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com/';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
Expand All@@ -205,6 +208,227 @@ describe('HandshakeService', () => {
expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
});

it('should handle proxy URL with multiple trailing slashes', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com//';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com//';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
expect(location).not.toContain('//v1/client/handshake');
});

it('should handle proxy URL with many trailing slashes', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com///';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com///';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
expect(location).not.toContain('//v1/client/handshake');
});

it('should handle proxy URL without trailing slash', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/v1/client/handshake');
});

it('should handle proxy URL with path and trailing slashes', () => {
mockAuthenticateContext.proxyUrl = 'https://my-proxy.example.com/clerk-proxy//';
mockAuthenticateContext.frontendApi = 'https://my-proxy.example.com/clerk-proxy//';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.hostname).toBe('my-proxy.example.com');
expect(url.pathname).toBe('/clerk-proxy/v1/client/handshake');
expect(location).not.toContain('clerk-proxy//v1/client/handshake');
});

it('should handle non-HTTP frontendApi (domain only)', () => {
mockAuthenticateContext.frontendApi = 'api.clerk.com';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.protocol).toBe('https:');
expect(url.hostname).toBe('api.clerk.com');
expect(url.pathname).toBe('/v1/client/handshake');
});

it('should not include dev browser token in production mode', () => {
mockAuthenticateContext.instanceType = 'production';
mockAuthenticateContext.devBrowserToken = 'dev-token';
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.DevBrowser)).toBeNull();
});

it('should not include dev browser token when not available in development', () => {
mockAuthenticateContext.instanceType = 'development';
mockAuthenticateContext.devBrowserToken = undefined;
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.DevBrowser)).toBeNull();
});

it('should handle usesSuffixedCookies returning false', () => {
mockAuthenticateContext.usesSuffixedCookies = vi.fn().mockReturnValue(false);
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.SuffixedCookies)).toBe('false');
});

it('should include organization sync parameters when organization target is found', () => {
// Mock the organization sync methods
const mockTarget = { type: 'organization', id: 'org_123' };
const mockParams = new Map([
['org_id', 'org_123'],
['org_slug', 'test-org'],
]);

vi.spyOn(handshakeService as any, 'getOrganizationSyncTarget').mockReturnValue(mockTarget);
vi.spyOn(handshakeService as any, 'getOrganizationSyncQueryParams').mockReturnValue(mockParams);

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get('org_id')).toBe('org_123');
expect(url.searchParams.get('org_slug')).toBe('test-org');
});

it('should not include organization sync parameters when no target is found', () => {
vi.spyOn(handshakeService as any, 'getOrganizationSyncTarget').mockReturnValue(null);

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get('org_id')).toBeNull();
expect(url.searchParams.get('org_slug')).toBeNull();
});

it('should handle different handshake reasons', () => {
const reasons = ['session-token-expired', 'dev-browser-sync', 'satellite-cookie-needs-syncing'];

reasons.forEach(reason => {
const headers = handshakeService.buildRedirectToHandshake(reason);
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

expect(url.searchParams.get(constants.QueryParameters.HandshakeReason)).toBe(reason);
});
});

it('should handle complex clerkUrl with query parameters and fragments', () => {
mockAuthenticateContext.clerkUrl = new URL('https://example.com/path?existing=param#fragment');

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

const redirectUrl = url.searchParams.get('redirect_url');
expect(redirectUrl).toBe('https://example.com/path?existing=param#fragment');
});

it('should create valid URLs with different frontend API formats', () => {
const frontendApiFormats = [
'api.clerk.com',
'https://api.clerk.com',
'https://api.clerk.com/',
'foo-bar-13.clerk.accounts.dev',
'https://foo-bar-13.clerk.accounts.dev',
'clerk.example.com',
'https://clerk.example.com/proxy-path',
];

frontendApiFormats.forEach(frontendApi => {
mockAuthenticateContext.frontendApi = frontendApi;

const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);

expect(location).toBeDefined();
if (!location) {
throw new Error('Location header should be defined');
}
expect(() => new URL(location)).not.toThrow();

const url = new URL(location);
// Path should end with '/v1/client/handshake' (may have proxy path prefix)
expect(url.pathname).toMatch(/\/v1\/client\/handshake$/);
expect(url.searchParams.get(constants.QueryParameters.HandshakeReason)).toBe('test-reason');
});
});

it('should always include required query parameters', () => {
const headers = handshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);
if (!location) {
throw new Error('Location header is missing');
}
const url = new URL(location);

// Verify all required parameters are present
expect(url.searchParams.get('redirect_url')).toBeDefined();
expect(url.searchParams.get('__clerk_api_version')).toBe('2025-04-10');
expect(url.searchParams.get(constants.QueryParameters.SuffixedCookies)).toMatch(/^(true|false)$/);
expect(url.searchParams.get(constants.QueryParameters.HandshakeReason)).toBe('test-reason');
});
});

describe('handleTokenVerificationErrorInDevelopment', () => {
Expand DownExpand Up@@ -320,4 +544,59 @@ describe('HandshakeService', () => {
spy.mockRestore();
});
});

describe('URL construction edge cases', () => {
const trailingSlashTestCases = [
{ input: 'https://example.com', expected: 'https://example.com' },
{ input: 'https://example.com/', expected: 'https://example.com' },
{ input: 'https://example.com//', expected: 'https://example.com' },
{ input: 'https://example.com///', expected: 'https://example.com' },
{ input: 'https://example.com/path', expected: 'https://example.com/path' },
{ input: 'https://example.com/path/', expected: 'https://example.com/path' },
{ input: 'https://example.com/path//', expected: 'https://example.com/path' },
{ input: 'https://example.com/proxy-path///', expected: 'https://example.com/proxy-path' },
];

trailingSlashTestCases.forEach(({ input, expected }) => {
it(`should correctly handle trailing slashes: "${input}" -> "${expected}"`, () => {
const result = input.replace(/\/+$/, '');
expect(result).toBe(expected);
});
});

it('should construct valid handshake URLs with various proxy configurations', () => {
const proxyConfigs = [
'https://proxy.example.com',
'https://proxy.example.com/',
'https://proxy.example.com//',
'https://proxy.example.com/clerk',
'https://proxy.example.com/clerk/',
'https://proxy.example.com/clerk//',
'https://api.example.com/v1/clerk///',
];

proxyConfigs.forEach(proxyUrl => {
const isolatedContext = {
...mockAuthenticateContext,
proxyUrl: proxyUrl,
frontendApi: proxyUrl,
} as AuthenticateContext;

const isolatedHandshakeService = new HandshakeService(isolatedContext, mockOptions, mockOrganizationMatcher);

const headers = isolatedHandshakeService.buildRedirectToHandshake('test-reason');
const location = headers.get(constants.Headers.Location);

expect(location).toBeDefined();
if (!location) {
throw new Error('Location header should be defined');
}
expect(location).toContain('/v1/client/handshake');
expect(location).not.toContain('//v1/client/handshake'); // No double slashes

// Ensure URL is valid
expect(() => new URL(location)).not.toThrow();
});
});
});
});
38 changes: 27 additions & 11 deletions packages/backend/src/tokens/authenticateContext.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,31 +10,33 @@ import type { AuthenticateRequestOptions } from './types';

interface AuthenticateContext extends AuthenticateRequestOptions {
// header-based values
tokenInHeader: string | undefined;
origin: string | undefined;
host: string | undefined;
accept: string | undefined;
forwardedHost: string | undefined;
forwardedProto: string | undefined;
host: string | undefined;
origin: string | undefined;
referrer: string | undefined;
userAgent: string | undefined;
secFetchDest: string | undefined;
accept: string | undefined;
tokenInHeader: string | undefined;
userAgent: string | undefined;

// cookie-based values
sessionTokenInCookie: string | undefined;
refreshTokenInCookie: string | undefined;
clientUat: number;
refreshTokenInCookie: string | undefined;
sessionTokenInCookie: string | undefined;

// handshake-related values
devBrowserToken: string | undefined;
handshakeNonce: string | undefined;
handshakeToken: string | undefined;
handshakeRedirectLoopCounter: number;
handshakeToken: string | undefined;

// url derived from headers
clerkUrl: URL;
// enforce existence of the following props
publishableKey: string;
instanceType: string;
frontendApi: string;
instanceType: string;
publishableKey: string;
}

/**
Expand All@@ -44,6 +46,12 @@ interface AuthenticateContext extends AuthenticateRequestOptions {
* to perform a handshake.
*/
class AuthenticateContext implements AuthenticateContext {
/**
* The original Clerk frontend API URL, extracted from publishable key before proxy URL override.
* Used for backend operations like token validation and issuer checking.
*/
private originalFrontendApi: string = '';

/**
* Retrieves the session token from either the cookie or the header.
*
Expand DownExpand Up@@ -163,6 +171,13 @@ class AuthenticateContext implements AuthenticateContext {
assertValidPublishableKey(options.publishableKey);
this.publishableKey = options.publishableKey;

const originalPk = parsePublishableKey(this.publishableKey, {
fatal: true,
domain: options.domain,
isSatellite: options.isSatellite,
});
this.originalFrontendApi = originalPk.frontendApi;

const pk = parsePublishableKey(this.publishableKey, {
fatal: true,
proxyUrl: options.proxyUrl,
Expand DownExpand Up@@ -266,7 +281,8 @@ class AuthenticateContext implements AuthenticateContext {
return false;
}
const tokenIssuer = data.payload.iss.replace(/https?:\/\//gi, '');
return this.frontendApi === tokenIssuer;
// Use original frontend API for token validation since tokens are issued by the actual Clerk API, not proxy
return this.originalFrontendApi === tokenIssuer;
}
Comment on lines 283 to 286

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Issuer check ignores trailing slashes / “/v1” – could produce false negatives

iss values coming from Clerk tokens usually end with /v1/ (or at least /v1).
Comparing the raw host against originalFrontendApi therefore fails for perfectly valid tokens behind a proxy.

- const tokenIssuer = data.payload.iss.replace(/https?:\/\//gi, '');- return this.originalFrontendApi === tokenIssuer;+ const tokenIssuer = data.payload.iss+ .replace(/https?:\/\//gi, '')+ .replace(/\/+v1\/?$/, '') // strip “/v1” if present+ .replace(/\/+$/, ''); // strip trailing slash(es)++ return this.originalFrontendApi.replace(/\/+$/, '') === tokenIssuer;

This keeps proxy handling intact while tolerating the canonical Clerk issuer suffix.

📝 Committable suggestion

‼️IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
consttokenIssuer=data.payload.iss.replace(/https?:\/\//gi,'');
returnthis.frontendApi===tokenIssuer;
// Use original frontend API for token validation since tokens are issued by the actual Clerk API, not proxy
returnthis.originalFrontendApi===tokenIssuer;
}
consttokenIssuer=data.payload.iss
.replace(/https?:\/\//gi,'')
.replace(/\/+v1\/?$/,'')// strip “/v1” if present
.replace(/\/+$/,'');// strip trailing slash(es)
// Use original frontend API for token validation since tokens are issued by the actual Clerk API, not proxy
returnthis.originalFrontendApi
.replace(/\/+$/,'')===tokenIssuer;
}
🤖 Prompt for AI Agents
In packages/backend/src/tokens/authenticateContext.ts around lines 283 to 286,
the issuer check removes the protocol but does not account for trailing slashes
or path segments like "/v1", causing valid tokens to fail validation. Modify the
code to normalize the issuer by removing the protocol and any trailing slashes
or path suffixes such as "/v1" before comparing it to originalFrontendApi,
ensuring the comparison tolerates the canonical Clerk issuer suffix while
preserving proxy handling.


private sessionExpired(jwt: Jwt | undefined): boolean {
Expand Down
Loading