com.ibm.cloud.objectstorage.auth

Class AWS4UnsignedPayloadSigner

java.lang.Object

com.ibm.cloud.objectstorage.auth.AbstractAWSSigner

com.ibm.cloud.objectstorage.auth.AWS4Signer

com.ibm.cloud.objectstorage.auth.AWS4UnsignedPayloadSigner

All Implemented Interfaces:

Presigner, RegionAwareSigner, ServiceAwareSigner, Signer

public class AWS4UnsignedPayloadSigner
extends AWS4Signer

Exactly the same as AWS4Signer except if the request is being sent over HTTPS, then it returns the string UNSIGNED-PAYLOAD as the content SHA-256 so services that support it can avoid needing to calculate the value when authorizing the request.

Payloads are still signed for requests over HTTP to preserve the request integrity over a non-secure transport.

Field Summary

Fields inherited from class com.ibm.cloud.objectstorage.auth.AWS4Signer

doubleUrlEncode, log, overriddenDate, regionName, serviceName

Fields inherited from class com.ibm.cloud.objectstorage.auth.AbstractAWSSigner

EMPTY_STRING_SHA256_HEX

Constructor Summary

Constructors

Constructor and Description
AWS4UnsignedPayloadSigner()
AWS4UnsignedPayloadSigner(SdkClock clock)

Method Summary

Modifier and Type	Method and Description
protected String	calculateContentHash(SignableRequest<?> request) Calculate the hash of the request's payload.
void	sign(SignableRequest<?> request, AWSCredentials credentials) Sign the given request with the given set of credentials.

Methods inherited from class com.ibm.cloud.objectstorage.auth.AWS4Signer

addHostHeader, addSessionCredentials, calculateContentHashPresign, computeSignature, createCanonicalRequest, createStringToSign, getCanonicalizedHeaderString, getOverriddenDate, getRegionName, getServiceName, getSignedHeadersString, newSigningKey, presignRequest, processRequestPayload, setOverrideDate, setRegionName, setServiceName, shouldExcludeHeaderFromSigning

Methods inherited from class com.ibm.cloud.objectstorage.auth.AbstractAWSSigner

getBinaryRequestPayload, getBinaryRequestPayloadStream, getBinaryRequestPayloadStreamWithoutQueryParams, getBinaryRequestPayloadWithoutQueryParams, getCanonicalizedEndpoint, getCanonicalizedQueryString, getCanonicalizedQueryString, getCanonicalizedResourcePath, getCanonicalizedResourcePath, getRequestPayload, getRequestPayloadWithoutQueryParams, getSignatureDate, getTimeOffset, hash, hash, hash, newString, sanitizeCredentials, sign, sign, signAndBase64Encode, signAndBase64Encode, signWithMac

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AWS4UnsignedPayloadSigner

public AWS4UnsignedPayloadSigner()

AWS4UnsignedPayloadSigner

public AWS4UnsignedPayloadSigner(SdkClock clock)

Method Detail

sign

public void sign(SignableRequest<?> request,
                 AWSCredentials credentials)

Description copied from interface: Signer

Sign the given request with the given set of credentials. Modifies the passed-in request to apply the signature.

Specified by:

sign in interface Signer

Overrides:

sign in class AWS4Signer

Parameters:

request - The request to sign.

credentials - The credentials to sign the request with.

calculateContentHash

protected String calculateContentHash(SignableRequest<?> request)

Description copied from class: AWS4Signer

Calculate the hash of the request's payload. Subclass could override this method to provide different values for "x-amz-content-sha256" header or do any other necessary set-ups on the request headers. (e.g. aws-chunked uses a pre-defined header value, and needs to change some headers relating to content-encoding and content-length.)

Overrides:

calculateContentHash in class AWS4Signer