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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .changeset/clever-ways-raise.md

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

changeset available in core 2

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
28 changes: 24 additions & 4 deletions integration/tests/machine-auth/m2m.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,10 +42,9 @@ test.describe('machine-to-machine auth @machine', () => {

app.get('/api/protected', async (req, res) => {
const token = req.get('Authorization')?.split(' ')[1];

try {
const m2mToken = await clerkClient.m2m.verify({ token });
res.send('Protected response ' + m2mToken.id);
res.send('Protected response ' + m2mToken.subject);
} catch {
res.status(401).send('Unauthorized');
}
Expand DownExpand Up@@ -150,7 +149,7 @@ test.describe('machine-to-machine auth @machine', () => {
},
});
expect(res.status()).toBe(200);
expect(await res.text()).toBe('Protected response ' + emailServerM2MToken.id);
expect(await res.text()).toBe('Protected response ' + emailServer.id);

// Analytics server can access primary API server after adding scope
await u.services.clerk.machines.createScope(analyticsServer.id, primaryApiServer.id);
Expand All@@ -165,9 +164,30 @@ test.describe('machine-to-machine auth @machine', () => {
},
});
expect(res2.status()).toBe(200);
expect(await res2.text()).toBe('Protected response ' + m2mToken.id);
expect(await res2.text()).toBe('Protected response ' + analyticsServer.id);
await u.services.clerk.m2m.revokeToken({
m2mTokenId: m2mToken.id,
});
});

test('verifies JWT format M2M token via local verification', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

const client = createClerkClient({
secretKey: instanceKeys.get('with-api-keys').sk,
});
const jwtToken = await client.m2m.createToken({
machineSecretKey: emailServer.secretKey,
secondsUntilExpiration: 60 * 30,
tokenFormat: 'jwt',
});

const res = await u.page.request.get(app.serverUrl + '/api/protected', {
headers: { Authorization: `Bearer ${jwtToken.token}` },
});
expect(res.status()).toBe(200);
expect(await res.text()).toBe('Protected response ' + emailServer.id);
// JWT-format tokens are self-contained and not stored in BAPI, so revocation
// is not applicable — they expire naturally via the exp claim.
});
});
2 changes: 0 additions & 2 deletions packages/backend/src/__tests__/exports.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,11 +49,9 @@ describe('subpath /internal exports', () => {
"decorateObjectWithResources",
"getAuthObjectForAcceptedToken",
"getAuthObjectFromJwt",
"getMachineTokenType",
"invalidTokenAuthObject",
"isMachineToken",
"isMachineTokenByPrefix",
"isMachineTokenType",
"isTokenTypeAccepted",
"makeAuthObjectSerializable",
"reverificationError",
Expand Down
196 changes: 195 additions & 1 deletion packages/backend/src/api/__tests__/M2MTokenApi.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { mockJwks, mockJwtPayload, mockM2MJwtPayload, signingJwks } from '../../fixtures';
import { signJwt } from '../../jwt/signJwt';
import { server, validateHeaders } from '../../mock-server';
import { M2MTokenApi } from '../endpoints/M2MTokenApi';
import { createBackendApiClient } from '../factory';
import { buildRequest } from '../request';

describe('M2MToken', () => {
const m2mId = 'mt_1xxxxxxxxxxxxx';
Expand DownExpand Up@@ -110,6 +114,130 @@ describe('M2MToken', () => {
'The provided Machine Secret Key is invalid. Make sure that your Machine Secret Key is correct.',
);
});

it('creates a jwt format m2m token', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
expect(body.token_format).toBe('jwt');
return HttpResponse.json({
...mockM2MToken,
token:
'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Imluc194eHh4eCJ9.eyJqdGkiOiJtdF94eHh4eCIsInN1YiI6Im1jaF94eHh4eCIsImF1ZCI6WyJtY2hfMXh4eHh4IiwibWNoXzJ4eHh4eCJdLCJzY29wZXMiOiJtY2hfMXh4eHh4IG1jaF8yeHh4eHgiLCJpYXQiOjE3NTM3NDMzMTYsImV4cCI6MTc1Mzc0NjkxNn0.signature',
});
}),
),
);

const response = await apiClient.m2m.createToken({
tokenFormat: 'jwt',
});
expect(response.id).toBe(m2mId);
expect(response.token).toMatch(/^[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+$/);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
});

it('creates a jwt m2m token with custom claims and scopes', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

const customClaims = {
role: 'service',
tier: 'gold',
};

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
expect(body.token_format).toBe('jwt');
expect(body.claims).toEqual(customClaims);
return HttpResponse.json({
...mockM2MToken,
claims: customClaims,
token:
'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Imluc194eHh4eCJ9.eyJqdGkiOiJtdF94eHh4eCIsInN1YiI6Im1jaF94eHh4eCIsImF1ZCI6WyJtY2hfMXh4eHh4IiwibWNoXzJ4eHh4eCJdLCJzY29wZXMiOiJtY2hfMXh4eHh4IG1jaF8yeHh4eHgiLCJyb2xlIjoic2VydmljZSIsInRpZXIiOiJnb2xkIiwiaWF0IjoxNzUzNzQzMzE2LCJleHAiOjE3NTM3NDY5MTZ9.signature',
});
}),
),
);

const response = await apiClient.m2m.createToken({
tokenFormat: 'jwt',
claims: customClaims,
});

expect(response.id).toBe(m2mId);
expect(response.token).toMatch(/^[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+$/);
expect(response.claims).toEqual(customClaims);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
});

it('creates an opaque format m2m token when explicitly specified', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
expect(body.token_format).toBe('opaque');
return HttpResponse.json(mockM2MToken);
}),
),
);

const response = await apiClient.m2m.createToken({
tokenFormat: 'opaque',
});

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.token).toMatch(/^mt_.+$/);
});

it('creates an opaque m2m token by default when tokenFormat is omitted', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
// tokenFormat defaults to 'opaque' when omitted
expect(body.token_format).toBe('opaque');
return HttpResponse.json(mockM2MToken);
}),
),
);

const response = await apiClient.m2m.createToken({
secondsUntilExpiration: 3600,
});

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
});
});

describe('revoke', () => {
Expand DownExpand Up@@ -283,6 +411,72 @@ describe('M2MToken', () => {
});
});

async function createSignedM2MJwt(payload = mockM2MJwtPayload) {
const { data } = await signJwt(payload, signingJwks, {
algorithm: 'RS256',
header: { typ: 'JWT', kid: 'ins_2GIoQhbUpy0hX7B2cVkuTMinXoD' },
});
return data!;
}

describe('verify — JWT format', () => {
beforeEach(() => {
vi.useFakeTimers();
vi.setSystemTime(new Date(mockJwtPayload.iat * 1000));
});
afterEach(() => {
vi.useRealTimers();
});

it('verifies a JWT M2M token using secretKey (JWKS lookup)', async () => {
const m2mApi = new M2MTokenApi(
buildRequest({ apiUrl: 'https://api.clerk.test', skipApiVersionInUrl: true, requireSecretKey: false }),
{ secretKey: 'sk_test_xxxxx', apiUrl: 'https://api.clerk.test', skipJwksCache: true },
);

server.use(
http.get(
'https://api.clerk.test/v1/jwks',
validateHeaders(() => HttpResponse.json(mockJwks)),
),
);

const jwtToken = await createSignedM2MJwt();
const result = await m2mApi.verify({ token: jwtToken });

expect(result.id).toBe('mt_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE');
expect(result.subject).toBe('mch_2vYVtestTESTtestTESTtestTESTtest');
expect(result.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
});

it('throws when JWT signature cannot be verified', async () => {
const m2mApi = new M2MTokenApi(
buildRequest({ apiUrl: 'https://api.clerk.test', skipApiVersionInUrl: true, requireSecretKey: false }),
{ secretKey: 'sk_test_xxxxx', apiUrl: 'https://api.clerk.test', skipJwksCache: true },
);

server.use(
http.get(
'https://api.clerk.test/v1/jwks',
validateHeaders(() => HttpResponse.json({ keys: [] })),
),
);

const jwtToken = await createSignedM2MJwt();
await expect(m2mApi.verify({ token: jwtToken })).rejects.toThrow();
});

it('throws when no secretKey or jwtKey is provided', async () => {
const m2mApi = new M2MTokenApi(
buildRequest({ apiUrl: 'https://api.clerk.test', skipApiVersionInUrl: true, requireSecretKey: false }),
{ apiUrl: 'https://api.clerk.test' },
);

const jwtToken = await createSignedM2MJwt();
await expect(m2mApi.verify({ token: jwtToken })).rejects.toThrow('Failed to resolve JWK during verification');
});
});

describe('list', () => {
const machineId = 'mch_1xxxxxxxxxxxxx';
const mockM2MTokenList = {
Expand Down
59 changes: 57 additions & 2 deletions packages/backend/src/api/endpoints/M2MTokenApi.ts
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,25 @@
import type { ClerkPaginationRequest } from '@clerk/shared/types';

import { MachineTokenVerificationError, MachineTokenVerificationErrorCode } from '../../errors';
import { decodeJwt } from '../../jwt/verifyJwt';
import type { JwtMachineVerifyOptions } from '../../jwt/verifyMachineJwt';
import { verifyM2MJwt } from '../../jwt/verifyMachineJwt';
import { isM2MJwt } from '../../tokens/machine';
import { joinPaths } from '../../util/path';
import type { ClerkBackendApiRequestOptions } from '../request';
import type { ClerkBackendApiRequestOptions, RequestFunction } from '../request';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import type { M2MToken } from '../resources/M2MToken';
import { AbstractAPI } from './AbstractApi';

const basePath = '/m2m_tokens';

/**
* Format of the M2M token to create.
* - 'opaque': Opaque token with mt_ prefix
* - 'jwt': JWT signed with instance keys
*/
export type M2MTokenFormat = 'opaque' | 'jwt';

type GetM2MTokenListParams = ClerkPaginationRequest<{
/**
* The machine ID to query machine-to-machine tokens by
Expand DownExpand Up@@ -39,6 +51,10 @@ type CreateM2MTokenParams = {
*/
secondsUntilExpiration?: number | null;
claims?: Record<string, unknown> | null;
/**
* @default 'opaque'
*/
tokenFormat?: M2MTokenFormat;
};

type RevokeM2MTokenParams = {
Expand All@@ -65,6 +81,18 @@ type VerifyM2MTokenParams = {
};

export class M2MTokenApi extends AbstractAPI {
#verifyOptions: JwtMachineVerifyOptions;

/**
* @param verifyOptions - JWT verification options (secretKey, apiUrl, etc.).
* Passed explicitly because BuildRequestOptions are captured inside the buildRequest closure
* and are not accessible from the RequestFunction itself.
*/
constructor(request: RequestFunction, verifyOptions: JwtMachineVerifyOptions = {}) {
super(request);
this.#verifyOptions = verifyOptions;
}

#createRequestOptions(options: ClerkBackendApiRequestOptions, machineSecretKey?: string) {
if (machineSecretKey) {
return {
Expand All@@ -88,7 +116,7 @@ export class M2MTokenApi extends AbstractAPI {
}

async createToken(params?: CreateM2MTokenParams) {
const { claims = null, machineSecretKey, secondsUntilExpiration = null } = params || {};
const { claims = null, machineSecretKey, secondsUntilExpiration = null, tokenFormat = 'opaque' } = params || {};

const requestOptions = this.#createRequestOptions(
{
Expand All@@ -97,6 +125,7 @@ export class M2MTokenApi extends AbstractAPI {
bodyParams: {
secondsUntilExpiration,
claims,
tokenFormat,
},
},
machineSecretKey,
Expand DownExpand Up@@ -124,9 +153,35 @@ export class M2MTokenApi extends AbstractAPI {
return this.request<M2MToken>(requestOptions);
}

async #verifyJwtFormat(token: string): Promise<M2MToken> {
let decoded;
try {
const { data, errors } = decodeJwt(token);
if (errors) {
throw errors[0];
}
decoded = data;
} catch (e) {
throw new MachineTokenVerificationError({
code: MachineTokenVerificationErrorCode.TokenInvalid,
message: (e as Error).message,
});
}

const result = await verifyM2MJwt(token, decoded, this.#verifyOptions);
if (result.errors) {
throw result.errors[0];
}
return result.data;
}

async verify(params: VerifyM2MTokenParams) {
const { token, machineSecretKey } = params;

if (isM2MJwt(token)) {
return this.#verifyJwtFormat(token);
}

const requestOptions = this.#createRequestOptions(
{
method: 'POST',
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .changeset/clever-ways-raise.md

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

changeset available in core 2

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
28 changes: 24 additions & 4 deletions integration/tests/machine-auth/m2m.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,10 +42,9 @@ test.describe('machine-to-machine auth @machine', () => {

app.get('/api/protected', async (req, res) => {
const token = req.get('Authorization')?.split(' ')[1];

try {
const m2mToken = await clerkClient.m2m.verify({ token });
res.send('Protected response ' + m2mToken.id);
res.send('Protected response ' + m2mToken.subject);
} catch {
res.status(401).send('Unauthorized');
}
Expand DownExpand Up@@ -150,7 +149,7 @@ test.describe('machine-to-machine auth @machine', () => {
},
});
expect(res.status()).toBe(200);
expect(await res.text()).toBe('Protected response ' + emailServerM2MToken.id);
expect(await res.text()).toBe('Protected response ' + emailServer.id);

// Analytics server can access primary API server after adding scope
await u.services.clerk.machines.createScope(analyticsServer.id, primaryApiServer.id);
Expand All@@ -165,9 +164,30 @@ test.describe('machine-to-machine auth @machine', () => {
},
});
expect(res2.status()).toBe(200);
expect(await res2.text()).toBe('Protected response ' + m2mToken.id);
expect(await res2.text()).toBe('Protected response ' + analyticsServer.id);
await u.services.clerk.m2m.revokeToken({
m2mTokenId: m2mToken.id,
});
});

test('verifies JWT format M2M token via local verification', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

const client = createClerkClient({
secretKey: instanceKeys.get('with-api-keys').sk,
});
const jwtToken = await client.m2m.createToken({
machineSecretKey: emailServer.secretKey,
secondsUntilExpiration: 60 * 30,
tokenFormat: 'jwt',
});

const res = await u.page.request.get(app.serverUrl + '/api/protected', {
headers: { Authorization: `Bearer ${jwtToken.token}` },
});
expect(res.status()).toBe(200);
expect(await res.text()).toBe('Protected response ' + emailServer.id);
// JWT-format tokens are self-contained and not stored in BAPI, so revocation
// is not applicable — they expire naturally via the exp claim.
});
});
2 changes: 0 additions & 2 deletions packages/backend/src/__tests__/exports.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,11 +49,9 @@ describe('subpath /internal exports', () => {
"decorateObjectWithResources",
"getAuthObjectForAcceptedToken",
"getAuthObjectFromJwt",
"getMachineTokenType",
"invalidTokenAuthObject",
"isMachineToken",
"isMachineTokenByPrefix",
"isMachineTokenType",
"isTokenTypeAccepted",
"makeAuthObjectSerializable",
"reverificationError",
Expand Down
196 changes: 195 additions & 1 deletion packages/backend/src/api/__tests__/M2MTokenApi.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { mockJwks, mockJwtPayload, mockM2MJwtPayload, signingJwks } from '../../fixtures';
import { signJwt } from '../../jwt/signJwt';
import { server, validateHeaders } from '../../mock-server';
import { M2MTokenApi } from '../endpoints/M2MTokenApi';
import { createBackendApiClient } from '../factory';
import { buildRequest } from '../request';

describe('M2MToken', () => {
const m2mId = 'mt_1xxxxxxxxxxxxx';
Expand DownExpand Up@@ -110,6 +114,130 @@ describe('M2MToken', () => {
'The provided Machine Secret Key is invalid. Make sure that your Machine Secret Key is correct.',
);
});

it('creates a jwt format m2m token', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
expect(body.token_format).toBe('jwt');
return HttpResponse.json({
...mockM2MToken,
token:
'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Imluc194eHh4eCJ9.eyJqdGkiOiJtdF94eHh4eCIsInN1YiI6Im1jaF94eHh4eCIsImF1ZCI6WyJtY2hfMXh4eHh4IiwibWNoXzJ4eHh4eCJdLCJzY29wZXMiOiJtY2hfMXh4eHh4IG1jaF8yeHh4eHgiLCJpYXQiOjE3NTM3NDMzMTYsImV4cCI6MTc1Mzc0NjkxNn0.signature',
});
}),
),
);

const response = await apiClient.m2m.createToken({
tokenFormat: 'jwt',
});
expect(response.id).toBe(m2mId);
expect(response.token).toMatch(/^[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+$/);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
});

it('creates a jwt m2m token with custom claims and scopes', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

const customClaims = {
role: 'service',
tier: 'gold',
};

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
expect(body.token_format).toBe('jwt');
expect(body.claims).toEqual(customClaims);
return HttpResponse.json({
...mockM2MToken,
claims: customClaims,
token:
'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Imluc194eHh4eCJ9.eyJqdGkiOiJtdF94eHh4eCIsInN1YiI6Im1jaF94eHh4eCIsImF1ZCI6WyJtY2hfMXh4eHh4IiwibWNoXzJ4eHh4eCJdLCJzY29wZXMiOiJtY2hfMXh4eHh4IG1jaF8yeHh4eHgiLCJyb2xlIjoic2VydmljZSIsInRpZXIiOiJnb2xkIiwiaWF0IjoxNzUzNzQzMzE2LCJleHAiOjE3NTM3NDY5MTZ9.signature',
});
}),
),
);

const response = await apiClient.m2m.createToken({
tokenFormat: 'jwt',
claims: customClaims,
});

expect(response.id).toBe(m2mId);
expect(response.token).toMatch(/^[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+$/);
expect(response.claims).toEqual(customClaims);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
});

it('creates an opaque format m2m token when explicitly specified', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
expect(body.token_format).toBe('opaque');
return HttpResponse.json(mockM2MToken);
}),
),
);

const response = await apiClient.m2m.createToken({
tokenFormat: 'opaque',
});

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.token).toMatch(/^mt_.+$/);
});

