php-sdk/tests/Unit/Server/Transport/Http/OAuth/LenientOidcDiscoveryMetadataPolicyTest.php
simon chrzanowski 863cfc1e78
[Server] feat: relax StrictOidcDiscoveryMetadataPolicy and add Dynamic Client Registration middleware (RFC 7591) (#269)
* feat: relax OIDC discovery policy and add Dynamic Client Registration middleware (RFC 7591)

- Add LenientOidcDiscoveryMetadataPolicy for providers that omit
  code_challenge_methods_supported (e.g. FusionAuth, Microsoft Entra ID)
- Keep StrictOidcDiscoveryMetadataPolicy RFC-aligned
- Add ClientRegistrationMiddleware handling POST /register and enriching
  /.well-known/oauth-authorization-server with registration_endpoint
- Update Microsoft example to use built-in LenientOidcDiscoveryMetadataPolicy

* fix: move metadata policy note under server.php in Files section

Address review comment: the LenientOidcDiscoveryMetadataPolicy bullet
was a behavioral note, not a file entry. Inline it into the server.php
description to keep the Files list consistent.

* fix: address Copilot review comments on ClientRegistrationMiddleware

- Decode JSON with assoc=true for registrar data so nested objects
  are associative arrays, not stdClass instances
- Add Cache-Control: no-store to all error responses (400), not just
  the success response (201)
- Rewind response body stream before returning unmodified response
  when metadata is not valid JSON, preventing empty body on read

* fix: harden ClientRegistrationMiddleware and improve test coverage

- Revert spurious .gitignore trailing newline
- Use JSON_THROW_ON_ERROR consistently in enrichAuthServerMetadata()
- Add comment clarifying the second json_decode in handleRegistration()
- Assert Cache-Control: no-store on registrar exception error response
- Add test for non-object JSON body in metadata enrichment path
- Extract createPlainTextHandler helper for non-JSON response tests

* fix: reject JSON array bodies in metadata enrichment

Treat JSON list arrays (e.g. [] or ["..."]) as invalid metadata in
enrichAuthServerMetadata() to prevent corrupting the response shape
by adding registration_endpoint to a non-object.

* fix: add RFC 7591 error codes, Content-Type validation, and docblock safety warning

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Christopher Hertel <mail@christopher-hertel.de>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-11 17:27:27 +02:00

125 lines
4.4 KiB
PHP

<?php
/*
* This file is part of the official PHP MCP SDK.
*
* A collaboration between Symfony and the PHP Foundation.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Mcp\Tests\Unit\Server\Transport\Http\OAuth;
use Mcp\Server\Transport\Http\OAuth\LenientOidcDiscoveryMetadataPolicy;
use PHPUnit\Framework\Attributes\TestDox;
use PHPUnit\Framework\TestCase;
/**
* Tests LenientOidcDiscoveryMetadataPolicy validation behavior.
*
* @author Simon Chrzanowski <simon.chrzanowski@quentic.com>
*/
class LenientOidcDiscoveryMetadataPolicyTest extends TestCase
{
#[TestDox('metadata without code challenge methods is valid (defaults to S256 downstream)')]
public function testMissingCodeChallengeMethodsIsValid(): void
{
$policy = new LenientOidcDiscoveryMetadataPolicy();
$metadata = [
'authorization_endpoint' => 'https://auth.example.com/authorize',
'token_endpoint' => 'https://auth.example.com/token',
'jwks_uri' => 'https://auth.example.com/jwks',
];
$this->assertTrue($policy->isValid($metadata));
}
#[TestDox('valid code challenge methods list is accepted')]
public function testValidCodeChallengeMethodsIsAccepted(): void
{
$policy = new LenientOidcDiscoveryMetadataPolicy();
$metadata = [
'authorization_endpoint' => 'https://auth.example.com/authorize',
'token_endpoint' => 'https://auth.example.com/token',
'jwks_uri' => 'https://auth.example.com/jwks',
'code_challenge_methods_supported' => ['S256'],
];
$this->assertTrue($policy->isValid($metadata));
}
#[TestDox('empty code challenge methods list is invalid')]
public function testEmptyCodeChallengeMethodsIsInvalid(): void
{
$policy = new LenientOidcDiscoveryMetadataPolicy();
$metadata = [
'authorization_endpoint' => 'https://auth.example.com/authorize',
'token_endpoint' => 'https://auth.example.com/token',
'jwks_uri' => 'https://auth.example.com/jwks',
'code_challenge_methods_supported' => [],
];
$this->assertFalse($policy->isValid($metadata));
}
#[TestDox('non string code challenge method is invalid')]
public function testNonStringCodeChallengeMethodIsInvalid(): void
{
$policy = new LenientOidcDiscoveryMetadataPolicy();
$metadata = [
'authorization_endpoint' => 'https://auth.example.com/authorize',
'token_endpoint' => 'https://auth.example.com/token',
'jwks_uri' => 'https://auth.example.com/jwks',
'code_challenge_methods_supported' => ['S256', 123],
];
$this->assertFalse($policy->isValid($metadata));
}
#[TestDox('missing required fields is invalid')]
public function testMissingRequiredFieldsIsInvalid(): void
{
$policy = new LenientOidcDiscoveryMetadataPolicy();
$this->assertFalse($policy->isValid([
'authorization_endpoint' => 'https://auth.example.com/authorize',
'token_endpoint' => 'https://auth.example.com/token',
// missing jwks_uri
]));
}
#[TestDox('empty string endpoint is invalid')]
public function testEmptyStringEndpointIsInvalid(): void
{
$policy = new LenientOidcDiscoveryMetadataPolicy();
$this->assertFalse($policy->isValid([
'authorization_endpoint' => '',
'token_endpoint' => 'https://auth.example.com/token',
'jwks_uri' => 'https://auth.example.com/jwks',
]));
}
#[TestDox('null code challenge methods is invalid')]
public function testNullCodeChallengeMethodsIsInvalid(): void
{
$policy = new LenientOidcDiscoveryMetadataPolicy();
$metadata = [
'authorization_endpoint' => 'https://auth.example.com/authorize',
'token_endpoint' => 'https://auth.example.com/token',
'jwks_uri' => 'https://auth.example.com/jwks',
'code_challenge_methods_supported' => null,
];
$this->assertFalse($policy->isValid($metadata));
}
#[TestDox('non-array input is invalid')]
public function testNonArrayInputIsInvalid(): void
{
$policy = new LenientOidcDiscoveryMetadataPolicy();
$this->assertFalse($policy->isValid('not an array'));
}
}