chore(repo): Backport support for JWTs in OAuth token type (#7308)#7394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wobsoriano merged 6 commits into from
Dec 8, 2025
Merged

chore(repo): Backport support for JWTs in OAuth token type (#7308) #7394

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9b02389
feat(backend): Add support for JWTs in OAuth token type (#7308)
wobsoriano Dec 5, 2025
b471ec1
chore: update changeset
wobsoriano Dec 8, 2025
6187459
Merge branch 'vincent-and-the-doctor' into rob/backport-user-4076
wobsoriano Dec 8, 2025
38e8033
Delete .changeset/swift-sheep-notice.md
wobsoriano Dec 8, 2025
05c3adb
Merge branch 'vincent-and-the-doctor' into rob/backport-user-4076
wobsoriano Dec 8, 2025
0990c46
chore: fix missing import
wobsoriano Dec 8, 2025
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
32 changes: 32 additions & 0 deletions packages/backend/src/api/resources/IdPOAuthAccessToken.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
import type { JwtPayload } from '@clerk/shared/types';

import type { IdPOAuthAccessTokenJSON } from './JSON';

type OAuthJwtPayload = JwtPayload & {
jti?: string;
client_id?: string;
scope?: string;
scp?: string[];
};

export class IdPOAuthAccessToken {
constructor(
readonly id: string,
Expand DownExpand Up@@ -30,4 +39,27 @@ export class IdPOAuthAccessToken {
data.updated_at,
);
}

/**
* Creates an IdPOAuthAccessToken from a JWT payload.
* Maps standard JWT claims and OAuth-specific fields to token properties.
*/
static fromJwtPayload(payload: JwtPayload, clockSkewInMs = 5000): IdPOAuthAccessToken {
const oauthPayload = payload as OAuthJwtPayload;

// Map JWT claims to IdPOAuthAccessToken fields
return new IdPOAuthAccessToken(
oauthPayload.jti ?? '',
oauthPayload.client_id ?? '',
'oauth_token',
payload.sub,
oauthPayload.scp ?? oauthPayload.scope?.split(' ') ?? [],
false,
null,
payload.exp * 1000 <= Date.now() - clockSkewInMs,
payload.exp,
payload.iat,
payload.iat,
);
}
}
19 changes: 16 additions & 3 deletions packages/backend/src/errors.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export const MachineTokenVerificationErrorCode = {
TokenInvalid: 'token-invalid',
InvalidSecretKey: 'secret-key-invalid',
UnexpectedError: 'unexpected-error',
TokenVerificationFailed: 'token-verification-failed',
} as const;

export type MachineTokenVerificationErrorCode =
Expand All@@ -82,17 +83,29 @@ export type MachineTokenVerificationErrorCode =
export class MachineTokenVerificationError extends Error {
code: MachineTokenVerificationErrorCode;
long_message?: string;
status: number;
status?: number;
action?: TokenVerificationErrorAction;

constructor({ message, code, status }: { message: string; code: MachineTokenVerificationErrorCode; status: number }) {
constructor({
message,
code,
status,
action,
}: {
message: string;
code: MachineTokenVerificationErrorCode;
status?: number;
action?: TokenVerificationErrorAction;
}) {
super(message);
Object.setPrototypeOf(this, MachineTokenVerificationError.prototype);

this.code = code;
this.status = status;
this.action = action;
}

public getFullMessage() {
return `${this.message} (code=${this.code}, status=${this.status})`;
return `${this.message} (code=${this.code}, status=${this.status || 'n/a'})`;
}
}
12 changes: 12 additions & 0 deletions packages/backend/src/fixtures/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,18 @@ export const mockJwtPayload = {
sub: 'user_2GIpXOEpVyJw51rkZn9Kmnc6Sxr',
};

export const mockOAuthAccessTokenJwtPayload = {
...mockJwtPayload,
iss: 'https://clerk.oauth.example.test',
sub: 'user_2vYVtestTESTtestTESTtestTESTtest',
client_id: 'client_2VTWUzvGC5UhdJCNx6xG1D98edc',
scope: 'read:foo write:bar',
jti: 'oat_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE',
exp: mockJwtPayload.iat + 300,
iat: mockJwtPayload.iat,
nbf: mockJwtPayload.iat - 10,
};

export const mockRsaJwkKid = 'ins_2GIoQhbUpy0hX7B2cVkuTMinXoD';

export const mockRsaJwk = {
Expand Down
14 changes: 14 additions & 0 deletions packages/backend/src/fixtures/machine.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -65,3 +65,17 @@ export const mockMachineAuthResponses = {
errorMessage: 'Machine token not found',
},
} as const;

// Valid OAuth access token JWT with typ: "at+jwt"
// Header: {"alg":"RS256","kid":"ins_2GIoQhbUpy0hX7B2cVkuTMinXoD","typ":"at+jwt"}
// Payload: {"client_id":"client_2VTWUzvGC5UhdJCNx6xG1D98edc","sub":"user_2vYVtestTESTtestTESTtestTESTtest","jti":"oat_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE","iat":1666648250,"exp":1666648550,"scope":"read:foo write:bar"}
// Signed with signingJwks, verifiable with mockJwks
export const mockSignedOAuthAccessTokenJwt =
'eyJhbGciOiJSUzI1NiIsImtpZCI6Imluc18yR0lvUWhiVXB5MGhYN0IyY1ZrdVRNaW5Yb0QiLCJ0eXAiOiJhdCtqd3QifQ.eyJhenAiOiJodHRwczovL2FjY291bnRzLmluc3BpcmVkLnB1bWEtNzQubGNsLmRldiIsImV4cCI6MTY2NjY0ODU1MCwiaWF0IjoxNjY2NjQ4MjUwLCJpc3MiOiJodHRwczovL2NsZXJrLm9hdXRoLmV4YW1wbGUudGVzdCIsIm5iZiI6MTY2NjY0ODI0MCwic2lkIjoic2Vzc18yR2JEQjRlbk5kQ2E1dlMxenBDM1h6Zzl0SzkiLCJzdWIiOiJ1c2VyXzJ2WVZ0ZXN0VEVTVHRlc3RURVNUdGVzdFRFU1R0ZXN0IiwiY2xpZW50X2lkIjoiY2xpZW50XzJWVFdVenZHQzVVaGRKQ054NnhHMUQ5OGVkYyIsInNjb3BlIjoicmVhZDpmb28gd3JpdGU6YmFyIiwianRpIjoib2F0XzJ4S2E5Qmd2N054TVJERnlRdzhMcFozY1RtVTF2SGpFIn0.Wgw5L2u0nGkxF9Y-5Dje414UEkxq2Fu3_VePeh1-GehCugi0eIXV-QyiXp1ba4pxWWbCfIC_hihzKjwnVb5wrhzqyw8FJpvnvtrHEjt-zSijpS7WlO7ScJDY-PE8zgH-CICnS2CKYSkP3Rbzka9XY_Z6ieUzmBSFdA_0K8pQOdDHv70y04dnL1CjL6XToncnvezioL388Y1UTqlhll8b2Pm4EI7rGdHVKzLcKnKoYpgsBPZLmO7qGPJ5BkHvmg3gOSkmIiziFaEZkoXvjbvEUAt5qEqzaADSaFP6QhRYNtr1s4OD9uj0SK6QaoZTj69XYFuNMNnm7zN_WxvPBMTq9g';

// Valid OAuth access token JWT with typ: "application/at+jwt"
// Header: {"alg":"RS256","kid":"ins_2GIoQhbUpy0hX7B2cVkuTMinXoD","typ":"application/at+jwt"}
// Payload: {"client_id":"client_2VTWUzvGC5UhdJCNx6xG1D98edc","sub":"user_2vYVtestTESTtestTESTtestTESTtest","jti":"oat_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE","iat":1666648250,"exp":1666648550,"scope":"read:foo write:bar"}
// Signed with signingJwks, verifiable with mockJwks
export const mockSignedOAuthAccessTokenJwtApplicationTyp =
'eyJhbGciOiJSUzI1NiIsImtpZCI6Imluc18yR0lvUWhiVXB5MGhYN0IyY1ZrdVRNaW5Yb0QiLCJ0eXAiOiJhcHBsaWNhdGlvbi9hdCtqd3QifQ.eyJhenAiOiJodHRwczovL2FjY291bnRzLmluc3BpcmVkLnB1bWEtNzQubGNsLmRldiIsImV4cCI6MTY2NjY0ODU1MCwiaWF0IjoxNjY2NjQ4MjUwLCJpc3MiOiJodHRwczovL2NsZXJrLm9hdXRoLmV4YW1wbGUudGVzdCIsIm5iZiI6MTY2NjY0ODI0MCwic2lkIjoic2Vzc18yR2JEQjRlbk5kQ2E1dlMxenBDM1h6Zzl0SzkiLCJzdWIiOiJ1c2VyXzJ2WVZ0ZXN0VEVTVHRlc3RURVNUdGVzdFRFU1R0ZXN0IiwiY2xpZW50X2lkIjoiY2xpZW50XzJWVFdVenZHQzVVaGRKQ054NnhHMUQ5OGVkYyIsInNjb3BlIjoicmVhZDpmb28gd3JpdGU6YmFyIiwianRpIjoib2F0XzJ4S2E5Qmd2N054TVJERnlRdzhMcFozY1RtVTF2SGpFIn0.GPTvB4doScjzQD0kRMhMebVDREjwcrMWK73OP_kFc3pl0gST29BlWrKMBi8wRxoSJBc2ukO10BPhGxnh15PxCNLyk6xQFWhFBA7XpVxY4T_VHPDU5FEOocPQuqcqZ4cA1GDJST-BH511fxoJnv4kfha46IvQiUMvWCacIj_w12qfZigeb208mTDIeoJQtlYb-sD9u__CVvB4uZOqGb0lIL5-cCbhMPFg-6GQ2DhZ-Eq5tw7oyO6lPrsAaFN9u-59SLvips364ieYNpgcr9Dbo5PDvUSltqxoIXTDFo4esWw6XwUjnGfqCh34LYAhv_2QF2U0-GASBEn4GK-Wfv3wXg';
36 changes: 34 additions & 2 deletions packages/backend/src/jwt/__tests__/assertions.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -106,15 +106,47 @@ describe('assertAudienceClaim(audience?, aud?)', () => {
});
});

describe('assertHeaderType(typ?)', () => {
describe('assertHeaderType(typ?, allowedTypes?)', () => {
it('does not throw error if type is missing', () => {
expect(() => assertHeaderType(undefined)).not.toThrow();
expect(() => assertHeaderType(undefined, 'JWT')).not.toThrow();
expect(() => assertHeaderType(undefined, ['JWT', 'at+jwt'])).not.toThrow();
});

it('throws error if type is not JWT', () => {
it('does not throw error if type matches default allowed type (JWT)', () => {
expect(() => assertHeaderType('JWT')).not.toThrow();
});

it('throws error if type is not JWT (default)', () => {
expect(() => assertHeaderType('')).toThrow(`Invalid JWT type "". Expected "JWT".`);
expect(() => assertHeaderType('Aloha')).toThrow(`Invalid JWT type "Aloha". Expected "JWT".`);
});

it('does not throw error if type matches single custom allowed type', () => {
expect(() => assertHeaderType('at+jwt', 'at+jwt')).not.toThrow();
expect(() => assertHeaderType('application/at+jwt', 'application/at+jwt')).not.toThrow();
});

it('throws error if type does not match single custom allowed type', () => {
expect(() => assertHeaderType('JWT', 'at+jwt')).toThrow(`Invalid JWT type "JWT". Expected "at+jwt".`);
expect(() => assertHeaderType('at+jwt', 'JWT')).toThrow(`Invalid JWT type "at+jwt". Expected "JWT".`);
});

it('does not throw error if type matches array of allowed types', () => {
expect(() => assertHeaderType('JWT', ['JWT', 'at+jwt'])).not.toThrow();
expect(() => assertHeaderType('at+jwt', ['JWT', 'at+jwt'])).not.toThrow();
expect(() => assertHeaderType('at+jwt', ['at+jwt', 'application/at+jwt'])).not.toThrow();
expect(() => assertHeaderType('application/at+jwt', ['at+jwt', 'application/at+jwt'])).not.toThrow();
});

it('throws error if type does not match any in array of allowed types', () => {
expect(() => assertHeaderType('JWT', ['at+jwt', 'application/at+jwt'])).toThrow(
`Invalid JWT type "JWT". Expected "at+jwt, application/at+jwt".`,
);
expect(() => assertHeaderType('invalid', ['at+jwt', 'application/at+jwt'])).toThrow(
`Invalid JWT type "invalid". Expected "at+jwt, application/at+jwt".`,
);
});
});

describe('assertHeaderAlgorithm(alg)', () => {
Expand Down
88 changes: 88 additions & 0 deletions packages/backend/src/jwt/__tests__/verifyJwt.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import {
createJwt,
mockJwks,
mockJwt,
mockJwtHeader,
mockJwtPayload,
mockOAuthAccessTokenJwtPayload,
pemEncodedPublicKey,
publicJwks,
signedJwt,
someOtherPublicKey,
} from '../../fixtures';
import { mockSignedOAuthAccessTokenJwt, mockSignedOAuthAccessTokenJwtApplicationTyp } from '../../fixtures/machine';
import { decodeJwt, hasValidSignature, verifyJwt } from '../verifyJwt';

const invalidTokenError = {
Expand DownExpand Up@@ -129,4 +132,89 @@ describe('verifyJwt(jwt, options)', () => {
const { errors: [error] = [] } = await verifyJwt('invalid-jwt', inputVerifyJwtOptions);
expect(error).toMatchObject(invalidTokenError);
});

it('verifies JWT with default headerType (JWT)', async () => {
const inputVerifyJwtOptions = {
key: mockJwks.keys[0],
issuer: mockJwtPayload.iss,
authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
};
const { data } = await verifyJwt(mockJwt, inputVerifyJwtOptions);
expect(data).toEqual(mockJwtPayload);
});

it('verifies JWT with explicit headerType as string', async () => {
const inputVerifyJwtOptions = {
key: mockJwks.keys[0],
issuer: mockJwtPayload.iss,
authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
headerType: 'JWT',
};
const { data } = await verifyJwt(mockJwt, inputVerifyJwtOptions);
expect(data).toEqual(mockJwtPayload);
});

it('verifies OAuth JWT with headerType as array including at+jwt', async () => {
const inputVerifyJwtOptions = {
key: mockJwks.keys[0],
authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
headerType: ['at+jwt', 'application/at+jwt'],
};
const { data } = await verifyJwt(mockSignedOAuthAccessTokenJwt, inputVerifyJwtOptions);
expect(data).toBeDefined();
expect(data?.sub).toBe('user_2vYVtestTESTtestTESTtestTESTtest');
});

it('verifies OAuth JWT with headerType as array including application/at+jwt', async () => {
const inputVerifyJwtOptions = {
key: mockJwks.keys[0],
authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
headerType: ['at+jwt', 'application/at+jwt'],
};
const { data } = await verifyJwt(mockSignedOAuthAccessTokenJwtApplicationTyp, inputVerifyJwtOptions);
expect(data).toBeDefined();
expect(data?.sub).toBe('user_2vYVtestTESTtestTESTtestTESTtest');
});

it('rejects JWT when headerType does not match', async () => {
const inputVerifyJwtOptions = {
key: mockJwks.keys[0],
issuer: mockJwtPayload.iss,
authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
headerType: 'at+jwt',
};
const { errors: [error] = [] } = await verifyJwt(mockJwt, inputVerifyJwtOptions);
expect(error).toBeDefined();
expect(error?.message).toContain('Invalid JWT type');
expect(error?.message).toContain('Expected "at+jwt"');
});

it('rejects OAuth JWT when headerType does not match', async () => {
const inputVerifyJwtOptions = {
key: mockJwks.keys[0],
authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
headerType: 'JWT',
};
const { errors: [error] = [] } = await verifyJwt(mockSignedOAuthAccessTokenJwt, inputVerifyJwtOptions);
expect(error).toBeDefined();
expect(error?.message).toContain('Invalid JWT type');
expect(error?.message).toContain('Expected "JWT"');
});

it('rejects JWT when headerType array does not include the token type', async () => {
const jwtWithCustomTyp = createJwt({
header: { typ: 'custom-type', kid: 'ins_2GIoQhbUpy0hX7B2cVkuTMinXoD' },
payload: mockOAuthAccessTokenJwtPayload,
});

const inputVerifyJwtOptions = {
key: mockJwks.keys[0],
authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
headerType: ['at+jwt', 'application/at+jwt'],
};
const { errors: [error] = [] } = await verifyJwt(jwtWithCustomTyp, inputVerifyJwtOptions);
expect(error).toBeDefined();
expect(error?.message).toContain('Invalid JWT type');
expect(error?.message).toContain('Expected "at+jwt, application/at+jwt"');
});
});
7 changes: 4 additions & 3 deletions packages/backend/src/jwt/assertions.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,16 +47,17 @@ export const assertAudienceClaim = (aud?: unknown, audience?: unknown) => {
}
};

export const assertHeaderType = (typ?: unknown) => {
export const assertHeaderType = (typ?: unknown, allowedTypes: string | string[] = 'JWT') => {
if (typeof typ === 'undefined') {
return;
}

if (typ !== 'JWT') {
const allowed = Array.isArray(allowedTypes) ? allowedTypes : [allowedTypes];
if (!allowed.includes(typ as string)) {
throw new TokenVerificationError({
action: TokenVerificationErrorAction.EnsureClerkJWT,
reason: TokenVerificationErrorReason.TokenInvalid,
message: `Invalid JWT type ${JSON.stringify(typ)}. Expected "JWT".`,
message: `Invalid JWT type ${JSON.stringify(typ)}. Expected "${allowed.join(', ')}".`,
});
}
};
Expand Down
9 changes: 7 additions & 2 deletions packages/backend/src/jwt/verifyJwt.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -119,13 +119,18 @@ export type VerifyJwtOptions = {
* @internal
*/
key: JsonWebKey | string;
/**
* A string or list of allowed [header types](https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.9).
* @default 'JWT'
*/
headerType?: string | string[];
};

export async function verifyJwt(
token: string,
options: VerifyJwtOptions,
): Promise<JwtReturnType<JwtPayload, TokenVerificationError>> {
const { audience, authorizedParties, clockSkewInMs, key } = options;
const { audience, authorizedParties, clockSkewInMs, key, headerType } = options;
const clockSkew = clockSkewInMs || DEFAULT_CLOCK_SKEW_IN_MS;

const { data: decoded, errors } = decodeJwt(token);
Expand All@@ -138,7 +143,7 @@ export async function verifyJwt(
// Header verifications
const { typ, alg } = header;

assertHeaderType(typ);
assertHeaderType(typ, headerType);
assertHeaderAlgorithm(alg);

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

Skip to content
chore(repo): Backport support for JWTs in OAuth token type (#7308)#7394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wobsoriano
merged 6 commits into

from

Dec 8, 2025
 Merged


chore(repo): Backport support for JWTs in OAuth token type (#7308)
#7394
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
9b02389

feat(backend): Add support for JWTs in OAuth token type (#7308)


wobsoriano Dec 5, 2025
b471ec1

chore: update changeset


wobsoriano Dec 8, 2025
6187459

Merge branch 'vincent-and-the-doctor' into rob/backport-user-4076


wobsoriano Dec 8, 2025
38e8033

Delete .changeset/swift-sheep-notice.md


wobsoriano Dec 8, 2025
05c3adb

Merge branch 'vincent-and-the-doctor' into rob/backport-user-4076


wobsoriano Dec 8, 2025
0990c46

chore: fix missing import


wobsoriano Dec 8, 2025

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


32 changes: 32 additions & 0 deletions
packages/backend/src/api/resources/IdPOAuthAccessToken.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
import type { JwtPayload } from '@clerk/shared/types';

import type { IdPOAuthAccessTokenJSON } from './JSON';

type OAuthJwtPayload = JwtPayload & {
 jti?: string;
 client_id?: string;
 scope?: string;
 scp?: string[];
};

export class IdPOAuthAccessToken {
 constructor(
 readonly id: string,
Expand DownExpand Up@@ -30,4 +39,27 @@ export class IdPOAuthAccessToken {
 data.updated_at,
 );
 }

 /**
 * Creates an IdPOAuthAccessToken from a JWT payload.
 * Maps standard JWT claims and OAuth-specific fields to token properties.
 */
 static fromJwtPayload(payload: JwtPayload, clockSkewInMs = 5000): IdPOAuthAccessToken {
 const oauthPayload = payload as OAuthJwtPayload;

 // Map JWT claims to IdPOAuthAccessToken fields
 return new IdPOAuthAccessToken(
 oauthPayload.jti ?? '',
 oauthPayload.client_id ?? '',
 'oauth_token',
 payload.sub,
 oauthPayload.scp ?? oauthPayload.scope?.split(' ') ?? [],
 false,
 null,
 payload.exp * 1000 <= Date.now() - clockSkewInMs,
 payload.exp,
 payload.iat,
 payload.iat,
 );
 }
}

19 changes: 16 additions & 3 deletions
packages/backend/src/errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export const MachineTokenVerificationErrorCode = {
 TokenInvalid: 'token-invalid',
 InvalidSecretKey: 'secret-key-invalid',
 UnexpectedError: 'unexpected-error',
 TokenVerificationFailed: 'token-verification-failed',
} as const;

export type MachineTokenVerificationErrorCode =
Expand All@@ -82,17 +83,29 @@ export type MachineTokenVerificationErrorCode =
export class MachineTokenVerificationError extends Error {
 code: MachineTokenVerificationErrorCode;
 long_message?: string;
 status: number;
 status?: number;
 action?: TokenVerificationErrorAction;

 constructor({ message, code, status }: { message: string; code: MachineTokenVerificationErrorCode; status: number }) {
 constructor({
 message,
 code,
 status,
 action,
 }: {
 message: string;
 code: MachineTokenVerificationErrorCode;
 status?: number;
 action?: TokenVerificationErrorAction;
 }) {
 super(message);
 Object.setPrototypeOf(this, MachineTokenVerificationError.prototype);

 this.code = code;
 this.status = status;
 this.action = action;
 }

 public getFullMessage() {
 return `${this.message} (code=${this.code}, status=${this.status})`;
 return `${this.message} (code=${this.code}, status=${this.status || 'n/a'})`;
 }
}

12 changes: 12 additions & 0 deletions
packages/backend/src/fixtures/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,18 @@ export const mockJwtPayload = {
 sub: 'user_2GIpXOEpVyJw51rkZn9Kmnc6Sxr',
};

export const mockOAuthAccessTokenJwtPayload = {
 ...mockJwtPayload,
 iss: 'https://clerk.oauth.example.test',
 sub: 'user_2vYVtestTESTtestTESTtestTESTtest',
 client_id: 'client_2VTWUzvGC5UhdJCNx6xG1D98edc',
 scope: 'read:foo write:bar',
 jti: 'oat_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE',
 exp: mockJwtPayload.iat + 300,
 iat: mockJwtPayload.iat,
 nbf: mockJwtPayload.iat - 10,
};

export const mockRsaJwkKid = 'ins_2GIoQhbUpy0hX7B2cVkuTMinXoD';

export const mockRsaJwk = {
Expand Down

14 changes: 14 additions & 0 deletions
packages/backend/src/fixtures/machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,3 +65,17 @@ export const mockMachineAuthResponses = {
 errorMessage: 'Machine token not found',
 },
} as const;

// Valid OAuth access token JWT with typ: "at+jwt"
// Header: {"alg":"RS256","kid":"ins_2GIoQhbUpy0hX7B2cVkuTMinXoD","typ":"at+jwt"}
// Payload: {"client_id":"client_2VTWUzvGC5UhdJCNx6xG1D98edc","sub":"user_2vYVtestTESTtestTESTtestTESTtest","jti":"oat_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE","iat":1666648250,"exp":1666648550,"scope":"read:foo write:bar"}
// Signed with signingJwks, verifiable with mockJwks
export const mockSignedOAuthAccessTokenJwt =
 'eyJhbGciOiJSUzI1NiIsImtpZCI6Imluc18yR0lvUWhiVXB5MGhYN0IyY1ZrdVRNaW5Yb0QiLCJ0eXAiOiJhdCtqd3QifQ.eyJhenAiOiJodHRwczovL2FjY291bnRzLmluc3BpcmVkLnB1bWEtNzQubGNsLmRldiIsImV4cCI6MTY2NjY0ODU1MCwiaWF0IjoxNjY2NjQ4MjUwLCJpc3MiOiJodHRwczovL2NsZXJrLm9hdXRoLmV4YW1wbGUudGVzdCIsIm5iZiI6MTY2NjY0ODI0MCwic2lkIjoic2Vzc18yR2JEQjRlbk5kQ2E1dlMxenBDM1h6Zzl0SzkiLCJzdWIiOiJ1c2VyXzJ2WVZ0ZXN0VEVTVHRlc3RURVNUdGVzdFRFU1R0ZXN0IiwiY2xpZW50X2lkIjoiY2xpZW50XzJWVFdVenZHQzVVaGRKQ054NnhHMUQ5OGVkYyIsInNjb3BlIjoicmVhZDpmb28gd3JpdGU6YmFyIiwianRpIjoib2F0XzJ4S2E5Qmd2N054TVJERnlRdzhMcFozY1RtVTF2SGpFIn0.Wgw5L2u0nGkxF9Y-5Dje414UEkxq2Fu3_VePeh1-GehCugi0eIXV-QyiXp1ba4pxWWbCfIC_hihzKjwnVb5wrhzqyw8FJpvnvtrHEjt-zSijpS7WlO7ScJDY-PE8zgH-CICnS2CKYSkP3Rbzka9XY_Z6ieUzmBSFdA_0K8pQOdDHv70y04dnL1CjL6XToncnvezioL388Y1UTqlhll8b2Pm4EI7rGdHVKzLcKnKoYpgsBPZLmO7qGPJ5BkHvmg3gOSkmIiziFaEZkoXvjbvEUAt5qEqzaADSaFP6QhRYNtr1s4OD9uj0SK6QaoZTj69XYFuNMNnm7zN_WxvPBMTq9g';

// Valid OAuth access token JWT with typ: "application/at+jwt"
// Header: {"alg":"RS256","kid":"ins_2GIoQhbUpy0hX7B2cVkuTMinXoD","typ":"application/at+jwt"}
// Payload: {"client_id":"client_2VTWUzvGC5UhdJCNx6xG1D98edc","sub":"user_2vYVtestTESTtestTESTtestTESTtest","jti":"oat_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE","iat":1666648250,"exp":1666648550,"scope":"read:foo write:bar"}
// Signed with signingJwks, verifiable with mockJwks
export const mockSignedOAuthAccessTokenJwtApplicationTyp =
 'eyJhbGciOiJSUzI1NiIsImtpZCI6Imluc18yR0lvUWhiVXB5MGhYN0IyY1ZrdVRNaW5Yb0QiLCJ0eXAiOiJhcHBsaWNhdGlvbi9hdCtqd3QifQ.eyJhenAiOiJodHRwczovL2FjY291bnRzLmluc3BpcmVkLnB1bWEtNzQubGNsLmRldiIsImV4cCI6MTY2NjY0ODU1MCwiaWF0IjoxNjY2NjQ4MjUwLCJpc3MiOiJodHRwczovL2NsZXJrLm9hdXRoLmV4YW1wbGUudGVzdCIsIm5iZiI6MTY2NjY0ODI0MCwic2lkIjoic2Vzc18yR2JEQjRlbk5kQ2E1dlMxenBDM1h6Zzl0SzkiLCJzdWIiOiJ1c2VyXzJ2WVZ0ZXN0VEVTVHRlc3RURVNUdGVzdFRFU1R0ZXN0IiwiY2xpZW50X2lkIjoiY2xpZW50XzJWVFdVenZHQzVVaGRKQ054NnhHMUQ5OGVkYyIsInNjb3BlIjoicmVhZDpmb28gd3JpdGU6YmFyIiwianRpIjoib2F0XzJ4S2E5Qmd2N054TVJERnlRdzhMcFozY1RtVTF2SGpFIn0.GPTvB4doScjzQD0kRMhMebVDREjwcrMWK73OP_kFc3pl0gST29BlWrKMBi8wRxoSJBc2ukO10BPhGxnh15PxCNLyk6xQFWhFBA7XpVxY4T_VHPDU5FEOocPQuqcqZ4cA1GDJST-BH511fxoJnv4kfha46IvQiUMvWCacIj_w12qfZigeb208mTDIeoJQtlYb-sD9u__CVvB4uZOqGb0lIL5-cCbhMPFg-6GQ2DhZ-Eq5tw7oyO6lPrsAaFN9u-59SLvips364ieYNpgcr9Dbo5PDvUSltqxoIXTDFo4esWw6XwUjnGfqCh34LYAhv_2QF2U0-GASBEn4GK-Wfv3wXg';

36 changes: 34 additions & 2 deletions
packages/backend/src/jwt/__tests__/assertions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -106,15 +106,47 @@ describe('assertAudienceClaim(audience?, aud?)', () => {
 });
});

describe('assertHeaderType(typ?)', () => {
describe('assertHeaderType(typ?, allowedTypes?)', () => {
 it('does not throw error if type is missing', () => {
 expect(() => assertHeaderType(undefined)).not.toThrow();
 expect(() => assertHeaderType(undefined, 'JWT')).not.toThrow();
 expect(() => assertHeaderType(undefined, ['JWT', 'at+jwt'])).not.toThrow();
 });

 it('throws error if type is not JWT', () => {
 it('does not throw error if type matches default allowed type (JWT)', () => {
 expect(() => assertHeaderType('JWT')).not.toThrow();
 });

 it('throws error if type is not JWT (default)', () => {
 expect(() => assertHeaderType('')).toThrow(`Invalid JWT type "". Expected "JWT".`);
 expect(() => assertHeaderType('Aloha')).toThrow(`Invalid JWT type "Aloha". Expected "JWT".`);
 });

 it('does not throw error if type matches single custom allowed type', () => {
 expect(() => assertHeaderType('at+jwt', 'at+jwt')).not.toThrow();
 expect(() => assertHeaderType('application/at+jwt', 'application/at+jwt')).not.toThrow();
 });

 it('throws error if type does not match single custom allowed type', () => {
 expect(() => assertHeaderType('JWT', 'at+jwt')).toThrow(`Invalid JWT type "JWT". Expected "at+jwt".`);
 expect(() => assertHeaderType('at+jwt', 'JWT')).toThrow(`Invalid JWT type "at+jwt". Expected "JWT".`);
 });

 it('does not throw error if type matches array of allowed types', () => {
 expect(() => assertHeaderType('JWT', ['JWT', 'at+jwt'])).not.toThrow();
 expect(() => assertHeaderType('at+jwt', ['JWT', 'at+jwt'])).not.toThrow();
 expect(() => assertHeaderType('at+jwt', ['at+jwt', 'application/at+jwt'])).not.toThrow();
 expect(() => assertHeaderType('application/at+jwt', ['at+jwt', 'application/at+jwt'])).not.toThrow();
 });

 it('throws error if type does not match any in array of allowed types', () => {
 expect(() => assertHeaderType('JWT', ['at+jwt', 'application/at+jwt'])).toThrow(
 `Invalid JWT type "JWT". Expected "at+jwt, application/at+jwt".`,
 );
 expect(() => assertHeaderType('invalid', ['at+jwt', 'application/at+jwt'])).toThrow(
 `Invalid JWT type "invalid". Expected "at+jwt, application/at+jwt".`,
 );
 });
});

describe('assertHeaderAlgorithm(alg)', () => {
Expand Down

88 changes: 88 additions & 0 deletions
packages/backend/src/jwt/__tests__/verifyJwt.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import {
 createJwt,
 mockJwks,
 mockJwt,
 mockJwtHeader,
 mockJwtPayload,
 mockOAuthAccessTokenJwtPayload,
 pemEncodedPublicKey,
 publicJwks,
 signedJwt,
 someOtherPublicKey,
} from '../../fixtures';
import { mockSignedOAuthAccessTokenJwt, mockSignedOAuthAccessTokenJwtApplicationTyp } from '../../fixtures/machine';
import { decodeJwt, hasValidSignature, verifyJwt } from '../verifyJwt';

const invalidTokenError = {
Expand DownExpand Up@@ -129,4 +132,89 @@ describe('verifyJwt(jwt, options)', () => {
 const { errors: [error] = [] } = await verifyJwt('invalid-jwt', inputVerifyJwtOptions);
 expect(error).toMatchObject(invalidTokenError);
 });

 it('verifies JWT with default headerType (JWT)', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 issuer: mockJwtPayload.iss,
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 };
 const { data } = await verifyJwt(mockJwt, inputVerifyJwtOptions);
 expect(data).toEqual(mockJwtPayload);
 });

 it('verifies JWT with explicit headerType as string', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 issuer: mockJwtPayload.iss,
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: 'JWT',
 };
 const { data } = await verifyJwt(mockJwt, inputVerifyJwtOptions);
 expect(data).toEqual(mockJwtPayload);
 });

 it('verifies OAuth JWT with headerType as array including at+jwt', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: ['at+jwt', 'application/at+jwt'],
 };
 const { data } = await verifyJwt(mockSignedOAuthAccessTokenJwt, inputVerifyJwtOptions);
 expect(data).toBeDefined();
 expect(data?.sub).toBe('user_2vYVtestTESTtestTESTtestTESTtest');
 });

 it('verifies OAuth JWT with headerType as array including application/at+jwt', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: ['at+jwt', 'application/at+jwt'],
 };
 const { data } = await verifyJwt(mockSignedOAuthAccessTokenJwtApplicationTyp, inputVerifyJwtOptions);
 expect(data).toBeDefined();
 expect(data?.sub).toBe('user_2vYVtestTESTtestTESTtestTESTtest');
 });

 it('rejects JWT when headerType does not match', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 issuer: mockJwtPayload.iss,
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: 'at+jwt',
 };
 const { errors: [error] = [] } = await verifyJwt(mockJwt, inputVerifyJwtOptions);
 expect(error).toBeDefined();
 expect(error?.message).toContain('Invalid JWT type');
 expect(error?.message).toContain('Expected "at+jwt"');
 });

 it('rejects OAuth JWT when headerType does not match', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: 'JWT',
 };
 const { errors: [error] = [] } = await verifyJwt(mockSignedOAuthAccessTokenJwt, inputVerifyJwtOptions);
 expect(error).toBeDefined();
 expect(error?.message).toContain('Invalid JWT type');
 expect(error?.message).toContain('Expected "JWT"');
 });

 it('rejects JWT when headerType array does not include the token type', async () => {
 const jwtWithCustomTyp = createJwt({
 header: { typ: 'custom-type', kid: 'ins_2GIoQhbUpy0hX7B2cVkuTMinXoD' },
 payload: mockOAuthAccessTokenJwtPayload,
 });

 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: ['at+jwt', 'application/at+jwt'],
 };
 const { errors: [error] = [] } = await verifyJwt(jwtWithCustomTyp, inputVerifyJwtOptions);
 expect(error).toBeDefined();
 expect(error?.message).toContain('Invalid JWT type');
 expect(error?.message).toContain('Expected "at+jwt, application/at+jwt"');
 });
});

7 changes: 4 additions & 3 deletions
packages/backend/src/jwt/assertions.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,16 +47,17 @@ export const assertAudienceClaim = (aud?: unknown, audience?: unknown) => {
 }
};

export const assertHeaderType = (typ?: unknown) => {
export const assertHeaderType = (typ?: unknown, allowedTypes: string | string[] = 'JWT') => {
 if (typeof typ === 'undefined') {
 return;
 }

 if (typ !== 'JWT') {
 const allowed = Array.isArray(allowedTypes) ? allowedTypes : [allowedTypes];
 if (!allowed.includes(typ as string)) {
 throw new TokenVerificationError({
 action: TokenVerificationErrorAction.EnsureClerkJWT,
 reason: TokenVerificationErrorReason.TokenInvalid,
 message: `Invalid JWT type ${JSON.stringify(typ)}. Expected "JWT".`,
 message: `Invalid JWT type ${JSON.stringify(typ)}. Expected "${allowed.join(', ')}".`,
 });
 }
};
Expand Down

9 changes: 7 additions & 2 deletions
packages/backend/src/jwt/verifyJwt.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -119,13 +119,18 @@ export type VerifyJwtOptions = {
 * @internal
 */
 key: JsonWebKey | string;
 /**
 * A string or list of allowed [header types](https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.9).
 * @default 'JWT'
 */
 headerType?: string | string[];
};

export async function verifyJwt(
 token: string,
 options: VerifyJwtOptions,
): Promise<JwtReturnType<JwtPayload, TokenVerificationError>> {
 const { audience, authorizedParties, clockSkewInMs, key } = options;
 const { audience, authorizedParties, clockSkewInMs, key, headerType } = options;
 const clockSkew = clockSkewInMs || DEFAULT_CLOCK_SKEW_IN_MS;

 const { data: decoded, errors } = decodeJwt(token);
Expand All@@ -138,7 +143,7 @@ export async function verifyJwt(
 // Header verifications
 const { typ, alg } = header;

 assertHeaderType(typ);
 assertHeaderType(typ, headerType);
 assertHeaderAlgorithm(alg);

 // Payload verifications
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
chore(repo): Backport support for JWTs in OAuth token type (#7308)#7394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wobsoriano
merged 6 commits into

from

Dec 8, 2025
 Merged


chore(repo): Backport support for JWTs in OAuth token type (#7308)
#7394
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
9b02389

feat(backend): Add support for JWTs in OAuth token type (#7308)


wobsoriano Dec 5, 2025
b471ec1

chore: update changeset


wobsoriano Dec 8, 2025
6187459

Merge branch 'vincent-and-the-doctor' into rob/backport-user-4076


wobsoriano Dec 8, 2025
38e8033

Delete .changeset/swift-sheep-notice.md


wobsoriano Dec 8, 2025
05c3adb

Merge branch 'vincent-and-the-doctor' into rob/backport-user-4076


wobsoriano Dec 8, 2025
0990c46

chore: fix missing import


wobsoriano Dec 8, 2025

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


32 changes: 32 additions & 0 deletions
packages/backend/src/api/resources/IdPOAuthAccessToken.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
import type { JwtPayload } from '@clerk/shared/types';

import type { IdPOAuthAccessTokenJSON } from './JSON';

type OAuthJwtPayload = JwtPayload & {
 jti?: string;
 client_id?: string;
 scope?: string;
 scp?: string[];
};

export class IdPOAuthAccessToken {
 constructor(
 readonly id: string,
Expand DownExpand Up@@ -30,4 +39,27 @@ export class IdPOAuthAccessToken {
 data.updated_at,
 );
 }

 /**
 * Creates an IdPOAuthAccessToken from a JWT payload.
 * Maps standard JWT claims and OAuth-specific fields to token properties.
 */
 static fromJwtPayload(payload: JwtPayload, clockSkewInMs = 5000): IdPOAuthAccessToken {
 const oauthPayload = payload as OAuthJwtPayload;

 // Map JWT claims to IdPOAuthAccessToken fields
 return new IdPOAuthAccessToken(
 oauthPayload.jti ?? '',
 oauthPayload.client_id ?? '',
 'oauth_token',
 payload.sub,
 oauthPayload.scp ?? oauthPayload.scope?.split(' ') ?? [],
 false,
 null,
 payload.exp * 1000 <= Date.now() - clockSkewInMs,
 payload.exp,
 payload.iat,
 payload.iat,
 );
 }
}

19 changes: 16 additions & 3 deletions
packages/backend/src/errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export const MachineTokenVerificationErrorCode = {
 TokenInvalid: 'token-invalid',
 InvalidSecretKey: 'secret-key-invalid',
 UnexpectedError: 'unexpected-error',
 TokenVerificationFailed: 'token-verification-failed',
} as const;

export type MachineTokenVerificationErrorCode =
Expand All@@ -82,17 +83,29 @@ export type MachineTokenVerificationErrorCode =
export class MachineTokenVerificationError extends Error {
 code: MachineTokenVerificationErrorCode;
 long_message?: string;
 status: number;
 status?: number;
 action?: TokenVerificationErrorAction;

 constructor({ message, code, status }: { message: string; code: MachineTokenVerificationErrorCode; status: number }) {
 constructor({
 message,
 code,
 status,
 action,
 }: {
 message: string;
 code: MachineTokenVerificationErrorCode;
 status?: number;
 action?: TokenVerificationErrorAction;
 }) {
 super(message);
 Object.setPrototypeOf(this, MachineTokenVerificationError.prototype);

 this.code = code;
 this.status = status;
 this.action = action;
 }

 public getFullMessage() {
 return `${this.message} (code=${this.code}, status=${this.status})`;
 return `${this.message} (code=${this.code}, status=${this.status || 'n/a'})`;
 }
}

12 changes: 12 additions & 0 deletions
packages/backend/src/fixtures/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,18 @@ export const mockJwtPayload = {
 sub: 'user_2GIpXOEpVyJw51rkZn9Kmnc6Sxr',
};

export const mockOAuthAccessTokenJwtPayload = {
 ...mockJwtPayload,
 iss: 'https://clerk.oauth.example.test',
 sub: 'user_2vYVtestTESTtestTESTtestTESTtest',
 client_id: 'client_2VTWUzvGC5UhdJCNx6xG1D98edc',
 scope: 'read:foo write:bar',
 jti: 'oat_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE',
 exp: mockJwtPayload.iat + 300,
 iat: mockJwtPayload.iat,
 nbf: mockJwtPayload.iat - 10,
};

export const mockRsaJwkKid = 'ins_2GIoQhbUpy0hX7B2cVkuTMinXoD';

export const mockRsaJwk = {
Expand Down

14 changes: 14 additions & 0 deletions
packages/backend/src/fixtures/machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,3 +65,17 @@ export const mockMachineAuthResponses = {
 errorMessage: 'Machine token not found',
 },
} as const;

// Valid OAuth access token JWT with typ: "at+jwt"
// Header: {"alg":"RS256","kid":"ins_2GIoQhbUpy0hX7B2cVkuTMinXoD","typ":"at+jwt"}
// Payload: {"client_id":"client_2VTWUzvGC5UhdJCNx6xG1D98edc","sub":"user_2vYVtestTESTtestTESTtestTESTtest","jti":"oat_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE","iat":1666648250,"exp":1666648550,"scope":"read:foo write:bar"}
// Signed with signingJwks, verifiable with mockJwks
export const mockSignedOAuthAccessTokenJwt =
 'eyJhbGciOiJSUzI1NiIsImtpZCI6Imluc18yR0lvUWhiVXB5MGhYN0IyY1ZrdVRNaW5Yb0QiLCJ0eXAiOiJhdCtqd3QifQ.eyJhenAiOiJodHRwczovL2FjY291bnRzLmluc3BpcmVkLnB1bWEtNzQubGNsLmRldiIsImV4cCI6MTY2NjY0ODU1MCwiaWF0IjoxNjY2NjQ4MjUwLCJpc3MiOiJodHRwczovL2NsZXJrLm9hdXRoLmV4YW1wbGUudGVzdCIsIm5iZiI6MTY2NjY0ODI0MCwic2lkIjoic2Vzc18yR2JEQjRlbk5kQ2E1dlMxenBDM1h6Zzl0SzkiLCJzdWIiOiJ1c2VyXzJ2WVZ0ZXN0VEVTVHRlc3RURVNUdGVzdFRFU1R0ZXN0IiwiY2xpZW50X2lkIjoiY2xpZW50XzJWVFdVenZHQzVVaGRKQ054NnhHMUQ5OGVkYyIsInNjb3BlIjoicmVhZDpmb28gd3JpdGU6YmFyIiwianRpIjoib2F0XzJ4S2E5Qmd2N054TVJERnlRdzhMcFozY1RtVTF2SGpFIn0.Wgw5L2u0nGkxF9Y-5Dje414UEkxq2Fu3_VePeh1-GehCugi0eIXV-QyiXp1ba4pxWWbCfIC_hihzKjwnVb5wrhzqyw8FJpvnvtrHEjt-zSijpS7WlO7ScJDY-PE8zgH-CICnS2CKYSkP3Rbzka9XY_Z6ieUzmBSFdA_0K8pQOdDHv70y04dnL1CjL6XToncnvezioL388Y1UTqlhll8b2Pm4EI7rGdHVKzLcKnKoYpgsBPZLmO7qGPJ5BkHvmg3gOSkmIiziFaEZkoXvjbvEUAt5qEqzaADSaFP6QhRYNtr1s4OD9uj0SK6QaoZTj69XYFuNMNnm7zN_WxvPBMTq9g';

// Valid OAuth access token JWT with typ: "application/at+jwt"
// Header: {"alg":"RS256","kid":"ins_2GIoQhbUpy0hX7B2cVkuTMinXoD","typ":"application/at+jwt"}
// Payload: {"client_id":"client_2VTWUzvGC5UhdJCNx6xG1D98edc","sub":"user_2vYVtestTESTtestTESTtestTESTtest","jti":"oat_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE","iat":1666648250,"exp":1666648550,"scope":"read:foo write:bar"}
// Signed with signingJwks, verifiable with mockJwks
export const mockSignedOAuthAccessTokenJwtApplicationTyp =
 'eyJhbGciOiJSUzI1NiIsImtpZCI6Imluc18yR0lvUWhiVXB5MGhYN0IyY1ZrdVRNaW5Yb0QiLCJ0eXAiOiJhcHBsaWNhdGlvbi9hdCtqd3QifQ.eyJhenAiOiJodHRwczovL2FjY291bnRzLmluc3BpcmVkLnB1bWEtNzQubGNsLmRldiIsImV4cCI6MTY2NjY0ODU1MCwiaWF0IjoxNjY2NjQ4MjUwLCJpc3MiOiJodHRwczovL2NsZXJrLm9hdXRoLmV4YW1wbGUudGVzdCIsIm5iZiI6MTY2NjY0ODI0MCwic2lkIjoic2Vzc18yR2JEQjRlbk5kQ2E1dlMxenBDM1h6Zzl0SzkiLCJzdWIiOiJ1c2VyXzJ2WVZ0ZXN0VEVTVHRlc3RURVNUdGVzdFRFU1R0ZXN0IiwiY2xpZW50X2lkIjoiY2xpZW50XzJWVFdVenZHQzVVaGRKQ054NnhHMUQ5OGVkYyIsInNjb3BlIjoicmVhZDpmb28gd3JpdGU6YmFyIiwianRpIjoib2F0XzJ4S2E5Qmd2N054TVJERnlRdzhMcFozY1RtVTF2SGpFIn0.GPTvB4doScjzQD0kRMhMebVDREjwcrMWK73OP_kFc3pl0gST29BlWrKMBi8wRxoSJBc2ukO10BPhGxnh15PxCNLyk6xQFWhFBA7XpVxY4T_VHPDU5FEOocPQuqcqZ4cA1GDJST-BH511fxoJnv4kfha46IvQiUMvWCacIj_w12qfZigeb208mTDIeoJQtlYb-sD9u__CVvB4uZOqGb0lIL5-cCbhMPFg-6GQ2DhZ-Eq5tw7oyO6lPrsAaFN9u-59SLvips364ieYNpgcr9Dbo5PDvUSltqxoIXTDFo4esWw6XwUjnGfqCh34LYAhv_2QF2U0-GASBEn4GK-Wfv3wXg';

36 changes: 34 additions & 2 deletions
packages/backend/src/jwt/__tests__/assertions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -106,15 +106,47 @@ describe('assertAudienceClaim(audience?, aud?)', () => {
 });
});

describe('assertHeaderType(typ?)', () => {
describe('assertHeaderType(typ?, allowedTypes?)', () => {
 it('does not throw error if type is missing', () => {
 expect(() => assertHeaderType(undefined)).not.toThrow();
 expect(() => assertHeaderType(undefined, 'JWT')).not.toThrow();
 expect(() => assertHeaderType(undefined, ['JWT', 'at+jwt'])).not.toThrow();
 });

 it('throws error if type is not JWT', () => {
 it('does not throw error if type matches default allowed type (JWT)', () => {
 expect(() => assertHeaderType('JWT')).not.toThrow();
 });

 it('throws error if type is not JWT (default)', () => {
 expect(() => assertHeaderType('')).toThrow(`Invalid JWT type "". Expected "JWT".`);
 expect(() => assertHeaderType('Aloha')).toThrow(`Invalid JWT type "Aloha". Expected "JWT".`);
 });

 it('does not throw error if type matches single custom allowed type', () => {
 expect(() => assertHeaderType('at+jwt', 'at+jwt')).not.toThrow();
 expect(() => assertHeaderType('application/at+jwt', 'application/at+jwt')).not.toThrow();
 });

 it('throws error if type does not match single custom allowed type', () => {
 expect(() => assertHeaderType('JWT', 'at+jwt')).toThrow(`Invalid JWT type "JWT". Expected "at+jwt".`);
 expect(() => assertHeaderType('at+jwt', 'JWT')).toThrow(`Invalid JWT type "at+jwt". Expected "JWT".`);
 });

 it('does not throw error if type matches array of allowed types', () => {
 expect(() => assertHeaderType('JWT', ['JWT', 'at+jwt'])).not.toThrow();
 expect(() => assertHeaderType('at+jwt', ['JWT', 'at+jwt'])).not.toThrow();
 expect(() => assertHeaderType('at+jwt', ['at+jwt', 'application/at+jwt'])).not.toThrow();
 expect(() => assertHeaderType('application/at+jwt', ['at+jwt', 'application/at+jwt'])).not.toThrow();
 });

 it('throws error if type does not match any in array of allowed types', () => {
 expect(() => assertHeaderType('JWT', ['at+jwt', 'application/at+jwt'])).toThrow(
 `Invalid JWT type "JWT". Expected "at+jwt, application/at+jwt".`,
 );
 expect(() => assertHeaderType('invalid', ['at+jwt', 'application/at+jwt'])).toThrow(
 `Invalid JWT type "invalid". Expected "at+jwt, application/at+jwt".`,
 );
 });
});

describe('assertHeaderAlgorithm(alg)', () => {
Expand Down

88 changes: 88 additions & 0 deletions
packages/backend/src/jwt/__tests__/verifyJwt.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import {
 createJwt,
 mockJwks,
 mockJwt,
 mockJwtHeader,
 mockJwtPayload,
 mockOAuthAccessTokenJwtPayload,
 pemEncodedPublicKey,
 publicJwks,
 signedJwt,
 someOtherPublicKey,
} from '../../fixtures';
import { mockSignedOAuthAccessTokenJwt, mockSignedOAuthAccessTokenJwtApplicationTyp } from '../../fixtures/machine';
import { decodeJwt, hasValidSignature, verifyJwt } from '../verifyJwt';

const invalidTokenError = {
Expand DownExpand Up@@ -129,4 +132,89 @@ describe('verifyJwt(jwt, options)', () => {
 const { errors: [error] = [] } = await verifyJwt('invalid-jwt', inputVerifyJwtOptions);
 expect(error).toMatchObject(invalidTokenError);
 });

 it('verifies JWT with default headerType (JWT)', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 issuer: mockJwtPayload.iss,
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 };
 const { data } = await verifyJwt(mockJwt, inputVerifyJwtOptions);
 expect(data).toEqual(mockJwtPayload);
 });

 it('verifies JWT with explicit headerType as string', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 issuer: mockJwtPayload.iss,
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: 'JWT',
 };
 const { data } = await verifyJwt(mockJwt, inputVerifyJwtOptions);
 expect(data).toEqual(mockJwtPayload);
 });

 it('verifies OAuth JWT with headerType as array including at+jwt', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: ['at+jwt', 'application/at+jwt'],
 };
 const { data } = await verifyJwt(mockSignedOAuthAccessTokenJwt, inputVerifyJwtOptions);
 expect(data).toBeDefined();
 expect(data?.sub).toBe('user_2vYVtestTESTtestTESTtestTESTtest');
 });

 it('verifies OAuth JWT with headerType as array including application/at+jwt', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: ['at+jwt', 'application/at+jwt'],
 };
 const { data } = await verifyJwt(mockSignedOAuthAccessTokenJwtApplicationTyp, inputVerifyJwtOptions);
 expect(data).toBeDefined();
 expect(data?.sub).toBe('user_2vYVtestTESTtestTESTtestTESTtest');
 });

 it('rejects JWT when headerType does not match', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 issuer: mockJwtPayload.iss,
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: 'at+jwt',
 };
 const { errors: [error] = [] } = await verifyJwt(mockJwt, inputVerifyJwtOptions);
 expect(error).toBeDefined();
 expect(error?.message).toContain('Invalid JWT type');
 expect(error?.message).toContain('Expected "at+jwt"');
 });

 it('rejects OAuth JWT when headerType does not match', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: 'JWT',
 };
 const { errors: [error] = [] } = await verifyJwt(mockSignedOAuthAccessTokenJwt, inputVerifyJwtOptions);
 expect(error).toBeDefined();
 expect(error?.message).toContain('Invalid JWT type');
 expect(error?.message).toContain('Expected "JWT"');
 });

 it('rejects JWT when headerType array does not include the token type', async () => {
 const jwtWithCustomTyp = createJwt({
 header: { typ: 'custom-type', kid: 'ins_2GIoQhbUpy0hX7B2cVkuTMinXoD' },
 payload: mockOAuthAccessTokenJwtPayload,
 });

 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: ['at+jwt', 'application/at+jwt'],
 };
 const { errors: [error] = [] } = await verifyJwt(jwtWithCustomTyp, inputVerifyJwtOptions);
 expect(error).toBeDefined();
 expect(error?.message).toContain('Invalid JWT type');
 expect(error?.message).toContain('Expected "at+jwt, application/at+jwt"');
 });
});

7 changes: 4 additions & 3 deletions
packages/backend/src/jwt/assertions.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,16 +47,17 @@ export const assertAudienceClaim = (aud?: unknown, audience?: unknown) => {
 }
};