it('creates an opaque m2m token by default when tokenFormat is omitted', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
// tokenFormat defaults to 'opaque' when omitted
expect(body.token_format).toBe('opaque');
return HttpResponse.json(mockM2MToken);
}),
),
);

const response = await apiClient.m2m.createToken({
secondsUntilExpiration: 3600,
});

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
});
});

describe('revoke', () => {
Expand DownExpand Up@@ -283,6 +411,72 @@ describe('M2MToken', () => {
});
});

async function createSignedM2MJwt(payload = mockM2MJwtPayload) {
const { data } = await signJwt(payload, signingJwks, {
algorithm: 'RS256',
header: { typ: 'JWT', kid: 'ins_2GIoQhbUpy0hX7B2cVkuTMinXoD' },
});
return data!;
}

describe('verify — JWT format', () => {
beforeEach(() => {
vi.useFakeTimers();
vi.setSystemTime(new Date(mockJwtPayload.iat * 1000));
});
afterEach(() => {
vi.useRealTimers();
});

it('verifies a JWT M2M token using secretKey (JWKS lookup)', async () => {
const m2mApi = new M2MTokenApi(
buildRequest({ apiUrl: 'https://api.clerk.test', skipApiVersionInUrl: true, requireSecretKey: false }),
{ secretKey: 'sk_test_xxxxx', apiUrl: 'https://api.clerk.test', skipJwksCache: true },
);

server.use(
http.get(
'https://api.clerk.test/v1/jwks',
validateHeaders(() => HttpResponse.json(mockJwks)),
),
);

const jwtToken = await createSignedM2MJwt();
const result = await m2mApi.verify({ token: jwtToken });

expect(result.id).toBe('mt_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE');
expect(result.subject).toBe('mch_2vYVtestTESTtestTESTtestTESTtest');
expect(result.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
});

it('throws when JWT signature cannot be verified', async () => {
const m2mApi = new M2MTokenApi(
buildRequest({ apiUrl: 'https://api.clerk.test', skipApiVersionInUrl: true, requireSecretKey: false }),
{ secretKey: 'sk_test_xxxxx', apiUrl: 'https://api.clerk.test', skipJwksCache: true },
);

server.use(
http.get(
'https://api.clerk.test/v1/jwks',
validateHeaders(() => HttpResponse.json({ keys: [] })),
),
);

const jwtToken = await createSignedM2MJwt();
await expect(m2mApi.verify({ token: jwtToken })).rejects.toThrow();
});

it('throws when no secretKey or jwtKey is provided', async () => {
const m2mApi = new M2MTokenApi(
buildRequest({ apiUrl: 'https://api.clerk.test', skipApiVersionInUrl: true, requireSecretKey: false }),
{ apiUrl: 'https://api.clerk.test' },
);

const jwtToken = await createSignedM2MJwt();
await expect(m2mApi.verify({ token: jwtToken })).rejects.toThrow('Failed to resolve JWK during verification');
});
});

describe('list', () => {
const machineId = 'mch_1xxxxxxxxxxxxx';
const mockM2MTokenList = {
Expand Down
59 changes: 57 additions & 2 deletions packages/backend/src/api/endpoints/M2MTokenApi.ts
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,25 @@
import type { ClerkPaginationRequest } from '@clerk/shared/types';

import { MachineTokenVerificationError, MachineTokenVerificationErrorCode } from '../../errors';
import { decodeJwt } from '../../jwt/verifyJwt';
import type { JwtMachineVerifyOptions } from '../../jwt/verifyMachineJwt';
import { verifyM2MJwt } from '../../jwt/verifyMachineJwt';
import { isM2MJwt } from '../../tokens/machine';
import { joinPaths } from '../../util/path';
import type { ClerkBackendApiRequestOptions } from '../request';
import type { ClerkBackendApiRequestOptions, RequestFunction } from '../request';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import type { M2MToken } from '../resources/M2MToken';
import { AbstractAPI } from './AbstractApi';

const basePath = '/m2m_tokens';

/**
* Format of the M2M token to create.
* - 'opaque': Opaque token with mt_ prefix
* - 'jwt': JWT signed with instance keys
*/
export type M2MTokenFormat = 'opaque' | 'jwt';

type GetM2MTokenListParams = ClerkPaginationRequest<{
/**
* The machine ID to query machine-to-machine tokens by
Expand DownExpand Up@@ -39,6 +51,10 @@ type CreateM2MTokenParams = {
*/
secondsUntilExpiration?: number | null;
claims?: Record<string, unknown> | null;
/**
* @default 'opaque'
*/
tokenFormat?: M2MTokenFormat;
};

type RevokeM2MTokenParams = {
Expand All@@ -65,6 +81,18 @@ type VerifyM2MTokenParams = {
};

export class M2MTokenApi extends AbstractAPI {
#verifyOptions: JwtMachineVerifyOptions;

/**
* @param verifyOptions - JWT verification options (secretKey, apiUrl, etc.).
* Passed explicitly because BuildRequestOptions are captured inside the buildRequest closure
* and are not accessible from the RequestFunction itself.
*/
constructor(request: RequestFunction, verifyOptions: JwtMachineVerifyOptions = {}) {
super(request);
this.#verifyOptions = verifyOptions;
}

#createRequestOptions(options: ClerkBackendApiRequestOptions, machineSecretKey?: string) {
if (machineSecretKey) {
return {
Expand All@@ -88,7 +116,7 @@ export class M2MTokenApi extends AbstractAPI {
}

async createToken(params?: CreateM2MTokenParams) {
const { claims = null, machineSecretKey, secondsUntilExpiration = null } = params || {};
const { claims = null, machineSecretKey, secondsUntilExpiration = null, tokenFormat = 'opaque' } = params || {};

const requestOptions = this.#createRequestOptions(
{
Expand All@@ -97,6 +125,7 @@ export class M2MTokenApi extends AbstractAPI {
bodyParams: {
secondsUntilExpiration,
claims,
tokenFormat,
},
},
machineSecretKey,
Expand DownExpand Up@@ -124,9 +153,35 @@ export class M2MTokenApi extends AbstractAPI {
return this.request<M2MToken>(requestOptions);
}

async #verifyJwtFormat(token: string): Promise<M2MToken> {
let decoded;
try {
const { data, errors } = decodeJwt(token);
if (errors) {
throw errors[0];
}
decoded = data;
} catch (e) {
throw new MachineTokenVerificationError({
code: MachineTokenVerificationErrorCode.TokenInvalid,
message: (e as Error).message,
});
}

const result = await verifyM2MJwt(token, decoded, this.#verifyOptions);
if (result.errors) {
throw result.errors[0];
}
return result.data;
}

async verify(params: VerifyM2MTokenParams) {
const { token, machineSecretKey } = params;

if (isM2MJwt(token)) {
return this.#verifyJwtFormat(token);
}

const requestOptions = this.#createRequestOptions(
{
method: 'POST',
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .changeset/clever-ways-raise.md

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

changeset available in core 2

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
28 changes: 24 additions & 4 deletions integration/tests/machine-auth/m2m.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,10 +42,9 @@ test.describe('machine-to-machine auth @machine', () => {

app.get('/api/protected', async (req, res) => {
const token = req.get('Authorization')?.split(' ')[1];

try {
const m2mToken = await clerkClient.m2m.verify({ token });
res.send('Protected response ' + m2mToken.id);
res.send('Protected response ' + m2mToken.subject);
} catch {
res.status(401).send('Unauthorized');
}
Expand DownExpand Up@@ -150,7 +149,7 @@ test.describe('machine-to-machine auth @machine', () => {
},
});
expect(res.status()).toBe(200);
expect(await res.text()).toBe('Protected response ' + emailServerM2MToken.id);
expect(await res.text()).toBe('Protected response ' + emailServer.id);

// Analytics server can access primary API server after adding scope
await u.services.clerk.machines.createScope(analyticsServer.id, primaryApiServer.id);
Expand All@@ -165,9 +164,30 @@ test.describe('machine-to-machine auth @machine', () => {
},
});
expect(res2.status()).toBe(200);
expect(await res2.text()).toBe('Protected response ' + m2mToken.id);
expect(await res2.text()).toBe('Protected response ' + analyticsServer.id);
await u.services.clerk.m2m.revokeToken({
m2mTokenId: m2mToken.id,
});
});

test('verifies JWT format M2M token via local verification', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

const client = createClerkClient({
secretKey: instanceKeys.get('with-api-keys').sk,
});
const jwtToken = await client.m2m.createToken({
machineSecretKey: emailServer.secretKey,
secondsUntilExpiration: 60 * 30,
tokenFormat: 'jwt',
});

const res = await u.page.request.get(app.serverUrl + '/api/protected', {
headers: { Authorization: `Bearer ${jwtToken.token}` },
});
expect(res.status()).toBe(200);
expect(await res.text()).toBe('Protected response ' + emailServer.id);
// JWT-format tokens are self-contained and not stored in BAPI, so revocation
// is not applicable — they expire naturally via the exp claim.
});
});
2 changes: 0 additions & 2 deletions packages/backend/src/__tests__/exports.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,11 +49,9 @@ describe('subpath /internal exports', () => {
"decorateObjectWithResources",
"getAuthObjectForAcceptedToken",
"getAuthObjectFromJwt",
"getMachineTokenType",
"invalidTokenAuthObject",
"isMachineToken",
"isMachineTokenByPrefix",
"isMachineTokenType",
"isTokenTypeAccepted",
"makeAuthObjectSerializable",
"reverificationError",
Expand Down
196 changes: 195 additions & 1 deletion packages/backend/src/api/__tests__/M2MTokenApi.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { mockJwks, mockJwtPayload, mockM2MJwtPayload, signingJwks } from '../../fixtures';
import { signJwt } from '../../jwt/signJwt';
import { server, validateHeaders } from '../../mock-server';
import { M2MTokenApi } from '../endpoints/M2MTokenApi';
import { createBackendApiClient } from '../factory';
import { buildRequest } from '../request';

describe('M2MToken', () => {
const m2mId = 'mt_1xxxxxxxxxxxxx';
Expand DownExpand Up@@ -110,6 +114,130 @@ describe('M2MToken', () => {
'The provided Machine Secret Key is invalid. Make sure that your Machine Secret Key is correct.',
);
});

it('creates a jwt format m2m token', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
expect(body.token_format).toBe('jwt');
return HttpResponse.json({
...mockM2MToken,
token:
'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Imluc194eHh4eCJ9.eyJqdGkiOiJtdF94eHh4eCIsInN1YiI6Im1jaF94eHh4eCIsImF1ZCI6WyJtY2hfMXh4eHh4IiwibWNoXzJ4eHh4eCJdLCJzY29wZXMiOiJtY2hfMXh4eHh4IG1jaF8yeHh4eHgiLCJpYXQiOjE3NTM3NDMzMTYsImV4cCI6MTc1Mzc0NjkxNn0.signature',
});
}),
),
);

const response = await apiClient.m2m.createToken({
tokenFormat: 'jwt',
});
expect(response.id).toBe(m2mId);
expect(response.token).toMatch(/^[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+$/);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
});

it('creates a jwt m2m token with custom claims and scopes', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

const customClaims = {
role: 'service',
tier: 'gold',
};

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
expect(body.token_format).toBe('jwt');
expect(body.claims).toEqual(customClaims);
return HttpResponse.json({
...mockM2MToken,
claims: customClaims,
token:
'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Imluc194eHh4eCJ9.eyJqdGkiOiJtdF94eHh4eCIsInN1YiI6Im1jaF94eHh4eCIsImF1ZCI6WyJtY2hfMXh4eHh4IiwibWNoXzJ4eHh4eCJdLCJzY29wZXMiOiJtY2hfMXh4eHh4IG1jaF8yeHh4eHgiLCJyb2xlIjoic2VydmljZSIsInRpZXIiOiJnb2xkIiwiaWF0IjoxNzUzNzQzMzE2LCJleHAiOjE3NTM3NDY5MTZ9.signature',
});
}),
),
);

const response = await apiClient.m2m.createToken({
tokenFormat: 'jwt',
claims: customClaims,
});

expect(response.id).toBe(m2mId);
expect(response.token).toMatch(/^[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+$/);
expect(response.claims).toEqual(customClaims);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
});

it('creates an opaque format m2m token when explicitly specified', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
expect(body.token_format).toBe('opaque');
return HttpResponse.json(mockM2MToken);
}),
),
);

const response = await apiClient.m2m.createToken({
tokenFormat: 'opaque',
});

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.token).toMatch(/^mt_.+$/);
});

