Class SignerUtils

java.lang.Object

software.amazon.awssdk.http.auth.aws.internal.signer.util.SignerUtils

@SdkInternalApi
public final class SignerUtils
extends Object

Utility methods to be used by various AWS Signer implementations. This class is protected and subject to change.

Method Summary

Modifier and Type	Method	Description
static void	addDateHeader(SdkHttpRequest.Builder requestBuilder, String dateTime)	Add a date header using a datetime string
static void	addHostHeader(SdkHttpRequest.Builder requestBuilder)	Add the host header based on parameters of a request
static long	computeAndMoveContentLength(SdkHttpRequest.Builder request, ContentStreamProvider contentStreamProvider)	Move `Content-Length` to `x-amz-decoded-content-length` if not already present.
static byte[]	computeSignature(String stringToSign, byte[] signingKey)	Compute the signature of a string using a signing key.
static byte[]	deriveSigningKey(AwsCredentialsIdentity credentials, CredentialScope credentialScope)	Get the signing key based on the given credentials and a credential-scope
static String	formatDate(Instant instant)	Returns a string representation of the given datetime in yyyyMMdd format.
static String	formatDateTime(Instant instant)	Returns a string representation of the given datetime in yyyyMMdd'T'HHmmss'Z' format.
static InputStream	getBinaryRequestPayloadStream(ContentStreamProvider streamProvider)
static String	getContentHash(SdkHttpRequest.Builder requestBuilder)
static byte[]	hash(byte[] data)
static byte[]	hash(InputStream input)
static byte[]	hash(String text)
static byte[]	hash(ByteBuffer input)
static String	hashCanonicalRequest(String canonicalRequestString)	Create a hash of the canonical request string
static CompletableFuture<Pair<SdkHttpRequest.Builder,Optional<org.reactivestreams.Publisher<ByteBuffer>>>>	moveContentLength(SdkHttpRequest.Builder request, org.reactivestreams.Publisher<ByteBuffer> contentPublisher)	Move Content-Length` to `x-amz-decoded-content-length` if not already present.
static byte[]	sign(byte[] data, byte[] key, SigningAlgorithm algorithm)	Sign given data using a key and a specific algorithm
static byte[]	sign(String stringData, byte[] key)	Sign given data using a key.

Methods inherited from class java.lang.Object

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

Method Details

formatDate

public static String formatDate(Instant instant)

Returns a string representation of the given datetime in yyyyMMdd format. The date returned is in the UTC zone.

For example, given an Instant with millis-value of 1416863450581, this method returns "20141124"

formatDateTime

public static String formatDateTime(Instant instant)

Returns a string representation of the given datetime in yyyyMMdd'T'HHmmss'Z' format. The date returned is in the UTC zone.

For example, given an Instant with millis-value of 1416863450581, this method returns "20141124T211050Z"

hashCanonicalRequest

public static String hashCanonicalRequest(String canonicalRequestString)

Create a hash of the canonical request string

Step 2 of the AWS Signature version 4 calculation. Refer to https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html#create-canonical-request-hash.

deriveSigningKey

public static byte[] deriveSigningKey(AwsCredentialsIdentity credentials,
 CredentialScope credentialScope)

Get the signing key based on the given credentials and a credential-scope

sign

public static byte[] sign(String stringData,
 byte[] key)

Sign given data using a key.

sign

public static byte[] sign(byte[] data,
 byte[] key,
 SigningAlgorithm algorithm)

Sign given data using a key and a specific algorithm

computeSignature

public static byte[] computeSignature(String stringToSign,
 byte[] signingKey)

Compute the signature of a string using a signing key.

Step 4 of the AWS Signature version 4 calculation. Refer to https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html#calculate-signature.

addHostHeader

public static void addHostHeader(SdkHttpRequest.Builder requestBuilder)

Add the host header based on parameters of a request

addDateHeader

public static void addDateHeader(SdkHttpRequest.Builder requestBuilder,
 String dateTime)

Add a date header using a datetime string

computeAndMoveContentLength

public static long computeAndMoveContentLength(SdkHttpRequest.Builder request,
 ContentStreamProvider contentStreamProvider)

Move `Content-Length` to `x-amz-decoded-content-length` if not already present. If `Content-Length` is not present, then the payload is read in its entirety to calculate the length.

moveContentLength

public static CompletableFuture<Pair<SdkHttpRequest.Builder,Optional<org.reactivestreams.Publisher<ByteBuffer>>>> moveContentLength(SdkHttpRequest.Builder request,
 org.reactivestreams.Publisher<ByteBuffer> contentPublisher)

Move Content-Length` to `x-amz-decoded-content-length` if not already present. If `Content-Length` is not present, the future is completed exceptionally. Note: this behavior differs from the sync version computeAndMoveContentLength(SdkHttpRequest.Builder, ContentStreamProvider) as the sync version reads the entire stream to compute the length if the header is not present. The async version was introduced after the sync version; moving forward, requests that have an unknown content length should be done through chunked transfer encoding.

getBinaryRequestPayloadStream

public static InputStream getBinaryRequestPayloadStream(ContentStreamProvider streamProvider)

hash

public static byte[] hash(InputStream input)

hash

public static byte[] hash(ByteBuffer input)

hash

public static byte[] hash(byte[] data)

hash

public static byte[] hash(String text)

getContentHash

public static String getContentHash(SdkHttpRequest.Builder requestBuilder)