com.github.davidmoten.aws.lw.client.internal.auth

Class AwsSignatureVersion4

java.lang.Object

com.github.davidmoten.aws.lw.client.internal.auth.AwsSignatureVersion4

public final class AwsSignatureVersion4
extends Object

Common methods and properties for all AWS4 signer variants

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALGORITHM
static String	EMPTY_BODY_SHA256 SHA256 hash of an empty request body
static String	SCHEME
static String	TERMINATOR
static String	UNSIGNED_PAYLOAD

Method Summary

Modifier and Type	Method and Description
static String	computeSignatureForAuthorizationHeader(URL endpointUrl, String httpMethod, String serviceName, String regionName, Clock clock, Map<String,String> headers, Map<String,String> queryParameters, String bodyHash, String awsAccessKey, String awsSecretKey) Computes an AWS4 signature for a request, ready for inclusion as an 'Authorization' header.
static String	computeSignatureForQueryAuth(URL endpointUrl, String httpMethod, String serviceName, Optional<String> regionName, Clock clock, Map<String,String> headers, Map<String,String> queryParameters, String bodyHash, String awsAccessKey, String awsSecretKey, Optional<String> sessionToken) Computes an AWS4 authorization for a request, suitable for embedding in query parameters.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_BODY_SHA256

public static final String EMPTY_BODY_SHA256

SHA256 hash of an empty request body

See Also:

Constant Field Values

UNSIGNED_PAYLOAD

public static final String UNSIGNED_PAYLOAD

See Also:

Constant Field Values

SCHEME

public static final String SCHEME

See Also:

Constant Field Values

ALGORITHM

public static final String ALGORITHM

See Also:

Constant Field Values

TERMINATOR

public static final String TERMINATOR

See Also:

Constant Field Values

Method Detail

computeSignatureForQueryAuth

public static String computeSignatureForQueryAuth(URL endpointUrl,
                                                  String httpMethod,
                                                  String serviceName,
                                                  Optional<String> regionName,
                                                  Clock clock,
                                                  Map<String,String> headers,
                                                  Map<String,String> queryParameters,
                                                  String bodyHash,
                                                  String awsAccessKey,
                                                  String awsSecretKey,
                                                  Optional<String> sessionToken)

Computes an AWS4 authorization for a request, suitable for embedding in query parameters.

Parameters:

endpointUrl - the url to which the request is being made

httpMethod - the HTTP method (GET, POST, PUT, etc.)

serviceName - the AWS service code (e.g iam)

regionName - the AWS region name

clock - provides a timestamp

headers - The request headers; 'Host' and 'X-Amz-Date' will be added to this set.

queryParameters - Any query parameters that will be added to the endpoint. The parameters should be specified in canonical format.

bodyHash - Precomputed SHA256 hash of the request body content; this value should also be set as the header 'X-Amz-Content-SHA256' for non-streaming uploads.

awsAccessKey - The user's AWS Access Key.

awsSecretKey - The user's AWS Secret Key.

sessionToken -

Returns:

The computed authorization string for the request. This value needs to be set as the header 'Authorization' on the subsequent HTTP request.

computeSignatureForAuthorizationHeader

public static String computeSignatureForAuthorizationHeader(URL endpointUrl,
                                                            String httpMethod,
                                                            String serviceName,
                                                            String regionName,
                                                            Clock clock,
                                                            Map<String,String> headers,
                                                            Map<String,String> queryParameters,
                                                            String bodyHash,
                                                            String awsAccessKey,
                                                            String awsSecretKey)

Computes an AWS4 signature for a request, ready for inclusion as an 'Authorization' header.

Parameters:

endpointUrl - the url to which the request is being made

httpMethod - the HTTP method (GET, POST, PUT, etc.)

serviceName - the AWS service code (e.g iam)

regionName - the AWS region name

clock - provides a timestamp

headers - The request headers; 'Host' and 'X-Amz-Date' will be added to this set.

queryParameters - Any query parameters that will be added to the endpoint. The parameters should be specified in canonical format.

bodyHash - Precomputed SHA256 hash of the request body content; this value should also be set as the header 'X-Amz-Content-SHA256' for non-streaming uploads.

awsAccessKey - The user's AWS Access Key.

awsSecretKey - The user's AWS Secret Key.

Returns:

The computed authorization string for the request. This value needs to be set as the header 'Authorization' on the subsequent HTTP request.