Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Do not sign Transfer-Encoding Header if present on the request #5895

Merged
merged 3 commits into from
Feb 20, 2025
Merged

Do not sign Transfer-Encoding Header if present on the request #5895

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
317f4dd
Do not sign Transfer-Encoding Header if present on the request
joviegas Feb 20, 2025
d5cb049
Added changelogs
joviegas Feb 20, 2025
ef305db
Added skip in HeaderTransformsHelper too , to be consistent
joviegas Feb 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changes/next-release/bugfix-AWSSDKforJavav2-ed80b40.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"type": "bugfix",
"category": "AWS SDK for Java v2",
"contributor": "",
"description": "Transfer-Encoding headers will no longer be signed during SigV4 authentication"
}
2 changes: 1 addition & 1 deletion core/auth/src/main/java/software/amazon/awssdk/auth/signer/internal/AbstractAws4Signer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ public abstract class AbstractAws4Signer<T extends Aws4SignerParams, U extends A
private static final FifoCache<SignerKey> SIGNER_CACHE =
new FifoCache<>(SIGNER_CACHE_MAX_SIZE);
private static final List<String> LIST_OF_HEADERS_TO_IGNORE_IN_LOWER_CASE =
Arrays.asList("connection", "x-amzn-trace-id", "user-agent", "expect");
Arrays.asList("connection", "x-amzn-trace-id", "user-agent", "expect", "transfer-encoding");
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have the same list in HeaderTransformsHelper used by AwsS3V4ChunkSigner, do we need to add TE there also?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nope , it is not required here because SDK add only one Header(singletonMap) via this function , that is checksum header and its always "x-amz-checksum-XYZ"

aws-sdk-java-v2/core/auth/src/main/java/software/amazon/awssdk/auth/signer/internal/chunkedencoding/AwsS3V4ChunkSigner.java

Lines 104 to 106 in 6c74e87

Map<String, List<String>> canonicalizeSigningHeaders = canonicalizeSigningHeaders(
Collections.singletonMap(checksumHeaderForTrailer, Arrays.asList(BinaryUtils.toBase64(calculatedChecksum))));
String canonicalizedHeaderString = getCanonicalizedHeaderString(canonicalizeSigningHeaders);

Copy link
Contributor Author

@joviegas joviegas Feb 20, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can add it just to make it consistent , I think its better to add this just to be consistent and avoid further confusion , will add test directly on HeaderTransformsHelper

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.


protected SdkHttpFullRequest.Builder doSign(SdkHttpFullRequest request,
Aws4SignerRequestParams requestParams,
Expand Down
15 changes: 15 additions & 0 deletions core/auth/src/test/java/software/amazon/awssdk/auth/signer/Aws4SignerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -398,4 +398,19 @@ public void signing_with_Crc32Checksum_with__trailer_header_already_present() th
assertThat(signed.firstMatchingHeader(SignerConstant.X_AMZ_CONTENT_SHA256)).isNotPresent();
assertThat(signed.firstMatchingHeader("Authorization")).hasValue(expectedAuthorization);
}


