com.amazonaws.auth

Class AbstractAWSSigner

java.lang.Object

com.amazonaws.auth.AbstractAWSSigner

All Implemented Interfaces:

Signer

Direct Known Subclasses:

AWS3Signer, AWS4Signer, QueryStringSigner

public abstract class AbstractAWSSigner
extends java.lang.Object
implements Signer

Abstract base class for AWS signing protocol implementations. Provides utilities commonly needed by signing protocols such as computing canonicalized host names, query string parameters, etc.

Not intended to be sub-classed by developers.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EMPTY_STRING_SHA256_HEX Empty sha256 hex.

Constructor Summary

Constructors

Constructor and Description
AbstractAWSSigner()

Method Summary

Modifier and Type	Method and Description
protected abstract void	addSessionCredentials(Request<?> request, AWSSessionCredentials credentials) Adds session credentials to the request given.
protected byte[]	getBinaryRequestPayload(Request<?> request) Returns the request's payload as binary data.
protected java.io.InputStream	getBinaryRequestPayloadStream(Request<?> request)
protected java.io.InputStream	getBinaryRequestPayloadStreamWithoutQueryParams(Request<?> request)
protected byte[]	getBinaryRequestPayloadWithoutQueryParams(Request<?> request) Returns the request's payload contents as binary data, without processing any query string params (i.e.
protected java.lang.String	getCanonicalizedEndpoint(java.net.URI endpoint)
protected java.lang.String	getCanonicalizedQueryString(java.util.Map<java.lang.String,java.lang.String> parameters) Examines the specified query string parameters and returns a canonicalized form.
protected java.lang.String	getCanonicalizedQueryString(Request<?> request)
protected java.lang.String	getCanonicalizedResourcePath(java.lang.String resourcePath)
protected java.lang.String	getCanonicalizedResourcePath(java.lang.String resourcePath, boolean urlEncode)
protected java.lang.String	getRequestPayload(Request<?> request) Returns the request's payload as a String.
protected java.lang.String	getRequestPayloadWithoutQueryParams(Request<?> request) Returns the request's payload contents as a String, without processing any query string params (i.e.
protected java.util.Date	getSignatureDate(long timeOffset)
protected long	getTimeOffset(Request<?> request)
byte[]	hash(byte[] data) Hashes the binary data using the SHA-256 algorithm.
protected byte[]	hash(java.io.InputStream input)
byte[]	hash(java.lang.String text) Hashes the string contents (assumed to be UTF-8) using the SHA-256 algorithm.
protected java.lang.String	newString(byte[] bytes) Safely converts a UTF-8 encoded byte array into a String.
protected AWSCredentials	sanitizeCredentials(AWSCredentials credentials) Loads the individual access key ID and secret key from the specified credentials, ensuring that access to the credentials is synchronized on the credentials object itself, and trimming any extra whitespace from the credentials.
protected byte[]	sign(byte[] data, byte[] key, SigningAlgorithm algorithm)
byte[]	sign(java.lang.String stringData, byte[] key, SigningAlgorithm algorithm) Signs using the given signing algorithm.
protected java.lang.String	signAndBase64Encode(byte[] data, java.lang.String key, SigningAlgorithm algorithm) Computes an RFC 2104-compliant HMAC signature for an array of bytes and returns the result as a Base64 encoded string.
protected java.lang.String	signAndBase64Encode(java.lang.String data, java.lang.String key, SigningAlgorithm algorithm) Computes an RFC 2104-compliant HMAC signature and returns the result as a Base64 encoded string.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amazonaws.auth.Signer

sign

Field Detail

EMPTY_STRING_SHA256_HEX

public static final java.lang.String EMPTY_STRING_SHA256_HEX

Empty sha256 hex.

Constructor Detail

AbstractAWSSigner

public AbstractAWSSigner()

Method Detail

signAndBase64Encode

protected java.lang.String signAndBase64Encode(java.lang.String data,
                                               java.lang.String key,
                                               SigningAlgorithm algorithm)

Computes an RFC 2104-compliant HMAC signature and returns the result as a Base64 encoded string.

signAndBase64Encode

protected java.lang.String signAndBase64Encode(byte[] data,
                                               java.lang.String key,
                                               SigningAlgorithm algorithm)

Computes an RFC 2104-compliant HMAC signature for an array of bytes and returns the result as a Base64 encoded string.

