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/spicy-llamas-brush.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/express': patch
---

Fix an authentication bypass where a `req.auth` value set by another library (such as `express-jwt`, Passport, or `express-openid-connect`) caused `clerkMiddleware()` and `requireAuth()` to silently skip Clerk authentication, and `getAuth()` to return the unverified foreign value. Clerk now brands the `req.auth` handler it installs and only trusts that handler: `clerkMiddleware()` authenticates the request and overwrites a foreign `req.auth` (logging a warning when it does), and `getAuth()` throws its "middleware required" error instead of reading foreign data.
89 changes: 89 additions & 0 deletions packages/express/src/__tests__/clerkMiddleware.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,9 +25,17 @@ vi.mock('@clerk/backend', async () => {
};
});

const { mockWarnOnce } = vi.hoisted(() => ({
mockWarnOnce: vi.fn(),
}));
vi.mock('@clerk/shared/logger', () => ({
logger: { warnOnce: mockWarnOnce, logOnce: vi.fn() },
}));

import { authenticateAndDecorateRequest, authenticateRequest } from '../authenticateRequest';
import { clerkMiddleware } from '../clerkMiddleware';
import { getAuth } from '../getAuth';
import { requireAuth } from '../requireAuth';
import { assertNoDebugHeaders, assertSignedOutDebugHeaders, runMiddleware, runMiddlewareOnPath } from './helpers';

describe('clerkMiddleware', () => {
Expand DownExpand Up@@ -331,6 +339,87 @@ describe('clerkMiddleware', () => {
expect(response.header).toHaveProperty('location', expect.stringContaining('/v1/client/handshake?redirect_url='));
});

describe('foreign req.auth values (authentication bypass hardening)', () => {
beforeEach(() => {
mockWarnOnce.mockClear();
});

it('authenticates the request even when a previous middleware set req.auth to a plain object (express-jwt style)', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: { sub: 'attacker' } });
next();
};

const response = await runMiddleware([foreignAuth, clerkMiddleware()], {
Cookie: '__clerk_db_jwt=deadbeef;',
}).expect(200, 'Hello world!');

assertSignedOutDebugHeaders(response);
expect(mockWarnOnce).toHaveBeenCalledTimes(1);
});

it('overwrites a foreign req.auth function so getAuth returns Clerk state', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: () => ({ userId: 'attacker' }) });
next();
};

let capturedUserId: string | null | undefined;
const capture: RequestHandler = (req, _res, next) => {
capturedUserId = getAuth(req).userId;
next();
};

const response = await runMiddleware([foreignAuth, clerkMiddleware(), capture], {
Cookie: '__clerk_db_jwt=deadbeef;',
}).expect(200, 'Hello world!');

assertSignedOutDebugHeaders(response);
expect(capturedUserId).toBeNull();
});

it('does not re-authenticate when clerkMiddleware runs twice', async () => {
const authenticateRequestSpy = vi.fn().mockResolvedValue({
headers: new Headers(),
status: 'signed-out',
toAuth: () => ({ userId: null }),
});
const clerkClient = { authenticateRequest: authenticateRequestSpy } as any;

await runMiddleware([clerkMiddleware({ clerkClient }), clerkMiddleware({ clerkClient })]).expect(
200,
'Hello world!',
);

expect(authenticateRequestSpy).toHaveBeenCalledTimes(1);
expect(mockWarnOnce).not.toHaveBeenCalled();
});

it('requireAuth is not bypassed by a foreign req.auth that reports a userId', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: () => ({ userId: 'attacker' }) });
next();
};

const response = await runMiddleware([foreignAuth, requireAuth({ signInUrl: '/sign-in' })]);

expect(response.status).toBe(302);
expect(response.headers.location).toBe('/sign-in');
});

it('requireAuth redirects (does not 500) when a foreign req.auth is a plain object', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: { sub: 'attacker' } });
next();
};

const response = await runMiddleware([foreignAuth, requireAuth({ signInUrl: '/sign-in' })]);

expect(response.status).toBe(302);
expect(response.headers.location).toBe('/sign-in');
});
});

describe('Frontend API proxy handling', () => {
beforeEach(() => {
mockClerkFrontendApiProxy.mockReset();
Expand Down
11 changes: 11 additions & 0 deletions packages/express/src/__tests__/getAuth.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import type { AuthenticatedMachineObject } from '@clerk/backend/internal';
import type { Request as ExpressRequest } from 'express';
import { describe, expect, it } from 'vitest';

import { getAuth } from '../getAuth';
Expand All@@ -9,6 +10,16 @@ describe('getAuth', () => {
expect(() => getAuth(mockRequest())).toThrow(/The "clerkMiddleware" should be registered before using "getAuth"/);
});

it('throws error if req.auth is a plain object set by another library (express-jwt style)', () => {
const req = { auth: { sub: 'attacker' } } as unknown as ExpressRequest;
expect(() => getAuth(req)).toThrow(/The "clerkMiddleware" should be registered before using "getAuth"/);
});

it('throws error if req.auth is a function set by another library', () => {
const req = { auth: () => ({ userId: 'attacker' }) } as unknown as ExpressRequest;
expect(() => getAuth(req)).toThrow(/The "clerkMiddleware" should be registered before using "getAuth"/);
});

it('returns auth from request for signed-out request', () => {
const req = mockRequestWithAuth({ userId: null, tokenType: 'session_token' });
const auth = getAuth(req);
Expand Down
5 changes: 3 additions & 2 deletions packages/express/src/__tests__/helpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import supertest from 'supertest';
import { expect, vi } from 'vitest';

import type { ExpressRequestWithAuth } from '../types';
import { brandRequestAuth } from '../utils';

// Inspired by https://github.com/helmetjs/helmet/blob/main/test/helpers.ts
export function runMiddleware(middleware: RequestHandler | RequestHandler[], headers: Record<string, string> = {}) {
Expand DownExpand Up@@ -41,13 +42,13 @@ export function mockRequest(): ExpressRequest {

export function mockRequestWithAuth(auth: Partial<AuthObject> = {}): ExpressRequestWithAuth {
return {
auth: () => ({
auth: brandRequestAuth(() => ({
getToken: () => Promise.resolve(''),
has: () => false,
debug: () => ({}),
tokenType: 'session_token',
...auth,
}),
})),
} as unknown as ExpressRequestWithAuth;
}

Expand Down
6 changes: 3 additions & 3 deletions packages/express/src/__tests__/requireAuth.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { beforeEach, describe, expect, it, vi } from 'vitest';

import { clerkMiddleware } from '../clerkMiddleware';
import { requireAuth } from '../requireAuth';
import type { ExpressRequestWithAuth } from '../types';
import { brandRequestAuth, requestHasAuthObject } from '../utils';
import { mockRequestWithAuth, runMiddleware } from './helpers';

let mockAuthenticateAndDecorateRequest: Mock;
Expand DownExpand Up@@ -87,11 +87,11 @@ describe('requireAuth', () => {

mockAuthenticateAndDecorateRequest.mockImplementation((): RequestHandler => {
return (req, _res, next) => {
if ((req as ExpressRequestWithAuth).auth) {
if (requestHasAuthObject(req)) {
return next();
}
const requestState = mockAuthenticateRequest({ request: req });
Object.assign(req, { auth: () => requestState.toAuth() });
Object.assign(req, { auth: brandRequestAuth(() => requestState.toAuth()) });
next();
};
});
Expand Down
27 changes: 23 additions & 4 deletions packages/express/src/authenticateRequest.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,15 +3,23 @@ import type { RequestState } from '@clerk/backend/internal';
import { AuthStatus, createClerkRequest } from '@clerk/backend/internal';
import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, stripTrailingSlashes } from '@clerk/backend/proxy';
import { isDevelopmentFromSecretKey } from '@clerk/shared/keys';
import { logger } from '@clerk/shared/logger';
import { isHttpOrHttps, isProxyUrlRelative, isValidProxyUrl } from '@clerk/shared/proxy';
import { handleValueOrFn } from '@clerk/shared/utils';
import type { RequestHandler, Response } from 'express';
import { Readable } from 'stream';

import { clerkClient as defaultClerkClient } from './clerkClient';
import { satelliteAndMissingProxyUrlAndDomain, satelliteAndMissingSignInUrl } from './errors';
import type { AuthenticateRequestParams, ClerkMiddlewareOptions, ExpressRequestWithAuth } from './types';
import { incomingMessageToRequest, loadApiEnv, loadClientEnv, requestToProxyRequest } from './utils';
import type { AuthenticateRequestParams, ClerkMiddlewareOptions } from './types';
import {
brandRequestAuth,
incomingMessageToRequest,
loadApiEnv,
loadClientEnv,
requestHasAuthObject,
requestToProxyRequest,
} from './utils';

/**
* @internal
Expand DownExpand Up@@ -140,10 +148,21 @@ export const authenticateAndDecorateRequest = (options: ClerkMiddlewareOptions =

// eslint-disable-next-line @typescript-eslint/no-misused-promises
const middleware: RequestHandler = async (request, response, next) => {
if ((request as ExpressRequestWithAuth).auth) {
// Skip authentication only when a Clerk middleware has already processed
// this request. The brand check matters: a truthy `req.auth` is not proof
// of that, since express-jwt, passport and other libraries set the same
// property, and treating their value as ours would silently disable Clerk
// authentication.
if (requestHasAuthObject(request)) {
return next();
}

if ('auth' in request) {
logger.warnOnce(
'Clerk: another middleware has already set `req.auth` on this request. Clerk authentication will run anyway and overwrite it. To use another auth library alongside Clerk, configure it to store its state on a different request property.',
);
}
Comment on lines +160 to +164

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nice 👍🏼


const env = { ...loadApiEnv(), ...loadClientEnv() };
const publishableKey = options.publishableKey || env.publishableKey;
const secretKey = options.secretKey || env.secretKey;
Expand DownExpand Up@@ -226,7 +245,7 @@ export const authenticateAndDecorateRequest = (options: ClerkMiddlewareOptions =
return;
}

const auth = (opts: Parameters<typeof requestState.toAuth>[0]) => requestState.toAuth(opts);
const auth = brandRequestAuth((opts: Parameters<typeof requestState.toAuth>[0]) => requestState.toAuth(opts));

Object.assign(request, { auth });

Expand Down
16 changes: 15 additions & 1 deletion packages/express/src/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,22 @@ import { Readable } from 'stream';

import type { ExpressRequestWithAuth } from './types';

/**
* Brand attached to the `req.auth` handler installed by Clerk middleware.
* `req.auth` is a property name shared with other auth libraries (express-jwt,
* passport, express-openid-connect), so its mere presence proves nothing about
* whether Clerk authenticated the request. `Symbol.for` registers the brand
* globally so it stays stable across multiple copies of this package loaded in
* the same process.
*/
const clerkAuthBrand = Symbol.for('@clerk/express.auth');

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

🧠


export const brandRequestAuth = <T extends (...args: never[]) => unknown>(authHandler: T): T =>
Object.assign(authHandler, { [clerkAuthBrand]: true });

export const requestHasAuthObject = (req: ExpressRequest): req is ExpressRequestWithAuth => {
return 'auth' in req;
const auth = (req as Partial<ExpressRequestWithAuth>).auth;
return typeof auth === 'function' && (auth as unknown as Record<symbol, unknown>)[clerkAuthBrand] === true;
};

export const loadClientEnv = () => {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
fix(express): prevent auth bypass from foreign req.auth values by jacekradko · Pull Request #8804 · clerk/javascript · GitHub
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/spicy-llamas-brush.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/express': patch
---

Fix an authentication bypass where a `req.auth` value set by another library (such as `express-jwt`, Passport, or `express-openid-connect`) caused `clerkMiddleware()` and `requireAuth()` to silently skip Clerk authentication, and `getAuth()` to return the unverified foreign value. Clerk now brands the `req.auth` handler it installs and only trusts that handler: `clerkMiddleware()` authenticates the request and overwrites a foreign `req.auth` (logging a warning when it does), and `getAuth()` throws its "middleware required" error instead of reading foreign data.
89 changes: 89 additions & 0 deletions packages/express/src/__tests__/clerkMiddleware.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,9 +25,17 @@ vi.mock('@clerk/backend', async () => {
};
});

const { mockWarnOnce } = vi.hoisted(() => ({
mockWarnOnce: vi.fn(),
}));
vi.mock('@clerk/shared/logger', () => ({
logger: { warnOnce: mockWarnOnce, logOnce: vi.fn() },
}));

import { authenticateAndDecorateRequest, authenticateRequest } from '../authenticateRequest';
import { clerkMiddleware } from '../clerkMiddleware';
import { getAuth } from '../getAuth';
import { requireAuth } from '../requireAuth';
import { assertNoDebugHeaders, assertSignedOutDebugHeaders, runMiddleware, runMiddlewareOnPath } from './helpers';

describe('clerkMiddleware', () => {
Expand DownExpand Up@@ -331,6 +339,87 @@ describe('clerkMiddleware', () => {
expect(response.header).toHaveProperty('location', expect.stringContaining('/v1/client/handshake?redirect_url='));
});

describe('foreign req.auth values (authentication bypass hardening)', () => {
beforeEach(() => {
mockWarnOnce.mockClear();
});

it('authenticates the request even when a previous middleware set req.auth to a plain object (express-jwt style)', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: { sub: 'attacker' } });
next();
};

const response = await runMiddleware([foreignAuth, clerkMiddleware()], {
Cookie: '__clerk_db_jwt=deadbeef;',
}).expect(200, 'Hello world!');

assertSignedOutDebugHeaders(response);
expect(mockWarnOnce).toHaveBeenCalledTimes(1);
});

it('overwrites a foreign req.auth function so getAuth returns Clerk state', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: () => ({ userId: 'attacker' }) });
next();
};

let capturedUserId: string | null | undefined;
const capture: RequestHandler = (req, _res, next) => {
capturedUserId = getAuth(req).userId;
next();
};

const response = await runMiddleware([foreignAuth, clerkMiddleware(), capture], {
Cookie: '__clerk_db_jwt=deadbeef;',
}).expect(200, 'Hello world!');

assertSignedOutDebugHeaders(response);
expect(capturedUserId).toBeNull();
});

it('does not re-authenticate when clerkMiddleware runs twice', async () => {
const authenticateRequestSpy = vi.fn().mockResolvedValue({
headers: new Headers(),
status: 'signed-out',
toAuth: () => ({ userId: null }),
});
const clerkClient = { authenticateRequest: authenticateRequestSpy } as any;

await runMiddleware([clerkMiddleware({ clerkClient }), clerkMiddleware({ clerkClient })]).expect(
200,
'Hello world!',
);

expect(authenticateRequestSpy).toHaveBeenCalledTimes(1);
expect(mockWarnOnce).not.toHaveBeenCalled();
});

it('requireAuth is not bypassed by a foreign req.auth that reports a userId', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: () => ({ userId: 'attacker' }) });
next();
};

const response = await runMiddleware([foreignAuth, requireAuth({ signInUrl: '/sign-in' })]);

expect(response.status).toBe(302);
expect(response.headers.location).toBe('/sign-in');
});

it('requireAuth redirects (does not 500) when a foreign req.auth is a plain object', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: { sub: 'attacker' } });
next();
};

