Skip to content

Fix login_session profile region resolution #7202

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

Open
ford220102 wants to merge 1 commit into
base: master
Choose a base branch
from
+44 −1
Open

Fix login_session profile region resolution #7202

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
8 changes: 7 additions & 1 deletion ...a/software/amazon/awssdk/services/signin/auth/LoginProfileCredentialsProviderFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@
import software.amazon.awssdk.auth.credentials.ProfileProviderCredentialsContext;
import software.amazon.awssdk.profiles.Profile;
import software.amazon.awssdk.profiles.ProfileProperty;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.signin.SigninClient;
import software.amazon.awssdk.services.signin.SigninClientBuilder;
import software.amazon.awssdk.utils.IoUtils;
import software.amazon.awssdk.utils.SdkAutoCloseable;

Expand Down Expand Up @@ -51,7 +53,11 @@ private LoginProfileCredentialsProvider(ProfileProviderCredentialsContext creden
String loginSession = profile.property(ProfileProperty.LOGIN_SESSION)
.orElseThrow(() -> new IllegalArgumentException("login_session property is required"));

this.signinClient = SigninClient.create();
SigninClientBuilder signinClientBuilder = SigninClient.builder();
profile.property(ProfileProperty.REGION)
.map(Region::of)
.ifPresent(signinClientBuilder::region);
this.signinClient = signinClientBuilder.build();
this.credentialsProvider = LoginCredentialsProvider
.builder()
.loginSession(loginSession)
Expand Down
37 changes: 37 additions & 0 deletions ...ftware/amazon/awssdk/services/signin/auth/LoginProfileCredentialsProviderFactoryTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import static org.junit.jupiter.api.Assertions.assertTrue;
import static software.amazon.awssdk.services.signin.auth.internal.DpopTestUtils.VALID_TEST_PEM;

import java.lang.reflect.Field;
import java.nio.file.Path;
import java.time.Instant;
import java.util.Optional;
Expand All @@ -33,12 +34,16 @@
import software.amazon.awssdk.auth.credentials.ProfileCredentialsProvider;
import software.amazon.awssdk.auth.credentials.ProfileProviderCredentialsContext;
import software.amazon.awssdk.auth.credentials.internal.ProfileCredentialsUtils;
import software.amazon.awssdk.core.SdkSystemSetting;
import software.amazon.awssdk.core.useragent.BusinessMetricFeatureId;
import software.amazon.awssdk.profiles.ProfileFile;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.signin.SigninClient;
import software.amazon.awssdk.services.signin.internal.AccessTokenManager;
import software.amazon.awssdk.services.signin.internal.LoginAccessToken;
import software.amazon.awssdk.services.signin.internal.LoginCacheDirectorySystemSetting;
import software.amazon.awssdk.services.signin.internal.OnDiskTokenManager;
import software.amazon.awssdk.utils.SdkAutoCloseable;
import software.amazon.awssdk.utils.StringInputStream;

public class LoginProfileCredentialsProviderFactoryTest {
Expand All @@ -48,16 +53,23 @@ public class LoginProfileCredentialsProviderFactoryTest {
Path tempDir;

private AccessTokenManager tokenManager;
private String originalRegion;

@BeforeEach
public void setup() {
originalRegion = System.getProperty(SdkSystemSetting.AWS_REGION.property());
System.setProperty(new LoginCacheDirectorySystemSetting().property(), tempDir.toString());
tokenManager = OnDiskTokenManager.create(tempDir, LOGIN_SESSION_ID);
}

@AfterEach
public void teardown() {
System.clearProperty(new LoginCacheDirectorySystemSetting().property());
if (originalRegion == null) {
System.clearProperty(SdkSystemSetting.AWS_REGION.property());
} else {
System.setProperty(SdkSystemSetting.AWS_REGION.property(), originalRegion);
}
}

@Test
Expand Down Expand Up @@ -88,6 +100,31 @@ public void create_returnsLoginCredentialsFromProfile() {
assertEquals(BusinessMetricFeatureId.CREDENTIALS_LOGIN.value(), resolvedCredentials.providerName().get());
}

@Test
public void create_usesRegionFromProfile() throws IllegalAccessException, NoSuchFieldException {
System.setProperty(SdkSystemSetting.AWS_REGION.property(), Region.US_EAST_1.id());
ProfileFile profileFile = configFile("[profile foo]\n" +
"login_session=" + LOGIN_SESSION_ID + "\n" +
"region=" + Region.US_WEST_2.id() + "\n");

AwsCredentialsProvider provider = new LoginProfileCredentialsProviderFactory().create(
ProfileProviderCredentialsContext
.builder()
.profile(profileFile.profile("foo").get())
.profileFile(profileFile)
.build()
);

try {
Field signinClientField = provider.getClass().getDeclaredField("signinClient");
signinClientField.setAccessible(true);
SigninClient signinClient = (SigninClient) signinClientField.get(provider);
assertEquals(Region.US_WEST_2, signinClient.serviceClientConfiguration().region());
} finally {
((SdkAutoCloseable) provider).close();
}
}

/**
* This test validates that the {@link ProfileCredentialsUtils} used in the {@link ProfileCredentialsProvider}
* correctly loads and configures login session credentials using the factory.
Expand Down