com.ibm.cloud.objectstorage.services.s3.internal

Class AWSS3V4Signer

java.lang.Object

com.ibm.cloud.objectstorage.auth.AbstractAWSSigner

com.ibm.cloud.objectstorage.auth.AWS4Signer

com.ibm.cloud.objectstorage.services.s3.internal.AWSS3V4Signer

All Implemented Interfaces:

Presigner, RegionAwareSigner, ServiceAwareSigner, Signer

public class AWSS3V4Signer
extends AWS4Signer

AWS4 signer implementation for Amazon Web Services S3

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
AWSS3V4Signer() Don't double-url-encode path elements; S3 expects path elements to be encoded only once in the canonical URI.

Method Summary

Modifier and Type	Method and Description
protected String	calculateContentHash(SignableRequest<?> request) Returns the pre-defined header value and set other necessary headers if the request needs to be chunk-encoded.
protected String	calculateContentHashPresign(SignableRequest<?> request) Calculate the hash of the request's payload.
protected void	processRequestPayload(SignableRequest<?> request, byte[] signature, byte[] signingKey, AWS4SignerRequestParams signerRequestParams) If necessary, creates a chunk-encoding wrapper on the request payload.

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

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

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

AWSS3V4Signer

public AWSS3V4Signer()

Don't double-url-encode path elements; S3 expects path elements to be encoded only once in the canonical URI.

Method Detail

processRequestPayload

protected void processRequestPayload(SignableRequest<?> request,
                                     byte[] signature,
                                     byte[] signingKey,
                                     AWS4SignerRequestParams signerRequestParams)

If necessary, creates a chunk-encoding wrapper on the request payload.

Overrides:

processRequestPayload in class AWS4Signer

calculateContentHashPresign

protected String calculateContentHashPresign(SignableRequest<?> request)

Description copied from class: AWS4Signer

Calculate the hash of the request's payload. In case of pre-sign, the existing code would generate the hash of an empty byte array and returns it. This method can be overridden by sub classes to provide different values (e.g) For S3 pre-signing, the content hash calculation is different from the general implementation.

Overrides:

calculateContentHashPresign in class AWS4Signer

calculateContentHash

protected String calculateContentHash(SignableRequest<?> request)

Returns the pre-defined header value and set other necessary headers if the request needs to be chunk-encoded. Otherwise calls the superclass method which calculates the hash of the whole content for signing.

Overrides:

calculateContentHash in class AWS4Signer