org.tomitribe.auth.signatures

Class Signature

java.lang.Object

org.tomitribe.auth.signatures.Signature

public class Signature
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Signature(java.lang.String keyId, SigningAlgorithm signingAlgorithm, Algorithm algorithm, java.security.spec.AlgorithmParameterSpec parameterSpec, java.lang.String signature, java.util.List<java.lang.String> headers)
Signature(java.lang.String keyId, java.lang.String signingAlgorithm, java.lang.String algorithm, java.security.spec.AlgorithmParameterSpec parameterSpec, java.util.List<java.lang.String> headers) Construct a signature configuration instance with the specified keyId, algorithm and HTTP headers.
Signature(java.lang.String keyId, java.lang.String signingAlgorithm, java.lang.String algorithm, java.security.spec.AlgorithmParameterSpec parameterSpec, java.lang.String signature, java.util.List<java.lang.String> headers)

Method Summary

Modifier and Type	Method and Description
static Signature	fromString(java.lang.String authorization, Algorithm algorithm) Constructs a Signature object by parsing the 'Authorization' header.
Algorithm	getAlgorithm() Returns the detailed implementation algorithm for HTTP signatures.
java.util.List<java.lang.String>	getHeaders()
java.lang.String	getKeyId()
java.security.spec.AlgorithmParameterSpec	getParameterSpec() Returns the specification of cryptographic parameters.
java.lang.String	getSignature() Returns the base-64 encoded value of the signature.
SigningAlgorithm	getSigningAlgorithm() Returns the identifier for the HTTP Signature Algorithm, as registered in the HTTP Signature Algorithms Registry.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Signature

public Signature(java.lang.String keyId,
                 java.lang.String signingAlgorithm,
                 java.lang.String algorithm,
                 java.security.spec.AlgorithmParameterSpec parameterSpec,
                 java.util.List<java.lang.String> headers)

Construct a signature configuration instance with the specified keyId, algorithm and HTTP headers.

Parameters:

keyId - An opaque string that the server can use to look up the component they need to validate the signature.

signingAlgorithm - An identifier for the HTTP Signature algorithm. This should be "hs2019" except for legacy applications that use an older version of the draft HTTP signature specification.

algorithm - The detailed algorithm used to sign the message.

parameterSpec - optional cryptographic parameters for the signature.

headers - The list of HTTP headers that will be used in the signature.

Signature

public Signature(java.lang.String keyId,
                 java.lang.String signingAlgorithm,
                 java.lang.String algorithm,
                 java.security.spec.AlgorithmParameterSpec parameterSpec,
                 java.lang.String signature,
                 java.util.List<java.lang.String> headers)

Signature

public Signature(java.lang.String keyId,
                 SigningAlgorithm signingAlgorithm,
                 Algorithm algorithm,
                 java.security.spec.AlgorithmParameterSpec parameterSpec,
                 java.lang.String signature,
                 java.util.List<java.lang.String> headers)

Method Detail

getKeyId

public java.lang.String getKeyId()

getAlgorithm

public Algorithm getAlgorithm()

Returns the detailed implementation algorithm for HTTP signatures.

Returns:

the cryptographic algorithm.

getSigningAlgorithm

public SigningAlgorithm getSigningAlgorithm()

Returns the identifier for the HTTP Signature Algorithm, as registered in the HTTP Signature Algorithms Registry.

Returns:

the identifier for the HTTP Signature Algorithm.

getSignature

public java.lang.String getSignature()

Returns the base-64 encoded value of the signature.

Returns:

the base-64 encoded value of the signature.

getParameterSpec

public java.security.spec.AlgorithmParameterSpec getParameterSpec()

Returns the specification of cryptographic parameters.

Returns:

specification of cryptographic parameters.

getHeaders

public java.util.List<java.lang.String> getHeaders()

fromString

public static Signature fromString(java.lang.String authorization,
                                   Algorithm algorithm)

Constructs a Signature object by parsing the 'Authorization' header. As stated in the HTTP signature specification, the value of the algorithm parameter in the 'Authorization' header should be set to generic identifier. The detailed algorithm should be derived from the keyId. Hence it is not possible to determine the detailed algorithm by inspecting the signature data.

Parameters:

authorization - The value of the HTTP 'Authorization' header containing the signature data.

algorithm - The detailed cryptographic algorithm for the HTTP signature.

Returns:

The Signature object.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object