Merge branch 'main' into dependabot/maven/org.apache.felix-maven-bundle-plugin-6.0.0

atakavci · web-flow · commit b8660a2e6a81 · 2025-03-11T11:03:24.000+03:00
diff --git a/.github/wordlist.txt b/.github/wordlist.txt
@@ -16,6 +16,8 @@ ClusterPipeline
 ClusterPubSub
 ConnectionPool
 CoreCommands
+Entra
+EntraID
 EVAL
 EVALSHA
 Failback
@@ -30,6 +32,7 @@ GeoRadiusParam
 GeoRadiusStoreParam
 GeoUnit
 GraphCommands
+Gradle
 Grokzen's
 HostAndPort
 HostnameVerifier
@@ -41,6 +44,7 @@ JSONArray
 JSONCommands
 Jaeger
 Javadocs
+Jedis
 ListPosition
 Ludovico
 Magnocavallo
@@ -59,6 +63,7 @@ POJOs
 PubSub
 Queable
 READONLY
+Reauthentication
 RediSearch
 RediSearchCommands
 RedisBloom
diff --git a/.github/workflows/core_integration.yml b/.github/workflows/core_integration.yml
@@ -35,7 +35,7 @@ jobs:
           java-version: '8'
           distribution: 'temurin'
       - name: Cache dependencies
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: |
             ~/.m2/repository
diff --git a/.github/workflows/core_snapshot.yml b/.github/workflows/core_snapshot.yml
@@ -28,7 +28,7 @@
             server-username: MAVEN_USERNAME
             server-password: MAVEN_PASSWORD
         - name: Cache dependencies
-          uses: actions/cache@v2
+          uses: actions/cache@v4
           with:
             path: |
               ~/.m2/repository
diff --git a/.github/workflows/entraid_integration.yml b/.github/workflows/entraid_integration.yml
@@ -34,7 +34,7 @@ jobs:
           java-version: '8'
           distribution: 'temurin'
       - name: Cache dependencies
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: |
             ~/.m2/repository
@@ -64,3 +64,4 @@ jobs:
           AZURE_CERT: ${{secrets.AZURE_CERT}}
           AZURE_PRIVATE_KEY: ${{secrets.AZURE_PRIVATE_KEY}}
           AZURE_REDIS_SCOPES: ${{secrets.AZURE_REDIS_SCOPES}}
+          AZURE_TENANT_ID: ${{secrets.AZURE_TENANT_ID}}
diff --git a/.github/workflows/entraid_snapshot.yml b/.github/workflows/entraid_snapshot.yml
@@ -29,7 +29,7 @@
             server-username: MAVEN_USERNAME
             server-password: MAVEN_PASSWORD
         - name: Cache dependencies
-          uses: actions/cache@v2
+          uses: actions/cache@v4
           with:
             path: |
               ~/.m2/repository