export const assertHeaderType = (typ?: unknown) => {
export const assertHeaderType = (typ?: unknown, allowedTypes: string | string[] = 'JWT') => {
 if (typeof typ === 'undefined') {
 return;
 }

 if (typ !== 'JWT') {
 const allowed = Array.isArray(allowedTypes) ? allowedTypes : [allowedTypes];
 if (!allowed.includes(typ as string)) {
 throw new TokenVerificationError({
 action: TokenVerificationErrorAction.EnsureClerkJWT,
 reason: TokenVerificationErrorReason.TokenInvalid,
 message: `Invalid JWT type ${JSON.stringify(typ)}. Expected "JWT".`,
 message: `Invalid JWT type ${JSON.stringify(typ)}. Expected "${allowed.join(', ')}".`,
 });
 }
};
Expand Down

9 changes: 7 additions & 2 deletions
packages/backend/src/jwt/verifyJwt.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -119,13 +119,18 @@ export type VerifyJwtOptions = {
 * @internal
 */
 key: JsonWebKey | string;
 /**
 * A string or list of allowed [header types](https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.9).
 * @default 'JWT'
 */
 headerType?: string | string[];
};

export async function verifyJwt(
 token: string,
 options: VerifyJwtOptions,
): Promise<JwtReturnType<JwtPayload, TokenVerificationError>> {
 const { audience, authorizedParties, clockSkewInMs, key } = options;
 const { audience, authorizedParties, clockSkewInMs, key, headerType } = options;
 const clockSkew = clockSkewInMs || DEFAULT_CLOCK_SKEW_IN_MS;

 const { data: decoded, errors } = decodeJwt(token);
Expand All@@ -138,7 +143,7 @@ export async function verifyJwt(
 // Header verifications
 const { typ, alg } = header;

 assertHeaderType(typ);
 assertHeaderType(typ, headerType);
 assertHeaderAlgorithm(alg);

 // Payload verifications
Expand Down
Loading
Loading

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

Skip to content
chore(repo): Backport support for JWTs in OAuth token type (#7308)#7394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wobsoriano
merged 6 commits into

from

Dec 8, 2025
 Merged


chore(repo): Backport support for JWTs in OAuth token type (#7308)
#7394
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
9b02389

feat(backend): Add support for JWTs in OAuth token type (#7308)


wobsoriano Dec 5, 2025
b471ec1

chore: update changeset


wobsoriano Dec 8, 2025
6187459

Merge branch 'vincent-and-the-doctor' into rob/backport-user-4076


wobsoriano Dec 8, 2025
38e8033

Delete .changeset/swift-sheep-notice.md


wobsoriano Dec 8, 2025
05c3adb

Merge branch 'vincent-and-the-doctor' into rob/backport-user-4076


wobsoriano Dec 8, 2025
0990c46

chore: fix missing import


wobsoriano Dec 8, 2025

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


32 changes: 32 additions & 0 deletions
packages/backend/src/api/resources/IdPOAuthAccessToken.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
import type { JwtPayload } from '@clerk/shared/types';

import type { IdPOAuthAccessTokenJSON } from './JSON';

type OAuthJwtPayload = JwtPayload & {
 jti?: string;
 client_id?: string;
 scope?: string;
 scp?: string[];
};

export class IdPOAuthAccessToken {
 constructor(
 readonly id: string,
Expand DownExpand Up@@ -30,4 +39,27 @@ export class IdPOAuthAccessToken {
 data.updated_at,
 );
 }

 /**
 * Creates an IdPOAuthAccessToken from a JWT payload.
 * Maps standard JWT claims and OAuth-specific fields to token properties.
 */
 static fromJwtPayload(payload: JwtPayload, clockSkewInMs = 5000): IdPOAuthAccessToken {
 const oauthPayload = payload as OAuthJwtPayload;

 // Map JWT claims to IdPOAuthAccessToken fields
 return new IdPOAuthAccessToken(
 oauthPayload.jti ?? '',
 oauthPayload.client_id ?? '',
 'oauth_token',
 payload.sub,
 oauthPayload.scp ?? oauthPayload.scope?.split(' ') ?? [],
 false,
 null,
 payload.exp * 1000 <= Date.now() - clockSkewInMs,
 payload.exp,
 payload.iat,
 payload.iat,
 );
 }
}

19 changes: 16 additions & 3 deletions
packages/backend/src/errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export const MachineTokenVerificationErrorCode = {
 TokenInvalid: 'token-invalid',
 InvalidSecretKey: 'secret-key-invalid',
 UnexpectedError: 'unexpected-error',
 TokenVerificationFailed: 'token-verification-failed',
} as const;

export type MachineTokenVerificationErrorCode =
Expand All@@ -82,17 +83,29 @@ export type MachineTokenVerificationErrorCode =
export class MachineTokenVerificationError extends Error {
 code: MachineTokenVerificationErrorCode;
 long_message?: string;
 status: number;
 status?: number;
 action?: TokenVerificationErrorAction;

 constructor({ message, code, status }: { message: string; code: MachineTokenVerificationErrorCode; status: number }) {
 constructor({
 message,
 code,
 status,
 action,
 }: {
 message: string;
 code: MachineTokenVerificationErrorCode;
 status?: number;
 action?: TokenVerificationErrorAction;
 }) {
 super(message);
 Object.setPrototypeOf(this, MachineTokenVerificationError.prototype);

 this.code = code;
 this.status = status;
 this.action = action;
 }

 public getFullMessage() {
 return `${this.message} (code=${this.code}, status=${this.status})`;
 return `${this.message} (code=${this.code}, status=${this.status || 'n/a'})`;
 }
}

12 changes: 12 additions & 0 deletions
packages/backend/src/fixtures/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,18 @@ export const mockJwtPayload = {
 sub: 'user_2GIpXOEpVyJw51rkZn9Kmnc6Sxr',
};

export const mockOAuthAccessTokenJwtPayload = {
 ...mockJwtPayload,
 iss: 'https://clerk.oauth.example.test',
 sub: 'user_2vYVtestTESTtestTESTtestTESTtest',
 client_id: 'client_2VTWUzvGC5UhdJCNx6xG1D98edc',
 scope: 'read:foo write:bar',
 jti: 'oat_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE',
 exp: mockJwtPayload.iat + 300,
 iat: mockJwtPayload.iat,
 nbf: mockJwtPayload.iat - 10,
};

export const mockRsaJwkKid = 'ins_2GIoQhbUpy0hX7B2cVkuTMinXoD';

export const mockRsaJwk = {
Expand Down

14 changes: 14 additions & 0 deletions
packages/backend/src/fixtures/machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,3 +65,17 @@ export const mockMachineAuthResponses = {
 errorMessage: 'Machine token not found',
 },
} as const;

// Valid OAuth access token JWT with typ: "at+jwt"
// Header: {"alg":"RS256","kid":"ins_2GIoQhbUpy0hX7B2cVkuTMinXoD","typ":"at+jwt"}
// Payload: {"client_id":"client_2VTWUzvGC5UhdJCNx6xG1D98edc","sub":"user_2vYVtestTESTtestTESTtestTESTtest","jti":"oat_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE","iat":1666648250,"exp":1666648550,"scope":"read:foo write:bar"}
// Signed with signingJwks, verifiable with mockJwks
export const mockSignedOAuthAccessTokenJwt =
 'eyJhbGciOiJSUzI1NiIsImtpZCI6Imluc18yR0lvUWhiVXB5MGhYN0IyY1ZrdVRNaW5Yb0QiLCJ0eXAiOiJhdCtqd3QifQ.eyJhenAiOiJodHRwczovL2FjY291bnRzLmluc3BpcmVkLnB1bWEtNzQubGNsLmRldiIsImV4cCI6MTY2NjY0ODU1MCwiaWF0IjoxNjY2NjQ4MjUwLCJpc3MiOiJodHRwczovL2NsZXJrLm9hdXRoLmV4YW1wbGUudGVzdCIsIm5iZiI6MTY2NjY0ODI0MCwic2lkIjoic2Vzc18yR2JEQjRlbk5kQ2E1dlMxenBDM1h6Zzl0SzkiLCJzdWIiOiJ1c2VyXzJ2WVZ0ZXN0VEVTVHRlc3RURVNUdGVzdFRFU1R0ZXN0IiwiY2xpZW50X2lkIjoiY2xpZW50XzJWVFdVenZHQzVVaGRKQ054NnhHMUQ5OGVkYyIsInNjb3BlIjoicmVhZDpmb28gd3JpdGU6YmFyIiwianRpIjoib2F0XzJ4S2E5Qmd2N054TVJERnlRdzhMcFozY1RtVTF2SGpFIn0.Wgw5L2u0nGkxF9Y-5Dje414UEkxq2Fu3_VePeh1-GehCugi0eIXV-QyiXp1ba4pxWWbCfIC_hihzKjwnVb5wrhzqyw8FJpvnvtrHEjt-zSijpS7WlO7ScJDY-PE8zgH-CICnS2CKYSkP3Rbzka9XY_Z6ieUzmBSFdA_0K8pQOdDHv70y04dnL1CjL6XToncnvezioL388Y1UTqlhll8b2Pm4EI7rGdHVKzLcKnKoYpgsBPZLmO7qGPJ5BkHvmg3gOSkmIiziFaEZkoXvjbvEUAt5qEqzaADSaFP6QhRYNtr1s4OD9uj0SK6QaoZTj69XYFuNMNnm7zN_WxvPBMTq9g';

// Valid OAuth access token JWT with typ: "application/at+jwt"
// Header: {"alg":"RS256","kid":"ins_2GIoQhbUpy0hX7B2cVkuTMinXoD","typ":"application/at+jwt"}
// Payload: {"client_id":"client_2VTWUzvGC5UhdJCNx6xG1D98edc","sub":"user_2vYVtestTESTtestTESTtestTESTtest","jti":"oat_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE","iat":1666648250,"exp":1666648550,"scope":"read:foo write:bar"}
// Signed with signingJwks, verifiable with mockJwks
export const mockSignedOAuthAccessTokenJwtApplicationTyp =
 'eyJhbGciOiJSUzI1NiIsImtpZCI6Imluc18yR0lvUWhiVXB5MGhYN0IyY1ZrdVRNaW5Yb0QiLCJ0eXAiOiJhcHBsaWNhdGlvbi9hdCtqd3QifQ.eyJhenAiOiJodHRwczovL2FjY291bnRzLmluc3BpcmVkLnB1bWEtNzQubGNsLmRldiIsImV4cCI6MTY2NjY0ODU1MCwiaWF0IjoxNjY2NjQ4MjUwLCJpc3MiOiJodHRwczovL2NsZXJrLm9hdXRoLmV4YW1wbGUudGVzdCIsIm5iZiI6MTY2NjY0ODI0MCwic2lkIjoic2Vzc18yR2JEQjRlbk5kQ2E1dlMxenBDM1h6Zzl0SzkiLCJzdWIiOiJ1c2VyXzJ2WVZ0ZXN0VEVTVHRlc3RURVNUdGVzdFRFU1R0ZXN0IiwiY2xpZW50X2lkIjoiY2xpZW50XzJWVFdVenZHQzVVaGRKQ054NnhHMUQ5OGVkYyIsInNjb3BlIjoicmVhZDpmb28gd3JpdGU6YmFyIiwianRpIjoib2F0XzJ4S2E5Qmd2N054TVJERnlRdzhMcFozY1RtVTF2SGpFIn0.GPTvB4doScjzQD0kRMhMebVDREjwcrMWK73OP_kFc3pl0gST29BlWrKMBi8wRxoSJBc2ukO10BPhGxnh15PxCNLyk6xQFWhFBA7XpVxY4T_VHPDU5FEOocPQuqcqZ4cA1GDJST-BH511fxoJnv4kfha46IvQiUMvWCacIj_w12qfZigeb208mTDIeoJQtlYb-sD9u__CVvB4uZOqGb0lIL5-cCbhMPFg-6GQ2DhZ-Eq5tw7oyO6lPrsAaFN9u-59SLvips364ieYNpgcr9Dbo5PDvUSltqxoIXTDFo4esWw6XwUjnGfqCh34LYAhv_2QF2U0-GASBEn4GK-Wfv3wXg';

36 changes: 34 additions & 2 deletions
packages/backend/src/jwt/__tests__/assertions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -106,15 +106,47 @@ describe('assertAudienceClaim(audience?, aud?)', () => {
 });
});

describe('assertHeaderType(typ?)', () => {
describe('assertHeaderType(typ?, allowedTypes?)', () => {
 it('does not throw error if type is missing', () => {
 expect(() => assertHeaderType(undefined)).not.toThrow();
 expect(() => assertHeaderType(undefined, 'JWT')).not.toThrow();
 expect(() => assertHeaderType(undefined, ['JWT', 'at+jwt'])).not.toThrow();
 });

 it('throws error if type is not JWT', () => {
 it('does not throw error if type matches default allowed type (JWT)', () => {
 expect(() => assertHeaderType('JWT')).not.toThrow();
 });

 it('throws error if type is not JWT (default)', () => {
 expect(() => assertHeaderType('')).toThrow(`Invalid JWT type "". Expected "JWT".`);
 expect(() => assertHeaderType('Aloha')).toThrow(`Invalid JWT type "Aloha". Expected "JWT".`);
 });

 it('does not throw error if type matches single custom allowed type', () => {
 expect(() => assertHeaderType('at+jwt', 'at+jwt')).not.toThrow();
 expect(() => assertHeaderType('application/at+jwt', 'application/at+jwt')).not.toThrow();
 });

 it('throws error if type does not match single custom allowed type', () => {
 expect(() => assertHeaderType('JWT', 'at+jwt')).toThrow(`Invalid JWT type "JWT". Expected "at+jwt".`);
 expect(() => assertHeaderType('at+jwt', 'JWT')).toThrow(`Invalid JWT type "at+jwt". Expected "JWT".`);
 });

 it('does not throw error if type matches array of allowed types', () => {
 expect(() => assertHeaderType('JWT', ['JWT', 'at+jwt'])).not.toThrow();
 expect(() => assertHeaderType('at+jwt', ['JWT', 'at+jwt'])).not.toThrow();
 expect(() => assertHeaderType('at+jwt', ['at+jwt', 'application/at+jwt'])).not.toThrow();
 expect(() => assertHeaderType('application/at+jwt', ['at+jwt', 'application/at+jwt'])).not.toThrow();
 });

 it('throws error if type does not match any in array of allowed types', () => {
 expect(() => assertHeaderType('JWT', ['at+jwt', 'application/at+jwt'])).toThrow(
 `Invalid JWT type "JWT". Expected "at+jwt, application/at+jwt".`,
 );
 expect(() => assertHeaderType('invalid', ['at+jwt', 'application/at+jwt'])).toThrow(
 `Invalid JWT type "invalid". Expected "at+jwt, application/at+jwt".`,
 );
 });
});

describe('assertHeaderAlgorithm(alg)', () => {
Expand Down

88 changes: 88 additions & 0 deletions
packages/backend/src/jwt/__tests__/verifyJwt.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import {
 createJwt,
 mockJwks,
 mockJwt,
 mockJwtHeader,
 mockJwtPayload,
 mockOAuthAccessTokenJwtPayload,
 pemEncodedPublicKey,
 publicJwks,
 signedJwt,
 someOtherPublicKey,
} from '../../fixtures';
import { mockSignedOAuthAccessTokenJwt, mockSignedOAuthAccessTokenJwtApplicationTyp } from '../../fixtures/machine';
import { decodeJwt, hasValidSignature, verifyJwt } from '../verifyJwt';

const invalidTokenError = {
Expand DownExpand Up@@ -129,4 +132,89 @@ describe('verifyJwt(jwt, options)', () => {
 const { errors: [error] = [] } = await verifyJwt('invalid-jwt', inputVerifyJwtOptions);
 expect(error).toMatchObject(invalidTokenError);
 });

 it('verifies JWT with default headerType (JWT)', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 issuer: mockJwtPayload.iss,
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 };
 const { data } = await verifyJwt(mockJwt, inputVerifyJwtOptions);
 expect(data).toEqual(mockJwtPayload);
 });

 it('verifies JWT with explicit headerType as string', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 issuer: mockJwtPayload.iss,
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: 'JWT',
 };
 const { data } = await verifyJwt(mockJwt, inputVerifyJwtOptions);
 expect(data).toEqual(mockJwtPayload);
 });

 it('verifies OAuth JWT with headerType as array including at+jwt', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: ['at+jwt', 'application/at+jwt'],
 };
 const { data } = await verifyJwt(mockSignedOAuthAccessTokenJwt, inputVerifyJwtOptions);
 expect(data).toBeDefined();
 expect(data?.sub).toBe('user_2vYVtestTESTtestTESTtestTESTtest');
 });

 it('verifies OAuth JWT with headerType as array including application/at+jwt', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: ['at+jwt', 'application/at+jwt'],
 };
 const { data } = await verifyJwt(mockSignedOAuthAccessTokenJwtApplicationTyp, inputVerifyJwtOptions);
 expect(data).toBeDefined();
 expect(data?.sub).toBe('user_2vYVtestTESTtestTESTtestTESTtest');
 });

 it('rejects JWT when headerType does not match', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 issuer: mockJwtPayload.iss,
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: 'at+jwt',
 };
 const { errors: [error] = [] } = await verifyJwt(mockJwt, inputVerifyJwtOptions);
 expect(error).toBeDefined();
 expect(error?.message).toContain('Invalid JWT type');
 expect(error?.message).toContain('Expected "at+jwt"');
 });

 it('rejects OAuth JWT when headerType does not match', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: 'JWT',
 };
 const { errors: [error] = [] } = await verifyJwt(mockSignedOAuthAccessTokenJwt, inputVerifyJwtOptions);
 expect(error).toBeDefined();
 expect(error?.message).toContain('Invalid JWT type');
 expect(error?.message).toContain('Expected "JWT"');
 });

 it('rejects JWT when headerType array does not include the token type', async () => {
 const jwtWithCustomTyp = createJwt({
 header: { typ: 'custom-type', kid: 'ins_2GIoQhbUpy0hX7B2cVkuTMinXoD' },
 payload: mockOAuthAccessTokenJwtPayload,
 });

 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: ['at+jwt', 'application/at+jwt'],
 };
 const { errors: [error] = [] } = await verifyJwt(jwtWithCustomTyp, inputVerifyJwtOptions);
 expect(error).toBeDefined();
 expect(error?.message).toContain('Invalid JWT type');
 expect(error?.message).toContain('Expected "at+jwt, application/at+jwt"');
 });
});

