Skip to content

Reuse checksum on streaming retries + refactor ChecksumInterceptor #3500

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
sbaluja merged 15 commits into from
Aug 6, 2025
Merged

Reuse checksum on streaming retries + refactor ChecksumInterceptor #3500

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
6a2c33f
Reuse checksum on streaming request retries
sbaluja Jul 29, 2025
17879fd
Fix precalculated hash allocationtag namespace
sbaluja Jul 29, 2025
ddeb5ed
ChecksumInterceptor.h - Refactor ModifyBeforeSigning logic for reada…
sbaluja Jul 30, 2025
291e457
ChecksumInterceptor.h - use memory safe Aws::Array instead of Aws::Un…
sbaluja Jul 31, 2025
1d69ae4
Reuse checksum on streaming request retries
sbaluja Jul 29, 2025
0313bed
Fix precalculated hash allocationtag namespace
sbaluja Jul 29, 2025
ba83b78
ChecksumInterceptor.h - Refactor ModifyBeforeSigning logic for reada…
sbaluja Jul 30, 2025
f2dbd60
ChecksumInterceptor.h - use memory safe Aws::Array instead of Aws::Un…
sbaluja Jul 31, 2025
4a559fc
Merge branch 'ReuseStreamingChecksum' of https://github.com/aws/aws-s…
sbaluja Aug 1, 2025
28a4eb9
AmazonWebServiceRequest - RetryContext to be private, and contain a p…
sbaluja Aug 1, 2025
1e8009d
Remove explicit nullptr initialization
sbaluja Aug 1, 2025
085013f
Merge branch 'main' into ReuseStreamingChecksum
sbaluja Aug 5, 2025
31346fa
Merge branch 'main' into ReuseStreamingChecksum
sbaluja Aug 5, 2025
8cf5e0e
Merge branch 'main' into ReuseStreamingChecksum
sbaluja Aug 5, 2025
d60742b
Merge branch 'main' into ReuseStreamingChecksum
sbaluja Aug 6, 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
11 changes: 10 additions & 1 deletion src/aws-cpp-sdk-core/include/aws/core/AmazonWebServiceRequest.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ namespace Aws
typedef std::function<void(const AmazonWebServiceRequest&)> RequestRetryHandler;
typedef std::function<void(const Aws::Http::HttpRequest&)> RequestSignedHandler;

struct RetryContext {
std::shared_ptr<std::pair<Aws::String, std::shared_ptr<Aws::Utils::Crypto::Hash>>> m_requestHash;
};

/**
* Base level abstraction for all modeled AWS requests
*/
Expand Down Expand Up @@ -222,7 +226,11 @@ namespace Aws
*/
Aws::Set<Aws::Client::UserAgentFeature> GetUserAgentFeatures() const { return m_userAgentFeatures; }

inline virtual bool RequestChecksumRequired() const { return false; }
inline virtual bool RequestChecksumRequired() const { return false; }

RetryContext GetRetryContext() const { return m_retryContext; }