const response = await runMiddleware([foreignAuth, requireAuth({ signInUrl: '/sign-in' })]);

expect(response.status).toBe(302);
expect(response.headers.location).toBe('/sign-in');
});
});

describe('Frontend API proxy handling', () => {
beforeEach(() => {
mockClerkFrontendApiProxy.mockReset();
Expand Down
11 changes: 11 additions & 0 deletions packages/express/src/__tests__/getAuth.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import type { AuthenticatedMachineObject } from '@clerk/backend/internal';
import type { Request as ExpressRequest } from 'express';
import { describe, expect, it } from 'vitest';

import { getAuth } from '../getAuth';
Expand All@@ -9,6 +10,16 @@ describe('getAuth', () => {
expect(() => getAuth(mockRequest())).toThrow(/The "clerkMiddleware" should be registered before using "getAuth"/);
});

it('throws error if req.auth is a plain object set by another library (express-jwt style)', () => {
const req = { auth: { sub: 'attacker' } } as unknown as ExpressRequest;
expect(() => getAuth(req)).toThrow(/The "clerkMiddleware" should be registered before using "getAuth"/);
});

it('throws error if req.auth is a function set by another library', () => {
const req = { auth: () => ({ userId: 'attacker' }) } as unknown as ExpressRequest;
expect(() => getAuth(req)).toThrow(/The "clerkMiddleware" should be registered before using "getAuth"/);
});

it('returns auth from request for signed-out request', () => {
const req = mockRequestWithAuth({ userId: null, tokenType: 'session_token' });
const auth = getAuth(req);
Expand Down
5 changes: 3 additions & 2 deletions packages/express/src/__tests__/helpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import supertest from 'supertest';
import { expect, vi } from 'vitest';

import type { ExpressRequestWithAuth } from '../types';
import { brandRequestAuth } from '../utils';

// Inspired by https://github.com/helmetjs/helmet/blob/main/test/helpers.ts
export function runMiddleware(middleware: RequestHandler | RequestHandler[], headers: Record<string, string> = {}) {
Expand DownExpand Up@@ -41,13 +42,13 @@ export function mockRequest(): ExpressRequest {

export function mockRequestWithAuth(auth: Partial<AuthObject> = {}): ExpressRequestWithAuth {
return {
auth: () => ({
auth: brandRequestAuth(() => ({
getToken: () => Promise.resolve(''),
has: () => false,
debug: () => ({}),
tokenType: 'session_token',
...auth,
}),
})),
} as unknown as ExpressRequestWithAuth;
}

Expand Down
6 changes: 3 additions & 3 deletions packages/express/src/__tests__/requireAuth.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { beforeEach, describe, expect, it, vi } from 'vitest';

import { clerkMiddleware } from '../clerkMiddleware';
import { requireAuth } from '../requireAuth';
import type { ExpressRequestWithAuth } from '../types';
import { brandRequestAuth, requestHasAuthObject } from '../utils';
import { mockRequestWithAuth, runMiddleware } from './helpers';

let mockAuthenticateAndDecorateRequest: Mock;
Expand DownExpand Up@@ -87,11 +87,11 @@ describe('requireAuth', () => {

mockAuthenticateAndDecorateRequest.mockImplementation((): RequestHandler => {
return (req, _res, next) => {
if ((req as ExpressRequestWithAuth).auth) {
if (requestHasAuthObject(req)) {
return next();
}
const requestState = mockAuthenticateRequest({ request: req });
Object.assign(req, { auth: () => requestState.toAuth() });
Object.assign(req, { auth: brandRequestAuth(() => requestState.toAuth()) });
next();
};
});
Expand Down
27 changes: 23 additions & 4 deletions packages/express/src/authenticateRequest.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,15 +3,23 @@ import type { RequestState } from '@clerk/backend/internal';
import { AuthStatus, createClerkRequest } from '@clerk/backend/internal';
import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, stripTrailingSlashes } from '@clerk/backend/proxy';
import { isDevelopmentFromSecretKey } from '@clerk/shared/keys';
import { logger } from '@clerk/shared/logger';
import { isHttpOrHttps, isProxyUrlRelative, isValidProxyUrl } from '@clerk/shared/proxy';
import { handleValueOrFn } from '@clerk/shared/utils';
import type { RequestHandler, Response } from 'express';
import { Readable } from 'stream';

import { clerkClient as defaultClerkClient } from './clerkClient';
import { satelliteAndMissingProxyUrlAndDomain, satelliteAndMissingSignInUrl } from './errors';
import type { AuthenticateRequestParams, ClerkMiddlewareOptions, ExpressRequestWithAuth } from './types';
import { incomingMessageToRequest, loadApiEnv, loadClientEnv, requestToProxyRequest } from './utils';
import type { AuthenticateRequestParams, ClerkMiddlewareOptions } from './types';
import {
brandRequestAuth,
incomingMessageToRequest,
loadApiEnv,
loadClientEnv,
requestHasAuthObject,
requestToProxyRequest,
} from './utils';

/**
* @internal
Expand DownExpand Up@@ -140,10 +148,21 @@ export const authenticateAndDecorateRequest = (options: ClerkMiddlewareOptions =

// eslint-disable-next-line @typescript-eslint/no-misused-promises
const middleware: RequestHandler = async (request, response, next) => {
if ((request as ExpressRequestWithAuth).auth) {
// Skip authentication only when a Clerk middleware has already processed
// this request. The brand check matters: a truthy `req.auth` is not proof
// of that, since express-jwt, passport and other libraries set the same
// property, and treating their value as ours would silently disable Clerk
// authentication.
if (requestHasAuthObject(request)) {
return next();
}

if ('auth' in request) {
logger.warnOnce(
'Clerk: another middleware has already set `req.auth` on this request. Clerk authentication will run anyway and overwrite it. To use another auth library alongside Clerk, configure it to store its state on a different request property.',
);
}
Comment on lines +160 to +164

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nice 👍🏼


const env = { ...loadApiEnv(), ...loadClientEnv() };
const publishableKey = options.publishableKey || env.publishableKey;
const secretKey = options.secretKey || env.secretKey;
Expand DownExpand Up@@ -226,7 +245,7 @@ export const authenticateAndDecorateRequest = (options: ClerkMiddlewareOptions =
return;
}

const auth = (opts: Parameters<typeof requestState.toAuth>[0]) => requestState.toAuth(opts);
const auth = brandRequestAuth((opts: Parameters<typeof requestState.toAuth>[0]) => requestState.toAuth(opts));

Object.assign(request, { auth });

Expand Down
16 changes: 15 additions & 1 deletion packages/express/src/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,22 @@ import { Readable } from 'stream';

import type { ExpressRequestWithAuth } from './types';

/**
* Brand attached to the `req.auth` handler installed by Clerk middleware.
* `req.auth` is a property name shared with other auth libraries (express-jwt,
* passport, express-openid-connect), so its mere presence proves nothing about
* whether Clerk authenticated the request. `Symbol.for` registers the brand
* globally so it stays stable across multiple copies of this package loaded in
* the same process.
*/
const clerkAuthBrand = Symbol.for('@clerk/express.auth');

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

🧠


export const brandRequestAuth = <T extends (...args: never[]) => unknown>(authHandler: T): T =>
Object.assign(authHandler, { [clerkAuthBrand]: true });

export const requestHasAuthObject = (req: ExpressRequest): req is ExpressRequestWithAuth => {
return 'auth' in req;
const auth = (req as Partial<ExpressRequestWithAuth>).auth;
return typeof auth === 'function' && (auth as unknown as Record<symbol, unknown>)[clerkAuthBrand] === true;
};

export const loadClientEnv = () => {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(express): prevent auth bypass from foreign req.auth values by jacekradko · Pull Request #8804 · clerk/javascript · GitHub
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/spicy-llamas-brush.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/express': patch
---

Fix an authentication bypass where a `req.auth` value set by another library (such as `express-jwt`, Passport, or `express-openid-connect`) caused `clerkMiddleware()` and `requireAuth()` to silently skip Clerk authentication, and `getAuth()` to return the unverified foreign value. Clerk now brands the `req.auth` handler it installs and only trusts that handler: `clerkMiddleware()` authenticates the request and overwrites a foreign `req.auth` (logging a warning when it does), and `getAuth()` throws its "middleware required" error instead of reading foreign data.
89 changes: 89 additions & 0 deletions packages/express/src/__tests__/clerkMiddleware.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,9 +25,17 @@ vi.mock('@clerk/backend', async () => {
};
});

const { mockWarnOnce } = vi.hoisted(() => ({
mockWarnOnce: vi.fn(),
}));
vi.mock('@clerk/shared/logger', () => ({
logger: { warnOnce: mockWarnOnce, logOnce: vi.fn() },
}));

import { authenticateAndDecorateRequest, authenticateRequest } from '../authenticateRequest';
import { clerkMiddleware } from '../clerkMiddleware';
import { getAuth } from '../getAuth';
import { requireAuth } from '../requireAuth';
import { assertNoDebugHeaders, assertSignedOutDebugHeaders, runMiddleware, runMiddlewareOnPath } from './helpers';

describe('clerkMiddleware', () => {
Expand DownExpand Up@@ -331,6 +339,87 @@ describe('clerkMiddleware', () => {
expect(response.header).toHaveProperty('location', expect.stringContaining('/v1/client/handshake?redirect_url='));
});

describe('foreign req.auth values (authentication bypass hardening)', () => {
beforeEach(() => {
mockWarnOnce.mockClear();
});

it('authenticates the request even when a previous middleware set req.auth to a plain object (express-jwt style)', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: { sub: 'attacker' } });
next();
};

const response = await runMiddleware([foreignAuth, clerkMiddleware()], {
Cookie: '__clerk_db_jwt=deadbeef;',
}).expect(200, 'Hello world!');

assertSignedOutDebugHeaders(response);
expect(mockWarnOnce).toHaveBeenCalledTimes(1);
});

it('overwrites a foreign req.auth function so getAuth returns Clerk state', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: () => ({ userId: 'attacker' }) });
next();
};

let capturedUserId: string | null | undefined;
const capture: RequestHandler = (req, _res, next) => {
capturedUserId = getAuth(req).userId;
next();
};

const response = await runMiddleware([foreignAuth, clerkMiddleware(), capture], {
Cookie: '__clerk_db_jwt=deadbeef;',
}).expect(200, 'Hello world!');

assertSignedOutDebugHeaders(response);
expect(capturedUserId).toBeNull();
});

it('does not re-authenticate when clerkMiddleware runs twice', async () => {
const authenticateRequestSpy = vi.fn().mockResolvedValue({
headers: new Headers(),
status: 'signed-out',
toAuth: () => ({ userId: null }),
});
const clerkClient = { authenticateRequest: authenticateRequestSpy } as any;

await runMiddleware([clerkMiddleware({ clerkClient }), clerkMiddleware({ clerkClient })]).expect(
200,
'Hello world!',
);

expect(authenticateRequestSpy).toHaveBeenCalledTimes(1);
expect(mockWarnOnce).not.toHaveBeenCalled();
});

it('requireAuth is not bypassed by a foreign req.auth that reports a userId', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: () => ({ userId: 'attacker' }) });
next();
};

const response = await runMiddleware([foreignAuth, requireAuth({ signInUrl: '/sign-in' })]);

expect(response.status).toBe(302);
expect(response.headers.location).toBe('/sign-in');
});

it('requireAuth redirects (does not 500) when a foreign req.auth is a plain object', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: { sub: 'attacker' } });
next();
};

