Remove the ServerOptions from the ServerProtocolHandlerInterface. Thi…

…s comes from the container if needed.
FreeDSx · Aug 6, 2023 · c1d5243 · c1d5243
1 parent 4fe9628
commit c1d5243
Show file tree

Hide file tree

Showing 26 changed files with 166 additions and 118 deletions.
diff --git a/src/FreeDSx/Ldap/Container.php b/src/FreeDSx/Ldap/Container.php
@@ -25,6 +25,7 @@
 use FreeDSx\Ldap\Server\RequestHistory;
 use FreeDSx\Ldap\Server\ServerProtocolFactory;
 use FreeDSx\Ldap\Server\ServerRunner\PcntlServerRunner;
+use FreeDSx\Ldap\Server\ServerRunner\ServerRunnerInterface;
 use FreeDSx\Ldap\Server\SocketServerFactory;
 use FreeDSx\Socket\SocketPool;
 
@@ -145,8 +146,8 @@ className: ServerProtocolFactory::class,
             factory: $this->makeServerProtocolFactory(...),
         );
         $this->registerFactory(
-            className: PcntlServerRunner::class,
-            factory: $this->makePcntlServerRunner(...),
+            className: ServerRunnerInterface::class,
+            factory: $this->makeServerRunner(...),
         );
         $this->registerFactory(
             className: ServerAuthorization::class,
@@ -197,8 +198,10 @@ private function makeRootDseLoader(): RootDseLoader
     private function makeServerProtocolFactory(): ServerProtocolFactory
     {
         return new ServerProtocolFactory(
-            $this->get(HandlerFactory::class),
-            $this->get(ServerOptions::class),
+            handlerFactory: $this->get(HandlerFactoryInterface::class),
+            logger: $this->get(ServerOptions::class)->getLogger(),
+            serverProtocolHandlerFactory: $this->get(ServerProtocolHandlerFactory::class),
+            serverAuthorization: $this->get(ServerAuthorization::class),
         );
     }
 
@@ -207,11 +210,11 @@ private function makeHandlerFactory(): HandlerFactory
         return new HandlerFactory($this->get(ServerOptions::class));
     }
 
-    private function makePcntlServerRunner(): PcntlServerRunner
+    private function makeServerRunner(): ServerRunnerInterface
     {
         return new PcntlServerRunner(
-            $this->get(ServerProtocolFactory::class),
-            $this->get(ServerOptions::class)->getLogger(),
+            serverProtocolFactory: $this->get(ServerProtocolFactory::class),
+            logger: $this->get(ServerOptions::class)->getLogger(),
         );
     }
 
@@ -220,8 +223,8 @@ private function makeSocketServerFactory(): SocketServerFactory
         $serverOptions = $this->get(ServerOptions::class);
 
         return new SocketServerFactory(
-            $serverOptions,
-            $serverOptions->getLogger(),
+            options: $serverOptions,
+            logger: $serverOptions->getLogger(),
         );
     }
 
@@ -233,8 +236,9 @@ private function makeServerAuthorizer(): ServerAuthorization
     private function makeServerProtocolHandlerFactory(): ServerProtocolHandlerFactory
     {
         return new ServerProtocolHandlerFactory(
-            $this->get(HandlerFactoryInterface::class),
-            new RequestHistory()
+            handlerFactory: $this->get(HandlerFactoryInterface::class),
+            options: $this->get(ServerOptions::class),
+            requestHistory: new RequestHistory(),
         );
     }
 }
diff --git a/src/FreeDSx/Ldap/LdapServer.php b/src/FreeDSx/Ldap/LdapServer.php
@@ -13,7 +13,6 @@
 
 namespace FreeDSx\Ldap;
 
-use FreeDSx\Ldap\Server\LoggerTrait;
 use FreeDSx\Ldap\Server\RequestHandler\PagingHandlerInterface;
 use FreeDSx\Ldap\Server\RequestHandler\ProxyHandler;
 use FreeDSx\Ldap\Server\RequestHandler\ProxyPagingHandler;
