Fix AWS SigV4 on delete requests when using AWS SDK's Apache client #1256
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The AWS SDK's Apache client implementation does not send the `Content-Length` header on DELETE requests, but the header is being set before calculating the signature. This causes the Amazon OpenSearch Service to report an incorrect signature as it does not receive the header value needed to validate the signature. `Content-Length` is somewhat unreliable to include in the signature calculation, but the AWS SDK doesn't allow configuring which headers to ignore in signature calculation. As such we must move setting the header to after the signature is calculated. Additionally moves to the supported `AwsV4HttpSigner` as `Aws4Signer` is now deprecated: https://github.com/aws/aws-sdk-java-v2/blob/88abec27e7d5d35b21545c7e05875a7cc3d0f46e/core/auth/src/main/java/software/amazon/awssdk/auth/signer/Aws4Signer.java Signed-off-by: Thomas Farr <[email protected]>
Xtansia
requested review from
reta,
Bukhtawar,
dblock,
szczepanczykd,
madhusudhankonda,
saratvemulapalli and
VachaShah
as code owners
Signed-off-by: Thomas Farr <[email protected]>
Signed-off-by: Thomas Farr <[email protected]>
reta
reviewed
Nov 1, 2024
| "awsSdk2SupportCompileOnly"("software.amazon.awssdk", "sdk-core", "[2.21,3.0)") | ||
| "awsSdk2SupportCompileOnly"("software.amazon.awssdk", "auth", "[2.21,3.0)") | ||
| "awsSdk2SupportCompileOnly"("software.amazon.awssdk", "http-auth-aws", "[2.21,3.0)") | ||
| testImplementation("software.amazon.awssdk", "sdk-core", "[2.21,3.0)") |
There was a problem hiding this comment.
I believe we should be using awsSdk2SupportTestImplementation here:
Suggested change
| testImplementation("software.amazon.awssdk", "sdk-core", "[2.21,3.0)") | |
| awsSdk2SupportTestImplementation("software.amazon.awssdk", "sdk-core", "[2.21,3.0)") |
reta
reviewed
Nov 1, 2024
| @@ -85,6 +87,7 @@ public class AwsSdk2Transport implements OpenSearchTransport { | |||
| private final String signingServiceName; | |||
| private final Region signingRegion; | |||
| private final JsonpMapper defaultMapper; | |||
| @Nonnull | |||
There was a problem hiding this comment.
No particular take on that, but I believe all these fields should not be null.
reta
reviewed
Nov 1, 2024
| } | ||
|
|
||
| // Apache 2.0 | ||
| testImplementation("org.wiremock", "wiremock", "3.9.2") |
There was a problem hiding this comment.
Nothing against wiremock, but we already have all needed pieces:
HttpServerthat comes from HttpCore 5 (example https://github.com/apache/httpcomponents-core/blob/master/httpcore5-reactive/src/test/java/org/apache/hc/core5/reactive/examples/ReactiveFullDuplexServerExample.java)- since we run test with JDK-11, we could use
com.sun.net.httpserver.HttpServerthat comes with standard library (see please https://docs.oracle.com/en/java/javase/11/docs/api/jdk.httpserver/com/sun/net/httpserver/HttpServer.html)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The AWS SDK's Apache client implementation does not send the
Content-Lengthheader on DELETE requests, but the header is being set before calculating the signature. This causes the Amazon OpenSearch Service to report an incorrect signature as it does not receive the header value needed to validate the signature.Content-Lengthis somewhat unreliable to include in the signature calculation, but the AWS SDK doesn't allow configuring which headers to ignore in signature calculation. As such we must move setting the header to after the signature is calculated.Additionally moves to the supported
AwsV4HttpSignerasAws4Signeris now deprecated: https://github.com/aws/aws-sdk-java-v2/blob/88abec27e7d5d35b21545c7e05875a7cc3d0f46e/core/auth/src/main/java/software/amazon/awssdk/auth/signer/Aws4Signer.javaIssues Resolved
Fixes #712
Fixes #521
Fixes #503
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.