Class DOMHMACSignatureMethod

java.lang.Object

org.apache.jcp.xml.dsig.internal.dom.DOMStructure

org.apache.jcp.xml.dsig.internal.dom.AbstractDOMSignatureMethod

org.apache.jcp.xml.dsig.internal.dom.DOMHMACSignatureMethod

All Implemented Interfaces:

AlgorithmMethod, SignatureMethod, XMLStructure

Direct Known Subclasses:

DOMHMACSignatureMethod.RIPEMD160, DOMHMACSignatureMethod.SHA1, DOMHMACSignatureMethod.SHA224, DOMHMACSignatureMethod.SHA256, DOMHMACSignatureMethod.SHA384, DOMHMACSignatureMethod.SHA512

public abstract class DOMHMACSignatureMethod
extends AbstractDOMSignatureMethod

DOM-based implementation of HMAC SignatureMethod.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final class	DOMHMACSignatureMethod.RIPEMD160
(package private) static final class	DOMHMACSignatureMethod.SHA1
(package private) static final class	DOMHMACSignatureMethod.SHA224
(package private) static final class	DOMHMACSignatureMethod.SHA256
(package private) static final class	DOMHMACSignatureMethod.SHA384
(package private) static final class	DOMHMACSignatureMethod.SHA512

Nested classes/interfaces inherited from class AbstractDOMSignatureMethod

AbstractDOMSignatureMethod.Type

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	DOM_SIGNATURE_PROVIDER
private Mac	hmac
(package private) static final String	HMAC_RIPEMD160
(package private) static final String	HMAC_SHA224
(package private) static final String	HMAC_SHA256
(package private) static final String	HMAC_SHA384
(package private) static final String	HMAC_SHA512
private static final org.slf4j.Logger	LOG
private int	outputLength
private boolean	outputLengthSet
private SignatureMethodParameterSpec	params

Fields inherited from interface SignatureMethod

DSA_SHA1, HMAC_SHA1, RSA_SHA1

Constructor Summary

Constructors

Constructor	Description
DOMHMACSignatureMethod(AlgorithmParameterSpec params)	Creates a DOMHMACSignatureMethod with the specified params
DOMHMACSignatureMethod(Element smElem)	Creates a DOMHMACSignatureMethod from an element.

Method Summary

Modifier and Type	Method	Description
(package private) void	checkParams(SignatureMethodParameterSpec params)	Checks if the specified parameters are valid for this algorithm.
(package private) AbstractDOMSignatureMethod.Type	getAlgorithmType()	Returns the type of signature algorithm.
(package private) abstract int	getDigestLength()	Returns the output length of the hash/digest.
final AlgorithmParameterSpec	getParameterSpec()
(package private) void	marshalParams(Element parent, String prefix)	Marshals the algorithm-specific parameters to an Element and appends it to the specified parent element.
(package private) boolean	paramsEqual(AlgorithmParameterSpec spec)	Returns true if parameters are equal; false otherwise.
(package private) byte[]	sign(Key key, SignedInfo si, XMLSignContext context)	Signs the bytes with the specified key, using the underlying Signature or Mac algorithm.
(package private) SignatureMethodParameterSpec	unmarshalParams(Element paramsElem)	Unmarshals SignatureMethodParameterSpec from the specified Element.
(package private) boolean	verify(Key key, SignedInfo si, byte[] sig, XMLValidateContext context)	Verifies the passed-in signature with the specified key, using the underlying Signature or Mac algorithm.

Methods inherited from class AbstractDOMSignatureMethod

equals, getJCAAlgorithm, hashCode, marshal

Methods inherited from class DOMStructure

isFeatureSupported

Methods inherited from class Object

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

Methods inherited from interface AlgorithmMethod

getAlgorithm

Methods inherited from interface XMLStructure

isFeatureSupported

Field Details

DOM_SIGNATURE_PROVIDER

private static final String DOM_SIGNATURE_PROVIDER

See Also:

• Constant Field Values

LOG

private static final org.slf4j.Logger LOG

HMAC_SHA224

static final String HMAC_SHA224

See Also:

• Constant Field Values

HMAC_SHA256

static final String HMAC_SHA256

See Also:

• Constant Field Values

HMAC_SHA384

static final String HMAC_SHA384

See Also:

• Constant Field Values

HMAC_SHA512

static final String HMAC_SHA512

See Also:

• Constant Field Values

HMAC_RIPEMD160

static final String HMAC_RIPEMD160

See Also:

• Constant Field Values

hmac

private Mac hmac

outputLength

private int outputLength

outputLengthSet

private boolean outputLengthSet