const response = await runMiddleware([foreignAuth, requireAuth({ signInUrl: '/sign-in' })]);

expect(response.status).toBe(302);
expect(response.headers.location).toBe('/sign-in');
});
});

describe('Frontend API proxy handling', () => {
beforeEach(() => {
mockClerkFrontendApiProxy.mockReset();
Expand Down
11 changes: 11 additions & 0 deletions packages/express/src/__tests__/getAuth.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import type { AuthenticatedMachineObject } from '@clerk/backend/internal';
import type { Request as ExpressRequest } from 'express';
import { describe, expect, it } from 'vitest';

import { getAuth } from '../getAuth';
Expand All@@ -9,6 +10,16 @@ describe('getAuth', () => {
expect(() => getAuth(mockRequest())).toThrow(/The "clerkMiddleware" should be registered before using "getAuth"/);
});

it('throws error if req.auth is a plain object set by another library (express-jwt style)', () => {
const req = { auth: { sub: 'attacker' } } as unknown as ExpressRequest;
expect(() => getAuth(req)).toThrow(/The "clerkMiddleware" should be registered before using "getAuth"/);
});

it('throws error if req.auth is a function set by another library', () => {
const req = { auth: () => ({ userId: 'attacker' }) } as unknown as ExpressRequest;
expect(() => getAuth(req)).toThrow(/The "clerkMiddleware" should be registered before using "getAuth"/);
});

it('returns auth from request for signed-out request', () => {
const req = mockRequestWithAuth({ userId: null, tokenType: 'session_token' });
const auth = getAuth(req);
Expand Down
5 changes: 3 additions & 2 deletions packages/express/src/__tests__/helpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import supertest from 'supertest';
import { expect, vi } from 'vitest';

import type { ExpressRequestWithAuth } from '../types';
import { brandRequestAuth } from '../utils';

// Inspired by https://github.com/helmetjs/helmet/blob/main/test/helpers.ts
export function runMiddleware(middleware: RequestHandler | RequestHandler[], headers: Record<string, string> = {}) {
Expand DownExpand Up@@ -41,13 +42,13 @@ export function mockRequest(): ExpressRequest {

export function mockRequestWithAuth(auth: Partial<AuthObject> = {}): ExpressRequestWithAuth {
return {
auth: () => ({
auth: brandRequestAuth(() => ({
getToken: () => Promise.resolve(''),
has: () => false,
debug: () => ({}),
tokenType: 'session_token',
...auth,
}),
})),
} as unknown as ExpressRequestWithAuth;
}

Expand Down
6 changes: 3 additions & 3 deletions packages/express/src/__tests__/requireAuth.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { beforeEach, describe, expect, it, vi } from 'vitest';

import { clerkMiddleware } from '../clerkMiddleware';
import { requireAuth } from '../requireAuth';
import type { ExpressRequestWithAuth } from '../types';
import { brandRequestAuth, requestHasAuthObject } from '../utils';
import { mockRequestWithAuth, runMiddleware } from './helpers';

let mockAuthenticateAndDecorateRequest: Mock;
Expand DownExpand Up@@ -87,11 +87,11 @@ describe('requireAuth', () => {

mockAuthenticateAndDecorateRequest.mockImplementation((): RequestHandler => {
return (req, _res, next) => {
if ((req as ExpressRequestWithAuth).auth) {
if (requestHasAuthObject(req)) {
return next();
}
const requestState = mockAuthenticateRequest({ request: req });
Object.assign(req, { auth: () => requestState.toAuth() });
Object.assign(req, { auth: brandRequestAuth(() => requestState.toAuth()) });
next();
};
});
Expand Down
27 changes: 23 additions & 4 deletions packages/express/src/authenticateRequest.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,15 +3,23 @@ import type { RequestState } from '@clerk/backend/internal';
import { AuthStatus, createClerkRequest } from '@clerk/backend/internal';
import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, stripTrailingSlashes } from '@clerk/backend/proxy';
import { isDevelopmentFromSecretKey } from '@clerk/shared/keys';
import { logger } from '@clerk/shared/logger';
import { isHttpOrHttps, isProxyUrlRelative, isValidProxyUrl } from '@clerk/shared/proxy';
import { handleValueOrFn } from '@clerk/shared/utils';
import type { RequestHandler, Response } from 'express';
import { Readable } from 'stream';

import { clerkClient as defaultClerkClient } from './clerkClient';
import { satelliteAndMissingProxyUrlAndDomain, satelliteAndMissingSignInUrl } from './errors';
import type { AuthenticateRequestParams, ClerkMiddlewareOptions, ExpressRequestWithAuth } from './types';
import { incomingMessageToRequest, loadApiEnv, loadClientEnv, requestToProxyRequest } from './utils';
import type { AuthenticateRequestParams, ClerkMiddlewareOptions } from './types';
import {
brandRequestAuth,
incomingMessageToRequest,
loadApiEnv,
loadClientEnv,
requestHasAuthObject,
requestToProxyRequest,
} from './utils';

/**
* @internal
Expand DownExpand Up@@ -140,10 +148,21 @@ export const authenticateAndDecorateRequest = (options: ClerkMiddlewareOptions =

// eslint-disable-next-line @typescript-eslint/no-misused-promises
const middleware: RequestHandler = async (request, response, next) => {
if ((request as ExpressRequestWithAuth).auth) {
// Skip authentication only when a Clerk middleware has already processed
// this request. The brand check matters: a truthy `req.auth` is not proof
// of that, since express-jwt, passport and other libraries set the same
// property, and treating their value as ours would silently disable Clerk
// authentication.
if (requestHasAuthObject(request)) {
return next();
}

if ('auth' in request) {
logger.warnOnce(
'Clerk: another middleware has already set `req.auth` on this request. Clerk authentication will run anyway and overwrite it. To use another auth library alongside Clerk, configure it to store its state on a different request property.',
);
}
Comment on lines +160 to +164

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nice 👍🏼


const env = { ...loadApiEnv(), ...loadClientEnv() };
const publishableKey = options.publishableKey || env.publishableKey;
const secretKey = options.secretKey || env.secretKey;
Expand DownExpand Up@@ -226,7 +245,7 @@ export const authenticateAndDecorateRequest = (options: ClerkMiddlewareOptions =
return;
}

const auth = (opts: Parameters<typeof requestState.toAuth>[0]) => requestState.toAuth(opts);
const auth = brandRequestAuth((opts: Parameters<typeof requestState.toAuth>[0]) => requestState.toAuth(opts));

Object.assign(request, { auth });

Expand Down
16 changes: 15 additions & 1 deletion packages/express/src/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,22 @@ import { Readable } from 'stream';

import type { ExpressRequestWithAuth } from './types';

/**
* Brand attached to the `req.auth` handler installed by Clerk middleware.
* `req.auth` is a property name shared with other auth libraries (express-jwt,
* passport, express-openid-connect), so its mere presence proves nothing about
* whether Clerk authenticated the request. `Symbol.for` registers the brand
* globally so it stays stable across multiple copies of this package loaded in
* the same process.
*/
const clerkAuthBrand = Symbol.for('@clerk/express.auth');

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

🧠


export const brandRequestAuth = <T extends (...args: never[]) => unknown>(authHandler: T): T =>
Object.assign(authHandler, { [clerkAuthBrand]: true });

export const requestHasAuthObject = (req: ExpressRequest): req is ExpressRequestWithAuth => {
return 'auth' in req;
const auth = (req as Partial<ExpressRequestWithAuth>).auth;
return typeof auth === 'function' && (auth as unknown as Record<symbol, unknown>)[clerkAuthBrand] === true;
};

export const loadClientEnv = () => {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(express): prevent auth bypass from foreign req.auth values by jacekradko · Pull Request #8804 · clerk/javascript · GitHub
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/spicy-llamas-brush.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/express': patch
---

Fix an authentication bypass where a `req.auth` value set by another library (such as `express-jwt`, Passport, or `express-openid-connect`) caused `clerkMiddleware()` and `requireAuth()` to silently skip Clerk authentication, and `getAuth()` to return the unverified foreign value. Clerk now brands the `req.auth` handler it installs and only trusts that handler: `clerkMiddleware()` authenticates the request and overwrites a foreign `req.auth` (logging a warning when it does), and `getAuth()` throws its "middleware required" error instead of reading foreign data.
89 changes: 89 additions & 0 deletions packages/express/src/__tests__/clerkMiddleware.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,9 +25,17 @@ vi.mock('@clerk/backend', async () => {
};
});

const { mockWarnOnce } = vi.hoisted(() => ({
mockWarnOnce: vi.fn(),
}));
vi.mock('@clerk/shared/logger', () => ({
logger: { warnOnce: mockWarnOnce, logOnce: vi.fn() },
}));

import { authenticateAndDecorateRequest, authenticateRequest } from '../authenticateRequest';
import { clerkMiddleware } from '../clerkMiddleware';
import { getAuth } from '../getAuth';
import { requireAuth } from '../requireAuth';
import { assertNoDebugHeaders, assertSignedOutDebugHeaders, runMiddleware, runMiddlewareOnPath } from './helpers';

describe('clerkMiddleware', () => {
Expand DownExpand Up@@ -331,6 +339,87 @@ describe('clerkMiddleware', () => {
expect(response.header).toHaveProperty('location', expect.stringContaining('/v1/client/handshake?redirect_url='));
});

describe('foreign req.auth values (authentication bypass hardening)', () => {
beforeEach(() => {
mockWarnOnce.mockClear();
});

it('authenticates the request even when a previous middleware set req.auth to a plain object (express-jwt style)', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: { sub: 'attacker' } });
next();
};

const response = await runMiddleware([foreignAuth, clerkMiddleware()], {
Cookie: '__clerk_db_jwt=deadbeef;',
}).expect(200, 'Hello world!');

assertSignedOutDebugHeaders(response);
expect(mockWarnOnce).toHaveBeenCalledTimes(1);
});

it('overwrites a foreign req.auth function so getAuth returns Clerk state', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: () => ({ userId: 'attacker' }) });
next();
};

let capturedUserId: string | null | undefined;
const capture: RequestHandler = (req, _res, next) => {
capturedUserId = getAuth(req).userId;
next();
};

const response = await runMiddleware([foreignAuth, clerkMiddleware(), capture], {
Cookie: '__clerk_db_jwt=deadbeef;',
}).expect(200, 'Hello world!');

assertSignedOutDebugHeaders(response);
expect(capturedUserId).toBeNull();
});

it('does not re-authenticate when clerkMiddleware runs twice', async () => {
const authenticateRequestSpy = vi.fn().mockResolvedValue({
headers: new Headers(),
status: 'signed-out',
toAuth: () => ({ userId: null }),
});
const clerkClient = { authenticateRequest: authenticateRequestSpy } as any;

await runMiddleware([clerkMiddleware({ clerkClient }), clerkMiddleware({ clerkClient })]).expect(
200,
'Hello world!',
);

expect(authenticateRequestSpy).toHaveBeenCalledTimes(1);
expect(mockWarnOnce).not.toHaveBeenCalled();
});

it('requireAuth is not bypassed by a foreign req.auth that reports a userId', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: () => ({ userId: 'attacker' }) });
next();
};

const response = await runMiddleware([foreignAuth, requireAuth({ signInUrl: '/sign-in' })]);

expect(response.status).toBe(302);
expect(response.headers.location).toBe('/sign-in');
});

it('requireAuth redirects (does not 500) when a foreign req.auth is a plain object', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: { sub: 'attacker' } });
next();
};