it('creates an opaque m2m token by default when tokenFormat is omitted', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
// tokenFormat defaults to 'opaque' when omitted
expect(body.token_format).toBe('opaque');
return HttpResponse.json(mockM2MToken);
}),
),
);

const response = await apiClient.m2m.createToken({
secondsUntilExpiration: 3600,
});

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
});
});

describe('revoke', () => {
Expand DownExpand Up@@ -283,6 +411,72 @@ describe('M2MToken', () => {
});
});

async function createSignedM2MJwt(payload = mockM2MJwtPayload) {
const { data } = await signJwt(payload, signingJwks, {
algorithm: 'RS256',
header: { typ: 'JWT', kid: 'ins_2GIoQhbUpy0hX7B2cVkuTMinXoD' },
});
return data!;
}

describe('verify — JWT format', () => {
beforeEach(() => {
vi.useFakeTimers();
vi.setSystemTime(new Date(mockJwtPayload.iat * 1000));
});
afterEach(() => {
vi.useRealTimers();
});

it('verifies a JWT M2M token using secretKey (JWKS lookup)', async () => {
const m2mApi = new M2MTokenApi(
buildRequest({ apiUrl: 'https://api.clerk.test', skipApiVersionInUrl: true, requireSecretKey: false }),
{ secretKey: 'sk_test_xxxxx', apiUrl: 'https://api.clerk.test', skipJwksCache: true },
);

server.use(
http.get(
'https://api.clerk.test/v1/jwks',
validateHeaders(() => HttpResponse.json(mockJwks)),
),
);

const jwtToken = await createSignedM2MJwt();
const result = await m2mApi.verify({ token: jwtToken });

expect(result.id).toBe('mt_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE');
expect(result.subject).toBe('mch_2vYVtestTESTtestTESTtestTESTtest');
expect(result.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
});

it('throws when JWT signature cannot be verified', async () => {
const m2mApi = new M2MTokenApi(
buildRequest({ apiUrl: 'https://api.clerk.test', skipApiVersionInUrl: true, requireSecretKey: false }),
{ secretKey: 'sk_test_xxxxx', apiUrl: 'https://api.clerk.test', skipJwksCache: true },
);

server.use(
http.get(
'https://api.clerk.test/v1/jwks',
validateHeaders(() => HttpResponse.json({ keys: [] })),
),
);

const jwtToken = await createSignedM2MJwt();
await expect(m2mApi.verify({ token: jwtToken })).rejects.toThrow();
});

it('throws when no secretKey or jwtKey is provided', async () => {
const m2mApi = new M2MTokenApi(
buildRequest({ apiUrl: 'https://api.clerk.test', skipApiVersionInUrl: true, requireSecretKey: false }),
{ apiUrl: 'https://api.clerk.test' },
);

const jwtToken = await createSignedM2MJwt();
await expect(m2mApi.verify({ token: jwtToken })).rejects.toThrow('Failed to resolve JWK during verification');
});
});

describe('list', () => {
const machineId = 'mch_1xxxxxxxxxxxxx';
const mockM2MTokenList = {
Expand Down
59 changes: 57 additions & 2 deletions packages/backend/src/api/endpoints/M2MTokenApi.ts
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,25 @@
import type { ClerkPaginationRequest } from '@clerk/shared/types';

import { MachineTokenVerificationError, MachineTokenVerificationErrorCode } from '../../errors';
import { decodeJwt } from '../../jwt/verifyJwt';
import type { JwtMachineVerifyOptions } from '../../jwt/verifyMachineJwt';
import { verifyM2MJwt } from '../../jwt/verifyMachineJwt';
import { isM2MJwt } from '../../tokens/machine';
import { joinPaths } from '../../util/path';
import type { ClerkBackendApiRequestOptions } from '../request';
import type { ClerkBackendApiRequestOptions, RequestFunction } from '../request';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import type { M2MToken } from '../resources/M2MToken';
import { AbstractAPI } from './AbstractApi';

const basePath = '/m2m_tokens';

/**
* Format of the M2M token to create.
* - 'opaque': Opaque token with mt_ prefix
* - 'jwt': JWT signed with instance keys
*/
export type M2MTokenFormat = 'opaque' | 'jwt';

type GetM2MTokenListParams = ClerkPaginationRequest<{
/**
* The machine ID to query machine-to-machine tokens by
Expand DownExpand Up@@ -39,6 +51,10 @@ type CreateM2MTokenParams = {
*/
secondsUntilExpiration?: number | null;
claims?: Record<string, unknown> | null;
/**
* @default 'opaque'
*/
tokenFormat?: M2MTokenFormat;
};

type RevokeM2MTokenParams = {
Expand All@@ -65,6 +81,18 @@ type VerifyM2MTokenParams = {
};

export class M2MTokenApi extends AbstractAPI {
#verifyOptions: JwtMachineVerifyOptions;

/**
* @param verifyOptions - JWT verification options (secretKey, apiUrl, etc.).
* Passed explicitly because BuildRequestOptions are captured inside the buildRequest closure
* and are not accessible from the RequestFunction itself.
*/
constructor(request: RequestFunction, verifyOptions: JwtMachineVerifyOptions = {}) {
super(request);
this.#verifyOptions = verifyOptions;
}

#createRequestOptions(options: ClerkBackendApiRequestOptions, machineSecretKey?: string) {
if (machineSecretKey) {
return {
Expand All@@ -88,7 +116,7 @@ export class M2MTokenApi extends AbstractAPI {
}

async createToken(params?: CreateM2MTokenParams) {
const { claims = null, machineSecretKey, secondsUntilExpiration = null } = params || {};
const { claims = null, machineSecretKey, secondsUntilExpiration = null, tokenFormat = 'opaque' } = params || {};

const requestOptions = this.#createRequestOptions(
{
Expand All@@ -97,6 +125,7 @@ export class M2MTokenApi extends AbstractAPI {
bodyParams: {
secondsUntilExpiration,
claims,
tokenFormat,
},
},
machineSecretKey,
Expand DownExpand Up@@ -124,9 +153,35 @@ export class M2MTokenApi extends AbstractAPI {
return this.request<M2MToken>(requestOptions);
}

async #verifyJwtFormat(token: string): Promise<M2MToken> {
let decoded;
try {
const { data, errors } = decodeJwt(token);
if (errors) {
throw errors[0];
}
decoded = data;
} catch (e) {
throw new MachineTokenVerificationError({
code: MachineTokenVerificationErrorCode.TokenInvalid,
message: (e as Error).message,
});
}

const result = await verifyM2MJwt(token, decoded, this.#verifyOptions);
if (result.errors) {
throw result.errors[0];
}
return result.data;
}

async verify(params: VerifyM2MTokenParams) {
const { token, machineSecretKey } = params;

if (isM2MJwt(token)) {
return this.#verifyJwtFormat(token);
}

const requestOptions = this.#createRequestOptions(
{
method: 'POST',
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .changeset/clever-ways-raise.md

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

changeset available in core 2

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
28 changes: 24 additions & 4 deletions integration/tests/machine-auth/m2m.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,10 +42,9 @@ test.describe('machine-to-machine auth @machine', () => {

app.get('/api/protected', async (req, res) => {
const token = req.get('Authorization')?.split(' ')[1];

try {
const m2mToken = await clerkClient.m2m.verify({ token });
res.send('Protected response ' + m2mToken.id);
res.send('Protected response ' + m2mToken.subject);
} catch {
res.status(401).send('Unauthorized');
}
Expand DownExpand Up@@ -150,7 +149,7 @@ test.describe('machine-to-machine auth @machine', () => {
},
});
expect(res.status()).toBe(200);
expect(await res.text()).toBe('Protected response ' + emailServerM2MToken.id);
expect(await res.text()).toBe('Protected response ' + emailServer.id);

// Analytics server can access primary API server after adding scope
await u.services.clerk.machines.createScope(analyticsServer.id, primaryApiServer.id);
Expand All@@ -165,9 +164,30 @@ test.describe('machine-to-machine auth @machine', () => {
},
});
expect(res2.status()).toBe(200);
expect(await res2.text()).toBe('Protected response ' + m2mToken.id);
expect(await res2.text()).toBe('Protected response ' + analyticsServer.id);
await u.services.clerk.m2m.revokeToken({
m2mTokenId: m2mToken.id,
});
});

test('verifies JWT format M2M token via local verification', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

const client = createClerkClient({
secretKey: instanceKeys.get('with-api-keys').sk,
});
const jwtToken = await client.m2m.createToken({
machineSecretKey: emailServer.secretKey,
secondsUntilExpiration: 60 * 30,
tokenFormat: 'jwt',
});

const res = await u.page.request.get(app.serverUrl + '/api/protected', {
headers: { Authorization: `Bearer ${jwtToken.token}` },
});
expect(res.status()).toBe(200);
expect(await res.text()).toBe('Protected response ' + emailServer.id);
// JWT-format tokens are self-contained and not stored in BAPI, so revocation
// is not applicable — they expire naturally via the exp claim.
});
});
2 changes: 0 additions & 2 deletions packages/backend/src/__tests__/exports.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,11 +49,9 @@ describe('subpath /internal exports', () => {
"decorateObjectWithResources",
"getAuthObjectForAcceptedToken",
"getAuthObjectFromJwt",
"getMachineTokenType",
"invalidTokenAuthObject",
"isMachineToken",
"isMachineTokenByPrefix",
"isMachineTokenType",
"isTokenTypeAccepted",
"makeAuthObjectSerializable",
"reverificationError",
Expand Down
196 changes: 195 additions & 1 deletion packages/backend/src/api/__tests__/M2MTokenApi.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { mockJwks, mockJwtPayload, mockM2MJwtPayload, signingJwks } from '../../fixtures';
import { signJwt } from '../../jwt/signJwt';
import { server, validateHeaders } from '../../mock-server';
import { M2MTokenApi } from '../endpoints/M2MTokenApi';
import { createBackendApiClient } from '../factory';
import { buildRequest } from '../request';

describe('M2MToken', () => {
const m2mId = 'mt_1xxxxxxxxxxxxx';
Expand DownExpand Up@@ -110,6 +114,130 @@ describe('M2MToken', () => {
'The provided Machine Secret Key is invalid. Make sure that your Machine Secret Key is correct.',
);
});

it('creates a jwt format m2m token', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
expect(body.token_format).toBe('jwt');
return HttpResponse.json({
...mockM2MToken,
token:
'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Imluc194eHh4eCJ9.eyJqdGkiOiJtdF94eHh4eCIsInN1YiI6Im1jaF94eHh4eCIsImF1ZCI6WyJtY2hfMXh4eHh4IiwibWNoXzJ4eHh4eCJdLCJzY29wZXMiOiJtY2hfMXh4eHh4IG1jaF8yeHh4eHgiLCJpYXQiOjE3NTM3NDMzMTYsImV4cCI6MTc1Mzc0NjkxNn0.signature',
});
}),
),
);

const response = await apiClient.m2m.createToken({
tokenFormat: 'jwt',
});
expect(response.id).toBe(m2mId);
expect(response.token).toMatch(/^[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+$/);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
});

it('creates a jwt m2m token with custom claims and scopes', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

const customClaims = {
role: 'service',
tier: 'gold',
};

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
expect(body.token_format).toBe('jwt');
expect(body.claims).toEqual(customClaims);
return HttpResponse.json({
...mockM2MToken,
claims: customClaims,
token:
'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Imluc194eHh4eCJ9.eyJqdGkiOiJtdF94eHh4eCIsInN1YiI6Im1jaF94eHh4eCIsImF1ZCI6WyJtY2hfMXh4eHh4IiwibWNoXzJ4eHh4eCJdLCJzY29wZXMiOiJtY2hfMXh4eHh4IG1jaF8yeHh4eHgiLCJyb2xlIjoic2VydmljZSIsInRpZXIiOiJnb2xkIiwiaWF0IjoxNzUzNzQzMzE2LCJleHAiOjE3NTM3NDY5MTZ9.signature',
});
}),
),
);

const response = await apiClient.m2m.createToken({
tokenFormat: 'jwt',
claims: customClaims,
});

expect(response.id).toBe(m2mId);
expect(response.token).toMatch(/^[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+$/);
expect(response.claims).toEqual(customClaims);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
});

it('creates an opaque format m2m token when explicitly specified', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
expect(body.token_format).toBe('opaque');
return HttpResponse.json(mockM2MToken);
}),
),
);

const response = await apiClient.m2m.createToken({
tokenFormat: 'opaque',
});

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.token).toMatch(/^mt_.+$/);
});

