Skip to content
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

Jump to bottom

fix: resolve region only when profile credentials require it #582

Merged
merged 4 commits into from
Apr 14, 2022
Merged

fix: resolve region only when profile credentials require it #582

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5f87f02
fix: resolve region only when profile credentials require it
ianbotsf Apr 13, 2022
ebb9eb0
lint
ianbotsf Apr 13, 2022
e132553
Merge branch 'main' into fix-unnecessary-region-resolution
ianbotsf Apr 14, 2022
d13865a
addressing PR feedback: don't throw custom exception when lazy region…
ianbotsf Apr 14, 2022
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
56 changes: 31 additions & 25 deletions ...s-config/common/src/aws/sdk/kotlin/runtime/auth/credentials/ProfileCredentialsProvider.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,10 @@ import aws.smithy.kotlin.runtime.http.engine.HttpClientEngine
import aws.smithy.kotlin.runtime.io.Closeable
import aws.smithy.kotlin.runtime.logging.Logger
import aws.smithy.kotlin.runtime.time.TimestampFormat
import aws.smithy.kotlin.runtime.util.LazyAsyncValue
import aws.smithy.kotlin.runtime.util.Platform
import aws.smithy.kotlin.runtime.util.PlatformProvider
import aws.smithy.kotlin.runtime.util.asyncLazy

/**
* A [CredentialsProvider] that gets credentials from a profile in `~/.aws/config` or the shared credentials
Expand Down Expand Up @@ -74,7 +76,6 @@ public class ProfileCredentialsProvider(
private val platformProvider: PlatformProvider = Platform,
private val httpClientEngine: HttpClientEngine? = null,
) : CredentialsProvider, Closeable {

private val namedProviders = mapOf(
"Environment" to EnvironmentCredentialsProvider(platformProvider::getenv),
"Ec2InstanceMetadata" to ImdsCredentialsProvider(
Expand All @@ -99,7 +100,7 @@ public class ProfileCredentialsProvider(

// if profile is overridden for this provider, attempt to resolve it from there first
val profileOverride = profileName?.let { profiles[it] }
val region = region ?: profileOverride?.get("region") ?: resolveRegion(platformProvider)
val region = asyncLazy { region ?: profileOverride?.get("region") ?: resolveRegion(platformProvider) }

val leaf = chain.leaf.toCredentialsProvider(region)
logger.debug { "Resolving credentials from ${chain.leaf.description()}" }
Expand All @@ -121,34 +122,39 @@ public class ProfileCredentialsProvider(
}
}

private fun LeafProvider.toCredentialsProvider(region: String): CredentialsProvider = when (this) {
is LeafProvider.NamedSource -> namedProviders[name] ?: throw ProviderConfigurationException("unknown credentials source: $name")
is LeafProvider.AccessKey -> StaticCredentialsProvider(credentials)
is LeafProvider.WebIdentityTokenRole -> StsWebIdentityCredentialsProvider(
roleArn,
webIdentityTokenFile,
region = region,
roleSessionName = sessionName,
platformProvider = platformProvider,
httpClientEngine = httpClientEngine
)
is LeafProvider.Sso -> SsoCredentialsProvider(
accountId = ssoAccountId,
roleName = ssoRoleName,
startUrl = ssoStartUrl,
ssoRegion = ssoRegion,
httpClientEngine = httpClientEngine,
platformProvider = platformProvider
)
}
private suspend fun LeafProvider.toCredentialsProvider(region: LazyAsyncValue<String>): CredentialsProvider =
when (this) {
is LeafProvider.NamedSource -> namedProviders[name]
?: throw ProviderConfigurationException("unknown credentials source: $name")

is LeafProvider.AccessKey -> StaticCredentialsProvider(credentials)

is LeafProvider.WebIdentityTokenRole -> StsWebIdentityCredentialsProvider(
roleArn,
webIdentityTokenFile,
region = region.get(),
roleSessionName = sessionName,
platformProvider = platformProvider,
httpClientEngine = httpClientEngine
)

is LeafProvider.Sso -> SsoCredentialsProvider(
accountId = ssoAccountId,
roleName = ssoRoleName,
startUrl = ssoStartUrl,
ssoRegion = ssoRegion,
httpClientEngine = httpClientEngine,
platformProvider = platformProvider
)
}

private fun RoleArn.toCredentialsProvider(
private suspend fun RoleArn.toCredentialsProvider(
creds: Credentials,
region: String
region: LazyAsyncValue<String>,
): CredentialsProvider = StsAssumeRoleCredentialsProvider(
credentialsProvider = StaticCredentialsProvider(creds),
roleArn = roleArn,
region = region,
region = region.get(),
roleSessionName = sessionName,
externalId = externalId,
httpClientEngine = httpClientEngine
Expand Down
3 changes: 0 additions & 3 deletions ...fig/common/test/aws/sdk/kotlin/runtime/auth/credentials/ProfileCredentialsProviderTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ class ProfileCredentialsProviderTest {
fs = mapOf(
"config" to """
[default]
region = us-east-2
aws_access_key_id = AKID-Default
aws_secret_access_key = Default-Secret
""".trimIndent()
Expand Down Expand Up @@ -50,7 +49,6 @@ class ProfileCredentialsProviderTest {
aws_secret_access_key = Default-Secret

[profile my-profile]
region = us-east-2
aws_access_key_id = AKID-Profile
aws_secret_access_key = Profile-Secret
""".trimIndent()
Expand All @@ -74,7 +72,6 @@ class ProfileCredentialsProviderTest {
env = mapOf(
"AWS_CONFIG_FILE" to "config",
"AWS_PROFILE" to "my-profile",
"AWS_REGION" to "us-west-1"
),
fs = mapOf(
"config" to """
Expand Down