7 changes: 4 additions & 3 deletions
packages/backend/src/jwt/assertions.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,16 +47,17 @@ export const assertAudienceClaim = (aud?: unknown, audience?: unknown) => {
 }
};

export const assertHeaderType = (typ?: unknown) => {
export const assertHeaderType = (typ?: unknown, allowedTypes: string | string[] = 'JWT') => {
 if (typeof typ === 'undefined') {
 return;
 }

 if (typ !== 'JWT') {
 const allowed = Array.isArray(allowedTypes) ? allowedTypes : [allowedTypes];
 if (!allowed.includes(typ as string)) {
 throw new TokenVerificationError({
 action: TokenVerificationErrorAction.EnsureClerkJWT,
 reason: TokenVerificationErrorReason.TokenInvalid,
 message: `Invalid JWT type ${JSON.stringify(typ)}. Expected "JWT".`,
 message: `Invalid JWT type ${JSON.stringify(typ)}. Expected "${allowed.join(', ')}".`,
 });
 }
};
Expand Down

9 changes: 7 additions & 2 deletions
packages/backend/src/jwt/verifyJwt.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -119,13 +119,18 @@ export type VerifyJwtOptions = {
 * @internal
 */
 key: JsonWebKey | string;
 /**
 * A string or list of allowed [header types](https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.9).
 * @default 'JWT'
 */
 headerType?: string | string[];
};

export async function verifyJwt(
 token: string,
 options: VerifyJwtOptions,
): Promise<JwtReturnType<JwtPayload, TokenVerificationError>> {
 const { audience, authorizedParties, clockSkewInMs, key } = options;
 const { audience, authorizedParties, clockSkewInMs, key, headerType } = options;
 const clockSkew = clockSkewInMs || DEFAULT_CLOCK_SKEW_IN_MS;

 const { data: decoded, errors } = decodeJwt(token);
Expand All@@ -138,7 +143,7 @@ export async function verifyJwt(
 // Header verifications
 const { typ, alg } = header;

 assertHeaderType(typ);
 assertHeaderType(typ, headerType);
 assertHeaderAlgorithm(alg);

 // Payload verifications
Expand Down
Loading
Loading

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

Skip to content
chore(repo): Backport support for JWTs in OAuth token type (#7308)#7394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wobsoriano
merged 6 commits into

from

Dec 8, 2025
 Merged


chore(repo): Backport support for JWTs in OAuth token type (#7308)
#7394
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
9b02389

feat(backend): Add support for JWTs in OAuth token type (#7308)


wobsoriano Dec 5, 2025
b471ec1

chore: update changeset


wobsoriano Dec 8, 2025
6187459

Merge branch 'vincent-and-the-doctor' into rob/backport-user-4076


wobsoriano Dec 8, 2025
38e8033

Delete .changeset/swift-sheep-notice.md


wobsoriano Dec 8, 2025
05c3adb

Merge branch 'vincent-and-the-doctor' into rob/backport-user-4076


wobsoriano Dec 8, 2025
0990c46

chore: fix missing import


wobsoriano Dec 8, 2025

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


32 changes: 32 additions & 0 deletions
packages/backend/src/api/resources/IdPOAuthAccessToken.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
import type { JwtPayload } from '@clerk/shared/types';

import type { IdPOAuthAccessTokenJSON } from './JSON';

type OAuthJwtPayload = JwtPayload & {
 jti?: string;
 client_id?: string;
 scope?: string;
 scp?: string[];
};

export class IdPOAuthAccessToken {
 constructor(
 readonly id: string,
Expand DownExpand Up@@ -30,4 +39,27 @@ export class IdPOAuthAccessToken {
 data.updated_at,
 );
 }

 /**
 * Creates an IdPOAuthAccessToken from a JWT payload.
 * Maps standard JWT claims and OAuth-specific fields to token properties.
 */
 static fromJwtPayload(payload: JwtPayload, clockSkewInMs = 5000): IdPOAuthAccessToken {
 const oauthPayload = payload as OAuthJwtPayload;

 // Map JWT claims to IdPOAuthAccessToken fields
 return new IdPOAuthAccessToken(
 oauthPayload.jti ?? '',
 oauthPayload.client_id ?? '',
 'oauth_token',
 payload.sub,
 oauthPayload.scp ?? oauthPayload.scope?.split(' ') ?? [],
 false,
 null,
 payload.exp * 1000 <= Date.now() - clockSkewInMs,
 payload.exp,
 payload.iat,
 payload.iat,
 );
 }
}

19 changes: 16 additions & 3 deletions
packages/backend/src/errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export const MachineTokenVerificationErrorCode = {
 TokenInvalid: 'token-invalid',
 InvalidSecretKey: 'secret-key-invalid',
 UnexpectedError: 'unexpected-error',
 TokenVerificationFailed: 'token-verification-failed',
} as const;

export type MachineTokenVerificationErrorCode =
Expand All@@ -82,17 +83,29 @@ export type MachineTokenVerificationErrorCode =
export class MachineTokenVerificationError extends Error {
 code: MachineTokenVerificationErrorCode;
 long_message?: string;
 status: number;
 status?: number;
 action?: TokenVerificationErrorAction;

 constructor({ message, code, status }: { message: string; code: MachineTokenVerificationErrorCode; status: number }) {
 constructor({
 message,
 code,
 status,
 action,
 }: {
 message: string;
 code: MachineTokenVerificationErrorCode;
 status?: number;
 action?: TokenVerificationErrorAction;
 }) {
 super(message);
 Object.setPrototypeOf(this, MachineTokenVerificationError.prototype);

 this.code = code;
 this.status = status;
 this.action = action;
 }

 public getFullMessage() {
 return `${this.message} (code=${this.code}, status=${this.status})`;
 return `${this.message} (code=${this.code}, status=${this.status || 'n/a'})`;
 }
}

12 changes: 12 additions & 0 deletions
packages/backend/src/fixtures/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,18 @@ export const mockJwtPayload = {
 sub: 'user_2GIpXOEpVyJw51rkZn9Kmnc6Sxr',
};

export const mockOAuthAccessTokenJwtPayload = {
 ...mockJwtPayload,
 iss: 'https://clerk.oauth.example.test',
 sub: 'user_2vYVtestTESTtestTESTtestTESTtest',
 client_id: 'client_2VTWUzvGC5UhdJCNx6xG1D98edc',
 scope: 'read:foo write:bar',
 jti: 'oat_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE',
 exp: mockJwtPayload.iat + 300,
 iat: mockJwtPayload.iat,
 nbf: mockJwtPayload.iat - 10,
};

export const mockRsaJwkKid = 'ins_2GIoQhbUpy0hX7B2cVkuTMinXoD';

export const mockRsaJwk = {
Expand Down

14 changes: 14 additions & 0 deletions
packages/backend/src/fixtures/machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,3 +65,17 @@ export const mockMachineAuthResponses = {
 errorMessage: 'Machine token not found',
 },
} as const;

// Valid OAuth access token JWT with typ: "at+jwt"
// Header: {"alg":"RS256","kid":"ins_2GIoQhbUpy0hX7B2cVkuTMinXoD","typ":"at+jwt"}
// Payload: {"client_id":"client_2VTWUzvGC5UhdJCNx6xG1D98edc","sub":"user_2vYVtestTESTtestTESTtestTESTtest","jti":"oat_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE","iat":1666648250,"exp":1666648550,"scope":"read:foo write:bar"}
// Signed with signingJwks, verifiable with mockJwks
export const mockSignedOAuthAccessTokenJwt =
 'eyJhbGciOiJSUzI1NiIsImtpZCI6Imluc18yR0lvUWhiVXB5MGhYN0IyY1ZrdVRNaW5Yb0QiLCJ0eXAiOiJhdCtqd3QifQ.eyJhenAiOiJodHRwczovL2FjY291bnRzLmluc3BpcmVkLnB1bWEtNzQubGNsLmRldiIsImV4cCI6MTY2NjY0ODU1MCwiaWF0IjoxNjY2NjQ4MjUwLCJpc3MiOiJodHRwczovL2NsZXJrLm9hdXRoLmV4YW1wbGUudGVzdCIsIm5iZiI6MTY2NjY0ODI0MCwic2lkIjoic2Vzc18yR2JEQjRlbk5kQ2E1dlMxenBDM1h6Zzl0SzkiLCJzdWIiOiJ1c2VyXzJ2WVZ0ZXN0VEVTVHRlc3RURVNUdGVzdFRFU1R0ZXN0IiwiY2xpZW50X2lkIjoiY2xpZW50XzJWVFdVenZHQzVVaGRKQ054NnhHMUQ5OGVkYyIsInNjb3BlIjoicmVhZDpmb28gd3JpdGU6YmFyIiwianRpIjoib2F0XzJ4S2E5Qmd2N054TVJERnlRdzhMcFozY1RtVTF2SGpFIn0.Wgw5L2u0nGkxF9Y-5Dje414UEkxq2Fu3_VePeh1-GehCugi0eIXV-QyiXp1ba4pxWWbCfIC_hihzKjwnVb5wrhzqyw8FJpvnvtrHEjt-zSijpS7WlO7ScJDY-PE8zgH-CICnS2CKYSkP3Rbzka9XY_Z6ieUzmBSFdA_0K8pQOdDHv70y04dnL1CjL6XToncnvezioL388Y1UTqlhll8b2Pm4EI7rGdHVKzLcKnKoYpgsBPZLmO7qGPJ5BkHvmg3gOSkmIiziFaEZkoXvjbvEUAt5qEqzaADSaFP6QhRYNtr1s4OD9uj0SK6QaoZTj69XYFuNMNnm7zN_WxvPBMTq9g';

// Valid OAuth access token JWT with typ: "application/at+jwt"
// Header: {"alg":"RS256","kid":"ins_2GIoQhbUpy0hX7B2cVkuTMinXoD","typ":"application/at+jwt"}
// Payload: {"client_id":"client_2VTWUzvGC5UhdJCNx6xG1D98edc","sub":"user_2vYVtestTESTtestTESTtestTESTtest","jti":"oat_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE","iat":1666648250,"exp":1666648550,"scope":"read:foo write:bar"}
// Signed with signingJwks, verifiable with mockJwks
export const mockSignedOAuthAccessTokenJwtApplicationTyp =
 'eyJhbGciOiJSUzI1NiIsImtpZCI6Imluc18yR0lvUWhiVXB5MGhYN0IyY1ZrdVRNaW5Yb0QiLCJ0eXAiOiJhcHBsaWNhdGlvbi9hdCtqd3QifQ.eyJhenAiOiJodHRwczovL2FjY291bnRzLmluc3BpcmVkLnB1bWEtNzQubGNsLmRldiIsImV4cCI6MTY2NjY0ODU1MCwiaWF0IjoxNjY2NjQ4MjUwLCJpc3MiOiJodHRwczovL2NsZXJrLm9hdXRoLmV4YW1wbGUudGVzdCIsIm5iZiI6MTY2NjY0ODI0MCwic2lkIjoic2Vzc18yR2JEQjRlbk5kQ2E1dlMxenBDM1h6Zzl0SzkiLCJzdWIiOiJ1c2VyXzJ2WVZ0ZXN0VEVTVHRlc3RURVNUdGVzdFRFU1R0ZXN0IiwiY2xpZW50X2lkIjoiY2xpZW50XzJWVFdVenZHQzVVaGRKQ054NnhHMUQ5OGVkYyIsInNjb3BlIjoicmVhZDpmb28gd3JpdGU6YmFyIiwianRpIjoib2F0XzJ4S2E5Qmd2N054TVJERnlRdzhMcFozY1RtVTF2SGpFIn0.GPTvB4doScjzQD0kRMhMebVDREjwcrMWK73OP_kFc3pl0gST29BlWrKMBi8wRxoSJBc2ukO10BPhGxnh15PxCNLyk6xQFWhFBA7XpVxY4T_VHPDU5FEOocPQuqcqZ4cA1GDJST-BH511fxoJnv4kfha46IvQiUMvWCacIj_w12qfZigeb208mTDIeoJQtlYb-sD9u__CVvB4uZOqGb0lIL5-cCbhMPFg-6GQ2DhZ-Eq5tw7oyO6lPrsAaFN9u-59SLvips364ieYNpgcr9Dbo5PDvUSltqxoIXTDFo4esWw6XwUjnGfqCh34LYAhv_2QF2U0-GASBEn4GK-Wfv3wXg';

36 changes: 34 additions & 2 deletions
packages/backend/src/jwt/__tests__/assertions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -106,15 +106,47 @@ describe('assertAudienceClaim(audience?, aud?)', () => {
 });
});

describe('assertHeaderType(typ?)', () => {
describe('assertHeaderType(typ?, allowedTypes?)', () => {
 it('does not throw error if type is missing', () => {
 expect(() => assertHeaderType(undefined)).not.toThrow();
 expect(() => assertHeaderType(undefined, 'JWT')).not.toThrow();
 expect(() => assertHeaderType(undefined, ['JWT', 'at+jwt'])).not.toThrow();
 });

 it('throws error if type is not JWT', () => {
 it('does not throw error if type matches default allowed type (JWT)', () => {
 expect(() => assertHeaderType('JWT')).not.toThrow();
 });

 it('throws error if type is not JWT (default)', () => {
 expect(() => assertHeaderType('')).toThrow(`Invalid JWT type "". Expected "JWT".`);
 expect(() => assertHeaderType('Aloha')).toThrow(`Invalid JWT type "Aloha". Expected "JWT".`);
 });

 it('does not throw error if type matches single custom allowed type', () => {
 expect(() => assertHeaderType('at+jwt', 'at+jwt')).not.toThrow();
 expect(() => assertHeaderType('application/at+jwt', 'application/at+jwt')).not.toThrow();
 });

 it('throws error if type does not match single custom allowed type', () => {
 expect(() => assertHeaderType('JWT', 'at+jwt')).toThrow(`Invalid JWT type "JWT". Expected "at+jwt".`);
 expect(() => assertHeaderType('at+jwt', 'JWT')).toThrow(`Invalid JWT type "at+jwt". Expected "JWT".`);
 });

 it('does not throw error if type matches array of allowed types', () => {
 expect(() => assertHeaderType('JWT', ['JWT', 'at+jwt'])).not.toThrow();
 expect(() => assertHeaderType('at+jwt', ['JWT', 'at+jwt'])).not.toThrow();
 expect(() => assertHeaderType('at+jwt', ['at+jwt', 'application/at+jwt'])).not.toThrow();
 expect(() => assertHeaderType('application/at+jwt', ['at+jwt', 'application/at+jwt'])).not.toThrow();
 });

 it('throws error if type does not match any in array of allowed types', () => {
 expect(() => assertHeaderType('JWT', ['at+jwt', 'application/at+jwt'])).toThrow(
 `Invalid JWT type "JWT". Expected "at+jwt, application/at+jwt".`,
 );
 expect(() => assertHeaderType('invalid', ['at+jwt', 'application/at+jwt'])).toThrow(
 `Invalid JWT type "invalid". Expected "at+jwt, application/at+jwt".`,
 );
 });
});

describe('assertHeaderAlgorithm(alg)', () => {
Expand Down

88 changes: 88 additions & 0 deletions
packages/backend/src/jwt/__tests__/verifyJwt.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import {
 createJwt,
 mockJwks,
 mockJwt,
 mockJwtHeader,
 mockJwtPayload,
 mockOAuthAccessTokenJwtPayload,
 pemEncodedPublicKey,
 publicJwks,
 signedJwt,
 someOtherPublicKey,
} from '../../fixtures';
import { mockSignedOAuthAccessTokenJwt, mockSignedOAuthAccessTokenJwtApplicationTyp } from '../../fixtures/machine';
import { decodeJwt, hasValidSignature, verifyJwt } from '../verifyJwt';

const invalidTokenError = {
Expand DownExpand Up@@ -129,4 +132,89 @@ describe('verifyJwt(jwt, options)', () => {
 const { errors: [error] = [] } = await verifyJwt('invalid-jwt', inputVerifyJwtOptions);
 expect(error).toMatchObject(invalidTokenError);
 });

 it('verifies JWT with default headerType (JWT)', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 issuer: mockJwtPayload.iss,
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 };
 const { data } = await verifyJwt(mockJwt, inputVerifyJwtOptions);
 expect(data).toEqual(mockJwtPayload);
 });

 it('verifies JWT with explicit headerType as string', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 issuer: mockJwtPayload.iss,
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: 'JWT',
 };
 const { data } = await verifyJwt(mockJwt, inputVerifyJwtOptions);
 expect(data).toEqual(mockJwtPayload);
 });

 it('verifies OAuth JWT with headerType as array including at+jwt', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: ['at+jwt', 'application/at+jwt'],
 };
 const { data } = await verifyJwt(mockSignedOAuthAccessTokenJwt, inputVerifyJwtOptions);
 expect(data).toBeDefined();
 expect(data?.sub).toBe('user_2vYVtestTESTtestTESTtestTESTtest');
 });

 it('verifies OAuth JWT with headerType as array including application/at+jwt', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: ['at+jwt', 'application/at+jwt'],
 };
 const { data } = await verifyJwt(mockSignedOAuthAccessTokenJwtApplicationTyp, inputVerifyJwtOptions);
 expect(data).toBeDefined();
 expect(data?.sub).toBe('user_2vYVtestTESTtestTESTtestTESTtest');
 });

 it('rejects JWT when headerType does not match', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 issuer: mockJwtPayload.iss,
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: 'at+jwt',
 };
 const { errors: [error] = [] } = await verifyJwt(mockJwt, inputVerifyJwtOptions);
 expect(error).toBeDefined();
 expect(error?.message).toContain('Invalid JWT type');
 expect(error?.message).toContain('Expected "at+jwt"');
 });

 it('rejects OAuth JWT when headerType does not match', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: 'JWT',
 };
 const { errors: [error] = [] } = await verifyJwt(mockSignedOAuthAccessTokenJwt, inputVerifyJwtOptions);
 expect(error).toBeDefined();
 expect(error?.message).toContain('Invalid JWT type');
 expect(error?.message).toContain('Expected "JWT"');
 });

 it('rejects JWT when headerType array does not include the token type', async () => {
 const jwtWithCustomTyp = createJwt({
 header: { typ: 'custom-type', kid: 'ins_2GIoQhbUpy0hX7B2cVkuTMinXoD' },
 payload: mockOAuthAccessTokenJwtPayload,
 });

 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: ['at+jwt', 'application/at+jwt'],
 };
 const { errors: [error] = [] } = await verifyJwt(jwtWithCustomTyp, inputVerifyJwtOptions);
 expect(error).toBeDefined();
 expect(error?.message).toContain('Invalid JWT type');
 expect(error?.message).toContain('Expected "at+jwt, application/at+jwt"');
 });
});

