Skip to content
Closed
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
65 changes: 0 additions & 65 deletions packages/backend/src/tokens/__tests__/authenticateContext.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -258,71 +258,6 @@ describe('AuthenticateContext', () => {
});
});

describe('auto-proxy for eligible hosts', () => {
const originalEnv = process.env;

beforeEach(() => {
process.env = {
...originalEnv,
VERCEL_TARGET_ENV: 'production',
VERCEL_PROJECT_PRODUCTION_URL: 'myapp-abc123.vercel.app',
};
});

afterEach(() => {
process.env = originalEnv;
});

it('auto-derives proxyUrl when Vercel env vars indicate production vercel.app', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkLive,
});

expect(context.proxyUrl).toBe('https://myapp-abc123.vercel.app/__clerk');
});

it('does NOT auto-derive proxyUrl for development keys', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkTest,
});

expect(context.proxyUrl).toBeUndefined();
});

it('does NOT auto-derive proxyUrl when Vercel env vars are absent', async () => {
delete process.env.VERCEL_TARGET_ENV;
delete process.env.VERCEL_PROJECT_PRODUCTION_URL;
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkLive,
});

expect(context.proxyUrl).toBeUndefined();
});

it('explicit proxyUrl takes precedence over auto-detection', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkLive,
proxyUrl: 'https://custom-proxy.example.com/__clerk',
});

expect(context.proxyUrl).toBe('https://custom-proxy.example.com/__clerk');
});

it('explicit domain skips auto-detection', async () => {
const clerkRequest = createClerkRequest(new Request('https://myapp-abc123.vercel.app/dashboard'));
const context = await createAuthenticateContext(clerkRequest, {
publishableKey: pkLive,
domain: 'clerk.myapp.com',
});

expect(context.proxyUrl).toBeUndefined();
});
});

// Added these tests to verify that the generated sha-1 is the same as the one used in cookie assignment
// Tests copied from packages/shared/src/__tests__/keys.test.ts
describe('getCookieSuffix(publishableKey, subtle)', () => {
Expand Down
13 changes: 0 additions & 13 deletions packages/backend/src/tokens/authenticateContext.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import { buildAccountsBaseUrl } from '@clerk/shared/buildAccountsBaseUrl';
import { getAutoProxyUrlFromEnvironment } from '@clerk/shared/proxy';
import type { Jwt } from '@clerk/shared/types';
import { isCurrentDevAccountPortalOrigin, isLegacyDevAccountPortalOrigin } from '@clerk/shared/url';

Expand Down Expand Up @@ -71,18 +70,6 @@ class AuthenticateContext implements AuthenticateContext {
private clerkRequest: ClerkRequest,
options: AuthenticateRequestOptions,
) {
// Auto-detect proxy for supported platform deployments using environment
// variables (e.g. VERCEL_TARGET_ENV, VERCEL_PROJECT_PRODUCTION_URL) instead
// of request headers, which avoids X-Forwarded-Host spoofing concerns.
const autoProxyPath = getAutoProxyUrlFromEnvironment({
publishableKey: options.publishableKey ?? '',
hasProxyUrl: !!options.proxyUrl,
hasDomain: !!options.domain,
});
if (autoProxyPath) {
options = { ...options, proxyUrl: `${clerkRequest.clerkUrl.origin}${autoProxyPath}` };
}

if (options.acceptsToken === TokenType.M2MToken || options.acceptsToken === TokenType.ApiKey) {
// For non-session tokens, we only want to set the header values.
this.initHeaderValues();
Expand Down
80 changes: 0 additions & 80 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2516,86 +2516,6 @@ describe('Clerk singleton', () => {
});
});
});

describe('auto-detection for eligible hosts', () => {
const originalLocation = window.location;

afterEach(() => {
Object.defineProperty(window, 'location', {
value: originalLocation,
writable: true,
});
});

test('auto-derives proxyUrl for production instances on eligible hosts', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(productionPublishableKey);
expect(sut.proxyUrl).toBe('https://myapp-abc123.vercel.app/__clerk');
});

test('does NOT auto-derive proxyUrl for development instances on eligible hosts', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(developmentPublishableKey);
expect(sut.proxyUrl).toBe('');
});

