Skip to content

Reuse computed checkums for async payloads #6441

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

Merged
merged 2 commits into from
Sep 25, 2025
Merged

Reuse computed checkums for async payloads #6441

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eb7d0e1
Reuse computed checkums for async payloads
dagnir Sep 19, 2025
4c45bb4
Fix cross module issue
dagnir Sep 24, 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
10 changes: 5 additions & 5 deletions .../software/amazon/awssdk/http/auth/aws/crt/internal/signer/AwsChunkedV4aPayloadSigner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ private AwsChunkedV4aPayloadSigner(Builder builder) {
this.credentialScope = Validate.paramNotNull(builder.credentialScope, "CredentialScope");
this.chunkSize = Validate.isPositive(builder.chunkSize, "ChunkSize");
this.checksumAlgorithm = builder.checksumAlgorithm;
this.payloadChecksumStore = builder.payloadChecksumStore == null ? NoOpPayloadChecksumStore.create() :
builder.payloadChecksumStore;
this.payloadChecksumStore = builder.checksumStore == null ? NoOpPayloadChecksumStore.create() :
builder.checksumStore;
}

public static Builder builder() {
Expand Down Expand Up @@ -282,7 +282,7 @@ static final class Builder {
private CredentialScope credentialScope;
private Integer chunkSize;
private ChecksumAlgorithm checksumAlgorithm;
private PayloadChecksumStore payloadChecksumStore;
private PayloadChecksumStore checksumStore;

public Builder credentialScope(CredentialScope credentialScope) {
this.credentialScope = credentialScope;
Expand All @@ -299,8 +299,8 @@ public Builder checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm) {
return this;
}

public Builder checksumCache(PayloadChecksumStore checksumCache) {
this.payloadChecksumStore = checksumCache;
public Builder checksumStore(PayloadChecksumStore checksumStore) {
this.checksumStore = checksumStore;
return this;
}

Expand Down
10 changes: 5 additions & 5 deletions .../software/amazon/awssdk/http/auth/aws/crt/internal/signer/DefaultAwsCrtV4aHttpSigner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
import static software.amazon.awssdk.http.auth.aws.internal.signer.util.CredentialUtils.sanitizeCredentials;
import static software.amazon.awssdk.http.auth.aws.internal.signer.util.SignerConstant.PRESIGN_URL_MAX_EXPIRATION_DURATION;
import static software.amazon.awssdk.http.auth.aws.internal.signer.util.SignerConstant.X_AMZ_TRAILER;
import static software.amazon.awssdk.http.auth.spi.signer.SdkInternalHttpSignerProperty.CHECKSUM_CACHE;
import static software.amazon.awssdk.http.auth.spi.signer.SdkInternalHttpSignerProperty.CHECKSUM_STORE;

import java.time.Clock;
import java.time.Duration;
Expand Down Expand Up @@ -73,7 +73,7 @@ public final class DefaultAwsCrtV4aHttpSigner implements AwsV4aHttpSigner {

@Override
public SignedRequest sign(SignRequest<? extends AwsCredentialsIdentity> request) {
Checksummer checksummer = checksummer(request, null, checksumCache(request));
Checksummer checksummer = checksummer(request, null, checksumStore(request));
V4aProperties v4aProperties = v4aProperties(request);
AwsSigningConfig signingConfig = signingConfig(request, v4aProperties);
V4aPayloadSigner payloadSigner = v4aPayloadSigner(request, v4aProperties);
Expand Down Expand Up @@ -120,7 +120,7 @@ private static V4aPayloadSigner v4aPayloadSigner(
.credentialScope(v4aProperties.getCredentialScope())
.chunkSize(DEFAULT_CHUNK_SIZE_IN_BYTES)
.checksumAlgorithm(request.property(CHECKSUM_ALGORITHM))
.checksumCache(checksumCache(request))
.checksumStore(checksumStore(request))
.build();
}

Expand Down Expand Up @@ -257,8 +257,8 @@ private static V4aRequestSigningResult sign(SdkHttpRequest request, HttpRequest
signingConfig);
}

private static PayloadChecksumStore checksumCache(SignRequest<? extends AwsCredentialsIdentity> request) {
PayloadChecksumStore cache = request.property(CHECKSUM_CACHE);
private static PayloadChecksumStore checksumStore(SignRequest<? extends AwsCredentialsIdentity> request) {
PayloadChecksumStore cache = request.property(CHECKSUM_STORE);
if (cache == null) {
return NoOpPayloadChecksumStore.create();
}
Expand Down
10 changes: 5 additions & 5 deletions .../java/software/amazon/awssdk/http/auth/aws/internal/signer/AwsChunkedV4PayloadSigner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ private AwsChunkedV4PayloadSigner(Builder builder) {
this.credentialScope = Validate.paramNotNull(builder.credentialScope, "CredentialScope");
this.chunkSize = Validate.isPositive(builder.chunkSize, "ChunkSize");
this.checksumAlgorithm = builder.checksumAlgorithm;
this.payloadChecksumStore = builder.payloadChecksumStore == null ? NoOpPayloadChecksumStore.create() :
builder.payloadChecksumStore;
this.payloadChecksumStore = builder.checksumStore == null ? NoOpPayloadChecksumStore.create() :
builder.checksumStore;
}

public static Builder builder() {
Expand Down Expand Up @@ -301,7 +301,7 @@ static class Builder {
private CredentialScope credentialScope;
private Integer chunkSize;
private ChecksumAlgorithm checksumAlgorithm;
private PayloadChecksumStore payloadChecksumStore;
private PayloadChecksumStore checksumStore;

public Builder credentialScope(CredentialScope credentialScope) {
this.credentialScope = credentialScope;
Expand All @@ -318,8 +318,8 @@ public Builder checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm) {
return this;
}

public Builder checksumCache(PayloadChecksumStore payloadChecksumStore) {
this.payloadChecksumStore = payloadChecksumStore;
public Builder checksumStore(PayloadChecksumStore checksumStore) {
this.checksumStore = checksumStore;
return this;
}

Expand Down
10 changes: 5 additions & 5 deletions ...ain/java/software/amazon/awssdk/http/auth/aws/internal/signer/DefaultAwsV4HttpSigner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
import static software.amazon.awssdk.http.auth.aws.internal.signer.util.OptionalDependencyLoaderUtil.getEventStreamV4PayloadSigner;
import static software.amazon.awssdk.http.auth.aws.internal.signer.util.SignerConstant.PRESIGN_URL_MAX_EXPIRATION_DURATION;
import static software.amazon.awssdk.http.auth.aws.internal.signer.util.SignerConstant.X_AMZ_TRAILER;
import static software.amazon.awssdk.http.auth.spi.signer.SdkInternalHttpSignerProperty.CHECKSUM_CACHE;
import static software.amazon.awssdk.http.auth.spi.signer.SdkInternalHttpSignerProperty.CHECKSUM_STORE;

import java.time.Clock;
import java.time.Duration;
Expand Down Expand Up @@ -57,7 +57,7 @@ public final class DefaultAwsV4HttpSigner implements AwsV4HttpSigner {

@Override
public SignedRequest sign(SignRequest<? extends AwsCredentialsIdentity> request) {
Checksummer checksummer = checksummer(request, null, checksumCache(request));
Checksummer checksummer = checksummer(request, null, checksumStore(request));
V4Properties v4Properties = v4Properties(request);
V4RequestSigner v4RequestSigner = v4RequestSigner(request, v4Properties);
V4PayloadSigner payloadSigner = v4PayloadSigner(request, v4Properties);
Expand Down Expand Up @@ -170,7 +170,7 @@ private static V4PayloadSigner v4PayloadSigner(
return AwsChunkedV4PayloadSigner.builder()
.credentialScope(properties.getCredentialScope())
.chunkSize(DEFAULT_CHUNK_SIZE_IN_BYTES)
.checksumCache(checksumCache(request))
.checksumStore(checksumStore(request))
.checksumAlgorithm(request.property(CHECKSUM_ALGORITHM))
.build();
}
Expand Down Expand Up @@ -265,8 +265,8 @@ private static boolean isBetweenInclusive(Duration start, Duration x, Duration e
return start.compareTo(x) <= 0 && x.compareTo(end) <= 0;
}

private static PayloadChecksumStore checksumCache(SignRequest<? extends AwsCredentialsIdentity> request) {
PayloadChecksumStore cache = request.property(CHECKSUM_CACHE);
private static PayloadChecksumStore checksumStore(SignRequest<? extends AwsCredentialsIdentity> request) {
PayloadChecksumStore cache = request.property(CHECKSUM_STORE);
if (cache == null) {
return NoOpPayloadChecksumStore.create();
}
Expand Down
10 changes: 5 additions & 5 deletions .../amazon/awssdk/http/auth/aws/internal/signer/chunkedencoding/ChecksumTrailerProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,14 @@ public class ChecksumTrailerProvider implements TrailerProvider {
private final SdkChecksum checksum;
private final String checksumName;
private final ChecksumAlgorithm checksumAlgorithm;
private final PayloadChecksumStore checksumCache;
private final PayloadChecksumStore checksumStore;

public ChecksumTrailerProvider(SdkChecksum checksum, String checksumName, ChecksumAlgorithm checksumAlgorithm,
PayloadChecksumStore checksumCache) {
PayloadChecksumStore checksumStore) {
this.checksum = checksum;
this.checksumName = checksumName;
this.checksumAlgorithm = checksumAlgorithm;
this.checksumCache = checksumCache;
this.checksumStore = checksumStore;
}

@Override
Expand All @@ -47,10 +47,10 @@ public void reset() {

@Override
public Pair<String, List<String>> get() {
byte[] checksumBytes = checksumCache.getChecksumValue(checksumAlgorithm);
byte[] checksumBytes = checksumStore.getChecksumValue(checksumAlgorithm);
if (checksumBytes == null) {
checksumBytes = checksum.getChecksumBytes();
checksumCache.putChecksumValue(checksumAlgorithm, checksumBytes);
checksumStore.putChecksumValue(checksumAlgorithm, checksumBytes);
}

return Pair.of(
Expand Down
14 changes: 7 additions & 7 deletions ...tware/amazon/awssdk/http/auth/aws/crt/internal/signer/DefaultAwsCrtV4aHttpSignerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
import static software.amazon.awssdk.http.auth.aws.signer.AwsV4aHttpSigner.PAYLOAD_SIGNING_ENABLED;
import static software.amazon.awssdk.http.auth.aws.signer.AwsV4aHttpSigner.REGION_SET;
import static software.amazon.awssdk.http.auth.spi.signer.HttpSigner.SIGNING_CLOCK;
import static software.amazon.awssdk.http.auth.spi.signer.SdkInternalHttpSignerProperty.CHECKSUM_CACHE;
import static software.amazon.awssdk.http.auth.spi.signer.SdkInternalHttpSignerProperty.CHECKSUM_STORE;

import java.io.ByteArrayInputStream;
import java.io.IOException;
Expand Down Expand Up @@ -461,7 +461,7 @@ void sign_WithPayloadSigningTrue_chunkEncodingFalse_cacheContainsChecksum_usesCa
signRequest -> signRequest
.putProperty(PAYLOAD_SIGNING_ENABLED, true)
.putProperty(CHUNK_ENCODING_ENABLED, false)
.putProperty(CHECKSUM_CACHE, cache)
.putProperty(CHECKSUM_STORE, cache)
);

SignedRequest signedRequest = signer.sign(request);
Expand All @@ -480,7 +480,7 @@ void sign_WithPayloadSigningTrue_chunkEncodingFalse_cacheEmpty_storesComputedChe
signRequest -> signRequest
.putProperty(PAYLOAD_SIGNING_ENABLED, true)
.putProperty(CHUNK_ENCODING_ENABLED, false)
.putProperty(CHECKSUM_CACHE, cache)
.putProperty(CHECKSUM_STORE, cache)
);

SignedRequest signedRequest = signer.sign(request);
Expand All @@ -502,7 +502,7 @@ void sign_WithPayloadSigningFalse_chunkEncodingTrue_cacheEmpty_storesComputedChe
.putProperty(PAYLOAD_SIGNING_ENABLED, false)
.putProperty(CHUNK_ENCODING_ENABLED, true)
.putProperty(CHECKSUM_ALGORITHM, CRC32)
.putProperty(CHECKSUM_CACHE, cache)
.putProperty(CHECKSUM_STORE, cache)
);

SignedRequest signedRequest = signer.sign(request);
Expand All @@ -529,7 +529,7 @@ void sign_WithPayloadSigningFalse_chunkEncodingTrue_cacheContainsChecksum_usesCa
.putProperty(PAYLOAD_SIGNING_ENABLED, false)
.putProperty(CHUNK_ENCODING_ENABLED, true)
.putProperty(CHECKSUM_ALGORITHM, CRC32)
.putProperty(CHECKSUM_CACHE, cache)
.putProperty(CHECKSUM_STORE, cache)
);

SignedRequest signedRequest = signer.sign(request);
Expand All @@ -553,7 +553,7 @@ void sign_withPayloadSigningTrue_chunkEncodingFalse_withChecksum_cacheContainsCr
.putProperty(PAYLOAD_SIGNING_ENABLED, true)
.putProperty(CHUNK_ENCODING_ENABLED, false)
.putProperty(CHECKSUM_ALGORITHM, CRC32)
.putProperty(CHECKSUM_CACHE, cache)
.putProperty(CHECKSUM_STORE, cache)
);

SignedRequest signedRequest = signer.sign(request);
Expand All @@ -574,7 +574,7 @@ void sign_withPayloadSigningTrue_chunkEncodingFalse_withChecksum_cacheEmpty_stor
.putProperty(PAYLOAD_SIGNING_ENABLED, true)
.putProperty(CHUNK_ENCODING_ENABLED, false)
.putProperty(CHECKSUM_ALGORITHM, CRC32)
.putProperty(CHECKSUM_CACHE, cache)
.putProperty(CHECKSUM_STORE, cache)
);

signer.sign(request);
Expand Down
14 changes: 7 additions & 7 deletions ...java/software/amazon/awssdk/http/auth/aws/internal/signer/DefaultAwsV4HttpSignerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
import static software.amazon.awssdk.http.auth.aws.signer.AwsV4HttpSigner.CHUNK_ENCODING_ENABLED;
import static software.amazon.awssdk.http.auth.aws.signer.AwsV4HttpSigner.EXPIRATION_DURATION;
import static software.amazon.awssdk.http.auth.aws.signer.AwsV4HttpSigner.PAYLOAD_SIGNING_ENABLED;
import static software.amazon.awssdk.http.auth.spi.signer.SdkInternalHttpSignerProperty.CHECKSUM_CACHE;
import static software.amazon.awssdk.http.auth.spi.signer.SdkInternalHttpSignerProperty.CHECKSUM_STORE;

import java.io.IOException;
import java.net.URI;
Expand Down Expand Up @@ -882,7 +882,7 @@ void sign_WithPayloadSigningTrue_chunkEncodingFalse_cacheContainsChecksum_usesCa
signRequest -> signRequest
.putProperty(PAYLOAD_SIGNING_ENABLED, true)
.putProperty(CHUNK_ENCODING_ENABLED, false)
.putProperty(CHECKSUM_CACHE, cache)
.putProperty(CHECKSUM_STORE, cache)
);

SignedRequest signedRequest = signer.sign(request);
Expand All @@ -901,7 +901,7 @@ void sign_WithPayloadSigningTrue_chunkEncodingFalse_cacheEmpty_storesComputedChe
signRequest -> signRequest
.putProperty(PAYLOAD_SIGNING_ENABLED, true)
.putProperty(CHUNK_ENCODING_ENABLED, false)
.putProperty(CHECKSUM_CACHE, cache)
.putProperty(CHECKSUM_STORE, cache)
);

SignedRequest signedRequest = signer.sign(request);
Expand All @@ -923,7 +923,7 @@ void sign_WithPayloadSigningFalse_chunkEncodingTrue_cacheEmpty_storesComputedChe
.putProperty(PAYLOAD_SIGNING_ENABLED, false)
.putProperty(CHUNK_ENCODING_ENABLED, true)
.putProperty(CHECKSUM_ALGORITHM, CRC32)
.putProperty(CHECKSUM_CACHE, cache)
.putProperty(CHECKSUM_STORE, cache)
);

SignedRequest signedRequest = signer.sign(request);
Expand All @@ -950,7 +950,7 @@ void sign_WithPayloadSigningFalse_chunkEncodingTrue_cacheContainsChecksum_usesCa
.putProperty(PAYLOAD_SIGNING_ENABLED, false)
.putProperty(CHUNK_ENCODING_ENABLED, true)
.putProperty(CHECKSUM_ALGORITHM, CRC32)
.putProperty(CHECKSUM_CACHE, cache)
.putProperty(CHECKSUM_STORE, cache)
);

SignedRequest signedRequest = signer.sign(request);
Expand All @@ -977,7 +977,7 @@ void sign_withPayloadSigningTrue_chunkEncodingFalse_withChecksum_cacheContainsCr
.putProperty(PAYLOAD_SIGNING_ENABLED, true)
.putProperty(CHUNK_ENCODING_ENABLED, false)
.putProperty(CHECKSUM_ALGORITHM, CRC32)
.putProperty(CHECKSUM_CACHE, cache)
.putProperty(CHECKSUM_STORE, cache)
);

SignedRequest signedRequest = signer.sign(request);
Expand All @@ -998,7 +998,7 @@ void sign_withPayloadSigningTrue_chunkEncodingFalse_withChecksum_cacheEmpty_stor
.putProperty(PAYLOAD_SIGNING_ENABLED, true)
.putProperty(CHUNK_ENCODING_ENABLED, false)
.putProperty(CHECKSUM_ALGORITHM, CRC32)
.putProperty(CHECKSUM_CACHE, cache)
.putProperty(CHECKSUM_STORE, cache)
);

signer.sign(request);
Expand Down
6 changes: 3 additions & 3 deletions .../main/java/software/amazon/awssdk/http/auth/spi/signer/SdkInternalHttpSignerProperty.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@
public final class SdkInternalHttpSignerProperty {

/**
* A cache for storing checksums calculated for a payload.
* An object for storing checksums calculated for a payload.
*
* <p>Note, checksums may not be relevant to some signers.
*/
public static final SignerProperty<PayloadChecksumStore> CHECKSUM_CACHE =
SignerProperty.create(SdkInternalHttpSignerProperty.class, "ChecksumCache");
public static final SignerProperty<PayloadChecksumStore> CHECKSUM_STORE =
SignerProperty.create(SdkInternalHttpSignerProperty.class, "ChecksumStore");

private SdkInternalHttpSignerProperty() {
}
Expand Down
6 changes: 3 additions & 3 deletions .../src/main/java/software/amazon/awssdk/core/interceptor/SdkInternalExecutionAttribute.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,10 +207,10 @@ public final class SdkInternalExecutionAttribute extends SdkExecutionAttribute {
"TokenConfiguredFromEnv");

/**
* The cache used by {@link HttpSigner} implementations to store payload checksums.
* The store used by {@link HttpSigner} implementations to store payload checksums.
*/
public static final ExecutionAttribute<PayloadChecksumStore> CHECKSUM_CACHE =
new ExecutionAttribute<>("ChecksumCache");
public static final ExecutionAttribute<PayloadChecksumStore> CHECKSUM_STORE =
new ExecutionAttribute<>("ChecksumStore");

/**
* The backing attribute for RESOLVED_CHECKSUM_SPECS.
Expand Down
Loading