void SetRetryContext(const RetryContext& context) const { m_retryContext = context; }
protected:
/**
* Default does nothing. Override this to convert what would otherwise be the payload of the
Expand All @@ -242,6 +250,7 @@ namespace Aws
RequestRetryHandler m_requestRetryHandler;
mutable std::shared_ptr<Aws::Http::ServiceSpecificParameters> m_serviceSpecificParameters;
mutable Aws::Set<Client::UserAgentFeature> m_userAgentFeatures;
mutable Aws::RetryContext m_retryContext;
};

} // namespace Aws
Expand Down
159 changes: 93 additions & 66 deletions src/aws-cpp-sdk-core/include/smithy/client/features/ChecksumInterceptor.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
#include <aws/core/utils/crypto/Sha1.h>
#include <aws/core/utils/crypto/Sha256.h>
#include <smithy/interceptor/Interceptor.h>
#include <aws/core/utils/memory/stl/AWSArray.h>

#include <iomanip>

Expand Down Expand Up @@ -82,49 +83,10 @@ class ChecksumInterceptor : public smithy::interceptor::Interceptor {
// For non-streaming payload, the resolved checksum location is always header.
// For streaming payload, the resolved checksum location depends on whether it is an unsigned payload, we let
// AwsAuthSigner decide it.
if (request.IsStreaming() && checksumValueAndAlgorithmProvided) {
addChecksumFeatureForChecksumName(checksumAlgorithmName, request);
const auto hash = Aws::MakeShared<PrecalculatedHash>(AWS_SMITHY_CLIENT_CHECKSUM, checksumHeader->second);
httpRequest->SetRequestHash(checksumAlgorithmName, hash);
} else if (checksumValueAndAlgorithmProvided) {
httpRequest->SetHeaderValue(checksumType, checksumHeader->second);
} else if (checksumAlgorithmName == "crc64nvme") {
request.AddUserAgentFeature(Aws::Client::UserAgentFeature::FLEXIBLE_CHECKSUMS_REQ_CRC64);
if (request.IsStreaming()) {
httpRequest->SetRequestHash(checksumAlgorithmName, Aws::MakeShared<CRC64>(AWS_SMITHY_CLIENT_CHECKSUM));
} else {
httpRequest->SetHeaderValue(checksumType, HashingUtils::Base64Encode(HashingUtils::CalculateCRC64(*(GetBodyStream(request)))));
}
} else if (checksumAlgorithmName == "crc32") {
request.AddUserAgentFeature(Aws::Client::UserAgentFeature::FLEXIBLE_CHECKSUMS_REQ_CRC32);
if (request.IsStreaming()) {
httpRequest->SetRequestHash(checksumAlgorithmName, Aws::MakeShared<CRC32>(AWS_SMITHY_CLIENT_CHECKSUM));
} else {
httpRequest->SetHeaderValue(checksumType, HashingUtils::Base64Encode(HashingUtils::CalculateCRC32(*(GetBodyStream(request)))));
}
} else if (checksumAlgorithmName == "crc32c") {
request.AddUserAgentFeature(Aws::Client::UserAgentFeature::FLEXIBLE_CHECKSUMS_REQ_CRC32C);
if (request.IsStreaming()) {
httpRequest->SetRequestHash(checksumAlgorithmName, Aws::MakeShared<CRC32C>(AWS_SMITHY_CLIENT_CHECKSUM));
} else {
httpRequest->SetHeaderValue(checksumType, HashingUtils::Base64Encode(HashingUtils::CalculateCRC32C(*(GetBodyStream(request)))));
}
} else if (checksumAlgorithmName == "sha256") {
request.AddUserAgentFeature(Aws::Client::UserAgentFeature::FLEXIBLE_CHECKSUMS_REQ_SHA256);
if (request.IsStreaming()) {
httpRequest->SetRequestHash(checksumAlgorithmName, Aws::MakeShared<Sha256>(AWS_SMITHY_CLIENT_CHECKSUM));
} else {
httpRequest->SetHeaderValue(checksumType, HashingUtils::Base64Encode(HashingUtils::CalculateSHA256(*(GetBodyStream(request)))));
}
} else if (checksumAlgorithmName == "sha1") {
request.AddUserAgentFeature(Aws::Client::UserAgentFeature::FLEXIBLE_CHECKSUMS_REQ_SHA1);
if (request.IsStreaming()) {
httpRequest->SetRequestHash(checksumAlgorithmName, Aws::MakeShared<Sha1>(AWS_SMITHY_CLIENT_CHECKSUM));
} else {
httpRequest->SetHeaderValue(checksumType, HashingUtils::Base64Encode(HashingUtils::CalculateSHA1(*(GetBodyStream(request)))));
}
if (checksumValueAndAlgorithmProvided) {
handleProvidedChecksum(request, httpRequest, checksumAlgorithmName, checksumType, checksumHeader->second);
} else {
AWS_LOGSTREAM_WARN(AWS_SMITHY_CLIENT_CHECKSUM, "Checksum algorithm: " << checksumAlgorithmName << "is not supported by SDK.");
calculateAndSetChecksum(request, httpRequest, checksumAlgorithmName, checksumType);
}
}
}
Expand All @@ -133,30 +95,7 @@ class ChecksumInterceptor : public smithy::interceptor::Interceptor {
if ((!request.GetResponseChecksumAlgorithmNames().empty() &&
m_responseChecksumValidation == ResponseChecksumValidation::WHEN_SUPPORTED) ||
request.ShouldValidateResponseChecksum()) {
for (const Aws::String& responseChecksumAlgorithmName : request.GetResponseChecksumAlgorithmNames()) {
const auto responseChecksum = Aws::Utils::StringUtils::ToLower(responseChecksumAlgorithmName.c_str());
if (responseChecksum == "crc32c") {
std::shared_ptr<CRC32C> crc32c = Aws::MakeShared<CRC32C>(AWS_SMITHY_CLIENT_CHECKSUM);
httpRequest->AddResponseValidationHash("crc32c", crc32c);
} else if (responseChecksum == "crc32") {
std::shared_ptr<CRC32> crc32 = Aws::MakeShared<CRC32>(AWS_SMITHY_CLIENT_CHECKSUM);
httpRequest->AddResponseValidationHash("crc32", crc32);
} else if (responseChecksum == "sha1") {
std::shared_ptr<Sha1> sha1 = Aws::MakeShared<Sha1>(AWS_SMITHY_CLIENT_CHECKSUM);
httpRequest->AddResponseValidationHash("sha1", sha1);
} else if (responseChecksum == "sha256") {
std::shared_ptr<Sha256> sha256 = Aws::MakeShared<Sha256>(AWS_SMITHY_CLIENT_CHECKSUM);
httpRequest->AddResponseValidationHash("sha256", sha256);
} else if (responseChecksum == "crc64nvme") {
std::shared_ptr<CRC64> crc64 = Aws::MakeShared<CRC64>(AWS_SMITHY_CLIENT_CHECKSUM);
httpRequest->AddResponseValidationHash("crc64nvme", crc64);
} else {
AWS_LOGSTREAM_WARN(AWS_SMITHY_CLIENT_CHECKSUM,
"Checksum algorithm: " << responseChecksum << " is not supported in validating response body yet.");
}
}
// we have to set the checksum mode to enabled if it was not previously
httpRequest->SetHeaderValue("x-amz-checksum-mode", "enabled");
SetResponseChecksum(request, httpRequest);
}

return httpRequest;
Expand Down Expand Up @@ -233,6 +172,94 @@ class ChecksumInterceptor : public smithy::interceptor::Interceptor {
}
}

void handleProvidedChecksum(const Aws::AmazonWebServiceRequest& request, std::shared_ptr<Aws::Http::HttpRequest> httpRequest,
const Aws::String& algorithm, const Aws::String& checksumType, const Aws::String& checksumValue) {
if (request.IsStreaming()) {
addChecksumFeatureForChecksumName(algorithm, request);
if (httpRequest->GetRequestHash().second == nullptr) {
auto hash = Aws::MakeShared<PrecalculatedHash>(AWS_SMITHY_CLIENT_CHECKSUM, checksumValue);
httpRequest->SetRequestHash(algorithm, hash);
}
} else {
httpRequest->SetHeaderValue(checksumType, checksumValue);
}
}

void calculateAndSetChecksum(const Aws::AmazonWebServiceRequest& request, std::shared_ptr<Aws::Http::HttpRequest> httpRequest,
const Aws::String& algorithm, const Aws::String& checksumType) {
static const Aws::Array<std::pair<const char*, ChecksumHandler>, 5> algorithmMap = {{
std::make_pair("crc64nvme", ChecksumHandler{
[]() { return Aws::MakeShared<CRC64>(AWS_SMITHY_CLIENT_CHECKSUM); },
[](Aws::IOStream& stream) { return HashingUtils::Base64Encode(HashingUtils::CalculateCRC64(stream)); },
Aws::Client::UserAgentFeature::FLEXIBLE_CHECKSUMS_REQ_CRC64}),
std::make_pair("crc32", ChecksumHandler{
[]() { return Aws::MakeShared<CRC32>(AWS_SMITHY_CLIENT_CHECKSUM); },
[](Aws::IOStream& stream) { return HashingUtils::Base64Encode(HashingUtils::CalculateCRC32(stream)); },
Aws::Client::UserAgentFeature::FLEXIBLE_CHECKSUMS_REQ_CRC32}),
std::make_pair("crc32c", ChecksumHandler{
[]() { return Aws::MakeShared<CRC32C>(AWS_SMITHY_CLIENT_CHECKSUM); },
[](Aws::IOStream& stream) { return HashingUtils::Base64Encode(HashingUtils::CalculateCRC32C(stream)); },
Aws::Client::UserAgentFeature::FLEXIBLE_CHECKSUMS_REQ_CRC32C}),
std::make_pair("sha256", ChecksumHandler{
[]() { return Aws::MakeShared<Sha256>(AWS_SMITHY_CLIENT_CHECKSUM); },
[](Aws::IOStream& stream) { return HashingUtils::Base64Encode(HashingUtils::CalculateSHA256(stream)); },
Aws::Client::UserAgentFeature::FLEXIBLE_CHECKSUMS_REQ_SHA256}),
std::make_pair("sha1", ChecksumHandler{
[]() { return Aws::MakeShared<Sha1>(AWS_SMITHY_CLIENT_CHECKSUM); },
[](Aws::IOStream& stream) { return HashingUtils::Base64Encode(HashingUtils::CalculateSHA1(stream)); },
Aws::Client::UserAgentFeature::FLEXIBLE_CHECKSUMS_REQ_SHA1})
}};

const auto it = find_if(algorithmMap.begin(), algorithmMap.end(), [&](const std::pair<const char*, ChecksumHandler> &pair) { return algorithm == pair.first; });
if (it == algorithmMap.end()) {
AWS_LOGSTREAM_WARN(AWS_SMITHY_CLIENT_CHECKSUM, "Checksum algorithm: " << algorithm << " is not supported by SDK.");
return;
}

request.AddUserAgentFeature(it->second.userAgentFeature);

if (request.IsStreaming()) {
if (httpRequest->GetRequestHash().second == nullptr) {
httpRequest->SetRequestHash(algorithm, it->second.createHash());
}
} else {
httpRequest->SetHeaderValue(checksumType, it->second.calculateHash(*GetBodyStream(request)));
}
}

void SetResponseChecksum(const Aws::AmazonWebServiceRequest& request, std::shared_ptr<Aws::Http::HttpRequest> httpRequest) {
for (const Aws::String& responseChecksumAlgorithmName : request.GetResponseChecksumAlgorithmNames()) {
const auto responseChecksum = Aws::Utils::StringUtils::ToLower(responseChecksumAlgorithmName.c_str());
if (responseChecksum == "crc32c") {
std::shared_ptr<CRC32C> crc32c = Aws::MakeShared<CRC32C>(AWS_SMITHY_CLIENT_CHECKSUM);
httpRequest->AddResponseValidationHash("crc32c", crc32c);
} else if (responseChecksum == "crc32") {
std::shared_ptr<CRC32> crc32 = Aws::MakeShared<CRC32>(AWS_SMITHY_CLIENT_CHECKSUM);
httpRequest->AddResponseValidationHash("crc32", crc32);
} else if (responseChecksum == "sha1") {
std::shared_ptr<Sha1> sha1 = Aws::MakeShared<Sha1>(AWS_SMITHY_CLIENT_CHECKSUM);
httpRequest->AddResponseValidationHash("sha1", sha1);
} else if (responseChecksum == "sha256") {
std::shared_ptr<Sha256> sha256 = Aws::MakeShared<Sha256>(AWS_SMITHY_CLIENT_CHECKSUM);
httpRequest->AddResponseValidationHash("sha256", sha256);
} else if (responseChecksum == "crc64nvme") {
std::shared_ptr<CRC64> crc64 = Aws::MakeShared<CRC64>(AWS_SMITHY_CLIENT_CHECKSUM);
httpRequest->AddResponseValidationHash("crc64nvme", crc64);
} else {
AWS_LOGSTREAM_WARN(AWS_SMITHY_CLIENT_CHECKSUM,
"Checksum algorithm: " << responseChecksum << " is not supported in validating response body yet.");
}
}
// we have to set the checksum mode to enabled if it was not previously
httpRequest->SetHeaderValue("x-amz-checksum-mode", "enabled");
}

struct ChecksumHandler {
std::function<std::shared_ptr<Aws::Utils::Crypto::Hash>()> createHash;
std::function<Aws::String(Aws::IOStream&)> calculateHash;
Aws::Client::UserAgentFeature userAgentFeature;
};

RequestChecksumCalculation m_requestChecksumCalculation{RequestChecksumCalculation::WHEN_SUPPORTED};
ResponseChecksumValidation m_responseChecksumValidation{ResponseChecksumValidation::WHEN_SUPPORTED};
};
Expand Down
18 changes: 18 additions & 0 deletions src/aws-cpp-sdk-core/source/client/AWSClient.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,6 +389,17 @@ HttpResponseOutcome AWSClient::AttemptExhaustively(const Aws::Http::URI& uri,
{
newUri.SetAuthority(newEndpoint);
}

// Save checksum information from the original request if we haven't already - safe to assume that the checksum has been finalized, since we have sent and received a response
RetryContext context = request.GetRetryContext();
if (context.m_requestHash == nullptr) {
auto originalRequestHash = httpRequest->GetRequestHash();
if (originalRequestHash.second != nullptr) {
context.m_requestHash = Aws::MakeShared<std::pair<Aws::String, std::shared_ptr<Aws::Utils::Crypto::Hash>>>(AWS_CLIENT_LOG_TAG, originalRequestHash);
request.SetRetryContext(context);
}
}

httpRequest = CreateHttpRequest(newUri, method, request.GetResponseStreamFactory());

httpRequest->SetHeaderValue(Http::SDK_INVOCATION_ID_HEADER, invocationId);
Expand Down Expand Up @@ -920,6 +931,13 @@ void AWSClient::BuildHttpRequest(const Aws::AmazonWebServiceRequest& request, co
httpRequest->SetContinueRequestHandle(request.GetContinueRequestHandler());
httpRequest->SetServiceSpecificParameters(request.GetServiceSpecificParameters());
request.AddQueryStringParameters(httpRequest->GetUri());

// check for retry context, if present use it
RetryContext context = request.GetRetryContext();
if (context.m_requestHash != nullptr) {
const auto hash = Aws::MakeShared<Aws::Utils::Crypto::PrecalculatedHash>(smithy::client::AWS_SMITHY_CLIENT_CHECKSUM, HashingUtils::Base64Encode(context.m_requestHash->second->GetHash().GetResult()));
httpRequest->SetRequestHash(context.m_requestHash->first, hash);
}
}

Aws::String AWSClient::GeneratePresignedUrl(const Aws::Http::URI& uri, Aws::Http::HttpMethod method, long long expirationInSeconds, const std::shared_ptr<Aws::Http::ServiceSpecificParameters> serviceSpecificParameter)
Expand Down
Loading