it('creates an opaque m2m token by default when tokenFormat is omitted', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
// tokenFormat defaults to 'opaque' when omitted
expect(body.token_format).toBe('opaque');
return HttpResponse.json(mockM2MToken);
}),
),
);

const response = await apiClient.m2m.createToken({
secondsUntilExpiration: 3600,
});

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
});
});

describe('revoke', () => {
Expand DownExpand Up@@ -283,6 +411,72 @@ describe('M2MToken', () => {
});
});

async function createSignedM2MJwt(payload = mockM2MJwtPayload) {
const { data } = await signJwt(payload, signingJwks, {
algorithm: 'RS256',
header: { typ: 'JWT', kid: 'ins_2GIoQhbUpy0hX7B2cVkuTMinXoD' },
});
return data!;
}

describe('verify — JWT format', () => {
beforeEach(() => {
vi.useFakeTimers();
vi.setSystemTime(new Date(mockJwtPayload.iat * 1000));
});
afterEach(() => {
vi.useRealTimers();
});

it('verifies a JWT M2M token using secretKey (JWKS lookup)', async () => {
const m2mApi = new M2MTokenApi(
buildRequest({ apiUrl: 'https://api.clerk.test', skipApiVersionInUrl: true, requireSecretKey: false }),
{ secretKey: 'sk_test_xxxxx', apiUrl: 'https://api.clerk.test', skipJwksCache: true },
);

server.use(
http.get(
'https://api.clerk.test/v1/jwks',
validateHeaders(() => HttpResponse.json(mockJwks)),
),
);

const jwtToken = await createSignedM2MJwt();
const result = await m2mApi.verify({ token: jwtToken });

expect(result.id).toBe('mt_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE');
expect(result.subject).toBe('mch_2vYVtestTESTtestTESTtestTESTtest');
expect(result.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
});

it('throws when JWT signature cannot be verified', async () => {
const m2mApi = new M2MTokenApi(
buildRequest({ apiUrl: 'https://api.clerk.test', skipApiVersionInUrl: true, requireSecretKey: false }),
{ secretKey: 'sk_test_xxxxx', apiUrl: 'https://api.clerk.test', skipJwksCache: true },
);

server.use(
http.get(
'https://api.clerk.test/v1/jwks',
validateHeaders(() => HttpResponse.json({ keys: [] })),
),
);

const jwtToken = await createSignedM2MJwt();
await expect(m2mApi.verify({ token: jwtToken })).rejects.toThrow();
});

it('throws when no secretKey or jwtKey is provided', async () => {
const m2mApi = new M2MTokenApi(
buildRequest({ apiUrl: 'https://api.clerk.test', skipApiVersionInUrl: true, requireSecretKey: false }),
{ apiUrl: 'https://api.clerk.test' },
);

const jwtToken = await createSignedM2MJwt();
await expect(m2mApi.verify({ token: jwtToken })).rejects.toThrow('Failed to resolve JWK during verification');
});
});

describe('list', () => {
const machineId = 'mch_1xxxxxxxxxxxxx';
const mockM2MTokenList = {
Expand Down
59 changes: 57 additions & 2 deletions packages/backend/src/api/endpoints/M2MTokenApi.ts
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,25 @@
import type { ClerkPaginationRequest } from '@clerk/shared/types';

import { MachineTokenVerificationError, MachineTokenVerificationErrorCode } from '../../errors';
import { decodeJwt } from '../../jwt/verifyJwt';
import type { JwtMachineVerifyOptions } from '../../jwt/verifyMachineJwt';
import { verifyM2MJwt } from '../../jwt/verifyMachineJwt';
import { isM2MJwt } from '../../tokens/machine';
import { joinPaths } from '../../util/path';
import type { ClerkBackendApiRequestOptions } from '../request';
import type { ClerkBackendApiRequestOptions, RequestFunction } from '../request';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import type { M2MToken } from '../resources/M2MToken';
import { AbstractAPI } from './AbstractApi';

const basePath = '/m2m_tokens';

/**
* Format of the M2M token to create.
* - 'opaque': Opaque token with mt_ prefix
* - 'jwt': JWT signed with instance keys
*/
export type M2MTokenFormat = 'opaque' | 'jwt';

type GetM2MTokenListParams = ClerkPaginationRequest<{
/**
* The machine ID to query machine-to-machine tokens by
Expand DownExpand Up@@ -39,6 +51,10 @@ type CreateM2MTokenParams = {
*/
secondsUntilExpiration?: number | null;
claims?: Record<string, unknown> | null;
/**
* @default 'opaque'
*/
tokenFormat?: M2MTokenFormat;
};

type RevokeM2MTokenParams = {
Expand All@@ -65,6 +81,18 @@ type VerifyM2MTokenParams = {
};

export class M2MTokenApi extends AbstractAPI {
#verifyOptions: JwtMachineVerifyOptions;

/**
* @param verifyOptions - JWT verification options (secretKey, apiUrl, etc.).
* Passed explicitly because BuildRequestOptions are captured inside the buildRequest closure
* and are not accessible from the RequestFunction itself.
*/
constructor(request: RequestFunction, verifyOptions: JwtMachineVerifyOptions = {}) {
super(request);
this.#verifyOptions = verifyOptions;
}

#createRequestOptions(options: ClerkBackendApiRequestOptions, machineSecretKey?: string) {
if (machineSecretKey) {
return {
Expand All@@ -88,7 +116,7 @@ export class M2MTokenApi extends AbstractAPI {
}

async createToken(params?: CreateM2MTokenParams) {
const { claims = null, machineSecretKey, secondsUntilExpiration = null } = params || {};
const { claims = null, machineSecretKey, secondsUntilExpiration = null, tokenFormat = 'opaque' } = params || {};

const requestOptions = this.#createRequestOptions(
{
Expand All@@ -97,6 +125,7 @@ export class M2MTokenApi extends AbstractAPI {
bodyParams: {
secondsUntilExpiration,
claims,
tokenFormat,
},
},
machineSecretKey,
Expand DownExpand Up@@ -124,9 +153,35 @@ export class M2MTokenApi extends AbstractAPI {
return this.request<M2MToken>(requestOptions);
}

async #verifyJwtFormat(token: string): Promise<M2MToken> {
let decoded;
try {
const { data, errors } = decodeJwt(token);
if (errors) {
throw errors[0];
}
decoded = data;
} catch (e) {
throw new MachineTokenVerificationError({
code: MachineTokenVerificationErrorCode.TokenInvalid,
message: (e as Error).message,
});
}

const result = await verifyM2MJwt(token, decoded, this.#verifyOptions);
if (result.errors) {
throw result.errors[0];
}
return result.data;
}

async verify(params: VerifyM2MTokenParams) {
const { token, machineSecretKey } = params;

if (isM2MJwt(token)) {
return this.#verifyJwtFormat(token);
}

const requestOptions = this.#createRequestOptions(
{
method: 'POST',
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .changeset/clever-ways-raise.md

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

changeset available in core 2

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
28 changes: 24 additions & 4 deletions integration/tests/machine-auth/m2m.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,10 +42,9 @@ test.describe('machine-to-machine auth @machine', () => {

app.get('/api/protected', async (req, res) => {
const token = req.get('Authorization')?.split(' ')[1];

try {
const m2mToken = await clerkClient.m2m.verify({ token });
res.send('Protected response ' + m2mToken.id);
res.send('Protected response ' + m2mToken.subject);
} catch {
res.status(401).send('Unauthorized');
}
Expand DownExpand Up@@ -150,7 +149,7 @@ test.describe('machine-to-machine auth @machine', () => {
},
});
expect(res.status()).toBe(200);
expect(await res.text()).toBe('Protected response ' + emailServerM2MToken.id);
expect(await res.text()).toBe('Protected response ' + emailServer.id);

// Analytics server can access primary API server after adding scope
await u.services.clerk.machines.createScope(analyticsServer.id, primaryApiServer.id);
Expand All@@ -165,9 +164,30 @@ test.describe('machine-to-machine auth @machine', () => {
},
});
expect(res2.status()).toBe(200);
expect(await res2.text()).toBe('Protected response ' + m2mToken.id);
expect(await res2.text()).toBe('Protected response ' + analyticsServer.id);
await u.services.clerk.m2m.revokeToken({
m2mTokenId: m2mToken.id,
});
});

test('verifies JWT format M2M token via local verification', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

const client = createClerkClient({
secretKey: instanceKeys.get('with-api-keys').sk,
});
const jwtToken = await client.m2m.createToken({
machineSecretKey: emailServer.secretKey,
secondsUntilExpiration: 60 * 30,
tokenFormat: 'jwt',
});

const res = await u.page.request.get(app.serverUrl + '/api/protected', {
headers: { Authorization: `Bearer ${jwtToken.token}` },
});
expect(res.status()).toBe(200);
expect(await res.text()).toBe('Protected response ' + emailServer.id);
// JWT-format tokens are self-contained and not stored in BAPI, so revocation
// is not applicable — they expire naturally via the exp claim.
});
});
2 changes: 0 additions & 2 deletions packages/backend/src/__tests__/exports.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,11 +49,9 @@ describe('subpath /internal exports', () => {
"decorateObjectWithResources",
"getAuthObjectForAcceptedToken",
"getAuthObjectFromJwt",
"getMachineTokenType",
"invalidTokenAuthObject",
"isMachineToken",
"isMachineTokenByPrefix",
"isMachineTokenType",
"isTokenTypeAccepted",
"makeAuthObjectSerializable",
"reverificationError",
Expand Down
196 changes: 195 additions & 1 deletion packages/backend/src/api/__tests__/M2MTokenApi.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { mockJwks, mockJwtPayload, mockM2MJwtPayload, signingJwks } from '../../fixtures';
import { signJwt } from '../../jwt/signJwt';
import { server, validateHeaders } from '../../mock-server';
import { M2MTokenApi } from '../endpoints/M2MTokenApi';
import { createBackendApiClient } from '../factory';
import { buildRequest } from '../request';

describe('M2MToken', () => {
const m2mId = 'mt_1xxxxxxxxxxxxx';
Expand DownExpand Up@@ -110,6 +114,130 @@ describe('M2MToken', () => {
'The provided Machine Secret Key is invalid. Make sure that your Machine Secret Key is correct.',
);
});

it('creates a jwt format m2m token', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
expect(body.token_format).toBe('jwt');
return HttpResponse.json({
...mockM2MToken,
token:
'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Imluc194eHh4eCJ9.eyJqdGkiOiJtdF94eHh4eCIsInN1YiI6Im1jaF94eHh4eCIsImF1ZCI6WyJtY2hfMXh4eHh4IiwibWNoXzJ4eHh4eCJdLCJzY29wZXMiOiJtY2hfMXh4eHh4IG1jaF8yeHh4eHgiLCJpYXQiOjE3NTM3NDMzMTYsImV4cCI6MTc1Mzc0NjkxNn0.signature',
});
}),
),
);

const response = await apiClient.m2m.createToken({
tokenFormat: 'jwt',
});
expect(response.id).toBe(m2mId);
expect(response.token).toMatch(/^[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+$/);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
});

it('creates a jwt m2m token with custom claims and scopes', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

const customClaims = {
role: 'service',
tier: 'gold',
};

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
expect(body.token_format).toBe('jwt');
expect(body.claims).toEqual(customClaims);
return HttpResponse.json({
...mockM2MToken,
claims: customClaims,
token:
'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Imluc194eHh4eCJ9.eyJqdGkiOiJtdF94eHh4eCIsInN1YiI6Im1jaF94eHh4eCIsImF1ZCI6WyJtY2hfMXh4eHh4IiwibWNoXzJ4eHh4eCJdLCJzY29wZXMiOiJtY2hfMXh4eHh4IG1jaF8yeHh4eHgiLCJyb2xlIjoic2VydmljZSIsInRpZXIiOiJnb2xkIiwiaWF0IjoxNzUzNzQzMzE2LCJleHAiOjE3NTM3NDY5MTZ9.signature',
});
}),
),
);

const response = await apiClient.m2m.createToken({
tokenFormat: 'jwt',
claims: customClaims,
});

expect(response.id).toBe(m2mId);
expect(response.token).toMatch(/^[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+$/);
expect(response.claims).toEqual(customClaims);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
});

it('creates an opaque format m2m token when explicitly specified', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
expect(body.token_format).toBe('opaque');
return HttpResponse.json(mockM2MToken);
}),
),
);

const response = await apiClient.m2m.createToken({
tokenFormat: 'opaque',
});

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.token).toMatch(/^mt_.+$/);
});

