feat: switch default signer implementation to standard (from CRT) (#616)

ianbotsf · web-flow · commit c40eaac6cb3e · 2022-06-01T10:13:38.000-07:00
diff --git a/.changes/2ca8d856-ee23-4d3f-94d4-633e7dbf9293.json b/.changes/2ca8d856-ee23-4d3f-94d4-633e7dbf9293.json
@@ -0,0 +1,8 @@
+{
+    "id": "2ca8d856-ee23-4d3f-94d4-633e7dbf9293",
+    "type": "feature",
+    "description": "Add a new non-CRT SigV4 signer and use it as the default. This removes the CRT as a hard dependency for using the SDK (although the CRT signer can still be used via explicit configuration on client creation).",
+    "issues": [
+        "awslabs/smithy-kotlin#617"
+    ]
+}
diff --git a/aws-runtime/aws-config/build.gradle.kts b/aws-runtime/aws-config/build.gradle.kts
@@ -38,9 +38,7 @@ kotlin {
                 implementation(project(":aws-runtime:protocols:aws-xml-protocols"))
                 implementation(project(":aws-runtime:aws-endpoint"))
                 implementation("aws.smithy.kotlin:aws-signing-common:$smithyKotlinVersion")
-
-                // TODO -- replace this once CRT is no longer the default signer
-                implementation("aws.smithy.kotlin:aws-signing-crt:$smithyKotlinVersion")
+                implementation("aws.smithy.kotlin:aws-signing-default:$smithyKotlinVersion")
 
                 // additional dependencies required by generated sso provider
                 implementation(project(":aws-runtime:protocols:aws-json-protocols"))
diff --git a/aws-runtime/protocols/aws-event-stream/build.gradle.kts b/aws-runtime/protocols/aws-event-stream/build.gradle.kts
@@ -29,9 +29,7 @@ kotlin {
             dependencies {
                 implementation(project(":aws-runtime:testing"))
                 api("org.jetbrains.kotlinx:kotlinx-coroutines-test:$coroutinesVersion")
-
-                // TODO -- replace this once CRT is no longer the default signer
-                api("aws.smithy.kotlin:aws-signing-crt:$smithyKotlinVersion")
+                implementation("aws.smithy.kotlin:aws-signing-default:$smithyKotlinVersion")
             }
         }
 
diff --git a/aws-runtime/protocols/aws-event-stream/common/test/aws/sdk/kotlin/runtime/protocol/eventstream/EventStreamSigningTest.kt b/aws-runtime/protocols/aws-event-stream/common/test/aws/sdk/kotlin/runtime/protocol/eventstream/EventStreamSigningTest.kt
@@ -9,7 +9,7 @@ import aws.smithy.kotlin.runtime.auth.awscredentials.Credentials
 import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProvider
 import aws.smithy.kotlin.runtime.auth.awssigning.AwsSignatureType
 import aws.smithy.kotlin.runtime.auth.awssigning.AwsSigningConfig
-import aws.smithy.kotlin.runtime.auth.awssigning.crt.CrtAwsSigner
+import aws.smithy.kotlin.runtime.auth.awssigning.DefaultAwsSigner
 import aws.smithy.kotlin.runtime.hashing.sha256
 import aws.smithy.kotlin.runtime.io.SdkByteBuffer
 import aws.smithy.kotlin.runtime.io.bytes
@@ -50,7 +50,7 @@ class EventStreamSigningTest {
         val buffer = SdkByteBuffer(0U)
         messageToSign.encode(buffer)
         val messagePayload = buffer.bytes()
-        val result = CrtAwsSigner.signPayload(signingConfig, prevSignature, messagePayload, testClock)
+        val result = DefaultAwsSigner.signPayload(signingConfig, prevSignature, messagePayload, testClock)
         assertEquals(":date", result.output.headers[0].name)
 
         val dateHeader = result.output.headers[0].value.expectTimestamp()
diff --git a/codegen/smithy-aws-kotlin-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/PresignerGenerator.kt b/codegen/smithy-aws-kotlin-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/PresignerGenerator.kt
@@ -357,9 +357,9 @@ class PresignerGenerator : KotlinIntegration {
                 name = "signer"
                 documentation = "The implementation of AWS signer to use for signing requests"
                 baseClass = RuntimeTypes.Auth.Signing.AwsSigningCommon.ServicePresignConfig
-                propertyType = ClientConfigPropertyType.RequiredWithDefault("CrtAwsSigner")
+                propertyType = ClientConfigPropertyType.RequiredWithDefault("DefaultAwsSigner")
                 additionalImports = listOf(
-                    RuntimeTypes.Auth.Signing.AwsSigningCrt.CrtAwsSigner,
+                    RuntimeTypes.Auth.Signing.AwsSigningStandard.DefaultAwsSigner,
                 )
             },
             ClientConfigProperty {
diff --git a/codegen/smithy-aws-kotlin-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/protocols/eventstream/EventStreamSerializerGenerator.kt b/codegen/smithy-aws-kotlin-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/protocols/eventstream/EventStreamSerializerGenerator.kt
@@ -65,7 +65,7 @@ class EventStreamSerializerGenerator(
         writer.write("val signingConfig = context.#T()", AwsRuntimeTypes.AwsEventStream.newEventStreamSigningConfig)
         // FIXME - needs to be set on the operation for initial request
         //   context[AwsSigningAttributes.SignedBodyHeader] = AwsSignedBodyHeader.X_AMZ_CONTENT_SHA256.name
-        //   context[AwsSigningAttributes.BodyHash] = BodyHash.StreamingAws4HmacSha256Events
+        //   context[AwsSigningAttributes.HashSpecification] = HashSpecification.StreamingAws4HmacSha256Events
 
         val encodeFn = encodeEventStreamMessage(ctx, op, streamShape)
         writer.withBlock("val messages = stream", "") {
diff --git a/codegen/smithy-aws-kotlin-codegen/src/test/kotlin/aws/sdk/kotlin/codegen/PresignerGeneratorTest.kt b/codegen/smithy-aws-kotlin-codegen/src/test/kotlin/aws/sdk/kotlin/codegen/PresignerGeneratorTest.kt
@@ -91,12 +91,12 @@ class PresignerGeneratorTest {
             import aws.sdk.kotlin.runtime.endpoint.asSigningEndpointProvider
             import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProvider
             import aws.smithy.kotlin.runtime.auth.awssigning.AwsSigner
+            import aws.smithy.kotlin.runtime.auth.awssigning.DefaultAwsSigner
             import aws.smithy.kotlin.runtime.auth.awssigning.PresignedRequestConfig
             import aws.smithy.kotlin.runtime.auth.awssigning.PresigningLocation
             import aws.smithy.kotlin.runtime.auth.awssigning.ServicePresignConfig
             import aws.smithy.kotlin.runtime.auth.awssigning.SigningEndpointProvider
             import aws.smithy.kotlin.runtime.auth.awssigning.createPresignedRequest
-            import aws.smithy.kotlin.runtime.auth.awssigning.crt.CrtAwsSigner
             import aws.smithy.kotlin.runtime.client.ExecutionContext
             import aws.smithy.kotlin.runtime.http.QueryParameters
             import aws.smithy.kotlin.runtime.http.request.HttpRequest
@@ -238,7 +238,7 @@ class PresignerGeneratorTest {
                 override val normalizeUriPath: Boolean = true
                 override val region: String = requireNotNull(builder.region) { "region is a required configuration property" }
                 override val serviceId: String = "example"
-                override val signer: AwsSigner = builder.signer ?: CrtAwsSigner
+                override val signer: AwsSigner = builder.signer ?: DefaultAwsSigner
                 override val signingName: String = "example-signing-name"
                 override val useDoubleUriEncode: Boolean = true
                 companion object {
diff --git a/gradle.properties b/gradle.properties
@@ -12,7 +12,7 @@ sdkVersion=0.16.1-SNAPSHOT
 smithyVersion=1.17.0
 smithyGradleVersion=0.5.3
 # smithy-kotlin codegen and runtime are versioned together
-smithyKotlinVersion=0.10.0
+smithyKotlinVersion=0.10.1-SNAPSHOT
 
 # kotlin
 kotlinVersion=1.6.21
@@ -42,4 +42,4 @@ slf4jVersion=1.7.36
 
 # dokka config (values specified at build-time as needed)
 smithyKotlinPackageListUrl=
-smithyKotlinDocBaseUrl=https://docs.aws.amazon.com/sdk-for-kotlin/latest/reference/smithy-kotlin
+smithyKotlinDocBaseUrl=https://docs.aws.amazon.com/sdk-for-kotlin/latest/reference/smithy-kotlin
diff --git a/services/glacier/common/test/aws/sdk/kotlin/services/glacier/internal/TreeHasherTest.kt b/services/glacier/common/test/aws/sdk/kotlin/services/glacier/internal/TreeHasherTest.kt
@@ -83,7 +83,7 @@ class RollingSumHashFunction(private val chunkSize: Int) : HashFunction {
 
     override fun digest(): ByteArray = rollingHash
     override fun reset() = fail("reset should not have been called")
-    override fun update(input: ByteArray) {
+    override fun update(input: ByteArray, offset: Int, length: Int) {
         assertEquals(chunkSize, input.size, "Chunk size must be exactly $chunkSize")
         for (i in input.indices) {
             rollingHash[i] = (rollingHash[i] + input[i] + 1).toByte()
diff --git a/tests/codegen/event-stream/build.gradle.kts b/tests/codegen/event-stream/build.gradle.kts
@@ -136,9 +136,7 @@ dependencies {
     testImplementation(kotlin("test-junit5"))
     testImplementation("org.jetbrains.kotlinx:kotlinx-coroutines-test:$coroutinesVersion")
     testImplementation("aws.smithy.kotlin:smithy-test:$smithyKotlinVersion")
-
-    // TODO -- replace this once CRT is no longer the default signer
-    testImplementation("aws.smithy.kotlin:aws-signing-crt:$smithyKotlinVersion")
+    testImplementation("aws.smithy.kotlin:aws-signing-default:$smithyKotlinVersion")
 
     // have to manually add all the dependencies of the generated client(s)
     // doing it this way (as opposed to doing what we do for protocol-tests) allows
diff --git a/tests/codegen/event-stream/src/test/kotlin/EventStreamTests.kt b/tests/codegen/event-stream/src/test/kotlin/EventStreamTests.kt
@@ -11,8 +11,8 @@ import aws.sdk.kotlin.test.eventstream.restjson1.transform.deserializeTestStream
 import aws.sdk.kotlin.test.eventstream.restjson1.transform.serializeTestStreamOpOperationBody
 import aws.smithy.kotlin.runtime.auth.awscredentials.Credentials
 import aws.smithy.kotlin.runtime.auth.awssigning.AwsSigningAttributes
-import aws.smithy.kotlin.runtime.auth.awssigning.BodyHash
-import aws.smithy.kotlin.runtime.auth.awssigning.crt.CrtAwsSigner
+import aws.smithy.kotlin.runtime.auth.awssigning.DefaultAwsSigner
+import aws.smithy.kotlin.runtime.auth.awssigning.HashSpecification
 import aws.smithy.kotlin.runtime.client.ExecutionContext
 import aws.smithy.kotlin.runtime.http.HttpBody
 import aws.smithy.kotlin.runtime.http.content.ByteArrayContent
@@ -46,8 +46,8 @@ class EventStreamTests {
             attributes[AwsSigningAttributes.CredentialsProvider] = StaticCredentialsProvider(
                 Credentials("fake-access-key", "fake-secret-key")
             )
-            attributes[AwsSigningAttributes.RequestSignature] = BodyHash.EmptyBody.hash!!.encodeToByteArray()
-            attributes[AwsSigningAttributes.Signer] = CrtAwsSigner
+            attributes[AwsSigningAttributes.RequestSignature] = HashSpecification.EmptyBody.hash.encodeToByteArray()
+            attributes[AwsSigningAttributes.Signer] = DefaultAwsSigner
         }
 
         val body = serializeTestStreamOpOperationBody(testContext, req)

Original file line number	Diff line number	Diff line change
`@@ -29,9 +29,7 @@ kotlin {`
`29`	`29`	`dependencies {`
`30`	`30`	`implementation(project(":aws-runtime:testing"))`
`31`	`31`	`api("org.jetbrains.kotlinx:kotlinx-coroutines-test:$coroutinesVersion")`
`32`		`-`
`33`		`- // TODO -- replace this once CRT is no longer the default signer`
`34`		`- api("aws.smithy.kotlin:aws-signing-crt:$smithyKotlinVersion")`
	`32`	`+ implementation("aws.smithy.kotlin:aws-signing-default:$smithyKotlinVersion")`
`35`	`33`	`}`
`36`	`34`	`}`
`37`	`35`