inspector/core/auth/ema/idpOidc.ts
cliffhall 19a6df7ad3 SDK v2 migration (behavior-neutral, versionNegotiation: 'legacy') (#1624)
Migrate all three clients + core + test-servers from
@modelcontextprotocol/sdk@1.29 to SDK v2 (2.0.0-beta.4), keeping behavior
identical against legacy (2025-11-25) servers. Foundation for the SDK V2 +
New Spec stack.

Packages
- Split @modelcontextprotocol/sdk -> @modelcontextprotocol/client (Client,
  transports, OAuth, error taxonomy, protocol types) + core (Zod schemas);
  stdio -> client/stdio, Ajv -> client/validators/ajv. Test-servers ->
  @modelcontextprotocol/server (+ server-legacy/sse). Deterministic import
  rewrite (schemas -> core, everything else -> client); the codemod misroutes
  client code to /server so it was not used for path routing.
- new Client(..., { versionNegotiation: { mode: 'legacy' } }) — nothing
  2026-era goes on the wire.

Runtime (core/mcp/inspectorClient.ts)
- Error taxonomy: McpError -> ProtocolError, ErrorCode -> ProtocolErrorCode;
  RequestTimeout -> SdkError/SdkErrorCode.
- Handlers take method strings; task methods (tasks/*, notifications/tasks/*)
  use the 3-arg custom form (excluded from v2's spec-method set).
- Legacy tasks kept working (per project requirement): requestor tasks re-
  implemented over raw client.request + explicit deprecated schemas;
  experimental.tasks.callToolStream replaced by a local pollTaskToolCall
  async generator (with _progressHandlers revival so task-execution progress
  still reaches the caller). Receiver (server-initiated) tasks: the v2 Client
  validates a sampling/elicit handler result and rejects the legacy { task }
  response with -32602 — installReceiverTaskResponseBypass swaps the wrapped
  entry in the private _requestHandlers map for the task-augmented branch so
  { task } reaches the wire (fixes server-initiated sampling-via-task).
- Pagination: list verbs use raw client.request({method}, List*ResultSchema)
  for single-page behavior (v2's client.listX() auto-aggregate all pages).

Web / auth / apps
- Rename local JsonSchemaType -> InspectorFormSchema + add toFormSchema()
  structural narrowing at the SDK-schema -> form boundary.
- ext-apps still peers on SDK v1: one compat boundary with documented casts
  (remove when ext-apps#702 lands a v2 peer).
- OAuth provider saveClientInformation reconciled with v2's
  OAuthClientInformationContext; InvalidClientMetadataError re-homed as a
  local class (server-legacy/auth is not browser-safe).
- vitest.shared.mts dedupes @modelcontextprotocol/client+core to one copy so
  vi.mock intercepts the SUT's import.

Accepted v2 behavior changes (per #1624 / spec §9.2): unknown-tool call
rejects with -32602; cancellation is stream-abort (no guaranteed
notifications/cancelled frame); output-schema strictness restored via the
Inspector's own Ajv check on the default path.

npm run ci green: validate (web 3087 / cli 212 / tui 274 / launcher 5),
coverage (>=90 per-file, all clients), smoke (launcher/cli/web), storybook
(410).

Closes #1624

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-15 10:44:24 -04:00

228 lines
6.9 KiB
TypeScript

import { discoverAuthorizationServerMetadata, exchangeAuthorization, startAuthorization } from "@modelcontextprotocol/client";
import type { OAuthClientInformation, OAuthMetadata } from "@modelcontextprotocol/client";
import { OAuthMetadataSchema } from "@modelcontextprotocol/core";
import type { OAuthStorage } from "../storage.js";
import type { EnterpriseManagedAuthIdpConfig } from "../../client/types.js";
import { generateOAuthState, parseHttpUrl } from "../utils.js";
import { IDP_OIDC_SCOPES } from "./constants.js";
import { isJwtExpired, jwtExpiresAtMs } from "./jwt.js";
import { idpOAuthStorageKey, normalizeIdpIssuer } from "./storage.js";
import {
parseOAuthTokenErrorResponse,
postOAuthTokenRequest,
} from "./tokenEndpoint.js";
function idpClientInformation(
idp: EnterpriseManagedAuthIdpConfig,
): OAuthClientInformation {
return {
client_id: idp.clientId,
client_secret: idp.clientSecret,
token_endpoint_auth_method: "client_secret_post",
} as OAuthClientInformation;
}
async function resolveIdpMetadata(
issuer: string,
storage: OAuthStorage,
fetchFn?: typeof fetch,
): Promise<OAuthMetadata> {
const storageKey = idpOAuthStorageKey(issuer);
const cached = await storage.getServerMetadata(storageKey);
if (cached?.token_endpoint) {
return cached;
}
return discoverIdpMetadata(issuer, fetchFn);
}
export async function discoverIdpMetadata(
issuer: string,
fetchFn?: typeof fetch,
): Promise<OAuthMetadata> {
const issuerUrl = parseHttpUrl(issuer, "EMA IdP issuer (Client Settings)");
const metadata = await discoverAuthorizationServerMetadata(issuerUrl, {
fetchFn,
});
if (!metadata) {
throw new Error(`Failed to discover OIDC metadata for IdP issuer ${issuer}`);
}
return OAuthMetadataSchema.parse(metadata);
}
export async function startIdpOidcAuthorization(params: {
idp: EnterpriseManagedAuthIdpConfig;
redirectUrl: string;
storage: OAuthStorage;
fetchFn?: typeof fetch;
}): Promise<{ authorizationUrl: URL }> {
const issuer = normalizeIdpIssuer(params.idp.issuer);
const metadata = await resolveIdpMetadata(issuer, params.storage, params.fetchFn);
const clientInformation = idpClientInformation(params.idp);
const storageKey = idpOAuthStorageKey(issuer);
const state = generateOAuthState();
const issuerUrl = parseHttpUrl(issuer, "EMA IdP issuer (Client Settings)");
const { authorizationUrl, codeVerifier } = await startAuthorization(
issuerUrl,
{
metadata,
clientInformation,
redirectUrl: params.redirectUrl,
scope: IDP_OIDC_SCOPES,
state,
},
);
await params.storage.saveCodeVerifier(storageKey, codeVerifier);
await params.storage.savePreregisteredClientInformation(
storageKey,
clientInformation,
);
// Stash IdP metadata for token exchange on callback.
await params.storage.saveServerMetadata(storageKey, metadata);
return { authorizationUrl };
}
export async function completeIdpOidcAuthorization(params: {
idp: EnterpriseManagedAuthIdpConfig;
authorizationCode: string;
redirectUrl: string;
storage: OAuthStorage;
fetchFn?: typeof fetch;
}): Promise<{
idToken: string;
refreshToken?: string;
idTokenExpiresAt?: number;
}> {
const issuer = normalizeIdpIssuer(params.idp.issuer);
const storageKey = idpOAuthStorageKey(issuer);
const metadata = await params.storage.getServerMetadata(storageKey);
if (!metadata) {
throw new Error("IdP OAuth metadata not found — restart EMA IdP login");
}
const clientInformation =
(await params.storage.getClientInformation(storageKey, true)) ??
(await params.storage.getClientInformation(storageKey));
if (!clientInformation) {
throw new Error("IdP client information not found — restart EMA IdP login");
}
const codeVerifier = await params.storage.getCodeVerifier(storageKey);
if (!codeVerifier) {
throw new Error("IdP PKCE verifier not found — restart EMA IdP login");
}
const issuerUrl = parseHttpUrl(issuer, "EMA IdP issuer (Client Settings)");
const tokens = await exchangeAuthorization(issuerUrl, {
metadata,
clientInformation,
authorizationCode: params.authorizationCode,
codeVerifier,
redirectUri: params.redirectUrl,
fetchFn: params.fetchFn,
});
const idToken = tokens.id_token;
if (!idToken) {
throw new Error("IdP token response did not include an ID Token");
}
await params.storage.clearCodeVerifier(storageKey);
const idTokenExpiresAt = jwtExpiresAtMs(idToken);
await params.storage.saveIdpSession(issuer, {
idToken,
refreshToken: tokens.refresh_token,
idTokenExpiresAt,
});
return {
idToken,
refreshToken: tokens.refresh_token,
idTokenExpiresAt,
};
}
/** Redeem a cached IdP refresh token for a new ID Token (OIDC refresh grant). */
export async function refreshIdpOidcSession(params: {
idp: EnterpriseManagedAuthIdpConfig;
storage: OAuthStorage;
fetchFn?: typeof fetch;
}): Promise<string> {
const issuer = normalizeIdpIssuer(params.idp.issuer);
const session = await params.storage.getIdpSession(issuer);
if (!session?.refreshToken) {
throw new Error("IdP refresh token not available");
}
const metadata = await resolveIdpMetadata(
issuer,
params.storage,
params.fetchFn,
);
if (!metadata.token_endpoint) {
throw new Error("IdP metadata missing token_endpoint");
}
const body = new URLSearchParams({
grant_type: "refresh_token",
refresh_token: session.refreshToken,
});
const response = await postOAuthTokenRequest(
parseHttpUrl(
metadata.token_endpoint,
"IdP token_endpoint (from OIDC discovery)",
),
body,
metadata,
idpClientInformation(params.idp),
params.fetchFn,
);
if (!response.ok) {
throw await parseOAuthTokenErrorResponse(
response,
"EMA IdP refresh (OIDC refresh_token grant)",
);
}
const json = (await response.json()) as {
id_token?: string;
refresh_token?: string;
};
const idToken = json.id_token;
if (!idToken) {
throw new Error("IdP refresh did not return an ID Token");
}
await params.storage.saveIdpSession(issuer, {
idToken,
refreshToken: json.refresh_token ?? session.refreshToken,
idTokenExpiresAt: jwtExpiresAtMs(idToken),
});
return idToken;
}
/**
* Returns a non-expired IdP ID Token from storage, refreshing via refresh_token
* when the cached ID Token has expired but a refresh token remains.
*/
export async function getValidIdToken(params: {
idp: EnterpriseManagedAuthIdpConfig;
storage: OAuthStorage;
fetchFn?: typeof fetch;
}): Promise<string | undefined> {
const issuer = normalizeIdpIssuer(params.idp.issuer);
const session = await params.storage.getIdpSession(issuer);
if (!session?.idToken) {
return undefined;
}
if (!isJwtExpired(session.idToken)) {
return session.idToken;
}
if (!session.refreshToken) {
return undefined;
}
try {
return await refreshIdpOidcSession(params);
} catch {
return undefined;
}
}