it('creates an opaque m2m token by default when tokenFormat is omitted', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
// tokenFormat defaults to 'opaque' when omitted
expect(body.token_format).toBe('opaque');
return HttpResponse.json(mockM2MToken);
}),
),
);

const response = await apiClient.m2m.createToken({
secondsUntilExpiration: 3600,
});

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
});
});

describe('revoke', () => {
Expand DownExpand Up@@ -283,6 +411,72 @@ describe('M2MToken', () => {
});
});

async function createSignedM2MJwt(payload = mockM2MJwtPayload) {
const { data } = await signJwt(payload, signingJwks, {
algorithm: 'RS256',
header: { typ: 'JWT', kid: 'ins_2GIoQhbUpy0hX7B2cVkuTMinXoD' },
});
return data!;
}

describe('verify — JWT format', () => {
beforeEach(() => {
vi.useFakeTimers();
vi.setSystemTime(new Date(mockJwtPayload.iat * 1000));
});
afterEach(() => {
vi.useRealTimers();
});

it('verifies a JWT M2M token using secretKey (JWKS lookup)', async () => {
const m2mApi = new M2MTokenApi(
buildRequest({ apiUrl: 'https://api.clerk.test', skipApiVersionInUrl: true, requireSecretKey: false }),
{ secretKey: 'sk_test_xxxxx', apiUrl: 'https://api.clerk.test', skipJwksCache: true },
);

server.use(
http.get(
'https://api.clerk.test/v1/jwks',
validateHeaders(() => HttpResponse.json(mockJwks)),
),
);

const jwtToken = await createSignedM2MJwt();
const result = await m2mApi.verify({ token: jwtToken });

expect(result.id).toBe('mt_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE');
expect(result.subject).toBe('mch_2vYVtestTESTtestTESTtestTESTtest');
expect(result.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
});

it('throws when JWT signature cannot be verified', async () => {
const m2mApi = new M2MTokenApi(
buildRequest({ apiUrl: 'https://api.clerk.test', skipApiVersionInUrl: true, requireSecretKey: false }),
{ secretKey: 'sk_test_xxxxx', apiUrl: 'https://api.clerk.test', skipJwksCache: true },
);

server.use(
http.get(
'https://api.clerk.test/v1/jwks',
validateHeaders(() => HttpResponse.json({ keys: [] })),
),
);

const jwtToken = await createSignedM2MJwt();
await expect(m2mApi.verify({ token: jwtToken })).rejects.toThrow();
});

it('throws when no secretKey or jwtKey is provided', async () => {
const m2mApi = new M2MTokenApi(
buildRequest({ apiUrl: 'https://api.clerk.test', skipApiVersionInUrl: true, requireSecretKey: false }),
{ apiUrl: 'https://api.clerk.test' },
);

const jwtToken = await createSignedM2MJwt();
await expect(m2mApi.verify({ token: jwtToken })).rejects.toThrow('Failed to resolve JWK during verification');
});
});

describe('list', () => {
const machineId = 'mch_1xxxxxxxxxxxxx';
const mockM2MTokenList = {
Expand Down
59 changes: 57 additions & 2 deletions packages/backend/src/api/endpoints/M2MTokenApi.ts
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,25 @@
import type { ClerkPaginationRequest } from '@clerk/shared/types';

import { MachineTokenVerificationError, MachineTokenVerificationErrorCode } from '../../errors';
import { decodeJwt } from '../../jwt/verifyJwt';
import type { JwtMachineVerifyOptions } from '../../jwt/verifyMachineJwt';
import { verifyM2MJwt } from '../../jwt/verifyMachineJwt';
import { isM2MJwt } from '../../tokens/machine';
import { joinPaths } from '../../util/path';
import type { ClerkBackendApiRequestOptions } from '../request';
import type { ClerkBackendApiRequestOptions, RequestFunction } from '../request';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import type { M2MToken } from '../resources/M2MToken';
import { AbstractAPI } from './AbstractApi';

const basePath = '/m2m_tokens';

/**
* Format of the M2M token to create.
* - 'opaque': Opaque token with mt_ prefix
* - 'jwt': JWT signed with instance keys
*/
export type M2MTokenFormat = 'opaque' | 'jwt';

type GetM2MTokenListParams = ClerkPaginationRequest<{
/**
* The machine ID to query machine-to-machine tokens by
Expand DownExpand Up@@ -39,6 +51,10 @@ type CreateM2MTokenParams = {
*/
secondsUntilExpiration?: number | null;
claims?: Record<string, unknown> | null;
/**
* @default 'opaque'
*/
tokenFormat?: M2MTokenFormat;
};

type RevokeM2MTokenParams = {
Expand All@@ -65,6 +81,18 @@ type VerifyM2MTokenParams = {
};

export class M2MTokenApi extends AbstractAPI {
#verifyOptions: JwtMachineVerifyOptions;

/**
* @param verifyOptions - JWT verification options (secretKey, apiUrl, etc.).
* Passed explicitly because BuildRequestOptions are captured inside the buildRequest closure
* and are not accessible from the RequestFunction itself.
*/
constructor(request: RequestFunction, verifyOptions: JwtMachineVerifyOptions = {}) {
super(request);
this.#verifyOptions = verifyOptions;
}

#createRequestOptions(options: ClerkBackendApiRequestOptions, machineSecretKey?: string) {
if (machineSecretKey) {
return {
Expand All@@ -88,7 +116,7 @@ export class M2MTokenApi extends AbstractAPI {
}

async createToken(params?: CreateM2MTokenParams) {
const { claims = null, machineSecretKey, secondsUntilExpiration = null } = params || {};
const { claims = null, machineSecretKey, secondsUntilExpiration = null, tokenFormat = 'opaque' } = params || {};

const requestOptions = this.#createRequestOptions(
{
Expand All@@ -97,6 +125,7 @@ export class M2MTokenApi extends AbstractAPI {
bodyParams: {
secondsUntilExpiration,
claims,
tokenFormat,
},
},
machineSecretKey,
Expand DownExpand Up@@ -124,9 +153,35 @@ export class M2MTokenApi extends AbstractAPI {
return this.request<M2MToken>(requestOptions);
}

async #verifyJwtFormat(token: string): Promise<M2MToken> {
let decoded;
try {
const { data, errors } = decodeJwt(token);
if (errors) {
throw errors[0];
}
decoded = data;
} catch (e) {
throw new MachineTokenVerificationError({
code: MachineTokenVerificationErrorCode.TokenInvalid,
message: (e as Error).message,
});
}

const result = await verifyM2MJwt(token, decoded, this.#verifyOptions);
if (result.errors) {
throw result.errors[0];
}
return result.data;
}

async verify(params: VerifyM2MTokenParams) {
const { token, machineSecretKey } = params;

if (isM2MJwt(token)) {
return this.#verifyJwtFormat(token);
}

const requestOptions = this.#createRequestOptions(
{
method: 'POST',
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .changeset/clever-ways-raise.md

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

changeset available in core 2

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
28 changes: 24 additions & 4 deletions integration/tests/machine-auth/m2m.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,10 +42,9 @@ test.describe('machine-to-machine auth @machine', () => {

app.get('/api/protected', async (req, res) => {
const token = req.get('Authorization')?.split(' ')[1];

try {
const m2mToken = await clerkClient.m2m.verify({ token });
res.send('Protected response ' + m2mToken.id);
res.send('Protected response ' + m2mToken.subject);
} catch {
res.status(401).send('Unauthorized');
}
Expand DownExpand Up@@ -150,7 +149,7 @@ test.describe('machine-to-machine auth @machine', () => {
},
});
expect(res.status()).toBe(200);
expect(await res.text()).toBe('Protected response ' + emailServerM2MToken.id);
expect(await res.text()).toBe('Protected response ' + emailServer.id);

// Analytics server can access primary API server after adding scope
await u.services.clerk.machines.createScope(analyticsServer.id, primaryApiServer.id);
Expand All@@ -165,9 +164,30 @@ test.describe('machine-to-machine auth @machine', () => {
},
});
expect(res2.status()).toBe(200);
expect(await res2.text()).toBe('Protected response ' + m2mToken.id);
expect(await res2.text()).toBe('Protected response ' + analyticsServer.id);
await u.services.clerk.m2m.revokeToken({
m2mTokenId: m2mToken.id,
});
});

test('verifies JWT format M2M token via local verification', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

const client = createClerkClient({
secretKey: instanceKeys.get('with-api-keys').sk,
});
const jwtToken = await client.m2m.createToken({
machineSecretKey: emailServer.secretKey,
secondsUntilExpiration: 60 * 30,
tokenFormat: 'jwt',
});

const res = await u.page.request.get(app.serverUrl + '/api/protected', {
headers: { Authorization: `Bearer ${jwtToken.token}` },
});
expect(res.status()).toBe(200);
expect(await res.text()).toBe('Protected response ' + emailServer.id);
// JWT-format tokens are self-contained and not stored in BAPI, so revocation
// is not applicable — they expire naturally via the exp claim.
});
});
2 changes: 0 additions & 2 deletions packages/backend/src/__tests__/exports.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,11 +49,9 @@ describe('subpath /internal exports', () => {
"decorateObjectWithResources",
"getAuthObjectForAcceptedToken",
"getAuthObjectFromJwt",
"getMachineTokenType",
"invalidTokenAuthObject",
"isMachineToken",
"isMachineTokenByPrefix",
"isMachineTokenType",
"isTokenTypeAccepted",
"makeAuthObjectSerializable",
"reverificationError",
Expand Down
196 changes: 195 additions & 1 deletion packages/backend/src/api/__tests__/M2MTokenApi.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { mockJwks, mockJwtPayload, mockM2MJwtPayload, signingJwks } from '../../fixtures';
import { signJwt } from '../../jwt/signJwt';
import { server, validateHeaders } from '../../mock-server';
import { M2MTokenApi } from '../endpoints/M2MTokenApi';
import { createBackendApiClient } from '../factory';
import { buildRequest } from '../request';

describe('M2MToken', () => {
const m2mId = 'mt_1xxxxxxxxxxxxx';
Expand DownExpand Up@@ -110,6 +114,130 @@ describe('M2MToken', () => {
'The provided Machine Secret Key is invalid. Make sure that your Machine Secret Key is correct.',
);
});

it('creates a jwt format m2m token', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
expect(body.token_format).toBe('jwt');
return HttpResponse.json({
...mockM2MToken,
token:
'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Imluc194eHh4eCJ9.eyJqdGkiOiJtdF94eHh4eCIsInN1YiI6Im1jaF94eHh4eCIsImF1ZCI6WyJtY2hfMXh4eHh4IiwibWNoXzJ4eHh4eCJdLCJzY29wZXMiOiJtY2hfMXh4eHh4IG1jaF8yeHh4eHgiLCJpYXQiOjE3NTM3NDMzMTYsImV4cCI6MTc1Mzc0NjkxNn0.signature',
});
}),
),
);

const response = await apiClient.m2m.createToken({
tokenFormat: 'jwt',
});
expect(response.id).toBe(m2mId);
expect(response.token).toMatch(/^[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+$/);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
});

it('creates a jwt m2m token with custom claims and scopes', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

const customClaims = {
role: 'service',
tier: 'gold',
};

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
expect(body.token_format).toBe('jwt');
expect(body.claims).toEqual(customClaims);
return HttpResponse.json({
...mockM2MToken,
claims: customClaims,
token:
'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Imluc194eHh4eCJ9.eyJqdGkiOiJtdF94eHh4eCIsInN1YiI6Im1jaF94eHh4eCIsImF1ZCI6WyJtY2hfMXh4eHh4IiwibWNoXzJ4eHh4eCJdLCJzY29wZXMiOiJtY2hfMXh4eHh4IG1jaF8yeHh4eHgiLCJyb2xlIjoic2VydmljZSIsInRpZXIiOiJnb2xkIiwiaWF0IjoxNzUzNzQzMzE2LCJleHAiOjE3NTM3NDY5MTZ9.signature',
});
}),
),
);

const response = await apiClient.m2m.createToken({
tokenFormat: 'jwt',
claims: customClaims,
});

expect(response.id).toBe(m2mId);
expect(response.token).toMatch(/^[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+$/);
expect(response.claims).toEqual(customClaims);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
});

it('creates an opaque format m2m token when explicitly specified', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
expect(body.token_format).toBe('opaque');
return HttpResponse.json(mockM2MToken);
}),
),
);

const response = await apiClient.m2m.createToken({
tokenFormat: 'opaque',
});

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.token).toMatch(/^mt_.+$/);
});

