updated driver configuration to allow for ssl override

Author: transistive

src/Databags/DriverConfiguration.php

@@ -28,30 +28,29 @@ final class DriverConfiguration
 {
     public const DEFAULT_USER_AGENT = 'neo4j-php-client/%s';
 
-    /** @var string|null */
-    private $userAgent;
+    private ?string $userAgent;
     /** @var pure-callable():(HttpPsrBindings|null)|HttpPsrBindings|null */
     private $httpPsrBindings;
+    private SslConfiguration $sslConfig;
 
     /**
-     * @param string|null                                                 $userAgent
      * @param pure-callable():(HttpPsrBindings|null)|HttpPsrBindings|null $httpPsrBindings
      */
-    public function __construct($userAgent, $httpPsrBindings)
+    public function __construct(?string $userAgent, $httpPsrBindings, SslConfiguration $sslConfig)
     {
         $this->userAgent = $userAgent;
         $this->httpPsrBindings = $httpPsrBindings;
+        $this->sslConfig = $sslConfig;
     }
 
     /**
-     * @pure
-     *
-     * @param string|null                                                 $userAgent
      * @param pure-callable():(HttpPsrBindings|null)|HttpPsrBindings|null $httpPsrBindings
+     *
+     * @pure
      */
-    public static function create($userAgent, $httpPsrBindings): self
+    public static function create(?string $userAgent, $httpPsrBindings, SslConfiguration $sslConfig): self
     {
-        return new self($userAgent, $httpPsrBindings);
+        return new self($userAgent, $httpPsrBindings, $sslConfig);
     }
 
     /**
@@ -62,10 +61,7 @@ public static function create($userAgent, $httpPsrBindings): self
      */
     public static function default(): self
     {
-        return new self(
-            self::DEFAULT_USER_AGENT,
-            HttpPsrBindings::default()
-        );
+        return new self(self::DEFAULT_USER_AGENT, HttpPsrBindings::default(), SslConfiguration::default());
     }
 
     public function getUserAgent(): string
@@ -91,7 +87,10 @@ public function getUserAgent(): string
      */
     public function withUserAgent($userAgent): self
     {
-        return new self($userAgent, $this->httpPsrBindings);
+        $tbr = clone $this;
+        $tbr->userAgent = $userAgent;
+
+        return $tbr;
     }
 
     /**
@@ -101,7 +100,23 @@ public function withUserAgent($userAgent): self
      */
     public function withHttpPsrBindings($bindings): self
     {
-        return new self($this->userAgent, $bindings);
+        $tbr = clone $this;
+        $tbr->httpPsrBindings = $bindings;
+
+        return $tbr;
+    }
+
+    public function withSslConfiguration(SslConfiguration $config): self
+    {
+        $tbr = clone $this;
+        $tbr->sslConfig = $config;
+
+        return $tbr;
+    }
+
+    public function getSslConfiguration(): SslConfiguration
+    {
+        return $this->sslConfig;
     }
 
     public function getHttpPsrBindings(): HttpPsrBindings

src/Databags/SslConfiguration.php

@@ -0,0 +1,72 @@
+<?php
+
+/*
+ * This file is part of the Laudis Neo4j package.
+ *
+ * (c) Laudis technologies <http://laudis.tech>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Laudis\Neo4j\Databags;
+
+use Laudis\Neo4j\Enum\SslMode;
+
+/**
+ * @psalm-immutable
+ */
+final class SslConfiguration
+{
+    private SslMode $mode;
+    private bool $verifyPeer;
+
+    public function __construct(SslMode $mode, bool $verifyPeer)
+    {
+        $this->mode = $mode;
+        $this->verifyPeer = $verifyPeer;
+    }
+
+    public function getMode(): SslMode
+    {
+        return $this->mode;
+    }
+
+    public function isVerifyPeer(): bool
+    {
+        return $this->verifyPeer;
+    }
+
+    /**
+     * @pure
+     */
+    public static function create(SslMode $mode, bool $verifyPeer): self
+    {
+        return new self($mode, $verifyPeer);
+    }
+
+    /**
+     * @pure
+     */
+    public static function default(): self
+    {
+        /** @psalm-suppress ImpureMethodCall */
+        return self::create(SslMode::FROM_URL(), true);
+    }
+
+    public function withMode(SslMode $mode): self
+    {
+        $tbr = clone $this;
+        $tbr->mode = $mode;
+
+        return $tbr;
+    }
+
+    public function withVerifyPeer(bool $verify): self
+    {
+        $tbr = clone $this;
+        $tbr->verifyPeer = $verify;
+
+        return $tbr;
+    }
+}

src/Enum/SslMode.php

@@ -0,0 +1,57 @@
+<?php
+
+/*
+ * This file is part of the Laudis Neo4j package.
+ *
+ * (c) Laudis technologies <http://laudis.tech>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Laudis\Neo4j\Enum;
+
+use const E_DEPRECATED;
+use function error_reporting;
+use JsonSerializable;
+use Laudis\TypedEnum\TypedEnum;
+
+/**
+ * Turn of error reporting for class definition. PHP Users of 8.1 receive a deprectation warning otherwise but
+ * it is not fixable from the minimum version 7.4 as it required the "mixed" keyword.
+ */
+$oldReporting = error_reporting(error_reporting() & ~E_DEPRECATED);
+
+/**
+ * @method static self ENABLE()
+ * @method static self DISABLE()
+ * @method static self FROM_URL()
+ *
+ * @extends TypedEnum<string>
+ *
+ * @psalm-immutable
+ *
+ * @psalm-suppress MutableDependency
+ */
+final class SslMode extends TypedEnum implements JsonSerializable
+{
+    private const ENABLE = 'enable';
+    private const DISABLE = 'disable';
+    private const FROM_URL = 'from_url';
+
+    public function __toString()
+    {
+        /** @noinspection MagicMethodsValidityInspection */
+        return $this->getValue();
+    }
+
+    public function jsonSerialize()
+    {
+        return $this->getValue();
+    }
+}
+
+/**
+ * Turn back on old error reporting after class definition.
+ */
+error_reporting($oldReporting);