const response = await runMiddleware([foreignAuth, requireAuth({ signInUrl: '/sign-in' })]);

expect(response.status).toBe(302);
expect(response.headers.location).toBe('/sign-in');
});
});

describe('Frontend API proxy handling', () => {
beforeEach(() => {
mockClerkFrontendApiProxy.mockReset();
Expand Down
11 changes: 11 additions & 0 deletions packages/express/src/__tests__/getAuth.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import type { AuthenticatedMachineObject } from '@clerk/backend/internal';
import type { Request as ExpressRequest } from 'express';
import { describe, expect, it } from 'vitest';

import { getAuth } from '../getAuth';
Expand All@@ -9,6 +10,16 @@ describe('getAuth', () => {
expect(() => getAuth(mockRequest())).toThrow(/The "clerkMiddleware" should be registered before using "getAuth"/);
});

it('throws error if req.auth is a plain object set by another library (express-jwt style)', () => {
const req = { auth: { sub: 'attacker' } } as unknown as ExpressRequest;
expect(() => getAuth(req)).toThrow(/The "clerkMiddleware" should be registered before using "getAuth"/);
});

it('throws error if req.auth is a function set by another library', () => {
const req = { auth: () => ({ userId: 'attacker' }) } as unknown as ExpressRequest;
expect(() => getAuth(req)).toThrow(/The "clerkMiddleware" should be registered before using "getAuth"/);
});

it('returns auth from request for signed-out request', () => {
const req = mockRequestWithAuth({ userId: null, tokenType: 'session_token' });
const auth = getAuth(req);
Expand Down
5 changes: 3 additions & 2 deletions packages/express/src/__tests__/helpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import supertest from 'supertest';
import { expect, vi } from 'vitest';

import type { ExpressRequestWithAuth } from '../types';
import { brandRequestAuth } from '../utils';

// Inspired by https://github.com/helmetjs/helmet/blob/main/test/helpers.ts
export function runMiddleware(middleware: RequestHandler | RequestHandler[], headers: Record<string, string> = {}) {
Expand DownExpand Up@@ -41,13 +42,13 @@ export function mockRequest(): ExpressRequest {

export function mockRequestWithAuth(auth: Partial<AuthObject> = {}): ExpressRequestWithAuth {
return {
auth: () => ({
auth: brandRequestAuth(() => ({
getToken: () => Promise.resolve(''),
has: () => false,
debug: () => ({}),
tokenType: 'session_token',
...auth,
}),
})),
} as unknown as ExpressRequestWithAuth;
}

Expand Down
6 changes: 3 additions & 3 deletions packages/express/src/__tests__/requireAuth.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { beforeEach, describe, expect, it, vi } from 'vitest';

import { clerkMiddleware } from '../clerkMiddleware';
import { requireAuth } from '../requireAuth';
import type { ExpressRequestWithAuth } from '../types';
import { brandRequestAuth, requestHasAuthObject } from '../utils';
import { mockRequestWithAuth, runMiddleware } from './helpers';

let mockAuthenticateAndDecorateRequest: Mock;
Expand DownExpand Up@@ -87,11 +87,11 @@ describe('requireAuth', () => {

mockAuthenticateAndDecorateRequest.mockImplementation((): RequestHandler => {
return (req, _res, next) => {
if ((req as ExpressRequestWithAuth).auth) {
if (requestHasAuthObject(req)) {
return next();
}
const requestState = mockAuthenticateRequest({ request: req });
Object.assign(req, { auth: () => requestState.toAuth() });
Object.assign(req, { auth: brandRequestAuth(() => requestState.toAuth()) });
next();
};
});
Expand Down
27 changes: 23 additions & 4 deletions packages/express/src/authenticateRequest.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,15 +3,23 @@ import type { RequestState } from '@clerk/backend/internal';
import { AuthStatus, createClerkRequest } from '@clerk/backend/internal';
import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, stripTrailingSlashes } from '@clerk/backend/proxy';
import { isDevelopmentFromSecretKey } from '@clerk/shared/keys';
import { logger } from '@clerk/shared/logger';
import { isHttpOrHttps, isProxyUrlRelative, isValidProxyUrl } from '@clerk/shared/proxy';
import { handleValueOrFn } from '@clerk/shared/utils';
import type { RequestHandler, Response } from 'express';
import { Readable } from 'stream';

import { clerkClient as defaultClerkClient } from './clerkClient';
import { satelliteAndMissingProxyUrlAndDomain, satelliteAndMissingSignInUrl } from './errors';
import type { AuthenticateRequestParams, ClerkMiddlewareOptions, ExpressRequestWithAuth } from './types';
import { incomingMessageToRequest, loadApiEnv, loadClientEnv, requestToProxyRequest } from './utils';
import type { AuthenticateRequestParams, ClerkMiddlewareOptions } from './types';
import {
brandRequestAuth,
incomingMessageToRequest,
loadApiEnv,
loadClientEnv,
requestHasAuthObject,
requestToProxyRequest,
} from './utils';

/**
* @internal
Expand DownExpand Up@@ -140,10 +148,21 @@ export const authenticateAndDecorateRequest = (options: ClerkMiddlewareOptions =

// eslint-disable-next-line @typescript-eslint/no-misused-promises
const middleware: RequestHandler = async (request, response, next) => {
if ((request as ExpressRequestWithAuth).auth) {
// Skip authentication only when a Clerk middleware has already processed
// this request. The brand check matters: a truthy `req.auth` is not proof
// of that, since express-jwt, passport and other libraries set the same
// property, and treating their value as ours would silently disable Clerk
// authentication.
if (requestHasAuthObject(request)) {
return next();
}

if ('auth' in request) {
logger.warnOnce(
'Clerk: another middleware has already set `req.auth` on this request. Clerk authentication will run anyway and overwrite it. To use another auth library alongside Clerk, configure it to store its state on a different request property.',
);
}
Comment on lines +160 to +164

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nice 👍🏼


const env = { ...loadApiEnv(), ...loadClientEnv() };
const publishableKey = options.publishableKey || env.publishableKey;
const secretKey = options.secretKey || env.secretKey;
Expand DownExpand Up@@ -226,7 +245,7 @@ export const authenticateAndDecorateRequest = (options: ClerkMiddlewareOptions =
return;
}

const auth = (opts: Parameters<typeof requestState.toAuth>[0]) => requestState.toAuth(opts);
const auth = brandRequestAuth((opts: Parameters<typeof requestState.toAuth>[0]) => requestState.toAuth(opts));

Object.assign(request, { auth });

Expand Down
16 changes: 15 additions & 1 deletion packages/express/src/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,22 @@ import { Readable } from 'stream';

import type { ExpressRequestWithAuth } from './types';

/**
* Brand attached to the `req.auth` handler installed by Clerk middleware.
* `req.auth` is a property name shared with other auth libraries (express-jwt,
* passport, express-openid-connect), so its mere presence proves nothing about
* whether Clerk authenticated the request. `Symbol.for` registers the brand
* globally so it stays stable across multiple copies of this package loaded in
* the same process.
*/
const clerkAuthBrand = Symbol.for('@clerk/express.auth');

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

🧠


export const brandRequestAuth = <T extends (...args: never[]) => unknown>(authHandler: T): T =>
Object.assign(authHandler, { [clerkAuthBrand]: true });

export const requestHasAuthObject = (req: ExpressRequest): req is ExpressRequestWithAuth => {
return 'auth' in req;
const auth = (req as Partial<ExpressRequestWithAuth>).auth;
return typeof auth === 'function' && (auth as unknown as Record<symbol, unknown>)[clerkAuthBrand] === true;
};

export const loadClientEnv = () => {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' fix(express): prevent auth bypass from foreign req.auth values by jacekradko · Pull Request #8804 · clerk/javascript · GitHub
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/spicy-llamas-brush.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/express': patch
---

Fix an authentication bypass where a `req.auth` value set by another library (such as `express-jwt`, Passport, or `express-openid-connect`) caused `clerkMiddleware()` and `requireAuth()` to silently skip Clerk authentication, and `getAuth()` to return the unverified foreign value. Clerk now brands the `req.auth` handler it installs and only trusts that handler: `clerkMiddleware()` authenticates the request and overwrites a foreign `req.auth` (logging a warning when it does), and `getAuth()` throws its "middleware required" error instead of reading foreign data.
89 changes: 89 additions & 0 deletions packages/express/src/__tests__/clerkMiddleware.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,9 +25,17 @@ vi.mock('@clerk/backend', async () => {
};
});

const { mockWarnOnce } = vi.hoisted(() => ({
mockWarnOnce: vi.fn(),
}));
vi.mock('@clerk/shared/logger', () => ({
logger: { warnOnce: mockWarnOnce, logOnce: vi.fn() },
}));

import { authenticateAndDecorateRequest, authenticateRequest } from '../authenticateRequest';
import { clerkMiddleware } from '../clerkMiddleware';
import { getAuth } from '../getAuth';
import { requireAuth } from '../requireAuth';
import { assertNoDebugHeaders, assertSignedOutDebugHeaders, runMiddleware, runMiddlewareOnPath } from './helpers';

describe('clerkMiddleware', () => {
Expand DownExpand Up@@ -331,6 +339,87 @@ describe('clerkMiddleware', () => {
expect(response.header).toHaveProperty('location', expect.stringContaining('/v1/client/handshake?redirect_url='));
});

describe('foreign req.auth values (authentication bypass hardening)', () => {
beforeEach(() => {
mockWarnOnce.mockClear();
});

it('authenticates the request even when a previous middleware set req.auth to a plain object (express-jwt style)', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: { sub: 'attacker' } });
next();
};

const response = await runMiddleware([foreignAuth, clerkMiddleware()], {
Cookie: '__clerk_db_jwt=deadbeef;',
}).expect(200, 'Hello world!');

assertSignedOutDebugHeaders(response);
expect(mockWarnOnce).toHaveBeenCalledTimes(1);
});

it('overwrites a foreign req.auth function so getAuth returns Clerk state', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: () => ({ userId: 'attacker' }) });
next();
};

let capturedUserId: string | null | undefined;
const capture: RequestHandler = (req, _res, next) => {
capturedUserId = getAuth(req).userId;
next();
};

const response = await runMiddleware([foreignAuth, clerkMiddleware(), capture], {
Cookie: '__clerk_db_jwt=deadbeef;',
}).expect(200, 'Hello world!');

assertSignedOutDebugHeaders(response);
expect(capturedUserId).toBeNull();
});

it('does not re-authenticate when clerkMiddleware runs twice', async () => {
const authenticateRequestSpy = vi.fn().mockResolvedValue({
headers: new Headers(),
status: 'signed-out',
toAuth: () => ({ userId: null }),
});
const clerkClient = { authenticateRequest: authenticateRequestSpy } as any;

await runMiddleware([clerkMiddleware({ clerkClient }), clerkMiddleware({ clerkClient })]).expect(
200,
'Hello world!',
);

expect(authenticateRequestSpy).toHaveBeenCalledTimes(1);
expect(mockWarnOnce).not.toHaveBeenCalled();
});

it('requireAuth is not bypassed by a foreign req.auth that reports a userId', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: () => ({ userId: 'attacker' }) });
next();
};

const response = await runMiddleware([foreignAuth, requireAuth({ signInUrl: '/sign-in' })]);

expect(response.status).toBe(302);
expect(response.headers.location).toBe('/sign-in');
});

it('requireAuth redirects (does not 500) when a foreign req.auth is a plain object', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: { sub: 'attacker' } });
next();
};