it('creates an opaque m2m token by default when tokenFormat is omitted', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
// tokenFormat defaults to 'opaque' when omitted
expect(body.token_format).toBe('opaque');
return HttpResponse.json(mockM2MToken);
}),
),
);

const response = await apiClient.m2m.createToken({
secondsUntilExpiration: 3600,
});

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
});
});

describe('revoke', () => {
Expand DownExpand Up@@ -283,6 +411,72 @@ describe('M2MToken', () => {
});
});

async function createSignedM2MJwt(payload = mockM2MJwtPayload) {
const { data } = await signJwt(payload, signingJwks, {
algorithm: 'RS256',
header: { typ: 'JWT', kid: 'ins_2GIoQhbUpy0hX7B2cVkuTMinXoD' },
});
return data!;
}

describe('verify — JWT format', () => {
beforeEach(() => {
vi.useFakeTimers();
vi.setSystemTime(new Date(mockJwtPayload.iat * 1000));
});
afterEach(() => {
vi.useRealTimers();
});

it('verifies a JWT M2M token using secretKey (JWKS lookup)', async () => {
const m2mApi = new M2MTokenApi(
buildRequest({ apiUrl: 'https://api.clerk.test', skipApiVersionInUrl: true, requireSecretKey: false }),
{ secretKey: 'sk_test_xxxxx', apiUrl: 'https://api.clerk.test', skipJwksCache: true },
);

server.use(
http.get(
'https://api.clerk.test/v1/jwks',
validateHeaders(() => HttpResponse.json(mockJwks)),
),
);

const jwtToken = await createSignedM2MJwt();
const result = await m2mApi.verify({ token: jwtToken });

expect(result.id).toBe('mt_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE');
expect(result.subject).toBe('mch_2vYVtestTESTtestTESTtestTESTtest');
expect(result.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
});

it('throws when JWT signature cannot be verified', async () => {
const m2mApi = new M2MTokenApi(
buildRequest({ apiUrl: 'https://api.clerk.test', skipApiVersionInUrl: true, requireSecretKey: false }),
{ secretKey: 'sk_test_xxxxx', apiUrl: 'https://api.clerk.test', skipJwksCache: true },
);

server.use(
http.get(
'https://api.clerk.test/v1/jwks',
validateHeaders(() => HttpResponse.json({ keys: [] })),
),
);

const jwtToken = await createSignedM2MJwt();
await expect(m2mApi.verify({ token: jwtToken })).rejects.toThrow();
});

it('throws when no secretKey or jwtKey is provided', async () => {
const m2mApi = new M2MTokenApi(
buildRequest({ apiUrl: 'https://api.clerk.test', skipApiVersionInUrl: true, requireSecretKey: false }),
{ apiUrl: 'https://api.clerk.test' },
);

const jwtToken = await createSignedM2MJwt();
await expect(m2mApi.verify({ token: jwtToken })).rejects.toThrow('Failed to resolve JWK during verification');
});
});

describe('list', () => {
const machineId = 'mch_1xxxxxxxxxxxxx';
const mockM2MTokenList = {
Expand Down
59 changes: 57 additions & 2 deletions packages/backend/src/api/endpoints/M2MTokenApi.ts
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,25 @@
import type { ClerkPaginationRequest } from '@clerk/shared/types';

import { MachineTokenVerificationError, MachineTokenVerificationErrorCode } from '../../errors';
import { decodeJwt } from '../../jwt/verifyJwt';
import type { JwtMachineVerifyOptions } from '../../jwt/verifyMachineJwt';
import { verifyM2MJwt } from '../../jwt/verifyMachineJwt';
import { isM2MJwt } from '../../tokens/machine';
import { joinPaths } from '../../util/path';
import type { ClerkBackendApiRequestOptions } from '../request';
import type { ClerkBackendApiRequestOptions, RequestFunction } from '../request';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import type { M2MToken } from '../resources/M2MToken';
import { AbstractAPI } from './AbstractApi';

const basePath = '/m2m_tokens';

/**
* Format of the M2M token to create.
* - 'opaque': Opaque token with mt_ prefix
* - 'jwt': JWT signed with instance keys
*/
export type M2MTokenFormat = 'opaque' | 'jwt';

type GetM2MTokenListParams = ClerkPaginationRequest<{
/**
* The machine ID to query machine-to-machine tokens by
Expand DownExpand Up@@ -39,6 +51,10 @@ type CreateM2MTokenParams = {
*/
secondsUntilExpiration?: number | null;
claims?: Record<string, unknown> | null;
/**
* @default 'opaque'
*/
tokenFormat?: M2MTokenFormat;
};

type RevokeM2MTokenParams = {
Expand All@@ -65,6 +81,18 @@ type VerifyM2MTokenParams = {
};

export class M2MTokenApi extends AbstractAPI {
#verifyOptions: JwtMachineVerifyOptions;

/**
* @param verifyOptions - JWT verification options (secretKey, apiUrl, etc.).
* Passed explicitly because BuildRequestOptions are captured inside the buildRequest closure
* and are not accessible from the RequestFunction itself.
*/
constructor(request: RequestFunction, verifyOptions: JwtMachineVerifyOptions = {}) {
super(request);
this.#verifyOptions = verifyOptions;
}

#createRequestOptions(options: ClerkBackendApiRequestOptions, machineSecretKey?: string) {
if (machineSecretKey) {
return {
Expand All@@ -88,7 +116,7 @@ export class M2MTokenApi extends AbstractAPI {
}

async createToken(params?: CreateM2MTokenParams) {
const { claims = null, machineSecretKey, secondsUntilExpiration = null } = params || {};
const { claims = null, machineSecretKey, secondsUntilExpiration = null, tokenFormat = 'opaque' } = params || {};

const requestOptions = this.#createRequestOptions(
{
Expand All@@ -97,6 +125,7 @@ export class M2MTokenApi extends AbstractAPI {
bodyParams: {
secondsUntilExpiration,
claims,
tokenFormat,
},
},
machineSecretKey,
Expand DownExpand Up@@ -124,9 +153,35 @@ export class M2MTokenApi extends AbstractAPI {
return this.request<M2MToken>(requestOptions);
}

async #verifyJwtFormat(token: string): Promise<M2MToken> {
let decoded;
try {
const { data, errors } = decodeJwt(token);
if (errors) {
throw errors[0];
}
decoded = data;
} catch (e) {
throw new MachineTokenVerificationError({
code: MachineTokenVerificationErrorCode.TokenInvalid,
message: (e as Error).message,
});
}

const result = await verifyM2MJwt(token, decoded, this.#verifyOptions);
if (result.errors) {
throw result.errors[0];
}
return result.data;
}

async verify(params: VerifyM2MTokenParams) {
const { token, machineSecretKey } = params;

if (isM2MJwt(token)) {
return this.#verifyJwtFormat(token);
}

const requestOptions = this.#createRequestOptions(
{
method: 'POST',
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .changeset/clever-ways-raise.md

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

changeset available in core 2

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
28 changes: 24 additions & 4 deletions integration/tests/machine-auth/m2m.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,10 +42,9 @@ test.describe('machine-to-machine auth @machine', () => {

app.get('/api/protected', async (req, res) => {
const token = req.get('Authorization')?.split(' ')[1];

try {
const m2mToken = await clerkClient.m2m.verify({ token });
res.send('Protected response ' + m2mToken.id);
res.send('Protected response ' + m2mToken.subject);
} catch {
res.status(401).send('Unauthorized');
}
Expand DownExpand Up@@ -150,7 +149,7 @@ test.describe('machine-to-machine auth @machine', () => {
},
});
expect(res.status()).toBe(200);
expect(await res.text()).toBe('Protected response ' + emailServerM2MToken.id);
expect(await res.text()).toBe('Protected response ' + emailServer.id);

// Analytics server can access primary API server after adding scope
await u.services.clerk.machines.createScope(analyticsServer.id, primaryApiServer.id);
Expand All@@ -165,9 +164,30 @@ test.describe('machine-to-machine auth @machine', () => {
},
});
expect(res2.status()).toBe(200);
expect(await res2.text()).toBe('Protected response ' + m2mToken.id);
expect(await res2.text()).toBe('Protected response ' + analyticsServer.id);
await u.services.clerk.m2m.revokeToken({
m2mTokenId: m2mToken.id,
});
});

test('verifies JWT format M2M token via local verification', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

const client = createClerkClient({
secretKey: instanceKeys.get('with-api-keys').sk,
});
const jwtToken = await client.m2m.createToken({
machineSecretKey: emailServer.secretKey,
secondsUntilExpiration: 60 * 30,
tokenFormat: 'jwt',
});

const res = await u.page.request.get(app.serverUrl + '/api/protected', {
headers: { Authorization: `Bearer ${jwtToken.token}` },
});
expect(res.status()).toBe(200);
expect(await res.text()).toBe('Protected response ' + emailServer.id);
// JWT-format tokens are self-contained and not stored in BAPI, so revocation
// is not applicable — they expire naturally via the exp claim.
});
});
2 changes: 0 additions & 2 deletions packages/backend/src/__tests__/exports.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,11 +49,9 @@ describe('subpath /internal exports', () => {
"decorateObjectWithResources",
"getAuthObjectForAcceptedToken",
"getAuthObjectFromJwt",
"getMachineTokenType",
"invalidTokenAuthObject",
"isMachineToken",
"isMachineTokenByPrefix",
"isMachineTokenType",
"isTokenTypeAccepted",
"makeAuthObjectSerializable",
"reverificationError",
Expand Down
196 changes: 195 additions & 1 deletion packages/backend/src/api/__tests__/M2MTokenApi.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { mockJwks, mockJwtPayload, mockM2MJwtPayload, signingJwks } from '../../fixtures';
import { signJwt } from '../../jwt/signJwt';
import { server, validateHeaders } from '../../mock-server';
import { M2MTokenApi } from '../endpoints/M2MTokenApi';
import { createBackendApiClient } from '../factory';
import { buildRequest } from '../request';

describe('M2MToken', () => {
const m2mId = 'mt_1xxxxxxxxxxxxx';
Expand DownExpand Up@@ -110,6 +114,130 @@ describe('M2MToken', () => {
'The provided Machine Secret Key is invalid. Make sure that your Machine Secret Key is correct.',
);
});

it('creates a jwt format m2m token', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
expect(body.token_format).toBe('jwt');
return HttpResponse.json({
...mockM2MToken,
token:
'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Imluc194eHh4eCJ9.eyJqdGkiOiJtdF94eHh4eCIsInN1YiI6Im1jaF94eHh4eCIsImF1ZCI6WyJtY2hfMXh4eHh4IiwibWNoXzJ4eHh4eCJdLCJzY29wZXMiOiJtY2hfMXh4eHh4IG1jaF8yeHh4eHgiLCJpYXQiOjE3NTM3NDMzMTYsImV4cCI6MTc1Mzc0NjkxNn0.signature',
});
}),
),
);

const response = await apiClient.m2m.createToken({
tokenFormat: 'jwt',
});
expect(response.id).toBe(m2mId);
expect(response.token).toMatch(/^[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+$/);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
});

it('creates a jwt m2m token with custom claims and scopes', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

const customClaims = {
role: 'service',
tier: 'gold',
};

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
expect(body.token_format).toBe('jwt');
expect(body.claims).toEqual(customClaims);
return HttpResponse.json({
...mockM2MToken,
claims: customClaims,
token:
'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Imluc194eHh4eCJ9.eyJqdGkiOiJtdF94eHh4eCIsInN1YiI6Im1jaF94eHh4eCIsImF1ZCI6WyJtY2hfMXh4eHh4IiwibWNoXzJ4eHh4eCJdLCJzY29wZXMiOiJtY2hfMXh4eHh4IG1jaF8yeHh4eHgiLCJyb2xlIjoic2VydmljZSIsInRpZXIiOiJnb2xkIiwiaWF0IjoxNzUzNzQzMzE2LCJleHAiOjE3NTM3NDY5MTZ9.signature',
});
}),
),
);

const response = await apiClient.m2m.createToken({
tokenFormat: 'jwt',
claims: customClaims,
});

expect(response.id).toBe(m2mId);
expect(response.token).toMatch(/^[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+$/);
expect(response.claims).toEqual(customClaims);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
});

it('creates an opaque format m2m token when explicitly specified', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
expect(body.token_format).toBe('opaque');
return HttpResponse.json(mockM2MToken);
}),
),
);

const response = await apiClient.m2m.createToken({
tokenFormat: 'opaque',
});

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.token).toMatch(/^mt_.+$/);
});

