Skip to content

add support for TLS configuration for Redis Store #1828

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tvdijen merged 1 commit into from
Jul 26, 2023
Merged

add support for TLS configuration for Redis Store #1828

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions config/config.php.dist
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1226,6 +1226,28 @@ $config = [
'store.redis.username' => '',
'store.redis.password' => '',

/*
* Communicate with Redis over a secure connection instead of plain TCP.
*
* This setting affects both single host connections as
* well as Sentinel mode.
*/
'store.redis.tls' => false,

/*
* Verify the Redis server certificate.
*/
'store.redis.insecure' => false,

/*
* Files related to secure communication with Redis.
*
* Files are searched in the 'certdir' when using relative paths.
*/
'store.redis.ca_certificate' => null,
'store.redis.certificate' => null,
'store.redis.privatekey' => null,

/*
* The prefix we should use on our Redis datastore.
*/
Expand All @@ -1244,6 +1266,9 @@ $config = [
* 'tcp://[yoursentinel2]:[port]',
* 'tcp://[yoursentinel3]:[port]
* ],
*
* Use 'tls' instead of 'tcp' in order to make use of the additional
* TLS settings.
*/
'store.redis.sentinels' => [],

Expand Down
32 changes: 30 additions & 2 deletions src/SimpleSAML/Store/RedisStore.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

use Predis\Client;
use SimpleSAML\Assert\Assert;
use SimpleSAML\{Configuration, Error};
use SimpleSAML\{Configuration, Error, Utils};

use function class_exists;
use function serialize;
Expand Down Expand Up @@ -45,17 +45,44 @@ public function __construct(Client $redis = null)
$password = $config->getOptionalString('store.redis.password', null);
$username = $config->getOptionalString('store.redis.username', null);
$database = $config->getOptionalInteger('store.redis.database', 0);
$tls = $config->getOptionalBoolean('store.redis.tls', false);
$scheme = $tls ? 'tls' : 'tcp';
$ssl = [];

$sentinels = $config->getOptionalArray('store.redis.sentinels', []);

if ($tls) {
$configUtils = new Utils\Config();

if ($config->getOptionalBoolean('store.redis.insecure', false)) {
$ssl['verify_peer'] = false;
$ssl['verify_peer_name'] = false;
} else {
$ca = $config->getOptionalString('store.redis.ca_certificate', null);

if ($ca !== null) {
$ssl['cafile'] = $configUtils->getCertPath($ca);
}
}

$cert = $config->getOptionalString('store.redis.certificate', null);
$key = $config->getOptionalString('store.redis.privatekey', null);

if ($cert !== null && $key !== null) {
$ssl['local_cert'] = $configUtils->getCertPath($cert);
$ssl['local_pk'] = $configUtils->getCertPath($key);
}
}

if (empty($sentinels)) {
$redis = new Client(
[
'scheme' => 'tcp',
'scheme' => $scheme,
'host' => $host,
'port' => $port,
'database' => $database,
]
+ (!empty($ssl) ? ['ssl' => $ssl] : [])
+ (!empty($username) ? ['username' => $username] : [])
+ (!empty($password) ? ['password' => $password] : []),
[
Expand All @@ -73,6 +100,7 @@ public function __construct(Client $redis = null)
'parameters' => [
'database' => $database,
]
+ (!empty($ssl) ? ['ssl' => $ssl] : [])
+ (!empty($username) ? ['username' => $username] : [])
+ (!empty($password) ? ['password' => $password] : []),
]
Expand Down
31 changes: 31 additions & 0 deletions tests/src/SimpleSAML/Store/RedisStoreTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,37 @@ public function testRedisInstance(): void
$this->assertInstanceOf(Store\RedisStore::class, $this->store);
}

/**
* @test
*/
public function testRedisInstanceWithInsecureTLS(): void
{
$config = Configuration::loadFromArray([
'store.type' => 'redis',
'store.redis.prefix' => 'phpunit_',
'store.redis.tls' => true,
'store.redis.insecure' => true,
], '[ARRAY]', 'simplesaml');

$this->assertInstanceOf(Store\RedisStore::class, $this->store);
}

/**
* @test
*/
public function testRedisInstanceWithSecureTLS(): void
{
$config = Configuration::loadFromArray([
'store.type' => 'redis',
'store.redis.prefix' => 'phpunit_',
'store.redis.tls' => true,
'store.redis.ca_certificate' => '/tmp/ssl/pki_roots.crt.pem',
'store.redis.certificate' => '/tmp/ssl/phpunit.crt.pem',
'store.redis.privatekey' => '/tmp/ssl/phpunit.key.pem',
], '[ARRAY]', 'simplesaml');

$this->assertInstanceOf(Store\RedisStore::class, $this->store);
}

/**
* @test
Expand Down