7 changes: 4 additions & 3 deletions
packages/backend/src/jwt/assertions.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,16 +47,17 @@ export const assertAudienceClaim = (aud?: unknown, audience?: unknown) => {
 }
};

export const assertHeaderType = (typ?: unknown) => {
export const assertHeaderType = (typ?: unknown, allowedTypes: string | string[] = 'JWT') => {
 if (typeof typ === 'undefined') {
 return;
 }

 if (typ !== 'JWT') {
 const allowed = Array.isArray(allowedTypes) ? allowedTypes : [allowedTypes];
 if (!allowed.includes(typ as string)) {
 throw new TokenVerificationError({
 action: TokenVerificationErrorAction.EnsureClerkJWT,
 reason: TokenVerificationErrorReason.TokenInvalid,
 message: `Invalid JWT type ${JSON.stringify(typ)}. Expected "JWT".`,
 message: `Invalid JWT type ${JSON.stringify(typ)}. Expected "${allowed.join(', ')}".`,
 });
 }
};
Expand Down

9 changes: 7 additions & 2 deletions
packages/backend/src/jwt/verifyJwt.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -119,13 +119,18 @@ export type VerifyJwtOptions = {
 * @internal
 */
 key: JsonWebKey | string;
 /**
 * A string or list of allowed [header types](https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.9).
 * @default 'JWT'
 */
 headerType?: string | string[];
};

export async function verifyJwt(
 token: string,
 options: VerifyJwtOptions,
): Promise<JwtReturnType<JwtPayload, TokenVerificationError>> {
 const { audience, authorizedParties, clockSkewInMs, key } = options;
 const { audience, authorizedParties, clockSkewInMs, key, headerType } = options;
 const clockSkew = clockSkewInMs || DEFAULT_CLOCK_SKEW_IN_MS;

 const { data: decoded, errors } = decodeJwt(token);
Expand All@@ -138,7 +143,7 @@ export async function verifyJwt(
 // Header verifications
 const { typ, alg } = header;

 assertHeaderType(typ);
 assertHeaderType(typ, headerType);
 assertHeaderAlgorithm(alg);

 // Payload verifications
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
chore(repo): Backport support for JWTs in OAuth token type (#7308)#7394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wobsoriano
merged 6 commits into

from

Dec 8, 2025
 Merged


chore(repo): Backport support for JWTs in OAuth token type (#7308)
#7394
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
9b02389

feat(backend): Add support for JWTs in OAuth token type (#7308)


wobsoriano Dec 5, 2025
b471ec1

chore: update changeset


wobsoriano Dec 8, 2025
6187459

Merge branch 'vincent-and-the-doctor' into rob/backport-user-4076


wobsoriano Dec 8, 2025
38e8033

Delete .changeset/swift-sheep-notice.md


wobsoriano Dec 8, 2025
05c3adb

Merge branch 'vincent-and-the-doctor' into rob/backport-user-4076


wobsoriano Dec 8, 2025
0990c46

chore: fix missing import


wobsoriano Dec 8, 2025

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


32 changes: 32 additions & 0 deletions
packages/backend/src/api/resources/IdPOAuthAccessToken.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
import type { JwtPayload } from '@clerk/shared/types';

import type { IdPOAuthAccessTokenJSON } from './JSON';

type OAuthJwtPayload = JwtPayload & {
 jti?: string;
 client_id?: string;
 scope?: string;
 scp?: string[];
};

export class IdPOAuthAccessToken {
 constructor(
 readonly id: string,
Expand DownExpand Up@@ -30,4 +39,27 @@ export class IdPOAuthAccessToken {
 data.updated_at,
 );
 }

 /**
 * Creates an IdPOAuthAccessToken from a JWT payload.
 * Maps standard JWT claims and OAuth-specific fields to token properties.
 */
 static fromJwtPayload(payload: JwtPayload, clockSkewInMs = 5000): IdPOAuthAccessToken {
 const oauthPayload = payload as OAuthJwtPayload;

 // Map JWT claims to IdPOAuthAccessToken fields
 return new IdPOAuthAccessToken(
 oauthPayload.jti ?? '',
 oauthPayload.client_id ?? '',
 'oauth_token',
 payload.sub,
 oauthPayload.scp ?? oauthPayload.scope?.split(' ') ?? [],
 false,
 null,
 payload.exp * 1000 <= Date.now() - clockSkewInMs,
 payload.exp,
 payload.iat,
 payload.iat,
 );
 }
}

19 changes: 16 additions & 3 deletions
packages/backend/src/errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export const MachineTokenVerificationErrorCode = {
 TokenInvalid: 'token-invalid',
 InvalidSecretKey: 'secret-key-invalid',
 UnexpectedError: 'unexpected-error',
 TokenVerificationFailed: 'token-verification-failed',
} as const;

export type MachineTokenVerificationErrorCode =
Expand All@@ -82,17 +83,29 @@ export type MachineTokenVerificationErrorCode =
export class MachineTokenVerificationError extends Error {
 code: MachineTokenVerificationErrorCode;
 long_message?: string;
 status: number;
 status?: number;
 action?: TokenVerificationErrorAction;

 constructor({ message, code, status }: { message: string; code: MachineTokenVerificationErrorCode; status: number }) {
 constructor({
 message,
 code,
 status,
 action,
 }: {
 message: string;
 code: MachineTokenVerificationErrorCode;
 status?: number;
 action?: TokenVerificationErrorAction;
 }) {
 super(message);
 Object.setPrototypeOf(this, MachineTokenVerificationError.prototype);

 this.code = code;
 this.status = status;
 this.action = action;
 }

 public getFullMessage() {
 return `${this.message} (code=${this.code}, status=${this.status})`;
 return `${this.message} (code=${this.code}, status=${this.status || 'n/a'})`;
 }
}

12 changes: 12 additions & 0 deletions
packages/backend/src/fixtures/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,18 @@ export const mockJwtPayload = {
 sub: 'user_2GIpXOEpVyJw51rkZn9Kmnc6Sxr',
};

export const mockOAuthAccessTokenJwtPayload = {
 ...mockJwtPayload,
 iss: 'https://clerk.oauth.example.test',
 sub: 'user_2vYVtestTESTtestTESTtestTESTtest',
 client_id: 'client_2VTWUzvGC5UhdJCNx6xG1D98edc',
 scope: 'read:foo write:bar',
 jti: 'oat_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE',
 exp: mockJwtPayload.iat + 300,
 iat: mockJwtPayload.iat,
 nbf: mockJwtPayload.iat - 10,
};

export const mockRsaJwkKid = 'ins_2GIoQhbUpy0hX7B2cVkuTMinXoD';

export const mockRsaJwk = {
Expand Down

14 changes: 14 additions & 0 deletions
packages/backend/src/fixtures/machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,3 +65,17 @@ export const mockMachineAuthResponses = {
 errorMessage: 'Machine token not found',
 },
} as const;

// Valid OAuth access token JWT with typ: "at+jwt"
// Header: {"alg":"RS256","kid":"ins_2GIoQhbUpy0hX7B2cVkuTMinXoD","typ":"at+jwt"}
// Payload: {"client_id":"client_2VTWUzvGC5UhdJCNx6xG1D98edc","sub":"user_2vYVtestTESTtestTESTtestTESTtest","jti":"oat_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE","iat":1666648250,"exp":1666648550,"scope":"read:foo write:bar"}
// Signed with signingJwks, verifiable with mockJwks
export const mockSignedOAuthAccessTokenJwt =
 'eyJhbGciOiJSUzI1NiIsImtpZCI6Imluc18yR0lvUWhiVXB5MGhYN0IyY1ZrdVRNaW5Yb0QiLCJ0eXAiOiJhdCtqd3QifQ.eyJhenAiOiJodHRwczovL2FjY291bnRzLmluc3BpcmVkLnB1bWEtNzQubGNsLmRldiIsImV4cCI6MTY2NjY0ODU1MCwiaWF0IjoxNjY2NjQ4MjUwLCJpc3MiOiJodHRwczovL2NsZXJrLm9hdXRoLmV4YW1wbGUudGVzdCIsIm5iZiI6MTY2NjY0ODI0MCwic2lkIjoic2Vzc18yR2JEQjRlbk5kQ2E1dlMxenBDM1h6Zzl0SzkiLCJzdWIiOiJ1c2VyXzJ2WVZ0ZXN0VEVTVHRlc3RURVNUdGVzdFRFU1R0ZXN0IiwiY2xpZW50X2lkIjoiY2xpZW50XzJWVFdVenZHQzVVaGRKQ054NnhHMUQ5OGVkYyIsInNjb3BlIjoicmVhZDpmb28gd3JpdGU6YmFyIiwianRpIjoib2F0XzJ4S2E5Qmd2N054TVJERnlRdzhMcFozY1RtVTF2SGpFIn0.Wgw5L2u0nGkxF9Y-5Dje414UEkxq2Fu3_VePeh1-GehCugi0eIXV-QyiXp1ba4pxWWbCfIC_hihzKjwnVb5wrhzqyw8FJpvnvtrHEjt-zSijpS7WlO7ScJDY-PE8zgH-CICnS2CKYSkP3Rbzka9XY_Z6ieUzmBSFdA_0K8pQOdDHv70y04dnL1CjL6XToncnvezioL388Y1UTqlhll8b2Pm4EI7rGdHVKzLcKnKoYpgsBPZLmO7qGPJ5BkHvmg3gOSkmIiziFaEZkoXvjbvEUAt5qEqzaADSaFP6QhRYNtr1s4OD9uj0SK6QaoZTj69XYFuNMNnm7zN_WxvPBMTq9g';

// Valid OAuth access token JWT with typ: "application/at+jwt"
// Header: {"alg":"RS256","kid":"ins_2GIoQhbUpy0hX7B2cVkuTMinXoD","typ":"application/at+jwt"}
// Payload: {"client_id":"client_2VTWUzvGC5UhdJCNx6xG1D98edc","sub":"user_2vYVtestTESTtestTESTtestTESTtest","jti":"oat_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE","iat":1666648250,"exp":1666648550,"scope":"read:foo write:bar"}
// Signed with signingJwks, verifiable with mockJwks
export const mockSignedOAuthAccessTokenJwtApplicationTyp =
 'eyJhbGciOiJSUzI1NiIsImtpZCI6Imluc18yR0lvUWhiVXB5MGhYN0IyY1ZrdVRNaW5Yb0QiLCJ0eXAiOiJhcHBsaWNhdGlvbi9hdCtqd3QifQ.eyJhenAiOiJodHRwczovL2FjY291bnRzLmluc3BpcmVkLnB1bWEtNzQubGNsLmRldiIsImV4cCI6MTY2NjY0ODU1MCwiaWF0IjoxNjY2NjQ4MjUwLCJpc3MiOiJodHRwczovL2NsZXJrLm9hdXRoLmV4YW1wbGUudGVzdCIsIm5iZiI6MTY2NjY0ODI0MCwic2lkIjoic2Vzc18yR2JEQjRlbk5kQ2E1dlMxenBDM1h6Zzl0SzkiLCJzdWIiOiJ1c2VyXzJ2WVZ0ZXN0VEVTVHRlc3RURVNUdGVzdFRFU1R0ZXN0IiwiY2xpZW50X2lkIjoiY2xpZW50XzJWVFdVenZHQzVVaGRKQ054NnhHMUQ5OGVkYyIsInNjb3BlIjoicmVhZDpmb28gd3JpdGU6YmFyIiwianRpIjoib2F0XzJ4S2E5Qmd2N054TVJERnlRdzhMcFozY1RtVTF2SGpFIn0.GPTvB4doScjzQD0kRMhMebVDREjwcrMWK73OP_kFc3pl0gST29BlWrKMBi8wRxoSJBc2ukO10BPhGxnh15PxCNLyk6xQFWhFBA7XpVxY4T_VHPDU5FEOocPQuqcqZ4cA1GDJST-BH511fxoJnv4kfha46IvQiUMvWCacIj_w12qfZigeb208mTDIeoJQtlYb-sD9u__CVvB4uZOqGb0lIL5-cCbhMPFg-6GQ2DhZ-Eq5tw7oyO6lPrsAaFN9u-59SLvips364ieYNpgcr9Dbo5PDvUSltqxoIXTDFo4esWw6XwUjnGfqCh34LYAhv_2QF2U0-GASBEn4GK-Wfv3wXg';

36 changes: 34 additions & 2 deletions
packages/backend/src/jwt/__tests__/assertions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -106,15 +106,47 @@ describe('assertAudienceClaim(audience?, aud?)', () => {
 });
});

describe('assertHeaderType(typ?)', () => {
describe('assertHeaderType(typ?, allowedTypes?)', () => {
 it('does not throw error if type is missing', () => {
 expect(() => assertHeaderType(undefined)).not.toThrow();
 expect(() => assertHeaderType(undefined, 'JWT')).not.toThrow();
 expect(() => assertHeaderType(undefined, ['JWT', 'at+jwt'])).not.toThrow();
 });

 it('throws error if type is not JWT', () => {
 it('does not throw error if type matches default allowed type (JWT)', () => {
 expect(() => assertHeaderType('JWT')).not.toThrow();
 });

 it('throws error if type is not JWT (default)', () => {
 expect(() => assertHeaderType('')).toThrow(`Invalid JWT type "". Expected "JWT".`);
 expect(() => assertHeaderType('Aloha')).toThrow(`Invalid JWT type "Aloha". Expected "JWT".`);
 });

 it('does not throw error if type matches single custom allowed type', () => {
 expect(() => assertHeaderType('at+jwt', 'at+jwt')).not.toThrow();
 expect(() => assertHeaderType('application/at+jwt', 'application/at+jwt')).not.toThrow();
 });

 it('throws error if type does not match single custom allowed type', () => {
 expect(() => assertHeaderType('JWT', 'at+jwt')).toThrow(`Invalid JWT type "JWT". Expected "at+jwt".`);
 expect(() => assertHeaderType('at+jwt', 'JWT')).toThrow(`Invalid JWT type "at+jwt". Expected "JWT".`);
 });

 it('does not throw error if type matches array of allowed types', () => {
 expect(() => assertHeaderType('JWT', ['JWT', 'at+jwt'])).not.toThrow();
 expect(() => assertHeaderType('at+jwt', ['JWT', 'at+jwt'])).not.toThrow();
 expect(() => assertHeaderType('at+jwt', ['at+jwt', 'application/at+jwt'])).not.toThrow();
 expect(() => assertHeaderType('application/at+jwt', ['at+jwt', 'application/at+jwt'])).not.toThrow();
 });

 it('throws error if type does not match any in array of allowed types', () => {
 expect(() => assertHeaderType('JWT', ['at+jwt', 'application/at+jwt'])).toThrow(
 `Invalid JWT type "JWT". Expected "at+jwt, application/at+jwt".`,
 );
 expect(() => assertHeaderType('invalid', ['at+jwt', 'application/at+jwt'])).toThrow(
 `Invalid JWT type "invalid". Expected "at+jwt, application/at+jwt".`,
 );
 });
});

describe('assertHeaderAlgorithm(alg)', () => {
Expand Down

88 changes: 88 additions & 0 deletions
packages/backend/src/jwt/__tests__/verifyJwt.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import {
 createJwt,
 mockJwks,
 mockJwt,
 mockJwtHeader,
 mockJwtPayload,
 mockOAuthAccessTokenJwtPayload,
 pemEncodedPublicKey,
 publicJwks,
 signedJwt,
 someOtherPublicKey,
} from '../../fixtures';
import { mockSignedOAuthAccessTokenJwt, mockSignedOAuthAccessTokenJwtApplicationTyp } from '../../fixtures/machine';
import { decodeJwt, hasValidSignature, verifyJwt } from '../verifyJwt';

const invalidTokenError = {
Expand DownExpand Up@@ -129,4 +132,89 @@ describe('verifyJwt(jwt, options)', () => {
 const { errors: [error] = [] } = await verifyJwt('invalid-jwt', inputVerifyJwtOptions);
 expect(error).toMatchObject(invalidTokenError);
 });

 it('verifies JWT with default headerType (JWT)', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 issuer: mockJwtPayload.iss,
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 };
 const { data } = await verifyJwt(mockJwt, inputVerifyJwtOptions);
 expect(data).toEqual(mockJwtPayload);
 });

 it('verifies JWT with explicit headerType as string', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 issuer: mockJwtPayload.iss,
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: 'JWT',
 };
 const { data } = await verifyJwt(mockJwt, inputVerifyJwtOptions);
 expect(data).toEqual(mockJwtPayload);
 });

 it('verifies OAuth JWT with headerType as array including at+jwt', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: ['at+jwt', 'application/at+jwt'],
 };
 const { data } = await verifyJwt(mockSignedOAuthAccessTokenJwt, inputVerifyJwtOptions);
 expect(data).toBeDefined();
 expect(data?.sub).toBe('user_2vYVtestTESTtestTESTtestTESTtest');
 });

 it('verifies OAuth JWT with headerType as array including application/at+jwt', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: ['at+jwt', 'application/at+jwt'],
 };
 const { data } = await verifyJwt(mockSignedOAuthAccessTokenJwtApplicationTyp, inputVerifyJwtOptions);
 expect(data).toBeDefined();
 expect(data?.sub).toBe('user_2vYVtestTESTtestTESTtestTESTtest');
 });

 it('rejects JWT when headerType does not match', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 issuer: mockJwtPayload.iss,
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: 'at+jwt',
 };
 const { errors: [error] = [] } = await verifyJwt(mockJwt, inputVerifyJwtOptions);
 expect(error).toBeDefined();
 expect(error?.message).toContain('Invalid JWT type');
 expect(error?.message).toContain('Expected "at+jwt"');
 });

 it('rejects OAuth JWT when headerType does not match', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: 'JWT',
 };
 const { errors: [error] = [] } = await verifyJwt(mockSignedOAuthAccessTokenJwt, inputVerifyJwtOptions);
 expect(error).toBeDefined();
 expect(error?.message).toContain('Invalid JWT type');
 expect(error?.message).toContain('Expected "JWT"');
 });

 it('rejects JWT when headerType array does not include the token type', async () => {
 const jwtWithCustomTyp = createJwt({
 header: { typ: 'custom-type', kid: 'ins_2GIoQhbUpy0hX7B2cVkuTMinXoD' },
 payload: mockOAuthAccessTokenJwtPayload,
 });

 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: ['at+jwt', 'application/at+jwt'],
 };
 const { errors: [error] = [] } = await verifyJwt(jwtWithCustomTyp, inputVerifyJwtOptions);
 expect(error).toBeDefined();
 expect(error?.message).toContain('Invalid JWT type');
 expect(error?.message).toContain('Expected "at+jwt, application/at+jwt"');
 });
});