const response = await runMiddleware([foreignAuth, requireAuth({ signInUrl: '/sign-in' })]);

expect(response.status).toBe(302);
expect(response.headers.location).toBe('/sign-in');
});
});

describe('Frontend API proxy handling', () => {
beforeEach(() => {
mockClerkFrontendApiProxy.mockReset();
Expand Down
11 changes: 11 additions & 0 deletions packages/express/src/__tests__/getAuth.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import type { AuthenticatedMachineObject } from '@clerk/backend/internal';
import type { Request as ExpressRequest } from 'express';
import { describe, expect, it } from 'vitest';

import { getAuth } from '../getAuth';
Expand All@@ -9,6 +10,16 @@ describe('getAuth', () => {
expect(() => getAuth(mockRequest())).toThrow(/The "clerkMiddleware" should be registered before using "getAuth"/);
});

it('throws error if req.auth is a plain object set by another library (express-jwt style)', () => {
const req = { auth: { sub: 'attacker' } } as unknown as ExpressRequest;
expect(() => getAuth(req)).toThrow(/The "clerkMiddleware" should be registered before using "getAuth"/);
});

it('throws error if req.auth is a function set by another library', () => {
const req = { auth: () => ({ userId: 'attacker' }) } as unknown as ExpressRequest;
expect(() => getAuth(req)).toThrow(/The "clerkMiddleware" should be registered before using "getAuth"/);
});

it('returns auth from request for signed-out request', () => {
const req = mockRequestWithAuth({ userId: null, tokenType: 'session_token' });
const auth = getAuth(req);
Expand Down
5 changes: 3 additions & 2 deletions packages/express/src/__tests__/helpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import supertest from 'supertest';
import { expect, vi } from 'vitest';

import type { ExpressRequestWithAuth } from '../types';
import { brandRequestAuth } from '../utils';

// Inspired by https://github.com/helmetjs/helmet/blob/main/test/helpers.ts
export function runMiddleware(middleware: RequestHandler | RequestHandler[], headers: Record<string, string> = {}) {
Expand DownExpand Up@@ -41,13 +42,13 @@ export function mockRequest(): ExpressRequest {

export function mockRequestWithAuth(auth: Partial<AuthObject> = {}): ExpressRequestWithAuth {
return {
auth: () => ({
auth: brandRequestAuth(() => ({
getToken: () => Promise.resolve(''),
has: () => false,
debug: () => ({}),
tokenType: 'session_token',
...auth,
}),
})),
} as unknown as ExpressRequestWithAuth;
}

Expand Down
6 changes: 3 additions & 3 deletions packages/express/src/__tests__/requireAuth.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { beforeEach, describe, expect, it, vi } from 'vitest';

import { clerkMiddleware } from '../clerkMiddleware';
import { requireAuth } from '../requireAuth';
import type { ExpressRequestWithAuth } from '../types';
import { brandRequestAuth, requestHasAuthObject } from '../utils';
import { mockRequestWithAuth, runMiddleware } from './helpers';

let mockAuthenticateAndDecorateRequest: Mock;
Expand DownExpand Up@@ -87,11 +87,11 @@ describe('requireAuth', () => {

mockAuthenticateAndDecorateRequest.mockImplementation((): RequestHandler => {
return (req, _res, next) => {
if ((req as ExpressRequestWithAuth).auth) {
if (requestHasAuthObject(req)) {
return next();
}
const requestState = mockAuthenticateRequest({ request: req });
Object.assign(req, { auth: () => requestState.toAuth() });
Object.assign(req, { auth: brandRequestAuth(() => requestState.toAuth()) });
next();
};
});
Expand Down
27 changes: 23 additions & 4 deletions packages/express/src/authenticateRequest.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,15 +3,23 @@ import type { RequestState } from '@clerk/backend/internal';
import { AuthStatus, createClerkRequest } from '@clerk/backend/internal';
import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, stripTrailingSlashes } from '@clerk/backend/proxy';
import { isDevelopmentFromSecretKey } from '@clerk/shared/keys';
import { logger } from '@clerk/shared/logger';
import { isHttpOrHttps, isProxyUrlRelative, isValidProxyUrl } from '@clerk/shared/proxy';
import { handleValueOrFn } from '@clerk/shared/utils';
import type { RequestHandler, Response } from 'express';
import { Readable } from 'stream';

import { clerkClient as defaultClerkClient } from './clerkClient';
import { satelliteAndMissingProxyUrlAndDomain, satelliteAndMissingSignInUrl } from './errors';
import type { AuthenticateRequestParams, ClerkMiddlewareOptions, ExpressRequestWithAuth } from './types';
import { incomingMessageToRequest, loadApiEnv, loadClientEnv, requestToProxyRequest } from './utils';
import type { AuthenticateRequestParams, ClerkMiddlewareOptions } from './types';
import {
brandRequestAuth,
incomingMessageToRequest,
loadApiEnv,
loadClientEnv,
requestHasAuthObject,
requestToProxyRequest,
} from './utils';

/**
* @internal
Expand DownExpand Up@@ -140,10 +148,21 @@ export const authenticateAndDecorateRequest = (options: ClerkMiddlewareOptions =

// eslint-disable-next-line @typescript-eslint/no-misused-promises
const middleware: RequestHandler = async (request, response, next) => {
if ((request as ExpressRequestWithAuth).auth) {
// Skip authentication only when a Clerk middleware has already processed
// this request. The brand check matters: a truthy `req.auth` is not proof
// of that, since express-jwt, passport and other libraries set the same
// property, and treating their value as ours would silently disable Clerk
// authentication.
if (requestHasAuthObject(request)) {
return next();
}

if ('auth' in request) {
logger.warnOnce(
'Clerk: another middleware has already set `req.auth` on this request. Clerk authentication will run anyway and overwrite it. To use another auth library alongside Clerk, configure it to store its state on a different request property.',
);
}
Comment on lines +160 to +164

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nice 👍🏼


const env = { ...loadApiEnv(), ...loadClientEnv() };
const publishableKey = options.publishableKey || env.publishableKey;
const secretKey = options.secretKey || env.secretKey;
Expand DownExpand Up@@ -226,7 +245,7 @@ export const authenticateAndDecorateRequest = (options: ClerkMiddlewareOptions =
return;
}

const auth = (opts: Parameters<typeof requestState.toAuth>[0]) => requestState.toAuth(opts);
const auth = brandRequestAuth((opts: Parameters<typeof requestState.toAuth>[0]) => requestState.toAuth(opts));

Object.assign(request, { auth });

Expand Down
16 changes: 15 additions & 1 deletion packages/express/src/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,22 @@ import { Readable } from 'stream';

import type { ExpressRequestWithAuth } from './types';

/**
* Brand attached to the `req.auth` handler installed by Clerk middleware.
* `req.auth` is a property name shared with other auth libraries (express-jwt,
* passport, express-openid-connect), so its mere presence proves nothing about
* whether Clerk authenticated the request. `Symbol.for` registers the brand
* globally so it stays stable across multiple copies of this package loaded in
* the same process.
*/
const clerkAuthBrand = Symbol.for('@clerk/express.auth');

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

🧠


export const brandRequestAuth = <T extends (...args: never[]) => unknown>(authHandler: T): T =>
Object.assign(authHandler, { [clerkAuthBrand]: true });

export const requestHasAuthObject = (req: ExpressRequest): req is ExpressRequestWithAuth => {
return 'auth' in req;
const auth = (req as Partial<ExpressRequestWithAuth>).auth;
return typeof auth === 'function' && (auth as unknown as Record<symbol, unknown>)[clerkAuthBrand] === true;
};

export const loadClientEnv = () => {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(express): prevent auth bypass from foreign req.auth values by jacekradko · Pull Request #8804 · clerk/javascript · GitHub
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/spicy-llamas-brush.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/express': patch
---

Fix an authentication bypass where a `req.auth` value set by another library (such as `express-jwt`, Passport, or `express-openid-connect`) caused `clerkMiddleware()` and `requireAuth()` to silently skip Clerk authentication, and `getAuth()` to return the unverified foreign value. Clerk now brands the `req.auth` handler it installs and only trusts that handler: `clerkMiddleware()` authenticates the request and overwrites a foreign `req.auth` (logging a warning when it does), and `getAuth()` throws its "middleware required" error instead of reading foreign data.
89 changes: 89 additions & 0 deletions packages/express/src/__tests__/clerkMiddleware.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,9 +25,17 @@ vi.mock('@clerk/backend', async () => {
};
});

const { mockWarnOnce } = vi.hoisted(() => ({
mockWarnOnce: vi.fn(),
}));
vi.mock('@clerk/shared/logger', () => ({
logger: { warnOnce: mockWarnOnce, logOnce: vi.fn() },
}));

import { authenticateAndDecorateRequest, authenticateRequest } from '../authenticateRequest';
import { clerkMiddleware } from '../clerkMiddleware';
import { getAuth } from '../getAuth';
import { requireAuth } from '../requireAuth';
import { assertNoDebugHeaders, assertSignedOutDebugHeaders, runMiddleware, runMiddlewareOnPath } from './helpers';

describe('clerkMiddleware', () => {
Expand DownExpand Up@@ -331,6 +339,87 @@ describe('clerkMiddleware', () => {
expect(response.header).toHaveProperty('location', expect.stringContaining('/v1/client/handshake?redirect_url='));
});

describe('foreign req.auth values (authentication bypass hardening)', () => {
beforeEach(() => {
mockWarnOnce.mockClear();
});

it('authenticates the request even when a previous middleware set req.auth to a plain object (express-jwt style)', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: { sub: 'attacker' } });
next();
};

const response = await runMiddleware([foreignAuth, clerkMiddleware()], {
Cookie: '__clerk_db_jwt=deadbeef;',
}).expect(200, 'Hello world!');

assertSignedOutDebugHeaders(response);
expect(mockWarnOnce).toHaveBeenCalledTimes(1);
});

it('overwrites a foreign req.auth function so getAuth returns Clerk state', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: () => ({ userId: 'attacker' }) });
next();
};

let capturedUserId: string | null | undefined;
const capture: RequestHandler = (req, _res, next) => {
capturedUserId = getAuth(req).userId;
next();
};

const response = await runMiddleware([foreignAuth, clerkMiddleware(), capture], {
Cookie: '__clerk_db_jwt=deadbeef;',
}).expect(200, 'Hello world!');

assertSignedOutDebugHeaders(response);
expect(capturedUserId).toBeNull();
});

it('does not re-authenticate when clerkMiddleware runs twice', async () => {
const authenticateRequestSpy = vi.fn().mockResolvedValue({
headers: new Headers(),
status: 'signed-out',
toAuth: () => ({ userId: null }),
});
const clerkClient = { authenticateRequest: authenticateRequestSpy } as any;

await runMiddleware([clerkMiddleware({ clerkClient }), clerkMiddleware({ clerkClient })]).expect(
200,
'Hello world!',
);

expect(authenticateRequestSpy).toHaveBeenCalledTimes(1);
expect(mockWarnOnce).not.toHaveBeenCalled();
});

it('requireAuth is not bypassed by a foreign req.auth that reports a userId', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: () => ({ userId: 'attacker' }) });
next();
};

const response = await runMiddleware([foreignAuth, requireAuth({ signInUrl: '/sign-in' })]);

expect(response.status).toBe(302);
expect(response.headers.location).toBe('/sign-in');
});

it('requireAuth redirects (does not 500) when a foreign req.auth is a plain object', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: { sub: 'attacker' } });
next();
};

