aws-advanced-jdbc-wrapper.git / summary / log / commit / refs
commit 416ce83977e2187d7bdbd2fbf9688909264de67f
Author: Bruno Paiva Lima da Silva <64107800+brunos-bq@users.noreply.github.com>
Commit: GitHub <noreply@github.com>
Date: Fri Jan 12 00:30:00 2024 +0000
feat: enabling AWS Profile for IAM/SecretsManager auth (#786)
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: sergiyv-improving <69876824+sergiyv-improving@users.noreply.github.com>
Co-authored-by: sergiyvamz <svvoshch@amazon.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: sergiyvamz <75754709+sergiyvamz@users.noreply.github.com>
Co-authored-by: Karen <64801825+karenc-bq@users.noreply.github.com>
Co-authored-by: crystall-bitquill <97126568+crystall-bitquill@users.noreply.github.com>
Co-authored-by: aaronchung-bitquill <118320132+aaronchung-bitquill@users.noreply.github.com>
Co-authored-by: congoamz <75754763+congoamz@users.noreply.github.com>
.../software/amazon/jdbc/PropertyDefinition.java | 4 ++++
.../jdbc/authentication/AwsCredentialsManager.java | 20 ++++++++++++++------
.../aws_advanced_jdbc_wrapper_messages.properties | 3 ---
.../authentication/AwsCredentialsManagerTest.java | 3 +--
4 files changed, 19 insertions(+), 11 deletions(-)
diff --git a/wrapper/src/main/java/software/amazon/jdbc/PropertyDefinition.java b/wrapper/src/main/java/software/amazon/jdbc/PropertyDefinition.java
index ebcbdae6..04051ad9 100644
--- a/wrapper/src/main/java/software/amazon/jdbc/PropertyDefinition.java
+++ b/wrapper/src/main/java/software/amazon/jdbc/PropertyDefinition.java
@@ -101,6 +101,10 @@ public class PropertyDefinition {
"OTLP", "NONE"
});
+ public static final AwsWrapperProperty AWS_PROFILE =
+ new AwsWrapperProperty(
+ "awsProfile", null, "Name of the AWS Profile to use for IAM/SecretsManager auth.");
+
public static final AwsWrapperProperty LOGIN_TIMEOUT =
new AwsWrapperProperty(
"loginTimeout", null, "Login timeout in msec.");
diff --git a/wrapper/src/main/java/software/amazon/jdbc/authentication/AwsCredentialsManager.java b/wrapper/src/main/java/software/amazon/jdbc/authentication/AwsCredentialsManager.java
index dbac70b2..eb463a7a 100644
--- a/wrapper/src/main/java/software/amazon/jdbc/authentication/AwsCredentialsManager.java
+++ b/wrapper/src/main/java/software/amazon/jdbc/authentication/AwsCredentialsManager.java
@@ -18,10 +18,13 @@ package software.amazon.jdbc.authentication;
import java.util.Properties;
import java.util.concurrent.locks.ReentrantLock;
+import org.checkerframework.checker.nullness.qual.Nullable;
import software.amazon.awssdk.auth.credentials.AwsCredentialsProvider;
import software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider;
import software.amazon.jdbc.HostSpec;
+import software.amazon.jdbc.PropertyDefinition;
import software.amazon.jdbc.util.Messages;
+import software.amazon.jdbc.util.StringUtils;
public class AwsCredentialsManager {
private static AwsCredentialsProviderHandler handler = null;
@@ -49,20 +52,25 @@ public class AwsCredentialsManager {
public static AwsCredentialsProvider getProvider(final HostSpec hostSpec, final Properties props) {
lock.lock();
try {
- final AwsCredentialsProvider provider = handler != null
- ? handler.getAwsCredentialsProvider(hostSpec, props)
- : getDefaultProvider();
+ AwsCredentialsProvider provider = handler == null
+ ? null
+ : handler.getAwsCredentialsProvider(hostSpec, props);
if (provider == null) {
- throw new IllegalArgumentException(Messages.get("AwsCredentialsManager.nullProvider"));
+ provider = getDefaultProvider(PropertyDefinition.AWS_PROFILE.getString(props));
}
+
return provider;
} finally {
lock.unlock();
}
}
- private static AwsCredentialsProvider getDefaultProvider() {
- return DefaultCredentialsProvider.create();
+ private static AwsCredentialsProvider getDefaultProvider(final @Nullable String awsProfileName) {
+ DefaultCredentialsProvider.Builder builder = DefaultCredentialsProvider.builder();
+ if (!StringUtils.isNullOrEmpty(awsProfileName)) {
+ builder.profileName(awsProfileName);
+ }
+ return builder.build();
}
}
diff --git a/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties b/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties
index 69fe2cb6..a951be2c 100644
--- a/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties
+++ b/wrapper/src/main/resources/aws_advanced_jdbc_wrapper_messages.properties
@@ -38,9 +38,6 @@ RdsHostListProvider.errorGettingHostRole=An error occurred while obtaining the c
RdsHostListProvider.errorIdentifyConnection=An error occurred while obtaining the connection's host ID.
RdsHostListProvider.errorGettingNetworkTimeout=An error occurred while getting the connection network timeout: {0}
-# AWS Credentials Manager
-AwsCredentialsManager.nullProvider=The configured AwsCredentialsProvider was null. If you have configured the AwsCredentialsManager to use a custom AwsCredentialsProviderHandler, please ensure the handler does not return null.
-
# AWS SDK
AwsSdk.unsupportedRegion=Unsupported AWS region ''{0}''. For supported regions please read https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html
diff --git a/wrapper/src/test/java/software/amazon/jdbc/authentication/AwsCredentialsManagerTest.java b/wrapper/src/test/java/software/amazon/jdbc/authentication/AwsCredentialsManagerTest.java
index e2dfbd10..6028f570 100644
--- a/wrapper/src/test/java/software/amazon/jdbc/authentication/AwsCredentialsManagerTest.java
+++ b/wrapper/src/test/java/software/amazon/jdbc/authentication/AwsCredentialsManagerTest.java
@@ -86,7 +86,6 @@ class AwsCredentialsManagerTest {
@Test
public void testNullProvider() {
AwsCredentialsManager.setCustomHandler(((hostSpec, props) -> null));
- assertThrows(IllegalArgumentException.class,
- () -> AwsCredentialsManager.getProvider(mockHostSpec, mockProps));
+ assertTrue(AwsCredentialsManager.getProvider(mockHostSpec, mockProps) instanceof DefaultCredentialsProvider);
}
}
[parent: 9e074d107196]