7 changes: 4 additions & 3 deletions
packages/backend/src/jwt/assertions.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,16 +47,17 @@ export const assertAudienceClaim = (aud?: unknown, audience?: unknown) => {
 }
};

export const assertHeaderType = (typ?: unknown) => {
export const assertHeaderType = (typ?: unknown, allowedTypes: string | string[] = 'JWT') => {
 if (typeof typ === 'undefined') {
 return;
 }

 if (typ !== 'JWT') {
 const allowed = Array.isArray(allowedTypes) ? allowedTypes : [allowedTypes];
 if (!allowed.includes(typ as string)) {
 throw new TokenVerificationError({
 action: TokenVerificationErrorAction.EnsureClerkJWT,
 reason: TokenVerificationErrorReason.TokenInvalid,
 message: `Invalid JWT type ${JSON.stringify(typ)}. Expected "JWT".`,
 message: `Invalid JWT type ${JSON.stringify(typ)}. Expected "${allowed.join(', ')}".`,
 });
 }
};
Expand Down

9 changes: 7 additions & 2 deletions
packages/backend/src/jwt/verifyJwt.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -119,13 +119,18 @@ export type VerifyJwtOptions = {
 * @internal
 */
 key: JsonWebKey | string;
 /**
 * A string or list of allowed [header types](https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.9).
 * @default 'JWT'
 */
 headerType?: string | string[];
};

export async function verifyJwt(
 token: string,
 options: VerifyJwtOptions,
): Promise<JwtReturnType<JwtPayload, TokenVerificationError>> {
 const { audience, authorizedParties, clockSkewInMs, key } = options;
 const { audience, authorizedParties, clockSkewInMs, key, headerType } = options;
 const clockSkew = clockSkewInMs || DEFAULT_CLOCK_SKEW_IN_MS;

 const { data: decoded, errors } = decodeJwt(token);
Expand All@@ -138,7 +143,7 @@ export async function verifyJwt(
 // Header verifications
 const { typ, alg } = header;

 assertHeaderType(typ);
 assertHeaderType(typ, headerType);
 assertHeaderAlgorithm(alg);

 // Payload verifications
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
chore(repo): Backport support for JWTs in OAuth token type (#7308)#7394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wobsoriano
merged 6 commits into

from

Dec 8, 2025
 Merged


chore(repo): Backport support for JWTs in OAuth token type (#7308)
#7394
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
9b02389

feat(backend): Add support for JWTs in OAuth token type (#7308)


wobsoriano Dec 5, 2025
b471ec1

chore: update changeset


wobsoriano Dec 8, 2025
6187459

Merge branch 'vincent-and-the-doctor' into rob/backport-user-4076


wobsoriano Dec 8, 2025
38e8033

Delete .changeset/swift-sheep-notice.md


wobsoriano Dec 8, 2025
05c3adb

Merge branch 'vincent-and-the-doctor' into rob/backport-user-4076


wobsoriano Dec 8, 2025
0990c46

chore: fix missing import


wobsoriano Dec 8, 2025

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


32 changes: 32 additions & 0 deletions
packages/backend/src/api/resources/IdPOAuthAccessToken.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
import type { JwtPayload } from '@clerk/shared/types';

import type { IdPOAuthAccessTokenJSON } from './JSON';

type OAuthJwtPayload = JwtPayload & {
 jti?: string;
 client_id?: string;
 scope?: string;
 scp?: string[];
};

export class IdPOAuthAccessToken {
 constructor(
 readonly id: string,
Expand DownExpand Up@@ -30,4 +39,27 @@ export class IdPOAuthAccessToken {
 data.updated_at,
 );
 }

 /**
 * Creates an IdPOAuthAccessToken from a JWT payload.
 * Maps standard JWT claims and OAuth-specific fields to token properties.
 */
 static fromJwtPayload(payload: JwtPayload, clockSkewInMs = 5000): IdPOAuthAccessToken {
 const oauthPayload = payload as OAuthJwtPayload;

 // Map JWT claims to IdPOAuthAccessToken fields
 return new IdPOAuthAccessToken(
 oauthPayload.jti ?? '',
 oauthPayload.client_id ?? '',
 'oauth_token',
 payload.sub,
 oauthPayload.scp ?? oauthPayload.scope?.split(' ') ?? [],
 false,
 null,
 payload.exp * 1000 <= Date.now() - clockSkewInMs,
 payload.exp,
 payload.iat,
 payload.iat,
 );
 }
}

19 changes: 16 additions & 3 deletions
packages/backend/src/errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export const MachineTokenVerificationErrorCode = {
 TokenInvalid: 'token-invalid',
 InvalidSecretKey: 'secret-key-invalid',
 UnexpectedError: 'unexpected-error',
 TokenVerificationFailed: 'token-verification-failed',
} as const;

export type MachineTokenVerificationErrorCode =
Expand All@@ -82,17 +83,29 @@ export type MachineTokenVerificationErrorCode =
export class MachineTokenVerificationError extends Error {
 code: MachineTokenVerificationErrorCode;
 long_message?: string;
 status: number;
 status?: number;
 action?: TokenVerificationErrorAction;

 constructor({ message, code, status }: { message: string; code: MachineTokenVerificationErrorCode; status: number }) {
 constructor({
 message,
 code,
 status,
 action,
 }: {
 message: string;
 code: MachineTokenVerificationErrorCode;
 status?: number;
 action?: TokenVerificationErrorAction;
 }) {
 super(message);
 Object.setPrototypeOf(this, MachineTokenVerificationError.prototype);

 this.code = code;
 this.status = status;
 this.action = action;
 }

 public getFullMessage() {
 return `${this.message} (code=${this.code}, status=${this.status})`;
 return `${this.message} (code=${this.code}, status=${this.status || 'n/a'})`;
 }
}

12 changes: 12 additions & 0 deletions
packages/backend/src/fixtures/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,18 @@ export const mockJwtPayload = {
 sub: 'user_2GIpXOEpVyJw51rkZn9Kmnc6Sxr',
};

export const mockOAuthAccessTokenJwtPayload = {
 ...mockJwtPayload,
 iss: 'https://clerk.oauth.example.test',
 sub: 'user_2vYVtestTESTtestTESTtestTESTtest',
 client_id: 'client_2VTWUzvGC5UhdJCNx6xG1D98edc',
 scope: 'read:foo write:bar',
 jti: 'oat_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE',
 exp: mockJwtPayload.iat + 300,
 iat: mockJwtPayload.iat,
 nbf: mockJwtPayload.iat - 10,
};

export const mockRsaJwkKid = 'ins_2GIoQhbUpy0hX7B2cVkuTMinXoD';

export const mockRsaJwk = {
Expand Down

14 changes: 14 additions & 0 deletions
packages/backend/src/fixtures/machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,3 +65,17 @@ export const mockMachineAuthResponses = {
 errorMessage: 'Machine token not found',
 },
} as const;

// Valid OAuth access token JWT with typ: "at+jwt"
// Header: {"alg":"RS256","kid":"ins_2GIoQhbUpy0hX7B2cVkuTMinXoD","typ":"at+jwt"}
// Payload: {"client_id":"client_2VTWUzvGC5UhdJCNx6xG1D98edc","sub":"user_2vYVtestTESTtestTESTtestTESTtest","jti":"oat_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE","iat":1666648250,"exp":1666648550,"scope":"read:foo write:bar"}
// Signed with signingJwks, verifiable with mockJwks
export const mockSignedOAuthAccessTokenJwt =
 'eyJhbGciOiJSUzI1NiIsImtpZCI6Imluc18yR0lvUWhiVXB5MGhYN0IyY1ZrdVRNaW5Yb0QiLCJ0eXAiOiJhdCtqd3QifQ.eyJhenAiOiJodHRwczovL2FjY291bnRzLmluc3BpcmVkLnB1bWEtNzQubGNsLmRldiIsImV4cCI6MTY2NjY0ODU1MCwiaWF0IjoxNjY2NjQ4MjUwLCJpc3MiOiJodHRwczovL2NsZXJrLm9hdXRoLmV4YW1wbGUudGVzdCIsIm5iZiI6MTY2NjY0ODI0MCwic2lkIjoic2Vzc18yR2JEQjRlbk5kQ2E1dlMxenBDM1h6Zzl0SzkiLCJzdWIiOiJ1c2VyXzJ2WVZ0ZXN0VEVTVHRlc3RURVNUdGVzdFRFU1R0ZXN0IiwiY2xpZW50X2lkIjoiY2xpZW50XzJWVFdVenZHQzVVaGRKQ054NnhHMUQ5OGVkYyIsInNjb3BlIjoicmVhZDpmb28gd3JpdGU6YmFyIiwianRpIjoib2F0XzJ4S2E5Qmd2N054TVJERnlRdzhMcFozY1RtVTF2SGpFIn0.Wgw5L2u0nGkxF9Y-5Dje414UEkxq2Fu3_VePeh1-GehCugi0eIXV-QyiXp1ba4pxWWbCfIC_hihzKjwnVb5wrhzqyw8FJpvnvtrHEjt-zSijpS7WlO7ScJDY-PE8zgH-CICnS2CKYSkP3Rbzka9XY_Z6ieUzmBSFdA_0K8pQOdDHv70y04dnL1CjL6XToncnvezioL388Y1UTqlhll8b2Pm4EI7rGdHVKzLcKnKoYpgsBPZLmO7qGPJ5BkHvmg3gOSkmIiziFaEZkoXvjbvEUAt5qEqzaADSaFP6QhRYNtr1s4OD9uj0SK6QaoZTj69XYFuNMNnm7zN_WxvPBMTq9g';

// Valid OAuth access token JWT with typ: "application/at+jwt"
// Header: {"alg":"RS256","kid":"ins_2GIoQhbUpy0hX7B2cVkuTMinXoD","typ":"application/at+jwt"}
// Payload: {"client_id":"client_2VTWUzvGC5UhdJCNx6xG1D98edc","sub":"user_2vYVtestTESTtestTESTtestTESTtest","jti":"oat_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE","iat":1666648250,"exp":1666648550,"scope":"read:foo write:bar"}
// Signed with signingJwks, verifiable with mockJwks
export const mockSignedOAuthAccessTokenJwtApplicationTyp =
 'eyJhbGciOiJSUzI1NiIsImtpZCI6Imluc18yR0lvUWhiVXB5MGhYN0IyY1ZrdVRNaW5Yb0QiLCJ0eXAiOiJhcHBsaWNhdGlvbi9hdCtqd3QifQ.eyJhenAiOiJodHRwczovL2FjY291bnRzLmluc3BpcmVkLnB1bWEtNzQubGNsLmRldiIsImV4cCI6MTY2NjY0ODU1MCwiaWF0IjoxNjY2NjQ4MjUwLCJpc3MiOiJodHRwczovL2NsZXJrLm9hdXRoLmV4YW1wbGUudGVzdCIsIm5iZiI6MTY2NjY0ODI0MCwic2lkIjoic2Vzc18yR2JEQjRlbk5kQ2E1dlMxenBDM1h6Zzl0SzkiLCJzdWIiOiJ1c2VyXzJ2WVZ0ZXN0VEVTVHRlc3RURVNUdGVzdFRFU1R0ZXN0IiwiY2xpZW50X2lkIjoiY2xpZW50XzJWVFdVenZHQzVVaGRKQ054NnhHMUQ5OGVkYyIsInNjb3BlIjoicmVhZDpmb28gd3JpdGU6YmFyIiwianRpIjoib2F0XzJ4S2E5Qmd2N054TVJERnlRdzhMcFozY1RtVTF2SGpFIn0.GPTvB4doScjzQD0kRMhMebVDREjwcrMWK73OP_kFc3pl0gST29BlWrKMBi8wRxoSJBc2ukO10BPhGxnh15PxCNLyk6xQFWhFBA7XpVxY4T_VHPDU5FEOocPQuqcqZ4cA1GDJST-BH511fxoJnv4kfha46IvQiUMvWCacIj_w12qfZigeb208mTDIeoJQtlYb-sD9u__CVvB4uZOqGb0lIL5-cCbhMPFg-6GQ2DhZ-Eq5tw7oyO6lPrsAaFN9u-59SLvips364ieYNpgcr9Dbo5PDvUSltqxoIXTDFo4esWw6XwUjnGfqCh34LYAhv_2QF2U0-GASBEn4GK-Wfv3wXg';

36 changes: 34 additions & 2 deletions
packages/backend/src/jwt/__tests__/assertions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -106,15 +106,47 @@ describe('assertAudienceClaim(audience?, aud?)', () => {
 });
});

describe('assertHeaderType(typ?)', () => {
describe('assertHeaderType(typ?, allowedTypes?)', () => {
 it('does not throw error if type is missing', () => {
 expect(() => assertHeaderType(undefined)).not.toThrow();
 expect(() => assertHeaderType(undefined, 'JWT')).not.toThrow();
 expect(() => assertHeaderType(undefined, ['JWT', 'at+jwt'])).not.toThrow();
 });

 it('throws error if type is not JWT', () => {
 it('does not throw error if type matches default allowed type (JWT)', () => {
 expect(() => assertHeaderType('JWT')).not.toThrow();
 });

 it('throws error if type is not JWT (default)', () => {
 expect(() => assertHeaderType('')).toThrow(`Invalid JWT type "". Expected "JWT".`);
 expect(() => assertHeaderType('Aloha')).toThrow(`Invalid JWT type "Aloha". Expected "JWT".`);
 });

 it('does not throw error if type matches single custom allowed type', () => {
 expect(() => assertHeaderType('at+jwt', 'at+jwt')).not.toThrow();
 expect(() => assertHeaderType('application/at+jwt', 'application/at+jwt')).not.toThrow();
 });

 it('throws error if type does not match single custom allowed type', () => {
 expect(() => assertHeaderType('JWT', 'at+jwt')).toThrow(`Invalid JWT type "JWT". Expected "at+jwt".`);
 expect(() => assertHeaderType('at+jwt', 'JWT')).toThrow(`Invalid JWT type "at+jwt". Expected "JWT".`);
 });

 it('does not throw error if type matches array of allowed types', () => {
 expect(() => assertHeaderType('JWT', ['JWT', 'at+jwt'])).not.toThrow();
 expect(() => assertHeaderType('at+jwt', ['JWT', 'at+jwt'])).not.toThrow();
 expect(() => assertHeaderType('at+jwt', ['at+jwt', 'application/at+jwt'])).not.toThrow();
 expect(() => assertHeaderType('application/at+jwt', ['at+jwt', 'application/at+jwt'])).not.toThrow();
 });

 it('throws error if type does not match any in array of allowed types', () => {
 expect(() => assertHeaderType('JWT', ['at+jwt', 'application/at+jwt'])).toThrow(
 `Invalid JWT type "JWT". Expected "at+jwt, application/at+jwt".`,
 );
 expect(() => assertHeaderType('invalid', ['at+jwt', 'application/at+jwt'])).toThrow(
 `Invalid JWT type "invalid". Expected "at+jwt, application/at+jwt".`,
 );
 });
});

describe('assertHeaderAlgorithm(alg)', () => {
Expand Down

88 changes: 88 additions & 0 deletions
packages/backend/src/jwt/__tests__/verifyJwt.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import {
 createJwt,
 mockJwks,
 mockJwt,
 mockJwtHeader,
 mockJwtPayload,
 mockOAuthAccessTokenJwtPayload,
 pemEncodedPublicKey,
 publicJwks,
 signedJwt,
 someOtherPublicKey,
} from '../../fixtures';
import { mockSignedOAuthAccessTokenJwt, mockSignedOAuthAccessTokenJwtApplicationTyp } from '../../fixtures/machine';
import { decodeJwt, hasValidSignature, verifyJwt } from '../verifyJwt';

const invalidTokenError = {
Expand DownExpand Up@@ -129,4 +132,89 @@ describe('verifyJwt(jwt, options)', () => {
 const { errors: [error] = [] } = await verifyJwt('invalid-jwt', inputVerifyJwtOptions);
 expect(error).toMatchObject(invalidTokenError);
 });

 it('verifies JWT with default headerType (JWT)', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 issuer: mockJwtPayload.iss,
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 };
 const { data } = await verifyJwt(mockJwt, inputVerifyJwtOptions);
 expect(data).toEqual(mockJwtPayload);
 });

 it('verifies JWT with explicit headerType as string', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 issuer: mockJwtPayload.iss,
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: 'JWT',
 };
 const { data } = await verifyJwt(mockJwt, inputVerifyJwtOptions);
 expect(data).toEqual(mockJwtPayload);
 });

 it('verifies OAuth JWT with headerType as array including at+jwt', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: ['at+jwt', 'application/at+jwt'],
 };
 const { data } = await verifyJwt(mockSignedOAuthAccessTokenJwt, inputVerifyJwtOptions);
 expect(data).toBeDefined();
 expect(data?.sub).toBe('user_2vYVtestTESTtestTESTtestTESTtest');
 });

 it('verifies OAuth JWT with headerType as array including application/at+jwt', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: ['at+jwt', 'application/at+jwt'],
 };
 const { data } = await verifyJwt(mockSignedOAuthAccessTokenJwtApplicationTyp, inputVerifyJwtOptions);
 expect(data).toBeDefined();
 expect(data?.sub).toBe('user_2vYVtestTESTtestTESTtestTESTtest');
 });

 it('rejects JWT when headerType does not match', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 issuer: mockJwtPayload.iss,
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: 'at+jwt',
 };
 const { errors: [error] = [] } = await verifyJwt(mockJwt, inputVerifyJwtOptions);
 expect(error).toBeDefined();
 expect(error?.message).toContain('Invalid JWT type');
 expect(error?.message).toContain('Expected "at+jwt"');
 });

 it('rejects OAuth JWT when headerType does not match', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: 'JWT',
 };
 const { errors: [error] = [] } = await verifyJwt(mockSignedOAuthAccessTokenJwt, inputVerifyJwtOptions);
 expect(error).toBeDefined();
 expect(error?.message).toContain('Invalid JWT type');
 expect(error?.message).toContain('Expected "JWT"');
 });

 it('rejects JWT when headerType array does not include the token type', async () => {
 const jwtWithCustomTyp = createJwt({
 header: { typ: 'custom-type', kid: 'ins_2GIoQhbUpy0hX7B2cVkuTMinXoD' },
 payload: mockOAuthAccessTokenJwtPayload,
 });

 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: ['at+jwt', 'application/at+jwt'],
 };
 const { errors: [error] = [] } = await verifyJwt(jwtWithCustomTyp, inputVerifyJwtOptions);
 expect(error).toBeDefined();
 expect(error?.message).toContain('Invalid JWT type');
 expect(error?.message).toContain('Expected "at+jwt, application/at+jwt"');
 });
});

