feat: add PKCE conformance tests (#119)

* feat: add PKCE conformance tests

Adds conformance checks for PKCE requirements from the MCP auth spec:

- pkce-code-challenge-sent: Verifies client sends code_challenge in auth request
- pkce-s256-method-used: Verifies client uses S256 code challenge method
- pkce-code-verifier-sent: Verifies client sends code_verifier in token request
- pkce-verifier-matches-challenge: Validates BASE64URL(SHA256(verifier)) = challenge

Also adds auth/pkce-no-s256-support scenario that tests clients correctly
refuse when S256 is not in code_challenge_methods_supported.

All PKCE checks are added to the createAuthServer helper, so they automatically
apply to all existing auth scenarios.

Fixes #77

* feat: add bad client example that skips PKCE

Adds auth-test-no-pkce.ts which implements a custom OAuth flow that
deliberately skips PKCE (no code_challenge in auth request, no
code_verifier in token request).

Also adds negative test to verify the conformance suite correctly
detects this non-compliant behavior.

* chore: skip pkce-no-s256-support scenario for now

* chore: fix formatting

* refactor: remove pkce-no-s256-support scenario and always validate PKCE

- Remove pkce-no-s256-support scenario (was skipped anyway)
- Make pkce-verifier-matches-challenge fail if either code_challenge
  or code_verifier is missing, rather than only running when both present
- Update negative test to expect the new failure
This commit is contained in:
Paul Carleton 2026-01-23 18:12:44 +00:00 • committed by GitHub
commit 4a2ba8ae7b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -0,0 +1,173 @@
#!/usr/bin/env node
/**
* Broken client that doesn't use PKCE.
*
* BUG: Skips PKCE entirely - doesn't send code_challenge in authorization
* request and doesn't send code_verifier in token request.
*
* Per MCP spec: "MCP clients MUST implement PKCE according to OAuth 2.1"
*/
import { Client } from '@modelcontextprotocol/sdk/client/index.js';
import { StreamableHTTPClientTransport } from '@modelcontextprotocol/sdk/client/streamableHttp.js';
import { extractWWWAuthenticateParams } from '@modelcontextprotocol/sdk/client/auth.js';
import type { FetchLike } from '@modelcontextprotocol/sdk/shared/transport.js';
import type { Middleware } from '@modelcontextprotocol/sdk/client/middleware.js';
import { runAsCli } from './helpers/cliRunner';
import { logger } from './helpers/logger';
interface OAuthTokens {
access_token: string;
token_type: string;
expires_in?: number;
refresh_token?: string;
scope?: string;
}
/**
* Custom OAuth flow that deliberately skips PKCE.
* This is intentionally broken behavior for conformance testing.
*/
async function oauthFlowWithoutPkce(
_serverUrl: string | URL,
resourceMetadataUrl: string | URL,
fetchFn: FetchLike
): Promise<OAuthTokens> {
// 1. Fetch Protected Resource Metadata
const prmResponse = await fetchFn(resourceMetadataUrl);
if (!prmResponse.ok) {
throw new Error(`Failed to fetch PRM: ${prmResponse.status}`);
}
const prm = await prmResponse.json();
const authServerUrl = prm.authorization_servers?.[0];
if (!authServerUrl) {
throw new Error('No authorization server in PRM');
}
// 2. Fetch Authorization Server Metadata
const asMetadataUrl = new URL(
'/.well-known/oauth-authorization-server',
authServerUrl
);
const asResponse = await fetchFn(asMetadataUrl.toString());
if (!asResponse.ok) {
throw new Error(`Failed to fetch AS metadata: ${asResponse.status}`);
}
const asMetadata = await asResponse.json();
// 3. Register client (DCR)
const dcrResponse = await fetchFn(asMetadata.registration_endpoint, {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
client_name: 'test-auth-client-no-pkce',
redirect_uris: ['http://localhost:3000/callback']
})
});
if (!dcrResponse.ok) {
throw new Error(`DCR failed: ${dcrResponse.status}`);
}
const clientInfo = await dcrResponse.json();
// 4. Build authorization URL WITHOUT PKCE (BUG!)
const authUrl = new URL(asMetadata.authorization_endpoint);
authUrl.searchParams.set('response_type', 'code');
authUrl.searchParams.set('client_id', clientInfo.client_id);
authUrl.searchParams.set('redirect_uri', 'http://localhost:3000/callback');
authUrl.searchParams.set('state', 'test-state');
// BUG: NOT setting code_challenge or code_challenge_method
// 5. Fetch authorization endpoint (simulates redirect)
const authResponse = await fetchFn(authUrl.toString(), {
redirect: 'manual'
});
const location = authResponse.headers.get('location');
if (!location) {
throw new Error('No redirect from authorization endpoint');
}
const redirectUrl = new URL(location);
const authCode = redirectUrl.searchParams.get('code');
if (!authCode) {
throw new Error('No auth code in redirect');
}
// 6. Exchange code for token WITHOUT code_verifier (BUG!)
const tokenResponse = await fetchFn(asMetadata.token_endpoint, {
method: 'POST',
headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
body: new URLSearchParams({
grant_type: 'authorization_code',
code: authCode,
redirect_uri: 'http://localhost:3000/callback',
client_id: clientInfo.client_id
// BUG: NOT sending code_verifier
}).toString()
});
if (!tokenResponse.ok) {
const error = await tokenResponse.text();
throw new Error(`Token request failed: ${tokenResponse.status} - ${error}`);
}
return tokenResponse.json();
}
/**
* Creates a fetch wrapper that uses OAuth without PKCE.
*/
function withOAuthNoPkce(baseUrl: string | URL): Middleware {
let tokens: OAuthTokens | undefined;
return (next: FetchLike) => {
return async (
input: string | URL,
init?: RequestInit
): Promise<Response> => {
const makeRequest = async (): Promise<Response> => {
const headers = new Headers(init?.headers);
if (tokens) {
headers.set('Authorization', `Bearer ${tokens.access_token}`);
}
return next(input, { ...init, headers });
};
let response = await makeRequest();
if (response.status === 401) {
const { resourceMetadataUrl } = extractWWWAuthenticateParams(response);
if (!resourceMetadataUrl) {
throw new Error('No resource_metadata in WWW-Authenticate');
}
tokens = await oauthFlowWithoutPkce(baseUrl, resourceMetadataUrl, next);
response = await makeRequest();
}
return response;
};
};
}
export async function runClient(serverUrl: string): Promise<void> {
const client = new Client(
{ name: 'test-auth-client-no-pkce', version: '1.0.0' },
{ capabilities: {} }
);
const oauthFetch = withOAuthNoPkce(new URL(serverUrl))(fetch);
const transport = new StreamableHTTPClientTransport(new URL(serverUrl), {
fetch: oauthFetch
});
await client.connect(transport);
logger.debug('Successfully connected to MCP server');
await client.listTools();
logger.debug('Successfully listed tools');
await transport.close();
logger.debug('Connection closed successfully');
}
runAsCli(runClient, import.meta.url, 'auth-test-no-pkce <server-url>');