Package software.amazon.awssdk.auth

Class AbstractAwsSigner

java.lang.Object

software.amazon.awssdk.auth.AbstractAwsSigner

All Implemented Interfaces:

Signer

Direct Known Subclasses:

Aws4Signer, QueryStringSigner

public abstract class AbstractAwsSigner
extends 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	Description
static String	EMPTY_STRING_SHA256_HEX

Constructor Summary

Constructors

Constructor	Description
AbstractAwsSigner()

Method Summary

Modifier and Type	Method	Description
byte[]	hash(byte[] data)	Hashes the binary data using the SHA-256 algorithm.
byte[]	hash(String text)	Hashes the string contents (assumed to be UTF-8) using the SHA-256 algorithm.
byte[]	sign(String stringData, byte[] key, SigningAlgorithm algorithm)
byte[]	signWithMac(String stringData, Mac mac)

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.auth.Signer

sign

Field Detail

EMPTY_STRING_SHA256_HEX

public static final String EMPTY_STRING_SHA256_HEX

Constructor Detail

AbstractAwsSigner

public AbstractAwsSigner()

Method Detail

signWithMac

public byte[] signWithMac(String stringData,
                          Mac mac)

sign

public byte[] sign(String stringData,
                   byte[] key,
                   SigningAlgorithm algorithm)
            throws SdkClientException

Throws:

SdkClientException

hash

public byte[] hash(String text)
            throws SdkClientException

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.

Throws:

SdkClientException - If the hash cannot be computed.

hash

public byte[] hash(byte[] data)
            throws SdkClientException

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:

SdkClientException - If the hash cannot be computed.