feat(gateway): add Custom JWT inbound auth for MCP gateways#596

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

Closed
aidandaly24 wants to merge 1 commit into from
Closed

feat(gateway): add Custom JWT inbound auth for MCP gateways #596

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/.
*/
2 changes: 1 addition & 1 deletion src/cli/cloudformation/outputs.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -52,7 +52,7 @@ export function parseGatewayOutputs(
const gatewayNames = Object.keys(gatewaySpecs);
const gatewayIdMap = new Map(gatewayNames.map(name => [toPascalId(name), name]));

// Match patterns: Gateway{Name}{Type}Output
// Match patterns: Gateway{Name}{Type}Output{Hash}
const outputPattern = /^Gateway(.+?)(Id|Arn|Url)Output/;

for (const [key, value] of Object.entries(outputs)) {
Expand Down
4 changes: 2 additions & 2 deletions src/cli/commands/add/__tests__/add-gateway.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -167,9 +167,9 @@ describe('add gateway command', () => {
'client1',
'--allowed-scopes',
'scope1,scope2',
'--agent-client-id',
'--client-id',
'agent-cid',
'--agent-client-secret',
'--client-secret',
'agent-secret',
'--json',
],
Expand Down
142 changes: 111 additions & 31 deletions src/cli/commands/add/__tests__/validate.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -220,19 +220,24 @@ describe('validate', () => {
expect(result.error?.includes('Invalid authorizer type')).toBeTruthy();
});

// AC11: CUSTOM_JWT requires discoveryUrl and allowedClients (allowedAudience is optional)
// AC11: CUSTOM_JWT requires discoveryUrl; at least one of allowedAudience/allowedClients/allowedScopes
it('returns error for CUSTOM_JWT missing required fields', () => {
const jwtFields: { field: keyof AddGatewayOptions; error: string }[] = [
{ field: 'discoveryUrl', error: '--discovery-url is required for CUSTOM_JWT authorizer' },
{ field: 'allowedClients', error: '--allowed-clients is required for CUSTOM_JWT authorizer' },
];
// 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');

for (const { field, error } of jwtFields) {
const opts = { ...validGatewayOptionsJwt, [field]: undefined };
const result = validateAddGatewayOptions(opts);
expect(result.valid, `Should fail for missing ${String(field)}`).toBe(false);
expect(result.error).toBe(error);
}
// All three optional fields absent fails
const noneResult = validateAddGatewayOptions({
...validGatewayOptionsJwt,
allowedAudience: undefined,
allowedClients: undefined,
allowedScopes: undefined,
});
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'
);
});

// AC11b: allowedAudience is optional
Expand All@@ -255,11 +260,86 @@ describe('validate', () => {
expect(result.error?.includes('.well-known/openid-configuration')).toBeTruthy();
});

// AC13: Empty comma-separated clients rejected (audience can be empty)
it('returns error for empty clients', () => {
const result = validateAddGatewayOptions({ ...validGatewayOptionsJwt, allowedClients: ' , ' });
// 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,
allowedAudience: ' ',
allowedClients: undefined,
allowedScopes: undefined,
});
expect(result.valid).toBe(false);
expect(result.error).toBe(
'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer'
);
});

// 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).toBe('At least one client value is required');
expect(result.error).toContain('Invalid custom claim at index 0');
});

// AC14: Valid options pass
Expand All@@ -268,42 +348,42 @@ describe('validate', () => {
expect(validateAddGatewayOptions(validGatewayOptionsJwt)).toEqual({ valid: true });
});