it('creates an opaque m2m token by default when tokenFormat is omitted', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
// tokenFormat defaults to 'opaque' when omitted
expect(body.token_format).toBe('opaque');
return HttpResponse.json(mockM2MToken);
}),
),
);

const response = await apiClient.m2m.createToken({
secondsUntilExpiration: 3600,
});

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
});
});

describe('revoke', () => {
Expand DownExpand Up@@ -283,6 +411,72 @@ describe('M2MToken', () => {
});
});

async function createSignedM2MJwt(payload = mockM2MJwtPayload) {
const { data } = await signJwt(payload, signingJwks, {
algorithm: 'RS256',
header: { typ: 'JWT', kid: 'ins_2GIoQhbUpy0hX7B2cVkuTMinXoD' },
});
return data!;
}

describe('verify — JWT format', () => {
beforeEach(() => {
vi.useFakeTimers();
vi.setSystemTime(new Date(mockJwtPayload.iat * 1000));
});
afterEach(() => {
vi.useRealTimers();
});

it('verifies a JWT M2M token using secretKey (JWKS lookup)', async () => {
const m2mApi = new M2MTokenApi(
buildRequest({ apiUrl: 'https://api.clerk.test', skipApiVersionInUrl: true, requireSecretKey: false }),
{ secretKey: 'sk_test_xxxxx', apiUrl: 'https://api.clerk.test', skipJwksCache: true },
);

server.use(
http.get(
'https://api.clerk.test/v1/jwks',
validateHeaders(() => HttpResponse.json(mockJwks)),
),
);

const jwtToken = await createSignedM2MJwt();
const result = await m2mApi.verify({ token: jwtToken });

expect(result.id).toBe('mt_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE');
expect(result.subject).toBe('mch_2vYVtestTESTtestTESTtestTESTtest');
expect(result.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
});

it('throws when JWT signature cannot be verified', async () => {
const m2mApi = new M2MTokenApi(
buildRequest({ apiUrl: 'https://api.clerk.test', skipApiVersionInUrl: true, requireSecretKey: false }),
{ secretKey: 'sk_test_xxxxx', apiUrl: 'https://api.clerk.test', skipJwksCache: true },
);

server.use(
http.get(
'https://api.clerk.test/v1/jwks',
validateHeaders(() => HttpResponse.json({ keys: [] })),
),
);

const jwtToken = await createSignedM2MJwt();
await expect(m2mApi.verify({ token: jwtToken })).rejects.toThrow();
});

it('throws when no secretKey or jwtKey is provided', async () => {
const m2mApi = new M2MTokenApi(
buildRequest({ apiUrl: 'https://api.clerk.test', skipApiVersionInUrl: true, requireSecretKey: false }),
{ apiUrl: 'https://api.clerk.test' },
);

const jwtToken = await createSignedM2MJwt();
await expect(m2mApi.verify({ token: jwtToken })).rejects.toThrow('Failed to resolve JWK during verification');
});
});

describe('list', () => {
const machineId = 'mch_1xxxxxxxxxxxxx';
const mockM2MTokenList = {
Expand Down
59 changes: 57 additions & 2 deletions packages/backend/src/api/endpoints/M2MTokenApi.ts
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,25 @@
import type { ClerkPaginationRequest } from '@clerk/shared/types';

import { MachineTokenVerificationError, MachineTokenVerificationErrorCode } from '../../errors';
import { decodeJwt } from '../../jwt/verifyJwt';
import type { JwtMachineVerifyOptions } from '../../jwt/verifyMachineJwt';
import { verifyM2MJwt } from '../../jwt/verifyMachineJwt';
import { isM2MJwt } from '../../tokens/machine';
import { joinPaths } from '../../util/path';
import type { ClerkBackendApiRequestOptions } from '../request';
import type { ClerkBackendApiRequestOptions, RequestFunction } from '../request';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import type { M2MToken } from '../resources/M2MToken';
import { AbstractAPI } from './AbstractApi';

const basePath = '/m2m_tokens';

/**
* Format of the M2M token to create.
* - 'opaque': Opaque token with mt_ prefix
* - 'jwt': JWT signed with instance keys
*/
export type M2MTokenFormat = 'opaque' | 'jwt';

type GetM2MTokenListParams = ClerkPaginationRequest<{
/**
* The machine ID to query machine-to-machine tokens by
Expand DownExpand Up@@ -39,6 +51,10 @@ type CreateM2MTokenParams = {
*/
secondsUntilExpiration?: number | null;
claims?: Record<string, unknown> | null;
/**
* @default 'opaque'
*/
tokenFormat?: M2MTokenFormat;
};

type RevokeM2MTokenParams = {
Expand All@@ -65,6 +81,18 @@ type VerifyM2MTokenParams = {
};

export class M2MTokenApi extends AbstractAPI {
#verifyOptions: JwtMachineVerifyOptions;

/**
* @param verifyOptions - JWT verification options (secretKey, apiUrl, etc.).
* Passed explicitly because BuildRequestOptions are captured inside the buildRequest closure
* and are not accessible from the RequestFunction itself.
*/
constructor(request: RequestFunction, verifyOptions: JwtMachineVerifyOptions = {}) {
super(request);
this.#verifyOptions = verifyOptions;
}

#createRequestOptions(options: ClerkBackendApiRequestOptions, machineSecretKey?: string) {
if (machineSecretKey) {
return {
Expand All@@ -88,7 +116,7 @@ export class M2MTokenApi extends AbstractAPI {
}

async createToken(params?: CreateM2MTokenParams) {
const { claims = null, machineSecretKey, secondsUntilExpiration = null } = params || {};
const { claims = null, machineSecretKey, secondsUntilExpiration = null, tokenFormat = 'opaque' } = params || {};

const requestOptions = this.#createRequestOptions(
{
Expand All@@ -97,6 +125,7 @@ export class M2MTokenApi extends AbstractAPI {
bodyParams: {
secondsUntilExpiration,
claims,
tokenFormat,
},
},
machineSecretKey,
Expand DownExpand Up@@ -124,9 +153,35 @@ export class M2MTokenApi extends AbstractAPI {
return this.request<M2MToken>(requestOptions);
}

async #verifyJwtFormat(token: string): Promise<M2MToken> {
let decoded;
try {
const { data, errors } = decodeJwt(token);
if (errors) {
throw errors[0];
}
decoded = data;
} catch (e) {
throw new MachineTokenVerificationError({
code: MachineTokenVerificationErrorCode.TokenInvalid,
message: (e as Error).message,
});
}

const result = await verifyM2MJwt(token, decoded, this.#verifyOptions);
if (result.errors) {
throw result.errors[0];
}
return result.data;
}

async verify(params: VerifyM2MTokenParams) {
const { token, machineSecretKey } = params;

if (isM2MJwt(token)) {
return this.#verifyJwtFormat(token);
}

const requestOptions = this.#createRequestOptions(
{
method: 'POST',
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .changeset/clever-ways-raise.md

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

changeset available in core 2

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
28 changes: 24 additions & 4 deletions integration/tests/machine-auth/m2m.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,10 +42,9 @@ test.describe('machine-to-machine auth @machine', () => {

app.get('/api/protected', async (req, res) => {
const token = req.get('Authorization')?.split(' ')[1];

try {
const m2mToken = await clerkClient.m2m.verify({ token });
res.send('Protected response ' + m2mToken.id);
res.send('Protected response ' + m2mToken.subject);
} catch {
res.status(401).send('Unauthorized');
}
Expand DownExpand Up@@ -150,7 +149,7 @@ test.describe('machine-to-machine auth @machine', () => {
},
});
expect(res.status()).toBe(200);
expect(await res.text()).toBe('Protected response ' + emailServerM2MToken.id);
expect(await res.text()).toBe('Protected response ' + emailServer.id);

// Analytics server can access primary API server after adding scope
await u.services.clerk.machines.createScope(analyticsServer.id, primaryApiServer.id);
Expand All@@ -165,9 +164,30 @@ test.describe('machine-to-machine auth @machine', () => {
},
});
expect(res2.status()).toBe(200);
expect(await res2.text()).toBe('Protected response ' + m2mToken.id);
expect(await res2.text()).toBe('Protected response ' + analyticsServer.id);
await u.services.clerk.m2m.revokeToken({
m2mTokenId: m2mToken.id,
});
});

test('verifies JWT format M2M token via local verification', async ({ page, context }) => {
const u = createTestUtils({ app, page, context });

const client = createClerkClient({
secretKey: instanceKeys.get('with-api-keys').sk,
});
const jwtToken = await client.m2m.createToken({
machineSecretKey: emailServer.secretKey,
secondsUntilExpiration: 60 * 30,
tokenFormat: 'jwt',
});

const res = await u.page.request.get(app.serverUrl + '/api/protected', {
headers: { Authorization: `Bearer ${jwtToken.token}` },
});
expect(res.status()).toBe(200);
expect(await res.text()).toBe('Protected response ' + emailServer.id);
// JWT-format tokens are self-contained and not stored in BAPI, so revocation
// is not applicable — they expire naturally via the exp claim.
});
});
2 changes: 0 additions & 2 deletions packages/backend/src/__tests__/exports.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,11 +49,9 @@ describe('subpath /internal exports', () => {
"decorateObjectWithResources",
"getAuthObjectForAcceptedToken",
"getAuthObjectFromJwt",
"getMachineTokenType",
"invalidTokenAuthObject",
"isMachineToken",
"isMachineTokenByPrefix",
"isMachineTokenType",
"isTokenTypeAccepted",
"makeAuthObjectSerializable",
"reverificationError",
Expand Down
196 changes: 195 additions & 1 deletion packages/backend/src/api/__tests__/M2MTokenApi.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

import { mockJwks, mockJwtPayload, mockM2MJwtPayload, signingJwks } from '../../fixtures';
import { signJwt } from '../../jwt/signJwt';
import { server, validateHeaders } from '../../mock-server';
import { M2MTokenApi } from '../endpoints/M2MTokenApi';
import { createBackendApiClient } from '../factory';
import { buildRequest } from '../request';

describe('M2MToken', () => {
const m2mId = 'mt_1xxxxxxxxxxxxx';
Expand DownExpand Up@@ -110,6 +114,130 @@ describe('M2MToken', () => {
'The provided Machine Secret Key is invalid. Make sure that your Machine Secret Key is correct.',
);
});

it('creates a jwt format m2m token', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
expect(body.token_format).toBe('jwt');
return HttpResponse.json({
...mockM2MToken,
token:
'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Imluc194eHh4eCJ9.eyJqdGkiOiJtdF94eHh4eCIsInN1YiI6Im1jaF94eHh4eCIsImF1ZCI6WyJtY2hfMXh4eHh4IiwibWNoXzJ4eHh4eCJdLCJzY29wZXMiOiJtY2hfMXh4eHh4IG1jaF8yeHh4eHgiLCJpYXQiOjE3NTM3NDMzMTYsImV4cCI6MTc1Mzc0NjkxNn0.signature',
});
}),
),
);

const response = await apiClient.m2m.createToken({
tokenFormat: 'jwt',
});
expect(response.id).toBe(m2mId);
expect(response.token).toMatch(/^[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+$/);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
});

it('creates a jwt m2m token with custom claims and scopes', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

const customClaims = {
role: 'service',
tier: 'gold',
};

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
expect(body.token_format).toBe('jwt');
expect(body.claims).toEqual(customClaims);
return HttpResponse.json({
...mockM2MToken,
claims: customClaims,
token:
'eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Imluc194eHh4eCJ9.eyJqdGkiOiJtdF94eHh4eCIsInN1YiI6Im1jaF94eHh4eCIsImF1ZCI6WyJtY2hfMXh4eHh4IiwibWNoXzJ4eHh4eCJdLCJzY29wZXMiOiJtY2hfMXh4eHh4IG1jaF8yeHh4eHgiLCJyb2xlIjoic2VydmljZSIsInRpZXIiOiJnb2xkIiwiaWF0IjoxNzUzNzQzMzE2LCJleHAiOjE3NTM3NDY5MTZ9.signature',
});
}),
),
);

const response = await apiClient.m2m.createToken({
tokenFormat: 'jwt',
claims: customClaims,
});

expect(response.id).toBe(m2mId);
expect(response.token).toMatch(/^[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+\.[a-zA-Z0-9\-_]+$/);
expect(response.claims).toEqual(customClaims);
expect(response.scopes).toEqual(['mch_1xxxxxxxxxxxxx', 'mch_2xxxxxxxxxxxxx']);
});

it('creates an opaque format m2m token when explicitly specified', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
expect(body.token_format).toBe('opaque');
return HttpResponse.json(mockM2MToken);
}),
),
);

const response = await apiClient.m2m.createToken({
tokenFormat: 'opaque',
});

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
expect(response.token).toMatch(/^mt_.+$/);
});

