commonMain.aws.smithy.kotlin.runtime.http.operation.OperationAuth.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of http-client-jvm Show documentation
HTTP client abstractions
The newest version!
/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0
 */

package aws.smithy.kotlin.runtime.http.operation

import aws.smithy.kotlin.runtime.InternalApi
import aws.smithy.kotlin.runtime.auth.AuthOption
import aws.smithy.kotlin.runtime.auth.AuthSchemeId
import aws.smithy.kotlin.runtime.auth.AuthSchemeProvider
import aws.smithy.kotlin.runtime.http.auth.AnonymousAuthScheme
import aws.smithy.kotlin.runtime.http.auth.AnonymousIdentityProvider
import aws.smithy.kotlin.runtime.http.auth.AuthScheme
import aws.smithy.kotlin.runtime.identity.IdentityProviderConfig
import aws.smithy.kotlin.runtime.identity.asIdentityProviderConfig

private val AnonymousAuthConfig = OperationAuthConfig.from(
    AnonymousIdentityProvider.asIdentityProviderConfig(),
    AnonymousAuthScheme,
)

/**
 * Container for authentication configuration for an operation
 * @param authSchemeResolver component capable of resolving authentication scheme candidates for the current operation
 * @param configuredAuthSchemes configured auth schemes, used to select from the candidates
 * @param identityProviderConfig configured identity providers
 */
@InternalApi
public data class OperationAuthConfig(
    val authSchemeResolver: AuthSchemeResolver,
    val configuredAuthSchemes: Map,
    val identityProviderConfig: IdentityProviderConfig,
) {
    @InternalApi
    public companion object {
        public val Anonymous: OperationAuthConfig = AnonymousAuthConfig

        /**
         * Convenience function to create auth configuration from configured auth schemes.
         * This creates an [AuthSchemeResolver] that returns all configured auth scheme ID's.
         */
        public fun from(
            identityProviderConfig: IdentityProviderConfig,
            vararg authSchemes: AuthScheme,
        ): OperationAuthConfig {
            val resolver = AuthSchemeResolver { authSchemes.map { AuthOption(it.schemeId) } }
            return OperationAuthConfig(resolver, authSchemes.associateBy(AuthScheme::schemeId), identityProviderConfig)
        }
    }
}

/**
 * Type agnostic version of [AuthSchemeProvider]. Typically service client specific versions are code generated and
 * then adapted to this generic version for actually executing a request.
 */
@InternalApi
public fun interface AuthSchemeResolver {
    /**
     * Resolve the candidate authentication schemes for an operation
     * @return a prioritized list of candidate auth schemes to use for the current operation
     */
    public suspend fun resolve(request: SdkHttpRequest): List
}