// AC15: agentClientId and agentClientSecret must be provided together
it('returns error when agentClientId provided without agentClientSecret', () => {
// AC15: clientId and clientSecret must be provided together
it('returns error when clientId provided without clientSecret', () => {
const result = validateAddGatewayOptions({
...validGatewayOptionsJwt,
agentClientId: 'my-client-id',
clientId: 'my-client-id',
});
expect(result.valid).toBe(false);
expect(result.error).toBe('Both --agent-client-id and --agent-client-secret must be provided together');
expect(result.error).toBe('Both --client-id and --client-secret must be provided together');
});

it('returns error when agentClientSecret provided without agentClientId', () => {
it('returns error when clientSecret provided without clientId', () => {
const result = validateAddGatewayOptions({
...validGatewayOptionsJwt,
agentClientSecret: 'my-secret',
clientSecret: 'my-secret',
});
expect(result.valid).toBe(false);
expect(result.error).toBe('Both --agent-client-id and --agent-client-secret must be provided together');
expect(result.error).toBe('Both --client-id and --client-secret must be provided together');
});

// AC16: agent credentials only valid with CUSTOM_JWT
it('returns error when agent 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,
agentClientId: 'my-client-id',
agentClientSecret: 'my-secret',
clientId: 'my-client-id',
clientSecret: 'my-secret',
});
expect(result.valid).toBe(false);
expect(result.error).toBe('Agent OAuth credentials are only valid with CUSTOM_JWT authorizer');
expect(result.error).toBe('OAuth client credentials are only valid with CUSTOM_JWT authorizer');
});

// AC17: valid CUSTOM_JWT with agent credentials passes
it('passes for CUSTOM_JWT with agent credentials', () => {
// AC17: valid CUSTOM_JWT with OAuth client credentials passes
it('passes for CUSTOM_JWT with OAuth client credentials', () => {
const result = validateAddGatewayOptions({
...validGatewayOptionsJwt,
agentClientId: 'my-client-id',
agentClientSecret: 'my-secret',
clientId: 'my-client-id',
clientSecret: 'my-secret',
allowedScopes: 'scope1,scope2',
});
expect(result.valid).toBe(true);
Expand Down
5 changes: 3 additions & 2 deletions src/cli/commands/add/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,8 +34,9 @@ export interface AddGatewayOptions {
allowedAudience?: string;
allowedClients?: string;
allowedScopes?: string;
agentClientId?: string;
agentClientSecret?: string;
customClaims?: string;
clientId?: string;
clientSecret?: string;
agents?: string;
semanticSearch?: boolean;
exceptionLevel?: string;
Expand Down
59 changes: 41 additions & 18 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@@ -230,7 +231,10 @@ export function validateAddGatewayOptions(options: AddGatewayOptions): Validatio
}

try {
new URL(options.discoveryUrl);
const url = new URL(options.discoveryUrl);
if (url.protocol !== 'https:') {
return { valid: false, error: 'Discovery URL must use HTTPS' };
}
} catch {
return { valid: false, error: 'Discovery URL must be a valid URL' };
}
Expand All@@ -239,30 +243,49 @@ export function validateAddGatewayOptions(options: AddGatewayOptions): Validatio
return { valid: false, error: `Discovery URL must end with ${OIDC_WELL_KNOWN_SUFFIX}` };
}

// allowedAudience is optional - empty means no audience validation

if (!options.allowedClients) {
return { valid: false, error: '--allowed-clients is required for CUSTOM_JWT authorizer' };
// 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}` };
}
}
}

const clients = options.allowedClients
.split(',')
.map(s => s.trim())
.filter(Boolean);
if (clients.length === 0) {
return { valid: false, error: 'At least one client value is required' };
// 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();
const hasClaims = !!options.customClaims?.trim();
if (!hasAudience && !hasClients && !hasScopes && !hasClaims) {
return {
valid: false,
error:
'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer',
};
}
}

// Validate agent OAuth credentials
if (options.agentClientId && !options.agentClientSecret) {
return { valid: false, error: 'Both --agent-client-id and --agent-client-secret must be provided together' };
// Validate OAuth client credentials
if (options.clientId && !options.clientSecret) {
return { valid: false, error: 'Both --client-id and --client-secret must be provided together' };
}
if (options.agentClientSecret && !options.agentClientId) {
return { valid: false, error: 'Both --agent-client-id and --agent-client-secret must be provided together' };
if (options.clientSecret && !options.clientId) {
return { valid: false, error: 'Both --client-id and --client-secret must be provided together' };
}
if (options.agentClientId && options.authorizerType !== 'CUSTOM_JWT') {
return { valid: false, error: 'Agent OAuth credentials are only valid with CUSTOM_JWT authorizer' };
if (options.clientId && options.authorizerType !== 'CUSTOM_JWT') {
return { valid: false, error: 'OAuth client credentials are only valid with CUSTOM_JWT authorizer' };
}

// Validate exception level if provided
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 JWT inbound auth for MCP gateways#596

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

 Closed

aidandaly24
wants to merge
1
commit into

from

 Closed


feat(gateway): add Custom JWT inbound auth for MCP gateways
#596
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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/.
 */

2 changes: 1 addition & 1 deletion
src/cli/cloudformation/outputs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,7 +52,7 @@ export function parseGatewayOutputs(
 const gatewayNames = Object.keys(gatewaySpecs);
 const gatewayIdMap = new Map(gatewayNames.map(name => [toPascalId(name), name]));

 // Match patterns: Gateway{Name}{Type}Output
 // Match patterns: Gateway{Name}{Type}Output{Hash}
 const outputPattern = /^Gateway(.+?)(Id|Arn|Url)Output/;

 for (const [key, value] of Object.entries(outputs)) {
Expand Down

4 changes: 2 additions & 2 deletions
src/cli/commands/add/__tests__/add-gateway.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -167,9 +167,9 @@ describe('add gateway command', () => {
 'client1',
 '--allowed-scopes',
 'scope1,scope2',
 '--agent-client-id',
 '--client-id',
 'agent-cid',
 '--agent-client-secret',
 '--client-secret',
 'agent-secret',
 '--json',
 ],
Expand Down

142 changes: 111 additions & 31 deletions
src/cli/commands/add/__tests__/validate.test.ts

View file


Open in desktop

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

 // AC11: CUSTOM_JWT requires discoveryUrl and allowedClients (allowedAudience is optional)
 // AC11: CUSTOM_JWT requires discoveryUrl; at least one of allowedAudience/allowedClients/allowedScopes
 it('returns error for CUSTOM_JWT missing required fields', () => {
const jwtFields: { field: keyof AddGatewayOptions; error: string }[] = [
 { field: 'discoveryUrl', error: '--discovery-url is required for CUSTOM_JWT authorizer' },
 { field: 'allowedClients', error: '--allowed-clients is required for CUSTOM_JWT authorizer' },
];
// 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');

 for (const { field, error } of jwtFields) {
 const opts = { ...validGatewayOptionsJwt, [field]: undefined };
 const result = validateAddGatewayOptions(opts);
 expect(result.valid, `Should fail for missing ${String(field)}`).toBe(false);
 expect(result.error).toBe(error);
 }
 // All three optional fields absent fails
 const noneResult = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 allowedAudience: undefined,
 allowedClients: undefined,
 allowedScopes: undefined,
 });
 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'
 );
 });

 // AC11b: allowedAudience is optional
Expand All@@ -255,11 +260,86 @@ describe('validate', () => {
 expect(result.error?.includes('.well-known/openid-configuration')).toBeTruthy();
 });

 // AC13: Empty comma-separated clients rejected (audience can be empty)
 it('returns error for empty clients', () => {
 const result = validateAddGatewayOptions({ ...validGatewayOptionsJwt, allowedClients: ' , ' });
 // 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,
 allowedAudience: ' ',
 allowedClients: undefined,
 allowedScopes: undefined,
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe(
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer'
 );
 });

 // 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).toBe('At least one client value is required');
 expect(result.error).toContain('Invalid custom claim at index 0');
 });

 // AC14: Valid options pass
Expand All@@ -268,42 +348,42 @@ describe('validate', () => {
 expect(validateAddGatewayOptions(validGatewayOptionsJwt)).toEqual({ valid: true });
 });

 // AC15: agentClientId and agentClientSecret must be provided together
 it('returns error when agentClientId provided without agentClientSecret', () => {
 // AC15: clientId and clientSecret must be provided together
 it('returns error when clientId provided without clientSecret', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
agentClientId: 'my-client-id',
clientId: 'my-client-id',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('Both --agent-client-id and --agent-client-secret must be provided together');
 expect(result.error).toBe('Both --client-id and --client-secret must be provided together');
 });

 it('returns error when agentClientSecret provided without agentClientId', () => {
 it('returns error when clientSecret provided without clientId', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
agentClientSecret: 'my-secret',
clientSecret: 'my-secret',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('Both --agent-client-id and --agent-client-secret must be provided together');
 expect(result.error).toBe('Both --client-id and --client-secret must be provided together');
 });

 // AC16: agent credentials only valid with CUSTOM_JWT
 it('returns error when agent 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,
agentClientId: 'my-client-id',
agentClientSecret: 'my-secret',
clientId: 'my-client-id',
clientSecret: 'my-secret',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('Agent OAuth credentials are only valid with CUSTOM_JWT authorizer');
 expect(result.error).toBe('OAuth client credentials are only valid with CUSTOM_JWT authorizer');
 });

 // AC17: valid CUSTOM_JWT with agent credentials passes
 it('passes for CUSTOM_JWT with agent credentials', () => {
 // AC17: valid CUSTOM_JWT with OAuth client credentials passes
 it('passes for CUSTOM_JWT with OAuth client credentials', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
agentClientId: 'my-client-id',
agentClientSecret: 'my-secret',
clientId: 'my-client-id',
clientSecret: 'my-secret',
 allowedScopes: 'scope1,scope2',
 });
 expect(result.valid).toBe(true);
Expand Down

5 changes: 3 additions & 2 deletions
src/cli/commands/add/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,8 +34,9 @@ export interface AddGatewayOptions {
 allowedAudience?: string;
 allowedClients?: string;
 allowedScopes?: string;
 agentClientId?: string;
 agentClientSecret?: string;
 customClaims?: string;
 clientId?: string;
 clientSecret?: string;
 agents?: string;
 semanticSearch?: boolean;
 exceptionLevel?: string;
Expand Down

59 changes: 41 additions & 18 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@@ -230,7 +231,10 @@ export function validateAddGatewayOptions(options: AddGatewayOptions): Validatio
 }

 try {
 new URL(options.discoveryUrl);
 const url = new URL(options.discoveryUrl);
 if (url.protocol !== 'https:') {
 return { valid: false, error: 'Discovery URL must use HTTPS' };
 }
 } catch {
 return { valid: false, error: 'Discovery URL must be a valid URL' };
 }
Expand All@@ -239,30 +243,49 @@ export function validateAddGatewayOptions(options: AddGatewayOptions): Validatio
 return { valid: false, error: `Discovery URL must end with ${OIDC_WELL_KNOWN_SUFFIX}` };
 }

 // allowedAudience is optional - empty means no audience validation

 if (!options.allowedClients) {
 return { valid: false, error: '--allowed-clients is required for CUSTOM_JWT authorizer' };
 // 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}` };
 }
 }
 }

 const clients = options.allowedClients
 .split(',')
 .map(s => s.trim())
 .filter(Boolean);
 if (clients.length === 0) {
 return { valid: false, error: 'At least one client value is required' };
 // 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();
 const hasClaims = !!options.customClaims?.trim();
 if (!hasAudience && !hasClients && !hasScopes && !hasClaims) {
 return {
 valid: false,
 error:
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer',
 };
 }
 }

 // Validate agent OAuth credentials
 if (options.agentClientId && !options.agentClientSecret) {
 return { valid: false, error: 'Both --agent-client-id and --agent-client-secret must be provided together' };
 // Validate OAuth client credentials
 if (options.clientId && !options.clientSecret) {
 return { valid: false, error: 'Both --client-id and --client-secret must be provided together' };
 }
 if (options.agentClientSecret && !options.agentClientId) {
 return { valid: false, error: 'Both --agent-client-id and --agent-client-secret must be provided together' };
 if (options.clientSecret && !options.clientId) {
 return { valid: false, error: 'Both --client-id and --client-secret must be provided together' };
 }
 if (options.agentClientId && options.authorizerType !== 'CUSTOM_JWT') {
 return { valid: false, error: 'Agent OAuth credentials are only valid with CUSTOM_JWT authorizer' };
 if (options.clientId && options.authorizerType !== 'CUSTOM_JWT') {
 return { valid: false, error: 'OAuth client credentials are only valid with CUSTOM_JWT authorizer' };
 }

 // Validate exception level if provided
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 JWT inbound auth for MCP gateways#596

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

 Closed

aidandaly24
wants to merge
1
commit into

from

 Closed


feat(gateway): add Custom JWT inbound auth for MCP gateways
#596
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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/.
 */

2 changes: 1 addition & 1 deletion
src/cli/cloudformation/outputs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,7 +52,7 @@ export function parseGatewayOutputs(
 const gatewayNames = Object.keys(gatewaySpecs);
 const gatewayIdMap = new Map(gatewayNames.map(name => [toPascalId(name), name]));

 // Match patterns: Gateway{Name}{Type}Output
 // Match patterns: Gateway{Name}{Type}Output{Hash}
 const outputPattern = /^Gateway(.+?)(Id|Arn|Url)Output/;

 for (const [key, value] of Object.entries(outputs)) {
Expand Down

4 changes: 2 additions & 2 deletions
src/cli/commands/add/__tests__/add-gateway.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -167,9 +167,9 @@ describe('add gateway command', () => {
 'client1',
 '--allowed-scopes',
 'scope1,scope2',
 '--agent-client-id',
 '--client-id',
 'agent-cid',
 '--agent-client-secret',
 '--client-secret',
 'agent-secret',
 '--json',
 ],
Expand Down

142 changes: 111 additions & 31 deletions
src/cli/commands/add/__tests__/validate.test.ts

View file


Open in desktop

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

 // AC11: CUSTOM_JWT requires discoveryUrl and allowedClients (allowedAudience is optional)
 // AC11: CUSTOM_JWT requires discoveryUrl; at least one of allowedAudience/allowedClients/allowedScopes
 it('returns error for CUSTOM_JWT missing required fields', () => {
const jwtFields: { field: keyof AddGatewayOptions; error: string }[] = [
 { field: 'discoveryUrl', error: '--discovery-url is required for CUSTOM_JWT authorizer' },
 { field: 'allowedClients', error: '--allowed-clients is required for CUSTOM_JWT authorizer' },
];
// 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');

 for (const { field, error } of jwtFields) {
 const opts = { ...validGatewayOptionsJwt, [field]: undefined };
 const result = validateAddGatewayOptions(opts);
 expect(result.valid, `Should fail for missing ${String(field)}`).toBe(false);
 expect(result.error).toBe(error);
 }
 // All three optional fields absent fails
 const noneResult = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 allowedAudience: undefined,
 allowedClients: undefined,
 allowedScopes: undefined,
 });
 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'
 );
 });

 // AC11b: allowedAudience is optional
Expand All@@ -255,11 +260,86 @@ describe('validate', () => {
 expect(result.error?.includes('.well-known/openid-configuration')).toBeTruthy();
 });

 // AC13: Empty comma-separated clients rejected (audience can be empty)
 it('returns error for empty clients', () => {
 const result = validateAddGatewayOptions({ ...validGatewayOptionsJwt, allowedClients: ' , ' });
 // 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,
 allowedAudience: ' ',
 allowedClients: undefined,
 allowedScopes: undefined,
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe(
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer'
 );
 });

 // 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).toBe('At least one client value is required');
 expect(result.error).toContain('Invalid custom claim at index 0');
 });

 // AC14: Valid options pass
Expand All@@ -268,42 +348,42 @@ describe('validate', () => {
 expect(validateAddGatewayOptions(validGatewayOptionsJwt)).toEqual({ valid: true });
 });

 // AC15: agentClientId and agentClientSecret must be provided together
 it('returns error when agentClientId provided without agentClientSecret', () => {
 // AC15: clientId and clientSecret must be provided together
 it('returns error when clientId provided without clientSecret', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
agentClientId: 'my-client-id',
clientId: 'my-client-id',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('Both --agent-client-id and --agent-client-secret must be provided together');
 expect(result.error).toBe('Both --client-id and --client-secret must be provided together');
 });

 it('returns error when agentClientSecret provided without agentClientId', () => {
 it('returns error when clientSecret provided without clientId', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
agentClientSecret: 'my-secret',
clientSecret: 'my-secret',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('Both --agent-client-id and --agent-client-secret must be provided together');
 expect(result.error).toBe('Both --client-id and --client-secret must be provided together');
 });

 // AC16: agent credentials only valid with CUSTOM_JWT
 it('returns error when agent 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,
agentClientId: 'my-client-id',
agentClientSecret: 'my-secret',
clientId: 'my-client-id',
clientSecret: 'my-secret',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('Agent OAuth credentials are only valid with CUSTOM_JWT authorizer');
 expect(result.error).toBe('OAuth client credentials are only valid with CUSTOM_JWT authorizer');
 });

 // AC17: valid CUSTOM_JWT with agent credentials passes
 it('passes for CUSTOM_JWT with agent credentials', () => {
 // AC17: valid CUSTOM_JWT with OAuth client credentials passes
 it('passes for CUSTOM_JWT with OAuth client credentials', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
agentClientId: 'my-client-id',
agentClientSecret: 'my-secret',
clientId: 'my-client-id',
clientSecret: 'my-secret',
 allowedScopes: 'scope1,scope2',
 });
 expect(result.valid).toBe(true);
Expand Down

5 changes: 3 additions & 2 deletions
src/cli/commands/add/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,8 +34,9 @@ export interface AddGatewayOptions {
 allowedAudience?: string;
 allowedClients?: string;
 allowedScopes?: string;
 agentClientId?: string;
 agentClientSecret?: string;
 customClaims?: string;
 clientId?: string;
 clientSecret?: string;
 agents?: string;
 semanticSearch?: boolean;
 exceptionLevel?: string;
Expand Down

59 changes: 41 additions & 18 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@@ -230,7 +231,10 @@ export function validateAddGatewayOptions(options: AddGatewayOptions): Validatio
 }

 try {
 new URL(options.discoveryUrl);
 const url = new URL(options.discoveryUrl);
 if (url.protocol !== 'https:') {
 return { valid: false, error: 'Discovery URL must use HTTPS' };
 }
 } catch {
 return { valid: false, error: 'Discovery URL must be a valid URL' };
 }
Expand All@@ -239,30 +243,49 @@ export function validateAddGatewayOptions(options: AddGatewayOptions): Validatio
 return { valid: false, error: `Discovery URL must end with ${OIDC_WELL_KNOWN_SUFFIX}` };
 }

 // allowedAudience is optional - empty means no audience validation

 if (!options.allowedClients) {
 return { valid: false, error: '--allowed-clients is required for CUSTOM_JWT authorizer' };
 // 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}` };
 }
 }
 }

 const clients = options.allowedClients
 .split(',')
 .map(s => s.trim())
 .filter(Boolean);
 if (clients.length === 0) {
 return { valid: false, error: 'At least one client value is required' };
 // 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();
 const hasClaims = !!options.customClaims?.trim();
 if (!hasAudience && !hasClients && !hasScopes && !hasClaims) {
 return {
 valid: false,
 error:
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer',
 };
 }
 }

 // Validate agent OAuth credentials
 if (options.agentClientId && !options.agentClientSecret) {
 return { valid: false, error: 'Both --agent-client-id and --agent-client-secret must be provided together' };
 // Validate OAuth client credentials
 if (options.clientId && !options.clientSecret) {
 return { valid: false, error: 'Both --client-id and --client-secret must be provided together' };
 }
 if (options.agentClientSecret && !options.agentClientId) {
 return { valid: false, error: 'Both --agent-client-id and --agent-client-secret must be provided together' };
 if (options.clientSecret && !options.clientId) {
 return { valid: false, error: 'Both --client-id and --client-secret must be provided together' };
 }
 if (options.agentClientId && options.authorizerType !== 'CUSTOM_JWT') {
 return { valid: false, error: 'Agent OAuth credentials are only valid with CUSTOM_JWT authorizer' };
 if (options.clientId && options.authorizerType !== 'CUSTOM_JWT') {
 return { valid: false, error: 'OAuth client credentials are only valid with CUSTOM_JWT authorizer' };
 }

 // Validate exception level if provided
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 JWT inbound auth for MCP gateways#596

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

 Closed

aidandaly24
wants to merge
1
commit into

from

 Closed


feat(gateway): add Custom JWT inbound auth for MCP gateways
#596
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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/.
 */

2 changes: 1 addition & 1 deletion
src/cli/cloudformation/outputs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,7 +52,7 @@ export function parseGatewayOutputs(
 const gatewayNames = Object.keys(gatewaySpecs);
 const gatewayIdMap = new Map(gatewayNames.map(name => [toPascalId(name), name]));

 // Match patterns: Gateway{Name}{Type}Output
 // Match patterns: Gateway{Name}{Type}Output{Hash}
 const outputPattern = /^Gateway(.+?)(Id|Arn|Url)Output/;

 for (const [key, value] of Object.entries(outputs)) {
Expand Down

4 changes: 2 additions & 2 deletions
src/cli/commands/add/__tests__/add-gateway.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -167,9 +167,9 @@ describe('add gateway command', () => {
 'client1',
 '--allowed-scopes',
 'scope1,scope2',
 '--agent-client-id',
 '--client-id',
 'agent-cid',
 '--agent-client-secret',
 '--client-secret',
 'agent-secret',
 '--json',
 ],
Expand Down

142 changes: 111 additions & 31 deletions
src/cli/commands/add/__tests__/validate.test.ts

View file


Open in desktop

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

 // AC11: CUSTOM_JWT requires discoveryUrl and allowedClients (allowedAudience is optional)
 // AC11: CUSTOM_JWT requires discoveryUrl; at least one of allowedAudience/allowedClients/allowedScopes
 it('returns error for CUSTOM_JWT missing required fields', () => {
const jwtFields: { field: keyof AddGatewayOptions; error: string }[] = [
 { field: 'discoveryUrl', error: '--discovery-url is required for CUSTOM_JWT authorizer' },
 { field: 'allowedClients', error: '--allowed-clients is required for CUSTOM_JWT authorizer' },
];
// 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');

 for (const { field, error } of jwtFields) {
 const opts = { ...validGatewayOptionsJwt, [field]: undefined };
 const result = validateAddGatewayOptions(opts);
 expect(result.valid, `Should fail for missing ${String(field)}`).toBe(false);
 expect(result.error).toBe(error);
 }
 // All three optional fields absent fails
 const noneResult = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 allowedAudience: undefined,
 allowedClients: undefined,
 allowedScopes: undefined,
 });
 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'
 );
 });

 // AC11b: allowedAudience is optional
Expand All@@ -255,11 +260,86 @@ describe('validate', () => {
 expect(result.error?.includes('.well-known/openid-configuration')).toBeTruthy();
 });

 // AC13: Empty comma-separated clients rejected (audience can be empty)
 it('returns error for empty clients', () => {
 const result = validateAddGatewayOptions({ ...validGatewayOptionsJwt, allowedClients: ' , ' });
 // 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,
 allowedAudience: ' ',
 allowedClients: undefined,
 allowedScopes: undefined,
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe(
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer'
 );
 });

 // 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).toBe('At least one client value is required');
 expect(result.error).toContain('Invalid custom claim at index 0');
 });

 // AC14: Valid options pass
Expand All@@ -268,42 +348,42 @@ describe('validate', () => {
 expect(validateAddGatewayOptions(validGatewayOptionsJwt)).toEqual({ valid: true });
 });

 // AC15: agentClientId and agentClientSecret must be provided together
 it('returns error when agentClientId provided without agentClientSecret', () => {
 // AC15: clientId and clientSecret must be provided together
 it('returns error when clientId provided without clientSecret', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
agentClientId: 'my-client-id',
clientId: 'my-client-id',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('Both --agent-client-id and --agent-client-secret must be provided together');
 expect(result.error).toBe('Both --client-id and --client-secret must be provided together');
 });

 it('returns error when agentClientSecret provided without agentClientId', () => {
 it('returns error when clientSecret provided without clientId', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
agentClientSecret: 'my-secret',
clientSecret: 'my-secret',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('Both --agent-client-id and --agent-client-secret must be provided together');
 expect(result.error).toBe('Both --client-id and --client-secret must be provided together');
 });

 // AC16: agent credentials only valid with CUSTOM_JWT
 it('returns error when agent 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,
agentClientId: 'my-client-id',
agentClientSecret: 'my-secret',
clientId: 'my-client-id',
clientSecret: 'my-secret',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('Agent OAuth credentials are only valid with CUSTOM_JWT authorizer');
 expect(result.error).toBe('OAuth client credentials are only valid with CUSTOM_JWT authorizer');
 });

 // AC17: valid CUSTOM_JWT with agent credentials passes
 it('passes for CUSTOM_JWT with agent credentials', () => {
 // AC17: valid CUSTOM_JWT with OAuth client credentials passes
 it('passes for CUSTOM_JWT with OAuth client credentials', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
agentClientId: 'my-client-id',
agentClientSecret: 'my-secret',
clientId: 'my-client-id',
clientSecret: 'my-secret',
 allowedScopes: 'scope1,scope2',
 });
 expect(result.valid).toBe(true);
Expand Down

5 changes: 3 additions & 2 deletions
src/cli/commands/add/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,8 +34,9 @@ export interface AddGatewayOptions {
 allowedAudience?: string;
 allowedClients?: string;
 allowedScopes?: string;
 agentClientId?: string;
 agentClientSecret?: string;
 customClaims?: string;
 clientId?: string;
 clientSecret?: string;
 agents?: string;
 semanticSearch?: boolean;
 exceptionLevel?: string;
Expand Down

59 changes: 41 additions & 18 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@@ -230,7 +231,10 @@ export function validateAddGatewayOptions(options: AddGatewayOptions): Validatio
 }

 try {
 new URL(options.discoveryUrl);
 const url = new URL(options.discoveryUrl);
 if (url.protocol !== 'https:') {
 return { valid: false, error: 'Discovery URL must use HTTPS' };
 }
 } catch {
 return { valid: false, error: 'Discovery URL must be a valid URL' };
 }
Expand All@@ -239,30 +243,49 @@ export function validateAddGatewayOptions(options: AddGatewayOptions): Validatio
 return { valid: false, error: `Discovery URL must end with ${OIDC_WELL_KNOWN_SUFFIX}` };
 }

 // allowedAudience is optional - empty means no audience validation

 if (!options.allowedClients) {
 return { valid: false, error: '--allowed-clients is required for CUSTOM_JWT authorizer' };
 // 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}` };
 }
 }
 }

 const clients = options.allowedClients
 .split(',')
 .map(s => s.trim())
 .filter(Boolean);
 if (clients.length === 0) {
 return { valid: false, error: 'At least one client value is required' };
 // 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();
 const hasClaims = !!options.customClaims?.trim();
 if (!hasAudience && !hasClients && !hasScopes && !hasClaims) {
 return {
 valid: false,
 error:
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer',
 };
 }
 }

 // Validate agent OAuth credentials
 if (options.agentClientId && !options.agentClientSecret) {
 return { valid: false, error: 'Both --agent-client-id and --agent-client-secret must be provided together' };
 // Validate OAuth client credentials
 if (options.clientId && !options.clientSecret) {
 return { valid: false, error: 'Both --client-id and --client-secret must be provided together' };
 }
 if (options.agentClientSecret && !options.agentClientId) {
 return { valid: false, error: 'Both --agent-client-id and --agent-client-secret must be provided together' };
 if (options.clientSecret && !options.clientId) {
 return { valid: false, error: 'Both --client-id and --client-secret must be provided together' };
 }
 if (options.agentClientId && options.authorizerType !== 'CUSTOM_JWT') {
 return { valid: false, error: 'Agent OAuth credentials are only valid with CUSTOM_JWT authorizer' };
 if (options.clientId && options.authorizerType !== 'CUSTOM_JWT') {
 return { valid: false, error: 'OAuth client credentials are only valid with CUSTOM_JWT authorizer' };
 }

 // Validate exception level if provided
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 JWT inbound auth for MCP gateways#596

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

 Closed

aidandaly24
wants to merge
1
commit into

from

 Closed


feat(gateway): add Custom JWT inbound auth for MCP gateways
#596
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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/.
 */

2 changes: 1 addition & 1 deletion
src/cli/cloudformation/outputs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,7 +52,7 @@ export function parseGatewayOutputs(
 const gatewayNames = Object.keys(gatewaySpecs);
 const gatewayIdMap = new Map(gatewayNames.map(name => [toPascalId(name), name]));

 // Match patterns: Gateway{Name}{Type}Output
 // Match patterns: Gateway{Name}{Type}Output{Hash}
 const outputPattern = /^Gateway(.+?)(Id|Arn|Url)Output/;

 for (const [key, value] of Object.entries(outputs)) {
Expand Down

4 changes: 2 additions & 2 deletions
src/cli/commands/add/__tests__/add-gateway.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -167,9 +167,9 @@ describe('add gateway command', () => {
 'client1',
 '--allowed-scopes',
 'scope1,scope2',
 '--agent-client-id',
 '--client-id',
 'agent-cid',
 '--agent-client-secret',
 '--client-secret',
 'agent-secret',
 '--json',
 ],
Expand Down

142 changes: 111 additions & 31 deletions
src/cli/commands/add/__tests__/validate.test.ts

View file


Open in desktop

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

 // AC11: CUSTOM_JWT requires discoveryUrl and allowedClients (allowedAudience is optional)
 // AC11: CUSTOM_JWT requires discoveryUrl; at least one of allowedAudience/allowedClients/allowedScopes
 it('returns error for CUSTOM_JWT missing required fields', () => {
const jwtFields: { field: keyof AddGatewayOptions; error: string }[] = [
 { field: 'discoveryUrl', error: '--discovery-url is required for CUSTOM_JWT authorizer' },
 { field: 'allowedClients', error: '--allowed-clients is required for CUSTOM_JWT authorizer' },
];
// 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');

 for (const { field, error } of jwtFields) {
 const opts = { ...validGatewayOptionsJwt, [field]: undefined };
 const result = validateAddGatewayOptions(opts);
 expect(result.valid, `Should fail for missing ${String(field)}`).toBe(false);
 expect(result.error).toBe(error);
 }
 // All three optional fields absent fails
 const noneResult = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 allowedAudience: undefined,
 allowedClients: undefined,
 allowedScopes: undefined,
 });
 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'
 );
 });

 // AC11b: allowedAudience is optional
Expand All@@ -255,11 +260,86 @@ describe('validate', () => {
 expect(result.error?.includes('.well-known/openid-configuration')).toBeTruthy();
 });

 // AC13: Empty comma-separated clients rejected (audience can be empty)
 it('returns error for empty clients', () => {
 const result = validateAddGatewayOptions({ ...validGatewayOptionsJwt, allowedClients: ' , ' });
 // 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,
 allowedAudience: ' ',
 allowedClients: undefined,
 allowedScopes: undefined,
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe(
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer'
 );
 });

 // 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).toBe('At least one client value is required');
 expect(result.error).toContain('Invalid custom claim at index 0');
 });

 // AC14: Valid options pass
Expand All@@ -268,42 +348,42 @@ describe('validate', () => {
 expect(validateAddGatewayOptions(validGatewayOptionsJwt)).toEqual({ valid: true });
 });

 // AC15: agentClientId and agentClientSecret must be provided together
 it('returns error when agentClientId provided without agentClientSecret', () => {
 // AC15: clientId and clientSecret must be provided together
 it('returns error when clientId provided without clientSecret', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
agentClientId: 'my-client-id',
clientId: 'my-client-id',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('Both --agent-client-id and --agent-client-secret must be provided together');
 expect(result.error).toBe('Both --client-id and --client-secret must be provided together');
 });

 it('returns error when agentClientSecret provided without agentClientId', () => {
 it('returns error when clientSecret provided without clientId', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
agentClientSecret: 'my-secret',
clientSecret: 'my-secret',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('Both --agent-client-id and --agent-client-secret must be provided together');
 expect(result.error).toBe('Both --client-id and --client-secret must be provided together');
 });

 // AC16: agent credentials only valid with CUSTOM_JWT
 it('returns error when agent 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,
agentClientId: 'my-client-id',
agentClientSecret: 'my-secret',
clientId: 'my-client-id',
clientSecret: 'my-secret',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('Agent OAuth credentials are only valid with CUSTOM_JWT authorizer');
 expect(result.error).toBe('OAuth client credentials are only valid with CUSTOM_JWT authorizer');
 });

 // AC17: valid CUSTOM_JWT with agent credentials passes
 it('passes for CUSTOM_JWT with agent credentials', () => {
 // AC17: valid CUSTOM_JWT with OAuth client credentials passes
 it('passes for CUSTOM_JWT with OAuth client credentials', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
agentClientId: 'my-client-id',
agentClientSecret: 'my-secret',
clientId: 'my-client-id',
clientSecret: 'my-secret',
 allowedScopes: 'scope1,scope2',
 });
 expect(result.valid).toBe(true);
Expand Down

5 changes: 3 additions & 2 deletions
src/cli/commands/add/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,8 +34,9 @@ export interface AddGatewayOptions {
 allowedAudience?: string;
 allowedClients?: string;
 allowedScopes?: string;
 agentClientId?: string;
 agentClientSecret?: string;
 customClaims?: string;
 clientId?: string;
 clientSecret?: string;
 agents?: string;
 semanticSearch?: boolean;
 exceptionLevel?: string;
Expand Down

59 changes: 41 additions & 18 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@@ -230,7 +231,10 @@ export function validateAddGatewayOptions(options: AddGatewayOptions): Validatio
 }

 try {
 new URL(options.discoveryUrl);
 const url = new URL(options.discoveryUrl);
 if (url.protocol !== 'https:') {
 return { valid: false, error: 'Discovery URL must use HTTPS' };
 }
 } catch {
 return { valid: false, error: 'Discovery URL must be a valid URL' };
 }
Expand All@@ -239,30 +243,49 @@ export function validateAddGatewayOptions(options: AddGatewayOptions): Validatio
 return { valid: false, error: `Discovery URL must end with ${OIDC_WELL_KNOWN_SUFFIX}` };
 }

 // allowedAudience is optional - empty means no audience validation

 if (!options.allowedClients) {
 return { valid: false, error: '--allowed-clients is required for CUSTOM_JWT authorizer' };
 // 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}` };
 }
 }
 }

 const clients = options.allowedClients
 .split(',')
 .map(s => s.trim())
 .filter(Boolean);
 if (clients.length === 0) {
 return { valid: false, error: 'At least one client value is required' };
 // 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();
 const hasClaims = !!options.customClaims?.trim();
 if (!hasAudience && !hasClients && !hasScopes && !hasClaims) {
 return {
 valid: false,
 error:
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer',
 };
 }
 }

 // Validate agent OAuth credentials
 if (options.agentClientId && !options.agentClientSecret) {
 return { valid: false, error: 'Both --agent-client-id and --agent-client-secret must be provided together' };
 // Validate OAuth client credentials
 if (options.clientId && !options.clientSecret) {
 return { valid: false, error: 'Both --client-id and --client-secret must be provided together' };
 }
 if (options.agentClientSecret && !options.agentClientId) {
 return { valid: false, error: 'Both --agent-client-id and --agent-client-secret must be provided together' };
 if (options.clientSecret && !options.clientId) {
 return { valid: false, error: 'Both --client-id and --client-secret must be provided together' };
 }
 if (options.agentClientId && options.authorizerType !== 'CUSTOM_JWT') {
 return { valid: false, error: 'Agent OAuth credentials are only valid with CUSTOM_JWT authorizer' };
 if (options.clientId && options.authorizerType !== 'CUSTOM_JWT') {
 return { valid: false, error: 'OAuth client credentials are only valid with CUSTOM_JWT authorizer' };
 }

 // Validate exception level if provided
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 JWT inbound auth for MCP gateways#596

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

 Closed

aidandaly24
wants to merge
1
commit into

from

 Closed


feat(gateway): add Custom JWT inbound auth for MCP gateways
#596
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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/.
 */

2 changes: 1 addition & 1 deletion
src/cli/cloudformation/outputs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,7 +52,7 @@ export function parseGatewayOutputs(
 const gatewayNames = Object.keys(gatewaySpecs);
 const gatewayIdMap = new Map(gatewayNames.map(name => [toPascalId(name), name]));

 // Match patterns: Gateway{Name}{Type}Output
 // Match patterns: Gateway{Name}{Type}Output{Hash}
 const outputPattern = /^Gateway(.+?)(Id|Arn|Url)Output/;

 for (const [key, value] of Object.entries(outputs)) {
Expand Down

4 changes: 2 additions & 2 deletions
src/cli/commands/add/__tests__/add-gateway.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -167,9 +167,9 @@ describe('add gateway command', () => {
 'client1',
 '--allowed-scopes',
 'scope1,scope2',
 '--agent-client-id',
 '--client-id',
 'agent-cid',
 '--agent-client-secret',
 '--client-secret',
 'agent-secret',
 '--json',
 ],
Expand Down

142 changes: 111 additions & 31 deletions
src/cli/commands/add/__tests__/validate.test.ts

View file


Open in desktop

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

 // AC11: CUSTOM_JWT requires discoveryUrl and allowedClients (allowedAudience is optional)
 // AC11: CUSTOM_JWT requires discoveryUrl; at least one of allowedAudience/allowedClients/allowedScopes
 it('returns error for CUSTOM_JWT missing required fields', () => {
const jwtFields: { field: keyof AddGatewayOptions; error: string }[] = [
 { field: 'discoveryUrl', error: '--discovery-url is required for CUSTOM_JWT authorizer' },
 { field: 'allowedClients', error: '--allowed-clients is required for CUSTOM_JWT authorizer' },
];
// 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');

 for (const { field, error } of jwtFields) {
 const opts = { ...validGatewayOptionsJwt, [field]: undefined };
 const result = validateAddGatewayOptions(opts);
 expect(result.valid, `Should fail for missing ${String(field)}`).toBe(false);
 expect(result.error).toBe(error);
 }
 // All three optional fields absent fails
 const noneResult = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 allowedAudience: undefined,
 allowedClients: undefined,
 allowedScopes: undefined,
 });
 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'
 );
 });

 // AC11b: allowedAudience is optional
Expand All@@ -255,11 +260,86 @@ describe('validate', () => {
 expect(result.error?.includes('.well-known/openid-configuration')).toBeTruthy();
 });

 // AC13: Empty comma-separated clients rejected (audience can be empty)
 it('returns error for empty clients', () => {
 const result = validateAddGatewayOptions({ ...validGatewayOptionsJwt, allowedClients: ' , ' });
 // 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,
 allowedAudience: ' ',
 allowedClients: undefined,
 allowedScopes: undefined,
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe(
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer'
 );
 });

 // 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).toBe('At least one client value is required');
 expect(result.error).toContain('Invalid custom claim at index 0');
 });

 // AC14: Valid options pass
Expand All@@ -268,42 +348,42 @@ describe('validate', () => {
 expect(validateAddGatewayOptions(validGatewayOptionsJwt)).toEqual({ valid: true });
 });

 // AC15: agentClientId and agentClientSecret must be provided together
 it('returns error when agentClientId provided without agentClientSecret', () => {
 // AC15: clientId and clientSecret must be provided together
 it('returns error when clientId provided without clientSecret', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
agentClientId: 'my-client-id',
clientId: 'my-client-id',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('Both --agent-client-id and --agent-client-secret must be provided together');
 expect(result.error).toBe('Both --client-id and --client-secret must be provided together');
 });

 it('returns error when agentClientSecret provided without agentClientId', () => {
 it('returns error when clientSecret provided without clientId', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
agentClientSecret: 'my-secret',
clientSecret: 'my-secret',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('Both --agent-client-id and --agent-client-secret must be provided together');
 expect(result.error).toBe('Both --client-id and --client-secret must be provided together');
 });

 // AC16: agent credentials only valid with CUSTOM_JWT
 it('returns error when agent 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,
agentClientId: 'my-client-id',
agentClientSecret: 'my-secret',
clientId: 'my-client-id',
clientSecret: 'my-secret',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('Agent OAuth credentials are only valid with CUSTOM_JWT authorizer');
 expect(result.error).toBe('OAuth client credentials are only valid with CUSTOM_JWT authorizer');
 });

 // AC17: valid CUSTOM_JWT with agent credentials passes
 it('passes for CUSTOM_JWT with agent credentials', () => {
 // AC17: valid CUSTOM_JWT with OAuth client credentials passes
 it('passes for CUSTOM_JWT with OAuth client credentials', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
agentClientId: 'my-client-id',
agentClientSecret: 'my-secret',
clientId: 'my-client-id',
clientSecret: 'my-secret',
 allowedScopes: 'scope1,scope2',
 });
 expect(result.valid).toBe(true);
Expand Down

5 changes: 3 additions & 2 deletions
src/cli/commands/add/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,8 +34,9 @@ export interface AddGatewayOptions {
 allowedAudience?: string;
 allowedClients?: string;
 allowedScopes?: string;
 agentClientId?: string;
 agentClientSecret?: string;
 customClaims?: string;
 clientId?: string;
 clientSecret?: string;
 agents?: string;
 semanticSearch?: boolean;
 exceptionLevel?: string;
Expand Down

59 changes: 41 additions & 18 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@@ -230,7 +231,10 @@ export function validateAddGatewayOptions(options: AddGatewayOptions): Validatio
 }

 try {
 new URL(options.discoveryUrl);
 const url = new URL(options.discoveryUrl);
 if (url.protocol !== 'https:') {
 return { valid: false, error: 'Discovery URL must use HTTPS' };
 }
 } catch {
 return { valid: false, error: 'Discovery URL must be a valid URL' };
 }
Expand All@@ -239,30 +243,49 @@ export function validateAddGatewayOptions(options: AddGatewayOptions): Validatio
 return { valid: false, error: `Discovery URL must end with ${OIDC_WELL_KNOWN_SUFFIX}` };
 }

 // allowedAudience is optional - empty means no audience validation

 if (!options.allowedClients) {
 return { valid: false, error: '--allowed-clients is required for CUSTOM_JWT authorizer' };
 // 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}` };
 }
 }
 }

 const clients = options.allowedClients
 .split(',')
 .map(s => s.trim())
 .filter(Boolean);
 if (clients.length === 0) {
 return { valid: false, error: 'At least one client value is required' };
 // 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();
 const hasClaims = !!options.customClaims?.trim();
 if (!hasAudience && !hasClients && !hasScopes && !hasClaims) {
 return {
 valid: false,
 error:
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer',
 };
 }
 }

 // Validate agent OAuth credentials
 if (options.agentClientId && !options.agentClientSecret) {
 return { valid: false, error: 'Both --agent-client-id and --agent-client-secret must be provided together' };
 // Validate OAuth client credentials
 if (options.clientId && !options.clientSecret) {
 return { valid: false, error: 'Both --client-id and --client-secret must be provided together' };
 }
 if (options.agentClientSecret && !options.agentClientId) {
 return { valid: false, error: 'Both --agent-client-id and --agent-client-secret must be provided together' };
 if (options.clientSecret && !options.clientId) {
 return { valid: false, error: 'Both --client-id and --client-secret must be provided together' };
 }
 if (options.agentClientId && options.authorizerType !== 'CUSTOM_JWT') {
 return { valid: false, error: 'Agent OAuth credentials are only valid with CUSTOM_JWT authorizer' };
 if (options.clientId && options.authorizerType !== 'CUSTOM_JWT') {
 return { valid: false, error: 'OAuth client credentials are only valid with CUSTOM_JWT authorizer' };
 }

 // Validate exception level if provided
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 JWT inbound auth for MCP gateways#596

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

 Closed

aidandaly24
wants to merge
1
commit into

from

 Closed


feat(gateway): add Custom JWT inbound auth for MCP gateways
#596
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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/.
 */

2 changes: 1 addition & 1 deletion
src/cli/cloudformation/outputs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,7 +52,7 @@ export function parseGatewayOutputs(
 const gatewayNames = Object.keys(gatewaySpecs);
 const gatewayIdMap = new Map(gatewayNames.map(name => [toPascalId(name), name]));

 // Match patterns: Gateway{Name}{Type}Output
 // Match patterns: Gateway{Name}{Type}Output{Hash}
 const outputPattern = /^Gateway(.+?)(Id|Arn|Url)Output/;

 for (const [key, value] of Object.entries(outputs)) {
Expand Down

4 changes: 2 additions & 2 deletions
src/cli/commands/add/__tests__/add-gateway.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -167,9 +167,9 @@ describe('add gateway command', () => {
 'client1',
 '--allowed-scopes',
 'scope1,scope2',
 '--agent-client-id',
 '--client-id',
 'agent-cid',
 '--agent-client-secret',
 '--client-secret',
 'agent-secret',
 '--json',
 ],
Expand Down

142 changes: 111 additions & 31 deletions
src/cli/commands/add/__tests__/validate.test.ts

View file


Open in desktop

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

 // AC11: CUSTOM_JWT requires discoveryUrl and allowedClients (allowedAudience is optional)
 // AC11: CUSTOM_JWT requires discoveryUrl; at least one of allowedAudience/allowedClients/allowedScopes
 it('returns error for CUSTOM_JWT missing required fields', () => {
const jwtFields: { field: keyof AddGatewayOptions; error: string }[] = [
 { field: 'discoveryUrl', error: '--discovery-url is required for CUSTOM_JWT authorizer' },
 { field: 'allowedClients', error: '--allowed-clients is required for CUSTOM_JWT authorizer' },
];
// 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');

 for (const { field, error } of jwtFields) {
 const opts = { ...validGatewayOptionsJwt, [field]: undefined };
 const result = validateAddGatewayOptions(opts);
 expect(result.valid, `Should fail for missing ${String(field)}`).toBe(false);
 expect(result.error).toBe(error);
 }
 // All three optional fields absent fails
 const noneResult = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 allowedAudience: undefined,
 allowedClients: undefined,
 allowedScopes: undefined,
 });
 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'
 );
 });

 // AC11b: allowedAudience is optional
Expand All@@ -255,11 +260,86 @@ describe('validate', () => {
 expect(result.error?.includes('.well-known/openid-configuration')).toBeTruthy();
 });

 // AC13: Empty comma-separated clients rejected (audience can be empty)
 it('returns error for empty clients', () => {
 const result = validateAddGatewayOptions({ ...validGatewayOptionsJwt, allowedClients: ' , ' });
 // 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,
 allowedAudience: ' ',
 allowedClients: undefined,
 allowedScopes: undefined,
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe(
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer'
 );
 });

 // 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).toBe('At least one client value is required');
 expect(result.error).toContain('Invalid custom claim at index 0');
 });

 // AC14: Valid options pass
Expand All@@ -268,42 +348,42 @@ describe('validate', () => {
 expect(validateAddGatewayOptions(validGatewayOptionsJwt)).toEqual({ valid: true });
 });

 // AC15: agentClientId and agentClientSecret must be provided together
 it('returns error when agentClientId provided without agentClientSecret', () => {
 // AC15: clientId and clientSecret must be provided together
 it('returns error when clientId provided without clientSecret', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
agentClientId: 'my-client-id',
clientId: 'my-client-id',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('Both --agent-client-id and --agent-client-secret must be provided together');
 expect(result.error).toBe('Both --client-id and --client-secret must be provided together');
 });

 it('returns error when agentClientSecret provided without agentClientId', () => {
 it('returns error when clientSecret provided without clientId', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
agentClientSecret: 'my-secret',
clientSecret: 'my-secret',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('Both --agent-client-id and --agent-client-secret must be provided together');
 expect(result.error).toBe('Both --client-id and --client-secret must be provided together');
 });

 // AC16: agent credentials only valid with CUSTOM_JWT
 it('returns error when agent 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,
agentClientId: 'my-client-id',
agentClientSecret: 'my-secret',
clientId: 'my-client-id',
clientSecret: 'my-secret',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('Agent OAuth credentials are only valid with CUSTOM_JWT authorizer');
 expect(result.error).toBe('OAuth client credentials are only valid with CUSTOM_JWT authorizer');
 });

 // AC17: valid CUSTOM_JWT with agent credentials passes
 it('passes for CUSTOM_JWT with agent credentials', () => {
 // AC17: valid CUSTOM_JWT with OAuth client credentials passes
 it('passes for CUSTOM_JWT with OAuth client credentials', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
agentClientId: 'my-client-id',
agentClientSecret: 'my-secret',
clientId: 'my-client-id',
clientSecret: 'my-secret',
 allowedScopes: 'scope1,scope2',
 });
 expect(result.valid).toBe(true);
Expand Down

5 changes: 3 additions & 2 deletions
src/cli/commands/add/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,8 +34,9 @@ export interface AddGatewayOptions {
 allowedAudience?: string;
 allowedClients?: string;
 allowedScopes?: string;
 agentClientId?: string;
 agentClientSecret?: string;
 customClaims?: string;
 clientId?: string;
 clientSecret?: string;
 agents?: string;
 semanticSearch?: boolean;
 exceptionLevel?: string;
Expand Down

59 changes: 41 additions & 18 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@@ -230,7 +231,10 @@ export function validateAddGatewayOptions(options: AddGatewayOptions): Validatio
 }

 try {
 new URL(options.discoveryUrl);
 const url = new URL(options.discoveryUrl);
 if (url.protocol !== 'https:') {
 return { valid: false, error: 'Discovery URL must use HTTPS' };
 }
 } catch {
 return { valid: false, error: 'Discovery URL must be a valid URL' };
 }
Expand All@@ -239,30 +243,49 @@ export function validateAddGatewayOptions(options: AddGatewayOptions): Validatio
 return { valid: false, error: `Discovery URL must end with ${OIDC_WELL_KNOWN_SUFFIX}` };
 }

 // allowedAudience is optional - empty means no audience validation

 if (!options.allowedClients) {
 return { valid: false, error: '--allowed-clients is required for CUSTOM_JWT authorizer' };
 // 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}` };
 }
 }
 }

 const clients = options.allowedClients
 .split(',')
 .map(s => s.trim())
 .filter(Boolean);
 if (clients.length === 0) {
 return { valid: false, error: 'At least one client value is required' };
 // 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();
 const hasClaims = !!options.customClaims?.trim();
 if (!hasAudience && !hasClients && !hasScopes && !hasClaims) {
 return {
 valid: false,
 error:
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer',
 };
 }
 }

 // Validate agent OAuth credentials
 if (options.agentClientId && !options.agentClientSecret) {
 return { valid: false, error: 'Both --agent-client-id and --agent-client-secret must be provided together' };
 // Validate OAuth client credentials
 if (options.clientId && !options.clientSecret) {
 return { valid: false, error: 'Both --client-id and --client-secret must be provided together' };
 }
 if (options.agentClientSecret && !options.agentClientId) {
 return { valid: false, error: 'Both --agent-client-id and --agent-client-secret must be provided together' };
 if (options.clientSecret && !options.clientId) {
 return { valid: false, error: 'Both --client-id and --client-secret must be provided together' };
 }
 if (options.agentClientId && options.authorizerType !== 'CUSTOM_JWT') {
 return { valid: false, error: 'Agent OAuth credentials are only valid with CUSTOM_JWT authorizer' };
 if (options.clientId && options.authorizerType !== 'CUSTOM_JWT') {
 return { valid: false, error: 'OAuth client credentials are only valid with CUSTOM_JWT authorizer' };
 }

 // Validate exception level if provided
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 JWT inbound auth for MCP gateways#596

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

 Closed

aidandaly24
wants to merge
1
commit into

from

 Closed


feat(gateway): add Custom JWT inbound auth for MCP gateways
#596
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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/.
 */

2 changes: 1 addition & 1 deletion
src/cli/cloudformation/outputs.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -52,7 +52,7 @@ export function parseGatewayOutputs(
 const gatewayNames = Object.keys(gatewaySpecs);
 const gatewayIdMap = new Map(gatewayNames.map(name => [toPascalId(name), name]));

 // Match patterns: Gateway{Name}{Type}Output
 // Match patterns: Gateway{Name}{Type}Output{Hash}
 const outputPattern = /^Gateway(.+?)(Id|Arn|Url)Output/;

 for (const [key, value] of Object.entries(outputs)) {
Expand Down

4 changes: 2 additions & 2 deletions
src/cli/commands/add/__tests__/add-gateway.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -167,9 +167,9 @@ describe('add gateway command', () => {
 'client1',
 '--allowed-scopes',
 'scope1,scope2',
 '--agent-client-id',
 '--client-id',
 'agent-cid',
 '--agent-client-secret',
 '--client-secret',
 'agent-secret',
 '--json',
 ],
Expand Down

142 changes: 111 additions & 31 deletions
src/cli/commands/add/__tests__/validate.test.ts

View file


Open in desktop

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

 // AC11: CUSTOM_JWT requires discoveryUrl and allowedClients (allowedAudience is optional)
 // AC11: CUSTOM_JWT requires discoveryUrl; at least one of allowedAudience/allowedClients/allowedScopes
 it('returns error for CUSTOM_JWT missing required fields', () => {
const jwtFields: { field: keyof AddGatewayOptions; error: string }[] = [
 { field: 'discoveryUrl', error: '--discovery-url is required for CUSTOM_JWT authorizer' },
 { field: 'allowedClients', error: '--allowed-clients is required for CUSTOM_JWT authorizer' },
];
// 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');

 for (const { field, error } of jwtFields) {
 const opts = { ...validGatewayOptionsJwt, [field]: undefined };
 const result = validateAddGatewayOptions(opts);
 expect(result.valid, `Should fail for missing ${String(field)}`).toBe(false);
 expect(result.error).toBe(error);
 }
 // All three optional fields absent fails
 const noneResult = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
 allowedAudience: undefined,
 allowedClients: undefined,
 allowedScopes: undefined,
 });
 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'
 );
 });

 // AC11b: allowedAudience is optional
Expand All@@ -255,11 +260,86 @@ describe('validate', () => {
 expect(result.error?.includes('.well-known/openid-configuration')).toBeTruthy();
 });

 // AC13: Empty comma-separated clients rejected (audience can be empty)
 it('returns error for empty clients', () => {
 const result = validateAddGatewayOptions({ ...validGatewayOptionsJwt, allowedClients: ' , ' });
 // 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,
 allowedAudience: ' ',
 allowedClients: undefined,
 allowedScopes: undefined,
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe(
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer'
 );
 });

 // 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).toBe('At least one client value is required');
 expect(result.error).toContain('Invalid custom claim at index 0');
 });

 // AC14: Valid options pass
Expand All@@ -268,42 +348,42 @@ describe('validate', () => {
 expect(validateAddGatewayOptions(validGatewayOptionsJwt)).toEqual({ valid: true });
 });

 // AC15: agentClientId and agentClientSecret must be provided together
 it('returns error when agentClientId provided without agentClientSecret', () => {
 // AC15: clientId and clientSecret must be provided together
 it('returns error when clientId provided without clientSecret', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
agentClientId: 'my-client-id',
clientId: 'my-client-id',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('Both --agent-client-id and --agent-client-secret must be provided together');
 expect(result.error).toBe('Both --client-id and --client-secret must be provided together');
 });

 it('returns error when agentClientSecret provided without agentClientId', () => {
 it('returns error when clientSecret provided without clientId', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
agentClientSecret: 'my-secret',
clientSecret: 'my-secret',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('Both --agent-client-id and --agent-client-secret must be provided together');
 expect(result.error).toBe('Both --client-id and --client-secret must be provided together');
 });

 // AC16: agent credentials only valid with CUSTOM_JWT
 it('returns error when agent 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,
agentClientId: 'my-client-id',
agentClientSecret: 'my-secret',
clientId: 'my-client-id',
clientSecret: 'my-secret',
 });
 expect(result.valid).toBe(false);
 expect(result.error).toBe('Agent OAuth credentials are only valid with CUSTOM_JWT authorizer');
 expect(result.error).toBe('OAuth client credentials are only valid with CUSTOM_JWT authorizer');
 });

 // AC17: valid CUSTOM_JWT with agent credentials passes
 it('passes for CUSTOM_JWT with agent credentials', () => {
 // AC17: valid CUSTOM_JWT with OAuth client credentials passes
 it('passes for CUSTOM_JWT with OAuth client credentials', () => {
 const result = validateAddGatewayOptions({
 ...validGatewayOptionsJwt,
agentClientId: 'my-client-id',
agentClientSecret: 'my-secret',
clientId: 'my-client-id',
clientSecret: 'my-secret',
 allowedScopes: 'scope1,scope2',
 });
 expect(result.valid).toBe(true);
Expand Down

5 changes: 3 additions & 2 deletions
src/cli/commands/add/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,8 +34,9 @@ export interface AddGatewayOptions {
 allowedAudience?: string;
 allowedClients?: string;
 allowedScopes?: string;
 agentClientId?: string;
 agentClientSecret?: string;
 customClaims?: string;
 clientId?: string;
 clientSecret?: string;
 agents?: string;
 semanticSearch?: boolean;
 exceptionLevel?: string;
Expand Down

59 changes: 41 additions & 18 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@@ -230,7 +231,10 @@ export function validateAddGatewayOptions(options: AddGatewayOptions): Validatio
 }

 try {
 new URL(options.discoveryUrl);
 const url = new URL(options.discoveryUrl);
 if (url.protocol !== 'https:') {
 return { valid: false, error: 'Discovery URL must use HTTPS' };
 }
 } catch {
 return { valid: false, error: 'Discovery URL must be a valid URL' };
 }
Expand All@@ -239,30 +243,49 @@ export function validateAddGatewayOptions(options: AddGatewayOptions): Validatio
 return { valid: false, error: `Discovery URL must end with ${OIDC_WELL_KNOWN_SUFFIX}` };
 }

 // allowedAudience is optional - empty means no audience validation

 if (!options.allowedClients) {
 return { valid: false, error: '--allowed-clients is required for CUSTOM_JWT authorizer' };
 // 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}` };
 }
 }
 }

 const clients = options.allowedClients
 .split(',')
 .map(s => s.trim())
 .filter(Boolean);
 if (clients.length === 0) {
 return { valid: false, error: 'At least one client value is required' };
 // 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();
 const hasClaims = !!options.customClaims?.trim();
 if (!hasAudience && !hasClients && !hasScopes && !hasClaims) {
 return {
 valid: false,
 error:
 'At least one of --allowed-audience, --allowed-clients, --allowed-scopes, or --custom-claims must be provided for CUSTOM_JWT authorizer',
 };
 }
 }

 // Validate agent OAuth credentials
 if (options.agentClientId && !options.agentClientSecret) {
 return { valid: false, error: 'Both --agent-client-id and --agent-client-secret must be provided together' };
 // Validate OAuth client credentials
 if (options.clientId && !options.clientSecret) {
 return { valid: false, error: 'Both --client-id and --client-secret must be provided together' };
 }
 if (options.agentClientSecret && !options.agentClientId) {
 return { valid: false, error: 'Both --agent-client-id and --agent-client-secret must be provided together' };
 if (options.clientSecret && !options.clientId) {
 return { valid: false, error: 'Both --client-id and --client-secret must be provided together' };
 }
 if (options.agentClientId && options.authorizerType !== 'CUSTOM_JWT') {
 return { valid: false, error: 'Agent OAuth credentials are only valid with CUSTOM_JWT authorizer' };
 if (options.clientId && options.authorizerType !== 'CUSTOM_JWT') {
 return { valid: false, error: 'OAuth client credentials are only valid with CUSTOM_JWT authorizer' };
 }

 // Validate exception level if provided
Expand Down
Loading
Loading