test('does NOT auto-derive proxyUrl for ineligible domains', () => {
const sut = new Clerk(productionPublishableKey);
expect(sut.proxyUrl).toBe('');
});

test('explicit proxyUrl takes precedence over auto-detection', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(productionPublishableKey, {
proxyUrl: 'https://custom-proxy.example.com/__clerk',
});
expect(sut.proxyUrl).toBe('https://custom-proxy.example.com/__clerk');
});

test('explicit domain skips auto-detection', () => {
Object.defineProperty(window, 'location', {
value: {
...originalLocation,
hostname: 'myapp-abc123.vercel.app',
origin: 'https://myapp-abc123.vercel.app',
href: 'https://myapp-abc123.vercel.app/dashboard',
},
writable: true,
});

const sut = new Clerk(productionPublishableKey, {
domain: 'clerk.myapp.com',
});
expect(sut.proxyUrl).toBe('');
});
});
});

describe('buildUrlWithAuth', () => {
Expand Down
17 changes: 2 additions & 15 deletions packages/clerk-js/src/core/clerk.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,7 @@ import { windowNavigate } from '@clerk/shared/internal/clerk-js/windowNavigate';
import { parsePublishableKey } from '@clerk/shared/keys';
import { logger } from '@clerk/shared/logger';
import { CLERK_NETLIFY_CACHE_BUST_PARAM } from '@clerk/shared/netlifyCacheHandler';
import {
AUTO_PROXY_PATH,
isHttpOrHttps,
isValidProxyUrl,
proxyUrlToAbsoluteURL,
shouldAutoProxy,
} from '@clerk/shared/proxy';
import { isHttpOrHttps, isValidProxyUrl, proxyUrlToAbsoluteURL } from '@clerk/shared/proxy';
import {
eventPrebuiltComponentMounted,
eventPrebuiltComponentOpened,
Expand Down Expand Up @@ -367,14 +361,7 @@ export class Clerk implements ClerkInterface {
if (!isValidProxyUrl(_unfilteredProxy)) {
errorThrower.throwInvalidProxyUrl({ url: _unfilteredProxy });
}
const resolved = proxyUrlToAbsoluteURL(_unfilteredProxy);
if (resolved) {
return resolved;
}
// Auto-detect when no explicit proxy or domain is configured (production only)
if (!this.#domain && this.#instanceType === 'production' && shouldAutoProxy(window.location.hostname)) {
return `${window.location.origin}${AUTO_PROXY_PATH}`;
}
return proxyUrlToAbsoluteURL(_unfilteredProxy);
}

if (typeof this.#proxyUrl === 'function') {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,24 +86,4 @@ describe('DynamicClerkScripts', () => {
expect(html).not.toContain('nonce="test');
expect(html).not.toContain('nonce="csp');
});

it('renders initial script tags with relative proxied asset URLs', async () => {
mockHeaders.mockResolvedValue(
new Map([
['X-Nonce', null],
['Content-Security-Policy', ''],
]),
);

const html = await render(
DynamicClerkScripts({
...defaultProps,
proxyUrl: '/__clerk',
}),
);

expect(html).toContain('src="/__clerk/npm/@clerk/clerk-js@');
expect(html).toContain('href="/__clerk/npm/@clerk/ui@');
expect(html).toContain('data-clerk-proxy-url="/__clerk"');
});
});
34 changes: 0 additions & 34 deletions packages/nextjs/src/server/__tests__/clerkMiddleware.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1326,40 +1326,6 @@ describe('frontendApiProxy multi-domain support', () => {
});
});