const response = await runMiddleware([foreignAuth, requireAuth({ signInUrl: '/sign-in' })]);

expect(response.status).toBe(302);
expect(response.headers.location).toBe('/sign-in');
});
});

describe('Frontend API proxy handling', () => {
beforeEach(() => {
mockClerkFrontendApiProxy.mockReset();
Expand Down
11 changes: 11 additions & 0 deletions packages/express/src/__tests__/getAuth.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import type { AuthenticatedMachineObject } from '@clerk/backend/internal';
import type { Request as ExpressRequest } from 'express';
import { describe, expect, it } from 'vitest';

import { getAuth } from '../getAuth';
Expand All@@ -9,6 +10,16 @@ describe('getAuth', () => {
expect(() => getAuth(mockRequest())).toThrow(/The "clerkMiddleware" should be registered before using "getAuth"/);
});

it('throws error if req.auth is a plain object set by another library (express-jwt style)', () => {
const req = { auth: { sub: 'attacker' } } as unknown as ExpressRequest;
expect(() => getAuth(req)).toThrow(/The "clerkMiddleware" should be registered before using "getAuth"/);
});

it('throws error if req.auth is a function set by another library', () => {
const req = { auth: () => ({ userId: 'attacker' }) } as unknown as ExpressRequest;
expect(() => getAuth(req)).toThrow(/The "clerkMiddleware" should be registered before using "getAuth"/);
});

it('returns auth from request for signed-out request', () => {
const req = mockRequestWithAuth({ userId: null, tokenType: 'session_token' });
const auth = getAuth(req);
Expand Down
5 changes: 3 additions & 2 deletions packages/express/src/__tests__/helpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import supertest from 'supertest';
import { expect, vi } from 'vitest';

import type { ExpressRequestWithAuth } from '../types';
import { brandRequestAuth } from '../utils';

// Inspired by https://github.com/helmetjs/helmet/blob/main/test/helpers.ts
export function runMiddleware(middleware: RequestHandler | RequestHandler[], headers: Record<string, string> = {}) {
Expand DownExpand Up@@ -41,13 +42,13 @@ export function mockRequest(): ExpressRequest {

export function mockRequestWithAuth(auth: Partial<AuthObject> = {}): ExpressRequestWithAuth {
return {
auth: () => ({
auth: brandRequestAuth(() => ({
getToken: () => Promise.resolve(''),
has: () => false,
debug: () => ({}),
tokenType: 'session_token',
...auth,
}),
})),
} as unknown as ExpressRequestWithAuth;
}

Expand Down
6 changes: 3 additions & 3 deletions packages/express/src/__tests__/requireAuth.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { beforeEach, describe, expect, it, vi } from 'vitest';

import { clerkMiddleware } from '../clerkMiddleware';
import { requireAuth } from '../requireAuth';
import type { ExpressRequestWithAuth } from '../types';
import { brandRequestAuth, requestHasAuthObject } from '../utils';
import { mockRequestWithAuth, runMiddleware } from './helpers';

let mockAuthenticateAndDecorateRequest: Mock;
Expand DownExpand Up@@ -87,11 +87,11 @@ describe('requireAuth', () => {

mockAuthenticateAndDecorateRequest.mockImplementation((): RequestHandler => {
return (req, _res, next) => {
if ((req as ExpressRequestWithAuth).auth) {
if (requestHasAuthObject(req)) {
return next();
}
const requestState = mockAuthenticateRequest({ request: req });
Object.assign(req, { auth: () => requestState.toAuth() });
Object.assign(req, { auth: brandRequestAuth(() => requestState.toAuth()) });
next();
};
});
Expand Down
27 changes: 23 additions & 4 deletions packages/express/src/authenticateRequest.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,15 +3,23 @@ import type { RequestState } from '@clerk/backend/internal';
import { AuthStatus, createClerkRequest } from '@clerk/backend/internal';
import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, stripTrailingSlashes } from '@clerk/backend/proxy';
import { isDevelopmentFromSecretKey } from '@clerk/shared/keys';
import { logger } from '@clerk/shared/logger';
import { isHttpOrHttps, isProxyUrlRelative, isValidProxyUrl } from '@clerk/shared/proxy';
import { handleValueOrFn } from '@clerk/shared/utils';
import type { RequestHandler, Response } from 'express';
import { Readable } from 'stream';

import { clerkClient as defaultClerkClient } from './clerkClient';
import { satelliteAndMissingProxyUrlAndDomain, satelliteAndMissingSignInUrl } from './errors';
import type { AuthenticateRequestParams, ClerkMiddlewareOptions, ExpressRequestWithAuth } from './types';
import { incomingMessageToRequest, loadApiEnv, loadClientEnv, requestToProxyRequest } from './utils';
import type { AuthenticateRequestParams, ClerkMiddlewareOptions } from './types';
import {
brandRequestAuth,
incomingMessageToRequest,
loadApiEnv,
loadClientEnv,
requestHasAuthObject,
requestToProxyRequest,
} from './utils';

/**
* @internal
Expand DownExpand Up@@ -140,10 +148,21 @@ export const authenticateAndDecorateRequest = (options: ClerkMiddlewareOptions =

// eslint-disable-next-line @typescript-eslint/no-misused-promises
const middleware: RequestHandler = async (request, response, next) => {
if ((request as ExpressRequestWithAuth).auth) {
// Skip authentication only when a Clerk middleware has already processed
// this request. The brand check matters: a truthy `req.auth` is not proof
// of that, since express-jwt, passport and other libraries set the same
// property, and treating their value as ours would silently disable Clerk
// authentication.
if (requestHasAuthObject(request)) {
return next();
}

if ('auth' in request) {
logger.warnOnce(
'Clerk: another middleware has already set `req.auth` on this request. Clerk authentication will run anyway and overwrite it. To use another auth library alongside Clerk, configure it to store its state on a different request property.',
);
}
Comment on lines +160 to +164

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nice 👍🏼


const env = { ...loadApiEnv(), ...loadClientEnv() };
const publishableKey = options.publishableKey || env.publishableKey;
const secretKey = options.secretKey || env.secretKey;
Expand DownExpand Up@@ -226,7 +245,7 @@ export const authenticateAndDecorateRequest = (options: ClerkMiddlewareOptions =
return;
}

const auth = (opts: Parameters<typeof requestState.toAuth>[0]) => requestState.toAuth(opts);
const auth = brandRequestAuth((opts: Parameters<typeof requestState.toAuth>[0]) => requestState.toAuth(opts));

Object.assign(request, { auth });

Expand Down
16 changes: 15 additions & 1 deletion packages/express/src/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,22 @@ import { Readable } from 'stream';

import type { ExpressRequestWithAuth } from './types';

/**
* Brand attached to the `req.auth` handler installed by Clerk middleware.
* `req.auth` is a property name shared with other auth libraries (express-jwt,
* passport, express-openid-connect), so its mere presence proves nothing about
* whether Clerk authenticated the request. `Symbol.for` registers the brand
* globally so it stays stable across multiple copies of this package loaded in
* the same process.
*/
const clerkAuthBrand = Symbol.for('@clerk/express.auth');

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

🧠


export const brandRequestAuth = <T extends (...args: never[]) => unknown>(authHandler: T): T =>
Object.assign(authHandler, { [clerkAuthBrand]: true });

export const requestHasAuthObject = (req: ExpressRequest): req is ExpressRequestWithAuth => {
return 'auth' in req;
const auth = (req as Partial<ExpressRequestWithAuth>).auth;
return typeof auth === 'function' && (auth as unknown as Record<symbol, unknown>)[clerkAuthBrand] === true;
};

export const loadClientEnv = () => {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(express): prevent auth bypass from foreign req.auth values by jacekradko · Pull Request #8804 · clerk/javascript · GitHub
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/spicy-llamas-brush.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/express': patch
---

Fix an authentication bypass where a `req.auth` value set by another library (such as `express-jwt`, Passport, or `express-openid-connect`) caused `clerkMiddleware()` and `requireAuth()` to silently skip Clerk authentication, and `getAuth()` to return the unverified foreign value. Clerk now brands the `req.auth` handler it installs and only trusts that handler: `clerkMiddleware()` authenticates the request and overwrites a foreign `req.auth` (logging a warning when it does), and `getAuth()` throws its "middleware required" error instead of reading foreign data.
89 changes: 89 additions & 0 deletions packages/express/src/__tests__/clerkMiddleware.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,9 +25,17 @@ vi.mock('@clerk/backend', async () => {
};
});

const { mockWarnOnce } = vi.hoisted(() => ({
mockWarnOnce: vi.fn(),
}));
vi.mock('@clerk/shared/logger', () => ({
logger: { warnOnce: mockWarnOnce, logOnce: vi.fn() },
}));

import { authenticateAndDecorateRequest, authenticateRequest } from '../authenticateRequest';
import { clerkMiddleware } from '../clerkMiddleware';
import { getAuth } from '../getAuth';
import { requireAuth } from '../requireAuth';
import { assertNoDebugHeaders, assertSignedOutDebugHeaders, runMiddleware, runMiddlewareOnPath } from './helpers';

describe('clerkMiddleware', () => {
Expand DownExpand Up@@ -331,6 +339,87 @@ describe('clerkMiddleware', () => {
expect(response.header).toHaveProperty('location', expect.stringContaining('/v1/client/handshake?redirect_url='));
});

describe('foreign req.auth values (authentication bypass hardening)', () => {
beforeEach(() => {
mockWarnOnce.mockClear();
});

it('authenticates the request even when a previous middleware set req.auth to a plain object (express-jwt style)', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: { sub: 'attacker' } });
next();
};

const response = await runMiddleware([foreignAuth, clerkMiddleware()], {
Cookie: '__clerk_db_jwt=deadbeef;',
}).expect(200, 'Hello world!');

assertSignedOutDebugHeaders(response);
expect(mockWarnOnce).toHaveBeenCalledTimes(1);
});

it('overwrites a foreign req.auth function so getAuth returns Clerk state', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: () => ({ userId: 'attacker' }) });
next();
};

let capturedUserId: string | null | undefined;
const capture: RequestHandler = (req, _res, next) => {
capturedUserId = getAuth(req).userId;
next();
};

const response = await runMiddleware([foreignAuth, clerkMiddleware(), capture], {
Cookie: '__clerk_db_jwt=deadbeef;',
}).expect(200, 'Hello world!');

assertSignedOutDebugHeaders(response);
expect(capturedUserId).toBeNull();
});

it('does not re-authenticate when clerkMiddleware runs twice', async () => {
const authenticateRequestSpy = vi.fn().mockResolvedValue({
headers: new Headers(),
status: 'signed-out',
toAuth: () => ({ userId: null }),
});
const clerkClient = { authenticateRequest: authenticateRequestSpy } as any;

await runMiddleware([clerkMiddleware({ clerkClient }), clerkMiddleware({ clerkClient })]).expect(
200,
'Hello world!',
);

expect(authenticateRequestSpy).toHaveBeenCalledTimes(1);
expect(mockWarnOnce).not.toHaveBeenCalled();
});

it('requireAuth is not bypassed by a foreign req.auth that reports a userId', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: () => ({ userId: 'attacker' }) });
next();
};

const response = await runMiddleware([foreignAuth, requireAuth({ signInUrl: '/sign-in' })]);

expect(response.status).toBe(302);
expect(response.headers.location).toBe('/sign-in');
});

it('requireAuth redirects (does not 500) when a foreign req.auth is a plain object', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: { sub: 'attacker' } });
next();
};

