feat(gateway): add custom claims validation and TUI wizard for JWT auth#599

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
tejaskash merged 7 commits into from
Mar 24, 2026
Merged

feat(gateway): add custom claims validation and TUI wizard for JWT auth #599

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8005978
feat(gateway): add custom claims validation and TUI wizard for JWT auth
aidandaly24 Mar 23, 2026
0b14f04
fix(gateway): improve custom claim form navigation UX
aidandaly24 Mar 23, 2026
6e07292
fix(gateway): position cursor before placeholder in custom claim form
aidandaly24 Mar 23, 2026
47b5a3b
test(gateway): update claim form test for Enter-advances-fields behavior
aidandaly24 Mar 23, 2026
f956200
fix: restore CLIENT_ID env var and move inline import to top-level
aidandaly24 Mar 23, 2026
d27c124
style: run prettier and fix test prop
aidandaly24 Mar 23, 2026
1fb146d
ci: retrigger checks
aidandaly24 Mar 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
415 changes: 415 additions & 0 deletions integ-tests/tui/add-gateway-jwt.test.ts
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 6 additions & 0 deletions integ-tests/tui/setup.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
/**
* TUI integration test setup.
*
* This file is referenced by vitest.config.ts as a setupFile for the 'tui' project.
* It runs before each test file in integ-tests/tui/.
*/
126 changes: 91 additions & 35 deletions src/cli/commands/add/__tests__/validate.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -218,40 +218,29 @@ describe('validate', () => {
expect(result.error?.includes('Invalid authorizer type')).toBeTruthy();
});

