refactor!: abstract AwsSigner to support multiple backing implementations (#626)

Author: ianbotsf

runtime/auth/aws-credentials/build.gradle.kts

@@ -0,0 +1,23 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
+
+description = "Types for AWS credentials"
+extra["displayName"] = "Smithy :: Kotlin :: AWS Credentials"
+extra["moduleName"] = "aws.smithy.kotlin.runtime.auth.awscredentials"
+
+kotlin {
+    sourceSets {
+        commonMain {
+            dependencies {
+                // For Instant
+                api(project(":runtime:runtime-core"))
+            }
+        }
+
+        all {
+            languageSettings.optIn("aws.smithy.kotlin.runtime.util.InternalApi")
+        }
+    }
+}

runtime/auth/aws-credentials/common/src/aws/smithy/kotlin/runtime/auth/awscredentials/Credentials.kt

@@ -0,0 +1,20 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
+package aws.smithy.kotlin.runtime.auth.awscredentials
+
+import aws.smithy.kotlin.runtime.time.Instant
+
+/**
+ * Represents a set of AWS credentials
+ *
+ * For more information see [AWS security credentials](https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html#AccessKeys)
+ */
+public data class Credentials(
+    val accessKeyId: String,
+    val secretAccessKey: String,
+    val sessionToken: String? = null,
+    val expiration: Instant? = null,
+    val providerName: String? = null,
+)

runtime/auth/aws-credentials/common/src/aws/smithy/kotlin/runtime/auth/awscredentials/CredentialsProvider.kt

@@ -0,0 +1,15 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
+package aws.smithy.kotlin.runtime.auth.awscredentials
+
+/**
+ * Represents a producer/source of AWS credentials
+ */
+public interface CredentialsProvider {
+    /**
+     * Request credentials from the provider
+     */
+    public suspend fun getCredentials(): Credentials
+}

runtime/auth/aws-signing-common/build.gradle.kts

@@ -0,0 +1,24 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
+
+description = "Common types for AWS signing"
+extra["displayName"] = "Smithy :: Kotlin :: AWS Signing Common"
+extra["moduleName"] = "aws.smithy.kotlin.runtime.auth.signing.awssigning"
+
+kotlin {
+    sourceSets {
+        commonMain {
+            dependencies {
+                api(project(":runtime:auth:aws-credentials"))
+                api(project(":runtime:protocol:http"))
+                implementation(project(":runtime:logging"))
+            }
+        }
+
+        all {
+            languageSettings.optIn("aws.smithy.kotlin.runtime.util.InternalApi")
+        }
+    }
+}

runtime/auth/aws-signing-common/common/src/aws/smithy/kotlin/runtime/auth/awssigning/AwsSigner.kt

@@ -0,0 +1,34 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
+package aws.smithy.kotlin.runtime.auth.awssigning
+
+import aws.smithy.kotlin.runtime.http.request.HttpRequest
+
+/**
+ * A component capable of signing requests and request chunks for AWS APIs.
+ */
+interface AwsSigner {
+    /**
+     * Signs an HTTP request according to the supplied signing configuration
+     * @param request The request to sign
+     * @param config The signing configuration
+     * @return The signed request
+     */
+    suspend fun sign(request: HttpRequest, config: AwsSigningConfig): AwsSigningResult<HttpRequest>
+
+    /**
+     * Signs a body chunk according to the supplied signing configuration
+     * @param chunkBody The chunk payload to sign
+     * @param prevSignature The signature of the previous component of the request (either the initial request itself
+     * for the first chunk or the previous chunk otherwise)
+     * @param config The signing configuration
+     * @return The signing result, which provides access to all signing-related result properties
+     */
+    suspend fun signChunk(
+        chunkBody: ByteArray,
+        prevSignature: ByteArray,
+        config: AwsSigningConfig,
+    ): AwsSigningResult<Unit>
+}

runtime/auth/aws-signing-common/common/src/aws/smithy/kotlin/runtime/auth/awssigning/AwsSigningAttributes.kt

@@ -0,0 +1,65 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
+package aws.smithy.kotlin.runtime.auth.awssigning
+
+import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProvider
+import aws.smithy.kotlin.runtime.client.ClientOption
+import aws.smithy.kotlin.runtime.time.Instant
+import aws.smithy.kotlin.runtime.util.AttributeKey
+
+/**
+ *  [ClientOption] instances related to signing.
+ */
+object AwsSigningAttributes {
+    /**
+     * The signer implementation to use
+     */
+    val Signer: ClientOption<AwsSigner> = ClientOption("Signer")
+
+    /**
+     * AWS region to be used for signing the request
+     */
+    val SigningRegion: ClientOption<String> = ClientOption("AwsSigningRegion")
+
+    /**
+     * The signature version 4 service signing name to use in the credential scope when signing requests.
+     * See: https://docs.aws.amazon.com/general/latest/gr/sigv4_elements.html
+     */
+    val SigningService: ClientOption<String> = ClientOption("AwsSigningService")
+
+    /**
+     * Override the date to complete the signing process with. Defaults to current time when not specified.
+     *
+     * **Note**: This is an advanced configuration option that does not normally need to be set manually.
+     */
+    val SigningDate: ClientOption<Instant> = ClientOption("SigningDate")
+
+    /**
+     * The [CredentialsProvider] to complete the signing process with. Defaults to the provider configured
+     * on the service client.
+     *
+     * **Note**: This is an advanced configuration option that does not normally need to be set manually.
+     */
+    val CredentialsProvider: ClientOption<CredentialsProvider> = ClientOption("CredentialsProvider")
+
+    /**
+     * The source for the body hash.
+     *
+     * **Note**: This is an advanced configuration option that does not normally need to be set manually.
+     */
+    val BodyHash: ClientOption<BodyHash> = ClientOption("BodyHash")
+
+    /**
+     * The signed body header type.
+     *
+     * **Note**: This is an advanced configuration option that does not normally need to be set manually.
+     */
+    val SignedBodyHeader: ClientOption<AwsSignedBodyHeader> = ClientOption("SignedBodyHeader")
+
+    /**
+     * The signature of the HTTP request. This will only exist after the request has been signed.
+     */
+    val RequestSignature: AttributeKey<ByteArray> = AttributeKey("AWS_HTTP_SIGNATURE")
+}