@Test
public void TransferEncodingIsNotSigned_NotSigned() {
AwsBasicCredentials credentials = AwsBasicCredentials.create("akid", "skid");
SdkHttpFullRequest.Builder request = generateBasicRequest();
request.putHeader("Transfer-Encoding", "chunked");

SdkHttpFullRequest actual = SignerTestUtils.signRequest(signer, request.build(), credentials, "demo", signingOverrideClock, "us-east-1");

assertThat(actual.firstMatchingHeader("Authorization"))
.hasValue("AWS4-HMAC-SHA256 Credential=akid/19810216/us-east-1/demo/aws4_request, " +
"SignedHeaders=host;x-amz-archive-description;x-amz-date, " +
"Signature=581d0042389009a28d461124138f1fe8eeb8daed87611d2a2b47fd3d68d81d73");
}
}
2 changes: 1 addition & 1 deletion ...rc/main/java/software/amazon/awssdk/http/auth/aws/internal/signer/V4CanonicalRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
@Immutable
public final class V4CanonicalRequest {
private static final List<String> HEADERS_TO_IGNORE_IN_LOWER_CASE =
Arrays.asList("connection", "x-amzn-trace-id", "user-agent", "expect");
Arrays.asList("connection", "x-amzn-trace-id", "user-agent", "expect", "transfer-encoding");

private final SdkHttpRequest request;
private final String contentHash;
Expand Down
1 change: 1 addition & 0 deletions ...est/java/software/amazon/awssdk/http/auth/aws/internal/signer/V4CanonicalRequestTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ public void canonicalRequest_WithForbiddenHeaders_shouldExcludeForbidden() {
.method(SdkHttpMethod.PUT)
.putHeader("foo", "bar")
.putHeader("x-amzn-trace-id", "wontBePresent")
.putHeader("Transfer-Encoding", "wontBePresent")
.build();
V4CanonicalRequest cr = new V4CanonicalRequest(request, "sha-256",
new V4CanonicalRequest.Options(true,
Expand Down
15 changes: 10 additions & 5 deletions ...asses-test/src/test/java/software/amazon/awssdk/services/AsyncRequestCompressionTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.reactivestreams.Subscriber;
import software.amazon.awssdk.auth.credentials.AnonymousCredentialsProvider;
import software.amazon.awssdk.auth.credentials.AwsBasicCredentials;
import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider;
import software.amazon.awssdk.core.SdkBytes;
import software.amazon.awssdk.core.async.AsyncRequestBody;
import software.amazon.awssdk.core.async.AsyncResponseTransformer;
Expand All @@ -44,17 +45,19 @@
public class AsyncRequestCompressionTest {
private static final String UNCOMPRESSED_BODY =
"RequestCompressionTest-RequestCompressionTest-RequestCompressionTest-RequestCompressionTest-RequestCompressionTest";
private static String TRANSFER_ENCODING_HEADER = "Transfer-Encoding";
private String compressedBody;
private int compressedLen;
private MockAsyncHttpClient mockAsyncHttpClient;
private ProtocolRestJsonAsyncClient asyncClient;
private Compressor compressor;
private static final AwsBasicCredentials CLIENT_CREDENTIALS = AwsBasicCredentials.create("akid", "skid");

@BeforeEach
public void setUp() {
mockAsyncHttpClient = new MockAsyncHttpClient();
asyncClient = ProtocolRestJsonAsyncClient.builder()
.credentialsProvider(AnonymousCredentialsProvider.create())
.credentialsProvider(StaticCredentialsProvider.create(CLIENT_CREDENTIALS))
.region(Region.US_EAST_1)
.httpClient(mockAsyncHttpClient)
.build();
Expand Down Expand Up @@ -129,7 +132,9 @@ public void asyncStreamingOperation_compressionEnabled_compressesCorrectly() {
assertThat(loggedBody).isEqualTo(compressedBody);
assertThat(loggedRequest.firstMatchingHeader("Content-encoding").get()).isEqualTo("gzip");
assertThat(loggedRequest.matchingHeaders("Content-Length")).isEmpty();
assertThat(loggedRequest.firstMatchingHeader("Transfer-Encoding").get()).isEqualTo("chunked");
assertThat(loggedRequest.firstMatchingHeader(TRANSFER_ENCODING_HEADER).get()).isEqualTo("chunked");
assertThat(loggedRequest.firstMatchingHeader("Authorization").get())
.doesNotContainIgnoringCase(TRANSFER_ENCODING_HEADER);
}

@Test
Expand Down Expand Up @@ -172,8 +177,8 @@ public void asyncStreamingOperation_compressionEnabledWithRetry_compressesCorrec

assertThat(loggedBody).isEqualTo(compressedBody);
assertThat(loggedRequest.firstMatchingHeader("Content-encoding").get()).isEqualTo("gzip");
assertThat(loggedRequest.matchingHeaders("Content-Length")).isEmpty();
assertThat(loggedRequest.firstMatchingHeader("Transfer-Encoding").get()).isEqualTo("chunked");
assertThat(loggedRequest.matchingHeaders("Content-Length")).isEmpty();assertThat(loggedRequest.firstMatchingHeader(TRANSFER_ENCODING_HEADER).get()).isEqualTo("chunked");
assertThat(loggedRequest.firstMatchingHeader("Authorization").get()).doesNotContainIgnoringCase(TRANSFER_ENCODING_HEADER);
}

private HttpExecuteResponse mockResponse() {
Expand Down
Loading