describe('auto-proxy for eligible hosts', () => {
const productionPublishableKey = 'pk_live_Y2xlcmsuaW5jbHVkZWQua2F0eWRpZC05Mi5sY2wuZGV2JA';

it('auto-intercepts /__clerk/* requests on eligible hostnames', async () => {
const req = new NextRequest(new URL('/__clerk/v1/client', 'https://myapp-abc123.vercel.app').toString(), {
method: 'GET',
headers: new Headers(),
});

const resp = await clerkMiddleware({ publishableKey: productionPublishableKey })(req, {} as NextFetchEvent);

// Proxy should intercept the request — authenticateRequest should NOT be called
expect((await clerkClient()).authenticateRequest).not.toBeCalled();
expect(resp?.status).toBeDefined();
});

it('uses request.nextUrl for auto-detection', async () => {
const req = new NextRequest('http://127.0.0.1:3000/__clerk/v1/client', {
method: 'GET',
headers: new Headers(),
});

Object.defineProperty(req, 'nextUrl', {
value: new URL('https://myapp-abc123.vercel.app/__clerk/v1/client'),
configurable: true,
});

const resp = await clerkMiddleware({ publishableKey: productionPublishableKey })(req, {} as NextFetchEvent);

expect((await clerkClient()).authenticateRequest).not.toBeCalled();
expect(resp?.status).toBeDefined();
});
});

describe('contentSecurityPolicy option', () => {
it('forwards CSP headers as request headers when strict mode is enabled', async () => {
const resp = await clerkMiddleware({
Expand Down
17 changes: 4 additions & 13 deletions packages/nextjs/src/server/clerkMiddleware.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,9 @@ import {
TokenType,
} from '@clerk/backend/internal';
import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, matchProxyPath } from '@clerk/backend/proxy';
import { isProductionFromPublishableKey, parsePublishableKey } from '@clerk/shared/keys';
import { parsePublishableKey } from '@clerk/shared/keys';
import { handleNetlifyCacheInDevInstance } from '@clerk/shared/netlifyCacheHandler';
import { isMalformedURLError } from '@clerk/shared/pathMatcher';
import { shouldAutoProxy } from '@clerk/shared/proxy';
import { notFound as nextjsNotFound } from 'next/navigation';
import type { NextMiddleware, NextRequest } from 'next/server';
import { NextResponse } from 'next/server';
Expand All @@ -36,7 +35,7 @@ import type { Logger, LoggerNoCommit } from '../utils/debugLogger';
import { withLogger } from '../utils/debugLogger';
import { canUseKeyless } from '../utils/feature-flags';
import { clerkClient } from './clerkClient';
import { DOMAIN, PROXY_URL, PUBLISHABLE_KEY, SECRET_KEY, SIGN_IN_URL, SIGN_UP_URL } from './constants';
import { PUBLISHABLE_KEY, SECRET_KEY, SIGN_IN_URL, SIGN_UP_URL } from './constants';
import { type ContentSecurityPolicyOptions, createContentSecurityPolicyHeaders } from './content-security-policy';
import { errorThrower } from './errorThrower';
import { getHeader } from './headers-utils';
Expand Down Expand Up @@ -162,20 +161,12 @@ export const clerkMiddleware = ((...args: unknown[]): NextMiddleware | NextMiddl
);

// Handle Frontend API proxy requests early, before authentication
const requestUrl = new URL(request.nextUrl.href);
let frontendApiProxyConfig = resolvedParams.frontendApiProxy;

// Auto-detect when no explicit proxy or domain is configured
const hasExplicitProxyOrDomain = resolvedParams.proxyUrl || PROXY_URL || resolvedParams.domain || DOMAIN;
if (!frontendApiProxyConfig && !hasExplicitProxyOrDomain && isProductionFromPublishableKey(publishableKey)) {
if (shouldAutoProxy(requestUrl.hostname)) {
frontendApiProxyConfig = { enabled: true };
}
}
const frontendApiProxyConfig = resolvedParams.frontendApiProxy;
if (frontendApiProxyConfig) {
const { enabled, path: proxyPath = DEFAULT_PROXY_PATH } = frontendApiProxyConfig;

// Resolve enabled - either boolean or function
const requestUrl = new URL(request.url);
const isEnabled = typeof enabled === 'function' ? enabled(requestUrl) : enabled;

if (isEnabled && matchProxyPath(request, { proxyPath })) {
Expand Down
Loading
Loading