sign

public byte[] sign(java.lang.String stringData,
                   byte[] key,
                   SigningAlgorithm algorithm)

Signs using the given signing algorithm.

Parameters:

stringData - the data.

key - the key in bytes.

algorithm - the signing algorithm.

Returns:

signed result in bytes.

sign

protected byte[] sign(byte[] data,
                      byte[] key,
                      SigningAlgorithm algorithm)

hash

public byte[] hash(java.lang.String text)

Hashes the string contents (assumed to be UTF-8) using the SHA-256 algorithm.

Parameters:

text - The string to hash.

Returns:

The hashed bytes from the specified string.

hash

protected byte[] hash(java.io.InputStream input)

hash

public byte[] hash(byte[] data)

Hashes the binary data using the SHA-256 algorithm.

Parameters:

data - The binary data to hash.

Returns:

The hashed bytes from the specified data.

Throws:

AmazonClientException - If the hash cannot be computed.

getCanonicalizedQueryString

protected java.lang.String getCanonicalizedQueryString(java.util.Map<java.lang.String,java.lang.String> parameters)

Examines the specified query string parameters and returns a canonicalized form.

The canonicalized query string is formed by first sorting all the query string parameters, then URI encoding both the key and value and then joining them, in order, separating key value pairs with an '&'.

Parameters:

parameters - The query string parameters to be canonicalized.

Returns:

A canonicalized form for the specified query string parameters.

getCanonicalizedQueryString

protected java.lang.String getCanonicalizedQueryString(Request<?> request)

getBinaryRequestPayload

protected byte[] getBinaryRequestPayload(Request<?> request)

Returns the request's payload as binary data.

Parameters:

request - The request

Returns:

The data from the request's payload, as binary data.

getRequestPayload

protected java.lang.String getRequestPayload(Request<?> request)

Returns the request's payload as a String.

Parameters:

request - The request

Returns:

The data from the request's payload, as a string.

getRequestPayloadWithoutQueryParams

protected java.lang.String getRequestPayloadWithoutQueryParams(Request<?> request)

Returns the request's payload contents as a String, without processing any query string params (i.e. no form encoding for query params).

Parameters:

request - The request

Returns:

the request's payload contents as a String, not including any form encoding of query string params.

getBinaryRequestPayloadWithoutQueryParams

protected byte[] getBinaryRequestPayloadWithoutQueryParams(Request<?> request)

Returns the request's payload contents as binary data, without processing any query string params (i.e. no form encoding for query params).

Parameters:

request - The request

Returns:

The request's payload contents as binary data, not including any form encoding of query string params.

getBinaryRequestPayloadStream

protected java.io.InputStream getBinaryRequestPayloadStream(Request<?> request)

getBinaryRequestPayloadStreamWithoutQueryParams

protected java.io.InputStream getBinaryRequestPayloadStreamWithoutQueryParams(Request<?> request)

getCanonicalizedResourcePath

protected java.lang.String getCanonicalizedResourcePath(java.lang.String resourcePath)

getCanonicalizedResourcePath

protected java.lang.String getCanonicalizedResourcePath(java.lang.String resourcePath,
                                                        boolean urlEncode)

getCanonicalizedEndpoint

protected java.lang.String getCanonicalizedEndpoint(java.net.URI endpoint)

sanitizeCredentials

protected AWSCredentials sanitizeCredentials(AWSCredentials credentials)

Loads the individual access key ID and secret key from the specified credentials, ensuring that access to the credentials is synchronized on the credentials object itself, and trimming any extra whitespace from the credentials.

Returns either a BasicSessionCredentials or a BasicAWSCredentials object, depending on the input type.

Parameters:

credentials -

Returns:

A new credentials object with the sanitized credentials.

newString

protected java.lang.String newString(byte[] bytes)

Safely converts a UTF-8 encoded byte array into a String.

Parameters:

bytes - UTF-8 encoded binary character data.

Returns:

The converted String object.

getSignatureDate

protected java.util.Date getSignatureDate(long timeOffset)

getTimeOffset

protected long getTimeOffset(Request<?> request)

addSessionCredentials

protected abstract void addSessionCredentials(Request<?> request,
                                              AWSSessionCredentials credentials)

Adds session credentials to the request given.

Parameters:

request - The request to add session credentials information to

credentials - The session credentials to add to the request