Support for payload signing + chunked encoding in DefaultAwsV4HttpSigner #6466
+1,246
−376
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "type": "feature", | ||
| "category": "AWS SDK for Java v2", | ||
| "contributor": "", | ||
| "description": "Add support for payload signing of async streaming requests signed with SigV4 using default `AwsV4HttpSigner` (using `AwsV4HttpSigner.create()`). Note, requests using the `http` URI scheme will not be signed regardless of the value of `AwsV4FamilyHttpSigner.PAYLOAD_SIGNING_ENABLED` to remain consistent with existing behavior. This may change in a future release." | ||
| } | ||
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,28 +23,35 @@ | |
| import static software.amazon.awssdk.http.auth.aws.internal.signer.util.SignerConstant.STREAMING_SIGNED_PAYLOAD_TRAILER; | ||
| import static software.amazon.awssdk.http.auth.aws.internal.signer.util.SignerConstant.STREAMING_UNSIGNED_PAYLOAD_TRAILER; | ||
| import static software.amazon.awssdk.http.auth.aws.internal.signer.util.SignerConstant.X_AMZ_CONTENT_SHA256; | ||
| import static software.amazon.awssdk.http.auth.aws.internal.signer.util.SignerConstant.X_AMZ_DECODED_CONTENT_LENGTH; | ||
| import static software.amazon.awssdk.http.auth.aws.internal.signer.util.SignerConstant.X_AMZ_TRAILER; | ||
| import static software.amazon.awssdk.http.auth.aws.internal.signer.util.SignerUtils.computeAndMoveContentLength; | ||
|
|
||
| import java.nio.ByteBuffer; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.util.ArrayList; | ||
| import java.util.Collections; | ||
| import java.util.List; | ||
| import java.util.Optional; | ||
| import java.util.concurrent.CompletableFuture; | ||
| import org.reactivestreams.Publisher; | ||
| import software.amazon.awssdk.annotations.SdkInternalApi; | ||
| import software.amazon.awssdk.checksums.SdkChecksum; | ||
| import software.amazon.awssdk.checksums.spi.ChecksumAlgorithm; | ||
| import software.amazon.awssdk.http.ContentStreamProvider; | ||
| import software.amazon.awssdk.http.Header; | ||
| import software.amazon.awssdk.http.SdkHttpRequest; | ||
| import software.amazon.awssdk.http.auth.aws.internal.signer.chunkedencoding.AsyncChunkEncodedPayload; | ||
| import software.amazon.awssdk.http.auth.aws.internal.signer.chunkedencoding.ChecksumTrailerProvider; | ||
| import software.amazon.awssdk.http.auth.aws.internal.signer.chunkedencoding.ChunkedEncodedInputStream; | ||
| import software.amazon.awssdk.http.auth.aws.internal.signer.chunkedencoding.ChunkedEncodedPayload; | ||
| import software.amazon.awssdk.http.auth.aws.internal.signer.chunkedencoding.ChunkedEncodedPublisher; | ||
| import software.amazon.awssdk.http.auth.aws.internal.signer.chunkedencoding.SigV4ChunkExtensionProvider; | ||
| import software.amazon.awssdk.http.auth.aws.internal.signer.chunkedencoding.SigV4TrailerProvider; | ||
| import software.amazon.awssdk.http.auth.aws.internal.signer.chunkedencoding.SyncChunkEncodedPayload; | ||
| import software.amazon.awssdk.http.auth.aws.internal.signer.chunkedencoding.TrailerProvider; | ||
| import software.amazon.awssdk.http.auth.aws.internal.signer.io.ResettableContentStreamProvider; | ||
| import software.amazon.awssdk.http.auth.aws.internal.signer.util.SignerUtils; | ||
| import software.amazon.awssdk.http.auth.spi.signer.PayloadChecksumStore; | ||
| import software.amazon.awssdk.utils.BinaryUtils; | ||
| import software.amazon.awssdk.utils.Logger; | ||
|
|
@@ -79,81 +86,140 @@ public static Builder builder() { | |
|
|
||
| @Override | ||
| public ContentStreamProvider sign(ContentStreamProvider payload, V4RequestSigningResult requestSigningResult) { | ||
| ChunkedEncodedInputStream.Builder chunkedEncodedInputStreamBuilder = ChunkedEncodedInputStream | ||
| .builder() | ||
| .inputStream(payload.newStream()) | ||
| .chunkSize(chunkSize) | ||
| .header(chunk -> Integer.toHexString(chunk.remaining()).getBytes(StandardCharsets.UTF_8)); | ||
|
|
||
| SyncChunkEncodedPayload chunkedPayload = new SyncChunkEncodedPayload(chunkedEncodedInputStreamBuilder); | ||
| signCommon(chunkedPayload, requestSigningResult); | ||
|
|
||
| return new ResettableContentStreamProvider(chunkedEncodedInputStreamBuilder::build); | ||
| } | ||
|
|
||
| @Override | ||
| public Publisher<ByteBuffer> signAsync(Publisher<ByteBuffer> payload, V4RequestSigningResult requestSigningResult) { | ||
| ChunkedEncodedPublisher.Builder chunkedStreamBuilder = ChunkedEncodedPublisher.builder() | ||
| .publisher(payload) | ||
| .chunkSize(chunkSize) | ||
| .addEmptyTrailingChunk(true); | ||
|
|
||
| AsyncChunkEncodedPayload chunkedPayload = new AsyncChunkEncodedPayload(chunkedStreamBuilder); | ||
| signCommon(chunkedPayload, requestSigningResult); | ||
|
|
||
| return chunkedStreamBuilder.build(); | ||
| } | ||
|
|
||
| private void signCommon(ChunkedEncodedPayload payload, V4RequestSigningResult requestSigningResult) { | ||
| preExistingTrailers.forEach(t -> payload.addTrailer(() -> t)); | ||
|
|
||
| SdkHttpRequest.Builder request = requestSigningResult.getSignedRequest(); | ||
|
|
||
| payload.decodedContentLength(request.firstMatchingHeader(X_AMZ_DECODED_CONTENT_LENGTH) | ||
| .map(Long::parseLong) | ||
| .orElseThrow(() -> { | ||
| String msg = String.format("Expected header '%s' to be present", | ||
| X_AMZ_DECODED_CONTENT_LENGTH); | ||
| return new RuntimeException(msg); | ||
| })); | ||
|
|
||
| String checksum = request.firstMatchingHeader(X_AMZ_CONTENT_SHA256).orElseThrow( | ||
| () -> new IllegalArgumentException(X_AMZ_CONTENT_SHA256 + " must be set!") | ||
| ); | ||
|
|
||
| switch (checksum) { | ||
| case STREAMING_SIGNED_PAYLOAD: { | ||
| RollingSigner rollingSigner = new RollingSigner(requestSigningResult.getSigningKey(), | ||
| requestSigningResult.getSignature()); | ||
| payload.addExtension(new SigV4ChunkExtensionProvider(rollingSigner, credentialScope)); | ||
| break; | ||
| } | ||
| case STREAMING_UNSIGNED_PAYLOAD_TRAILER: | ||
| setupChecksumTrailerIfNeeded(payload); | ||
| break; | ||
| case STREAMING_SIGNED_PAYLOAD_TRAILER: { | ||
| setupChecksumTrailerIfNeeded(payload); | ||
| RollingSigner rollingSigner = new RollingSigner(requestSigningResult.getSigningKey(), | ||
| requestSigningResult.getSignature()); | ||
| payload.addExtension(new SigV4ChunkExtensionProvider(rollingSigner, credentialScope)); | ||
| payload.addTrailer( | ||
| new SigV4TrailerProvider(payload.trailers(), rollingSigner, credentialScope) | ||
| ); | ||
| break; | ||
| } | ||
| default: | ||
| throw new UnsupportedOperationException(); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void beforeSigning(SdkHttpRequest.Builder request, ContentStreamProvider payload) { | ||
| long encodedContentLength = 0; | ||
| long contentLength = SignerUtils.computeAndMoveContentLength(request, payload); | ||
| setupPreExistingTrailers(request); | ||
|
|
||
| // pre-existing trailers | ||
| encodedContentLength = calculateEncodedContentLength(request, contentLength); | ||
|
|
||
| if (checksumAlgorithm != null) { | ||
| String checksumHeaderName = checksumHeaderName(checksumAlgorithm); | ||
| request.appendHeader(X_AMZ_TRAILER, checksumHeaderName); | ||
| } | ||
| request.putHeader(Header.CONTENT_LENGTH, Long.toString(encodedContentLength)); | ||
| request.appendHeader(CONTENT_ENCODING, AWS_CHUNKED); | ||
| } | ||
|
|
||
| @Override | ||
| public CompletableFuture<Pair<SdkHttpRequest.Builder, Optional<Publisher<ByteBuffer>>>> beforeSigningAsync( | ||
| SdkHttpRequest.Builder request, Publisher<ByteBuffer> payload) { | ||
| return computeAndMoveContentLength(request, payload) | ||
| .thenApply(p -> { | ||
| SdkHttpRequest.Builder requestBuilder = p.left(); | ||
| setupPreExistingTrailers(requestBuilder); | ||
|
|
||
| long decodedContentLength = requestBuilder.firstMatchingHeader(X_AMZ_DECODED_CONTENT_LENGTH) | ||
| .map(Long::parseLong) | ||
| // should not happen, this header is added by moveContentLength | ||
| .orElseThrow(() -> new RuntimeException(X_AMZ_DECODED_CONTENT_LENGTH | ||
| + " header not present")); | ||
|
Comment on lines
+183
to
+185
There was a problem hiding this comment. Should we fail the future instead? There was a problem hiding this comment. Hmm it should fail the future right? CompletableFuture<String> c1 = new CompletableFuture<>();
c1.complete("Hello");
CompletableFuture<String> c2 = c1.thenApply(s -> {
throw new RuntimeException();
});
c2.join(); // throws |
||
|
|
||
| long encodedContentLength = calculateEncodedContentLength(request, decodedContentLength); | ||
|
|
||
| if (checksumAlgorithm != null) { | ||
| String checksumHeaderName = checksumHeaderName(checksumAlgorithm); | ||
| request.appendHeader(X_AMZ_TRAILER, checksumHeaderName); | ||
| } | ||
| request.putHeader(Header.CONTENT_LENGTH, Long.toString(encodedContentLength)); | ||
|
There was a problem hiding this comment. I thought content-length header is not required, is that not the case? There was a problem hiding this comment. Hmm not sure. Per the public docs, it's required unless This logic is preserved from the existing signer code @Fred1155 do you have any other info on this? |
||
| request.appendHeader(CONTENT_ENCODING, AWS_CHUNKED); | ||
| return Pair.of(requestBuilder, p.right()); | ||
| }); | ||
| } | ||
|
|
||
| private long calculateEncodedContentLength(SdkHttpRequest.Builder requestBuilder, long decodedContentLength) { | ||
| long encodedContentLength = 0; | ||
|
|
||
| encodedContentLength += calculateExistingTrailersLength(); | ||
|
|
||
| String checksum = requestBuilder.firstMatchingHeader(X_AMZ_CONTENT_SHA256).orElseThrow( | ||
| () -> new IllegalArgumentException(X_AMZ_CONTENT_SHA256 + " must be set!") | ||
| ); | ||
|
|
||
| switch (checksum) { | ||
| case STREAMING_SIGNED_PAYLOAD: { | ||
| long extensionsLength = 81; // ;chunk-signature:<sigv4 hex signature, 64 bytes> | ||
| encodedContentLength += calculateChunksLength(decodedContentLength, extensionsLength); | ||
| break; | ||
| } | ||
| case STREAMING_UNSIGNED_PAYLOAD_TRAILER: | ||
| if (checksumAlgorithm != null) { | ||
| encodedContentLength += calculateChecksumTrailerLength(checksumHeaderName(checksumAlgorithm)); | ||
| } | ||
| encodedContentLength += calculateChunksLength(decodedContentLength, 0); | ||
| break; | ||
| case STREAMING_SIGNED_PAYLOAD_TRAILER: { | ||
| long extensionsLength = 81; // ;chunk-signature:<sigv4 hex signature, 64 bytes> | ||
| encodedContentLength += calculateChunksLength(decodedContentLength, extensionsLength); | ||
| if (checksumAlgorithm != null) { | ||
| encodedContentLength += calculateChecksumTrailerLength(checksumHeaderName(checksumAlgorithm)); | ||
| } | ||
|
|
@@ -167,12 +233,7 @@ public void beforeSigning(SdkHttpRequest.Builder request, ContentStreamProvider | |
| // terminating \r\n | ||
| encodedContentLength += 2; | ||
|
|
||
| return encodedContentLength; | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -256,12 +317,7 @@ private long calculateChecksumTrailerLength(String checksumHeaderName) { | |
| return lengthInBytes + 2; | ||
| } | ||
|
|
||
| private void setupChecksumTrailerIfNeeded(ChunkedEncodedPayload payload) { | ||
| if (checksumAlgorithm == null) { | ||
| return; | ||
| } | ||
|
|
@@ -273,20 +329,17 @@ private void setupChecksumTrailerIfNeeded(ChunkedEncodedInputStream.Builder buil | |
| if (cachedChecksum != null) { | ||
| LOG.debug(() -> String.format("Cached payload checksum available for algorithm %s: %s. Using cached value", | ||
| checksumAlgorithm.algorithmId(), checksumHeaderName)); | ||
| payload.addTrailer(() -> Pair.of(checksumHeaderName, Collections.singletonList(cachedChecksum))); | ||
| return; | ||
| } | ||
|
|
||
| SdkChecksum sdkChecksum = fromChecksumAlgorithm(checksumAlgorithm); | ||
|
|
||
| TrailerProvider checksumTrailer = | ||
| new ChecksumTrailerProvider(sdkChecksum, checksumHeaderName, checksumAlgorithm, payloadChecksumStore); | ||
|
|
||
| payload.checksumPayload(sdkChecksum); | ||
| payload.addTrailer(checksumTrailer); | ||
| } | ||
|
|
||
| private String getCachedChecksum() { | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.