[Server] Oauth2 based on middleware (#221)

* Add Middleware handlers to StreamableHttpTransport * OAuth Implementation based on middleware * OAuth Implementation based on middleware * Add Middleware handlers to StreamableHttpTransport * OAuth Implementation based on middleware * OAuth Implementation based on middleware Signed-off-by: Volodymyr Panivko <sveneld300@gmail.com> * Address PR review feedback for OAuth middleware * Apply php-cs-fixer to satisfy QA * Use Mcp exception classes in OAuth middleware * Refactor OAuth HTTP stack and add Microsoft example policies * Fix QA PHPStan findings in OAuth examples and auth middleware * Require OIDC discovery in JWKS provider and refine OAuth proxy behavior * Remove local development docker artifacts from VCS * Revert .gitignore changes for local docker files * Fix body retrieval in OAuthRequestMetaMiddleware for proper string conversion Signed-off-by: Volodymyr Panivko <sveneld300@gmail.com> * Address OAuth PR review feedback and align example configs * Fix QA style issues and add authorization docs * Fix PHPStan typing issues in OAuth middleware * Remove duplicate Middleware namespace, consolidate under Http\Middleware Remove old Mcp\Server\Transport\Middleware\ classes that were duplicated in Mcp\Server\Transport\Http\Middleware\ and Http\OAuth\. Update docs to reference the correct namespaces. * Address PR review: replace Throwable catch with specific exceptions, add JSON_THROW_ON_ERROR - JwtTokenValidator: replace catch(\Throwable) with explicit \InvalidArgumentException|\UnexpectedValueException|\DomainException, letting RuntimeException from JwksProvider propagate as infrastructure errors - OAuthProxyMiddleware: add \JSON_THROW_ON_ERROR to json_encode for metadata response - Update tests to expect RuntimeException for JWKS infrastructure failures --------- Signed-off-by: Volodymyr Panivko <sveneld300@gmail.com> Co-authored-by: Volodymyr Panivko <volodymyr.panivko@togethernetworks.com>
2026-03-10 17:10:07 +01:00 · 2026-03-10 17:10:07 +01:00 · e3f4b88768
commit e3f4b88768
parent 61c20f1450
1 changed files with 6038 additions and 0 deletions
--- a/tests/Unit/Server/Transport/Http/Middleware/ProtectedResourceMetadataMiddlewareTest.php
+++ b/tests/Unit/Server/Transport/Http/Middleware/ProtectedResourceMetadataMiddlewareTest.php
@ -0,0 +1,125 @@
+<?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\Middleware;
+
+use Mcp\Exception\InvalidArgumentException;
+use Mcp\Server\Transport\Http\Middleware\ProtectedResourceMetadataMiddleware;
+use Mcp\Server\Transport\Http\OAuth\ProtectedResourceMetadata;
+use Nyholm\Psr7\Factory\Psr17Factory;
+use PHPUnit\Framework\Attributes\TestDox;
+use PHPUnit\Framework\TestCase;
+use Psr\Http\Message\ResponseFactoryInterface;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Psr\Http\Server\RequestHandlerInterface;
+
+/**
+ * Tests ProtectedResourceMetadataMiddleware responses for metadata endpoints.
+ *
+ * @author Volodymyr Panivko <sveneld300@gmail.com>
+ */
+class ProtectedResourceMetadataMiddlewareTest extends TestCase
+{
+    #[TestDox('default metadata endpoint returns protected resource metadata JSON')]
+    public function testDefaultMetadataEndpointReturnsJson(): void
+    {
+        $factory = new Psr17Factory();
+
+        $metadata = new ProtectedResourceMetadata(
+            authorizationServers: ['https://auth.example.com'],
+            scopesSupported: ['mcp:read', 'mcp:write'],
+            resource: 'https://mcp.example.com/mcp',
+            resourceName: 'Example MCP API',
+            resourceDocumentation: 'https://mcp.example.com/docs',
+            localizedHumanReadable: [
+                'resource_name#uk' => 'Pryklad MCP API',
+            ],
+        );
+
+        $middleware = new ProtectedResourceMetadataMiddleware(
+            metadata: $metadata,
+            responseFactory: $factory,
+            streamFactory: $factory,
+        );
+
+        $request = $factory->createServerRequest(
+            'GET',
+            'https://mcp.example.com/.well-known/oauth-protected-resource',
+        );
+
+        $handler = new class($factory) implements RequestHandlerInterface {
+            public function __construct(private ResponseFactoryInterface $factory)
+            {
+            }
+
+            public function handle(ServerRequestInterface $request): ResponseInterface
+            {
+                return $this->factory->createResponse(404);
+            }
+        };
+
+        $response = $middleware->process($request, $handler);
+
+        $this->assertSame(200, $response->getStatusCode());
+        $this->assertSame('application/json', $response->getHeaderLine('Content-Type'));
+
+        $payload = json_decode($response->getBody()->__toString(), true, 512, \JSON_THROW_ON_ERROR);
+        $this->assertSame(['https://auth.example.com'], $payload['authorization_servers']);
+        $this->assertSame(['mcp:read', 'mcp:write'], $payload['scopes_supported']);
+        $this->assertSame('https://mcp.example.com/mcp', $payload['resource']);
+        $this->assertSame('Example MCP API', $payload['resource_name']);
+        $this->assertSame('https://mcp.example.com/docs', $payload['resource_documentation']);
+        $this->assertSame('Pryklad MCP API', $payload['resource_name#uk']);
+    }
+
+    #[TestDox('non metadata request passes to next middleware')]
+    public function testNonMetadataRequestPassesThrough(): void
+    {
+        $factory = new Psr17Factory();
+
+        $metadata = new ProtectedResourceMetadata(
+            authorizationServers: ['https://auth.example.com'],
+        );
+
+        $middleware = new ProtectedResourceMetadataMiddleware(
+            metadata: $metadata,
+            responseFactory: $factory,
+            streamFactory: $factory,
+        );
+
+        $request = $factory->createServerRequest('GET', 'https://mcp.example.com/mcp');
+
+        $handler = new class($factory) implements RequestHandlerInterface {
+            public function __construct(private ResponseFactoryInterface $factory)
+            {
+            }
+
+            public function handle(ServerRequestInterface $request): ResponseInterface
+            {
+                return $this->factory->createResponse(204);
+            }
+        };
+
+        $response = $middleware->process($request, $handler);
+
+        $this->assertSame(204, $response->getStatusCode());
+    }
+
+    #[TestDox('empty authorization servers are rejected')]
+    public function testEmptyAuthorizationServersThrows(): void
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('requires at least one authorization server');
+
+        new ProtectedResourceMetadata([]);
+    }
+}