Support for SSL encrypted connection to Redis. (#5007)

Co-authored-by: 李铭昕 <[email protected]>

Author: her-cat

publish/redis.php

@@ -18,6 +18,7 @@
         'timeout' => 0.0,
         'reserved' => null,
         'retry_interval' => 0,
+        'read_timeout' => 0.0,
         'cluster' => [
             'enable' => (bool) env('REDIS_CLUSTER_ENABLE', false),
             'name' => null,

src/RedisConnection.php

@@ -34,12 +34,16 @@ class RedisConnection extends BaseConnection implements ConnectionInterface
         'auth' => null,
         'db' => 0,
         'timeout' => 0.0,
+        'reserved' => null,
+        'retry_interval' => 0,
+        'read_timeout' => 0.0,
         'cluster' => [
             'enable' => false,
             'name' => null,
             'seeds' => [],
             'read_timeout' => 0.0,
             'persistent' => false,
+            'context' => [],
         ],
         'sentinel' => [
             'enable' => false,
@@ -49,6 +53,7 @@ class RedisConnection extends BaseConnection implements ConnectionInterface
             'read_timeout' => 0,
         ],
         'options' => [],
+        'context' => [],
     ];
 
     /**
@@ -88,20 +93,21 @@ public function getActiveConnection()
         return $this;
     }
 
+    /**
+     * @throws \RedisException
+     * @throws ConnectionException
+     */
     public function reconnect(): bool
     {
-        $host = $this->config['host'];
-        $port = $this->config['port'];
         $auth = $this->config['auth'];
         $db = $this->config['db'];
-        $timeout = $this->config['timeout'];
         $cluster = $this->config['cluster']['enable'] ?? false;
         $sentinel = $this->config['sentinel']['enable'] ?? false;
 
         $redis = match (true) {
             $cluster => $this->createRedisCluster(),
             $sentinel => $this->createRedisSentinel(),
-            default => $this->createRedis($host, $port, $timeout),
+            default => $this->createRedis($this->config),
         };
 
         $options = $this->config['options'] ?? [];
@@ -160,6 +166,9 @@ protected function createRedisCluster(): \RedisCluster
             if (isset($this->config['auth'])) {
                 $parameters[] = $this->config['auth'];
             }
+            if (! empty($this->config['cluster']['context'])) {
+                $parameters[] = $this->config['cluster']['context'];
+            }
 
             $redis = new \RedisCluster(...$parameters);
         } catch (\Throwable $e) {
@@ -185,6 +194,9 @@ protected function retry($name, $arguments, \Throwable $exception)
         return $result;
     }
 
+    /**
+     * @throws ConnectionException
+     */
     protected function createRedisSentinel(): \Redis
     {
         try {
@@ -227,7 +239,13 @@ protected function createRedisSentinel(): \Redis
                 throw new InvalidRedisConnectionException('Connect sentinel redis server failed.');
             }
 
-            $redis = $this->createRedis($host, $port, $timeout);
+            $redis = $this->createRedis([
+                'host' => $host,
+                'port' => $port,
+                'timeout' => $timeout,
+                'retry_interval' => $retryInterval,
+                'read_timeout' => $readTimeout,
+            ]);
         } catch (\Throwable $e) {
             throw new ConnectionException('Connection reconnect failed ' . $e->getMessage());
         }
@@ -236,14 +254,26 @@ protected function createRedisSentinel(): \Redis
     }
 
     /**
-     * @param string $host
-     * @param int $port
-     * @param float $timeout
+     * @throws ConnectionException
+     * @throws \RedisException
      */
-    protected function createRedis($host, $port, $timeout): \Redis
+    protected function createRedis(array $config): \Redis
     {
+        $parameters = [
+            $config['host'] ?? '',
+            $config['port'] ?? 6379,
+            $config['timeout'] ?? 0.0,
+            $config['reserved'] ?? null,
+            $config['retry_interval'] ?? 0,
+            $config['read_timeout'] ?? 0.0,
+        ];
+
+        if (! empty($config['context'])) {
+            $parameters[] = $config['context'];
+        }
+
         $redis = new \Redis();
-        if (! $redis->connect((string) $host, (int) $port, $timeout)) {
+        if (! $redis->connect(...$parameters)) {
             throw new ConnectionException('Connection reconnect failed.');
         }
         return $redis;

src/RedisProxy.php

@@ -25,6 +25,12 @@ public function __construct(PoolFactory $factory, string $pool)
         $this->poolName = $pool;
     }
 
+    /**
+     * WARN: Can't remove this function, because AOP need it.
+     * @see https://github.com/hyperf/hyperf/issues/1239
+     * @param string $name
+     * @param array $arguments
+     */
     public function __call($name, $arguments)
     {
         return parent::__call($name, $arguments);

tests/RedisConnectionTest.php

@@ -46,6 +46,9 @@ public function testRedisConnectionConfig()
             'auth' => 'redis',
             'db' => 0,
             'timeout' => 0.0,
+            'reserved' => null,
+            'retry_interval' => 5,
+            'read_timeout' => 3.0,
             'cluster' => [
                 'enable' => false,
                 'name' => null,
@@ -54,6 +57,9 @@ public function testRedisConnectionConfig()
                 ],
                 'read_timeout' => 0.0,
                 'persistent' => false,
+                'context' => [
+                    'stream' => ['cafile' => 'foo-cafile', 'verify_peer' => true],
+                ],
             ],
             'sentinel' => [
                 'enable' => false,
@@ -63,6 +69,9 @@ public function testRedisConnectionConfig()
                 'read_timeout' => 0,
             ],
             'options' => [],
+            'context' => [
+                'stream' => ['cafile' => 'foo-cafile', 'verify_peer' => true],
+            ],
             'pool' => [
                 'min_connections' => 1,
                 'max_connections' => 30,
@@ -122,6 +131,12 @@ private function getRedisPool()
                     'host' => 'redis',
                     'auth' => 'redis',
                     'port' => 16379,
+                    'read_timeout' => 3.0,
+                    'reserved' => null,
+                    'retry_interval' => 5,
+                    'context' => [
+                        'stream' => ['cafile' => 'foo-cafile', 'verify_peer' => true],
+                    ],
                     'pool' => [
                         'min_connections' => 1,
                         'max_connections' => 30,
@@ -136,6 +151,9 @@ private function getRedisPool()
                         'seeds' => [
                             '127.0.0.1:6379',
                         ],
+                        'context' => [
+                            'stream' => ['cafile' => 'foo-cafile', 'verify_peer' => true],
+                        ],
                     ],
                     'sentinel' => [
                         'enable' => false,

tests/RedisTest.php

@@ -54,7 +54,7 @@ public function testRedisConnect()
         $this->assertSame('timeout', $timeout->getName());
         $this->assertSame('retry_interval', $retryInterval->getName());
 
-        $this->assertTrue($redis->connect('127.0.0.1', 6379, 0.0));
+        $this->assertTrue($redis->connect('127.0.0.1', 6379, 0.0, null, 0, 0));
     }
 
     public function testRedisSelect()