const response = await runMiddleware([foreignAuth, requireAuth({ signInUrl: '/sign-in' })]);

expect(response.status).toBe(302);
expect(response.headers.location).toBe('/sign-in');
});
});

describe('Frontend API proxy handling', () => {
beforeEach(() => {
mockClerkFrontendApiProxy.mockReset();
Expand Down
11 changes: 11 additions & 0 deletions packages/express/src/__tests__/getAuth.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import type { AuthenticatedMachineObject } from '@clerk/backend/internal';
import type { Request as ExpressRequest } from 'express';
import { describe, expect, it } from 'vitest';

import { getAuth } from '../getAuth';
Expand All@@ -9,6 +10,16 @@ describe('getAuth', () => {
expect(() => getAuth(mockRequest())).toThrow(/The "clerkMiddleware" should be registered before using "getAuth"/);
});

it('throws error if req.auth is a plain object set by another library (express-jwt style)', () => {
const req = { auth: { sub: 'attacker' } } as unknown as ExpressRequest;
expect(() => getAuth(req)).toThrow(/The "clerkMiddleware" should be registered before using "getAuth"/);
});

it('throws error if req.auth is a function set by another library', () => {
const req = { auth: () => ({ userId: 'attacker' }) } as unknown as ExpressRequest;
expect(() => getAuth(req)).toThrow(/The "clerkMiddleware" should be registered before using "getAuth"/);
});

it('returns auth from request for signed-out request', () => {
const req = mockRequestWithAuth({ userId: null, tokenType: 'session_token' });
const auth = getAuth(req);
Expand Down
5 changes: 3 additions & 2 deletions packages/express/src/__tests__/helpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import supertest from 'supertest';
import { expect, vi } from 'vitest';

import type { ExpressRequestWithAuth } from '../types';
import { brandRequestAuth } from '../utils';

// Inspired by https://github.com/helmetjs/helmet/blob/main/test/helpers.ts
export function runMiddleware(middleware: RequestHandler | RequestHandler[], headers: Record<string, string> = {}) {
Expand DownExpand Up@@ -41,13 +42,13 @@ export function mockRequest(): ExpressRequest {

export function mockRequestWithAuth(auth: Partial<AuthObject> = {}): ExpressRequestWithAuth {
return {
auth: () => ({
auth: brandRequestAuth(() => ({
getToken: () => Promise.resolve(''),
has: () => false,
debug: () => ({}),
tokenType: 'session_token',
...auth,
}),
})),
} as unknown as ExpressRequestWithAuth;
}

Expand Down
6 changes: 3 additions & 3 deletions packages/express/src/__tests__/requireAuth.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { beforeEach, describe, expect, it, vi } from 'vitest';

import { clerkMiddleware } from '../clerkMiddleware';
import { requireAuth } from '../requireAuth';
import type { ExpressRequestWithAuth } from '../types';
import { brandRequestAuth, requestHasAuthObject } from '../utils';
import { mockRequestWithAuth, runMiddleware } from './helpers';

let mockAuthenticateAndDecorateRequest: Mock;
Expand DownExpand Up@@ -87,11 +87,11 @@ describe('requireAuth', () => {

mockAuthenticateAndDecorateRequest.mockImplementation((): RequestHandler => {
return (req, _res, next) => {
if ((req as ExpressRequestWithAuth).auth) {
if (requestHasAuthObject(req)) {
return next();
}
const requestState = mockAuthenticateRequest({ request: req });
Object.assign(req, { auth: () => requestState.toAuth() });
Object.assign(req, { auth: brandRequestAuth(() => requestState.toAuth()) });
next();
};
});
Expand Down
27 changes: 23 additions & 4 deletions packages/express/src/authenticateRequest.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,15 +3,23 @@ import type { RequestState } from '@clerk/backend/internal';
import { AuthStatus, createClerkRequest } from '@clerk/backend/internal';
import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, stripTrailingSlashes } from '@clerk/backend/proxy';
import { isDevelopmentFromSecretKey } from '@clerk/shared/keys';
import { logger } from '@clerk/shared/logger';
import { isHttpOrHttps, isProxyUrlRelative, isValidProxyUrl } from '@clerk/shared/proxy';
import { handleValueOrFn } from '@clerk/shared/utils';
import type { RequestHandler, Response } from 'express';
import { Readable } from 'stream';

import { clerkClient as defaultClerkClient } from './clerkClient';
import { satelliteAndMissingProxyUrlAndDomain, satelliteAndMissingSignInUrl } from './errors';
import type { AuthenticateRequestParams, ClerkMiddlewareOptions, ExpressRequestWithAuth } from './types';
import { incomingMessageToRequest, loadApiEnv, loadClientEnv, requestToProxyRequest } from './utils';
import type { AuthenticateRequestParams, ClerkMiddlewareOptions } from './types';
import {
brandRequestAuth,
incomingMessageToRequest,
loadApiEnv,
loadClientEnv,
requestHasAuthObject,
requestToProxyRequest,
} from './utils';

/**
* @internal
Expand DownExpand Up@@ -140,10 +148,21 @@ export const authenticateAndDecorateRequest = (options: ClerkMiddlewareOptions =

// eslint-disable-next-line @typescript-eslint/no-misused-promises
const middleware: RequestHandler = async (request, response, next) => {
if ((request as ExpressRequestWithAuth).auth) {
// Skip authentication only when a Clerk middleware has already processed
// this request. The brand check matters: a truthy `req.auth` is not proof
// of that, since express-jwt, passport and other libraries set the same
// property, and treating their value as ours would silently disable Clerk
// authentication.
if (requestHasAuthObject(request)) {
return next();
}

if ('auth' in request) {
logger.warnOnce(
'Clerk: another middleware has already set `req.auth` on this request. Clerk authentication will run anyway and overwrite it. To use another auth library alongside Clerk, configure it to store its state on a different request property.',
);
}
Comment on lines +160 to +164

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nice 👍🏼


const env = { ...loadApiEnv(), ...loadClientEnv() };
const publishableKey = options.publishableKey || env.publishableKey;
const secretKey = options.secretKey || env.secretKey;
Expand DownExpand Up@@ -226,7 +245,7 @@ export const authenticateAndDecorateRequest = (options: ClerkMiddlewareOptions =
return;
}

const auth = (opts: Parameters<typeof requestState.toAuth>[0]) => requestState.toAuth(opts);
const auth = brandRequestAuth((opts: Parameters<typeof requestState.toAuth>[0]) => requestState.toAuth(opts));

Object.assign(request, { auth });

Expand Down
16 changes: 15 additions & 1 deletion packages/express/src/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,22 @@ import { Readable } from 'stream';

import type { ExpressRequestWithAuth } from './types';

/**
* Brand attached to the `req.auth` handler installed by Clerk middleware.
* `req.auth` is a property name shared with other auth libraries (express-jwt,
* passport, express-openid-connect), so its mere presence proves nothing about
* whether Clerk authenticated the request. `Symbol.for` registers the brand
* globally so it stays stable across multiple copies of this package loaded in
* the same process.
*/
const clerkAuthBrand = Symbol.for('@clerk/express.auth');

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

🧠


export const brandRequestAuth = <T extends (...args: never[]) => unknown>(authHandler: T): T =>
Object.assign(authHandler, { [clerkAuthBrand]: true });

export const requestHasAuthObject = (req: ExpressRequest): req is ExpressRequestWithAuth => {
return 'auth' in req;
const auth = (req as Partial<ExpressRequestWithAuth>).auth;
return typeof auth === 'function' && (auth as unknown as Record<symbol, unknown>)[clerkAuthBrand] === true;
};

export const loadClientEnv = () => {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); fix(express): prevent auth bypass from foreign req.auth values by jacekradko · Pull Request #8804 · clerk/javascript · GitHub
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/spicy-llamas-brush.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/express': patch
---

Fix an authentication bypass where a `req.auth` value set by another library (such as `express-jwt`, Passport, or `express-openid-connect`) caused `clerkMiddleware()` and `requireAuth()` to silently skip Clerk authentication, and `getAuth()` to return the unverified foreign value. Clerk now brands the `req.auth` handler it installs and only trusts that handler: `clerkMiddleware()` authenticates the request and overwrites a foreign `req.auth` (logging a warning when it does), and `getAuth()` throws its "middleware required" error instead of reading foreign data.
89 changes: 89 additions & 0 deletions packages/express/src/__tests__/clerkMiddleware.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,9 +25,17 @@ vi.mock('@clerk/backend', async () => {
};
});

const { mockWarnOnce } = vi.hoisted(() => ({
mockWarnOnce: vi.fn(),
}));
vi.mock('@clerk/shared/logger', () => ({
logger: { warnOnce: mockWarnOnce, logOnce: vi.fn() },
}));

import { authenticateAndDecorateRequest, authenticateRequest } from '../authenticateRequest';
import { clerkMiddleware } from '../clerkMiddleware';
import { getAuth } from '../getAuth';
import { requireAuth } from '../requireAuth';
import { assertNoDebugHeaders, assertSignedOutDebugHeaders, runMiddleware, runMiddlewareOnPath } from './helpers';

describe('clerkMiddleware', () => {
Expand DownExpand Up@@ -331,6 +339,87 @@ describe('clerkMiddleware', () => {
expect(response.header).toHaveProperty('location', expect.stringContaining('/v1/client/handshake?redirect_url='));
});

describe('foreign req.auth values (authentication bypass hardening)', () => {
beforeEach(() => {
mockWarnOnce.mockClear();
});

it('authenticates the request even when a previous middleware set req.auth to a plain object (express-jwt style)', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: { sub: 'attacker' } });
next();
};

const response = await runMiddleware([foreignAuth, clerkMiddleware()], {
Cookie: '__clerk_db_jwt=deadbeef;',
}).expect(200, 'Hello world!');

assertSignedOutDebugHeaders(response);
expect(mockWarnOnce).toHaveBeenCalledTimes(1);
});

it('overwrites a foreign req.auth function so getAuth returns Clerk state', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: () => ({ userId: 'attacker' }) });
next();
};

let capturedUserId: string | null | undefined;
const capture: RequestHandler = (req, _res, next) => {
capturedUserId = getAuth(req).userId;
next();
};

const response = await runMiddleware([foreignAuth, clerkMiddleware(), capture], {
Cookie: '__clerk_db_jwt=deadbeef;',
}).expect(200, 'Hello world!');

assertSignedOutDebugHeaders(response);
expect(capturedUserId).toBeNull();
});

it('does not re-authenticate when clerkMiddleware runs twice', async () => {
const authenticateRequestSpy = vi.fn().mockResolvedValue({
headers: new Headers(),
status: 'signed-out',
toAuth: () => ({ userId: null }),
});
const clerkClient = { authenticateRequest: authenticateRequestSpy } as any;

await runMiddleware([clerkMiddleware({ clerkClient }), clerkMiddleware({ clerkClient })]).expect(
200,
'Hello world!',
);

expect(authenticateRequestSpy).toHaveBeenCalledTimes(1);
expect(mockWarnOnce).not.toHaveBeenCalled();
});

it('requireAuth is not bypassed by a foreign req.auth that reports a userId', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: () => ({ userId: 'attacker' }) });
next();
};

const response = await runMiddleware([foreignAuth, requireAuth({ signInUrl: '/sign-in' })]);

expect(response.status).toBe(302);
expect(response.headers.location).toBe('/sign-in');
});

it('requireAuth redirects (does not 500) when a foreign req.auth is a plain object', async () => {
const foreignAuth: RequestHandler = (req, _res, next) => {
Object.assign(req, { auth: { sub: 'attacker' } });
next();
};

const response = await runMiddleware([foreignAuth, requireAuth({ signInUrl: '/sign-in' })]);

expect(response.status).toBe(302);
expect(response.headers.location).toBe('/sign-in');
});
});