7 changes: 4 additions & 3 deletions
packages/backend/src/jwt/assertions.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,16 +47,17 @@ export const assertAudienceClaim = (aud?: unknown, audience?: unknown) => {
 }
};

export const assertHeaderType = (typ?: unknown) => {
export const assertHeaderType = (typ?: unknown, allowedTypes: string | string[] = 'JWT') => {
 if (typeof typ === 'undefined') {
 return;
 }

 if (typ !== 'JWT') {
 const allowed = Array.isArray(allowedTypes) ? allowedTypes : [allowedTypes];
 if (!allowed.includes(typ as string)) {
 throw new TokenVerificationError({
 action: TokenVerificationErrorAction.EnsureClerkJWT,
 reason: TokenVerificationErrorReason.TokenInvalid,
 message: `Invalid JWT type ${JSON.stringify(typ)}. Expected "JWT".`,
 message: `Invalid JWT type ${JSON.stringify(typ)}. Expected "${allowed.join(', ')}".`,
 });
 }
};
Expand Down

9 changes: 7 additions & 2 deletions
packages/backend/src/jwt/verifyJwt.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -119,13 +119,18 @@ export type VerifyJwtOptions = {
 * @internal
 */
 key: JsonWebKey | string;
 /**
 * A string or list of allowed [header types](https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.9).
 * @default 'JWT'
 */
 headerType?: string | string[];
};

export async function verifyJwt(
 token: string,
 options: VerifyJwtOptions,
): Promise<JwtReturnType<JwtPayload, TokenVerificationError>> {
 const { audience, authorizedParties, clockSkewInMs, key } = options;
 const { audience, authorizedParties, clockSkewInMs, key, headerType } = options;
 const clockSkew = clockSkewInMs || DEFAULT_CLOCK_SKEW_IN_MS;

 const { data: decoded, errors } = decodeJwt(token);
Expand All@@ -138,7 +143,7 @@ export async function verifyJwt(
 // Header verifications
 const { typ, alg } = header;

 assertHeaderType(typ);
 assertHeaderType(typ, headerType);
 assertHeaderAlgorithm(alg);

 // Payload verifications
Expand Down
Loading
Loading

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

Skip to content
chore(repo): Backport support for JWTs in OAuth token type (#7308)#7394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

wobsoriano
merged 6 commits into

from

Dec 8, 2025
 Merged


chore(repo): Backport support for JWTs in OAuth token type (#7308)
#7394
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
9b02389

feat(backend): Add support for JWTs in OAuth token type (#7308)


wobsoriano Dec 5, 2025
b471ec1

chore: update changeset


wobsoriano Dec 8, 2025
6187459

Merge branch 'vincent-and-the-doctor' into rob/backport-user-4076


wobsoriano Dec 8, 2025
38e8033

Delete .changeset/swift-sheep-notice.md


wobsoriano Dec 8, 2025
05c3adb

Merge branch 'vincent-and-the-doctor' into rob/backport-user-4076


wobsoriano Dec 8, 2025
0990c46

chore: fix missing import


wobsoriano Dec 8, 2025

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


32 changes: 32 additions & 0 deletions
packages/backend/src/api/resources/IdPOAuthAccessToken.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
import type { JwtPayload } from '@clerk/shared/types';

import type { IdPOAuthAccessTokenJSON } from './JSON';

type OAuthJwtPayload = JwtPayload & {
 jti?: string;
 client_id?: string;
 scope?: string;
 scp?: string[];
};

export class IdPOAuthAccessToken {
 constructor(
 readonly id: string,
Expand DownExpand Up@@ -30,4 +39,27 @@ export class IdPOAuthAccessToken {
 data.updated_at,
 );
 }

 /**
 * Creates an IdPOAuthAccessToken from a JWT payload.
 * Maps standard JWT claims and OAuth-specific fields to token properties.
 */
 static fromJwtPayload(payload: JwtPayload, clockSkewInMs = 5000): IdPOAuthAccessToken {
 const oauthPayload = payload as OAuthJwtPayload;

 // Map JWT claims to IdPOAuthAccessToken fields
 return new IdPOAuthAccessToken(
 oauthPayload.jti ?? '',
 oauthPayload.client_id ?? '',
 'oauth_token',
 payload.sub,
 oauthPayload.scp ?? oauthPayload.scope?.split(' ') ?? [],
 false,
 null,
 payload.exp * 1000 <= Date.now() - clockSkewInMs,
 payload.exp,
 payload.iat,
 payload.iat,
 );
 }
}

19 changes: 16 additions & 3 deletions
packages/backend/src/errors.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -74,6 +74,7 @@ export const MachineTokenVerificationErrorCode = {
 TokenInvalid: 'token-invalid',
 InvalidSecretKey: 'secret-key-invalid',
 UnexpectedError: 'unexpected-error',
 TokenVerificationFailed: 'token-verification-failed',
} as const;

export type MachineTokenVerificationErrorCode =
Expand All@@ -82,17 +83,29 @@ export type MachineTokenVerificationErrorCode =
export class MachineTokenVerificationError extends Error {
 code: MachineTokenVerificationErrorCode;
 long_message?: string;
 status: number;
 status?: number;
 action?: TokenVerificationErrorAction;

 constructor({ message, code, status }: { message: string; code: MachineTokenVerificationErrorCode; status: number }) {
 constructor({
 message,
 code,
 status,
 action,
 }: {
 message: string;
 code: MachineTokenVerificationErrorCode;
 status?: number;
 action?: TokenVerificationErrorAction;
 }) {
 super(message);
 Object.setPrototypeOf(this, MachineTokenVerificationError.prototype);

 this.code = code;
 this.status = status;
 this.action = action;
 }

 public getFullMessage() {
 return `${this.message} (code=${this.code}, status=${this.status})`;
 return `${this.message} (code=${this.code}, status=${this.status || 'n/a'})`;
 }
}

12 changes: 12 additions & 0 deletions
packages/backend/src/fixtures/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,6 +33,18 @@ export const mockJwtPayload = {
 sub: 'user_2GIpXOEpVyJw51rkZn9Kmnc6Sxr',
};

export const mockOAuthAccessTokenJwtPayload = {
 ...mockJwtPayload,
 iss: 'https://clerk.oauth.example.test',
 sub: 'user_2vYVtestTESTtestTESTtestTESTtest',
 client_id: 'client_2VTWUzvGC5UhdJCNx6xG1D98edc',
 scope: 'read:foo write:bar',
 jti: 'oat_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE',
 exp: mockJwtPayload.iat + 300,
 iat: mockJwtPayload.iat,
 nbf: mockJwtPayload.iat - 10,
};

export const mockRsaJwkKid = 'ins_2GIoQhbUpy0hX7B2cVkuTMinXoD';

export const mockRsaJwk = {
Expand Down

14 changes: 14 additions & 0 deletions
packages/backend/src/fixtures/machine.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -65,3 +65,17 @@ export const mockMachineAuthResponses = {
 errorMessage: 'Machine token not found',
 },
} as const;

// Valid OAuth access token JWT with typ: "at+jwt"
// Header: {"alg":"RS256","kid":"ins_2GIoQhbUpy0hX7B2cVkuTMinXoD","typ":"at+jwt"}
// Payload: {"client_id":"client_2VTWUzvGC5UhdJCNx6xG1D98edc","sub":"user_2vYVtestTESTtestTESTtestTESTtest","jti":"oat_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE","iat":1666648250,"exp":1666648550,"scope":"read:foo write:bar"}
// Signed with signingJwks, verifiable with mockJwks
export const mockSignedOAuthAccessTokenJwt =
 'eyJhbGciOiJSUzI1NiIsImtpZCI6Imluc18yR0lvUWhiVXB5MGhYN0IyY1ZrdVRNaW5Yb0QiLCJ0eXAiOiJhdCtqd3QifQ.eyJhenAiOiJodHRwczovL2FjY291bnRzLmluc3BpcmVkLnB1bWEtNzQubGNsLmRldiIsImV4cCI6MTY2NjY0ODU1MCwiaWF0IjoxNjY2NjQ4MjUwLCJpc3MiOiJodHRwczovL2NsZXJrLm9hdXRoLmV4YW1wbGUudGVzdCIsIm5iZiI6MTY2NjY0ODI0MCwic2lkIjoic2Vzc18yR2JEQjRlbk5kQ2E1dlMxenBDM1h6Zzl0SzkiLCJzdWIiOiJ1c2VyXzJ2WVZ0ZXN0VEVTVHRlc3RURVNUdGVzdFRFU1R0ZXN0IiwiY2xpZW50X2lkIjoiY2xpZW50XzJWVFdVenZHQzVVaGRKQ054NnhHMUQ5OGVkYyIsInNjb3BlIjoicmVhZDpmb28gd3JpdGU6YmFyIiwianRpIjoib2F0XzJ4S2E5Qmd2N054TVJERnlRdzhMcFozY1RtVTF2SGpFIn0.Wgw5L2u0nGkxF9Y-5Dje414UEkxq2Fu3_VePeh1-GehCugi0eIXV-QyiXp1ba4pxWWbCfIC_hihzKjwnVb5wrhzqyw8FJpvnvtrHEjt-zSijpS7WlO7ScJDY-PE8zgH-CICnS2CKYSkP3Rbzka9XY_Z6ieUzmBSFdA_0K8pQOdDHv70y04dnL1CjL6XToncnvezioL388Y1UTqlhll8b2Pm4EI7rGdHVKzLcKnKoYpgsBPZLmO7qGPJ5BkHvmg3gOSkmIiziFaEZkoXvjbvEUAt5qEqzaADSaFP6QhRYNtr1s4OD9uj0SK6QaoZTj69XYFuNMNnm7zN_WxvPBMTq9g';

// Valid OAuth access token JWT with typ: "application/at+jwt"
// Header: {"alg":"RS256","kid":"ins_2GIoQhbUpy0hX7B2cVkuTMinXoD","typ":"application/at+jwt"}
// Payload: {"client_id":"client_2VTWUzvGC5UhdJCNx6xG1D98edc","sub":"user_2vYVtestTESTtestTESTtestTESTtest","jti":"oat_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE","iat":1666648250,"exp":1666648550,"scope":"read:foo write:bar"}
// Signed with signingJwks, verifiable with mockJwks
export const mockSignedOAuthAccessTokenJwtApplicationTyp =
 'eyJhbGciOiJSUzI1NiIsImtpZCI6Imluc18yR0lvUWhiVXB5MGhYN0IyY1ZrdVRNaW5Yb0QiLCJ0eXAiOiJhcHBsaWNhdGlvbi9hdCtqd3QifQ.eyJhenAiOiJodHRwczovL2FjY291bnRzLmluc3BpcmVkLnB1bWEtNzQubGNsLmRldiIsImV4cCI6MTY2NjY0ODU1MCwiaWF0IjoxNjY2NjQ4MjUwLCJpc3MiOiJodHRwczovL2NsZXJrLm9hdXRoLmV4YW1wbGUudGVzdCIsIm5iZiI6MTY2NjY0ODI0MCwic2lkIjoic2Vzc18yR2JEQjRlbk5kQ2E1dlMxenBDM1h6Zzl0SzkiLCJzdWIiOiJ1c2VyXzJ2WVZ0ZXN0VEVTVHRlc3RURVNUdGVzdFRFU1R0ZXN0IiwiY2xpZW50X2lkIjoiY2xpZW50XzJWVFdVenZHQzVVaGRKQ054NnhHMUQ5OGVkYyIsInNjb3BlIjoicmVhZDpmb28gd3JpdGU6YmFyIiwianRpIjoib2F0XzJ4S2E5Qmd2N054TVJERnlRdzhMcFozY1RtVTF2SGpFIn0.GPTvB4doScjzQD0kRMhMebVDREjwcrMWK73OP_kFc3pl0gST29BlWrKMBi8wRxoSJBc2ukO10BPhGxnh15PxCNLyk6xQFWhFBA7XpVxY4T_VHPDU5FEOocPQuqcqZ4cA1GDJST-BH511fxoJnv4kfha46IvQiUMvWCacIj_w12qfZigeb208mTDIeoJQtlYb-sD9u__CVvB4uZOqGb0lIL5-cCbhMPFg-6GQ2DhZ-Eq5tw7oyO6lPrsAaFN9u-59SLvips364ieYNpgcr9Dbo5PDvUSltqxoIXTDFo4esWw6XwUjnGfqCh34LYAhv_2QF2U0-GASBEn4GK-Wfv3wXg';

36 changes: 34 additions & 2 deletions
packages/backend/src/jwt/__tests__/assertions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -106,15 +106,47 @@ describe('assertAudienceClaim(audience?, aud?)', () => {
 });
});

describe('assertHeaderType(typ?)', () => {
describe('assertHeaderType(typ?, allowedTypes?)', () => {
 it('does not throw error if type is missing', () => {
 expect(() => assertHeaderType(undefined)).not.toThrow();
 expect(() => assertHeaderType(undefined, 'JWT')).not.toThrow();
 expect(() => assertHeaderType(undefined, ['JWT', 'at+jwt'])).not.toThrow();
 });

 it('throws error if type is not JWT', () => {
 it('does not throw error if type matches default allowed type (JWT)', () => {
 expect(() => assertHeaderType('JWT')).not.toThrow();
 });

 it('throws error if type is not JWT (default)', () => {
 expect(() => assertHeaderType('')).toThrow(`Invalid JWT type "". Expected "JWT".`);
 expect(() => assertHeaderType('Aloha')).toThrow(`Invalid JWT type "Aloha". Expected "JWT".`);
 });

 it('does not throw error if type matches single custom allowed type', () => {
 expect(() => assertHeaderType('at+jwt', 'at+jwt')).not.toThrow();
 expect(() => assertHeaderType('application/at+jwt', 'application/at+jwt')).not.toThrow();
 });

 it('throws error if type does not match single custom allowed type', () => {
 expect(() => assertHeaderType('JWT', 'at+jwt')).toThrow(`Invalid JWT type "JWT". Expected "at+jwt".`);
 expect(() => assertHeaderType('at+jwt', 'JWT')).toThrow(`Invalid JWT type "at+jwt". Expected "JWT".`);
 });

 it('does not throw error if type matches array of allowed types', () => {
 expect(() => assertHeaderType('JWT', ['JWT', 'at+jwt'])).not.toThrow();
 expect(() => assertHeaderType('at+jwt', ['JWT', 'at+jwt'])).not.toThrow();
 expect(() => assertHeaderType('at+jwt', ['at+jwt', 'application/at+jwt'])).not.toThrow();
 expect(() => assertHeaderType('application/at+jwt', ['at+jwt', 'application/at+jwt'])).not.toThrow();
 });

 it('throws error if type does not match any in array of allowed types', () => {
 expect(() => assertHeaderType('JWT', ['at+jwt', 'application/at+jwt'])).toThrow(
 `Invalid JWT type "JWT". Expected "at+jwt, application/at+jwt".`,
 );
 expect(() => assertHeaderType('invalid', ['at+jwt', 'application/at+jwt'])).toThrow(
 `Invalid JWT type "invalid". Expected "at+jwt, application/at+jwt".`,
 );
 });
});

describe('assertHeaderAlgorithm(alg)', () => {
Expand Down

88 changes: 88 additions & 0 deletions
packages/backend/src/jwt/__tests__/verifyJwt.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import {
 createJwt,
 mockJwks,
 mockJwt,
 mockJwtHeader,
 mockJwtPayload,
 mockOAuthAccessTokenJwtPayload,
 pemEncodedPublicKey,
 publicJwks,
 signedJwt,
 someOtherPublicKey,
} from '../../fixtures';
import { mockSignedOAuthAccessTokenJwt, mockSignedOAuthAccessTokenJwtApplicationTyp } from '../../fixtures/machine';
import { decodeJwt, hasValidSignature, verifyJwt } from '../verifyJwt';

const invalidTokenError = {
Expand DownExpand Up@@ -129,4 +132,89 @@ describe('verifyJwt(jwt, options)', () => {
 const { errors: [error] = [] } = await verifyJwt('invalid-jwt', inputVerifyJwtOptions);
 expect(error).toMatchObject(invalidTokenError);
 });

 it('verifies JWT with default headerType (JWT)', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 issuer: mockJwtPayload.iss,
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 };
 const { data } = await verifyJwt(mockJwt, inputVerifyJwtOptions);
 expect(data).toEqual(mockJwtPayload);
 });

 it('verifies JWT with explicit headerType as string', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 issuer: mockJwtPayload.iss,
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: 'JWT',
 };
 const { data } = await verifyJwt(mockJwt, inputVerifyJwtOptions);
 expect(data).toEqual(mockJwtPayload);
 });

 it('verifies OAuth JWT with headerType as array including at+jwt', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: ['at+jwt', 'application/at+jwt'],
 };
 const { data } = await verifyJwt(mockSignedOAuthAccessTokenJwt, inputVerifyJwtOptions);
 expect(data).toBeDefined();
 expect(data?.sub).toBe('user_2vYVtestTESTtestTESTtestTESTtest');
 });

 it('verifies OAuth JWT with headerType as array including application/at+jwt', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: ['at+jwt', 'application/at+jwt'],
 };
 const { data } = await verifyJwt(mockSignedOAuthAccessTokenJwtApplicationTyp, inputVerifyJwtOptions);
 expect(data).toBeDefined();
 expect(data?.sub).toBe('user_2vYVtestTESTtestTESTtestTESTtest');
 });

 it('rejects JWT when headerType does not match', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 issuer: mockJwtPayload.iss,
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: 'at+jwt',
 };
 const { errors: [error] = [] } = await verifyJwt(mockJwt, inputVerifyJwtOptions);
 expect(error).toBeDefined();
 expect(error?.message).toContain('Invalid JWT type');
 expect(error?.message).toContain('Expected "at+jwt"');
 });

 it('rejects OAuth JWT when headerType does not match', async () => {
 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: 'JWT',
 };
 const { errors: [error] = [] } = await verifyJwt(mockSignedOAuthAccessTokenJwt, inputVerifyJwtOptions);
 expect(error).toBeDefined();
 expect(error?.message).toContain('Invalid JWT type');
 expect(error?.message).toContain('Expected "JWT"');
 });

 it('rejects JWT when headerType array does not include the token type', async () => {
 const jwtWithCustomTyp = createJwt({
 header: { typ: 'custom-type', kid: 'ins_2GIoQhbUpy0hX7B2cVkuTMinXoD' },
 payload: mockOAuthAccessTokenJwtPayload,
 });

 const inputVerifyJwtOptions = {
 key: mockJwks.keys[0],
 authorizedParties: ['https://accounts.inspired.puma-74.lcl.dev'],
 headerType: ['at+jwt', 'application/at+jwt'],
 };
 const { errors: [error] = [] } = await verifyJwt(jwtWithCustomTyp, inputVerifyJwtOptions);
 expect(error).toBeDefined();
 expect(error?.message).toContain('Invalid JWT type');
 expect(error?.message).toContain('Expected "at+jwt, application/at+jwt"');
 });
});

