Redis ACL authentication (#124)

thibaultmeyer · web-flow · commit 2a9fb06c2dc2 · 2023-10-09T18:58:10.000+02:00
Signed-off-by: Thibault Meyer &lt;meyer.thibault@gmail.com&gt;
diff --git a/voidframework-redis/src/main/java/dev/voidframework/redis/module/JedisResourceProvider.java b/voidframework-redis/src/main/java/dev/voidframework/redis/module/JedisResourceProvider.java
@@ -32,6 +32,7 @@ public class JedisResourceProvider implements Provider<Jedis> {
     private static final String CONFIGURATION_KEY_CONNECTION_POOL_MAXIMUM_WAIT = "voidframework.redis.connPool.maximumWait";
     private static final String CONFIGURATION_KEY_HOST = "voidframework.redis.host";
     private static final String CONFIGURATION_KEY_PORT = "voidframework.redis.port";
+    private static final String CONFIGURATION_KEY_USERNAME = "voidframework.redis.username";
     private static final String CONFIGURATION_KEY_PASSWORD = "voidframework.redis.password";
 
     private final Config configuration;
@@ -62,6 +63,7 @@ public Jedis get() {
             final Duration maximumWait = this.configuration.getDuration(CONFIGURATION_KEY_CONNECTION_POOL_MAXIMUM_WAIT);
             final String host = this.configuration.getString(CONFIGURATION_KEY_HOST);
             final int port = this.configuration.getInt(CONFIGURATION_KEY_PORT);
+            final String username = this.configuration.getString(CONFIGURATION_KEY_USERNAME);
             final String password = this.configuration.getString(CONFIGURATION_KEY_PASSWORD);
 
             // Checks configuration
@@ -91,7 +93,11 @@ public Jedis get() {
             jedisPoolConfig.setMaxWait(maximumWait);
 
             if (StringUtils.isNotBlank(password)) {
-                this.jedisPool = new JedisPool(jedisPoolConfig, host, port, (int) connectionTimeout, password);
+                if (StringUtils.isBlank(username)) {
+                    this.jedisPool = new JedisPool(jedisPoolConfig, host, port, (int) connectionTimeout, password);
+                } else {
+                    this.jedisPool = new JedisPool(jedisPoolConfig, host, port, (int) connectionTimeout, username, password);
+                }
             } else {
                 this.jedisPool = new JedisPool(jedisPoolConfig, host, port, (int) connectionTimeout);
             }
diff --git a/voidframework-redis/src/main/resources/reference.conf b/voidframework-redis/src/main/resources/reference.conf
@@ -17,6 +17,8 @@ voidframework {
         port = 6379
 
         # Redis authentication
+        # Note: username only works with Redis 6+ ACL-based authentication
+        username = ""
         password = ""
 
         # Defines the database to use by default. Must be a valid # number. Check
diff --git a/voidframework-redis/src/test/java/com/voidframework/redis/RedisTest.java b/voidframework-redis/src/test/java/com/voidframework/redis/RedisTest.java
@@ -630,6 +630,7 @@ private Redis createRedisInstance(final String hostname, final int port) {
             voidframework.core.runInDevMode = true
             voidframework.redis.host = "%s"
             voidframework.redis.port = %d
+            voidframework.redis.username = ""
             voidframework.redis.password = ""
             voidframework.redis.defaultDatabase = 0
             voidframework.redis.connPool.connectionTimeout = "2000 ms"