// AC11: CUSTOM_JWT requires discoveryUrl
it('returns error for CUSTOM_JWT missing discoveryUrl', () => {
const opts = { ...validGatewayOptionsJwt, discoveryUrl: undefined };
const result = validateAddGatewayOptions(opts);
// AC11: CUSTOM_JWT requires discoveryUrl; at least one of allowedAudience/allowedClients/allowedScopes
it('returns error for CUSTOM_JWT missing required fields', () => {
// discoveryUrl is always required
const result = validateAddGatewayOptions({ ...validGatewayOptionsJwt, discoveryUrl: undefined });
expect(result.valid).toBe(false);
expect(result.error).toBe('--discovery-url is required for CUSTOM_JWT authorizer');
});

// AC11b: at least one of audience/clients/scopes required
it('returns error when all of audience, clients, and scopes are missing', () => {
const opts = {
// All three optional fields absent fails
const noneResult = validateAddGatewayOptions({
...validGatewayOptionsJwt,
allowedAudience: undefined,
allowedClients: undefined,
allowedScopes: undefined,
};
const result = validateAddGatewayOptions(opts);
expect(result.valid).toBe(false);
expect(result.error).toContain('At least one of');
});

it('allows CUSTOM_JWT with only allowedScopes', () => {
const opts = {
...validGatewayOptionsJwt,
allowedAudience: undefined,
allowedClients: undefined,
allowedScopes: 'scope1',
};
const result = validateAddGatewayOptions(opts);
expect(result.valid).toBe(true);
});
expect(noneResult.valid).toBe(false);
expect(noneResult.error).toBe(
'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer'
);
});

it('allows CUSTOM_JWT with only allowedAudience', () => {
const opts = { ...validGatewayOptionsJwt, allowedClients: undefined, allowedScopes: undefined };
// AC11b: allowedAudience is optional
it('allows CUSTOM_JWT without allowedAudience', () => {
const opts = { ...validGatewayOptionsJwt, allowedAudience: undefined };
const result = validateAddGatewayOptions(opts);
expect(result.valid).toBe(true);
});
Expand All@@ -269,21 +258,88 @@ describe('validate', () => {
expect(result.error?.includes('.well-known/openid-configuration')).toBeTruthy();
});

it('returns error for HTTP discoveryUrl (HTTPS required)', () => {
// AC13: At least one of audience/clients/scopes must be non-empty
it('returns error when all of audience, clients, and scopes are empty', () => {
const result = validateAddGatewayOptions({
...validGatewayOptionsJwt,
discoveryUrl: 'http://example.com/.well-known/openid-configuration',
allowedAudience: ' ',
allowedClients: undefined,
allowedScopes: undefined,
});
expect(result.valid).toBe(false);
expect(result.error).toBe('Discovery URL must use HTTPS');
expect(result.error).toBe(
'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer'
);
});

it('allows CUSTOM_JWT with only allowedClients', () => {
const opts = { ...validGatewayOptionsJwt, allowedAudience: undefined, allowedScopes: undefined };
const result = validateAddGatewayOptions(opts);
// AC-claims1: --custom-claims with valid JSON passes validation
it('accepts valid --custom-claims JSON', () => {
const result = validateAddGatewayOptions({
...validGatewayOptionsJwt,
customClaims: JSON.stringify([
{
inboundTokenClaimName: 'dept',
inboundTokenClaimValueType: 'STRING',
authorizingClaimMatchValue: {
claimMatchOperator: 'EQUALS',
claimMatchValue: { matchValueString: 'engineering' },
},
},
]),
});
expect(result.valid).toBe(true);
});

// AC-claims2: --custom-claims alone satisfies the "at least one constraint" check
it('allows CUSTOM_JWT with only --custom-claims (no audience/clients/scopes)', () => {
const result = validateAddGatewayOptions({
name: 'test-gw',
authorizerType: 'CUSTOM_JWT',
discoveryUrl: 'https://example.com/.well-known/openid-configuration',
customClaims: JSON.stringify([
{
inboundTokenClaimName: 'role',
inboundTokenClaimValueType: 'STRING_ARRAY',
authorizingClaimMatchValue: {
claimMatchOperator: 'CONTAINS_ANY',
claimMatchValue: { matchValueStringList: ['admin'] },
},
},
]),
});
expect(result.valid).toBe(true);
});

// AC-claims3: --custom-claims with invalid JSON fails
it('returns error for --custom-claims with invalid JSON', () => {
const result = validateAddGatewayOptions({
...validGatewayOptionsJwt,
customClaims: 'not json',
});
expect(result.valid).toBe(false);
expect(result.error).toBe('--custom-claims must be valid JSON');
});

// AC-claims4: --custom-claims with empty array fails
it('returns error for --custom-claims with empty array', () => {
const result = validateAddGatewayOptions({
...validGatewayOptionsJwt,
customClaims: '[]',
});
expect(result.valid).toBe(false);
expect(result.error).toBe('--custom-claims must be a non-empty JSON array');
});

// AC-claims5: --custom-claims with invalid claim structure fails
it('returns error for --custom-claims with invalid claim structure', () => {
const result = validateAddGatewayOptions({
...validGatewayOptionsJwt,
customClaims: JSON.stringify([{ badField: 'value' }]),
});
expect(result.valid).toBe(false);
expect(result.error).toContain('Invalid custom claim at index 0');
});

// AC14: Valid options pass
it('passes for valid options', () => {
expect(validateAddGatewayOptions(validGatewayOptionsNone)).toEqual({ valid: true });
Expand All@@ -309,8 +365,8 @@ describe('validate', () => {
expect(result.error).toBe('Both --client-id and --client-secret must be provided together');
});

// AC16: OAuth credentials only valid with CUSTOM_JWT
it('returns error when OAuth credentials used with non-CUSTOM_JWT authorizer', () => {
// AC16: OAuth client credentials only valid with CUSTOM_JWT
it('returns error when OAuth client credentials used with non-CUSTOM_JWT authorizer', () => {
const result = validateAddGatewayOptions({
...validGatewayOptionsNone,
clientId: 'my-client-id',
Expand All@@ -320,8 +376,8 @@ describe('validate', () => {
expect(result.error).toBe('OAuth client credentials are only valid with CUSTOM_JWT authorizer');
});

// AC17: valid CUSTOM_JWT with OAuth credentials passes
it('passes for CUSTOM_JWT with OAuth credentials', () => {
// AC17: valid CUSTOM_JWT with OAuth client credentials passes
it('passes for CUSTOM_JWT with OAuth client credentials', () => {
const result = validateAddGatewayOptions({
...validGatewayOptionsJwt,
clientId: 'my-client-id',
Expand Down
1 change: 1 addition & 0 deletions src/cli/commands/add/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ export interface AddGatewayOptions {
allowedAudience?: string;
allowedClients?: string;
allowedScopes?: string;
customClaims?: string;
clientId?: string;
clientSecret?: string;
agents?: string;
Expand Down
27 changes: 24 additions & 3 deletions src/cli/commands/add/validate.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { ConfigIO, findConfigRoot } from '../../../lib';
import {
AgentNameSchema,
BuildTypeSchema,
CustomClaimValidationSchema,
GatewayExceptionLevelSchema,
GatewayNameSchema,
ModelProviderSchema,
Expand DownExpand Up@@ -275,16 +276,36 @@ export function validateAddGatewayOptions(options: AddGatewayOptions): Validatio
return { valid: false, error: `Discovery URL must end with ${OIDC_WELL_KNOWN_SUFFIX}` };
}

// allowedAudience, allowedClients, allowedScopes are all optional individually,
// Validate custom claims JSON if provided
if (options.customClaims) {
let parsed: unknown;
try {
parsed = JSON.parse(options.customClaims);
} catch {
return { valid: false, error: '--custom-claims must be valid JSON' };
}
if (!Array.isArray(parsed) || parsed.length === 0) {
return { valid: false, error: '--custom-claims must be a non-empty JSON array' };
}
for (const [i, entry] of parsed.entries()) {
const result = CustomClaimValidationSchema.safeParse(entry);
if (!result.success) {
return { valid: false, error: `Invalid custom claim at index ${i}: ${result.error.issues[0]?.message}` };
}
}
}

// allowedAudience, allowedClients, allowedScopes, customClaims are all optional individually,
// but at least one must be provided
const hasAudience = !!options.allowedAudience?.trim();
const hasClients = !!options.allowedClients?.trim();
const hasScopes = !!options.allowedScopes?.trim();
if (!hasAudience && !hasClients && !hasScopes) {
const hasClaims = !!options.customClaims?.trim();
if (!hasAudience && !hasClients && !hasScopes && !hasClaims) {
return {
valid: false,
error:
'At least one of --allowed-audience, --allowed-clients, or --allowed-scopes must be provided for CUSTOM_JWT authorizer',
'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer',
};
}
}
Expand Down
18 changes: 15 additions & 3 deletions src/cli/primitives/GatewayPrimitive.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type {
AgentCoreGatewayTarget,
AgentCoreMcpSpec,
AgentCoreProjectSpec,
CustomClaimValidation,
GatewayAuthorizerType,
} from '../../schema';
import { AgentCoreGatewaySchema, PolicyEngineModeSchema } from '../../schema';
Expand All@@ -29,6 +30,7 @@ export interface AddGatewayOptions {
allowedAudience?: string;
allowedClients?: string;
allowedScopes?: string;
customClaims?: CustomClaimValidation[];
clientId?: string;
clientSecret?: string;
agents?: string;
Expand DownExpand Up@@ -164,6 +166,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
.option('--allowed-audience <audience>', 'Comma-separated allowed audiences (for CUSTOM_JWT)')
.option('--allowed-clients <clients>', 'Comma-separated allowed client IDs (for CUSTOM_JWT)')
.option('--allowed-scopes <scopes>', 'Comma-separated allowed scopes (for CUSTOM_JWT)')
.option('--custom-claims <json>', 'Custom claim validations as JSON array (for CUSTOM_JWT)')
.option('--client-id <id>', 'OAuth client ID for gateway bearer token')
.option('--client-secret <secret>', 'OAuth client secret')
.option('--agents <agents>', 'Comma-separated agent names')
Expand All@@ -190,6 +193,11 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
process.exit(1);
}

// Parse custom claims JSON if provided (already validated)
const parsedCustomClaims = cliOptions.customClaims
? (JSON.parse(cliOptions.customClaims) as CustomClaimValidation[])
: undefined;

const result = await this.add({
name: cliOptions.name!,
description: cliOptions.description,
Expand All@@ -198,6 +206,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
allowedAudience: cliOptions.allowedAudience,
allowedClients: cliOptions.allowedClients,
allowedScopes: cliOptions.allowedScopes,
customClaims: parsedCustomClaims,
clientId: cliOptions.clientId,
clientSecret: cliOptions.clientSecret,
agents: cliOptions.agents,
Expand DownExpand Up@@ -334,6 +343,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
...(allowedAudience?.length ? { allowedAudience } : {}),
...(allowedClients?.length ? { allowedClients } : {}),
...(allowedScopes?.length ? { allowedScopes } : {}),
...(options.customClaims?.length ? { customClaims: options.customClaims } : {}),
...(options.clientId ? { clientId: options.clientId } : {}),
...(options.clientSecret ? { clientSecret: options.clientSecret } : {}),
};
Expand DownExpand Up@@ -415,9 +425,10 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
});
await this.writeProjectSpec(project);

// Write client secret to .env
const envVarName = computeDefaultCredentialEnvVarName(credentialName);
await setEnvVar(envVarName, jwtConfig.clientSecret!);
// Write client ID and client secret to .env
const envVarPrefix = computeDefaultCredentialEnvVarName(credentialName);
await setEnvVar(`${envVarPrefix}_CLIENT_ID`, jwtConfig.clientId!);
await setEnvVar(`${envVarPrefix}_CLIENT_SECRET`, jwtConfig.clientSecret!);
}

/**
Expand All@@ -434,6 +445,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
...(config.jwtConfig.allowedAudience?.length ? { allowedAudience: config.jwtConfig.allowedAudience } : {}),
...(config.jwtConfig.allowedClients?.length ? { allowedClients: config.jwtConfig.allowedClients } : {}),
...(config.jwtConfig.allowedScopes?.length ? { allowedScopes: config.jwtConfig.allowedScopes } : {}),
...(config.jwtConfig.customClaims?.length ? { customClaims: config.jwtConfig.customClaims } : {}),
},
};
}
Expand Down
72 changes: 72 additions & 0 deletions src/cli/primitives/__tests__/GatewayPrimitive.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,78 @@ describe('GatewayPrimitive', () => {
primitive = new GatewayPrimitive();
});

describe('customClaims pipeline', () => {
const SAMPLE_CLAIMS = [
{
inboundTokenClaimName: 'department',
inboundTokenClaimValueType: 'STRING_ARRAY' as const,
authorizingClaimMatchValue: {
claimMatchOperator: 'CONTAINS_ANY' as const,
claimMatchValue: { matchValueStringList: ['engineering', 'sales'] },
},
},
];

it('custom claims from TUI flow are written to authorizerConfiguration', async () => {
await primitive.add({
name: 'jwt-gw',
authorizerType: 'CUSTOM_JWT',
discoveryUrl: 'https://example.com/.well-known/openid-configuration',
allowedAudience: 'aud1',
customClaims: SAMPLE_CLAIMS,
});

const gw = getWrittenGateway();
expect(gw.authorizerConfiguration?.customJwtAuthorizer).toBeDefined();
expect(gw.authorizerConfiguration!.customJwtAuthorizer!.customClaims).toEqual(SAMPLE_CLAIMS);
});

it('custom claims are preserved alongside audience and clients', async () => {
await primitive.add({
name: 'jwt-gw',
authorizerType: 'CUSTOM_JWT',
discoveryUrl: 'https://example.com/.well-known/openid-configuration',
allowedAudience: 'aud1,aud2',
allowedClients: 'client1',
customClaims: SAMPLE_CLAIMS,
});

const gw = getWrittenGateway();
const jwtConfig = gw.authorizerConfiguration!.customJwtAuthorizer!;
expect(jwtConfig.allowedAudience).toEqual(['aud1', 'aud2']);
expect(jwtConfig.allowedClients).toEqual(['client1']);
expect(jwtConfig.customClaims).toEqual(SAMPLE_CLAIMS);
});

it('omits customClaims from authorizerConfiguration when not provided', async () => {
await primitive.add({
name: 'jwt-gw',
authorizerType: 'CUSTOM_JWT',
discoveryUrl: 'https://example.com/.well-known/openid-configuration',
allowedAudience: 'aud1',
});

const gw = getWrittenGateway();
expect(gw.authorizerConfiguration!.customJwtAuthorizer!.customClaims).toBeUndefined();
});

it('custom claims only (no audience/clients/scopes) produces valid config', async () => {
await primitive.add({
name: 'jwt-gw',
authorizerType: 'CUSTOM_JWT',
discoveryUrl: 'https://example.com/.well-known/openid-configuration',
customClaims: SAMPLE_CLAIMS,
});

const gw = getWrittenGateway();
const jwtConfig = gw.authorizerConfiguration!.customJwtAuthorizer!;
expect(jwtConfig.allowedAudience).toBeUndefined();
expect(jwtConfig.allowedClients).toBeUndefined();
expect(jwtConfig.allowedScopes).toBeUndefined();
expect(jwtConfig.customClaims).toEqual(SAMPLE_CLAIMS);
});
});

describe('exceptionLevel', () => {
it('defaults to exceptionLevel NONE', async () => {
await primitive.add({ name: 'test-gw', authorizerType: 'NONE' });
Expand Down
1 change: 1 addition & 0 deletions src/cli/tui/hooks/useCreateMcp.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ export function useCreateGateway() {
allowedAudience: config.jwtConfig?.allowedAudience?.join(','),
allowedClients: config.jwtConfig?.allowedClients?.join(','),
allowedScopes: config.jwtConfig?.allowedScopes?.join(','),
customClaims: config.jwtConfig?.customClaims,
clientId: config.jwtConfig?.clientId,
clientSecret: config.jwtConfig?.clientSecret,
enableSemanticSearch: config.enableSemanticSearch,
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(gateway): add custom claims validation and TUI wizard for JWT auth#599

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tejaskash
merged 7 commits into

from

Mar 24, 2026
 Merged


feat(gateway): add custom claims validation and TUI wizard for JWT auth
#599
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
8005978

feat(gateway): add custom claims validation and TUI wizard for JWT auth


aidandaly24 Mar 23, 2026
0b14f04

fix(gateway): improve custom claim form navigation UX


aidandaly24 Mar 23, 2026
6e07292

fix(gateway): position cursor before placeholder in custom claim form


aidandaly24 Mar 23, 2026
47b5a3b

test(gateway): update claim form test for Enter-advances-fields behavior


aidandaly24 Mar 23, 2026
f956200

fix: restore CLIENT_ID env var and move inline import to top-level


aidandaly24 Mar 23, 2026
d27c124

style: run prettier and fix test prop


aidandaly24 Mar 23, 2026
1fb146d

ci: retrigger checks


aidandaly24 Mar 24, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


415 changes: 415 additions & 0 deletions
integ-tests/tui/add-gateway-jwt.test.ts

View file


Open in desktop


Large diffs are not rendered by default.


6 changes: 6 additions & 0 deletions
integ-tests/tui/setup.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
/**
 * TUI integration test setup.
 *
 * This file is referenced by vitest.config.ts as a setupFile for the 'tui' project.
 * It runs before each test file in integ-tests/tui/.
 */

126 changes: 91 additions & 35 deletions
src/cli/commands/add/__tests__/validate.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -218,40 +218,29 @@ describe('validate', () => {
 expect(result.error?.includes('Invalid authorizer type')).toBeTruthy();
 });

 // AC11: CUSTOM_JWT requires discoveryUrl
 it('returns error for CUSTOM_JWT missing discoveryUrl', () => {
const opts = { ...validGatewayOptionsJwt, discoveryUrl: undefined };
 const result = validateAddGatewayOptions(opts);
 // AC11: CUSTOM_JWT requires discoveryUrl; at least one of allowedAudience/allowedClients/allowedScopes
 it('returns error for CUSTOM_JWT missing required fields', () => {
// discoveryUrl is always required
 const result = validateAddGatewayOptions({ ...validGatewayOptionsJwt, discoveryUrl: undefined });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('--discovery-url is required for CUSTOM_JWT authorizer');
 });

 // AC11b: at least one of audience/clients/scopes required
 it('returns error when all of audience, clients, and scopes are missing', () => {
 const opts = {
 // All three optional fields absent fails
 const noneResult = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 allowedAudience: undefined,
 allowedClients: undefined,
 allowedScopes: undefined,
 };
 const result = validateAddGatewayOptions(opts);
 expect(result.valid).toBe(false);
 expect(result.error).toContain('At least one of');
 });

 it('allows CUSTOM_JWT with only allowedScopes', () => {
 const opts = {
 ...validGatewayOptionsJwt,
 allowedAudience: undefined,
 allowedClients: undefined,
 allowedScopes: 'scope1',
 };
 const result = validateAddGatewayOptions(opts);
 expect(result.valid).toBe(true);
 });
 expect(noneResult.valid).toBe(false);
 expect(noneResult.error).toBe(
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer'
 );
 });

 it('allows CUSTOM_JWT with only allowedAudience', () => {
 const opts = { ...validGatewayOptionsJwt, allowedClients: undefined, allowedScopes: undefined };
 // AC11b: allowedAudience is optional
 it('allows CUSTOM_JWT without allowedAudience', () => {
 const opts = { ...validGatewayOptionsJwt, allowedAudience: undefined };
 const result = validateAddGatewayOptions(opts);
 expect(result.valid).toBe(true);
 });
Expand All@@ -269,21 +258,88 @@ describe('validate', () => {
 expect(result.error?.includes('.well-known/openid-configuration')).toBeTruthy();
 });

 it('returns error for HTTP discoveryUrl (HTTPS required)', () => {
 // AC13: At least one of audience/clients/scopes must be non-empty
 it('returns error when all of audience, clients, and scopes are empty', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 discoveryUrl: 'http://example.com/.well-known/openid-configuration',
 allowedAudience: ' ',
 allowedClients: undefined,
 allowedScopes: undefined,
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('Discovery URL must use HTTPS');
 expect(result.error).toBe(
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer'
 );
 });

 it('allows CUSTOM_JWT with only allowedClients', () => {
 const opts = { ...validGatewayOptionsJwt, allowedAudience: undefined, allowedScopes: undefined };
 const result = validateAddGatewayOptions(opts);
 // AC-claims1: --custom-claims with valid JSON passes validation
 it('accepts valid --custom-claims JSON', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 customClaims: JSON.stringify([
 {
 inboundTokenClaimName: 'dept',
 inboundTokenClaimValueType: 'STRING',
 authorizingClaimMatchValue: {
 claimMatchOperator: 'EQUALS',
 claimMatchValue: { matchValueString: 'engineering' },
 },
 },
 ]),
 });
 expect(result.valid).toBe(true);
 });

 // AC-claims2: --custom-claims alone satisfies the "at least one constraint" check
 it('allows CUSTOM_JWT with only --custom-claims (no audience/clients/scopes)', () => {
 const result = validateAddGatewayOptions({
 name: 'test-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 customClaims: JSON.stringify([
 {
 inboundTokenClaimName: 'role',
 inboundTokenClaimValueType: 'STRING_ARRAY',
 authorizingClaimMatchValue: {
 claimMatchOperator: 'CONTAINS_ANY',
 claimMatchValue: { matchValueStringList: ['admin'] },
 },
 },
 ]),
 });
 expect(result.valid).toBe(true);
 });

 // AC-claims3: --custom-claims with invalid JSON fails
 it('returns error for --custom-claims with invalid JSON', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 customClaims: 'not json',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('--custom-claims must be valid JSON');
 });

 // AC-claims4: --custom-claims with empty array fails
 it('returns error for --custom-claims with empty array', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 customClaims: '[]',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('--custom-claims must be a non-empty JSON array');
 });

 // AC-claims5: --custom-claims with invalid claim structure fails
 it('returns error for --custom-claims with invalid claim structure', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 customClaims: JSON.stringify([{ badField: 'value' }]),
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('Invalid custom claim at index 0');
 });

 // AC14: Valid options pass
 it('passes for valid options', () => {
 expect(validateAddGatewayOptions(validGatewayOptionsNone)).toEqual({ valid: true });
Expand All@@ -309,8 +365,8 @@ describe('validate', () => {
 expect(result.error).toBe('Both --client-id and --client-secret must be provided together');
 });

 // AC16: OAuth credentials only valid with CUSTOM_JWT
 it('returns error when OAuth credentials used with non-CUSTOM_JWT authorizer', () => {
 // AC16: OAuth client credentials only valid with CUSTOM_JWT
 it('returns error when OAuth client credentials used with non-CUSTOM_JWT authorizer', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsNone,
 clientId: 'my-client-id',
Expand All@@ -320,8 +376,8 @@ describe('validate', () => {
 expect(result.error).toBe('OAuth client credentials are only valid with CUSTOM_JWT authorizer');
 });

 // AC17: valid CUSTOM_JWT with OAuth credentials passes
 it('passes for CUSTOM_JWT with OAuth credentials', () => {
 // AC17: valid CUSTOM_JWT with OAuth client credentials passes
 it('passes for CUSTOM_JWT with OAuth client credentials', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 clientId: 'my-client-id',
Expand Down

1 change: 1 addition & 0 deletions
src/cli/commands/add/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ export interface AddGatewayOptions {
 allowedAudience?: string;
 allowedClients?: string;
 allowedScopes?: string;
 customClaims?: string;
 clientId?: string;
 clientSecret?: string;
 agents?: string;
Expand Down

27 changes: 24 additions & 3 deletions
src/cli/commands/add/validate.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { ConfigIO, findConfigRoot } from '../../../lib';
import {
 AgentNameSchema,
 BuildTypeSchema,
 CustomClaimValidationSchema,
 GatewayExceptionLevelSchema,
 GatewayNameSchema,
 ModelProviderSchema,
Expand DownExpand Up@@ -275,16 +276,36 @@ export function validateAddGatewayOptions(options: AddGatewayOptions): Validatio
 return { valid: false, error: `Discovery URL must end with ${OIDC_WELL_KNOWN_SUFFIX}` };
 }

 // allowedAudience, allowedClients, allowedScopes are all optional individually,
 // Validate custom claims JSON if provided
 if (options.customClaims) {
 let parsed: unknown;
 try {
 parsed = JSON.parse(options.customClaims);
 } catch {
 return { valid: false, error: '--custom-claims must be valid JSON' };
 }
 if (!Array.isArray(parsed) || parsed.length === 0) {
 return { valid: false, error: '--custom-claims must be a non-empty JSON array' };
 }
 for (const [i, entry] of parsed.entries()) {
 const result = CustomClaimValidationSchema.safeParse(entry);
 if (!result.success) {
 return { valid: false, error: `Invalid custom claim at index ${i}: ${result.error.issues[0]?.message}` };
 }
 }
 }

 // allowedAudience, allowedClients, allowedScopes, customClaims are all optional individually,
 // but at least one must be provided
 const hasAudience = !!options.allowedAudience?.trim();
 const hasClients = !!options.allowedClients?.trim();
 const hasScopes = !!options.allowedScopes?.trim();
 if (!hasAudience && !hasClients && !hasScopes) {
 const hasClaims = !!options.customClaims?.trim();
 if (!hasAudience && !hasClients && !hasScopes && !hasClaims) {
 return {
 valid: false,
 error:
 'At least one of --allowed-audience, --allowed-clients, or --allowed-scopes must be provided for CUSTOM_JWT authorizer',
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer',
 };
 }
 }
Expand Down

18 changes: 15 additions & 3 deletions
src/cli/primitives/GatewayPrimitive.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type {
 AgentCoreGatewayTarget,
 AgentCoreMcpSpec,
 AgentCoreProjectSpec,
 CustomClaimValidation,
 GatewayAuthorizerType,
} from '../../schema';
import { AgentCoreGatewaySchema, PolicyEngineModeSchema } from '../../schema';
Expand All@@ -29,6 +30,7 @@ export interface AddGatewayOptions {
 allowedAudience?: string;
 allowedClients?: string;
 allowedScopes?: string;
 customClaims?: CustomClaimValidation[];
 clientId?: string;
 clientSecret?: string;
 agents?: string;
Expand DownExpand Up@@ -164,6 +166,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 .option('--allowed-audience <audience>', 'Comma-separated allowed audiences (for CUSTOM_JWT)')
 .option('--allowed-clients <clients>', 'Comma-separated allowed client IDs (for CUSTOM_JWT)')
 .option('--allowed-scopes <scopes>', 'Comma-separated allowed scopes (for CUSTOM_JWT)')
 .option('--custom-claims <json>', 'Custom claim validations as JSON array (for CUSTOM_JWT)')
 .option('--client-id <id>', 'OAuth client ID for gateway bearer token')
 .option('--client-secret <secret>', 'OAuth client secret')
 .option('--agents <agents>', 'Comma-separated agent names')
Expand All@@ -190,6 +193,11 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 process.exit(1);
 }

 // Parse custom claims JSON if provided (already validated)
 const parsedCustomClaims = cliOptions.customClaims
 ? (JSON.parse(cliOptions.customClaims) as CustomClaimValidation[])
 : undefined;

 const result = await this.add({
 name: cliOptions.name!,
 description: cliOptions.description,
Expand All@@ -198,6 +206,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 allowedAudience: cliOptions.allowedAudience,
 allowedClients: cliOptions.allowedClients,
 allowedScopes: cliOptions.allowedScopes,
 customClaims: parsedCustomClaims,
 clientId: cliOptions.clientId,
 clientSecret: cliOptions.clientSecret,
 agents: cliOptions.agents,
Expand DownExpand Up@@ -334,6 +343,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 ...(allowedAudience?.length ? { allowedAudience } : {}),
 ...(allowedClients?.length ? { allowedClients } : {}),
 ...(allowedScopes?.length ? { allowedScopes } : {}),
 ...(options.customClaims?.length ? { customClaims: options.customClaims } : {}),
 ...(options.clientId ? { clientId: options.clientId } : {}),
 ...(options.clientSecret ? { clientSecret: options.clientSecret } : {}),
 };
Expand DownExpand Up@@ -415,9 +425,10 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 });
 await this.writeProjectSpec(project);

 // Write client secret to .env
 const envVarName = computeDefaultCredentialEnvVarName(credentialName);
 await setEnvVar(envVarName, jwtConfig.clientSecret!);
 // Write client ID and client secret to .env
 const envVarPrefix = computeDefaultCredentialEnvVarName(credentialName);
 await setEnvVar(`${envVarPrefix}_CLIENT_ID`, jwtConfig.clientId!);
 await setEnvVar(`${envVarPrefix}_CLIENT_SECRET`, jwtConfig.clientSecret!);
 }

 /**
Expand All@@ -434,6 +445,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 ...(config.jwtConfig.allowedAudience?.length ? { allowedAudience: config.jwtConfig.allowedAudience } : {}),
 ...(config.jwtConfig.allowedClients?.length ? { allowedClients: config.jwtConfig.allowedClients } : {}),
 ...(config.jwtConfig.allowedScopes?.length ? { allowedScopes: config.jwtConfig.allowedScopes } : {}),
 ...(config.jwtConfig.customClaims?.length ? { customClaims: config.jwtConfig.customClaims } : {}),
 },
 };
 }
Expand Down

72 changes: 72 additions & 0 deletions
src/cli/primitives/__tests__/GatewayPrimitive.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,78 @@ describe('GatewayPrimitive', () => {
 primitive = new GatewayPrimitive();
 });

 describe('customClaims pipeline', () => {
 const SAMPLE_CLAIMS = [
 {
 inboundTokenClaimName: 'department',
 inboundTokenClaimValueType: 'STRING_ARRAY' as const,
 authorizingClaimMatchValue: {
 claimMatchOperator: 'CONTAINS_ANY' as const,
 claimMatchValue: { matchValueStringList: ['engineering', 'sales'] },
 },
 },
 ];

 it('custom claims from TUI flow are written to authorizerConfiguration', async () => {
 await primitive.add({
 name: 'jwt-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 allowedAudience: 'aud1',
 customClaims: SAMPLE_CLAIMS,
 });

 const gw = getWrittenGateway();
 expect(gw.authorizerConfiguration?.customJwtAuthorizer).toBeDefined();
 expect(gw.authorizerConfiguration!.customJwtAuthorizer!.customClaims).toEqual(SAMPLE_CLAIMS);
 });

 it('custom claims are preserved alongside audience and clients', async () => {
 await primitive.add({
 name: 'jwt-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 allowedAudience: 'aud1,aud2',
 allowedClients: 'client1',
 customClaims: SAMPLE_CLAIMS,
 });

 const gw = getWrittenGateway();
 const jwtConfig = gw.authorizerConfiguration!.customJwtAuthorizer!;
 expect(jwtConfig.allowedAudience).toEqual(['aud1', 'aud2']);
 expect(jwtConfig.allowedClients).toEqual(['client1']);
 expect(jwtConfig.customClaims).toEqual(SAMPLE_CLAIMS);
 });

 it('omits customClaims from authorizerConfiguration when not provided', async () => {
 await primitive.add({
 name: 'jwt-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 allowedAudience: 'aud1',
 });

 const gw = getWrittenGateway();
 expect(gw.authorizerConfiguration!.customJwtAuthorizer!.customClaims).toBeUndefined();
 });

 it('custom claims only (no audience/clients/scopes) produces valid config', async () => {
 await primitive.add({
 name: 'jwt-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 customClaims: SAMPLE_CLAIMS,
 });

 const gw = getWrittenGateway();
 const jwtConfig = gw.authorizerConfiguration!.customJwtAuthorizer!;
 expect(jwtConfig.allowedAudience).toBeUndefined();
 expect(jwtConfig.allowedClients).toBeUndefined();
 expect(jwtConfig.allowedScopes).toBeUndefined();
 expect(jwtConfig.customClaims).toEqual(SAMPLE_CLAIMS);
 });
 });

 describe('exceptionLevel', () => {
 it('defaults to exceptionLevel NONE', async () => {
 await primitive.add({ name: 'test-gw', authorizerType: 'NONE' });
Expand Down

1 change: 1 addition & 0 deletions
src/cli/tui/hooks/useCreateMcp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ export function useCreateGateway() {
 allowedAudience: config.jwtConfig?.allowedAudience?.join(','),
 allowedClients: config.jwtConfig?.allowedClients?.join(','),
 allowedScopes: config.jwtConfig?.allowedScopes?.join(','),
 customClaims: config.jwtConfig?.customClaims,
 clientId: config.jwtConfig?.clientId,
 clientSecret: config.jwtConfig?.clientSecret,
 enableSemanticSearch: config.enableSemanticSearch,
Expand Down
Loading
Loading

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

Skip to content
feat(gateway): add custom claims validation and TUI wizard for JWT auth#599

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tejaskash
merged 7 commits into

from

Mar 24, 2026
 Merged


feat(gateway): add custom claims validation and TUI wizard for JWT auth
#599
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
8005978

feat(gateway): add custom claims validation and TUI wizard for JWT auth


aidandaly24 Mar 23, 2026
0b14f04

fix(gateway): improve custom claim form navigation UX


aidandaly24 Mar 23, 2026
6e07292

fix(gateway): position cursor before placeholder in custom claim form


aidandaly24 Mar 23, 2026
47b5a3b

test(gateway): update claim form test for Enter-advances-fields behavior


aidandaly24 Mar 23, 2026
f956200

fix: restore CLIENT_ID env var and move inline import to top-level


aidandaly24 Mar 23, 2026
d27c124

style: run prettier and fix test prop


aidandaly24 Mar 23, 2026
1fb146d

ci: retrigger checks


aidandaly24 Mar 24, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


415 changes: 415 additions & 0 deletions
integ-tests/tui/add-gateway-jwt.test.ts

View file


Open in desktop


Large diffs are not rendered by default.


6 changes: 6 additions & 0 deletions
integ-tests/tui/setup.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
/**
 * TUI integration test setup.
 *
 * This file is referenced by vitest.config.ts as a setupFile for the 'tui' project.
 * It runs before each test file in integ-tests/tui/.
 */

126 changes: 91 additions & 35 deletions
src/cli/commands/add/__tests__/validate.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -218,40 +218,29 @@ describe('validate', () => {
 expect(result.error?.includes('Invalid authorizer type')).toBeTruthy();
 });

 // AC11: CUSTOM_JWT requires discoveryUrl
 it('returns error for CUSTOM_JWT missing discoveryUrl', () => {
const opts = { ...validGatewayOptionsJwt, discoveryUrl: undefined };
 const result = validateAddGatewayOptions(opts);
 // AC11: CUSTOM_JWT requires discoveryUrl; at least one of allowedAudience/allowedClients/allowedScopes
 it('returns error for CUSTOM_JWT missing required fields', () => {
// discoveryUrl is always required
 const result = validateAddGatewayOptions({ ...validGatewayOptionsJwt, discoveryUrl: undefined });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('--discovery-url is required for CUSTOM_JWT authorizer');
 });

 // AC11b: at least one of audience/clients/scopes required
 it('returns error when all of audience, clients, and scopes are missing', () => {
 const opts = {
 // All three optional fields absent fails
 const noneResult = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 allowedAudience: undefined,
 allowedClients: undefined,
 allowedScopes: undefined,
 };
 const result = validateAddGatewayOptions(opts);
 expect(result.valid).toBe(false);
 expect(result.error).toContain('At least one of');
 });

 it('allows CUSTOM_JWT with only allowedScopes', () => {
 const opts = {
 ...validGatewayOptionsJwt,
 allowedAudience: undefined,
 allowedClients: undefined,
 allowedScopes: 'scope1',
 };
 const result = validateAddGatewayOptions(opts);
 expect(result.valid).toBe(true);
 });
 expect(noneResult.valid).toBe(false);
 expect(noneResult.error).toBe(
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer'
 );
 });

 it('allows CUSTOM_JWT with only allowedAudience', () => {
 const opts = { ...validGatewayOptionsJwt, allowedClients: undefined, allowedScopes: undefined };
 // AC11b: allowedAudience is optional
 it('allows CUSTOM_JWT without allowedAudience', () => {
 const opts = { ...validGatewayOptionsJwt, allowedAudience: undefined };
 const result = validateAddGatewayOptions(opts);
 expect(result.valid).toBe(true);
 });
Expand All@@ -269,21 +258,88 @@ describe('validate', () => {
 expect(result.error?.includes('.well-known/openid-configuration')).toBeTruthy();
 });

 it('returns error for HTTP discoveryUrl (HTTPS required)', () => {
 // AC13: At least one of audience/clients/scopes must be non-empty
 it('returns error when all of audience, clients, and scopes are empty', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 discoveryUrl: 'http://example.com/.well-known/openid-configuration',
 allowedAudience: ' ',
 allowedClients: undefined,
 allowedScopes: undefined,
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('Discovery URL must use HTTPS');
 expect(result.error).toBe(
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer'
 );
 });

 it('allows CUSTOM_JWT with only allowedClients', () => {
 const opts = { ...validGatewayOptionsJwt, allowedAudience: undefined, allowedScopes: undefined };
 const result = validateAddGatewayOptions(opts);
 // AC-claims1: --custom-claims with valid JSON passes validation
 it('accepts valid --custom-claims JSON', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 customClaims: JSON.stringify([
 {
 inboundTokenClaimName: 'dept',
 inboundTokenClaimValueType: 'STRING',
 authorizingClaimMatchValue: {
 claimMatchOperator: 'EQUALS',
 claimMatchValue: { matchValueString: 'engineering' },
 },
 },
 ]),
 });
 expect(result.valid).toBe(true);
 });

 // AC-claims2: --custom-claims alone satisfies the "at least one constraint" check
 it('allows CUSTOM_JWT with only --custom-claims (no audience/clients/scopes)', () => {
 const result = validateAddGatewayOptions({
 name: 'test-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 customClaims: JSON.stringify([
 {
 inboundTokenClaimName: 'role',
 inboundTokenClaimValueType: 'STRING_ARRAY',
 authorizingClaimMatchValue: {
 claimMatchOperator: 'CONTAINS_ANY',
 claimMatchValue: { matchValueStringList: ['admin'] },
 },
 },
 ]),
 });
 expect(result.valid).toBe(true);
 });

 // AC-claims3: --custom-claims with invalid JSON fails
 it('returns error for --custom-claims with invalid JSON', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 customClaims: 'not json',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('--custom-claims must be valid JSON');
 });

 // AC-claims4: --custom-claims with empty array fails
 it('returns error for --custom-claims with empty array', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 customClaims: '[]',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('--custom-claims must be a non-empty JSON array');
 });

 // AC-claims5: --custom-claims with invalid claim structure fails
 it('returns error for --custom-claims with invalid claim structure', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 customClaims: JSON.stringify([{ badField: 'value' }]),
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('Invalid custom claim at index 0');
 });

 // AC14: Valid options pass
 it('passes for valid options', () => {
 expect(validateAddGatewayOptions(validGatewayOptionsNone)).toEqual({ valid: true });
Expand All@@ -309,8 +365,8 @@ describe('validate', () => {
 expect(result.error).toBe('Both --client-id and --client-secret must be provided together');
 });

 // AC16: OAuth credentials only valid with CUSTOM_JWT
 it('returns error when OAuth credentials used with non-CUSTOM_JWT authorizer', () => {
 // AC16: OAuth client credentials only valid with CUSTOM_JWT
 it('returns error when OAuth client credentials used with non-CUSTOM_JWT authorizer', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsNone,
 clientId: 'my-client-id',
Expand All@@ -320,8 +376,8 @@ describe('validate', () => {
 expect(result.error).toBe('OAuth client credentials are only valid with CUSTOM_JWT authorizer');
 });

 // AC17: valid CUSTOM_JWT with OAuth credentials passes
 it('passes for CUSTOM_JWT with OAuth credentials', () => {
 // AC17: valid CUSTOM_JWT with OAuth client credentials passes
 it('passes for CUSTOM_JWT with OAuth client credentials', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 clientId: 'my-client-id',
Expand Down

1 change: 1 addition & 0 deletions
src/cli/commands/add/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ export interface AddGatewayOptions {
 allowedAudience?: string;
 allowedClients?: string;
 allowedScopes?: string;
 customClaims?: string;
 clientId?: string;
 clientSecret?: string;
 agents?: string;
Expand Down

27 changes: 24 additions & 3 deletions
src/cli/commands/add/validate.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { ConfigIO, findConfigRoot } from '../../../lib';
import {
 AgentNameSchema,
 BuildTypeSchema,
 CustomClaimValidationSchema,
 GatewayExceptionLevelSchema,
 GatewayNameSchema,
 ModelProviderSchema,
Expand DownExpand Up@@ -275,16 +276,36 @@ export function validateAddGatewayOptions(options: AddGatewayOptions): Validatio
 return { valid: false, error: `Discovery URL must end with ${OIDC_WELL_KNOWN_SUFFIX}` };
 }

 // allowedAudience, allowedClients, allowedScopes are all optional individually,
 // Validate custom claims JSON if provided
 if (options.customClaims) {
 let parsed: unknown;
 try {
 parsed = JSON.parse(options.customClaims);
 } catch {
 return { valid: false, error: '--custom-claims must be valid JSON' };
 }
 if (!Array.isArray(parsed) || parsed.length === 0) {
 return { valid: false, error: '--custom-claims must be a non-empty JSON array' };
 }
 for (const [i, entry] of parsed.entries()) {
 const result = CustomClaimValidationSchema.safeParse(entry);
 if (!result.success) {
 return { valid: false, error: `Invalid custom claim at index ${i}: ${result.error.issues[0]?.message}` };
 }
 }
 }

 // allowedAudience, allowedClients, allowedScopes, customClaims are all optional individually,
 // but at least one must be provided
 const hasAudience = !!options.allowedAudience?.trim();
 const hasClients = !!options.allowedClients?.trim();
 const hasScopes = !!options.allowedScopes?.trim();
 if (!hasAudience && !hasClients && !hasScopes) {
 const hasClaims = !!options.customClaims?.trim();
 if (!hasAudience && !hasClients && !hasScopes && !hasClaims) {
 return {
 valid: false,
 error:
 'At least one of --allowed-audience, --allowed-clients, or --allowed-scopes must be provided for CUSTOM_JWT authorizer',
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer',
 };
 }
 }
Expand Down

18 changes: 15 additions & 3 deletions
src/cli/primitives/GatewayPrimitive.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type {
 AgentCoreGatewayTarget,
 AgentCoreMcpSpec,
 AgentCoreProjectSpec,
 CustomClaimValidation,
 GatewayAuthorizerType,
} from '../../schema';
import { AgentCoreGatewaySchema, PolicyEngineModeSchema } from '../../schema';
Expand All@@ -29,6 +30,7 @@ export interface AddGatewayOptions {
 allowedAudience?: string;
 allowedClients?: string;
 allowedScopes?: string;
 customClaims?: CustomClaimValidation[];
 clientId?: string;
 clientSecret?: string;
 agents?: string;
Expand DownExpand Up@@ -164,6 +166,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 .option('--allowed-audience <audience>', 'Comma-separated allowed audiences (for CUSTOM_JWT)')
 .option('--allowed-clients <clients>', 'Comma-separated allowed client IDs (for CUSTOM_JWT)')
 .option('--allowed-scopes <scopes>', 'Comma-separated allowed scopes (for CUSTOM_JWT)')
 .option('--custom-claims <json>', 'Custom claim validations as JSON array (for CUSTOM_JWT)')
 .option('--client-id <id>', 'OAuth client ID for gateway bearer token')
 .option('--client-secret <secret>', 'OAuth client secret')
 .option('--agents <agents>', 'Comma-separated agent names')
Expand All@@ -190,6 +193,11 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 process.exit(1);
 }

 // Parse custom claims JSON if provided (already validated)
 const parsedCustomClaims = cliOptions.customClaims
 ? (JSON.parse(cliOptions.customClaims) as CustomClaimValidation[])
 : undefined;

 const result = await this.add({
 name: cliOptions.name!,
 description: cliOptions.description,
Expand All@@ -198,6 +206,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 allowedAudience: cliOptions.allowedAudience,
 allowedClients: cliOptions.allowedClients,
 allowedScopes: cliOptions.allowedScopes,
 customClaims: parsedCustomClaims,
 clientId: cliOptions.clientId,
 clientSecret: cliOptions.clientSecret,
 agents: cliOptions.agents,
Expand DownExpand Up@@ -334,6 +343,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 ...(allowedAudience?.length ? { allowedAudience } : {}),
 ...(allowedClients?.length ? { allowedClients } : {}),
 ...(allowedScopes?.length ? { allowedScopes } : {}),
 ...(options.customClaims?.length ? { customClaims: options.customClaims } : {}),
 ...(options.clientId ? { clientId: options.clientId } : {}),
 ...(options.clientSecret ? { clientSecret: options.clientSecret } : {}),
 };
Expand DownExpand Up@@ -415,9 +425,10 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 });
 await this.writeProjectSpec(project);

 // Write client secret to .env
 const envVarName = computeDefaultCredentialEnvVarName(credentialName);
 await setEnvVar(envVarName, jwtConfig.clientSecret!);
 // Write client ID and client secret to .env
 const envVarPrefix = computeDefaultCredentialEnvVarName(credentialName);
 await setEnvVar(`${envVarPrefix}_CLIENT_ID`, jwtConfig.clientId!);
 await setEnvVar(`${envVarPrefix}_CLIENT_SECRET`, jwtConfig.clientSecret!);
 }

 /**
Expand All@@ -434,6 +445,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 ...(config.jwtConfig.allowedAudience?.length ? { allowedAudience: config.jwtConfig.allowedAudience } : {}),
 ...(config.jwtConfig.allowedClients?.length ? { allowedClients: config.jwtConfig.allowedClients } : {}),
 ...(config.jwtConfig.allowedScopes?.length ? { allowedScopes: config.jwtConfig.allowedScopes } : {}),
 ...(config.jwtConfig.customClaims?.length ? { customClaims: config.jwtConfig.customClaims } : {}),
 },
 };
 }
Expand Down

72 changes: 72 additions & 0 deletions
src/cli/primitives/__tests__/GatewayPrimitive.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,78 @@ describe('GatewayPrimitive', () => {
 primitive = new GatewayPrimitive();
 });

 describe('customClaims pipeline', () => {
 const SAMPLE_CLAIMS = [
 {
 inboundTokenClaimName: 'department',
 inboundTokenClaimValueType: 'STRING_ARRAY' as const,
 authorizingClaimMatchValue: {
 claimMatchOperator: 'CONTAINS_ANY' as const,
 claimMatchValue: { matchValueStringList: ['engineering', 'sales'] },
 },
 },
 ];

 it('custom claims from TUI flow are written to authorizerConfiguration', async () => {
 await primitive.add({
 name: 'jwt-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 allowedAudience: 'aud1',
 customClaims: SAMPLE_CLAIMS,
 });

 const gw = getWrittenGateway();
 expect(gw.authorizerConfiguration?.customJwtAuthorizer).toBeDefined();
 expect(gw.authorizerConfiguration!.customJwtAuthorizer!.customClaims).toEqual(SAMPLE_CLAIMS);
 });

 it('custom claims are preserved alongside audience and clients', async () => {
 await primitive.add({
 name: 'jwt-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 allowedAudience: 'aud1,aud2',
 allowedClients: 'client1',
 customClaims: SAMPLE_CLAIMS,
 });

 const gw = getWrittenGateway();
 const jwtConfig = gw.authorizerConfiguration!.customJwtAuthorizer!;
 expect(jwtConfig.allowedAudience).toEqual(['aud1', 'aud2']);
 expect(jwtConfig.allowedClients).toEqual(['client1']);
 expect(jwtConfig.customClaims).toEqual(SAMPLE_CLAIMS);
 });

 it('omits customClaims from authorizerConfiguration when not provided', async () => {
 await primitive.add({
 name: 'jwt-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 allowedAudience: 'aud1',
 });

 const gw = getWrittenGateway();
 expect(gw.authorizerConfiguration!.customJwtAuthorizer!.customClaims).toBeUndefined();
 });

 it('custom claims only (no audience/clients/scopes) produces valid config', async () => {
 await primitive.add({
 name: 'jwt-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 customClaims: SAMPLE_CLAIMS,
 });

 const gw = getWrittenGateway();
 const jwtConfig = gw.authorizerConfiguration!.customJwtAuthorizer!;
 expect(jwtConfig.allowedAudience).toBeUndefined();
 expect(jwtConfig.allowedClients).toBeUndefined();
 expect(jwtConfig.allowedScopes).toBeUndefined();
 expect(jwtConfig.customClaims).toEqual(SAMPLE_CLAIMS);
 });
 });

 describe('exceptionLevel', () => {
 it('defaults to exceptionLevel NONE', async () => {
 await primitive.add({ name: 'test-gw', authorizerType: 'NONE' });
Expand Down

1 change: 1 addition & 0 deletions
src/cli/tui/hooks/useCreateMcp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ export function useCreateGateway() {
 allowedAudience: config.jwtConfig?.allowedAudience?.join(','),
 allowedClients: config.jwtConfig?.allowedClients?.join(','),
 allowedScopes: config.jwtConfig?.allowedScopes?.join(','),
 customClaims: config.jwtConfig?.customClaims,
 clientId: config.jwtConfig?.clientId,
 clientSecret: config.jwtConfig?.clientSecret,
 enableSemanticSearch: config.enableSemanticSearch,
Expand Down
Loading
Loading

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

Skip to content
feat(gateway): add custom claims validation and TUI wizard for JWT auth#599

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tejaskash
merged 7 commits into

from

Mar 24, 2026
 Merged


feat(gateway): add custom claims validation and TUI wizard for JWT auth
#599
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
8005978

feat(gateway): add custom claims validation and TUI wizard for JWT auth


aidandaly24 Mar 23, 2026
0b14f04

fix(gateway): improve custom claim form navigation UX


aidandaly24 Mar 23, 2026
6e07292

fix(gateway): position cursor before placeholder in custom claim form


aidandaly24 Mar 23, 2026
47b5a3b

test(gateway): update claim form test for Enter-advances-fields behavior


aidandaly24 Mar 23, 2026
f956200

fix: restore CLIENT_ID env var and move inline import to top-level


aidandaly24 Mar 23, 2026
d27c124

style: run prettier and fix test prop


aidandaly24 Mar 23, 2026
1fb146d

ci: retrigger checks


aidandaly24 Mar 24, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


415 changes: 415 additions & 0 deletions
integ-tests/tui/add-gateway-jwt.test.ts

View file


Open in desktop


Large diffs are not rendered by default.


6 changes: 6 additions & 0 deletions
integ-tests/tui/setup.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
/**
 * TUI integration test setup.
 *
 * This file is referenced by vitest.config.ts as a setupFile for the 'tui' project.
 * It runs before each test file in integ-tests/tui/.
 */

126 changes: 91 additions & 35 deletions
src/cli/commands/add/__tests__/validate.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -218,40 +218,29 @@ describe('validate', () => {
 expect(result.error?.includes('Invalid authorizer type')).toBeTruthy();
 });

 // AC11: CUSTOM_JWT requires discoveryUrl
 it('returns error for CUSTOM_JWT missing discoveryUrl', () => {
const opts = { ...validGatewayOptionsJwt, discoveryUrl: undefined };
 const result = validateAddGatewayOptions(opts);
 // AC11: CUSTOM_JWT requires discoveryUrl; at least one of allowedAudience/allowedClients/allowedScopes
 it('returns error for CUSTOM_JWT missing required fields', () => {
// discoveryUrl is always required
 const result = validateAddGatewayOptions({ ...validGatewayOptionsJwt, discoveryUrl: undefined });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('--discovery-url is required for CUSTOM_JWT authorizer');
 });

 // AC11b: at least one of audience/clients/scopes required
 it('returns error when all of audience, clients, and scopes are missing', () => {
 const opts = {
 // All three optional fields absent fails
 const noneResult = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 allowedAudience: undefined,
 allowedClients: undefined,
 allowedScopes: undefined,
 };
 const result = validateAddGatewayOptions(opts);
 expect(result.valid).toBe(false);
 expect(result.error).toContain('At least one of');
 });

 it('allows CUSTOM_JWT with only allowedScopes', () => {
 const opts = {
 ...validGatewayOptionsJwt,
 allowedAudience: undefined,
 allowedClients: undefined,
 allowedScopes: 'scope1',
 };
 const result = validateAddGatewayOptions(opts);
 expect(result.valid).toBe(true);
 });
 expect(noneResult.valid).toBe(false);
 expect(noneResult.error).toBe(
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer'
 );
 });

 it('allows CUSTOM_JWT with only allowedAudience', () => {
 const opts = { ...validGatewayOptionsJwt, allowedClients: undefined, allowedScopes: undefined };
 // AC11b: allowedAudience is optional
 it('allows CUSTOM_JWT without allowedAudience', () => {
 const opts = { ...validGatewayOptionsJwt, allowedAudience: undefined };
 const result = validateAddGatewayOptions(opts);
 expect(result.valid).toBe(true);
 });
Expand All@@ -269,21 +258,88 @@ describe('validate', () => {
 expect(result.error?.includes('.well-known/openid-configuration')).toBeTruthy();
 });

 it('returns error for HTTP discoveryUrl (HTTPS required)', () => {
 // AC13: At least one of audience/clients/scopes must be non-empty
 it('returns error when all of audience, clients, and scopes are empty', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 discoveryUrl: 'http://example.com/.well-known/openid-configuration',
 allowedAudience: ' ',
 allowedClients: undefined,
 allowedScopes: undefined,
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('Discovery URL must use HTTPS');
 expect(result.error).toBe(
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer'
 );
 });

 it('allows CUSTOM_JWT with only allowedClients', () => {
 const opts = { ...validGatewayOptionsJwt, allowedAudience: undefined, allowedScopes: undefined };
 const result = validateAddGatewayOptions(opts);
 // AC-claims1: --custom-claims with valid JSON passes validation
 it('accepts valid --custom-claims JSON', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 customClaims: JSON.stringify([
 {
 inboundTokenClaimName: 'dept',
 inboundTokenClaimValueType: 'STRING',
 authorizingClaimMatchValue: {
 claimMatchOperator: 'EQUALS',
 claimMatchValue: { matchValueString: 'engineering' },
 },
 },
 ]),
 });
 expect(result.valid).toBe(true);
 });

 // AC-claims2: --custom-claims alone satisfies the "at least one constraint" check
 it('allows CUSTOM_JWT with only --custom-claims (no audience/clients/scopes)', () => {
 const result = validateAddGatewayOptions({
 name: 'test-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 customClaims: JSON.stringify([
 {
 inboundTokenClaimName: 'role',
 inboundTokenClaimValueType: 'STRING_ARRAY',
 authorizingClaimMatchValue: {
 claimMatchOperator: 'CONTAINS_ANY',
 claimMatchValue: { matchValueStringList: ['admin'] },
 },
 },
 ]),
 });
 expect(result.valid).toBe(true);
 });

 // AC-claims3: --custom-claims with invalid JSON fails
 it('returns error for --custom-claims with invalid JSON', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 customClaims: 'not json',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('--custom-claims must be valid JSON');
 });

 // AC-claims4: --custom-claims with empty array fails
 it('returns error for --custom-claims with empty array', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 customClaims: '[]',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('--custom-claims must be a non-empty JSON array');
 });

 // AC-claims5: --custom-claims with invalid claim structure fails
 it('returns error for --custom-claims with invalid claim structure', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 customClaims: JSON.stringify([{ badField: 'value' }]),
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('Invalid custom claim at index 0');
 });

 // AC14: Valid options pass
 it('passes for valid options', () => {
 expect(validateAddGatewayOptions(validGatewayOptionsNone)).toEqual({ valid: true });
Expand All@@ -309,8 +365,8 @@ describe('validate', () => {
 expect(result.error).toBe('Both --client-id and --client-secret must be provided together');
 });

 // AC16: OAuth credentials only valid with CUSTOM_JWT
 it('returns error when OAuth credentials used with non-CUSTOM_JWT authorizer', () => {
 // AC16: OAuth client credentials only valid with CUSTOM_JWT
 it('returns error when OAuth client credentials used with non-CUSTOM_JWT authorizer', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsNone,
 clientId: 'my-client-id',
Expand All@@ -320,8 +376,8 @@ describe('validate', () => {
 expect(result.error).toBe('OAuth client credentials are only valid with CUSTOM_JWT authorizer');
 });

 // AC17: valid CUSTOM_JWT with OAuth credentials passes
 it('passes for CUSTOM_JWT with OAuth credentials', () => {
 // AC17: valid CUSTOM_JWT with OAuth client credentials passes
 it('passes for CUSTOM_JWT with OAuth client credentials', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 clientId: 'my-client-id',
Expand Down

1 change: 1 addition & 0 deletions
src/cli/commands/add/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ export interface AddGatewayOptions {
 allowedAudience?: string;
 allowedClients?: string;
 allowedScopes?: string;
 customClaims?: string;
 clientId?: string;
 clientSecret?: string;
 agents?: string;
Expand Down

27 changes: 24 additions & 3 deletions
src/cli/commands/add/validate.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { ConfigIO, findConfigRoot } from '../../../lib';
import {
 AgentNameSchema,
 BuildTypeSchema,
 CustomClaimValidationSchema,
 GatewayExceptionLevelSchema,
 GatewayNameSchema,
 ModelProviderSchema,
Expand DownExpand Up@@ -275,16 +276,36 @@ export function validateAddGatewayOptions(options: AddGatewayOptions): Validatio
 return { valid: false, error: `Discovery URL must end with ${OIDC_WELL_KNOWN_SUFFIX}` };
 }

 // allowedAudience, allowedClients, allowedScopes are all optional individually,
 // Validate custom claims JSON if provided
 if (options.customClaims) {
 let parsed: unknown;
 try {
 parsed = JSON.parse(options.customClaims);
 } catch {
 return { valid: false, error: '--custom-claims must be valid JSON' };
 }
 if (!Array.isArray(parsed) || parsed.length === 0) {
 return { valid: false, error: '--custom-claims must be a non-empty JSON array' };
 }
 for (const [i, entry] of parsed.entries()) {
 const result = CustomClaimValidationSchema.safeParse(entry);
 if (!result.success) {
 return { valid: false, error: `Invalid custom claim at index ${i}: ${result.error.issues[0]?.message}` };
 }
 }
 }

 // allowedAudience, allowedClients, allowedScopes, customClaims are all optional individually,
 // but at least one must be provided
 const hasAudience = !!options.allowedAudience?.trim();
 const hasClients = !!options.allowedClients?.trim();
 const hasScopes = !!options.allowedScopes?.trim();
 if (!hasAudience && !hasClients && !hasScopes) {
 const hasClaims = !!options.customClaims?.trim();
 if (!hasAudience && !hasClients && !hasScopes && !hasClaims) {
 return {
 valid: false,
 error:
 'At least one of --allowed-audience, --allowed-clients, or --allowed-scopes must be provided for CUSTOM_JWT authorizer',
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer',
 };
 }
 }
Expand Down

18 changes: 15 additions & 3 deletions
src/cli/primitives/GatewayPrimitive.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type {
 AgentCoreGatewayTarget,
 AgentCoreMcpSpec,
 AgentCoreProjectSpec,
 CustomClaimValidation,
 GatewayAuthorizerType,
} from '../../schema';
import { AgentCoreGatewaySchema, PolicyEngineModeSchema } from '../../schema';
Expand All@@ -29,6 +30,7 @@ export interface AddGatewayOptions {
 allowedAudience?: string;
 allowedClients?: string;
 allowedScopes?: string;
 customClaims?: CustomClaimValidation[];
 clientId?: string;
 clientSecret?: string;
 agents?: string;
Expand DownExpand Up@@ -164,6 +166,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 .option('--allowed-audience <audience>', 'Comma-separated allowed audiences (for CUSTOM_JWT)')
 .option('--allowed-clients <clients>', 'Comma-separated allowed client IDs (for CUSTOM_JWT)')
 .option('--allowed-scopes <scopes>', 'Comma-separated allowed scopes (for CUSTOM_JWT)')
 .option('--custom-claims <json>', 'Custom claim validations as JSON array (for CUSTOM_JWT)')
 .option('--client-id <id>', 'OAuth client ID for gateway bearer token')
 .option('--client-secret <secret>', 'OAuth client secret')
 .option('--agents <agents>', 'Comma-separated agent names')
Expand All@@ -190,6 +193,11 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 process.exit(1);
 }

 // Parse custom claims JSON if provided (already validated)
 const parsedCustomClaims = cliOptions.customClaims
 ? (JSON.parse(cliOptions.customClaims) as CustomClaimValidation[])
 : undefined;

 const result = await this.add({
 name: cliOptions.name!,
 description: cliOptions.description,
Expand All@@ -198,6 +206,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 allowedAudience: cliOptions.allowedAudience,
 allowedClients: cliOptions.allowedClients,
 allowedScopes: cliOptions.allowedScopes,
 customClaims: parsedCustomClaims,
 clientId: cliOptions.clientId,
 clientSecret: cliOptions.clientSecret,
 agents: cliOptions.agents,
Expand DownExpand Up@@ -334,6 +343,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 ...(allowedAudience?.length ? { allowedAudience } : {}),
 ...(allowedClients?.length ? { allowedClients } : {}),
 ...(allowedScopes?.length ? { allowedScopes } : {}),
 ...(options.customClaims?.length ? { customClaims: options.customClaims } : {}),
 ...(options.clientId ? { clientId: options.clientId } : {}),
 ...(options.clientSecret ? { clientSecret: options.clientSecret } : {}),
 };
Expand DownExpand Up@@ -415,9 +425,10 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 });
 await this.writeProjectSpec(project);

 // Write client secret to .env
 const envVarName = computeDefaultCredentialEnvVarName(credentialName);
 await setEnvVar(envVarName, jwtConfig.clientSecret!);
 // Write client ID and client secret to .env
 const envVarPrefix = computeDefaultCredentialEnvVarName(credentialName);
 await setEnvVar(`${envVarPrefix}_CLIENT_ID`, jwtConfig.clientId!);
 await setEnvVar(`${envVarPrefix}_CLIENT_SECRET`, jwtConfig.clientSecret!);
 }

 /**
Expand All@@ -434,6 +445,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 ...(config.jwtConfig.allowedAudience?.length ? { allowedAudience: config.jwtConfig.allowedAudience } : {}),
 ...(config.jwtConfig.allowedClients?.length ? { allowedClients: config.jwtConfig.allowedClients } : {}),
 ...(config.jwtConfig.allowedScopes?.length ? { allowedScopes: config.jwtConfig.allowedScopes } : {}),
 ...(config.jwtConfig.customClaims?.length ? { customClaims: config.jwtConfig.customClaims } : {}),
 },
 };
 }
Expand Down

72 changes: 72 additions & 0 deletions
src/cli/primitives/__tests__/GatewayPrimitive.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,78 @@ describe('GatewayPrimitive', () => {
 primitive = new GatewayPrimitive();
 });

 describe('customClaims pipeline', () => {
 const SAMPLE_CLAIMS = [
 {
 inboundTokenClaimName: 'department',
 inboundTokenClaimValueType: 'STRING_ARRAY' as const,
 authorizingClaimMatchValue: {
 claimMatchOperator: 'CONTAINS_ANY' as const,
 claimMatchValue: { matchValueStringList: ['engineering', 'sales'] },
 },
 },
 ];

 it('custom claims from TUI flow are written to authorizerConfiguration', async () => {
 await primitive.add({
 name: 'jwt-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 allowedAudience: 'aud1',
 customClaims: SAMPLE_CLAIMS,
 });

 const gw = getWrittenGateway();
 expect(gw.authorizerConfiguration?.customJwtAuthorizer).toBeDefined();
 expect(gw.authorizerConfiguration!.customJwtAuthorizer!.customClaims).toEqual(SAMPLE_CLAIMS);
 });

 it('custom claims are preserved alongside audience and clients', async () => {
 await primitive.add({
 name: 'jwt-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 allowedAudience: 'aud1,aud2',
 allowedClients: 'client1',
 customClaims: SAMPLE_CLAIMS,
 });

 const gw = getWrittenGateway();
 const jwtConfig = gw.authorizerConfiguration!.customJwtAuthorizer!;
 expect(jwtConfig.allowedAudience).toEqual(['aud1', 'aud2']);
 expect(jwtConfig.allowedClients).toEqual(['client1']);
 expect(jwtConfig.customClaims).toEqual(SAMPLE_CLAIMS);
 });

 it('omits customClaims from authorizerConfiguration when not provided', async () => {
 await primitive.add({
 name: 'jwt-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 allowedAudience: 'aud1',
 });

 const gw = getWrittenGateway();
 expect(gw.authorizerConfiguration!.customJwtAuthorizer!.customClaims).toBeUndefined();
 });

 it('custom claims only (no audience/clients/scopes) produces valid config', async () => {
 await primitive.add({
 name: 'jwt-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 customClaims: SAMPLE_CLAIMS,
 });

 const gw = getWrittenGateway();
 const jwtConfig = gw.authorizerConfiguration!.customJwtAuthorizer!;
 expect(jwtConfig.allowedAudience).toBeUndefined();
 expect(jwtConfig.allowedClients).toBeUndefined();
 expect(jwtConfig.allowedScopes).toBeUndefined();
 expect(jwtConfig.customClaims).toEqual(SAMPLE_CLAIMS);
 });
 });

 describe('exceptionLevel', () => {
 it('defaults to exceptionLevel NONE', async () => {
 await primitive.add({ name: 'test-gw', authorizerType: 'NONE' });
Expand Down

1 change: 1 addition & 0 deletions
src/cli/tui/hooks/useCreateMcp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ export function useCreateGateway() {
 allowedAudience: config.jwtConfig?.allowedAudience?.join(','),
 allowedClients: config.jwtConfig?.allowedClients?.join(','),
 allowedScopes: config.jwtConfig?.allowedScopes?.join(','),
 customClaims: config.jwtConfig?.customClaims,
 clientId: config.jwtConfig?.clientId,
 clientSecret: config.jwtConfig?.clientSecret,
 enableSemanticSearch: config.enableSemanticSearch,
Expand Down
Loading
Loading

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

Skip to content
feat(gateway): add custom claims validation and TUI wizard for JWT auth#599

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tejaskash
merged 7 commits into

from

Mar 24, 2026
 Merged


feat(gateway): add custom claims validation and TUI wizard for JWT auth
#599
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
8005978

feat(gateway): add custom claims validation and TUI wizard for JWT auth


aidandaly24 Mar 23, 2026
0b14f04

fix(gateway): improve custom claim form navigation UX


aidandaly24 Mar 23, 2026
6e07292

fix(gateway): position cursor before placeholder in custom claim form


aidandaly24 Mar 23, 2026
47b5a3b

test(gateway): update claim form test for Enter-advances-fields behavior


aidandaly24 Mar 23, 2026
f956200

fix: restore CLIENT_ID env var and move inline import to top-level


aidandaly24 Mar 23, 2026
d27c124

style: run prettier and fix test prop


aidandaly24 Mar 23, 2026
1fb146d

ci: retrigger checks


aidandaly24 Mar 24, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


415 changes: 415 additions & 0 deletions
integ-tests/tui/add-gateway-jwt.test.ts

View file


Open in desktop


Large diffs are not rendered by default.


6 changes: 6 additions & 0 deletions
integ-tests/tui/setup.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
/**
 * TUI integration test setup.
 *
 * This file is referenced by vitest.config.ts as a setupFile for the 'tui' project.
 * It runs before each test file in integ-tests/tui/.
 */

126 changes: 91 additions & 35 deletions
src/cli/commands/add/__tests__/validate.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -218,40 +218,29 @@ describe('validate', () => {
 expect(result.error?.includes('Invalid authorizer type')).toBeTruthy();
 });

 // AC11: CUSTOM_JWT requires discoveryUrl
 it('returns error for CUSTOM_JWT missing discoveryUrl', () => {
const opts = { ...validGatewayOptionsJwt, discoveryUrl: undefined };
 const result = validateAddGatewayOptions(opts);
 // AC11: CUSTOM_JWT requires discoveryUrl; at least one of allowedAudience/allowedClients/allowedScopes
 it('returns error for CUSTOM_JWT missing required fields', () => {
// discoveryUrl is always required
 const result = validateAddGatewayOptions({ ...validGatewayOptionsJwt, discoveryUrl: undefined });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('--discovery-url is required for CUSTOM_JWT authorizer');
 });

 // AC11b: at least one of audience/clients/scopes required
 it('returns error when all of audience, clients, and scopes are missing', () => {
 const opts = {
 // All three optional fields absent fails
 const noneResult = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 allowedAudience: undefined,
 allowedClients: undefined,
 allowedScopes: undefined,
 };
 const result = validateAddGatewayOptions(opts);
 expect(result.valid).toBe(false);
 expect(result.error).toContain('At least one of');
 });

 it('allows CUSTOM_JWT with only allowedScopes', () => {
 const opts = {
 ...validGatewayOptionsJwt,
 allowedAudience: undefined,
 allowedClients: undefined,
 allowedScopes: 'scope1',
 };
 const result = validateAddGatewayOptions(opts);
 expect(result.valid).toBe(true);
 });
 expect(noneResult.valid).toBe(false);
 expect(noneResult.error).toBe(
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer'
 );
 });

 it('allows CUSTOM_JWT with only allowedAudience', () => {
 const opts = { ...validGatewayOptionsJwt, allowedClients: undefined, allowedScopes: undefined };
 // AC11b: allowedAudience is optional
 it('allows CUSTOM_JWT without allowedAudience', () => {
 const opts = { ...validGatewayOptionsJwt, allowedAudience: undefined };
 const result = validateAddGatewayOptions(opts);
 expect(result.valid).toBe(true);
 });
Expand All@@ -269,21 +258,88 @@ describe('validate', () => {
 expect(result.error?.includes('.well-known/openid-configuration')).toBeTruthy();
 });

 it('returns error for HTTP discoveryUrl (HTTPS required)', () => {
 // AC13: At least one of audience/clients/scopes must be non-empty
 it('returns error when all of audience, clients, and scopes are empty', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 discoveryUrl: 'http://example.com/.well-known/openid-configuration',
 allowedAudience: ' ',
 allowedClients: undefined,
 allowedScopes: undefined,
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('Discovery URL must use HTTPS');
 expect(result.error).toBe(
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer'
 );
 });

 it('allows CUSTOM_JWT with only allowedClients', () => {
 const opts = { ...validGatewayOptionsJwt, allowedAudience: undefined, allowedScopes: undefined };
 const result = validateAddGatewayOptions(opts);
 // AC-claims1: --custom-claims with valid JSON passes validation
 it('accepts valid --custom-claims JSON', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 customClaims: JSON.stringify([
 {
 inboundTokenClaimName: 'dept',
 inboundTokenClaimValueType: 'STRING',
 authorizingClaimMatchValue: {
 claimMatchOperator: 'EQUALS',
 claimMatchValue: { matchValueString: 'engineering' },
 },
 },
 ]),
 });
 expect(result.valid).toBe(true);
 });

 // AC-claims2: --custom-claims alone satisfies the "at least one constraint" check
 it('allows CUSTOM_JWT with only --custom-claims (no audience/clients/scopes)', () => {
 const result = validateAddGatewayOptions({
 name: 'test-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 customClaims: JSON.stringify([
 {
 inboundTokenClaimName: 'role',
 inboundTokenClaimValueType: 'STRING_ARRAY',
 authorizingClaimMatchValue: {
 claimMatchOperator: 'CONTAINS_ANY',
 claimMatchValue: { matchValueStringList: ['admin'] },
 },
 },
 ]),
 });
 expect(result.valid).toBe(true);
 });

 // AC-claims3: --custom-claims with invalid JSON fails
 it('returns error for --custom-claims with invalid JSON', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 customClaims: 'not json',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('--custom-claims must be valid JSON');
 });

 // AC-claims4: --custom-claims with empty array fails
 it('returns error for --custom-claims with empty array', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 customClaims: '[]',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('--custom-claims must be a non-empty JSON array');
 });

 // AC-claims5: --custom-claims with invalid claim structure fails
 it('returns error for --custom-claims with invalid claim structure', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 customClaims: JSON.stringify([{ badField: 'value' }]),
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('Invalid custom claim at index 0');
 });

 // AC14: Valid options pass
 it('passes for valid options', () => {
 expect(validateAddGatewayOptions(validGatewayOptionsNone)).toEqual({ valid: true });
Expand All@@ -309,8 +365,8 @@ describe('validate', () => {
 expect(result.error).toBe('Both --client-id and --client-secret must be provided together');
 });

 // AC16: OAuth credentials only valid with CUSTOM_JWT
 it('returns error when OAuth credentials used with non-CUSTOM_JWT authorizer', () => {
 // AC16: OAuth client credentials only valid with CUSTOM_JWT
 it('returns error when OAuth client credentials used with non-CUSTOM_JWT authorizer', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsNone,
 clientId: 'my-client-id',
Expand All@@ -320,8 +376,8 @@ describe('validate', () => {
 expect(result.error).toBe('OAuth client credentials are only valid with CUSTOM_JWT authorizer');
 });

 // AC17: valid CUSTOM_JWT with OAuth credentials passes
 it('passes for CUSTOM_JWT with OAuth credentials', () => {
 // AC17: valid CUSTOM_JWT with OAuth client credentials passes
 it('passes for CUSTOM_JWT with OAuth client credentials', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 clientId: 'my-client-id',
Expand Down

1 change: 1 addition & 0 deletions
src/cli/commands/add/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ export interface AddGatewayOptions {
 allowedAudience?: string;
 allowedClients?: string;
 allowedScopes?: string;
 customClaims?: string;
 clientId?: string;
 clientSecret?: string;
 agents?: string;
Expand Down

27 changes: 24 additions & 3 deletions
src/cli/commands/add/validate.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { ConfigIO, findConfigRoot } from '../../../lib';
import {
 AgentNameSchema,
 BuildTypeSchema,
 CustomClaimValidationSchema,
 GatewayExceptionLevelSchema,
 GatewayNameSchema,
 ModelProviderSchema,
Expand DownExpand Up@@ -275,16 +276,36 @@ export function validateAddGatewayOptions(options: AddGatewayOptions): Validatio
 return { valid: false, error: `Discovery URL must end with ${OIDC_WELL_KNOWN_SUFFIX}` };
 }

 // allowedAudience, allowedClients, allowedScopes are all optional individually,
 // Validate custom claims JSON if provided
 if (options.customClaims) {
 let parsed: unknown;
 try {
 parsed = JSON.parse(options.customClaims);
 } catch {
 return { valid: false, error: '--custom-claims must be valid JSON' };
 }
 if (!Array.isArray(parsed) || parsed.length === 0) {
 return { valid: false, error: '--custom-claims must be a non-empty JSON array' };
 }
 for (const [i, entry] of parsed.entries()) {
 const result = CustomClaimValidationSchema.safeParse(entry);
 if (!result.success) {
 return { valid: false, error: `Invalid custom claim at index ${i}: ${result.error.issues[0]?.message}` };
 }
 }
 }

 // allowedAudience, allowedClients, allowedScopes, customClaims are all optional individually,
 // but at least one must be provided
 const hasAudience = !!options.allowedAudience?.trim();
 const hasClients = !!options.allowedClients?.trim();
 const hasScopes = !!options.allowedScopes?.trim();
 if (!hasAudience && !hasClients && !hasScopes) {
 const hasClaims = !!options.customClaims?.trim();
 if (!hasAudience && !hasClients && !hasScopes && !hasClaims) {
 return {
 valid: false,
 error:
 'At least one of --allowed-audience, --allowed-clients, or --allowed-scopes must be provided for CUSTOM_JWT authorizer',
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer',
 };
 }
 }
Expand Down

18 changes: 15 additions & 3 deletions
src/cli/primitives/GatewayPrimitive.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type {
 AgentCoreGatewayTarget,
 AgentCoreMcpSpec,
 AgentCoreProjectSpec,
 CustomClaimValidation,
 GatewayAuthorizerType,
} from '../../schema';
import { AgentCoreGatewaySchema, PolicyEngineModeSchema } from '../../schema';
Expand All@@ -29,6 +30,7 @@ export interface AddGatewayOptions {
 allowedAudience?: string;
 allowedClients?: string;
 allowedScopes?: string;
 customClaims?: CustomClaimValidation[];
 clientId?: string;
 clientSecret?: string;
 agents?: string;
Expand DownExpand Up@@ -164,6 +166,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 .option('--allowed-audience <audience>', 'Comma-separated allowed audiences (for CUSTOM_JWT)')
 .option('--allowed-clients <clients>', 'Comma-separated allowed client IDs (for CUSTOM_JWT)')
 .option('--allowed-scopes <scopes>', 'Comma-separated allowed scopes (for CUSTOM_JWT)')
 .option('--custom-claims <json>', 'Custom claim validations as JSON array (for CUSTOM_JWT)')
 .option('--client-id <id>', 'OAuth client ID for gateway bearer token')
 .option('--client-secret <secret>', 'OAuth client secret')
 .option('--agents <agents>', 'Comma-separated agent names')
Expand All@@ -190,6 +193,11 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 process.exit(1);
 }

 // Parse custom claims JSON if provided (already validated)
 const parsedCustomClaims = cliOptions.customClaims
 ? (JSON.parse(cliOptions.customClaims) as CustomClaimValidation[])
 : undefined;

 const result = await this.add({
 name: cliOptions.name!,
 description: cliOptions.description,
Expand All@@ -198,6 +206,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 allowedAudience: cliOptions.allowedAudience,
 allowedClients: cliOptions.allowedClients,
 allowedScopes: cliOptions.allowedScopes,
 customClaims: parsedCustomClaims,
 clientId: cliOptions.clientId,
 clientSecret: cliOptions.clientSecret,
 agents: cliOptions.agents,
Expand DownExpand Up@@ -334,6 +343,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 ...(allowedAudience?.length ? { allowedAudience } : {}),
 ...(allowedClients?.length ? { allowedClients } : {}),
 ...(allowedScopes?.length ? { allowedScopes } : {}),
 ...(options.customClaims?.length ? { customClaims: options.customClaims } : {}),
 ...(options.clientId ? { clientId: options.clientId } : {}),
 ...(options.clientSecret ? { clientSecret: options.clientSecret } : {}),
 };
Expand DownExpand Up@@ -415,9 +425,10 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 });
 await this.writeProjectSpec(project);

 // Write client secret to .env
 const envVarName = computeDefaultCredentialEnvVarName(credentialName);
 await setEnvVar(envVarName, jwtConfig.clientSecret!);
 // Write client ID and client secret to .env
 const envVarPrefix = computeDefaultCredentialEnvVarName(credentialName);
 await setEnvVar(`${envVarPrefix}_CLIENT_ID`, jwtConfig.clientId!);
 await setEnvVar(`${envVarPrefix}_CLIENT_SECRET`, jwtConfig.clientSecret!);
 }

 /**
Expand All@@ -434,6 +445,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 ...(config.jwtConfig.allowedAudience?.length ? { allowedAudience: config.jwtConfig.allowedAudience } : {}),
 ...(config.jwtConfig.allowedClients?.length ? { allowedClients: config.jwtConfig.allowedClients } : {}),
 ...(config.jwtConfig.allowedScopes?.length ? { allowedScopes: config.jwtConfig.allowedScopes } : {}),
 ...(config.jwtConfig.customClaims?.length ? { customClaims: config.jwtConfig.customClaims } : {}),
 },
 };
 }
Expand Down

72 changes: 72 additions & 0 deletions
src/cli/primitives/__tests__/GatewayPrimitive.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,78 @@ describe('GatewayPrimitive', () => {
 primitive = new GatewayPrimitive();
 });

 describe('customClaims pipeline', () => {
 const SAMPLE_CLAIMS = [
 {
 inboundTokenClaimName: 'department',
 inboundTokenClaimValueType: 'STRING_ARRAY' as const,
 authorizingClaimMatchValue: {
 claimMatchOperator: 'CONTAINS_ANY' as const,
 claimMatchValue: { matchValueStringList: ['engineering', 'sales'] },
 },
 },
 ];

 it('custom claims from TUI flow are written to authorizerConfiguration', async () => {
 await primitive.add({
 name: 'jwt-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 allowedAudience: 'aud1',
 customClaims: SAMPLE_CLAIMS,
 });

 const gw = getWrittenGateway();
 expect(gw.authorizerConfiguration?.customJwtAuthorizer).toBeDefined();
 expect(gw.authorizerConfiguration!.customJwtAuthorizer!.customClaims).toEqual(SAMPLE_CLAIMS);
 });

 it('custom claims are preserved alongside audience and clients', async () => {
 await primitive.add({
 name: 'jwt-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 allowedAudience: 'aud1,aud2',
 allowedClients: 'client1',
 customClaims: SAMPLE_CLAIMS,
 });

 const gw = getWrittenGateway();
 const jwtConfig = gw.authorizerConfiguration!.customJwtAuthorizer!;
 expect(jwtConfig.allowedAudience).toEqual(['aud1', 'aud2']);
 expect(jwtConfig.allowedClients).toEqual(['client1']);
 expect(jwtConfig.customClaims).toEqual(SAMPLE_CLAIMS);
 });

 it('omits customClaims from authorizerConfiguration when not provided', async () => {
 await primitive.add({
 name: 'jwt-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 allowedAudience: 'aud1',
 });

 const gw = getWrittenGateway();
 expect(gw.authorizerConfiguration!.customJwtAuthorizer!.customClaims).toBeUndefined();
 });

 it('custom claims only (no audience/clients/scopes) produces valid config', async () => {
 await primitive.add({
 name: 'jwt-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 customClaims: SAMPLE_CLAIMS,
 });

 const gw = getWrittenGateway();
 const jwtConfig = gw.authorizerConfiguration!.customJwtAuthorizer!;
 expect(jwtConfig.allowedAudience).toBeUndefined();
 expect(jwtConfig.allowedClients).toBeUndefined();
 expect(jwtConfig.allowedScopes).toBeUndefined();
 expect(jwtConfig.customClaims).toEqual(SAMPLE_CLAIMS);
 });
 });

 describe('exceptionLevel', () => {
 it('defaults to exceptionLevel NONE', async () => {
 await primitive.add({ name: 'test-gw', authorizerType: 'NONE' });
Expand Down

1 change: 1 addition & 0 deletions
src/cli/tui/hooks/useCreateMcp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ export function useCreateGateway() {
 allowedAudience: config.jwtConfig?.allowedAudience?.join(','),
 allowedClients: config.jwtConfig?.allowedClients?.join(','),
 allowedScopes: config.jwtConfig?.allowedScopes?.join(','),
 customClaims: config.jwtConfig?.customClaims,
 clientId: config.jwtConfig?.clientId,
 clientSecret: config.jwtConfig?.clientSecret,
 enableSemanticSearch: config.enableSemanticSearch,
Expand Down
Loading
Loading

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

Skip to content
feat(gateway): add custom claims validation and TUI wizard for JWT auth#599

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tejaskash
merged 7 commits into

from

Mar 24, 2026
 Merged


feat(gateway): add custom claims validation and TUI wizard for JWT auth
#599
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
8005978

feat(gateway): add custom claims validation and TUI wizard for JWT auth


aidandaly24 Mar 23, 2026
0b14f04

fix(gateway): improve custom claim form navigation UX


aidandaly24 Mar 23, 2026
6e07292

fix(gateway): position cursor before placeholder in custom claim form


aidandaly24 Mar 23, 2026
47b5a3b

test(gateway): update claim form test for Enter-advances-fields behavior


aidandaly24 Mar 23, 2026
f956200

fix: restore CLIENT_ID env var and move inline import to top-level


aidandaly24 Mar 23, 2026
d27c124

style: run prettier and fix test prop


aidandaly24 Mar 23, 2026
1fb146d

ci: retrigger checks


aidandaly24 Mar 24, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


415 changes: 415 additions & 0 deletions
integ-tests/tui/add-gateway-jwt.test.ts

View file


Open in desktop


Large diffs are not rendered by default.


6 changes: 6 additions & 0 deletions
integ-tests/tui/setup.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
/**
 * TUI integration test setup.
 *
 * This file is referenced by vitest.config.ts as a setupFile for the 'tui' project.
 * It runs before each test file in integ-tests/tui/.
 */

126 changes: 91 additions & 35 deletions
src/cli/commands/add/__tests__/validate.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -218,40 +218,29 @@ describe('validate', () => {
 expect(result.error?.includes('Invalid authorizer type')).toBeTruthy();
 });

 // AC11: CUSTOM_JWT requires discoveryUrl
 it('returns error for CUSTOM_JWT missing discoveryUrl', () => {
const opts = { ...validGatewayOptionsJwt, discoveryUrl: undefined };
 const result = validateAddGatewayOptions(opts);
 // AC11: CUSTOM_JWT requires discoveryUrl; at least one of allowedAudience/allowedClients/allowedScopes
 it('returns error for CUSTOM_JWT missing required fields', () => {
// discoveryUrl is always required
 const result = validateAddGatewayOptions({ ...validGatewayOptionsJwt, discoveryUrl: undefined });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('--discovery-url is required for CUSTOM_JWT authorizer');
 });

 // AC11b: at least one of audience/clients/scopes required
 it('returns error when all of audience, clients, and scopes are missing', () => {
 const opts = {
 // All three optional fields absent fails
 const noneResult = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 allowedAudience: undefined,
 allowedClients: undefined,
 allowedScopes: undefined,
 };
 const result = validateAddGatewayOptions(opts);
 expect(result.valid).toBe(false);
 expect(result.error).toContain('At least one of');
 });

 it('allows CUSTOM_JWT with only allowedScopes', () => {
 const opts = {
 ...validGatewayOptionsJwt,
 allowedAudience: undefined,
 allowedClients: undefined,
 allowedScopes: 'scope1',
 };
 const result = validateAddGatewayOptions(opts);
 expect(result.valid).toBe(true);
 });
 expect(noneResult.valid).toBe(false);
 expect(noneResult.error).toBe(
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer'
 );
 });

 it('allows CUSTOM_JWT with only allowedAudience', () => {
 const opts = { ...validGatewayOptionsJwt, allowedClients: undefined, allowedScopes: undefined };
 // AC11b: allowedAudience is optional
 it('allows CUSTOM_JWT without allowedAudience', () => {
 const opts = { ...validGatewayOptionsJwt, allowedAudience: undefined };
 const result = validateAddGatewayOptions(opts);
 expect(result.valid).toBe(true);
 });
Expand All@@ -269,21 +258,88 @@ describe('validate', () => {
 expect(result.error?.includes('.well-known/openid-configuration')).toBeTruthy();
 });

 it('returns error for HTTP discoveryUrl (HTTPS required)', () => {
 // AC13: At least one of audience/clients/scopes must be non-empty
 it('returns error when all of audience, clients, and scopes are empty', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 discoveryUrl: 'http://example.com/.well-known/openid-configuration',
 allowedAudience: ' ',
 allowedClients: undefined,
 allowedScopes: undefined,
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('Discovery URL must use HTTPS');
 expect(result.error).toBe(
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer'
 );
 });

 it('allows CUSTOM_JWT with only allowedClients', () => {
 const opts = { ...validGatewayOptionsJwt, allowedAudience: undefined, allowedScopes: undefined };
 const result = validateAddGatewayOptions(opts);
 // AC-claims1: --custom-claims with valid JSON passes validation
 it('accepts valid --custom-claims JSON', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 customClaims: JSON.stringify([
 {
 inboundTokenClaimName: 'dept',
 inboundTokenClaimValueType: 'STRING',
 authorizingClaimMatchValue: {
 claimMatchOperator: 'EQUALS',
 claimMatchValue: { matchValueString: 'engineering' },
 },
 },
 ]),
 });
 expect(result.valid).toBe(true);
 });

 // AC-claims2: --custom-claims alone satisfies the "at least one constraint" check
 it('allows CUSTOM_JWT with only --custom-claims (no audience/clients/scopes)', () => {
 const result = validateAddGatewayOptions({
 name: 'test-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 customClaims: JSON.stringify([
 {
 inboundTokenClaimName: 'role',
 inboundTokenClaimValueType: 'STRING_ARRAY',
 authorizingClaimMatchValue: {
 claimMatchOperator: 'CONTAINS_ANY',
 claimMatchValue: { matchValueStringList: ['admin'] },
 },
 },
 ]),
 });
 expect(result.valid).toBe(true);
 });

 // AC-claims3: --custom-claims with invalid JSON fails
 it('returns error for --custom-claims with invalid JSON', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 customClaims: 'not json',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('--custom-claims must be valid JSON');
 });

 // AC-claims4: --custom-claims with empty array fails
 it('returns error for --custom-claims with empty array', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 customClaims: '[]',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('--custom-claims must be a non-empty JSON array');
 });

 // AC-claims5: --custom-claims with invalid claim structure fails
 it('returns error for --custom-claims with invalid claim structure', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 customClaims: JSON.stringify([{ badField: 'value' }]),
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('Invalid custom claim at index 0');
 });

 // AC14: Valid options pass
 it('passes for valid options', () => {
 expect(validateAddGatewayOptions(validGatewayOptionsNone)).toEqual({ valid: true });
Expand All@@ -309,8 +365,8 @@ describe('validate', () => {
 expect(result.error).toBe('Both --client-id and --client-secret must be provided together');
 });

 // AC16: OAuth credentials only valid with CUSTOM_JWT
 it('returns error when OAuth credentials used with non-CUSTOM_JWT authorizer', () => {
 // AC16: OAuth client credentials only valid with CUSTOM_JWT
 it('returns error when OAuth client credentials used with non-CUSTOM_JWT authorizer', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsNone,
 clientId: 'my-client-id',
Expand All@@ -320,8 +376,8 @@ describe('validate', () => {
 expect(result.error).toBe('OAuth client credentials are only valid with CUSTOM_JWT authorizer');
 });

 // AC17: valid CUSTOM_JWT with OAuth credentials passes
 it('passes for CUSTOM_JWT with OAuth credentials', () => {
 // AC17: valid CUSTOM_JWT with OAuth client credentials passes
 it('passes for CUSTOM_JWT with OAuth client credentials', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 clientId: 'my-client-id',
Expand Down

1 change: 1 addition & 0 deletions
src/cli/commands/add/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ export interface AddGatewayOptions {
 allowedAudience?: string;
 allowedClients?: string;
 allowedScopes?: string;
 customClaims?: string;
 clientId?: string;
 clientSecret?: string;
 agents?: string;
Expand Down

27 changes: 24 additions & 3 deletions
src/cli/commands/add/validate.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { ConfigIO, findConfigRoot } from '../../../lib';
import {
 AgentNameSchema,
 BuildTypeSchema,
 CustomClaimValidationSchema,
 GatewayExceptionLevelSchema,
 GatewayNameSchema,
 ModelProviderSchema,
Expand DownExpand Up@@ -275,16 +276,36 @@ export function validateAddGatewayOptions(options: AddGatewayOptions): Validatio
 return { valid: false, error: `Discovery URL must end with ${OIDC_WELL_KNOWN_SUFFIX}` };
 }

 // allowedAudience, allowedClients, allowedScopes are all optional individually,
 // Validate custom claims JSON if provided
 if (options.customClaims) {
 let parsed: unknown;
 try {
 parsed = JSON.parse(options.customClaims);
 } catch {
 return { valid: false, error: '--custom-claims must be valid JSON' };
 }
 if (!Array.isArray(parsed) || parsed.length === 0) {
 return { valid: false, error: '--custom-claims must be a non-empty JSON array' };
 }
 for (const [i, entry] of parsed.entries()) {
 const result = CustomClaimValidationSchema.safeParse(entry);
 if (!result.success) {
 return { valid: false, error: `Invalid custom claim at index ${i}: ${result.error.issues[0]?.message}` };
 }
 }
 }

 // allowedAudience, allowedClients, allowedScopes, customClaims are all optional individually,
 // but at least one must be provided
 const hasAudience = !!options.allowedAudience?.trim();
 const hasClients = !!options.allowedClients?.trim();
 const hasScopes = !!options.allowedScopes?.trim();
 if (!hasAudience && !hasClients && !hasScopes) {
 const hasClaims = !!options.customClaims?.trim();
 if (!hasAudience && !hasClients && !hasScopes && !hasClaims) {
 return {
 valid: false,
 error:
 'At least one of --allowed-audience, --allowed-clients, or --allowed-scopes must be provided for CUSTOM_JWT authorizer',
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer',
 };
 }
 }
Expand Down

18 changes: 15 additions & 3 deletions
src/cli/primitives/GatewayPrimitive.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type {
 AgentCoreGatewayTarget,
 AgentCoreMcpSpec,
 AgentCoreProjectSpec,
 CustomClaimValidation,
 GatewayAuthorizerType,
} from '../../schema';
import { AgentCoreGatewaySchema, PolicyEngineModeSchema } from '../../schema';
Expand All@@ -29,6 +30,7 @@ export interface AddGatewayOptions {
 allowedAudience?: string;
 allowedClients?: string;
 allowedScopes?: string;
 customClaims?: CustomClaimValidation[];
 clientId?: string;
 clientSecret?: string;
 agents?: string;
Expand DownExpand Up@@ -164,6 +166,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 .option('--allowed-audience <audience>', 'Comma-separated allowed audiences (for CUSTOM_JWT)')
 .option('--allowed-clients <clients>', 'Comma-separated allowed client IDs (for CUSTOM_JWT)')
 .option('--allowed-scopes <scopes>', 'Comma-separated allowed scopes (for CUSTOM_JWT)')
 .option('--custom-claims <json>', 'Custom claim validations as JSON array (for CUSTOM_JWT)')
 .option('--client-id <id>', 'OAuth client ID for gateway bearer token')
 .option('--client-secret <secret>', 'OAuth client secret')
 .option('--agents <agents>', 'Comma-separated agent names')
Expand All@@ -190,6 +193,11 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 process.exit(1);
 }

 // Parse custom claims JSON if provided (already validated)
 const parsedCustomClaims = cliOptions.customClaims
 ? (JSON.parse(cliOptions.customClaims) as CustomClaimValidation[])
 : undefined;

 const result = await this.add({
 name: cliOptions.name!,
 description: cliOptions.description,
Expand All@@ -198,6 +206,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 allowedAudience: cliOptions.allowedAudience,
 allowedClients: cliOptions.allowedClients,
 allowedScopes: cliOptions.allowedScopes,
 customClaims: parsedCustomClaims,
 clientId: cliOptions.clientId,
 clientSecret: cliOptions.clientSecret,
 agents: cliOptions.agents,
Expand DownExpand Up@@ -334,6 +343,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 ...(allowedAudience?.length ? { allowedAudience } : {}),
 ...(allowedClients?.length ? { allowedClients } : {}),
 ...(allowedScopes?.length ? { allowedScopes } : {}),
 ...(options.customClaims?.length ? { customClaims: options.customClaims } : {}),
 ...(options.clientId ? { clientId: options.clientId } : {}),
 ...(options.clientSecret ? { clientSecret: options.clientSecret } : {}),
 };
Expand DownExpand Up@@ -415,9 +425,10 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 });
 await this.writeProjectSpec(project);

 // Write client secret to .env
 const envVarName = computeDefaultCredentialEnvVarName(credentialName);
 await setEnvVar(envVarName, jwtConfig.clientSecret!);
 // Write client ID and client secret to .env
 const envVarPrefix = computeDefaultCredentialEnvVarName(credentialName);
 await setEnvVar(`${envVarPrefix}_CLIENT_ID`, jwtConfig.clientId!);
 await setEnvVar(`${envVarPrefix}_CLIENT_SECRET`, jwtConfig.clientSecret!);
 }

 /**
Expand All@@ -434,6 +445,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 ...(config.jwtConfig.allowedAudience?.length ? { allowedAudience: config.jwtConfig.allowedAudience } : {}),
 ...(config.jwtConfig.allowedClients?.length ? { allowedClients: config.jwtConfig.allowedClients } : {}),
 ...(config.jwtConfig.allowedScopes?.length ? { allowedScopes: config.jwtConfig.allowedScopes } : {}),
 ...(config.jwtConfig.customClaims?.length ? { customClaims: config.jwtConfig.customClaims } : {}),
 },
 };
 }
Expand Down

72 changes: 72 additions & 0 deletions
src/cli/primitives/__tests__/GatewayPrimitive.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,78 @@ describe('GatewayPrimitive', () => {
 primitive = new GatewayPrimitive();
 });

 describe('customClaims pipeline', () => {
 const SAMPLE_CLAIMS = [
 {
 inboundTokenClaimName: 'department',
 inboundTokenClaimValueType: 'STRING_ARRAY' as const,
 authorizingClaimMatchValue: {
 claimMatchOperator: 'CONTAINS_ANY' as const,
 claimMatchValue: { matchValueStringList: ['engineering', 'sales'] },
 },
 },
 ];

 it('custom claims from TUI flow are written to authorizerConfiguration', async () => {
 await primitive.add({
 name: 'jwt-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 allowedAudience: 'aud1',
 customClaims: SAMPLE_CLAIMS,
 });

 const gw = getWrittenGateway();
 expect(gw.authorizerConfiguration?.customJwtAuthorizer).toBeDefined();
 expect(gw.authorizerConfiguration!.customJwtAuthorizer!.customClaims).toEqual(SAMPLE_CLAIMS);
 });

 it('custom claims are preserved alongside audience and clients', async () => {
 await primitive.add({
 name: 'jwt-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 allowedAudience: 'aud1,aud2',
 allowedClients: 'client1',
 customClaims: SAMPLE_CLAIMS,
 });

 const gw = getWrittenGateway();
 const jwtConfig = gw.authorizerConfiguration!.customJwtAuthorizer!;
 expect(jwtConfig.allowedAudience).toEqual(['aud1', 'aud2']);
 expect(jwtConfig.allowedClients).toEqual(['client1']);
 expect(jwtConfig.customClaims).toEqual(SAMPLE_CLAIMS);
 });

 it('omits customClaims from authorizerConfiguration when not provided', async () => {
 await primitive.add({
 name: 'jwt-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 allowedAudience: 'aud1',
 });

 const gw = getWrittenGateway();
 expect(gw.authorizerConfiguration!.customJwtAuthorizer!.customClaims).toBeUndefined();
 });

 it('custom claims only (no audience/clients/scopes) produces valid config', async () => {
 await primitive.add({
 name: 'jwt-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 customClaims: SAMPLE_CLAIMS,
 });

 const gw = getWrittenGateway();
 const jwtConfig = gw.authorizerConfiguration!.customJwtAuthorizer!;
 expect(jwtConfig.allowedAudience).toBeUndefined();
 expect(jwtConfig.allowedClients).toBeUndefined();
 expect(jwtConfig.allowedScopes).toBeUndefined();
 expect(jwtConfig.customClaims).toEqual(SAMPLE_CLAIMS);
 });
 });

 describe('exceptionLevel', () => {
 it('defaults to exceptionLevel NONE', async () => {
 await primitive.add({ name: 'test-gw', authorizerType: 'NONE' });
Expand Down

1 change: 1 addition & 0 deletions
src/cli/tui/hooks/useCreateMcp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ export function useCreateGateway() {
 allowedAudience: config.jwtConfig?.allowedAudience?.join(','),
 allowedClients: config.jwtConfig?.allowedClients?.join(','),
 allowedScopes: config.jwtConfig?.allowedScopes?.join(','),
 customClaims: config.jwtConfig?.customClaims,
 clientId: config.jwtConfig?.clientId,
 clientSecret: config.jwtConfig?.clientSecret,
 enableSemanticSearch: config.enableSemanticSearch,
Expand Down
Loading
Loading

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

Skip to content
feat(gateway): add custom claims validation and TUI wizard for JWT auth#599

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tejaskash
merged 7 commits into

from

Mar 24, 2026
 Merged


feat(gateway): add custom claims validation and TUI wizard for JWT auth
#599
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
8005978

feat(gateway): add custom claims validation and TUI wizard for JWT auth


aidandaly24 Mar 23, 2026
0b14f04

fix(gateway): improve custom claim form navigation UX


aidandaly24 Mar 23, 2026
6e07292

fix(gateway): position cursor before placeholder in custom claim form


aidandaly24 Mar 23, 2026
47b5a3b

test(gateway): update claim form test for Enter-advances-fields behavior


aidandaly24 Mar 23, 2026
f956200

fix: restore CLIENT_ID env var and move inline import to top-level


aidandaly24 Mar 23, 2026
d27c124

style: run prettier and fix test prop


aidandaly24 Mar 23, 2026
1fb146d

ci: retrigger checks


aidandaly24 Mar 24, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


415 changes: 415 additions & 0 deletions
integ-tests/tui/add-gateway-jwt.test.ts

View file


Open in desktop


Large diffs are not rendered by default.


6 changes: 6 additions & 0 deletions
integ-tests/tui/setup.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
/**
 * TUI integration test setup.
 *
 * This file is referenced by vitest.config.ts as a setupFile for the 'tui' project.
 * It runs before each test file in integ-tests/tui/.
 */

126 changes: 91 additions & 35 deletions
src/cli/commands/add/__tests__/validate.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -218,40 +218,29 @@ describe('validate', () => {
 expect(result.error?.includes('Invalid authorizer type')).toBeTruthy();
 });

 // AC11: CUSTOM_JWT requires discoveryUrl
 it('returns error for CUSTOM_JWT missing discoveryUrl', () => {
const opts = { ...validGatewayOptionsJwt, discoveryUrl: undefined };
 const result = validateAddGatewayOptions(opts);
 // AC11: CUSTOM_JWT requires discoveryUrl; at least one of allowedAudience/allowedClients/allowedScopes
 it('returns error for CUSTOM_JWT missing required fields', () => {
// discoveryUrl is always required
 const result = validateAddGatewayOptions({ ...validGatewayOptionsJwt, discoveryUrl: undefined });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('--discovery-url is required for CUSTOM_JWT authorizer');
 });

 // AC11b: at least one of audience/clients/scopes required
 it('returns error when all of audience, clients, and scopes are missing', () => {
 const opts = {
 // All three optional fields absent fails
 const noneResult = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 allowedAudience: undefined,
 allowedClients: undefined,
 allowedScopes: undefined,
 };
 const result = validateAddGatewayOptions(opts);
 expect(result.valid).toBe(false);
 expect(result.error).toContain('At least one of');
 });

 it('allows CUSTOM_JWT with only allowedScopes', () => {
 const opts = {
 ...validGatewayOptionsJwt,
 allowedAudience: undefined,
 allowedClients: undefined,
 allowedScopes: 'scope1',
 };
 const result = validateAddGatewayOptions(opts);
 expect(result.valid).toBe(true);
 });
 expect(noneResult.valid).toBe(false);
 expect(noneResult.error).toBe(
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer'
 );
 });

 it('allows CUSTOM_JWT with only allowedAudience', () => {
 const opts = { ...validGatewayOptionsJwt, allowedClients: undefined, allowedScopes: undefined };
 // AC11b: allowedAudience is optional
 it('allows CUSTOM_JWT without allowedAudience', () => {
 const opts = { ...validGatewayOptionsJwt, allowedAudience: undefined };
 const result = validateAddGatewayOptions(opts);
 expect(result.valid).toBe(true);
 });
Expand All@@ -269,21 +258,88 @@ describe('validate', () => {
 expect(result.error?.includes('.well-known/openid-configuration')).toBeTruthy();
 });

 it('returns error for HTTP discoveryUrl (HTTPS required)', () => {
 // AC13: At least one of audience/clients/scopes must be non-empty
 it('returns error when all of audience, clients, and scopes are empty', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 discoveryUrl: 'http://example.com/.well-known/openid-configuration',
 allowedAudience: ' ',
 allowedClients: undefined,
 allowedScopes: undefined,
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('Discovery URL must use HTTPS');
 expect(result.error).toBe(
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer'
 );
 });

 it('allows CUSTOM_JWT with only allowedClients', () => {
 const opts = { ...validGatewayOptionsJwt, allowedAudience: undefined, allowedScopes: undefined };
 const result = validateAddGatewayOptions(opts);
 // AC-claims1: --custom-claims with valid JSON passes validation
 it('accepts valid --custom-claims JSON', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 customClaims: JSON.stringify([
 {
 inboundTokenClaimName: 'dept',
 inboundTokenClaimValueType: 'STRING',
 authorizingClaimMatchValue: {
 claimMatchOperator: 'EQUALS',
 claimMatchValue: { matchValueString: 'engineering' },
 },
 },
 ]),
 });
 expect(result.valid).toBe(true);
 });

 // AC-claims2: --custom-claims alone satisfies the "at least one constraint" check
 it('allows CUSTOM_JWT with only --custom-claims (no audience/clients/scopes)', () => {
 const result = validateAddGatewayOptions({
 name: 'test-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 customClaims: JSON.stringify([
 {
 inboundTokenClaimName: 'role',
 inboundTokenClaimValueType: 'STRING_ARRAY',
 authorizingClaimMatchValue: {
 claimMatchOperator: 'CONTAINS_ANY',
 claimMatchValue: { matchValueStringList: ['admin'] },
 },
 },
 ]),
 });
 expect(result.valid).toBe(true);
 });

 // AC-claims3: --custom-claims with invalid JSON fails
 it('returns error for --custom-claims with invalid JSON', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 customClaims: 'not json',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('--custom-claims must be valid JSON');
 });

 // AC-claims4: --custom-claims with empty array fails
 it('returns error for --custom-claims with empty array', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 customClaims: '[]',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('--custom-claims must be a non-empty JSON array');
 });

 // AC-claims5: --custom-claims with invalid claim structure fails
 it('returns error for --custom-claims with invalid claim structure', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 customClaims: JSON.stringify([{ badField: 'value' }]),
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('Invalid custom claim at index 0');
 });

 // AC14: Valid options pass
 it('passes for valid options', () => {
 expect(validateAddGatewayOptions(validGatewayOptionsNone)).toEqual({ valid: true });
Expand All@@ -309,8 +365,8 @@ describe('validate', () => {
 expect(result.error).toBe('Both --client-id and --client-secret must be provided together');
 });

 // AC16: OAuth credentials only valid with CUSTOM_JWT
 it('returns error when OAuth credentials used with non-CUSTOM_JWT authorizer', () => {
 // AC16: OAuth client credentials only valid with CUSTOM_JWT
 it('returns error when OAuth client credentials used with non-CUSTOM_JWT authorizer', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsNone,
 clientId: 'my-client-id',
Expand All@@ -320,8 +376,8 @@ describe('validate', () => {
 expect(result.error).toBe('OAuth client credentials are only valid with CUSTOM_JWT authorizer');
 });

 // AC17: valid CUSTOM_JWT with OAuth credentials passes
 it('passes for CUSTOM_JWT with OAuth credentials', () => {
 // AC17: valid CUSTOM_JWT with OAuth client credentials passes
 it('passes for CUSTOM_JWT with OAuth client credentials', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 clientId: 'my-client-id',
Expand Down

1 change: 1 addition & 0 deletions
src/cli/commands/add/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ export interface AddGatewayOptions {
 allowedAudience?: string;
 allowedClients?: string;
 allowedScopes?: string;
 customClaims?: string;
 clientId?: string;
 clientSecret?: string;
 agents?: string;
Expand Down

27 changes: 24 additions & 3 deletions
src/cli/commands/add/validate.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { ConfigIO, findConfigRoot } from '../../../lib';
import {
 AgentNameSchema,
 BuildTypeSchema,
 CustomClaimValidationSchema,
 GatewayExceptionLevelSchema,
 GatewayNameSchema,
 ModelProviderSchema,
Expand DownExpand Up@@ -275,16 +276,36 @@ export function validateAddGatewayOptions(options: AddGatewayOptions): Validatio
 return { valid: false, error: `Discovery URL must end with ${OIDC_WELL_KNOWN_SUFFIX}` };
 }

 // allowedAudience, allowedClients, allowedScopes are all optional individually,
 // Validate custom claims JSON if provided
 if (options.customClaims) {
 let parsed: unknown;
 try {
 parsed = JSON.parse(options.customClaims);
 } catch {
 return { valid: false, error: '--custom-claims must be valid JSON' };
 }
 if (!Array.isArray(parsed) || parsed.length === 0) {
 return { valid: false, error: '--custom-claims must be a non-empty JSON array' };
 }
 for (const [i, entry] of parsed.entries()) {
 const result = CustomClaimValidationSchema.safeParse(entry);
 if (!result.success) {
 return { valid: false, error: `Invalid custom claim at index ${i}: ${result.error.issues[0]?.message}` };
 }
 }
 }

 // allowedAudience, allowedClients, allowedScopes, customClaims are all optional individually,
 // but at least one must be provided
 const hasAudience = !!options.allowedAudience?.trim();
 const hasClients = !!options.allowedClients?.trim();
 const hasScopes = !!options.allowedScopes?.trim();
 if (!hasAudience && !hasClients && !hasScopes) {
 const hasClaims = !!options.customClaims?.trim();
 if (!hasAudience && !hasClients && !hasScopes && !hasClaims) {
 return {
 valid: false,
 error:
 'At least one of --allowed-audience, --allowed-clients, or --allowed-scopes must be provided for CUSTOM_JWT authorizer',
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer',
 };
 }
 }
Expand Down

18 changes: 15 additions & 3 deletions
src/cli/primitives/GatewayPrimitive.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type {
 AgentCoreGatewayTarget,
 AgentCoreMcpSpec,
 AgentCoreProjectSpec,
 CustomClaimValidation,
 GatewayAuthorizerType,
} from '../../schema';
import { AgentCoreGatewaySchema, PolicyEngineModeSchema } from '../../schema';
Expand All@@ -29,6 +30,7 @@ export interface AddGatewayOptions {
 allowedAudience?: string;
 allowedClients?: string;
 allowedScopes?: string;
 customClaims?: CustomClaimValidation[];
 clientId?: string;
 clientSecret?: string;
 agents?: string;
Expand DownExpand Up@@ -164,6 +166,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 .option('--allowed-audience <audience>', 'Comma-separated allowed audiences (for CUSTOM_JWT)')
 .option('--allowed-clients <clients>', 'Comma-separated allowed client IDs (for CUSTOM_JWT)')
 .option('--allowed-scopes <scopes>', 'Comma-separated allowed scopes (for CUSTOM_JWT)')
 .option('--custom-claims <json>', 'Custom claim validations as JSON array (for CUSTOM_JWT)')
 .option('--client-id <id>', 'OAuth client ID for gateway bearer token')
 .option('--client-secret <secret>', 'OAuth client secret')
 .option('--agents <agents>', 'Comma-separated agent names')
Expand All@@ -190,6 +193,11 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 process.exit(1);
 }

 // Parse custom claims JSON if provided (already validated)
 const parsedCustomClaims = cliOptions.customClaims
 ? (JSON.parse(cliOptions.customClaims) as CustomClaimValidation[])
 : undefined;

 const result = await this.add({
 name: cliOptions.name!,
 description: cliOptions.description,
Expand All@@ -198,6 +206,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 allowedAudience: cliOptions.allowedAudience,
 allowedClients: cliOptions.allowedClients,
 allowedScopes: cliOptions.allowedScopes,
 customClaims: parsedCustomClaims,
 clientId: cliOptions.clientId,
 clientSecret: cliOptions.clientSecret,
 agents: cliOptions.agents,
Expand DownExpand Up@@ -334,6 +343,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 ...(allowedAudience?.length ? { allowedAudience } : {}),
 ...(allowedClients?.length ? { allowedClients } : {}),
 ...(allowedScopes?.length ? { allowedScopes } : {}),
 ...(options.customClaims?.length ? { customClaims: options.customClaims } : {}),
 ...(options.clientId ? { clientId: options.clientId } : {}),
 ...(options.clientSecret ? { clientSecret: options.clientSecret } : {}),
 };
Expand DownExpand Up@@ -415,9 +425,10 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 });
 await this.writeProjectSpec(project);

 // Write client secret to .env
 const envVarName = computeDefaultCredentialEnvVarName(credentialName);
 await setEnvVar(envVarName, jwtConfig.clientSecret!);
 // Write client ID and client secret to .env
 const envVarPrefix = computeDefaultCredentialEnvVarName(credentialName);
 await setEnvVar(`${envVarPrefix}_CLIENT_ID`, jwtConfig.clientId!);
 await setEnvVar(`${envVarPrefix}_CLIENT_SECRET`, jwtConfig.clientSecret!);
 }

 /**
Expand All@@ -434,6 +445,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 ...(config.jwtConfig.allowedAudience?.length ? { allowedAudience: config.jwtConfig.allowedAudience } : {}),
 ...(config.jwtConfig.allowedClients?.length ? { allowedClients: config.jwtConfig.allowedClients } : {}),
 ...(config.jwtConfig.allowedScopes?.length ? { allowedScopes: config.jwtConfig.allowedScopes } : {}),
 ...(config.jwtConfig.customClaims?.length ? { customClaims: config.jwtConfig.customClaims } : {}),
 },
 };
 }
Expand Down

72 changes: 72 additions & 0 deletions
src/cli/primitives/__tests__/GatewayPrimitive.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,78 @@ describe('GatewayPrimitive', () => {
 primitive = new GatewayPrimitive();
 });

 describe('customClaims pipeline', () => {
 const SAMPLE_CLAIMS = [
 {
 inboundTokenClaimName: 'department',
 inboundTokenClaimValueType: 'STRING_ARRAY' as const,
 authorizingClaimMatchValue: {
 claimMatchOperator: 'CONTAINS_ANY' as const,
 claimMatchValue: { matchValueStringList: ['engineering', 'sales'] },
 },
 },
 ];

 it('custom claims from TUI flow are written to authorizerConfiguration', async () => {
 await primitive.add({
 name: 'jwt-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 allowedAudience: 'aud1',
 customClaims: SAMPLE_CLAIMS,
 });

 const gw = getWrittenGateway();
 expect(gw.authorizerConfiguration?.customJwtAuthorizer).toBeDefined();
 expect(gw.authorizerConfiguration!.customJwtAuthorizer!.customClaims).toEqual(SAMPLE_CLAIMS);
 });

 it('custom claims are preserved alongside audience and clients', async () => {
 await primitive.add({
 name: 'jwt-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 allowedAudience: 'aud1,aud2',
 allowedClients: 'client1',
 customClaims: SAMPLE_CLAIMS,
 });

 const gw = getWrittenGateway();
 const jwtConfig = gw.authorizerConfiguration!.customJwtAuthorizer!;
 expect(jwtConfig.allowedAudience).toEqual(['aud1', 'aud2']);
 expect(jwtConfig.allowedClients).toEqual(['client1']);
 expect(jwtConfig.customClaims).toEqual(SAMPLE_CLAIMS);
 });

 it('omits customClaims from authorizerConfiguration when not provided', async () => {
 await primitive.add({
 name: 'jwt-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 allowedAudience: 'aud1',
 });

 const gw = getWrittenGateway();
 expect(gw.authorizerConfiguration!.customJwtAuthorizer!.customClaims).toBeUndefined();
 });

 it('custom claims only (no audience/clients/scopes) produces valid config', async () => {
 await primitive.add({
 name: 'jwt-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 customClaims: SAMPLE_CLAIMS,
 });

 const gw = getWrittenGateway();
 const jwtConfig = gw.authorizerConfiguration!.customJwtAuthorizer!;
 expect(jwtConfig.allowedAudience).toBeUndefined();
 expect(jwtConfig.allowedClients).toBeUndefined();
 expect(jwtConfig.allowedScopes).toBeUndefined();
 expect(jwtConfig.customClaims).toEqual(SAMPLE_CLAIMS);
 });
 });

 describe('exceptionLevel', () => {
 it('defaults to exceptionLevel NONE', async () => {
 await primitive.add({ name: 'test-gw', authorizerType: 'NONE' });
Expand Down

1 change: 1 addition & 0 deletions
src/cli/tui/hooks/useCreateMcp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ export function useCreateGateway() {
 allowedAudience: config.jwtConfig?.allowedAudience?.join(','),
 allowedClients: config.jwtConfig?.allowedClients?.join(','),
 allowedScopes: config.jwtConfig?.allowedScopes?.join(','),
 customClaims: config.jwtConfig?.customClaims,
 clientId: config.jwtConfig?.clientId,
 clientSecret: config.jwtConfig?.clientSecret,
 enableSemanticSearch: config.enableSemanticSearch,
Expand Down
Loading
Loading

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

Skip to content
feat(gateway): add custom claims validation and TUI wizard for JWT auth#599

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Merged

tejaskash
merged 7 commits into

from

Mar 24, 2026
 Merged


feat(gateway): add custom claims validation and TUI wizard for JWT auth
#599
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
8005978

feat(gateway): add custom claims validation and TUI wizard for JWT auth


aidandaly24 Mar 23, 2026
0b14f04

fix(gateway): improve custom claim form navigation UX


aidandaly24 Mar 23, 2026
6e07292

fix(gateway): position cursor before placeholder in custom claim form


aidandaly24 Mar 23, 2026
47b5a3b

test(gateway): update claim form test for Enter-advances-fields behavior


aidandaly24 Mar 23, 2026
f956200

fix: restore CLIENT_ID env var and move inline import to top-level


aidandaly24 Mar 23, 2026
d27c124

style: run prettier and fix test prop


aidandaly24 Mar 23, 2026
1fb146d

ci: retrigger checks


aidandaly24 Mar 24, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


415 changes: 415 additions & 0 deletions
integ-tests/tui/add-gateway-jwt.test.ts

View file


Open in desktop


Large diffs are not rendered by default.


6 changes: 6 additions & 0 deletions
integ-tests/tui/setup.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
/**
 * TUI integration test setup.
 *
 * This file is referenced by vitest.config.ts as a setupFile for the 'tui' project.
 * It runs before each test file in integ-tests/tui/.
 */

126 changes: 91 additions & 35 deletions
src/cli/commands/add/__tests__/validate.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -218,40 +218,29 @@ describe('validate', () => {
 expect(result.error?.includes('Invalid authorizer type')).toBeTruthy();
 });

 // AC11: CUSTOM_JWT requires discoveryUrl
 it('returns error for CUSTOM_JWT missing discoveryUrl', () => {
const opts = { ...validGatewayOptionsJwt, discoveryUrl: undefined };
 const result = validateAddGatewayOptions(opts);
 // AC11: CUSTOM_JWT requires discoveryUrl; at least one of allowedAudience/allowedClients/allowedScopes
 it('returns error for CUSTOM_JWT missing required fields', () => {
// discoveryUrl is always required
 const result = validateAddGatewayOptions({ ...validGatewayOptionsJwt, discoveryUrl: undefined });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('--discovery-url is required for CUSTOM_JWT authorizer');
 });

 // AC11b: at least one of audience/clients/scopes required
 it('returns error when all of audience, clients, and scopes are missing', () => {
 const opts = {
 // All three optional fields absent fails
 const noneResult = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 allowedAudience: undefined,
 allowedClients: undefined,
 allowedScopes: undefined,
 };
 const result = validateAddGatewayOptions(opts);
 expect(result.valid).toBe(false);
 expect(result.error).toContain('At least one of');
 });

 it('allows CUSTOM_JWT with only allowedScopes', () => {
 const opts = {
 ...validGatewayOptionsJwt,
 allowedAudience: undefined,
 allowedClients: undefined,
 allowedScopes: 'scope1',
 };
 const result = validateAddGatewayOptions(opts);
 expect(result.valid).toBe(true);
 });
 expect(noneResult.valid).toBe(false);
 expect(noneResult.error).toBe(
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer'
 );
 });

 it('allows CUSTOM_JWT with only allowedAudience', () => {
 const opts = { ...validGatewayOptionsJwt, allowedClients: undefined, allowedScopes: undefined };
 // AC11b: allowedAudience is optional
 it('allows CUSTOM_JWT without allowedAudience', () => {
 const opts = { ...validGatewayOptionsJwt, allowedAudience: undefined };
 const result = validateAddGatewayOptions(opts);
 expect(result.valid).toBe(true);
 });
Expand All@@ -269,21 +258,88 @@ describe('validate', () => {
 expect(result.error?.includes('.well-known/openid-configuration')).toBeTruthy();
 });

 it('returns error for HTTP discoveryUrl (HTTPS required)', () => {
 // AC13: At least one of audience/clients/scopes must be non-empty
 it('returns error when all of audience, clients, and scopes are empty', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 discoveryUrl: 'http://example.com/.well-known/openid-configuration',
 allowedAudience: ' ',
 allowedClients: undefined,
 allowedScopes: undefined,
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('Discovery URL must use HTTPS');
 expect(result.error).toBe(
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer'
 );
 });

 it('allows CUSTOM_JWT with only allowedClients', () => {
 const opts = { ...validGatewayOptionsJwt, allowedAudience: undefined, allowedScopes: undefined };
 const result = validateAddGatewayOptions(opts);
 // AC-claims1: --custom-claims with valid JSON passes validation
 it('accepts valid --custom-claims JSON', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 customClaims: JSON.stringify([
 {
 inboundTokenClaimName: 'dept',
 inboundTokenClaimValueType: 'STRING',
 authorizingClaimMatchValue: {
 claimMatchOperator: 'EQUALS',
 claimMatchValue: { matchValueString: 'engineering' },
 },
 },
 ]),
 });
 expect(result.valid).toBe(true);
 });

 // AC-claims2: --custom-claims alone satisfies the "at least one constraint" check
 it('allows CUSTOM_JWT with only --custom-claims (no audience/clients/scopes)', () => {
 const result = validateAddGatewayOptions({
 name: 'test-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 customClaims: JSON.stringify([
 {
 inboundTokenClaimName: 'role',
 inboundTokenClaimValueType: 'STRING_ARRAY',
 authorizingClaimMatchValue: {
 claimMatchOperator: 'CONTAINS_ANY',
 claimMatchValue: { matchValueStringList: ['admin'] },
 },
 },
 ]),
 });
 expect(result.valid).toBe(true);
 });

 // AC-claims3: --custom-claims with invalid JSON fails
 it('returns error for --custom-claims with invalid JSON', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 customClaims: 'not json',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('--custom-claims must be valid JSON');
 });

 // AC-claims4: --custom-claims with empty array fails
 it('returns error for --custom-claims with empty array', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 customClaims: '[]',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('--custom-claims must be a non-empty JSON array');
 });

 // AC-claims5: --custom-claims with invalid claim structure fails
 it('returns error for --custom-claims with invalid claim structure', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 customClaims: JSON.stringify([{ badField: 'value' }]),
 });
 expect(result.valid).toBe(false);
 expect(result.error).toContain('Invalid custom claim at index 0');
 });

 // AC14: Valid options pass
 it('passes for valid options', () => {
 expect(validateAddGatewayOptions(validGatewayOptionsNone)).toEqual({ valid: true });
Expand All@@ -309,8 +365,8 @@ describe('validate', () => {
 expect(result.error).toBe('Both --client-id and --client-secret must be provided together');
 });

 // AC16: OAuth credentials only valid with CUSTOM_JWT
 it('returns error when OAuth credentials used with non-CUSTOM_JWT authorizer', () => {
 // AC16: OAuth client credentials only valid with CUSTOM_JWT
 it('returns error when OAuth client credentials used with non-CUSTOM_JWT authorizer', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsNone,
 clientId: 'my-client-id',
Expand All@@ -320,8 +376,8 @@ describe('validate', () => {
 expect(result.error).toBe('OAuth client credentials are only valid with CUSTOM_JWT authorizer');
 });

 // AC17: valid CUSTOM_JWT with OAuth credentials passes
 it('passes for CUSTOM_JWT with OAuth credentials', () => {
 // AC17: valid CUSTOM_JWT with OAuth client credentials passes
 it('passes for CUSTOM_JWT with OAuth client credentials', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 clientId: 'my-client-id',
Expand Down

1 change: 1 addition & 0 deletions
src/cli/commands/add/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ export interface AddGatewayOptions {
 allowedAudience?: string;
 allowedClients?: string;
 allowedScopes?: string;
 customClaims?: string;
 clientId?: string;
 clientSecret?: string;
 agents?: string;
Expand Down

27 changes: 24 additions & 3 deletions
src/cli/commands/add/validate.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { ConfigIO, findConfigRoot } from '../../../lib';
import {
 AgentNameSchema,
 BuildTypeSchema,
 CustomClaimValidationSchema,
 GatewayExceptionLevelSchema,
 GatewayNameSchema,
 ModelProviderSchema,
Expand DownExpand Up@@ -275,16 +276,36 @@ export function validateAddGatewayOptions(options: AddGatewayOptions): Validatio
 return { valid: false, error: `Discovery URL must end with ${OIDC_WELL_KNOWN_SUFFIX}` };
 }

 // allowedAudience, allowedClients, allowedScopes are all optional individually,
 // Validate custom claims JSON if provided
 if (options.customClaims) {
 let parsed: unknown;
 try {
 parsed = JSON.parse(options.customClaims);
 } catch {
 return { valid: false, error: '--custom-claims must be valid JSON' };
 }
 if (!Array.isArray(parsed) || parsed.length === 0) {
 return { valid: false, error: '--custom-claims must be a non-empty JSON array' };
 }
 for (const [i, entry] of parsed.entries()) {
 const result = CustomClaimValidationSchema.safeParse(entry);
 if (!result.success) {
 return { valid: false, error: `Invalid custom claim at index ${i}: ${result.error.issues[0]?.message}` };
 }
 }
 }

 // allowedAudience, allowedClients, allowedScopes, customClaims are all optional individually,
 // but at least one must be provided
 const hasAudience = !!options.allowedAudience?.trim();
 const hasClients = !!options.allowedClients?.trim();
 const hasScopes = !!options.allowedScopes?.trim();
 if (!hasAudience && !hasClients && !hasScopes) {
 const hasClaims = !!options.customClaims?.trim();
 if (!hasAudience && !hasClients && !hasScopes && !hasClaims) {
 return {
 valid: false,
 error:
 'At least one of --allowed-audience, --allowed-clients, or --allowed-scopes must be provided for CUSTOM_JWT authorizer',
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer',
 };
 }
 }
Expand Down

18 changes: 15 additions & 3 deletions
src/cli/primitives/GatewayPrimitive.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import type {
 AgentCoreGatewayTarget,
 AgentCoreMcpSpec,
 AgentCoreProjectSpec,
 CustomClaimValidation,
 GatewayAuthorizerType,
} from '../../schema';
import { AgentCoreGatewaySchema, PolicyEngineModeSchema } from '../../schema';
Expand All@@ -29,6 +30,7 @@ export interface AddGatewayOptions {
 allowedAudience?: string;
 allowedClients?: string;
 allowedScopes?: string;
 customClaims?: CustomClaimValidation[];
 clientId?: string;
 clientSecret?: string;
 agents?: string;
Expand DownExpand Up@@ -164,6 +166,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 .option('--allowed-audience <audience>', 'Comma-separated allowed audiences (for CUSTOM_JWT)')
 .option('--allowed-clients <clients>', 'Comma-separated allowed client IDs (for CUSTOM_JWT)')
 .option('--allowed-scopes <scopes>', 'Comma-separated allowed scopes (for CUSTOM_JWT)')
 .option('--custom-claims <json>', 'Custom claim validations as JSON array (for CUSTOM_JWT)')
 .option('--client-id <id>', 'OAuth client ID for gateway bearer token')
 .option('--client-secret <secret>', 'OAuth client secret')
 .option('--agents <agents>', 'Comma-separated agent names')
Expand All@@ -190,6 +193,11 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 process.exit(1);
 }

 // Parse custom claims JSON if provided (already validated)
 const parsedCustomClaims = cliOptions.customClaims
 ? (JSON.parse(cliOptions.customClaims) as CustomClaimValidation[])
 : undefined;

 const result = await this.add({
 name: cliOptions.name!,
 description: cliOptions.description,
Expand All@@ -198,6 +206,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 allowedAudience: cliOptions.allowedAudience,
 allowedClients: cliOptions.allowedClients,
 allowedScopes: cliOptions.allowedScopes,
 customClaims: parsedCustomClaims,
 clientId: cliOptions.clientId,
 clientSecret: cliOptions.clientSecret,
 agents: cliOptions.agents,
Expand DownExpand Up@@ -334,6 +343,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 ...(allowedAudience?.length ? { allowedAudience } : {}),
 ...(allowedClients?.length ? { allowedClients } : {}),
 ...(allowedScopes?.length ? { allowedScopes } : {}),
 ...(options.customClaims?.length ? { customClaims: options.customClaims } : {}),
 ...(options.clientId ? { clientId: options.clientId } : {}),
 ...(options.clientSecret ? { clientSecret: options.clientSecret } : {}),
 };
Expand DownExpand Up@@ -415,9 +425,10 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 });
 await this.writeProjectSpec(project);

 // Write client secret to .env
 const envVarName = computeDefaultCredentialEnvVarName(credentialName);
 await setEnvVar(envVarName, jwtConfig.clientSecret!);
 // Write client ID and client secret to .env
 const envVarPrefix = computeDefaultCredentialEnvVarName(credentialName);
 await setEnvVar(`${envVarPrefix}_CLIENT_ID`, jwtConfig.clientId!);
 await setEnvVar(`${envVarPrefix}_CLIENT_SECRET`, jwtConfig.clientSecret!);
 }

 /**
Expand All@@ -434,6 +445,7 @@ export class GatewayPrimitive extends BasePrimitive<AddGatewayOptions, Removable
 ...(config.jwtConfig.allowedAudience?.length ? { allowedAudience: config.jwtConfig.allowedAudience } : {}),
 ...(config.jwtConfig.allowedClients?.length ? { allowedClients: config.jwtConfig.allowedClients } : {}),
 ...(config.jwtConfig.allowedScopes?.length ? { allowedScopes: config.jwtConfig.allowedScopes } : {}),
 ...(config.jwtConfig.customClaims?.length ? { customClaims: config.jwtConfig.customClaims } : {}),
 },
 };
 }
Expand Down

72 changes: 72 additions & 0 deletions
src/cli/primitives/__tests__/GatewayPrimitive.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,78 @@ describe('GatewayPrimitive', () => {
 primitive = new GatewayPrimitive();
 });

 describe('customClaims pipeline', () => {
 const SAMPLE_CLAIMS = [
 {
 inboundTokenClaimName: 'department',
 inboundTokenClaimValueType: 'STRING_ARRAY' as const,
 authorizingClaimMatchValue: {
 claimMatchOperator: 'CONTAINS_ANY' as const,
 claimMatchValue: { matchValueStringList: ['engineering', 'sales'] },
 },
 },
 ];

 it('custom claims from TUI flow are written to authorizerConfiguration', async () => {
 await primitive.add({
 name: 'jwt-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 allowedAudience: 'aud1',
 customClaims: SAMPLE_CLAIMS,
 });

 const gw = getWrittenGateway();
 expect(gw.authorizerConfiguration?.customJwtAuthorizer).toBeDefined();
 expect(gw.authorizerConfiguration!.customJwtAuthorizer!.customClaims).toEqual(SAMPLE_CLAIMS);
 });

 it('custom claims are preserved alongside audience and clients', async () => {
 await primitive.add({
 name: 'jwt-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 allowedAudience: 'aud1,aud2',
 allowedClients: 'client1',
 customClaims: SAMPLE_CLAIMS,
 });

 const gw = getWrittenGateway();
 const jwtConfig = gw.authorizerConfiguration!.customJwtAuthorizer!;
 expect(jwtConfig.allowedAudience).toEqual(['aud1', 'aud2']);
 expect(jwtConfig.allowedClients).toEqual(['client1']);
 expect(jwtConfig.customClaims).toEqual(SAMPLE_CLAIMS);
 });

 it('omits customClaims from authorizerConfiguration when not provided', async () => {
 await primitive.add({
 name: 'jwt-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 allowedAudience: 'aud1',
 });

 const gw = getWrittenGateway();
 expect(gw.authorizerConfiguration!.customJwtAuthorizer!.customClaims).toBeUndefined();
 });

 it('custom claims only (no audience/clients/scopes) produces valid config', async () => {
 await primitive.add({
 name: 'jwt-gw',
 authorizerType: 'CUSTOM_JWT',
 discoveryUrl: 'https://example.com/.well-known/openid-configuration',
 customClaims: SAMPLE_CLAIMS,
 });

 const gw = getWrittenGateway();
 const jwtConfig = gw.authorizerConfiguration!.customJwtAuthorizer!;
 expect(jwtConfig.allowedAudience).toBeUndefined();
 expect(jwtConfig.allowedClients).toBeUndefined();
 expect(jwtConfig.allowedScopes).toBeUndefined();
 expect(jwtConfig.customClaims).toEqual(SAMPLE_CLAIMS);
 });
 });

 describe('exceptionLevel', () => {
 it('defaults to exceptionLevel NONE', async () => {
 await primitive.add({ name: 'test-gw', authorizerType: 'NONE' });
Expand Down

1 change: 1 addition & 0 deletions
src/cli/tui/hooks/useCreateMcp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@ export function useCreateGateway() {
 allowedAudience: config.jwtConfig?.allowedAudience?.join(','),
 allowedClients: config.jwtConfig?.allowedClients?.join(','),
 allowedScopes: config.jwtConfig?.allowedScopes?.join(','),
 customClaims: config.jwtConfig?.customClaims,
 clientId: config.jwtConfig?.clientId,
 clientSecret: config.jwtConfig?.clientSecret,
 enableSemanticSearch: config.enableSemanticSearch,
Expand Down
Loading
Loading