describe('Frontend API proxy handling', () => {
beforeEach(() => {
mockClerkFrontendApiProxy.mockReset();
Expand Down
11 changes: 11 additions & 0 deletions packages/express/src/__tests__/getAuth.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import type { AuthenticatedMachineObject } from '@clerk/backend/internal';
import type { Request as ExpressRequest } from 'express';
import { describe, expect, it } from 'vitest';

import { getAuth } from '../getAuth';
Expand All@@ -9,6 +10,16 @@ describe('getAuth', () => {
expect(() => getAuth(mockRequest())).toThrow(/The "clerkMiddleware" should be registered before using "getAuth"/);
});

it('throws error if req.auth is a plain object set by another library (express-jwt style)', () => {
const req = { auth: { sub: 'attacker' } } as unknown as ExpressRequest;
expect(() => getAuth(req)).toThrow(/The "clerkMiddleware" should be registered before using "getAuth"/);
});

it('throws error if req.auth is a function set by another library', () => {
const req = { auth: () => ({ userId: 'attacker' }) } as unknown as ExpressRequest;
expect(() => getAuth(req)).toThrow(/The "clerkMiddleware" should be registered before using "getAuth"/);
});

it('returns auth from request for signed-out request', () => {
const req = mockRequestWithAuth({ userId: null, tokenType: 'session_token' });
const auth = getAuth(req);
Expand Down
5 changes: 3 additions & 2 deletions packages/express/src/__tests__/helpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@ import supertest from 'supertest';
import { expect, vi } from 'vitest';

import type { ExpressRequestWithAuth } from '../types';
import { brandRequestAuth } from '../utils';

// Inspired by https://github.com/helmetjs/helmet/blob/main/test/helpers.ts
export function runMiddleware(middleware: RequestHandler | RequestHandler[], headers: Record<string, string> = {}) {
Expand DownExpand Up@@ -41,13 +42,13 @@ export function mockRequest(): ExpressRequest {

export function mockRequestWithAuth(auth: Partial<AuthObject> = {}): ExpressRequestWithAuth {
return {
auth: () => ({
auth: brandRequestAuth(() => ({
getToken: () => Promise.resolve(''),
has: () => false,
debug: () => ({}),
tokenType: 'session_token',
...auth,
}),
})),
} as unknown as ExpressRequestWithAuth;
}

Expand Down
6 changes: 3 additions & 3 deletions packages/express/src/__tests__/requireAuth.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import { beforeEach, describe, expect, it, vi } from 'vitest';

import { clerkMiddleware } from '../clerkMiddleware';
import { requireAuth } from '../requireAuth';
import type { ExpressRequestWithAuth } from '../types';
import { brandRequestAuth, requestHasAuthObject } from '../utils';
import { mockRequestWithAuth, runMiddleware } from './helpers';

let mockAuthenticateAndDecorateRequest: Mock;
Expand DownExpand Up@@ -87,11 +87,11 @@ describe('requireAuth', () => {

mockAuthenticateAndDecorateRequest.mockImplementation((): RequestHandler => {
return (req, _res, next) => {
if ((req as ExpressRequestWithAuth).auth) {
if (requestHasAuthObject(req)) {
return next();
}
const requestState = mockAuthenticateRequest({ request: req });
Object.assign(req, { auth: () => requestState.toAuth() });
Object.assign(req, { auth: brandRequestAuth(() => requestState.toAuth()) });
next();
};
});
Expand Down
27 changes: 23 additions & 4 deletions packages/express/src/authenticateRequest.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,15 +3,23 @@ import type { RequestState } from '@clerk/backend/internal';
import { AuthStatus, createClerkRequest } from '@clerk/backend/internal';
import { clerkFrontendApiProxy, DEFAULT_PROXY_PATH, stripTrailingSlashes } from '@clerk/backend/proxy';
import { isDevelopmentFromSecretKey } from '@clerk/shared/keys';
import { logger } from '@clerk/shared/logger';
import { isHttpOrHttps, isProxyUrlRelative, isValidProxyUrl } from '@clerk/shared/proxy';
import { handleValueOrFn } from '@clerk/shared/utils';
import type { RequestHandler, Response } from 'express';
import { Readable } from 'stream';

import { clerkClient as defaultClerkClient } from './clerkClient';
import { satelliteAndMissingProxyUrlAndDomain, satelliteAndMissingSignInUrl } from './errors';
import type { AuthenticateRequestParams, ClerkMiddlewareOptions, ExpressRequestWithAuth } from './types';
import { incomingMessageToRequest, loadApiEnv, loadClientEnv, requestToProxyRequest } from './utils';
import type { AuthenticateRequestParams, ClerkMiddlewareOptions } from './types';
import {
brandRequestAuth,
incomingMessageToRequest,
loadApiEnv,
loadClientEnv,
requestHasAuthObject,
requestToProxyRequest,
} from './utils';

/**
* @internal
Expand DownExpand Up@@ -140,10 +148,21 @@ export const authenticateAndDecorateRequest = (options: ClerkMiddlewareOptions =

// eslint-disable-next-line @typescript-eslint/no-misused-promises
const middleware: RequestHandler = async (request, response, next) => {
if ((request as ExpressRequestWithAuth).auth) {
// Skip authentication only when a Clerk middleware has already processed
// this request. The brand check matters: a truthy `req.auth` is not proof
// of that, since express-jwt, passport and other libraries set the same
// property, and treating their value as ours would silently disable Clerk
// authentication.
if (requestHasAuthObject(request)) {
return next();
}

if ('auth' in request) {
logger.warnOnce(
'Clerk: another middleware has already set `req.auth` on this request. Clerk authentication will run anyway and overwrite it. To use another auth library alongside Clerk, configure it to store its state on a different request property.',
);
}
Comment on lines +160 to +164

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nice 👍🏼


const env = { ...loadApiEnv(), ...loadClientEnv() };
const publishableKey = options.publishableKey || env.publishableKey;
const secretKey = options.secretKey || env.secretKey;
Expand DownExpand Up@@ -226,7 +245,7 @@ export const authenticateAndDecorateRequest = (options: ClerkMiddlewareOptions =
return;
}

const auth = (opts: Parameters<typeof requestState.toAuth>[0]) => requestState.toAuth(opts);
const auth = brandRequestAuth((opts: Parameters<typeof requestState.toAuth>[0]) => requestState.toAuth(opts));

Object.assign(request, { auth });

Expand Down
16 changes: 15 additions & 1 deletion packages/express/src/utils.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,22 @@ import { Readable } from 'stream';

import type { ExpressRequestWithAuth } from './types';

/**
* Brand attached to the `req.auth` handler installed by Clerk middleware.
* `req.auth` is a property name shared with other auth libraries (express-jwt,
* passport, express-openid-connect), so its mere presence proves nothing about
* whether Clerk authenticated the request. `Symbol.for` registers the brand
* globally so it stays stable across multiple copies of this package loaded in
* the same process.
*/
const clerkAuthBrand = Symbol.for('@clerk/express.auth');

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

🧠


export const brandRequestAuth = <T extends (...args: never[]) => unknown>(authHandler: T): T =>
Object.assign(authHandler, { [clerkAuthBrand]: true });

export const requestHasAuthObject = (req: ExpressRequest): req is ExpressRequestWithAuth => {
return 'auth' in req;
const auth = (req as Partial<ExpressRequestWithAuth>).auth;
return typeof auth === 'function' && (auth as unknown as Record<symbol, unknown>)[clerkAuthBrand] === true;
};

export const loadClientEnv = () => {
Expand Down
Loading