com.amazonaws.auth.AWS4Signer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-core Show documentation
Show all versions of aws-java-sdk-core Show documentation
The AWS SDK for Java Mobile - Core module holds the classes that is used by the individual service clients to interact with Amazon Web Services. Users need to depend on aws-java-sdk artifact for accessing individual client classes.
The newest version!
/*
* Copyright 2013-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.auth;
import com.amazonaws.AmazonClientException;
import com.amazonaws.Request;
import com.amazonaws.util.AwsHostNameUtils;
import com.amazonaws.util.BinaryUtils;
import com.amazonaws.util.DateUtils;
import com.amazonaws.util.HttpUtils;
import com.amazonaws.util.StringUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import java.io.IOException;
import java.io.InputStream;
import java.net.URI;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Date;
import java.util.List;
/**
* Signer implementation that signs requests with the AWS4 signing protocol.
*/
public class AWS4Signer extends AbstractAWSSigner
implements ServiceAwareSigner, RegionAwareSigner, Presigner {
protected static final String ALGORITHM = "AWS4-HMAC-SHA256";
protected static final String TERMINATOR = "aws4_request";
private static final String DATE_PATTERN = "yyyyMMdd";
private static final String TIME_PATTERN = "yyyyMMdd'T'HHmmss'Z'";
private static final long MILLISEC = 1000L;
/** Seconds in a week, which is the max expiration time Sig-v4 accepts */
private static final long MAX_EXPIRATION_TIME_IN_SECONDS = 60 * 60 * 24 * 7;
/**
* Service name override for use when the endpoint can't be used to
* determine the service name.
*/
protected String serviceName;
/**
* Region name override for use when the endpoint can't be used to determine
* the region name.
*/
protected String regionName;
/** Date override for testing only */
protected Date overriddenDate;
/**
* Whether double url-encode the resource path when constructing the
* canonical request. By default, we enable double url-encoding. TODO:
* Different sigv4 services seem to be inconsistent on this. So for services
* that want to suppress this, they should use new AWS4Signer(false).
*/
protected boolean doubleUrlEncode;
/**
* Construct a new AWS4 signer instance. By default, enable double
* url-encoding.
*/
public AWS4Signer() {
this(true);
}
/**
* Construct a new AWS4 signer instance.
*
* @param doubleUrlEncoding Whether double url-encode the resource path when
* constructing the canonical request.
*/
public AWS4Signer(boolean doubleUrlEncoding) {
this.doubleUrlEncode = doubleUrlEncoding;
}
protected static final Log log = LogFactory.getLog(AWS4Signer.class);
@Override
public void sign(Request request, AWSCredentials credentials) {
// annonymous credentials, don't sign
if (credentials instanceof AnonymousAWSCredentials) {
return;
}
final AWSCredentials sanitizedCredentials = sanitizeCredentials(credentials);
if (sanitizedCredentials instanceof AWSSessionCredentials) {
addSessionCredentials(request, (AWSSessionCredentials) sanitizedCredentials);
}
addHostHeader(request);
final long dateMilli = getDateFromRequest(request);
final String dateStamp = getDateStamp(dateMilli);
final String scope = getScope(request, dateStamp);
final String contentSha256 = calculateContentHash(request);
final String timeStamp = getTimeStamp(dateMilli);
request.addHeader("X-Amz-Date", timeStamp);
if (request.getHeaders().get("x-amz-content-sha256") != null
&& "required".equals(request.getHeaders().get("x-amz-content-sha256"))) {
request.addHeader("x-amz-content-sha256", contentSha256);
}
final String signingCredentials = sanitizedCredentials.getAWSAccessKeyId() + "/" + scope;
final HeaderSigningResult headerSigningResult = computeSignature(
request,
dateStamp,
timeStamp,
ALGORITHM,
contentSha256,
sanitizedCredentials);
final String credentialsAuthorizationHeader =
"Credential=" + signingCredentials;
final String signedHeadersAuthorizationHeader =
"SignedHeaders=" + getSignedHeadersString(request);
final String signatureAuthorizationHeader =
"Signature=" + BinaryUtils.toHex(headerSigningResult.getSignature());
final String authorizationHeader = ALGORITHM + " "
+ credentialsAuthorizationHeader + ", "
+ signedHeadersAuthorizationHeader + ", "
+ signatureAuthorizationHeader;
request.addHeader("Authorization", authorizationHeader);
processRequestPayload(request, headerSigningResult);
}
/**
* Sets the service name that this signer should use when calculating
* request signatures. This can almost always be determined directly from
* the request's end point, so you shouldn't need this method, but it's
* provided for the edge case where the information is not in the endpoint.
*
* @param serviceName The service name to use when calculating signatures in
* this signer.
*/
@Override
public void setServiceName(String serviceName) {
this.serviceName = serviceName;
}
/**
* Sets the region name that this signer should use when calculating request
* signatures. This can almost always be determined directly from the
* request's end point, so you shouldn't need this method, but it's provided
* for the edge case where the information is not in the endpoint.
*
* @param regionName The region name to use when calculating signatures in
* this signer.
*/
@Override
public void setRegionName(String regionName) {
this.regionName = regionName;
}
@Override
protected void addSessionCredentials(Request request, AWSSessionCredentials credentials) {
request.addHeader("x-amz-security-token", credentials.getSessionToken());
}
protected String extractRegionName(URI endpoint) {
if (regionName != null) {
return regionName;
}
return AwsHostNameUtils.parseRegionName(endpoint.getHost(),
serviceName);
}
protected String extractServiceName(URI endpoint) {
if (serviceName != null) {
return serviceName;
}
// This should never actually be called, as we should always be setting
// a service name on the signer; retain it for now in case anyone is
// using the AWS4Signer directly and not setting a service name
// explicitly.
return AwsHostNameUtils.parseServiceName(endpoint);
}
@SuppressWarnings("checkstyle:hiddenfield")
void overrideDate(Date overriddenDate) {
this.overriddenDate = overriddenDate;
}
protected String getCanonicalizedHeaderString(Request request) {
final List sortedHeaders = new ArrayList();
sortedHeaders.addAll(request.getHeaders().keySet());
Collections.sort(sortedHeaders, String.CASE_INSENSITIVE_ORDER);
final StringBuilder buffer = new StringBuilder();
for (final String header : sortedHeaders) {
if (needsSign(header)) {
final String key = StringUtils.lowerCase(header).replaceAll("\\s+", " ");
final String value = request.getHeaders().get(header);
buffer.append(key).append(":");
if (value != null) {
buffer.append(value.replaceAll("\\s+", " "));
}
buffer.append("\n");
}
}
return buffer.toString();
}
protected String getSignedHeadersString(Request request) {
final List sortedHeaders = new ArrayList();
sortedHeaders.addAll(request.getHeaders().keySet());
Collections.sort(sortedHeaders, String.CASE_INSENSITIVE_ORDER);
final StringBuilder buffer = new StringBuilder();
for (final String header : sortedHeaders) {
if (needsSign(header)) {
if (buffer.length() > 0) {
buffer.append(";");
}
buffer.append(StringUtils.lowerCase(header));
}
}
return buffer.toString();
}
protected String getCanonicalRequest(Request request, String contentSha256) {
/* This would url-encode the resource path for the first time */
final String path = HttpUtils.appendUri(request.getEndpoint().getPath(),
request.getResourcePath());
final String canonicalRequest =
request.getHttpMethod().toString() + "\n" +
/*
* This would optionally double url-encode the resource
* path
*/
getCanonicalizedResourcePath(path, doubleUrlEncode) + "\n" +
getCanonicalizedQueryString(request) + "\n" +
getCanonicalizedHeaderString(request) + "\n" +
getSignedHeadersString(request) + "\n" +
contentSha256;
log.debug("AWS4 Canonical Request: '\"" + canonicalRequest + "\"");
return canonicalRequest;
}
protected String getStringToSign(String algorithm, String dateTime, String scope,
String canonicalRequest) {
final String stringToSign =
algorithm + "\n" +
dateTime + "\n" +
scope + "\n" +
BinaryUtils.toHex(hash(canonicalRequest));
log.debug("AWS4 String to Sign: '\"" + stringToSign + "\"");
return stringToSign;
}
@SuppressWarnings("checkstyle:hiddenfield")
protected final HeaderSigningResult computeSignature(
Request request,
String dateStamp,
String timeStamp,
String algorithm,
String contentSha256,
AWSCredentials sanitizedCredentials) {
final String regionName = extractRegionName(request.getEndpoint());
final String serviceName = extractServiceName(request.getEndpoint());
final String scope = dateStamp + "/" + regionName + "/" + serviceName + "/" + TERMINATOR;
final String stringToSign = getStringToSign(algorithm, timeStamp, scope,
getCanonicalRequest(request, contentSha256));
// AWS4 uses a series of derived keys, formed by hashing different
// pieces of data
final byte[] kSecret = ("AWS4" + sanitizedCredentials.getAWSSecretKey())
.getBytes(StringUtils.UTF8);
final byte[] kDate = sign(dateStamp, kSecret, SigningAlgorithm.HmacSHA256);
final byte[] kRegion = sign(regionName, kDate, SigningAlgorithm.HmacSHA256);
final byte[] kService = sign(serviceName, kRegion, SigningAlgorithm.HmacSHA256);
final byte[] kSigning = sign(TERMINATOR, kService, SigningAlgorithm.HmacSHA256);
final byte[] signature = sign(stringToSign.getBytes(StringUtils.UTF8), kSigning,
SigningAlgorithm.HmacSHA256);
return new HeaderSigningResult(timeStamp, scope, kSigning, signature);
}
protected final String getTimeStamp(long dateMilli) {
return DateUtils.format(TIME_PATTERN, new Date(dateMilli));
}
protected final String getDateStamp(long dateMilli) {
return DateUtils.format(DATE_PATTERN, new Date(dateMilli));
}
protected final long getDateFromRequest(Request request) {
final int timeOffset = getTimeOffset(request);
Date date = getSignatureDate(timeOffset);
if (overriddenDate != null) {
date = overriddenDate;
}
return date.getTime();
}
protected void addHostHeader(Request request) {
// AWS4 requires that we sign the Host header so we
// have to have it in the request by the time we sign.
String hostHeader = request.getEndpoint().getHost();
if (HttpUtils.isUsingNonDefaultPort(request.getEndpoint())) {
hostHeader += ":" + request.getEndpoint().getPort();
}
request.addHeader("Host", hostHeader);
}
@SuppressWarnings("checkstyle:hiddenfield")
protected String getScope(Request request, String dateStamp) {
final String regionName = extractRegionName(request.getEndpoint());
final String serviceName = extractServiceName(request.getEndpoint());
final String scope = dateStamp + "/" + regionName + "/" + serviceName + "/" + TERMINATOR;
return scope;
}
/**
* Calculate the hash of the request's payload. Subclass could override this
* method to provide different values for "x-amz-content-sha256" header or
* do any other necessary set-ups on the request headers. (e.g. aws-chunked
* uses a pre-defined header value, and needs to change some headers
* relating to content-encoding and content-length.)
*/
protected String calculateContentHash(Request request) {
final InputStream payloadStream = getBinaryRequestPayloadStream(request);
payloadStream.mark(-1);
final String contentSha256 = BinaryUtils.toHex(hash(payloadStream));
try {
payloadStream.reset();
} catch (final IOException e) {
throw new AmazonClientException(
"Unable to reset stream after calculating AWS4 signature", e);
}
return contentSha256;
}
/**
* Subclass could override this method to perform any additional procedure
* on the request payload, with access to the result from signing the
* header. (e.g. Signing the payload by chunk-encoding). The default
* implementation doesn't need to do anything.
*/
protected void processRequestPayload(Request request, HeaderSigningResult headerSigningResult) {
return;
}
protected static class HeaderSigningResult {
private final String dateTime;
private final String scope;
private final byte[] kSigning;
private final byte[] signature;
public HeaderSigningResult(String dateTime, String scope, byte[] kSigning, byte[] signature) {
this.dateTime = dateTime;
this.scope = scope;
this.kSigning = kSigning;
this.signature = signature;
}
public String getDateTime() {
return dateTime;
}
public String getScope() {
return scope;
}
public byte[] getKSigning() {
final byte[] kSigningCopy = new byte[kSigning.length];
System.arraycopy(kSigning, 0, kSigningCopy, 0, kSigning.length);
return kSigningCopy;
}
public byte[] getSignature() {
final byte[] signatureCopy = new byte[signature.length];
System.arraycopy(signature, 0, signatureCopy, 0, signature.length);
return signatureCopy;
}
}
@Override
public void presignRequest(Request request, AWSCredentials credentials,
Date expiration) {
// annonymous credentials, don't sign
if (credentials instanceof AnonymousAWSCredentials) {
return;
}
long expirationInSeconds = MAX_EXPIRATION_TIME_IN_SECONDS;
if (expiration != null) {
expirationInSeconds = (expiration.getTime() - System
.currentTimeMillis()) / MILLISEC;
}
if (expirationInSeconds > MAX_EXPIRATION_TIME_IN_SECONDS) {
throw new AmazonClientException(
"Requests that are pre-signed by SigV4 algorithm are valid for at most 7 days. "
+ "The expiration date set on the current request ["
+ getTimeStamp(expiration.getTime())
+ "] has exceeded this limit.");
}
addHostHeader(request);
final AWSCredentials sanitizedCredentials = sanitizeCredentials(credentials);
if (sanitizedCredentials instanceof AWSSessionCredentials) {
// For SigV4 pre-signing URL, we need to add "x-amz-security-token"
// as a query string parameter, before constructing the canonical
// request.
request.addParameter("X-Amz-Security-Token",
((AWSSessionCredentials) sanitizedCredentials)
.getSessionToken());
}
final long dateMilli = getDateFromRequest(request);
final String dateStamp = getDateStamp(dateMilli);
final String scope = getScope(request, dateStamp);
final String signingCredentials = sanitizedCredentials.getAWSAccessKeyId()
+ "/" + scope;
// Add the important parameters for v4 signing
final String timeStamp = getTimeStamp(dateMilli);
request.addParameter("X-Amz-Algorithm", ALGORITHM);
request.addParameter("X-Amz-Date", timeStamp);
request.addParameter("X-Amz-SignedHeaders",
getSignedHeadersString(request));
request.addParameter("X-Amz-Expires",
Long.toString(expirationInSeconds));
request.addParameter("X-Amz-Credential", signingCredentials);
final String contentSha256 = calculateContentHashPresign(request);
final HeaderSigningResult headerSigningResult = computeSignature(request,
dateStamp, timeStamp, ALGORITHM, contentSha256,
sanitizedCredentials);
request.addParameter("X-Amz-Signature",
BinaryUtils.toHex(headerSigningResult.getSignature()));
}
/**
* Calculate the hash of the request's payload. In case of pre-sign, the
* existing code would generate the hash of an empty byte array and returns
* it. This method can be overridden by sub classes to provide different
* values (e.g) For S3 pre-signing, the content hash calculation is
* different from the general implementation.
*/
protected String calculateContentHashPresign(Request request) {
return calculateContentHash(request);
}
/**
* Determine if a header needs to be signed. The headers must be signed
* according to sigv4 spec are host, date, Content-MD5and all x-amz headers.
*
* @param header header key
* @return true if it should be sign, false otherwise
*/
boolean needsSign(String header) {
return "date".equalsIgnoreCase(header) || "Content-MD5".equalsIgnoreCase(header)
|| "host".equalsIgnoreCase(header)
|| header.startsWith("x-amz") || header.startsWith("X-Amz");
}
}