|
| 1 | +/* |
| 2 | + * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. |
| 3 | + * SPDX-License-Identifier: Apache-2.0 |
| 4 | + */ |
| 5 | +package aws.sdk.kotlin.codegen.customization |
| 6 | + |
| 7 | +import aws.sdk.kotlin.codegen.SdkIdTransform |
| 8 | +import aws.sdk.kotlin.codegen.ServiceClientCompanionObjectWriter |
| 9 | +import aws.sdk.kotlin.codegen.withTransform |
| 10 | +import software.amazon.smithy.kotlin.codegen.KotlinSettings |
| 11 | +import software.amazon.smithy.kotlin.codegen.core.* |
| 12 | +import software.amazon.smithy.kotlin.codegen.integration.AppendingSectionWriter |
| 13 | +import software.amazon.smithy.kotlin.codegen.integration.KotlinIntegration |
| 14 | +import software.amazon.smithy.kotlin.codegen.integration.SectionWriterBinding |
| 15 | +import software.amazon.smithy.kotlin.codegen.model.buildSymbol |
| 16 | +import software.amazon.smithy.kotlin.codegen.model.expectShape |
| 17 | +import software.amazon.smithy.kotlin.codegen.model.hasTrait |
| 18 | +import software.amazon.smithy.kotlin.codegen.model.knowledge.AwsSignatureVersion4 |
| 19 | +import software.amazon.smithy.kotlin.codegen.rendering.ServiceClientGenerator |
| 20 | +import software.amazon.smithy.model.Model |
| 21 | +import software.amazon.smithy.model.shapes.ServiceShape |
| 22 | +import software.amazon.smithy.model.traits.HttpBearerAuthTrait |
| 23 | + |
| 24 | +/** |
| 25 | + * Customization that enables sourcing Bearer tokens from an environment variable |
| 26 | + * |
| 27 | + * When a service-specific environment variable for bearer tokens is present (e.g., AWS_BEARER_TOKEN_BEDROCK), |
| 28 | + * this customization configures the auth scheme resolver to prefer the smithy.api#httpBearerAuth scheme |
| 29 | + * over other authentication methods. Additionally, it configures a token provider that extracts the bearer token |
| 30 | + * from the target environment variable. |
| 31 | + */ |
| 32 | +class EnvironmentBearerTokenCustomization : KotlinIntegration { |
| 33 | + // Currently only services with sigv4 service name 'bedrock' need this customization |
| 34 | + private val supportedSigningServiceNames = setOf("bedrock") |
| 35 | + |
| 36 | + override fun enabledForService(model: Model, settings: KotlinSettings): Boolean { |
| 37 | + val serviceShape = settings.getService(model) |
| 38 | + if (!AwsSignatureVersion4.isSupportedAuthentication(model, serviceShape)) { |
| 39 | + return false |
| 40 | + } |
| 41 | + if (!serviceShape.hasTrait<HttpBearerAuthTrait>()) { |
| 42 | + return false |
| 43 | + } |
| 44 | + |
| 45 | + return AwsSignatureVersion4.signingServiceName(serviceShape) in supportedSigningServiceNames |
| 46 | + } |
| 47 | + |
| 48 | + override fun writeAdditionalFiles(ctx: CodegenContext, delegator: KotlinDelegator) { |
| 49 | + val serviceShape = ctx.model.expectShape<ServiceShape>(ctx.settings.service) |
| 50 | + val packageName = ctx.settings.pkg.name |
| 51 | + |
| 52 | + delegator.useFileWriter( |
| 53 | + "FinalizeBearerTokenConfig.kt", |
| 54 | + "$packageName.auth", |
| 55 | + ) { writer -> |
| 56 | + renderEnvironmentBearerTokenConfig( |
| 57 | + writer, |
| 58 | + ctx, |
| 59 | + serviceShape, |
| 60 | + ) |
| 61 | + } |
| 62 | + } |
| 63 | + |
| 64 | + private fun renderEnvironmentBearerTokenConfig( |
| 65 | + writer: KotlinWriter, |
| 66 | + ctx: CodegenContext, |
| 67 | + serviceShape: ServiceShape, |
| 68 | + ) { |
| 69 | + val serviceSymbol = ctx.symbolProvider.toSymbol(serviceShape) |
| 70 | + val signingServiceName = AwsSignatureVersion4.signingServiceName(serviceShape) |
| 71 | + // Transform signing name to environment variable name |
| 72 | + val envVarSuffix = signingServiceName.withTransform(SdkIdTransform.UpperSnakeCase) |
| 73 | + val envVarName = "AWS_BEARER_TOKEN_$envVarSuffix" |
| 74 | + val authSchemeId = RuntimeTypes.Auth.Identity.AuthSchemeId |
| 75 | + |
| 76 | + writer.withBlock( |
| 77 | + "internal fun finalizeBearerTokenConfig(builder: #1T.Builder, provider: #2T = #2T.System) {", |
| 78 | + "}", |
| 79 | + serviceSymbol, |
| 80 | + RuntimeTypes.Core.Utils.PlatformProvider, |
| 81 | + ) { |
| 82 | + // The customization do nothing if environment variable is not set |
| 83 | + write("if (provider.getenv(#S) == null) { return }", envVarName) |
| 84 | + |
| 85 | + // Configure auth scheme preference if customer hasn't specify one |
| 86 | + write("builder.config.authSchemePreference = builder.config.authSchemePreference ?: listOf(#T.HttpBearer)", authSchemeId) |
| 87 | + |
| 88 | + // Promote HttpBearer to first position in auth scheme preference list |
| 89 | + withBlock("val filteredSchemes = builder.config.authSchemePreference?.filterNot {", "} ?: emptyList()") { |
| 90 | + write("it == #T.HttpBearer", authSchemeId) |
| 91 | + } |
| 92 | + |
| 93 | + write("builder.config.authSchemePreference = listOf(#1T.HttpBearer) + filteredSchemes", authSchemeId) |
| 94 | + |
| 95 | + write( |
| 96 | + "builder.config.bearerTokenProvider = builder.config.bearerTokenProvider ?: #T(#S, provider)", |
| 97 | + RuntimeTypes.Auth.HttpAuth.EnvironmentBearerTokenProvider, |
| 98 | + envVarName, |
| 99 | + ) |
| 100 | + } |
| 101 | + } |
| 102 | + |
| 103 | + override val sectionWriters: List<SectionWriterBinding> |
| 104 | + get() = listOf( |
| 105 | + SectionWriterBinding( |
| 106 | + ServiceClientCompanionObjectWriter.FinalizeEnvironmentalConfig, |
| 107 | + finalizeEnvironmentBearerTokenConfigWriter, |
| 108 | + ), |
| 109 | + ) |
| 110 | + |
| 111 | + private val finalizeEnvironmentBearerTokenConfigWriter = AppendingSectionWriter { writer -> |
| 112 | + val serviceName = clientName(writer.getContextValue(ServiceClientGenerator.Sections.CompanionObject.SdkId)) |
| 113 | + |
| 114 | + val environmentBearerTokenConfig = buildSymbol { |
| 115 | + name = "finalizeBearerTokenConfig" |
| 116 | + namespace = "aws.sdk.kotlin.services.${serviceName.lowercase()}.auth" |
| 117 | + } |
| 118 | + |
| 119 | + writer.write("#T(builder)", environmentBearerTokenConfig) |
| 120 | + } |
| 121 | +} |
0 commit comments