params

private SignatureMethodParameterSpec params

Constructor Details

DOMHMACSignatureMethod

DOMHMACSignatureMethod(AlgorithmParameterSpec params)
                throws InvalidAlgorithmParameterException

Creates a DOMHMACSignatureMethod with the specified params

Parameters:

params - algorithm-specific parameters (may be null)

Throws:

InvalidAlgorithmParameterException - if params are inappropriate

DOMHMACSignatureMethod

DOMHMACSignatureMethod(Element smElem)
                throws MarshalException

Creates a DOMHMACSignatureMethod from an element.

Parameters:

smElem - a SignatureMethod element

Throws:

MarshalException

Method Details

checkParams

void checkParams(SignatureMethodParameterSpec params)
          throws InvalidAlgorithmParameterException

Description copied from class: AbstractDOMSignatureMethod

Checks if the specified parameters are valid for this algorithm. By default, this method throws an exception if parameters are specified since most SignatureMethod algorithms do not have parameters. Subclasses should override it if they have parameters.

Overrides:

checkParams in class AbstractDOMSignatureMethod

Parameters:

params - the algorithm-specific params (may be null)

Throws:

InvalidAlgorithmParameterException - if the parameters are not appropriate for this signature method

getParameterSpec

public final AlgorithmParameterSpec getParameterSpec()

unmarshalParams

SignatureMethodParameterSpec unmarshalParams(Element paramsElem)
                                      throws MarshalException

Description copied from class: AbstractDOMSignatureMethod

Unmarshals SignatureMethodParameterSpec from the specified Element. By default, this method throws an exception since most SignatureMethod algorithms do not have parameters. Subclasses should override it if they have parameters.

Overrides:

unmarshalParams in class AbstractDOMSignatureMethod

Parameters:

paramsElem - the Element holding the input params

Returns:

the algorithm-specific SignatureMethodParameterSpec

Throws:

MarshalException - if the parameters cannot be unmarshalled

marshalParams

void marshalParams(Element parent,
 String prefix)
            throws MarshalException

Description copied from class: AbstractDOMSignatureMethod

Marshals the algorithm-specific parameters to an Element and appends it to the specified parent element. By default, this method throws an exception since most SignatureMethod algorithms do not have parameters. Subclasses should override it if they have parameters.

Overrides:

marshalParams in class AbstractDOMSignatureMethod

Parameters:

parent - the parent element to append the parameters to

prefix - the algorithm parameters prefix to use

Throws:

MarshalException - if the parameters cannot be marshalled

verify

boolean verify(Key key,
 SignedInfo si,
 byte[] sig,
 XMLValidateContext context)
        throws InvalidKeyException,
SignatureException,
XMLSignatureException

Description copied from class: AbstractDOMSignatureMethod

Verifies the passed-in signature with the specified key, using the underlying Signature or Mac algorithm.

Specified by:

verify in class AbstractDOMSignatureMethod

Parameters:

key - the verification key

si - the SignedInfo

sig - the signature bytes to be verified

context - the XMLValidateContext

Returns:

true if the signature verified successfully, false if not

Throws:

InvalidKeyException - if the key is improperly encoded, of the wrong type, or parameters are missing, etc

SignatureException - if an unexpected error occurs, such as the passed in signature is improperly encoded

XMLSignatureException - if an unexpected error occurs

sign

byte[] sign(Key key,
 SignedInfo si,
 XMLSignContext context)
     throws InvalidKeyException,
XMLSignatureException

Description copied from class: AbstractDOMSignatureMethod

Signs the bytes with the specified key, using the underlying Signature or Mac algorithm.

Specified by:

sign in class AbstractDOMSignatureMethod

Parameters:

key - the signing key

si - the SignedInfo

context - the XMLSignContext

Returns:

the signature

Throws:

InvalidKeyException - if the key is improperly encoded, of the wrong type, or parameters are missing, etc

XMLSignatureException - if an unexpected error occurs

paramsEqual

boolean paramsEqual(AlgorithmParameterSpec spec)

Description copied from class: AbstractDOMSignatureMethod

Returns true if parameters are equal; false otherwise. Subclasses should override this method to compare algorithm-specific parameters.

Overrides:

paramsEqual in class AbstractDOMSignatureMethod

getAlgorithmType

AbstractDOMSignatureMethod.Type getAlgorithmType()

Description copied from class: AbstractDOMSignatureMethod

Returns the type of signature algorithm.

Specified by:

getAlgorithmType in class AbstractDOMSignatureMethod

getDigestLength

abstract int getDigestLength()

Returns the output length of the hash/digest.