alluxio.s3.signature

Class StringToSignProducer

java.lang.Object

alluxio.s3.signature.StringToSignProducer

public final class StringToSignProducer
extends Object

Stateless utility to create stringToSign, the base of the signature.

Method Summary

Modifier and Type	Method and Description
static String	buildCanonicalRequest(String schema, String method, String uri, String signedHeaders, Map<String,String> headers, Map<String,String> queryParams, boolean unsignedPayload) Convert request info to a format string.
static String	createSignatureBase(SignatureInfo signatureInfo, javax.ws.rs.container.ContainerRequestContext context) Convert signature info to strToSign.
static String	createSignatureBase(SignatureInfo signatureInfo, io.netty.handler.codec.http.HttpRequest httpRequest) Convert signature info to strToSign.
static String	createSignatureBase(SignatureInfo signatureInfo, javax.servlet.http.HttpServletRequest request) Convert signature info to strToSign.
static String	createSignatureBase(SignatureInfo signatureInfo, String scheme, String method, String uri, Map<String,String> headers, Map<String,String> queryParams) Convert request info to strToSign.
static String	hash(String payload) Compute a hash for provided string.

Methods inherited from class java.lang.Object

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

Method Detail

createSignatureBase

public static String createSignatureBase(SignatureInfo signatureInfo,
                                         javax.ws.rs.container.ContainerRequestContext context)
                                  throws Exception

Convert signature info to strToSign.

Parameters:

signatureInfo -

context -

Returns:

signature string

Throws:

Exception

createSignatureBase

public static String createSignatureBase(SignatureInfo signatureInfo,
                                         javax.servlet.http.HttpServletRequest request)
                                  throws Exception

Convert signature info to strToSign.

Parameters:

signatureInfo -

request -

Returns:

signature string

Throws:

Exception

createSignatureBase

public static String createSignatureBase(SignatureInfo signatureInfo,
                                         io.netty.handler.codec.http.HttpRequest httpRequest)
                                  throws Exception

Convert signature info to strToSign.

Parameters:

signatureInfo -

httpRequest -

Returns:

signature string

Throws:

Exception

createSignatureBase

public static String createSignatureBase(SignatureInfo signatureInfo,
                                         String scheme,
                                         String method,
                                         String uri,
                                         Map<String,String> headers,
                                         Map<String,String> queryParams)
                                  throws Exception

Convert request info to strToSign. Construct String to sign in below format. StringToSign = Algorithm + \n + RequestDateTime + \n + CredentialScope + \n + HashedCanonicalRequest For more details refer to AWS documentation: https://docs.aws.amazon.com/general/latest/gr/sigv4-create-string-to-sign.html

Parameters:

signatureInfo -

scheme -

method -

uri -

headers -

queryParams -

Returns:

signature string

Throws:

Exception

hash

public static String hash(String payload)
                   throws NoSuchAlgorithmException

Compute a hash for provided string.

Parameters:

payload -

Returns:

hashed string

Throws:

NoSuchAlgorithmException

buildCanonicalRequest

public static String buildCanonicalRequest(String schema,
                                           String method,
                                           String uri,
                                           String signedHeaders,
                                           Map<String,String> headers,
                                           Map<String,String> queryParams,
                                           boolean unsignedPayload)
                                    throws S3Exception

Convert request info to a format string.

Parameters:

schema - request schema

method - request method

uri - request uri

signedHeaders - signed headers

headers - request headers

queryParams - request params

unsignedPayload - whether or not the payload is unsigned

Returns:

formatted string

Throws:

S3Exception