Skip to content
11 changes: 11 additions & 0 deletions .changeset/keyless-ci-guard.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
---
'@clerk/astro': patch
'@clerk/backend': patch
'@clerk/nextjs': patch
'@clerk/nuxt': patch
'@clerk/react-router': patch
'@clerk/shared': patch
'@clerk/tanstack-react-start': patch
---

Prevent keyless mode from activating in CI and other automated environments in framework SDKs.
16 changes: 15 additions & 1 deletion integration/models/__tests__/application.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { describe, expect, it } from 'vitest';

import { resolveServerUrl } from '../application';
import { createAppRuntimeEnv, resolveServerUrl } from '../application';
import { environmentConfig } from '../environment';

describe('resolveServerUrl', () => {
describe('with opts.serverUrl', () => {
Expand DownExpand Up@@ -49,3 +50,16 @@ describe('resolveServerUrl', () => {
});
});
});

describe('createAppRuntimeEnv', () => {
it('passes configured falsey values through to spawned app processes', () => {
const env = environmentConfig()
.setEnvVariable('private', 'CI', 'false')
.setEnvVariable('public', 'CLERK_KEYLESS_DISABLED', false);

expect(createAppRuntimeEnv(env)).toMatchObject({
CI: 'false',
CLERK_KEYLESS_DISABLED: 'false',
});
});
});
23 changes: 21 additions & 2 deletions integration/models/application.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,24 @@ export const resolveServerUrl = (
return fallbackServerUrl || `http://localhost:${port}`;
};

export const createAppRuntimeEnv = (env?: EnvironmentConfig): Record<string, string> => {
if (!env?.publicVariables || !env?.privateVariables) {
return {};
}

const runtimeEnv: Record<string, string> = {};
// Private variables intentionally win when the same runtime key exists in both maps.
for (const [key, value] of [...env.publicVariables, ...env.privateVariables]) {
if (value === undefined || value === null) {
continue;
}

runtimeEnv[key] = String(value);
}

return runtimeEnv;
};