diff --git a/README.md b/README.md
@@ -0,0 +1,31 @@
+# Token-based Authentication Providers for Redis Java clients
+
+This extension provides Token-based Authentication for Redis Java client libraries: [lettuce](https://github.com/redis/lettuce) and [Jedis](https://github.com/redis/jedis)
+
+## Microsoft Entra ID provider
+
+### Installation 
+To install the Entra ID provider, add the following dependencies to your `pom.xml` file if you're using Maven:
+```xml
+<dependency>
+    <groupId>redis.clients.authentication</groupId>
+    <artifactId>redis-authx-entraid</artifactId>
+    <version>0.1.1-beta1</version>
+</dependency>
+```
+If you're using Gradle, add the following dependencies to your `build.gradle` file:
+
+```
+implementation 'redis.clients.authentication:redis-authx-entraid:0.1.1-beta1'
+```
+
+### Quick Start
+Basic usage would look like this:
+```java
+    TokenAuthConfig tokenAuthConfig = EntraIDTokenAuthConfigBuilder.builder()
+        .clientId("YOUR_CLIENT_ID").secret("YOUR_SECRET")
+        .authority("YOUR_AUTHORITY").scopes("SCOPES").build();
+```
+With the `tokenAuthConfig` provided, both Jedis and Lettuce clients can automatically handle Reauthentication with EntraID.
+
+Refer to the [test files](https://github.com/redis/tbd-auth-entraid/tree/main/entraid/src/test/java/redis/clients/authentication) for more examples and detailed usage.
diff --git a/core/src/main/java/redis/clients/authentication/core/Dispatcher.java b/core/src/main/java/redis/clients/authentication/core/Dispatcher.java
@@ -1,5 +1,8 @@
 /*
- * Copyright 2024, Redis Ltd. and Contributors All rights reserved. Licensed under the MIT License.
+ * Copyright 2024, Redis Ltd. and Contributors 
+ * All rights reserved. 
+ * 
+ * Licensed under the MIT License.
  */
 package redis.clients.authentication.core;
 
diff --git a/core/src/main/java/redis/clients/authentication/core/RenewalScheduler.java b/core/src/main/java/redis/clients/authentication/core/RenewalScheduler.java
@@ -1,5 +1,8 @@
 /*
- * Copyright 2024, Redis Ltd. and Contributors All rights reserved. Licensed under the MIT License.
+ * Copyright 2024, Redis Ltd. and Contributors 
+ * All rights reserved. 
+ * 
+ * Licensed under the MIT License.
  */
 package redis.clients.authentication.core;
 
diff --git a/core/src/main/java/redis/clients/authentication/core/TokenManager.java b/core/src/main/java/redis/clients/authentication/core/TokenManager.java
@@ -1,5 +1,8 @@
 /*
- * Copyright 2024, Redis Ltd. and Contributors All rights reserved. Licensed under the MIT License.
+ * Copyright 2024, Redis Ltd. and Contributors 
+ * All rights reserved. 
+ * 
+ * Licensed under the MIT License.
  */
 package redis.clients.authentication.core;
 
diff --git a/entraid/pom.xml b/entraid/pom.xml
@@ -67,6 +67,11 @@
 		<artifactId>msal4j</artifactId>
 		<version>1.17.2</version>
 	</dependency>
+	<dependency>
+		<groupId>com.azure</groupId>
+		<artifactId>azure-identity</artifactId>
+		<version>1.15.3</version>
+	</dependency>
     <dependency>
 		<groupId>junit</groupId>
 		<artifactId>junit</artifactId>
diff --git a/entraid/src/main/java/redis/clients/authentication/entraid/AzureIdentityProvider.java b/entraid/src/main/java/redis/clients/authentication/entraid/AzureIdentityProvider.java
@@ -0,0 +1,68 @@
+/*
+ * Copyright 2024, Redis Ltd. and Contributors 
+ * All rights reserved. 
+ * 
+ * Licensed under the MIT License.
+ */
+package redis.clients.authentication.entraid;
+
+import java.time.Duration;
+import java.util.ArrayList;
+import java.util.Set;
+import java.util.function.Supplier;
+
+import com.azure.core.credential.AccessToken;
+import com.azure.core.credential.TokenRequestContext;
+import com.azure.identity.DefaultAzureCredential;
+import redis.clients.authentication.core.IdentityProvider;
+import redis.clients.authentication.core.Token;
+
+/**
+ * AzureIdentityProvider is an implementation of the IdentityProvider interface
+ * that uses Azure's DefaultAzureCredential to obtain access tokens.
+ * 
+ * <p>This class is designed to work with Azure's identity platform to provide
+ * authentication tokens for accessing Azure resources. It uses a 
+ * DefaultAzureCredential to request tokens with specified scopes and a timeout(in milliseconds). 
+ * For most cases you will not need to use it directly since AzureTokenAuthConfigBuilder 
+ * will do the work for you as shown in the example below:
+ * <pre>
+ * {@code
+ * TokenAuthConfig config = AzureTokenAuthConfigBuilder.builder()
+ *          .defaultAzureCredential(new DefaultAzureCredential()).build();
+ * }
+ * </pre>
+ * <p>In you case you need your own implementation for relevant reasons, you can use it as follows:
+ * <pre>
+ * {@code
+ * Set<String> scopes = new HashSet<>(Arrays.asList("https://redis.azure.com/.default"));
+ * AzureIdentityProvider provider = new AzureIdentityProvider(
+ *      new DefaultAzureCredentialBuilder().build(), scopes, 5000);
+ * TokenAuthConfig config = AzureTokenAuthConfigBuilder.builder().identityProviderConfig(()-> provider)).build();
+ * }
+ * </pre>
+ * 
+ * <p>Thread Safety: This class is thread-safe as long as the provided 
+ * DefaultAzureCredential is thread-safe.
+ * 
+ * @see redis.clients.authentication.entraid.AzureTokenAuthConfigBuilder
+ * @see com.azure.identity.DefaultAzureCredentialBuilder
+ */
+
+public final class AzureIdentityProvider implements IdentityProvider {
+
+    private Supplier<AccessToken> accessTokenSupplier;
+
+    public AzureIdentityProvider(DefaultAzureCredential defaultAzureCredential, Set<String> scopes,
+            int timeout) {
+        TokenRequestContext ctx = new TokenRequestContext()
+                .setScopes(new ArrayList<String>(scopes));
+        accessTokenSupplier = () -> defaultAzureCredential.getToken(ctx)
+                .block(Duration.ofMillis(timeout));
+    }
+
+    @Override
+    public Token requestToken() {
+        return new JWToken(accessTokenSupplier.get().getToken());
+    }
+}
diff --git a/entraid/src/main/java/redis/clients/authentication/entraid/AzureIdentityProviderConfig.java b/entraid/src/main/java/redis/clients/authentication/entraid/AzureIdentityProviderConfig.java
@@ -0,0 +1,62 @@
+/*
+ * Copyright 2024, Redis Ltd. and Contributors
+ * All rights reserved.
+ *
+ * Licensed under the MIT License.
+ */
+package redis.clients.authentication.entraid;
+
+import java.util.Set;
+import java.util.function.Supplier;
+
+import com.azure.identity.DefaultAzureCredential;
+
+import redis.clients.authentication.core.IdentityProvider;
+import redis.clients.authentication.core.IdentityProviderConfig;
+
+/**
+ * Configuration class for Azure Identity Provider.
+ * This class implements the {@link IdentityProviderConfig} interface and provides
+ * a configuration for creating an {@link AzureIdentityProvider} instance.
+ * 
+ * <p>This class uses {@link DefaultAzureCredential} for authentication and allows
+ * specifying scopes and a timeout(in milliseconds) for the identity provider.</p>
+ * For most cases you will not need to use it directly since AzureTokenAuthConfigBuilder 
+ * will do the work for you as shown in the example below:
+ * <pre>
+ * {@code
+ * TokenAuthConfig config = AzureTokenAuthConfigBuilder.builder()
+ *          .defaultAzureCredential(new DefaultAzureCredentialBuilder()).build();
+ * } 
+ * </pre>
+ * <p>In you case you need your own implementation for relevant reasons, you can use it as follows:
+ * <pre>
+ * {@code
+ * DefaultAzureCredential credential = new DefaultAzureCredentialBuilder().build();
+ * Set<String> scopes = Set.of("https://redis.azure.com/.default");
+ * AzureIdentityProviderConfig azureIDPConfig = new AzureIdentityProviderConfig(credential, scopes, 5000);
+ * TokenAuthConfig config = AzureTokenAuthConfigBuilder.builder().identityProviderConfig(azureIDPConfig).build();
+ * }
+ * </pre>
+ * 
+ * For more information and details on how to use, please see:
+ * https://github.com/redis/jedis/blob/master/docs/advanced-usage.md#token-based-authentication
+ * https://github.com/redis/lettuce/blob/main/docs/user-guide/connecting-redis.md#microsoft-entra-id-authentication
+ * 
+ * @see IdentityProviderConfig
+ * @see AzureIdentityProvider
+ * @see DefaultAzureCredential
+ */
+public final class AzureIdentityProviderConfig implements IdentityProviderConfig {
+
+    private final Supplier<IdentityProvider> providerSupplier;
+
+    public AzureIdentityProviderConfig(DefaultAzureCredential defaultAzureCredential, Set<String> scopes, int timeout) {
+        providerSupplier = () -> new AzureIdentityProvider(defaultAzureCredential, scopes, timeout);
+    }
+
+    @Override
+    public IdentityProvider getProvider() {
+        return providerSupplier.get();
+    }
+}
diff --git a/entraid/src/main/java/redis/clients/authentication/entraid/AzureTokenAuthConfigBuilder.java b/entraid/src/main/java/redis/clients/authentication/entraid/AzureTokenAuthConfigBuilder.java
@@ -0,0 +1,118 @@
+/*
+ * Copyright 2024, Redis Ltd. and Contributors 
+ * All rights reserved. 
+ * 
+ * Licensed under the MIT License.
+ */
+package redis.clients.authentication.entraid;
+
+import java.util.Collections;
+import java.util.Set;
+
+import com.azure.identity.DefaultAzureCredential;
+
+import redis.clients.authentication.core.TokenAuthConfig;
+import redis.clients.authentication.core.TokenManagerConfig;
+
+/**
+ * Builder class for configuring Azure Token Authentication via a DefaultAzureCredential.
+ * It builds a TokenAuthConfig object which can be used to authenticate with Azure resources. 
+ * This class extends {@link TokenAuthConfig.Builder} and implements {@link AutoCloseable}.
+ * It provides methods to configure various parameters for Azure Token Authentication.
+ * 
+ * <p>Default values:</p>
+ * <ul>
+ *   <li>{@code DEFAULT_EXPIRATION_REFRESH_RATIO}: 0.75F</li>
+ *   <li>{@code DEFAULT_LOWER_REFRESH_BOUND_MILLIS}: 2 * 60 * 1000</li>
+ *   <li>{@code DEFAULT_TOKEN_REQUEST_EXECUTION_TIMEOUT_IN_MS}: 1000</li>
+ *   <li>{@code DEFAULT_MAX_ATTEMPTS_TO_RETRY}: 5</li>
+ *   <li>{@code DEFAULT_DELAY_IN_MS_TO_RETRY}: 100</li>
+ *   <li>{@code DEFAULT_SCOPES}: "https://redis.azure.com/.default"</li>
+ * </ul>
+ * 
+ * <p>Example usage:</p>
+ * <pre>{@code
+ * AzureTokenAuthConfigBuilder builder = AzureTokenAuthConfigBuilder.builder()
+ *     .defaultAzureCredential(new DefaultAzureCredentialBuilder.build())
+ *     .scopes(Collections.singleton("https://example.com/.default"))
+ *     .tokenRequestExecTimeoutInMs(2000);
+ * TokenAuthConfig config = builder.build();
+ * }</pre>
+ * 
+ * <p>This class is also {@link AutoCloseable}, and resources can be cleaned
+ * up by calling {@link #close()}.</p>
+ * 
+ * @see TokenAuthConfig.Builder
+ * @see DefaultAzureCredential
+ */
+public class AzureTokenAuthConfigBuilder
+        extends TokenAuthConfig.Builder<AzureTokenAuthConfigBuilder> implements AutoCloseable {
+    public static final float DEFAULT_EXPIRATION_REFRESH_RATIO = 0.75F;
+    public static final int DEFAULT_LOWER_REFRESH_BOUND_MILLIS = 2 * 60 * 1000;
+    public static final int DEFAULT_TOKEN_REQUEST_EXECUTION_TIMEOUT_IN_MS = 1000;
+    public static final int DEFAULT_MAX_ATTEMPTS_TO_RETRY = 5;
+    public static final int DEFAULT_DELAY_IN_MS_TO_RETRY = 100;
+    public static final Set<String> DEFAULT_SCOPES = Collections.singleton("https://redis.azure.com/.default");;
+
+    private DefaultAzureCredential defaultAzureCredential;
+    private Set<String> scopes = DEFAULT_SCOPES;
+    private int tokenRequestExecTimeoutInMs = DEFAULT_TOKEN_REQUEST_EXECUTION_TIMEOUT_IN_MS;
+
+    public AzureTokenAuthConfigBuilder() {
+        this.expirationRefreshRatio(DEFAULT_EXPIRATION_REFRESH_RATIO)
+                .lowerRefreshBoundMillis(DEFAULT_LOWER_REFRESH_BOUND_MILLIS)
+                .tokenRequestExecTimeoutInMs(DEFAULT_TOKEN_REQUEST_EXECUTION_TIMEOUT_IN_MS)
+                .maxAttemptsToRetry(DEFAULT_MAX_ATTEMPTS_TO_RETRY)
+                .delayInMsToRetry(DEFAULT_DELAY_IN_MS_TO_RETRY);
+    }
+
+    public AzureTokenAuthConfigBuilder defaultAzureCredential(
+            DefaultAzureCredential defaultAzureCredential) {
+        this.defaultAzureCredential = defaultAzureCredential;
+        return this;
+    }
+
+    public AzureTokenAuthConfigBuilder scopes(Set<String> scopes) {
+        this.scopes = scopes;
+        return this;
+    }
+
+    @Override
+    public AzureTokenAuthConfigBuilder tokenRequestExecTimeoutInMs(
+            int tokenRequestExecTimeoutInMs) {
+        super.tokenRequestExecTimeoutInMs(tokenRequestExecTimeoutInMs);
+        this.tokenRequestExecTimeoutInMs = tokenRequestExecTimeoutInMs;
+        return this;
+    }
+
+    public TokenAuthConfig build() {
+        super.identityProviderConfig(new AzureIdentityProviderConfig(defaultAzureCredential, scopes,
+                tokenRequestExecTimeoutInMs));
+        return super.build();
+    }
+
+    @Override
+    public void close() throws Exception {
+        defaultAzureCredential = null;
+        scopes = null;
+    }
+
+    public static AzureTokenAuthConfigBuilder builder() {
+        return new AzureTokenAuthConfigBuilder();
+    }
+
+    public static AzureTokenAuthConfigBuilder from(AzureTokenAuthConfigBuilder sample) {
+        TokenAuthConfig tokenAuthConfig = TokenAuthConfig.Builder.from(sample).build();
+        TokenManagerConfig tokenManagerConfig = tokenAuthConfig.getTokenManagerConfig();
+
+        AzureTokenAuthConfigBuilder builder = (AzureTokenAuthConfigBuilder) new AzureTokenAuthConfigBuilder()
+                .expirationRefreshRatio(tokenManagerConfig.getExpirationRefreshRatio())
+                .lowerRefreshBoundMillis(tokenManagerConfig.getLowerRefreshBoundMillis())
+                .tokenRequestExecTimeoutInMs(tokenManagerConfig.getTokenRequestExecTimeoutInMs())
+                .maxAttemptsToRetry(tokenManagerConfig.getRetryPolicy().getMaxAttempts())
+                .delayInMsToRetry(tokenManagerConfig.getRetryPolicy().getdelayInMs())
+                .identityProviderConfig(tokenAuthConfig.getIdentityProviderConfig());
+        builder.scopes = sample.scopes;
+        return builder;
+    }
+}
diff --git a/entraid/src/main/java/redis/clients/authentication/entraid/EntraIDTokenAuthConfigBuilder.java b/entraid/src/main/java/redis/clients/authentication/entraid/EntraIDTokenAuthConfigBuilder.java
diff --git a/entraid/src/test/java/redis/clients/authentication/AzureIdentityProviderIntegrationTests.java b/entraid/src/test/java/redis/clients/authentication/AzureIdentityProviderIntegrationTests.java
diff --git a/entraid/src/test/java/redis/clients/authentication/AzureIdentityProviderUnitTests.java b/entraid/src/test/java/redis/clients/authentication/AzureIdentityProviderUnitTests.java
diff --git a/entraid/src/test/java/redis/clients/authentication/EntraIDUnitTests.java b/entraid/src/test/java/redis/clients/authentication/EntraIDUnitTests.java
diff --git a/entraid/src/test/java/redis/clients/authentication/TestContext.java b/entraid/src/test/java/redis/clients/authentication/TestContext.java