7 changes: 4 additions & 3 deletions
packages/backend/src/jwt/assertions.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,16 +47,17 @@ export const assertAudienceClaim = (aud?: unknown, audience?: unknown) => {
 }
};

export const assertHeaderType = (typ?: unknown) => {
export const assertHeaderType = (typ?: unknown, allowedTypes: string | string[] = 'JWT') => {
 if (typeof typ === 'undefined') {
 return;
 }

 if (typ !== 'JWT') {
 const allowed = Array.isArray(allowedTypes) ? allowedTypes : [allowedTypes];
 if (!allowed.includes(typ as string)) {
 throw new TokenVerificationError({
 action: TokenVerificationErrorAction.EnsureClerkJWT,
 reason: TokenVerificationErrorReason.TokenInvalid,
 message: `Invalid JWT type ${JSON.stringify(typ)}. Expected "JWT".`,
 message: `Invalid JWT type ${JSON.stringify(typ)}. Expected "${allowed.join(', ')}".`,
 });
 }
};
Expand Down

9 changes: 7 additions & 2 deletions
packages/backend/src/jwt/verifyJwt.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -119,13 +119,18 @@ export type VerifyJwtOptions = {
 * @internal
 */
 key: JsonWebKey | string;
 /**
 * A string or list of allowed [header types](https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.9).
 * @default 'JWT'
 */
 headerType?: string | string[];
};

export async function verifyJwt(
 token: string,
 options: VerifyJwtOptions,
): Promise<JwtReturnType<JwtPayload, TokenVerificationError>> {
 const { audience, authorizedParties, clockSkewInMs, key } = options;
 const { audience, authorizedParties, clockSkewInMs, key, headerType } = options;
 const clockSkew = clockSkewInMs || DEFAULT_CLOCK_SKEW_IN_MS;

 const { data: decoded, errors } = decodeJwt(token);
Expand All@@ -138,7 +143,7 @@ export async function verifyJwt(
 // Header verifications
 const { typ, alg } = header;

 assertHeaderType(typ);
 assertHeaderType(typ, headerType);
 assertHeaderAlgorithm(alg);

 // Payload verifications
Expand Down
Loading
Loading