export const application = (
config: ApplicationConfig,
appDirPath: string,
Expand DownExpand Up@@ -103,7 +121,7 @@ export const application = (

const proc = run(scripts.dev, {
cwd: appDirPath,
env: { PORT: port.toString() },
env: { ...createAppRuntimeEnv(state.env), PORT: port.toString() },
detached: opts.detached,
stdout: opts.detached ? fs.openSync(stdoutFilePath, 'a') : undefined,
stderr: opts.detached ? fs.openSync(stderrFilePath, 'a') : undefined,
Expand DownExpand Up@@ -158,6 +176,7 @@ export const application = (
const log = logger.child({ prefix: 'build' }).info;
await run(scripts.build, {
cwd: appDirPath,
env: createAppRuntimeEnv(state.env),
log: (msg: string) => {
buildOutput += `\n${msg}`;
log(msg);
Expand DownExpand Up@@ -200,7 +219,7 @@ export const application = (

const proc = run(scripts.serve, {
cwd: appDirPath,
env: { ...envFromFile, PORT: port.toString() },
env: { ...envFromFile, ...createAppRuntimeEnv(state.env), PORT: port.toString() },
detached: opts.detached,
stdout: opts.detached ? fs.openSync(stdoutFilePath, 'a') : undefined,
stderr: opts.detached ? fs.openSync(stderrFilePath, 'a') : undefined,
Expand Down
5 changes: 5 additions & 0 deletions integration/presets/envs.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import { resolve } from 'node:path';

import { automatedEnvironmentVariables } from '@clerk/shared/utils';
import fs from 'fs-extra';

import { constants } from '../constants';
Expand DownExpand Up@@ -91,6 +92,10 @@ const withKeyless = base
.setEnvVariable('private', 'CLERK_API_URL', 'https://api.clerkstage.dev')
.setEnvVariable('public', 'CLERK_KEYLESS_DISABLED', false);

automatedEnvironmentVariables.forEach(name => {
withKeyless.setEnvVariable('private', name, 'false');
});

const withEmailCodes = withInstanceKeys(
'with-email-codes',
base
Expand Down
6 changes: 4 additions & 2 deletions packages/astro/src/server/keyless/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,21 +12,23 @@ export function keyless(context: APIContext) {
keylessServiceInstance = createKeylessService({
storage: createFileStorage(),
api: {
async createAccountlessApplication(requestHeaders?: Headers) {
async createAccountlessApplication(requestHeaders?: Headers, source?: string) {
try {
return await clerkClient(context).__experimental_accountlessApplications.createAccountlessApplication({
requestHeaders,
source,
});
} catch {
return null;
}
},
async completeOnboarding(requestHeaders?: Headers) {
async completeOnboarding(requestHeaders?: Headers, source?: string) {
try {
return await clerkClient(
context,
).__experimental_accountlessApplications.completeAccountlessApplicationOnboarding({
requestHeaders,
source,
});
} catch {
return null;
Expand Down
48 changes: 48 additions & 0 deletions packages/astro/src/utils/__tests__/feature-flags.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
import { automatedEnvironmentVariables } from '@clerk/shared/utils';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

async function loadCanUseKeyless() {
vi.resetModules();
const { canUseKeyless } = await import('../feature-flags.js');
return canUseKeyless;
}

describe('canUseKeyless', () => {
beforeEach(() => {
vi.stubEnv('NODE_ENV', 'development');
vi.stubEnv('PUBLIC_CLERK_KEYLESS_DISABLED', undefined);
vi.stubEnv('CLERK_KEYLESS_DISABLED', undefined);
automatedEnvironmentVariables.forEach(name => {
vi.stubEnv(name, undefined);
vi.stubGlobal(name, undefined);
});
});

afterEach(() => {
vi.unstubAllEnvs();
vi.unstubAllGlobals();
vi.resetModules();
});

it('enables keyless in development when automation signals are absent', async () => {
await expect(loadCanUseKeyless()).resolves.toBe(true);
});

it('disables keyless in CI even when the app runs in development mode', async () => {
vi.stubEnv('CI', 'true');

await expect(loadCanUseKeyless()).resolves.toBe(false);
});

it('disables keyless outside development mode', async () => {
vi.stubEnv('NODE_ENV', 'production');

await expect(loadCanUseKeyless()).resolves.toBe(false);
});

it('disables keyless when explicitly disabled', async () => {
vi.stubEnv('PUBLIC_CLERK_KEYLESS_DISABLED', 'true');

await expect(loadCanUseKeyless()).resolves.toBe(false);
});
});
4 changes: 2 additions & 2 deletions packages/astro/src/utils/feature-flags.ts
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import { getEnvVariable } from '@clerk/shared/getEnvVariable';
import { isTruthy } from '@clerk/shared/underscore';
import { isDevelopmentEnvironment } from '@clerk/shared/utils';
import { isAutomatedEnvironment, isDevelopmentEnvironment } from '@clerk/shared/utils';

const KEYLESS_DISABLED =
isTruthy(getEnvVariable('PUBLIC_CLERK_KEYLESS_DISABLED')) ||
isTruthy(getEnvVariable('CLERK_KEYLESS_DISABLED')) ||
false;

export const canUseKeyless = isDevelopmentEnvironment() && !KEYLESS_DISABLED;
export const canUseKeyless = isDevelopmentEnvironment() && !isAutomatedEnvironment() && !KEYLESS_DISABLED;
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';

import { server } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('AccountlessApplications', () => {
const mockAccountlessApplication = {
object: 'accountless_application',
publishable_key: 'pk_test_keyless',
secret_key: 'sk_test_keyless',
claim_url: 'https://dashboard.clerk.com/claim',
api_keys_url: 'https://dashboard.clerk.com/api-keys',
};

it('creates an accountless application with a source query parameter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('source')).toBe('nextjs');
expect(request.headers.get('Clerk-API-Version')).toBeTruthy();
expect(request.headers.get('User-Agent')).toBe('@clerk/backend@0.0.0-test');

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.createAccountlessApplication({
source: 'nextjs',
});

expect(response.publishableKey).toBe('pk_test_keyless');
});

it('creates an accountless application without a source query parameter when source is omitted', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.has('source')).toBe(false);

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.createAccountlessApplication();

expect(response.publishableKey).toBe('pk_test_keyless');
});

it('completes accountless application onboarding with a source query parameter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications/complete', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('source')).toBe('nextjs');
expect(request.headers.get('Clerk-API-Version')).toBeTruthy();
expect(request.headers.get('User-Agent')).toBe('@clerk/backend@0.0.0-test');

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.completeAccountlessApplicationOnboarding({
source: 'nextjs',
});

expect(response.publishableKey).toBe('pk_test_keyless');
});

it('completes accountless application onboarding without a source query parameter when source is omitted', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications/complete', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.has('source')).toBe(false);

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.completeAccountlessApplicationOnboarding();

expect(response.publishableKey).toBe('pk_test_keyless');
});
});
17 changes: 15 additions & 2 deletions packages/backend/src/api/endpoints/AccountlessApplicationsAPI.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,22 +4,35 @@ import { AbstractAPI } from './AbstractApi';

const basePath = '/accountless_applications';

type AccountlessApplicationParams = {
requestHeaders?: Headers;
source?: string;
};

export class AccountlessApplicationAPI extends AbstractAPI {
public async createAccountlessApplication(params?: { requestHeaders?: Headers }) {
public async createAccountlessApplication(params?: AccountlessApplicationParams): Promise<AccountlessApplication> {
const headerParams = params?.requestHeaders ? Object.fromEntries(params.requestHeaders.entries()) : undefined;
return this.request<AccountlessApplication>({
method: 'POST',
path: basePath,
headerParams,
queryParams: {
source: params?.source,
},
});
}

public async completeAccountlessApplicationOnboarding(params?: { requestHeaders?: Headers }) {
public async completeAccountlessApplicationOnboarding(
params?: AccountlessApplicationParams,
): Promise<AccountlessApplication> {
const headerParams = params?.requestHeaders ? Object.fromEntries(params.requestHeaders.entries()) : undefined;
return this.request<AccountlessApplication>({
method: 'POST',
path: joinPaths(basePath, 'complete'),
headerParams,
queryParams: {
source: params?.source,
},
});
}
}
6 changes: 4 additions & 2 deletions packages/nextjs/src/server/keyless-node.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,19 +24,21 @@ export function keyless() {
keylessServiceInstance = createKeylessService({
storage: createFileStorage(),
api: {
async createAccountlessApplication(requestHeaders?: Headers) {
async createAccountlessApplication(requestHeaders?: Headers, source?: string) {
try {
return await client.__experimental_accountlessApplications.createAccountlessApplication({
requestHeaders,
source,
});
} catch {
return null;
}
},
async completeOnboarding(requestHeaders?: Headers) {
async completeOnboarding(requestHeaders?: Headers, source?: string) {
try {
return await client.__experimental_accountlessApplications.completeAccountlessApplicationOnboarding({
requestHeaders,
source,
});
} catch {
return null;
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
fix(repo): harden keyless accountless requests by mwickett · Pull Request #8676 · clerk/javascript · GitHub
Skip to content
11 changes: 11 additions & 0 deletions .changeset/keyless-ci-guard.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
---
'@clerk/astro': patch
'@clerk/backend': patch
'@clerk/nextjs': patch
'@clerk/nuxt': patch
'@clerk/react-router': patch
'@clerk/shared': patch
'@clerk/tanstack-react-start': patch
---

Prevent keyless mode from activating in CI and other automated environments in framework SDKs.
16 changes: 15 additions & 1 deletion integration/models/__tests__/application.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { describe, expect, it } from 'vitest';

import { resolveServerUrl } from '../application';
import { createAppRuntimeEnv, resolveServerUrl } from '../application';
import { environmentConfig } from '../environment';

describe('resolveServerUrl', () => {
describe('with opts.serverUrl', () => {
Expand DownExpand Up@@ -49,3 +50,16 @@ describe('resolveServerUrl', () => {
});
});
});

describe('createAppRuntimeEnv', () => {
it('passes configured falsey values through to spawned app processes', () => {
const env = environmentConfig()
.setEnvVariable('private', 'CI', 'false')
.setEnvVariable('public', 'CLERK_KEYLESS_DISABLED', false);

expect(createAppRuntimeEnv(env)).toMatchObject({
CI: 'false',
CLERK_KEYLESS_DISABLED: 'false',
});
});
});
23 changes: 21 additions & 2 deletions integration/models/application.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,24 @@ export const resolveServerUrl = (
return fallbackServerUrl || `http://localhost:${port}`;
};

export const createAppRuntimeEnv = (env?: EnvironmentConfig): Record<string, string> => {
if (!env?.publicVariables || !env?.privateVariables) {
return {};
}

const runtimeEnv: Record<string, string> = {};
// Private variables intentionally win when the same runtime key exists in both maps.
for (const [key, value] of [...env.publicVariables, ...env.privateVariables]) {
if (value === undefined || value === null) {
continue;
}

runtimeEnv[key] = String(value);
}

return runtimeEnv;
};

export const application = (
config: ApplicationConfig,
appDirPath: string,
Expand DownExpand Up@@ -103,7 +121,7 @@ export const application = (

const proc = run(scripts.dev, {
cwd: appDirPath,
env: { PORT: port.toString() },
env: { ...createAppRuntimeEnv(state.env), PORT: port.toString() },
detached: opts.detached,
stdout: opts.detached ? fs.openSync(stdoutFilePath, 'a') : undefined,
stderr: opts.detached ? fs.openSync(stderrFilePath, 'a') : undefined,
Expand DownExpand Up@@ -158,6 +176,7 @@ export const application = (
const log = logger.child({ prefix: 'build' }).info;
await run(scripts.build, {
cwd: appDirPath,
env: createAppRuntimeEnv(state.env),
log: (msg: string) => {
buildOutput += `\n${msg}`;
log(msg);
Expand DownExpand Up@@ -200,7 +219,7 @@ export const application = (

const proc = run(scripts.serve, {
cwd: appDirPath,
env: { ...envFromFile, PORT: port.toString() },
env: { ...envFromFile, ...createAppRuntimeEnv(state.env), PORT: port.toString() },
detached: opts.detached,
stdout: opts.detached ? fs.openSync(stdoutFilePath, 'a') : undefined,
stderr: opts.detached ? fs.openSync(stderrFilePath, 'a') : undefined,
Expand Down
5 changes: 5 additions & 0 deletions integration/presets/envs.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import { resolve } from 'node:path';

import { automatedEnvironmentVariables } from '@clerk/shared/utils';
import fs from 'fs-extra';

import { constants } from '../constants';
Expand DownExpand Up@@ -91,6 +92,10 @@ const withKeyless = base
.setEnvVariable('private', 'CLERK_API_URL', 'https://api.clerkstage.dev')
.setEnvVariable('public', 'CLERK_KEYLESS_DISABLED', false);

automatedEnvironmentVariables.forEach(name => {
withKeyless.setEnvVariable('private', name, 'false');
});

const withEmailCodes = withInstanceKeys(
'with-email-codes',
base
Expand Down
6 changes: 4 additions & 2 deletions packages/astro/src/server/keyless/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,21 +12,23 @@ export function keyless(context: APIContext) {
keylessServiceInstance = createKeylessService({
storage: createFileStorage(),
api: {
async createAccountlessApplication(requestHeaders?: Headers) {
async createAccountlessApplication(requestHeaders?: Headers, source?: string) {
try {
return await clerkClient(context).__experimental_accountlessApplications.createAccountlessApplication({
requestHeaders,
source,
});
} catch {
return null;
}
},
async completeOnboarding(requestHeaders?: Headers) {
async completeOnboarding(requestHeaders?: Headers, source?: string) {
try {
return await clerkClient(
context,
).__experimental_accountlessApplications.completeAccountlessApplicationOnboarding({
requestHeaders,
source,
});
} catch {
return null;
Expand Down
48 changes: 48 additions & 0 deletions packages/astro/src/utils/__tests__/feature-flags.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
import { automatedEnvironmentVariables } from '@clerk/shared/utils';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

async function loadCanUseKeyless() {
vi.resetModules();
const { canUseKeyless } = await import('../feature-flags.js');
return canUseKeyless;
}

describe('canUseKeyless', () => {
beforeEach(() => {
vi.stubEnv('NODE_ENV', 'development');
vi.stubEnv('PUBLIC_CLERK_KEYLESS_DISABLED', undefined);
vi.stubEnv('CLERK_KEYLESS_DISABLED', undefined);
automatedEnvironmentVariables.forEach(name => {
vi.stubEnv(name, undefined);
vi.stubGlobal(name, undefined);
});
});

afterEach(() => {
vi.unstubAllEnvs();
vi.unstubAllGlobals();
vi.resetModules();
});

it('enables keyless in development when automation signals are absent', async () => {
await expect(loadCanUseKeyless()).resolves.toBe(true);
});

it('disables keyless in CI even when the app runs in development mode', async () => {
vi.stubEnv('CI', 'true');

await expect(loadCanUseKeyless()).resolves.toBe(false);
});

it('disables keyless outside development mode', async () => {
vi.stubEnv('NODE_ENV', 'production');

await expect(loadCanUseKeyless()).resolves.toBe(false);
});

it('disables keyless when explicitly disabled', async () => {
vi.stubEnv('PUBLIC_CLERK_KEYLESS_DISABLED', 'true');

await expect(loadCanUseKeyless()).resolves.toBe(false);
});
});
4 changes: 2 additions & 2 deletions packages/astro/src/utils/feature-flags.ts
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import { getEnvVariable } from '@clerk/shared/getEnvVariable';
import { isTruthy } from '@clerk/shared/underscore';
import { isDevelopmentEnvironment } from '@clerk/shared/utils';
import { isAutomatedEnvironment, isDevelopmentEnvironment } from '@clerk/shared/utils';

const KEYLESS_DISABLED =
isTruthy(getEnvVariable('PUBLIC_CLERK_KEYLESS_DISABLED')) ||
isTruthy(getEnvVariable('CLERK_KEYLESS_DISABLED')) ||
false;

export const canUseKeyless = isDevelopmentEnvironment() && !KEYLESS_DISABLED;
export const canUseKeyless = isDevelopmentEnvironment() && !isAutomatedEnvironment() && !KEYLESS_DISABLED;
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';

import { server } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('AccountlessApplications', () => {
const mockAccountlessApplication = {
object: 'accountless_application',
publishable_key: 'pk_test_keyless',
secret_key: 'sk_test_keyless',
claim_url: 'https://dashboard.clerk.com/claim',
api_keys_url: 'https://dashboard.clerk.com/api-keys',
};

it('creates an accountless application with a source query parameter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('source')).toBe('nextjs');
expect(request.headers.get('Clerk-API-Version')).toBeTruthy();
expect(request.headers.get('User-Agent')).toBe('@clerk/backend@0.0.0-test');

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.createAccountlessApplication({
source: 'nextjs',
});

expect(response.publishableKey).toBe('pk_test_keyless');
});

it('creates an accountless application without a source query parameter when source is omitted', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.has('source')).toBe(false);

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.createAccountlessApplication();

expect(response.publishableKey).toBe('pk_test_keyless');
});

it('completes accountless application onboarding with a source query parameter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications/complete', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('source')).toBe('nextjs');
expect(request.headers.get('Clerk-API-Version')).toBeTruthy();
expect(request.headers.get('User-Agent')).toBe('@clerk/backend@0.0.0-test');

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.completeAccountlessApplicationOnboarding({
source: 'nextjs',
});

expect(response.publishableKey).toBe('pk_test_keyless');
});

it('completes accountless application onboarding without a source query parameter when source is omitted', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications/complete', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.has('source')).toBe(false);

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.completeAccountlessApplicationOnboarding();

expect(response.publishableKey).toBe('pk_test_keyless');
});
});
17 changes: 15 additions & 2 deletions packages/backend/src/api/endpoints/AccountlessApplicationsAPI.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,22 +4,35 @@ import { AbstractAPI } from './AbstractApi';

const basePath = '/accountless_applications';

type AccountlessApplicationParams = {
requestHeaders?: Headers;
source?: string;
};

export class AccountlessApplicationAPI extends AbstractAPI {
public async createAccountlessApplication(params?: { requestHeaders?: Headers }) {
public async createAccountlessApplication(params?: AccountlessApplicationParams): Promise<AccountlessApplication> {
const headerParams = params?.requestHeaders ? Object.fromEntries(params.requestHeaders.entries()) : undefined;
return this.request<AccountlessApplication>({
method: 'POST',
path: basePath,
headerParams,
queryParams: {
source: params?.source,
},
});
}

public async completeAccountlessApplicationOnboarding(params?: { requestHeaders?: Headers }) {
public async completeAccountlessApplicationOnboarding(
params?: AccountlessApplicationParams,
): Promise<AccountlessApplication> {
const headerParams = params?.requestHeaders ? Object.fromEntries(params.requestHeaders.entries()) : undefined;
return this.request<AccountlessApplication>({
method: 'POST',
path: joinPaths(basePath, 'complete'),
headerParams,
queryParams: {
source: params?.source,
},
});
}
}
6 changes: 4 additions & 2 deletions packages/nextjs/src/server/keyless-node.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,19 +24,21 @@ export function keyless() {
keylessServiceInstance = createKeylessService({
storage: createFileStorage(),
api: {
async createAccountlessApplication(requestHeaders?: Headers) {
async createAccountlessApplication(requestHeaders?: Headers, source?: string) {
try {
return await client.__experimental_accountlessApplications.createAccountlessApplication({
requestHeaders,
source,
});
} catch {
return null;
}
},
async completeOnboarding(requestHeaders?: Headers) {
async completeOnboarding(requestHeaders?: Headers, source?: string) {
try {
return await client.__experimental_accountlessApplications.completeAccountlessApplicationOnboarding({
requestHeaders,
source,
});
} catch {
return null;
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(repo): harden keyless accountless requests by mwickett · Pull Request #8676 · clerk/javascript · GitHub
Skip to content
11 changes: 11 additions & 0 deletions .changeset/keyless-ci-guard.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
---
'@clerk/astro': patch
'@clerk/backend': patch
'@clerk/nextjs': patch
'@clerk/nuxt': patch
'@clerk/react-router': patch
'@clerk/shared': patch
'@clerk/tanstack-react-start': patch
---

Prevent keyless mode from activating in CI and other automated environments in framework SDKs.
16 changes: 15 additions & 1 deletion integration/models/__tests__/application.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { describe, expect, it } from 'vitest';

import { resolveServerUrl } from '../application';
import { createAppRuntimeEnv, resolveServerUrl } from '../application';
import { environmentConfig } from '../environment';

describe('resolveServerUrl', () => {
describe('with opts.serverUrl', () => {
Expand DownExpand Up@@ -49,3 +50,16 @@ describe('resolveServerUrl', () => {
});
});
});

describe('createAppRuntimeEnv', () => {
it('passes configured falsey values through to spawned app processes', () => {
const env = environmentConfig()
.setEnvVariable('private', 'CI', 'false')
.setEnvVariable('public', 'CLERK_KEYLESS_DISABLED', false);

expect(createAppRuntimeEnv(env)).toMatchObject({
CI: 'false',
CLERK_KEYLESS_DISABLED: 'false',
});
});
});
23 changes: 21 additions & 2 deletions integration/models/application.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,24 @@ export const resolveServerUrl = (
return fallbackServerUrl || `http://localhost:${port}`;
};

export const createAppRuntimeEnv = (env?: EnvironmentConfig): Record<string, string> => {
if (!env?.publicVariables || !env?.privateVariables) {
return {};
}

const runtimeEnv: Record<string, string> = {};
// Private variables intentionally win when the same runtime key exists in both maps.
for (const [key, value] of [...env.publicVariables, ...env.privateVariables]) {
if (value === undefined || value === null) {
continue;
}

runtimeEnv[key] = String(value);
}

return runtimeEnv;
};

export const application = (
config: ApplicationConfig,
appDirPath: string,
Expand DownExpand Up@@ -103,7 +121,7 @@ export const application = (

const proc = run(scripts.dev, {
cwd: appDirPath,
env: { PORT: port.toString() },
env: { ...createAppRuntimeEnv(state.env), PORT: port.toString() },
detached: opts.detached,
stdout: opts.detached ? fs.openSync(stdoutFilePath, 'a') : undefined,
stderr: opts.detached ? fs.openSync(stderrFilePath, 'a') : undefined,
Expand DownExpand Up@@ -158,6 +176,7 @@ export const application = (
const log = logger.child({ prefix: 'build' }).info;
await run(scripts.build, {
cwd: appDirPath,
env: createAppRuntimeEnv(state.env),
log: (msg: string) => {
buildOutput += `\n${msg}`;
log(msg);
Expand DownExpand Up@@ -200,7 +219,7 @@ export const application = (

const proc = run(scripts.serve, {
cwd: appDirPath,
env: { ...envFromFile, PORT: port.toString() },
env: { ...envFromFile, ...createAppRuntimeEnv(state.env), PORT: port.toString() },
detached: opts.detached,
stdout: opts.detached ? fs.openSync(stdoutFilePath, 'a') : undefined,
stderr: opts.detached ? fs.openSync(stderrFilePath, 'a') : undefined,
Expand Down
5 changes: 5 additions & 0 deletions integration/presets/envs.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import { resolve } from 'node:path';

import { automatedEnvironmentVariables } from '@clerk/shared/utils';
import fs from 'fs-extra';

import { constants } from '../constants';
Expand DownExpand Up@@ -91,6 +92,10 @@ const withKeyless = base
.setEnvVariable('private', 'CLERK_API_URL', 'https://api.clerkstage.dev')
.setEnvVariable('public', 'CLERK_KEYLESS_DISABLED', false);

automatedEnvironmentVariables.forEach(name => {
withKeyless.setEnvVariable('private', name, 'false');
});

const withEmailCodes = withInstanceKeys(
'with-email-codes',
base
Expand Down
6 changes: 4 additions & 2 deletions packages/astro/src/server/keyless/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,21 +12,23 @@ export function keyless(context: APIContext) {
keylessServiceInstance = createKeylessService({
storage: createFileStorage(),
api: {
async createAccountlessApplication(requestHeaders?: Headers) {
async createAccountlessApplication(requestHeaders?: Headers, source?: string) {
try {
return await clerkClient(context).__experimental_accountlessApplications.createAccountlessApplication({
requestHeaders,
source,
});
} catch {
return null;
}
},
async completeOnboarding(requestHeaders?: Headers) {
async completeOnboarding(requestHeaders?: Headers, source?: string) {
try {
return await clerkClient(
context,
).__experimental_accountlessApplications.completeAccountlessApplicationOnboarding({
requestHeaders,
source,
});
} catch {
return null;
Expand Down
48 changes: 48 additions & 0 deletions packages/astro/src/utils/__tests__/feature-flags.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
import { automatedEnvironmentVariables } from '@clerk/shared/utils';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

async function loadCanUseKeyless() {
vi.resetModules();
const { canUseKeyless } = await import('../feature-flags.js');
return canUseKeyless;
}

describe('canUseKeyless', () => {
beforeEach(() => {
vi.stubEnv('NODE_ENV', 'development');
vi.stubEnv('PUBLIC_CLERK_KEYLESS_DISABLED', undefined);
vi.stubEnv('CLERK_KEYLESS_DISABLED', undefined);
automatedEnvironmentVariables.forEach(name => {
vi.stubEnv(name, undefined);
vi.stubGlobal(name, undefined);
});
});

afterEach(() => {
vi.unstubAllEnvs();
vi.unstubAllGlobals();
vi.resetModules();
});

it('enables keyless in development when automation signals are absent', async () => {
await expect(loadCanUseKeyless()).resolves.toBe(true);
});

it('disables keyless in CI even when the app runs in development mode', async () => {
vi.stubEnv('CI', 'true');

await expect(loadCanUseKeyless()).resolves.toBe(false);
});

it('disables keyless outside development mode', async () => {
vi.stubEnv('NODE_ENV', 'production');

await expect(loadCanUseKeyless()).resolves.toBe(false);
});

it('disables keyless when explicitly disabled', async () => {
vi.stubEnv('PUBLIC_CLERK_KEYLESS_DISABLED', 'true');

await expect(loadCanUseKeyless()).resolves.toBe(false);
});
});
4 changes: 2 additions & 2 deletions packages/astro/src/utils/feature-flags.ts
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import { getEnvVariable } from '@clerk/shared/getEnvVariable';
import { isTruthy } from '@clerk/shared/underscore';
import { isDevelopmentEnvironment } from '@clerk/shared/utils';
import { isAutomatedEnvironment, isDevelopmentEnvironment } from '@clerk/shared/utils';

const KEYLESS_DISABLED =
isTruthy(getEnvVariable('PUBLIC_CLERK_KEYLESS_DISABLED')) ||
isTruthy(getEnvVariable('CLERK_KEYLESS_DISABLED')) ||
false;

export const canUseKeyless = isDevelopmentEnvironment() && !KEYLESS_DISABLED;
export const canUseKeyless = isDevelopmentEnvironment() && !isAutomatedEnvironment() && !KEYLESS_DISABLED;
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';

import { server } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('AccountlessApplications', () => {
const mockAccountlessApplication = {
object: 'accountless_application',
publishable_key: 'pk_test_keyless',
secret_key: 'sk_test_keyless',
claim_url: 'https://dashboard.clerk.com/claim',
api_keys_url: 'https://dashboard.clerk.com/api-keys',
};

it('creates an accountless application with a source query parameter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('source')).toBe('nextjs');
expect(request.headers.get('Clerk-API-Version')).toBeTruthy();
expect(request.headers.get('User-Agent')).toBe('@clerk/backend@0.0.0-test');

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.createAccountlessApplication({
source: 'nextjs',
});

expect(response.publishableKey).toBe('pk_test_keyless');
});

it('creates an accountless application without a source query parameter when source is omitted', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.has('source')).toBe(false);

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.createAccountlessApplication();

expect(response.publishableKey).toBe('pk_test_keyless');
});

it('completes accountless application onboarding with a source query parameter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications/complete', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('source')).toBe('nextjs');
expect(request.headers.get('Clerk-API-Version')).toBeTruthy();
expect(request.headers.get('User-Agent')).toBe('@clerk/backend@0.0.0-test');

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.completeAccountlessApplicationOnboarding({
source: 'nextjs',
});

expect(response.publishableKey).toBe('pk_test_keyless');
});

it('completes accountless application onboarding without a source query parameter when source is omitted', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications/complete', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.has('source')).toBe(false);

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.completeAccountlessApplicationOnboarding();

expect(response.publishableKey).toBe('pk_test_keyless');
});
});
17 changes: 15 additions & 2 deletions packages/backend/src/api/endpoints/AccountlessApplicationsAPI.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,22 +4,35 @@ import { AbstractAPI } from './AbstractApi';

const basePath = '/accountless_applications';

type AccountlessApplicationParams = {
requestHeaders?: Headers;
source?: string;
};

export class AccountlessApplicationAPI extends AbstractAPI {
public async createAccountlessApplication(params?: { requestHeaders?: Headers }) {
public async createAccountlessApplication(params?: AccountlessApplicationParams): Promise<AccountlessApplication> {
const headerParams = params?.requestHeaders ? Object.fromEntries(params.requestHeaders.entries()) : undefined;
return this.request<AccountlessApplication>({
method: 'POST',
path: basePath,
headerParams,
queryParams: {
source: params?.source,
},
});
}

public async completeAccountlessApplicationOnboarding(params?: { requestHeaders?: Headers }) {
public async completeAccountlessApplicationOnboarding(
params?: AccountlessApplicationParams,
): Promise<AccountlessApplication> {
const headerParams = params?.requestHeaders ? Object.fromEntries(params.requestHeaders.entries()) : undefined;
return this.request<AccountlessApplication>({
method: 'POST',
path: joinPaths(basePath, 'complete'),
headerParams,
queryParams: {
source: params?.source,
},
});
}
}
6 changes: 4 additions & 2 deletions packages/nextjs/src/server/keyless-node.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,19 +24,21 @@ export function keyless() {
keylessServiceInstance = createKeylessService({
storage: createFileStorage(),
api: {
async createAccountlessApplication(requestHeaders?: Headers) {
async createAccountlessApplication(requestHeaders?: Headers, source?: string) {
try {
return await client.__experimental_accountlessApplications.createAccountlessApplication({
requestHeaders,
source,
});
} catch {
return null;
}
},
async completeOnboarding(requestHeaders?: Headers) {
async completeOnboarding(requestHeaders?: Headers, source?: string) {
try {
return await client.__experimental_accountlessApplications.completeAccountlessApplicationOnboarding({
requestHeaders,
source,
});
} catch {
return null;
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(repo): harden keyless accountless requests by mwickett · Pull Request #8676 · clerk/javascript · GitHub
Skip to content
11 changes: 11 additions & 0 deletions .changeset/keyless-ci-guard.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
---
'@clerk/astro': patch
'@clerk/backend': patch
'@clerk/nextjs': patch
'@clerk/nuxt': patch
'@clerk/react-router': patch
'@clerk/shared': patch
'@clerk/tanstack-react-start': patch
---

Prevent keyless mode from activating in CI and other automated environments in framework SDKs.
16 changes: 15 additions & 1 deletion integration/models/__tests__/application.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { describe, expect, it } from 'vitest';

import { resolveServerUrl } from '../application';
import { createAppRuntimeEnv, resolveServerUrl } from '../application';
import { environmentConfig } from '../environment';

describe('resolveServerUrl', () => {
describe('with opts.serverUrl', () => {
Expand DownExpand Up@@ -49,3 +50,16 @@ describe('resolveServerUrl', () => {
});
});
});

describe('createAppRuntimeEnv', () => {
it('passes configured falsey values through to spawned app processes', () => {
const env = environmentConfig()
.setEnvVariable('private', 'CI', 'false')
.setEnvVariable('public', 'CLERK_KEYLESS_DISABLED', false);

expect(createAppRuntimeEnv(env)).toMatchObject({
CI: 'false',
CLERK_KEYLESS_DISABLED: 'false',
});
});
});
23 changes: 21 additions & 2 deletions integration/models/application.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,24 @@ export const resolveServerUrl = (
return fallbackServerUrl || `http://localhost:${port}`;
};

export const createAppRuntimeEnv = (env?: EnvironmentConfig): Record<string, string> => {
if (!env?.publicVariables || !env?.privateVariables) {
return {};
}

const runtimeEnv: Record<string, string> = {};
// Private variables intentionally win when the same runtime key exists in both maps.
for (const [key, value] of [...env.publicVariables, ...env.privateVariables]) {
if (value === undefined || value === null) {
continue;
}

runtimeEnv[key] = String(value);
}

return runtimeEnv;
};

export const application = (
config: ApplicationConfig,
appDirPath: string,
Expand DownExpand Up@@ -103,7 +121,7 @@ export const application = (

const proc = run(scripts.dev, {
cwd: appDirPath,
env: { PORT: port.toString() },
env: { ...createAppRuntimeEnv(state.env), PORT: port.toString() },
detached: opts.detached,
stdout: opts.detached ? fs.openSync(stdoutFilePath, 'a') : undefined,
stderr: opts.detached ? fs.openSync(stderrFilePath, 'a') : undefined,
Expand DownExpand Up@@ -158,6 +176,7 @@ export const application = (
const log = logger.child({ prefix: 'build' }).info;
await run(scripts.build, {
cwd: appDirPath,
env: createAppRuntimeEnv(state.env),
log: (msg: string) => {
buildOutput += `\n${msg}`;
log(msg);
Expand DownExpand Up@@ -200,7 +219,7 @@ export const application = (

const proc = run(scripts.serve, {
cwd: appDirPath,
env: { ...envFromFile, PORT: port.toString() },
env: { ...envFromFile, ...createAppRuntimeEnv(state.env), PORT: port.toString() },
detached: opts.detached,
stdout: opts.detached ? fs.openSync(stdoutFilePath, 'a') : undefined,
stderr: opts.detached ? fs.openSync(stderrFilePath, 'a') : undefined,
Expand Down
5 changes: 5 additions & 0 deletions integration/presets/envs.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import { resolve } from 'node:path';

import { automatedEnvironmentVariables } from '@clerk/shared/utils';
import fs from 'fs-extra';

import { constants } from '../constants';
Expand DownExpand Up@@ -91,6 +92,10 @@ const withKeyless = base
.setEnvVariable('private', 'CLERK_API_URL', 'https://api.clerkstage.dev')
.setEnvVariable('public', 'CLERK_KEYLESS_DISABLED', false);

automatedEnvironmentVariables.forEach(name => {
withKeyless.setEnvVariable('private', name, 'false');
});

const withEmailCodes = withInstanceKeys(
'with-email-codes',
base
Expand Down
6 changes: 4 additions & 2 deletions packages/astro/src/server/keyless/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,21 +12,23 @@ export function keyless(context: APIContext) {
keylessServiceInstance = createKeylessService({
storage: createFileStorage(),
api: {
async createAccountlessApplication(requestHeaders?: Headers) {
async createAccountlessApplication(requestHeaders?: Headers, source?: string) {
try {
return await clerkClient(context).__experimental_accountlessApplications.createAccountlessApplication({
requestHeaders,
source,
});
} catch {
return null;
}
},
async completeOnboarding(requestHeaders?: Headers) {
async completeOnboarding(requestHeaders?: Headers, source?: string) {
try {
return await clerkClient(
context,
).__experimental_accountlessApplications.completeAccountlessApplicationOnboarding({
requestHeaders,
source,
});
} catch {
return null;
Expand Down
48 changes: 48 additions & 0 deletions packages/astro/src/utils/__tests__/feature-flags.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
import { automatedEnvironmentVariables } from '@clerk/shared/utils';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

async function loadCanUseKeyless() {
vi.resetModules();
const { canUseKeyless } = await import('../feature-flags.js');
return canUseKeyless;
}

describe('canUseKeyless', () => {
beforeEach(() => {
vi.stubEnv('NODE_ENV', 'development');
vi.stubEnv('PUBLIC_CLERK_KEYLESS_DISABLED', undefined);
vi.stubEnv('CLERK_KEYLESS_DISABLED', undefined);
automatedEnvironmentVariables.forEach(name => {
vi.stubEnv(name, undefined);
vi.stubGlobal(name, undefined);
});
});

afterEach(() => {
vi.unstubAllEnvs();
vi.unstubAllGlobals();
vi.resetModules();
});

it('enables keyless in development when automation signals are absent', async () => {
await expect(loadCanUseKeyless()).resolves.toBe(true);
});

it('disables keyless in CI even when the app runs in development mode', async () => {
vi.stubEnv('CI', 'true');

await expect(loadCanUseKeyless()).resolves.toBe(false);
});

it('disables keyless outside development mode', async () => {
vi.stubEnv('NODE_ENV', 'production');

await expect(loadCanUseKeyless()).resolves.toBe(false);
});

it('disables keyless when explicitly disabled', async () => {
vi.stubEnv('PUBLIC_CLERK_KEYLESS_DISABLED', 'true');

await expect(loadCanUseKeyless()).resolves.toBe(false);
});
});
4 changes: 2 additions & 2 deletions packages/astro/src/utils/feature-flags.ts
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import { getEnvVariable } from '@clerk/shared/getEnvVariable';
import { isTruthy } from '@clerk/shared/underscore';
import { isDevelopmentEnvironment } from '@clerk/shared/utils';
import { isAutomatedEnvironment, isDevelopmentEnvironment } from '@clerk/shared/utils';

const KEYLESS_DISABLED =
isTruthy(getEnvVariable('PUBLIC_CLERK_KEYLESS_DISABLED')) ||
isTruthy(getEnvVariable('CLERK_KEYLESS_DISABLED')) ||
false;

export const canUseKeyless = isDevelopmentEnvironment() && !KEYLESS_DISABLED;
export const canUseKeyless = isDevelopmentEnvironment() && !isAutomatedEnvironment() && !KEYLESS_DISABLED;
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';

import { server } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('AccountlessApplications', () => {
const mockAccountlessApplication = {
object: 'accountless_application',
publishable_key: 'pk_test_keyless',
secret_key: 'sk_test_keyless',
claim_url: 'https://dashboard.clerk.com/claim',
api_keys_url: 'https://dashboard.clerk.com/api-keys',
};

it('creates an accountless application with a source query parameter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('source')).toBe('nextjs');
expect(request.headers.get('Clerk-API-Version')).toBeTruthy();
expect(request.headers.get('User-Agent')).toBe('@clerk/backend@0.0.0-test');

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.createAccountlessApplication({
source: 'nextjs',
});

expect(response.publishableKey).toBe('pk_test_keyless');
});

it('creates an accountless application without a source query parameter when source is omitted', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.has('source')).toBe(false);

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.createAccountlessApplication();

expect(response.publishableKey).toBe('pk_test_keyless');
});

it('completes accountless application onboarding with a source query parameter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications/complete', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('source')).toBe('nextjs');
expect(request.headers.get('Clerk-API-Version')).toBeTruthy();
expect(request.headers.get('User-Agent')).toBe('@clerk/backend@0.0.0-test');

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.completeAccountlessApplicationOnboarding({
source: 'nextjs',
});

expect(response.publishableKey).toBe('pk_test_keyless');
});

it('completes accountless application onboarding without a source query parameter when source is omitted', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications/complete', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.has('source')).toBe(false);

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.completeAccountlessApplicationOnboarding();

expect(response.publishableKey).toBe('pk_test_keyless');
});
});
17 changes: 15 additions & 2 deletions packages/backend/src/api/endpoints/AccountlessApplicationsAPI.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,22 +4,35 @@ import { AbstractAPI } from './AbstractApi';

const basePath = '/accountless_applications';

type AccountlessApplicationParams = {
requestHeaders?: Headers;
source?: string;
};

export class AccountlessApplicationAPI extends AbstractAPI {
public async createAccountlessApplication(params?: { requestHeaders?: Headers }) {
public async createAccountlessApplication(params?: AccountlessApplicationParams): Promise<AccountlessApplication> {
const headerParams = params?.requestHeaders ? Object.fromEntries(params.requestHeaders.entries()) : undefined;
return this.request<AccountlessApplication>({
method: 'POST',
path: basePath,
headerParams,
queryParams: {
source: params?.source,
},
});
}

public async completeAccountlessApplicationOnboarding(params?: { requestHeaders?: Headers }) {
public async completeAccountlessApplicationOnboarding(
params?: AccountlessApplicationParams,
): Promise<AccountlessApplication> {
const headerParams = params?.requestHeaders ? Object.fromEntries(params.requestHeaders.entries()) : undefined;
return this.request<AccountlessApplication>({
method: 'POST',
path: joinPaths(basePath, 'complete'),
headerParams,
queryParams: {
source: params?.source,
},
});
}
}
6 changes: 4 additions & 2 deletions packages/nextjs/src/server/keyless-node.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,19 +24,21 @@ export function keyless() {
keylessServiceInstance = createKeylessService({
storage: createFileStorage(),
api: {
async createAccountlessApplication(requestHeaders?: Headers) {
async createAccountlessApplication(requestHeaders?: Headers, source?: string) {
try {
return await client.__experimental_accountlessApplications.createAccountlessApplication({
requestHeaders,
source,
});
} catch {
return null;
}
},
async completeOnboarding(requestHeaders?: Headers) {
async completeOnboarding(requestHeaders?: Headers, source?: string) {
try {
return await client.__experimental_accountlessApplications.completeAccountlessApplicationOnboarding({
requestHeaders,
source,
});
} catch {
return null;
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' fix(repo): harden keyless accountless requests by mwickett · Pull Request #8676 · clerk/javascript · GitHub
Skip to content
11 changes: 11 additions & 0 deletions .changeset/keyless-ci-guard.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
---
'@clerk/astro': patch
'@clerk/backend': patch
'@clerk/nextjs': patch
'@clerk/nuxt': patch
'@clerk/react-router': patch
'@clerk/shared': patch
'@clerk/tanstack-react-start': patch
---

Prevent keyless mode from activating in CI and other automated environments in framework SDKs.
16 changes: 15 additions & 1 deletion integration/models/__tests__/application.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { describe, expect, it } from 'vitest';

import { resolveServerUrl } from '../application';
import { createAppRuntimeEnv, resolveServerUrl } from '../application';
import { environmentConfig } from '../environment';

describe('resolveServerUrl', () => {
describe('with opts.serverUrl', () => {
Expand DownExpand Up@@ -49,3 +50,16 @@ describe('resolveServerUrl', () => {
});
});
});

describe('createAppRuntimeEnv', () => {
it('passes configured falsey values through to spawned app processes', () => {
const env = environmentConfig()
.setEnvVariable('private', 'CI', 'false')
.setEnvVariable('public', 'CLERK_KEYLESS_DISABLED', false);

expect(createAppRuntimeEnv(env)).toMatchObject({
CI: 'false',
CLERK_KEYLESS_DISABLED: 'false',
});
});
});
23 changes: 21 additions & 2 deletions integration/models/application.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,24 @@ export const resolveServerUrl = (
return fallbackServerUrl || `http://localhost:${port}`;
};

export const createAppRuntimeEnv = (env?: EnvironmentConfig): Record<string, string> => {
if (!env?.publicVariables || !env?.privateVariables) {
return {};
}

const runtimeEnv: Record<string, string> = {};
// Private variables intentionally win when the same runtime key exists in both maps.
for (const [key, value] of [...env.publicVariables, ...env.privateVariables]) {
if (value === undefined || value === null) {
continue;
}

runtimeEnv[key] = String(value);
}

return runtimeEnv;
};

export const application = (
config: ApplicationConfig,
appDirPath: string,
Expand DownExpand Up@@ -103,7 +121,7 @@ export const application = (

const proc = run(scripts.dev, {
cwd: appDirPath,
env: { PORT: port.toString() },
env: { ...createAppRuntimeEnv(state.env), PORT: port.toString() },
detached: opts.detached,
stdout: opts.detached ? fs.openSync(stdoutFilePath, 'a') : undefined,
stderr: opts.detached ? fs.openSync(stderrFilePath, 'a') : undefined,
Expand DownExpand Up@@ -158,6 +176,7 @@ export const application = (
const log = logger.child({ prefix: 'build' }).info;
await run(scripts.build, {
cwd: appDirPath,
env: createAppRuntimeEnv(state.env),
log: (msg: string) => {
buildOutput += `\n${msg}`;
log(msg);
Expand DownExpand Up@@ -200,7 +219,7 @@ export const application = (

const proc = run(scripts.serve, {
cwd: appDirPath,
env: { ...envFromFile, PORT: port.toString() },
env: { ...envFromFile, ...createAppRuntimeEnv(state.env), PORT: port.toString() },
detached: opts.detached,
stdout: opts.detached ? fs.openSync(stdoutFilePath, 'a') : undefined,
stderr: opts.detached ? fs.openSync(stderrFilePath, 'a') : undefined,
Expand Down
5 changes: 5 additions & 0 deletions integration/presets/envs.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import { resolve } from 'node:path';

import { automatedEnvironmentVariables } from '@clerk/shared/utils';
import fs from 'fs-extra';

import { constants } from '../constants';
Expand DownExpand Up@@ -91,6 +92,10 @@ const withKeyless = base
.setEnvVariable('private', 'CLERK_API_URL', 'https://api.clerkstage.dev')
.setEnvVariable('public', 'CLERK_KEYLESS_DISABLED', false);

automatedEnvironmentVariables.forEach(name => {
withKeyless.setEnvVariable('private', name, 'false');
});

const withEmailCodes = withInstanceKeys(
'with-email-codes',
base
Expand Down
6 changes: 4 additions & 2 deletions packages/astro/src/server/keyless/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,21 +12,23 @@ export function keyless(context: APIContext) {
keylessServiceInstance = createKeylessService({
storage: createFileStorage(),
api: {
async createAccountlessApplication(requestHeaders?: Headers) {
async createAccountlessApplication(requestHeaders?: Headers, source?: string) {
try {
return await clerkClient(context).__experimental_accountlessApplications.createAccountlessApplication({
requestHeaders,
source,
});
} catch {
return null;
}
},
async completeOnboarding(requestHeaders?: Headers) {
async completeOnboarding(requestHeaders?: Headers, source?: string) {
try {
return await clerkClient(
context,
).__experimental_accountlessApplications.completeAccountlessApplicationOnboarding({
requestHeaders,
source,
});
} catch {
return null;
Expand Down
48 changes: 48 additions & 0 deletions packages/astro/src/utils/__tests__/feature-flags.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
import { automatedEnvironmentVariables } from '@clerk/shared/utils';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

async function loadCanUseKeyless() {
vi.resetModules();
const { canUseKeyless } = await import('../feature-flags.js');
return canUseKeyless;
}

describe('canUseKeyless', () => {
beforeEach(() => {
vi.stubEnv('NODE_ENV', 'development');
vi.stubEnv('PUBLIC_CLERK_KEYLESS_DISABLED', undefined);
vi.stubEnv('CLERK_KEYLESS_DISABLED', undefined);
automatedEnvironmentVariables.forEach(name => {
vi.stubEnv(name, undefined);
vi.stubGlobal(name, undefined);
});
});

afterEach(() => {
vi.unstubAllEnvs();
vi.unstubAllGlobals();
vi.resetModules();
});

it('enables keyless in development when automation signals are absent', async () => {
await expect(loadCanUseKeyless()).resolves.toBe(true);
});

it('disables keyless in CI even when the app runs in development mode', async () => {
vi.stubEnv('CI', 'true');

await expect(loadCanUseKeyless()).resolves.toBe(false);
});

it('disables keyless outside development mode', async () => {
vi.stubEnv('NODE_ENV', 'production');

await expect(loadCanUseKeyless()).resolves.toBe(false);
});

it('disables keyless when explicitly disabled', async () => {
vi.stubEnv('PUBLIC_CLERK_KEYLESS_DISABLED', 'true');

await expect(loadCanUseKeyless()).resolves.toBe(false);
});
});
4 changes: 2 additions & 2 deletions packages/astro/src/utils/feature-flags.ts
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import { getEnvVariable } from '@clerk/shared/getEnvVariable';
import { isTruthy } from '@clerk/shared/underscore';
import { isDevelopmentEnvironment } from '@clerk/shared/utils';
import { isAutomatedEnvironment, isDevelopmentEnvironment } from '@clerk/shared/utils';

const KEYLESS_DISABLED =
isTruthy(getEnvVariable('PUBLIC_CLERK_KEYLESS_DISABLED')) ||
isTruthy(getEnvVariable('CLERK_KEYLESS_DISABLED')) ||
false;

export const canUseKeyless = isDevelopmentEnvironment() && !KEYLESS_DISABLED;
export const canUseKeyless = isDevelopmentEnvironment() && !isAutomatedEnvironment() && !KEYLESS_DISABLED;
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';

import { server } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('AccountlessApplications', () => {
const mockAccountlessApplication = {
object: 'accountless_application',
publishable_key: 'pk_test_keyless',
secret_key: 'sk_test_keyless',
claim_url: 'https://dashboard.clerk.com/claim',
api_keys_url: 'https://dashboard.clerk.com/api-keys',
};

it('creates an accountless application with a source query parameter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('source')).toBe('nextjs');
expect(request.headers.get('Clerk-API-Version')).toBeTruthy();
expect(request.headers.get('User-Agent')).toBe('@clerk/backend@0.0.0-test');

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.createAccountlessApplication({
source: 'nextjs',
});

expect(response.publishableKey).toBe('pk_test_keyless');
});

it('creates an accountless application without a source query parameter when source is omitted', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.has('source')).toBe(false);

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.createAccountlessApplication();

expect(response.publishableKey).toBe('pk_test_keyless');
});

it('completes accountless application onboarding with a source query parameter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications/complete', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('source')).toBe('nextjs');
expect(request.headers.get('Clerk-API-Version')).toBeTruthy();
expect(request.headers.get('User-Agent')).toBe('@clerk/backend@0.0.0-test');

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.completeAccountlessApplicationOnboarding({
source: 'nextjs',
});

expect(response.publishableKey).toBe('pk_test_keyless');
});

it('completes accountless application onboarding without a source query parameter when source is omitted', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications/complete', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.has('source')).toBe(false);

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.completeAccountlessApplicationOnboarding();

expect(response.publishableKey).toBe('pk_test_keyless');
});
});
17 changes: 15 additions & 2 deletions packages/backend/src/api/endpoints/AccountlessApplicationsAPI.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,22 +4,35 @@ import { AbstractAPI } from './AbstractApi';

const basePath = '/accountless_applications';

type AccountlessApplicationParams = {
requestHeaders?: Headers;
source?: string;
};

export class AccountlessApplicationAPI extends AbstractAPI {
public async createAccountlessApplication(params?: { requestHeaders?: Headers }) {
public async createAccountlessApplication(params?: AccountlessApplicationParams): Promise<AccountlessApplication> {
const headerParams = params?.requestHeaders ? Object.fromEntries(params.requestHeaders.entries()) : undefined;
return this.request<AccountlessApplication>({
method: 'POST',
path: basePath,
headerParams,
queryParams: {
source: params?.source,
},
});
}

public async completeAccountlessApplicationOnboarding(params?: { requestHeaders?: Headers }) {
public async completeAccountlessApplicationOnboarding(
params?: AccountlessApplicationParams,
): Promise<AccountlessApplication> {
const headerParams = params?.requestHeaders ? Object.fromEntries(params.requestHeaders.entries()) : undefined;
return this.request<AccountlessApplication>({
method: 'POST',
path: joinPaths(basePath, 'complete'),
headerParams,
queryParams: {
source: params?.source,
},
});
}
}
6 changes: 4 additions & 2 deletions packages/nextjs/src/server/keyless-node.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,19 +24,21 @@ export function keyless() {
keylessServiceInstance = createKeylessService({
storage: createFileStorage(),
api: {
async createAccountlessApplication(requestHeaders?: Headers) {
async createAccountlessApplication(requestHeaders?: Headers, source?: string) {
try {
return await client.__experimental_accountlessApplications.createAccountlessApplication({
requestHeaders,
source,
});
} catch {
return null;
}
},
async completeOnboarding(requestHeaders?: Headers) {
async completeOnboarding(requestHeaders?: Headers, source?: string) {
try {
return await client.__experimental_accountlessApplications.completeAccountlessApplicationOnboarding({
requestHeaders,
source,
});
} catch {
return null;
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(repo): harden keyless accountless requests by mwickett · Pull Request #8676 · clerk/javascript · GitHub
Skip to content
11 changes: 11 additions & 0 deletions .changeset/keyless-ci-guard.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
---
'@clerk/astro': patch
'@clerk/backend': patch
'@clerk/nextjs': patch
'@clerk/nuxt': patch
'@clerk/react-router': patch
'@clerk/shared': patch
'@clerk/tanstack-react-start': patch
---

Prevent keyless mode from activating in CI and other automated environments in framework SDKs.
16 changes: 15 additions & 1 deletion integration/models/__tests__/application.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { describe, expect, it } from 'vitest';

import { resolveServerUrl } from '../application';
import { createAppRuntimeEnv, resolveServerUrl } from '../application';
import { environmentConfig } from '../environment';

describe('resolveServerUrl', () => {
describe('with opts.serverUrl', () => {
Expand DownExpand Up@@ -49,3 +50,16 @@ describe('resolveServerUrl', () => {
});
});
});

describe('createAppRuntimeEnv', () => {
it('passes configured falsey values through to spawned app processes', () => {
const env = environmentConfig()
.setEnvVariable('private', 'CI', 'false')
.setEnvVariable('public', 'CLERK_KEYLESS_DISABLED', false);

expect(createAppRuntimeEnv(env)).toMatchObject({
CI: 'false',
CLERK_KEYLESS_DISABLED: 'false',
});
});
});
23 changes: 21 additions & 2 deletions integration/models/application.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,24 @@ export const resolveServerUrl = (
return fallbackServerUrl || `http://localhost:${port}`;
};

export const createAppRuntimeEnv = (env?: EnvironmentConfig): Record<string, string> => {
if (!env?.publicVariables || !env?.privateVariables) {
return {};
}

const runtimeEnv: Record<string, string> = {};
// Private variables intentionally win when the same runtime key exists in both maps.
for (const [key, value] of [...env.publicVariables, ...env.privateVariables]) {
if (value === undefined || value === null) {
continue;
}

runtimeEnv[key] = String(value);
}

return runtimeEnv;
};

export const application = (
config: ApplicationConfig,
appDirPath: string,
Expand DownExpand Up@@ -103,7 +121,7 @@ export const application = (

const proc = run(scripts.dev, {
cwd: appDirPath,
env: { PORT: port.toString() },
env: { ...createAppRuntimeEnv(state.env), PORT: port.toString() },
detached: opts.detached,
stdout: opts.detached ? fs.openSync(stdoutFilePath, 'a') : undefined,
stderr: opts.detached ? fs.openSync(stderrFilePath, 'a') : undefined,
Expand DownExpand Up@@ -158,6 +176,7 @@ export const application = (
const log = logger.child({ prefix: 'build' }).info;
await run(scripts.build, {
cwd: appDirPath,
env: createAppRuntimeEnv(state.env),
log: (msg: string) => {
buildOutput += `\n${msg}`;
log(msg);
Expand DownExpand Up@@ -200,7 +219,7 @@ export const application = (

const proc = run(scripts.serve, {
cwd: appDirPath,
env: { ...envFromFile, PORT: port.toString() },
env: { ...envFromFile, ...createAppRuntimeEnv(state.env), PORT: port.toString() },
detached: opts.detached,
stdout: opts.detached ? fs.openSync(stdoutFilePath, 'a') : undefined,
stderr: opts.detached ? fs.openSync(stderrFilePath, 'a') : undefined,
Expand Down
5 changes: 5 additions & 0 deletions integration/presets/envs.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import { resolve } from 'node:path';

import { automatedEnvironmentVariables } from '@clerk/shared/utils';
import fs from 'fs-extra';

import { constants } from '../constants';
Expand DownExpand Up@@ -91,6 +92,10 @@ const withKeyless = base
.setEnvVariable('private', 'CLERK_API_URL', 'https://api.clerkstage.dev')
.setEnvVariable('public', 'CLERK_KEYLESS_DISABLED', false);

automatedEnvironmentVariables.forEach(name => {
withKeyless.setEnvVariable('private', name, 'false');
});

const withEmailCodes = withInstanceKeys(
'with-email-codes',
base
Expand Down
6 changes: 4 additions & 2 deletions packages/astro/src/server/keyless/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,21 +12,23 @@ export function keyless(context: APIContext) {
keylessServiceInstance = createKeylessService({
storage: createFileStorage(),
api: {
async createAccountlessApplication(requestHeaders?: Headers) {
async createAccountlessApplication(requestHeaders?: Headers, source?: string) {
try {
return await clerkClient(context).__experimental_accountlessApplications.createAccountlessApplication({
requestHeaders,
source,
});
} catch {
return null;
}
},
async completeOnboarding(requestHeaders?: Headers) {
async completeOnboarding(requestHeaders?: Headers, source?: string) {
try {
return await clerkClient(
context,
).__experimental_accountlessApplications.completeAccountlessApplicationOnboarding({
requestHeaders,
source,
});
} catch {
return null;
Expand Down
48 changes: 48 additions & 0 deletions packages/astro/src/utils/__tests__/feature-flags.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
import { automatedEnvironmentVariables } from '@clerk/shared/utils';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

async function loadCanUseKeyless() {
vi.resetModules();
const { canUseKeyless } = await import('../feature-flags.js');
return canUseKeyless;
}

describe('canUseKeyless', () => {
beforeEach(() => {
vi.stubEnv('NODE_ENV', 'development');
vi.stubEnv('PUBLIC_CLERK_KEYLESS_DISABLED', undefined);
vi.stubEnv('CLERK_KEYLESS_DISABLED', undefined);
automatedEnvironmentVariables.forEach(name => {
vi.stubEnv(name, undefined);
vi.stubGlobal(name, undefined);
});
});

afterEach(() => {
vi.unstubAllEnvs();
vi.unstubAllGlobals();
vi.resetModules();
});

it('enables keyless in development when automation signals are absent', async () => {
await expect(loadCanUseKeyless()).resolves.toBe(true);
});

it('disables keyless in CI even when the app runs in development mode', async () => {
vi.stubEnv('CI', 'true');

await expect(loadCanUseKeyless()).resolves.toBe(false);
});

it('disables keyless outside development mode', async () => {
vi.stubEnv('NODE_ENV', 'production');

await expect(loadCanUseKeyless()).resolves.toBe(false);
});

it('disables keyless when explicitly disabled', async () => {
vi.stubEnv('PUBLIC_CLERK_KEYLESS_DISABLED', 'true');

await expect(loadCanUseKeyless()).resolves.toBe(false);
});
});
4 changes: 2 additions & 2 deletions packages/astro/src/utils/feature-flags.ts
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import { getEnvVariable } from '@clerk/shared/getEnvVariable';
import { isTruthy } from '@clerk/shared/underscore';
import { isDevelopmentEnvironment } from '@clerk/shared/utils';
import { isAutomatedEnvironment, isDevelopmentEnvironment } from '@clerk/shared/utils';

const KEYLESS_DISABLED =
isTruthy(getEnvVariable('PUBLIC_CLERK_KEYLESS_DISABLED')) ||
isTruthy(getEnvVariable('CLERK_KEYLESS_DISABLED')) ||
false;

export const canUseKeyless = isDevelopmentEnvironment() && !KEYLESS_DISABLED;
export const canUseKeyless = isDevelopmentEnvironment() && !isAutomatedEnvironment() && !KEYLESS_DISABLED;
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';

import { server } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('AccountlessApplications', () => {
const mockAccountlessApplication = {
object: 'accountless_application',
publishable_key: 'pk_test_keyless',
secret_key: 'sk_test_keyless',
claim_url: 'https://dashboard.clerk.com/claim',
api_keys_url: 'https://dashboard.clerk.com/api-keys',
};

it('creates an accountless application with a source query parameter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('source')).toBe('nextjs');
expect(request.headers.get('Clerk-API-Version')).toBeTruthy();
expect(request.headers.get('User-Agent')).toBe('@clerk/backend@0.0.0-test');

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.createAccountlessApplication({
source: 'nextjs',
});

expect(response.publishableKey).toBe('pk_test_keyless');
});

it('creates an accountless application without a source query parameter when source is omitted', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.has('source')).toBe(false);

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.createAccountlessApplication();

expect(response.publishableKey).toBe('pk_test_keyless');
});

it('completes accountless application onboarding with a source query parameter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications/complete', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('source')).toBe('nextjs');
expect(request.headers.get('Clerk-API-Version')).toBeTruthy();
expect(request.headers.get('User-Agent')).toBe('@clerk/backend@0.0.0-test');

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.completeAccountlessApplicationOnboarding({
source: 'nextjs',
});

expect(response.publishableKey).toBe('pk_test_keyless');
});

it('completes accountless application onboarding without a source query parameter when source is omitted', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications/complete', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.has('source')).toBe(false);

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.completeAccountlessApplicationOnboarding();

expect(response.publishableKey).toBe('pk_test_keyless');
});
});
17 changes: 15 additions & 2 deletions packages/backend/src/api/endpoints/AccountlessApplicationsAPI.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,22 +4,35 @@ import { AbstractAPI } from './AbstractApi';

const basePath = '/accountless_applications';

type AccountlessApplicationParams = {
requestHeaders?: Headers;
source?: string;
};

export class AccountlessApplicationAPI extends AbstractAPI {
public async createAccountlessApplication(params?: { requestHeaders?: Headers }) {
public async createAccountlessApplication(params?: AccountlessApplicationParams): Promise<AccountlessApplication> {
const headerParams = params?.requestHeaders ? Object.fromEntries(params.requestHeaders.entries()) : undefined;
return this.request<AccountlessApplication>({
method: 'POST',
path: basePath,
headerParams,
queryParams: {
source: params?.source,
},
});
}

public async completeAccountlessApplicationOnboarding(params?: { requestHeaders?: Headers }) {
public async completeAccountlessApplicationOnboarding(
params?: AccountlessApplicationParams,
): Promise<AccountlessApplication> {
const headerParams = params?.requestHeaders ? Object.fromEntries(params.requestHeaders.entries()) : undefined;
return this.request<AccountlessApplication>({
method: 'POST',
path: joinPaths(basePath, 'complete'),
headerParams,
queryParams: {
source: params?.source,
},
});
}
}
6 changes: 4 additions & 2 deletions packages/nextjs/src/server/keyless-node.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,19 +24,21 @@ export function keyless() {
keylessServiceInstance = createKeylessService({
storage: createFileStorage(),
api: {
async createAccountlessApplication(requestHeaders?: Headers) {
async createAccountlessApplication(requestHeaders?: Headers, source?: string) {
try {
return await client.__experimental_accountlessApplications.createAccountlessApplication({
requestHeaders,
source,
});
} catch {
return null;
}
},
async completeOnboarding(requestHeaders?: Headers) {
async completeOnboarding(requestHeaders?: Headers, source?: string) {
try {
return await client.__experimental_accountlessApplications.completeAccountlessApplicationOnboarding({
requestHeaders,
source,
});
} catch {
return null;
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(repo): harden keyless accountless requests by mwickett · Pull Request #8676 · clerk/javascript · GitHub
Skip to content
11 changes: 11 additions & 0 deletions .changeset/keyless-ci-guard.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
---
'@clerk/astro': patch
'@clerk/backend': patch
'@clerk/nextjs': patch
'@clerk/nuxt': patch
'@clerk/react-router': patch
'@clerk/shared': patch
'@clerk/tanstack-react-start': patch
---

Prevent keyless mode from activating in CI and other automated environments in framework SDKs.
16 changes: 15 additions & 1 deletion integration/models/__tests__/application.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { describe, expect, it } from 'vitest';

import { resolveServerUrl } from '../application';
import { createAppRuntimeEnv, resolveServerUrl } from '../application';
import { environmentConfig } from '../environment';

describe('resolveServerUrl', () => {
describe('with opts.serverUrl', () => {
Expand DownExpand Up@@ -49,3 +50,16 @@ describe('resolveServerUrl', () => {
});
});
});

describe('createAppRuntimeEnv', () => {
it('passes configured falsey values through to spawned app processes', () => {
const env = environmentConfig()
.setEnvVariable('private', 'CI', 'false')
.setEnvVariable('public', 'CLERK_KEYLESS_DISABLED', false);

expect(createAppRuntimeEnv(env)).toMatchObject({
CI: 'false',
CLERK_KEYLESS_DISABLED: 'false',
});
});
});
23 changes: 21 additions & 2 deletions integration/models/application.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,24 @@ export const resolveServerUrl = (
return fallbackServerUrl || `http://localhost:${port}`;
};

export const createAppRuntimeEnv = (env?: EnvironmentConfig): Record<string, string> => {
if (!env?.publicVariables || !env?.privateVariables) {
return {};
}

const runtimeEnv: Record<string, string> = {};
// Private variables intentionally win when the same runtime key exists in both maps.
for (const [key, value] of [...env.publicVariables, ...env.privateVariables]) {
if (value === undefined || value === null) {
continue;
}

runtimeEnv[key] = String(value);
}

return runtimeEnv;
};

export const application = (
config: ApplicationConfig,
appDirPath: string,
Expand DownExpand Up@@ -103,7 +121,7 @@ export const application = (

const proc = run(scripts.dev, {
cwd: appDirPath,
env: { PORT: port.toString() },
env: { ...createAppRuntimeEnv(state.env), PORT: port.toString() },
detached: opts.detached,
stdout: opts.detached ? fs.openSync(stdoutFilePath, 'a') : undefined,
stderr: opts.detached ? fs.openSync(stderrFilePath, 'a') : undefined,
Expand DownExpand Up@@ -158,6 +176,7 @@ export const application = (
const log = logger.child({ prefix: 'build' }).info;
await run(scripts.build, {
cwd: appDirPath,
env: createAppRuntimeEnv(state.env),
log: (msg: string) => {
buildOutput += `\n${msg}`;
log(msg);
Expand DownExpand Up@@ -200,7 +219,7 @@ export const application = (

const proc = run(scripts.serve, {
cwd: appDirPath,
env: { ...envFromFile, PORT: port.toString() },
env: { ...envFromFile, ...createAppRuntimeEnv(state.env), PORT: port.toString() },
detached: opts.detached,
stdout: opts.detached ? fs.openSync(stdoutFilePath, 'a') : undefined,
stderr: opts.detached ? fs.openSync(stderrFilePath, 'a') : undefined,
Expand Down
5 changes: 5 additions & 0 deletions integration/presets/envs.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import { resolve } from 'node:path';

import { automatedEnvironmentVariables } from '@clerk/shared/utils';
import fs from 'fs-extra';

import { constants } from '../constants';
Expand DownExpand Up@@ -91,6 +92,10 @@ const withKeyless = base
.setEnvVariable('private', 'CLERK_API_URL', 'https://api.clerkstage.dev')
.setEnvVariable('public', 'CLERK_KEYLESS_DISABLED', false);

automatedEnvironmentVariables.forEach(name => {
withKeyless.setEnvVariable('private', name, 'false');
});

const withEmailCodes = withInstanceKeys(
'with-email-codes',
base
Expand Down
6 changes: 4 additions & 2 deletions packages/astro/src/server/keyless/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,21 +12,23 @@ export function keyless(context: APIContext) {
keylessServiceInstance = createKeylessService({
storage: createFileStorage(),
api: {
async createAccountlessApplication(requestHeaders?: Headers) {
async createAccountlessApplication(requestHeaders?: Headers, source?: string) {
try {
return await clerkClient(context).__experimental_accountlessApplications.createAccountlessApplication({
requestHeaders,
source,
});
} catch {
return null;
}
},
async completeOnboarding(requestHeaders?: Headers) {
async completeOnboarding(requestHeaders?: Headers, source?: string) {
try {
return await clerkClient(
context,
).__experimental_accountlessApplications.completeAccountlessApplicationOnboarding({
requestHeaders,
source,
});
} catch {
return null;
Expand Down
48 changes: 48 additions & 0 deletions packages/astro/src/utils/__tests__/feature-flags.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
import { automatedEnvironmentVariables } from '@clerk/shared/utils';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

async function loadCanUseKeyless() {
vi.resetModules();
const { canUseKeyless } = await import('../feature-flags.js');
return canUseKeyless;
}

describe('canUseKeyless', () => {
beforeEach(() => {
vi.stubEnv('NODE_ENV', 'development');
vi.stubEnv('PUBLIC_CLERK_KEYLESS_DISABLED', undefined);
vi.stubEnv('CLERK_KEYLESS_DISABLED', undefined);
automatedEnvironmentVariables.forEach(name => {
vi.stubEnv(name, undefined);
vi.stubGlobal(name, undefined);
});
});

afterEach(() => {
vi.unstubAllEnvs();
vi.unstubAllGlobals();
vi.resetModules();
});

it('enables keyless in development when automation signals are absent', async () => {
await expect(loadCanUseKeyless()).resolves.toBe(true);
});

it('disables keyless in CI even when the app runs in development mode', async () => {
vi.stubEnv('CI', 'true');

await expect(loadCanUseKeyless()).resolves.toBe(false);
});

it('disables keyless outside development mode', async () => {
vi.stubEnv('NODE_ENV', 'production');

await expect(loadCanUseKeyless()).resolves.toBe(false);
});

it('disables keyless when explicitly disabled', async () => {
vi.stubEnv('PUBLIC_CLERK_KEYLESS_DISABLED', 'true');

await expect(loadCanUseKeyless()).resolves.toBe(false);
});
});
4 changes: 2 additions & 2 deletions packages/astro/src/utils/feature-flags.ts
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import { getEnvVariable } from '@clerk/shared/getEnvVariable';
import { isTruthy } from '@clerk/shared/underscore';
import { isDevelopmentEnvironment } from '@clerk/shared/utils';
import { isAutomatedEnvironment, isDevelopmentEnvironment } from '@clerk/shared/utils';

const KEYLESS_DISABLED =
isTruthy(getEnvVariable('PUBLIC_CLERK_KEYLESS_DISABLED')) ||
isTruthy(getEnvVariable('CLERK_KEYLESS_DISABLED')) ||
false;

export const canUseKeyless = isDevelopmentEnvironment() && !KEYLESS_DISABLED;
export const canUseKeyless = isDevelopmentEnvironment() && !isAutomatedEnvironment() && !KEYLESS_DISABLED;
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';

import { server } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('AccountlessApplications', () => {
const mockAccountlessApplication = {
object: 'accountless_application',
publishable_key: 'pk_test_keyless',
secret_key: 'sk_test_keyless',
claim_url: 'https://dashboard.clerk.com/claim',
api_keys_url: 'https://dashboard.clerk.com/api-keys',
};

it('creates an accountless application with a source query parameter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('source')).toBe('nextjs');
expect(request.headers.get('Clerk-API-Version')).toBeTruthy();
expect(request.headers.get('User-Agent')).toBe('@clerk/backend@0.0.0-test');

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.createAccountlessApplication({
source: 'nextjs',
});

expect(response.publishableKey).toBe('pk_test_keyless');
});

it('creates an accountless application without a source query parameter when source is omitted', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.has('source')).toBe(false);

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.createAccountlessApplication();

expect(response.publishableKey).toBe('pk_test_keyless');
});

it('completes accountless application onboarding with a source query parameter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications/complete', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('source')).toBe('nextjs');
expect(request.headers.get('Clerk-API-Version')).toBeTruthy();
expect(request.headers.get('User-Agent')).toBe('@clerk/backend@0.0.0-test');

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.completeAccountlessApplicationOnboarding({
source: 'nextjs',
});

expect(response.publishableKey).toBe('pk_test_keyless');
});

it('completes accountless application onboarding without a source query parameter when source is omitted', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications/complete', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.has('source')).toBe(false);

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.completeAccountlessApplicationOnboarding();

expect(response.publishableKey).toBe('pk_test_keyless');
});
});
17 changes: 15 additions & 2 deletions packages/backend/src/api/endpoints/AccountlessApplicationsAPI.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,22 +4,35 @@ import { AbstractAPI } from './AbstractApi';

const basePath = '/accountless_applications';

type AccountlessApplicationParams = {
requestHeaders?: Headers;
source?: string;
};

export class AccountlessApplicationAPI extends AbstractAPI {
public async createAccountlessApplication(params?: { requestHeaders?: Headers }) {
public async createAccountlessApplication(params?: AccountlessApplicationParams): Promise<AccountlessApplication> {
const headerParams = params?.requestHeaders ? Object.fromEntries(params.requestHeaders.entries()) : undefined;
return this.request<AccountlessApplication>({
method: 'POST',
path: basePath,
headerParams,
queryParams: {
source: params?.source,
},
});
}

public async completeAccountlessApplicationOnboarding(params?: { requestHeaders?: Headers }) {
public async completeAccountlessApplicationOnboarding(
params?: AccountlessApplicationParams,
): Promise<AccountlessApplication> {
const headerParams = params?.requestHeaders ? Object.fromEntries(params.requestHeaders.entries()) : undefined;
return this.request<AccountlessApplication>({
method: 'POST',
path: joinPaths(basePath, 'complete'),
headerParams,
queryParams: {
source: params?.source,
},
});
}
}
6 changes: 4 additions & 2 deletions packages/nextjs/src/server/keyless-node.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,19 +24,21 @@ export function keyless() {
keylessServiceInstance = createKeylessService({
storage: createFileStorage(),
api: {
async createAccountlessApplication(requestHeaders?: Headers) {
async createAccountlessApplication(requestHeaders?: Headers, source?: string) {
try {
return await client.__experimental_accountlessApplications.createAccountlessApplication({
requestHeaders,
source,
});
} catch {
return null;
}
},
async completeOnboarding(requestHeaders?: Headers) {
async completeOnboarding(requestHeaders?: Headers, source?: string) {
try {
return await client.__experimental_accountlessApplications.completeAccountlessApplicationOnboarding({
requestHeaders,
source,
});
} catch {
return null;
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); fix(repo): harden keyless accountless requests by mwickett · Pull Request #8676 · clerk/javascript · GitHub
Skip to content
11 changes: 11 additions & 0 deletions .changeset/keyless-ci-guard.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
---
'@clerk/astro': patch
'@clerk/backend': patch
'@clerk/nextjs': patch
'@clerk/nuxt': patch
'@clerk/react-router': patch
'@clerk/shared': patch
'@clerk/tanstack-react-start': patch
---

Prevent keyless mode from activating in CI and other automated environments in framework SDKs.
16 changes: 15 additions & 1 deletion integration/models/__tests__/application.test.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { describe, expect, it } from 'vitest';

import { resolveServerUrl } from '../application';
import { createAppRuntimeEnv, resolveServerUrl } from '../application';
import { environmentConfig } from '../environment';

describe('resolveServerUrl', () => {
describe('with opts.serverUrl', () => {
Expand DownExpand Up@@ -49,3 +50,16 @@ describe('resolveServerUrl', () => {
});
});
});

describe('createAppRuntimeEnv', () => {
it('passes configured falsey values through to spawned app processes', () => {
const env = environmentConfig()
.setEnvVariable('private', 'CI', 'false')
.setEnvVariable('public', 'CLERK_KEYLESS_DISABLED', false);

expect(createAppRuntimeEnv(env)).toMatchObject({
CI: 'false',
CLERK_KEYLESS_DISABLED: 'false',
});
});
});
23 changes: 21 additions & 2 deletions integration/models/application.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,24 @@ export const resolveServerUrl = (
return fallbackServerUrl || `http://localhost:${port}`;
};

export const createAppRuntimeEnv = (env?: EnvironmentConfig): Record<string, string> => {
if (!env?.publicVariables || !env?.privateVariables) {
return {};
}

const runtimeEnv: Record<string, string> = {};
// Private variables intentionally win when the same runtime key exists in both maps.
for (const [key, value] of [...env.publicVariables, ...env.privateVariables]) {
if (value === undefined || value === null) {
continue;
}

runtimeEnv[key] = String(value);
}

return runtimeEnv;
};

export const application = (
config: ApplicationConfig,
appDirPath: string,
Expand DownExpand Up@@ -103,7 +121,7 @@ export const application = (

const proc = run(scripts.dev, {
cwd: appDirPath,
env: { PORT: port.toString() },
env: { ...createAppRuntimeEnv(state.env), PORT: port.toString() },
detached: opts.detached,
stdout: opts.detached ? fs.openSync(stdoutFilePath, 'a') : undefined,
stderr: opts.detached ? fs.openSync(stderrFilePath, 'a') : undefined,
Expand DownExpand Up@@ -158,6 +176,7 @@ export const application = (
const log = logger.child({ prefix: 'build' }).info;
await run(scripts.build, {
cwd: appDirPath,
env: createAppRuntimeEnv(state.env),
log: (msg: string) => {
buildOutput += `\n${msg}`;
log(msg);
Expand DownExpand Up@@ -200,7 +219,7 @@ export const application = (

const proc = run(scripts.serve, {
cwd: appDirPath,
env: { ...envFromFile, PORT: port.toString() },
env: { ...envFromFile, ...createAppRuntimeEnv(state.env), PORT: port.toString() },
detached: opts.detached,
stdout: opts.detached ? fs.openSync(stdoutFilePath, 'a') : undefined,
stderr: opts.detached ? fs.openSync(stderrFilePath, 'a') : undefined,
Expand Down
5 changes: 5 additions & 0 deletions integration/presets/envs.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
import { resolve } from 'node:path';

import { automatedEnvironmentVariables } from '@clerk/shared/utils';
import fs from 'fs-extra';

import { constants } from '../constants';
Expand DownExpand Up@@ -91,6 +92,10 @@ const withKeyless = base
.setEnvVariable('private', 'CLERK_API_URL', 'https://api.clerkstage.dev')
.setEnvVariable('public', 'CLERK_KEYLESS_DISABLED', false);

automatedEnvironmentVariables.forEach(name => {
withKeyless.setEnvVariable('private', name, 'false');
});

const withEmailCodes = withInstanceKeys(
'with-email-codes',
base
Expand Down
6 changes: 4 additions & 2 deletions packages/astro/src/server/keyless/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,21 +12,23 @@ export function keyless(context: APIContext) {
keylessServiceInstance = createKeylessService({
storage: createFileStorage(),
api: {
async createAccountlessApplication(requestHeaders?: Headers) {
async createAccountlessApplication(requestHeaders?: Headers, source?: string) {
try {
return await clerkClient(context).__experimental_accountlessApplications.createAccountlessApplication({
requestHeaders,
source,
});
} catch {
return null;
}
},
async completeOnboarding(requestHeaders?: Headers) {
async completeOnboarding(requestHeaders?: Headers, source?: string) {
try {
return await clerkClient(
context,
).__experimental_accountlessApplications.completeAccountlessApplicationOnboarding({
requestHeaders,
source,
});
} catch {
return null;
Expand Down
48 changes: 48 additions & 0 deletions packages/astro/src/utils/__tests__/feature-flags.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
import { automatedEnvironmentVariables } from '@clerk/shared/utils';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

async function loadCanUseKeyless() {
vi.resetModules();
const { canUseKeyless } = await import('../feature-flags.js');
return canUseKeyless;
}

describe('canUseKeyless', () => {
beforeEach(() => {
vi.stubEnv('NODE_ENV', 'development');
vi.stubEnv('PUBLIC_CLERK_KEYLESS_DISABLED', undefined);
vi.stubEnv('CLERK_KEYLESS_DISABLED', undefined);
automatedEnvironmentVariables.forEach(name => {
vi.stubEnv(name, undefined);
vi.stubGlobal(name, undefined);
});
});

afterEach(() => {
vi.unstubAllEnvs();
vi.unstubAllGlobals();
vi.resetModules();
});

it('enables keyless in development when automation signals are absent', async () => {
await expect(loadCanUseKeyless()).resolves.toBe(true);
});

it('disables keyless in CI even when the app runs in development mode', async () => {
vi.stubEnv('CI', 'true');

await expect(loadCanUseKeyless()).resolves.toBe(false);
});

it('disables keyless outside development mode', async () => {
vi.stubEnv('NODE_ENV', 'production');

await expect(loadCanUseKeyless()).resolves.toBe(false);
});

it('disables keyless when explicitly disabled', async () => {
vi.stubEnv('PUBLIC_CLERK_KEYLESS_DISABLED', 'true');

await expect(loadCanUseKeyless()).resolves.toBe(false);
});
});
4 changes: 2 additions & 2 deletions packages/astro/src/utils/feature-flags.ts
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
import { getEnvVariable } from '@clerk/shared/getEnvVariable';
import { isTruthy } from '@clerk/shared/underscore';
import { isDevelopmentEnvironment } from '@clerk/shared/utils';
import { isAutomatedEnvironment, isDevelopmentEnvironment } from '@clerk/shared/utils';

const KEYLESS_DISABLED =
isTruthy(getEnvVariable('PUBLIC_CLERK_KEYLESS_DISABLED')) ||
isTruthy(getEnvVariable('CLERK_KEYLESS_DISABLED')) ||
false;

export const canUseKeyless = isDevelopmentEnvironment() && !KEYLESS_DISABLED;
export const canUseKeyless = isDevelopmentEnvironment() && !isAutomatedEnvironment() && !KEYLESS_DISABLED;
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';

import { server } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('AccountlessApplications', () => {
const mockAccountlessApplication = {
object: 'accountless_application',
publishable_key: 'pk_test_keyless',
secret_key: 'sk_test_keyless',
claim_url: 'https://dashboard.clerk.com/claim',
api_keys_url: 'https://dashboard.clerk.com/api-keys',
};

it('creates an accountless application with a source query parameter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('source')).toBe('nextjs');
expect(request.headers.get('Clerk-API-Version')).toBeTruthy();
expect(request.headers.get('User-Agent')).toBe('@clerk/backend@0.0.0-test');

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.createAccountlessApplication({
source: 'nextjs',
});

expect(response.publishableKey).toBe('pk_test_keyless');
});

it('creates an accountless application without a source query parameter when source is omitted', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.has('source')).toBe(false);

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.createAccountlessApplication();

expect(response.publishableKey).toBe('pk_test_keyless');
});

it('completes accountless application onboarding with a source query parameter', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications/complete', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('source')).toBe('nextjs');
expect(request.headers.get('Clerk-API-Version')).toBeTruthy();
expect(request.headers.get('User-Agent')).toBe('@clerk/backend@0.0.0-test');

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.completeAccountlessApplicationOnboarding({
source: 'nextjs',
});

expect(response.publishableKey).toBe('pk_test_keyless');
});

it('completes accountless application onboarding without a source query parameter when source is omitted', async () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
});

server.use(
http.post('https://api.clerk.test/v1/accountless_applications/complete', ({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.has('source')).toBe(false);

return HttpResponse.json(mockAccountlessApplication);
}),
);

const response = await apiClient.__experimental_accountlessApplications.completeAccountlessApplicationOnboarding();

expect(response.publishableKey).toBe('pk_test_keyless');
});
});
17 changes: 15 additions & 2 deletions packages/backend/src/api/endpoints/AccountlessApplicationsAPI.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,22 +4,35 @@ import { AbstractAPI } from './AbstractApi';

const basePath = '/accountless_applications';

type AccountlessApplicationParams = {
requestHeaders?: Headers;
source?: string;
};

export class AccountlessApplicationAPI extends AbstractAPI {
public async createAccountlessApplication(params?: { requestHeaders?: Headers }) {
public async createAccountlessApplication(params?: AccountlessApplicationParams): Promise<AccountlessApplication> {
const headerParams = params?.requestHeaders ? Object.fromEntries(params.requestHeaders.entries()) : undefined;
return this.request<AccountlessApplication>({
method: 'POST',
path: basePath,
headerParams,
queryParams: {
source: params?.source,
},
});
}

public async completeAccountlessApplicationOnboarding(params?: { requestHeaders?: Headers }) {
public async completeAccountlessApplicationOnboarding(
params?: AccountlessApplicationParams,
): Promise<AccountlessApplication> {
const headerParams = params?.requestHeaders ? Object.fromEntries(params.requestHeaders.entries()) : undefined;
return this.request<AccountlessApplication>({
method: 'POST',
path: joinPaths(basePath, 'complete'),
headerParams,
queryParams: {
source: params?.source,
},
});
}
}
6 changes: 4 additions & 2 deletions packages/nextjs/src/server/keyless-node.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,19 +24,21 @@ export function keyless() {
keylessServiceInstance = createKeylessService({
storage: createFileStorage(),
api: {
async createAccountlessApplication(requestHeaders?: Headers) {
async createAccountlessApplication(requestHeaders?: Headers, source?: string) {
try {
return await client.__experimental_accountlessApplications.createAccountlessApplication({
requestHeaders,
source,
});
} catch {
return null;
}
},
async completeOnboarding(requestHeaders?: Headers) {
async completeOnboarding(requestHeaders?: Headers, source?: string) {
try {
return await client.__experimental_accountlessApplications.completeAccountlessApplicationOnboarding({
requestHeaders,
source,
});
} catch {
return null;
Expand Down
Loading
Loading