it('creates an opaque m2m token by default when tokenFormat is omitted', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
machineSecretKey: 'ak_xxxxx',
});

server.use(
http.post(
'https://api.clerk.test/m2m_tokens',
validateHeaders(async ({ request }) => {
expect(request.headers.get('Authorization')).toBe('Bearer ak_xxxxx');
const body = (await request.json()) as Record<string, unknown>;
// tokenFormat defaults to 'opaque' when omitted
expect(body.token_format).toBe('opaque');
return HttpResponse.json(mockM2MToken);
}),
),
);

const response = await apiClient.m2m.createToken({
secondsUntilExpiration: 3600,
});

expect(response.id).toBe(m2mId);
expect(response.token).toBe(m2mSecret);
});
});

describe('revoke', () => {
Expand DownExpand Up@@ -283,6 +411,72 @@ describe('M2MToken', () => {
});
});

async function createSignedM2MJwt(payload = mockM2MJwtPayload) {
const { data } = await signJwt(payload, signingJwks, {
algorithm: 'RS256',
header: { typ: 'JWT', kid: 'ins_2GIoQhbUpy0hX7B2cVkuTMinXoD' },
});
return data!;
}

describe('verify — JWT format', () => {
beforeEach(() => {
vi.useFakeTimers();
vi.setSystemTime(new Date(mockJwtPayload.iat * 1000));
});
afterEach(() => {
vi.useRealTimers();
});

it('verifies a JWT M2M token using secretKey (JWKS lookup)', async () => {
const m2mApi = new M2MTokenApi(
buildRequest({ apiUrl: 'https://api.clerk.test', skipApiVersionInUrl: true, requireSecretKey: false }),
{ secretKey: 'sk_test_xxxxx', apiUrl: 'https://api.clerk.test', skipJwksCache: true },
);

server.use(
http.get(
'https://api.clerk.test/v1/jwks',
validateHeaders(() => HttpResponse.json(mockJwks)),
),
);

const jwtToken = await createSignedM2MJwt();
const result = await m2mApi.verify({ token: jwtToken });

expect(result.id).toBe('mt_2xKa9Bgv7NxMRDFyQw8LpZ3cTmU1vHjE');
expect(result.subject).toBe('mch_2vYVtestTESTtestTESTtestTESTtest');
expect(result.scopes).toEqual(['mch_1xxxxx', 'mch_2xxxxx']);
});

it('throws when JWT signature cannot be verified', async () => {
const m2mApi = new M2MTokenApi(
buildRequest({ apiUrl: 'https://api.clerk.test', skipApiVersionInUrl: true, requireSecretKey: false }),
{ secretKey: 'sk_test_xxxxx', apiUrl: 'https://api.clerk.test', skipJwksCache: true },
);

server.use(
http.get(
'https://api.clerk.test/v1/jwks',
validateHeaders(() => HttpResponse.json({ keys: [] })),
),
);

const jwtToken = await createSignedM2MJwt();
await expect(m2mApi.verify({ token: jwtToken })).rejects.toThrow();
});

it('throws when no secretKey or jwtKey is provided', async () => {
const m2mApi = new M2MTokenApi(
buildRequest({ apiUrl: 'https://api.clerk.test', skipApiVersionInUrl: true, requireSecretKey: false }),
{ apiUrl: 'https://api.clerk.test' },
);

const jwtToken = await createSignedM2MJwt();
await expect(m2mApi.verify({ token: jwtToken })).rejects.toThrow('Failed to resolve JWK during verification');
});
});

describe('list', () => {
const machineId = 'mch_1xxxxxxxxxxxxx';
const mockM2MTokenList = {
Expand Down
59 changes: 57 additions & 2 deletions packages/backend/src/api/endpoints/M2MTokenApi.ts
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,25 @@
import type { ClerkPaginationRequest } from '@clerk/shared/types';

import { MachineTokenVerificationError, MachineTokenVerificationErrorCode } from '../../errors';
import { decodeJwt } from '../../jwt/verifyJwt';
import type { JwtMachineVerifyOptions } from '../../jwt/verifyMachineJwt';
import { verifyM2MJwt } from '../../jwt/verifyMachineJwt';
import { isM2MJwt } from '../../tokens/machine';
import { joinPaths } from '../../util/path';
import type { ClerkBackendApiRequestOptions } from '../request';
import type { ClerkBackendApiRequestOptions, RequestFunction } from '../request';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import type { M2MToken } from '../resources/M2MToken';
import { AbstractAPI } from './AbstractApi';

const basePath = '/m2m_tokens';

/**
* Format of the M2M token to create.
* - 'opaque': Opaque token with mt_ prefix
* - 'jwt': JWT signed with instance keys
*/
export type M2MTokenFormat = 'opaque' | 'jwt';

type GetM2MTokenListParams = ClerkPaginationRequest<{
/**
* The machine ID to query machine-to-machine tokens by
Expand DownExpand Up@@ -39,6 +51,10 @@ type CreateM2MTokenParams = {
*/
secondsUntilExpiration?: number | null;
claims?: Record<string, unknown> | null;
/**
* @default 'opaque'
*/
tokenFormat?: M2MTokenFormat;
};

type RevokeM2MTokenParams = {
Expand All@@ -65,6 +81,18 @@ type VerifyM2MTokenParams = {
};

export class M2MTokenApi extends AbstractAPI {
#verifyOptions: JwtMachineVerifyOptions;

/**
* @param verifyOptions - JWT verification options (secretKey, apiUrl, etc.).
* Passed explicitly because BuildRequestOptions are captured inside the buildRequest closure
* and are not accessible from the RequestFunction itself.
*/
constructor(request: RequestFunction, verifyOptions: JwtMachineVerifyOptions = {}) {
super(request);
this.#verifyOptions = verifyOptions;
}

#createRequestOptions(options: ClerkBackendApiRequestOptions, machineSecretKey?: string) {
if (machineSecretKey) {
return {
Expand All@@ -88,7 +116,7 @@ export class M2MTokenApi extends AbstractAPI {
}

async createToken(params?: CreateM2MTokenParams) {
const { claims = null, machineSecretKey, secondsUntilExpiration = null } = params || {};
const { claims = null, machineSecretKey, secondsUntilExpiration = null, tokenFormat = 'opaque' } = params || {};

const requestOptions = this.#createRequestOptions(
{
Expand All@@ -97,6 +125,7 @@ export class M2MTokenApi extends AbstractAPI {
bodyParams: {
secondsUntilExpiration,
claims,
tokenFormat,
},
},
machineSecretKey,
Expand DownExpand Up@@ -124,9 +153,35 @@ export class M2MTokenApi extends AbstractAPI {
return this.request<M2MToken>(requestOptions);
}

async #verifyJwtFormat(token: string): Promise<M2MToken> {
let decoded;
try {
const { data, errors } = decodeJwt(token);
if (errors) {
throw errors[0];
}
decoded = data;
} catch (e) {
throw new MachineTokenVerificationError({
code: MachineTokenVerificationErrorCode.TokenInvalid,
message: (e as Error).message,
});
}

const result = await verifyM2MJwt(token, decoded, this.#verifyOptions);
if (result.errors) {
throw result.errors[0];
}
return result.data;
}

async verify(params: VerifyM2MTokenParams) {
const { token, machineSecretKey } = params;

if (isM2MJwt(token)) {
return this.#verifyJwtFormat(token);
}

const requestOptions = this.#createRequestOptions(
{
method: 'POST',
Expand Down
Loading
Loading