@@ -31,8 +30,6 @@
  */
 class LdapServer
 {
-    use LoggerTrait;
-
     private Container $container;
 
     public function __construct(

diff --git a/src/FreeDSx/Ldap/Protocol/Factory/ServerProtocolHandlerFactory.php b/src/FreeDSx/Ldap/Protocol/Factory/ServerProtocolHandlerFactory.php
@@ -23,6 +23,7 @@
 use FreeDSx\Ldap\Protocol\ServerProtocolHandler\ServerProtocolHandlerInterface;
 use FreeDSx\Ldap\Server\HandlerFactoryInterface;
 use FreeDSx\Ldap\Server\RequestHistory;
+use FreeDSx\Ldap\ServerOptions;
 
 /**
  * Determines the correct handler for the request.
@@ -31,16 +32,11 @@
  */
 class ServerProtocolHandlerFactory
 {
-    private HandlerFactoryInterface $handlerFactory;
-
-    private RequestHistory $requestHistory;
-
     public function __construct(
-        HandlerFactoryInterface $handlerFactory,
-        RequestHistory $requestHistory
+        private readonly HandlerFactoryInterface $handlerFactory,
+        private readonly ServerOptions $options,
+        private readonly RequestHistory $requestHistory,
     ) {
-        $this->handlerFactory = $handlerFactory;
-        $this->requestHistory = $requestHistory;
     }
 
     public function get(
@@ -50,7 +46,7 @@ public function get(
         if ($request instanceof ExtendedRequest && $request->getName() === ExtendedRequest::OID_WHOAMI) {
             return new ServerProtocolHandler\ServerWhoAmIHandler();
         } elseif ($request instanceof ExtendedRequest && $request->getName() === ExtendedRequest::OID_START_TLS) {
-            return new ServerProtocolHandler\ServerStartTlsHandler();
+            return new ServerProtocolHandler\ServerStartTlsHandler($this->options);
         } elseif ($this->isRootDseSearch($request)) {
             return $this->getRootDseHandler();
         } elseif ($this->isPagingSearch($request, $controls)) {
@@ -86,7 +82,10 @@ private function getRootDseHandler(): ServerProtocolHandler\ServerRootDseHandler
     {
         $rootDseHandler = $this->handlerFactory->makeRootDseHandler();
 
-        return new ServerProtocolHandler\ServerRootDseHandler($rootDseHandler);
+        return new ServerProtocolHandler\ServerRootDseHandler(
+            $this->options,
+            $rootDseHandler,
+        );
     }
 
     private function getPagingHandler(): ServerProtocolHandlerInterface

diff --git a/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler.php b/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler.php
@@ -170,8 +170,7 @@ private function dispatchRequest(LdapMessageRequest $message): void
                 $message,
                 $this->authorizer->getToken(),
                 $this->handlerFactory->makeRequestHandler(),
-                $this->queue,
-                $this->options
+                $this->queue
             );
         # Authentication is required, but they have not authenticated...
         } else {

diff --git a/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerDispatchHandler.php b/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerDispatchHandler.php
@@ -22,7 +22,6 @@
 use FreeDSx\Ldap\Server\RequestContext;
 use FreeDSx\Ldap\Server\RequestHandler\RequestHandlerInterface;
 use FreeDSx\Ldap\Server\Token\TokenInterface;
-use FreeDSx\Ldap\ServerOptions;
 
 /**
  * Handles generic requests that can be sent to the user supplied dispatcher / handler.
@@ -40,8 +39,7 @@ public function handleRequest(
         LdapMessageRequest $message,
         TokenInterface $token,
         RequestHandlerInterface $dispatcher,
-        ServerQueue $queue,
-        ServerOptions $options
+        ServerQueue $queue
     ): void {
         $context = new RequestContext($message->controls(), $token);
         $request = $message->getRequest();

diff --git a/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerPagingHandler.php b/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerPagingHandler.php
@@ -30,7 +30,6 @@
 use FreeDSx\Ldap\Server\RequestHandler\RequestHandlerInterface;
 use FreeDSx\Ldap\Server\RequestHistory;
 use FreeDSx\Ldap\Server\Token\TokenInterface;
-use FreeDSx\Ldap\ServerOptions;
 use Throwable;
 
 /**
@@ -66,8 +65,7 @@ public function handleRequest(
         LdapMessageRequest $message,
         TokenInterface $token,
         RequestHandlerInterface $dispatcher,
-        ServerQueue $queue,
-        ServerOptions $options
+        ServerQueue $queue
     ): void {
         $context = new RequestContext(
             $message->controls(),

diff --git a/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerPagingUnsupportedHandler.php b/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerPagingUnsupportedHandler.php
@@ -20,7 +20,6 @@
 use FreeDSx\Ldap\Server\RequestContext;
 use FreeDSx\Ldap\Server\RequestHandler\RequestHandlerInterface;
 use FreeDSx\Ldap\Server\Token\TokenInterface;
-use FreeDSx\Ldap\ServerOptions;
 
 /**
  * Determines whether we can page results if no paging handler is defined.
@@ -38,8 +37,7 @@ public function handleRequest(
         LdapMessageRequest $message,
         TokenInterface $token,
         RequestHandlerInterface $dispatcher,
-        ServerQueue $queue,
-        ServerOptions $options
+        ServerQueue $queue
     ): void {
         $context = new RequestContext(
             $message->controls(),

diff --git a/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerProtocolHandlerInterface.php b/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerProtocolHandlerInterface.php
@@ -18,7 +18,6 @@
 use FreeDSx\Ldap\Protocol\Queue\ServerQueue;
 use FreeDSx\Ldap\Server\RequestHandler\RequestHandlerInterface;
 use FreeDSx\Ldap\Server\Token\TokenInterface;
-use FreeDSx\Ldap\ServerOptions;
 use FreeDSx\Socket\Exception\ConnectionException;
 
 /**
@@ -32,7 +31,6 @@ interface ServerProtocolHandlerInterface
     /**
      * Handle protocol actions specific to the request received.
      *
-     * @param ServerOptions $options
      * @throws OperationException
      * @throws ConnectionException
      */
@@ -41,6 +39,5 @@ public function handleRequest(
         TokenInterface $token,
         RequestHandlerInterface $dispatcher,
         ServerQueue $queue,
-        ServerOptions $options
     ): void;
 }
diff --git a/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerRootDseHandler.php b/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerRootDseHandler.php
@@ -38,8 +38,10 @@
  */
 class ServerRootDseHandler implements ServerProtocolHandlerInterface
 {
-    public function __construct(private ?RootDseHandlerInterface $rootDseHandler = null)
-    {
+    public function __construct(
+        private readonly ServerOptions $options,
+        private readonly ?RootDseHandlerInterface $rootDseHandler = null
+    ) {
     }
 
     /**
@@ -50,34 +52,33 @@ public function handleRequest(
         LdapMessageRequest $message,
         TokenInterface $token,
         RequestHandlerInterface $dispatcher,
-        ServerQueue $queue,
-        ServerOptions $options
+        ServerQueue $queue
     ): void {
         $entry = Entry::fromArray('', [
-            'namingContexts' => $options->getDseNamingContexts(),
+            'namingContexts' => $this->options->getDseNamingContexts(),
             'supportedExtension' => [
                 ExtendedRequest::OID_WHOAMI,
             ],
             'supportedLDAPVersion' => ['3'],
-            'vendorName' => $options->getDseVendorName(),
+            'vendorName' => $this->options->getDseVendorName(),
         ]);
-        if ($options->getSslCert()) {
+        if ($this->options->getSslCert()) {
             $entry->add(
                 'supportedExtension',
                 ExtendedRequest::OID_START_TLS
             );
         }
-        if ($options->getPagingHandler()) {
+        if ($this->options->getPagingHandler()) {
             $entry->add(
                 'supportedControl',
                 Control::OID_PAGING
             );
         }
-        if ($options->getDseVendorVersion()) {
-            $entry->set('vendorVersion', (string) $options->getDseVendorVersion());
+        if ($this->options->getDseVendorVersion()) {
+            $entry->set('vendorVersion', (string) $this->options->getDseVendorVersion());
         }
-        if ($options->getDseAltServer()) {
-            $entry->set('altServer', (string) $options->getDseAltServer());
+        if ($this->options->getDseAltServer()) {
+            $entry->set('altServer', (string) $this->options->getDseAltServer());
         }
 
         /** @var SearchRequest $request */

diff --git a/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerSearchHandler.php b/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerSearchHandler.php
@@ -19,7 +19,6 @@
 use FreeDSx\Ldap\Server\RequestContext;
 use FreeDSx\Ldap\Server\RequestHandler\RequestHandlerInterface;
 use FreeDSx\Ldap\Server\Token\TokenInterface;
-use FreeDSx\Ldap\ServerOptions;
 
 /**
  * Handles search request logic.
@@ -37,8 +36,7 @@ public function handleRequest(
         LdapMessageRequest $message,
         TokenInterface $token,
         RequestHandlerInterface $dispatcher,
-        ServerQueue $queue,
-        ServerOptions $options
+        ServerQueue $queue
     ): void {
         $context = new RequestContext(
             $message->controls(),

diff --git a/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerStartTlsHandler.php b/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerStartTlsHandler.php
@@ -36,7 +36,7 @@ class ServerStartTlsHandler implements ServerProtocolHandlerInterface
 {
     private static ?bool $hasOpenssl = null;
 
-    public function __construct()
+    public function __construct(private readonly ServerOptions $options)
     {
         if (self::$hasOpenssl === null) {
             $this::$hasOpenssl = extension_loaded('openssl');
@@ -52,11 +52,10 @@ public function handleRequest(
         LdapMessageRequest $message,
         TokenInterface $token,
         RequestHandlerInterface $dispatcher,
-        ServerQueue $queue,
-        ServerOptions $options
+        ServerQueue $queue
     ): void {
         # If we don't have a SSL cert or the OpenSSL extension is not available, then we can do nothing...
-        if ($options->getSslCert() === null || !self::$hasOpenssl) {
+        if ($this->options->getSslCert() === null || !self::$hasOpenssl) {
             $queue->sendMessage(new LdapMessageResponse($message->getMessageId(), new ExtendedResponse(
                 new LdapResult(ResultCode::PROTOCOL_ERROR),
                 ExtendedRequest::OID_START_TLS

diff --git a/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerUnbindHandler.php b/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerUnbindHandler.php
@@ -17,7 +17,6 @@
 use FreeDSx\Ldap\Protocol\Queue\ServerQueue;
 use FreeDSx\Ldap\Server\RequestHandler\RequestHandlerInterface;
 use FreeDSx\Ldap\Server\Token\TokenInterface;
-use FreeDSx\Ldap\ServerOptions;
 
 /**
  * Handles an un-bind. Which just closes the connection.
@@ -33,8 +32,7 @@ public function handleRequest(
         LdapMessageRequest $message,
         TokenInterface $token,
         RequestHandlerInterface $dispatcher,
-        ServerQueue $queue,
-        ServerOptions $options
+        ServerQueue $queue
     ): void {
         $queue->close();
     }

diff --git a/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerWhoAmIHandler.php b/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerWhoAmIHandler.php
@@ -24,7 +24,6 @@
 use FreeDSx\Ldap\Protocol\Queue\ServerQueue;
 use FreeDSx\Ldap\Server\RequestHandler\RequestHandlerInterface;
 use FreeDSx\Ldap\Server\Token\TokenInterface;
-use FreeDSx\Ldap\ServerOptions;
 
 /**
  * Handles a whoami request.
@@ -41,8 +40,7 @@ public function handleRequest(
         LdapMessageRequest $message,
         TokenInterface $token,
         RequestHandlerInterface $dispatcher,
-        ServerQueue $queue,
-        ServerOptions $options
+        ServerQueue $queue
     ): void {
         $userId = $token->getUsername();
 

diff --git a/src/FreeDSx/Ldap/Server/ServerProtocolFactory.php b/src/FreeDSx/Ldap/Server/ServerProtocolFactory.php
@@ -17,15 +17,14 @@
 use FreeDSx\Ldap\Protocol\Queue\ServerQueue;
 use FreeDSx\Ldap\Protocol\ServerAuthorization;
 use FreeDSx\Ldap\Protocol\ServerProtocolHandler;
-use FreeDSx\Ldap\Server\RequestHandler\HandlerFactory;
 use FreeDSx\Socket\Socket;
 use Psr\Log\LoggerInterface;
 
 class ServerProtocolFactory
 {
     public function __construct(
-        private readonly HandlerFactory $handlerFactory,
-        private readonly LoggerInterface $logger,
+        private readonly HandlerFactoryInterface $handlerFactory,
+        private readonly ?LoggerInterface $logger,
         private readonly ServerProtocolHandlerFactory $serverProtocolHandlerFactory,
         private readonly ServerAuthorization $serverAuthorization,
     ) {

diff --git a/tests/integration/FreeDSx/Ldap/ServerTestCase.php b/tests/integration/FreeDSx/Ldap/ServerTestCase.php
@@ -61,9 +61,10 @@ protected function waitForServerOutput(string $marker): string
         }
 
         throw new Exception(sprintf(
-            'The expected output (%s) was not received after %d seconds.',
+            'The expected output (%s) was not received after %d seconds. Received: %s',
             $marker,
-            $i
+            $i,
+            PHP_EOL . $this->subject->getErrorOutput()
         ));
     }