Class AwsRequestSigner

java.lang.Object

com.google.auth.oauth2.AwsRequestSigner

class AwsRequestSigner
extends Object

Internal utility that signs AWS API requests based on the AWS Signature Version 4 signing process.

See Also:

• AWS Signature V4

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	AwsRequestSigner.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<String,String>	additionalHeaders
private static final String	AWS_REQUEST_TYPE
private final AwsSecurityCredentials	awsSecurityCredentials
private final AwsDates	dates
private static final String	HASHING_ALGORITHM
private final String	httpMethod
private final String	region
private final String	requestPayload
private final URI	uri

Constructor Summary

Constructors

Modifier	Constructor	Description
private	AwsRequestSigner(AwsSecurityCredentials awsSecurityCredentials, String httpMethod, String url, String region, String requestPayload, Map<String,String> additionalHeaders, AwsDates awsDates)	Internal constructor.

Method Summary

Modifier and Type	Method	Description
private String	calculateAwsV4Signature(String serviceName, String secret, String date, String region, String stringToSign)	Task 3: Calculate the signature for AWS Signature Version 4.
private String	createCanonicalRequestHash(Map<String,String> headers, List<String> sortedHeaderNames)	Task 1: Create a canonical request for Signature Version 4.
private String	createStringToSign(String canonicalRequestHash, String xAmzDate, String credentialScope)	Task 2: Create a string to sign for Signature Version 4.
private String	generateAuthorizationHeader(List<String> sortedHeaderNames, String accessKeyId, String credentialScope, String signature)	Task 4: Format the signature to be added to the HTTP request.
private Map<String,String>	getCanonicalHeaders(String defaultDate)
private static String	getHexEncodedSha256Hash(byte[] bytes)
(package private) static AwsRequestSigner.Builder	newBuilder(AwsSecurityCredentials awsSecurityCredentials, String httpMethod, String url, String region)
(package private) AwsRequestSignature	sign()	Signs the specified AWS API request.
private static byte[]	sign(byte[] key, byte[] value)

Methods inherited from class Object

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

Field Details

HASHING_ALGORITHM

private static final String HASHING_ALGORITHM

See Also:

• Constant Field Values

AWS_REQUEST_TYPE

private static final String AWS_REQUEST_TYPE

See Also:

• Constant Field Values

awsSecurityCredentials

private final AwsSecurityCredentials awsSecurityCredentials

additionalHeaders

private final Map<String,String> additionalHeaders

httpMethod

private final String httpMethod

region

private final String region

requestPayload

private final String requestPayload

uri

private final URI uri

dates

private final AwsDates dates

Constructor Details

AwsRequestSigner

private AwsRequestSigner(AwsSecurityCredentials awsSecurityCredentials,
 String httpMethod,
 String url,
 String region,
 @Nullable
 String requestPayload,
 @Nullable
 Map<String,String> additionalHeaders,
 @Nullable
 AwsDates awsDates)

Internal constructor.

Parameters:

awsSecurityCredentials - AWS security credentials

httpMethod - the HTTP request method

url - the request URL

region - the targeted region

requestPayload - the request payload

additionalHeaders - a map of additional HTTP headers to be included with the signed request

Method Details

sign

AwsRequestSignature sign()

Signs the specified AWS API request.

Returns:

the AwsRequestSignature

createCanonicalRequestHash

private String createCanonicalRequestHash(Map<String,String> headers,
 List<String> sortedHeaderNames)

Task 1: Create a canonical request for Signature Version 4.

createStringToSign

private String createStringToSign(String canonicalRequestHash,
 String xAmzDate,
 String credentialScope)

Task 2: Create a string to sign for Signature Version 4.

calculateAwsV4Signature

private String calculateAwsV4Signature(String serviceName,
 String secret,
 String date,
 String region,
 String stringToSign)

Task 3: Calculate the signature for AWS Signature Version 4.

Parameters:

date - the date used in the hashing process in YYYYMMDD format

generateAuthorizationHeader

private String generateAuthorizationHeader(List<String> sortedHeaderNames,
 String accessKeyId,
 String credentialScope,
 String signature)

Task 4: Format the signature to be added to the HTTP request.

getCanonicalHeaders

private Map<String,String> getCanonicalHeaders(String defaultDate)

sign

private static byte[] sign(byte[] key,
 byte[] value)

getHexEncodedSha256Hash

private static String getHexEncodedSha256Hash(byte[] bytes)

newBuilder

static AwsRequestSigner.Builder newBuilder(AwsSecurityCredentials awsSecurityCredentials,
 String httpMethod,
 String url,
 String region)