Class DOMSignatureMethod

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.DOMSignatureMethod

All Implemented Interfaces:

AlgorithmMethod, SignatureMethod, XMLStructure

Direct Known Subclasses:

DOMSignatureMethod.RIPEMD160withECDSA, DOMSignatureMethod.RIPEMD160withRSA, DOMSignatureMethod.RIPEMD160withRSAandMGF1, DOMSignatureMethod.SHA1withDSA, DOMSignatureMethod.SHA1withECDSA, DOMSignatureMethod.SHA1withRSA, DOMSignatureMethod.SHA1withRSAandMGF1, DOMSignatureMethod.SHA224withECDSA, DOMSignatureMethod.SHA224withRSA, DOMSignatureMethod.SHA224withRSAandMGF1, DOMSignatureMethod.SHA256withDSA, DOMSignatureMethod.SHA256withECDSA, DOMSignatureMethod.SHA256withRSA, DOMSignatureMethod.SHA256withRSAandMGF1, DOMSignatureMethod.SHA384withECDSA, DOMSignatureMethod.SHA384withRSA, DOMSignatureMethod.SHA384withRSAandMGF1, DOMSignatureMethod.SHA512withECDSA, DOMSignatureMethod.SHA512withRSA, DOMSignatureMethod.SHA512withRSAandMGF1

public abstract class DOMSignatureMethod
extends AbstractDOMSignatureMethod

DOM-based abstract implementation of SignatureMethod.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final class	DOMSignatureMethod.RIPEMD160withECDSA
(package private) static final class	DOMSignatureMethod.RIPEMD160withRSA
(package private) static final class	DOMSignatureMethod.RIPEMD160withRSAandMGF1
(package private) static final class	DOMSignatureMethod.SHA1withDSA
(package private) static final class	DOMSignatureMethod.SHA1withECDSA
(package private) static final class	DOMSignatureMethod.SHA1withRSA
(package private) static final class	DOMSignatureMethod.SHA1withRSAandMGF1
(package private) static final class	DOMSignatureMethod.SHA224withECDSA
(package private) static final class	DOMSignatureMethod.SHA224withRSA
(package private) static final class	DOMSignatureMethod.SHA224withRSAandMGF1
(package private) static final class	DOMSignatureMethod.SHA256withDSA
(package private) static final class	DOMSignatureMethod.SHA256withECDSA
(package private) static final class	DOMSignatureMethod.SHA256withRSA
(package private) static final class	DOMSignatureMethod.SHA256withRSAandMGF1
(package private) static final class	DOMSignatureMethod.SHA384withECDSA
(package private) static final class	DOMSignatureMethod.SHA384withRSA
(package private) static final class	DOMSignatureMethod.SHA384withRSAandMGF1
(package private) static final class	DOMSignatureMethod.SHA512withECDSA
(package private) static final class	DOMSignatureMethod.SHA512withRSA
(package private) static final class	DOMSignatureMethod.SHA512withRSAandMGF1

Nested classes/interfaces inherited from class AbstractDOMSignatureMethod

AbstractDOMSignatureMethod.Type

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	DOM_SIGNATURE_PROVIDER
(package private) static final String	DSA_SHA256
(package private) static final String	ECDSA_RIPEMD160
(package private) static final String	ECDSA_SHA1
(package private) static final String	ECDSA_SHA224
(package private) static final String	ECDSA_SHA256
(package private) static final String	ECDSA_SHA384
(package private) static final String	ECDSA_SHA512
private static final org.slf4j.Logger	LOG
private SignatureMethodParameterSpec	params
(package private) static final String	RSA_RIPEMD160
(package private) static final String	RSA_RIPEMD160_MGF1
(package private) static final String	RSA_SHA1_MGF1
(package private) static final String	RSA_SHA224
(package private) static final String	RSA_SHA224_MGF1
(package private) static final String	RSA_SHA256
(package private) static final String	RSA_SHA256_MGF1
(package private) static final String	RSA_SHA384
(package private) static final String	RSA_SHA384_MGF1
(package private) static final String	RSA_SHA512
(package private) static final String	RSA_SHA512_MGF1
private Signature	signature

Fields inherited from interface SignatureMethod

DSA_SHA1, HMAC_SHA1, RSA_SHA1

Constructor Summary

Constructors

Constructor	Description
DOMSignatureMethod(AlgorithmParameterSpec params)	Creates a DOMSignatureMethod.
DOMSignatureMethod(Element smElem)	Creates a DOMSignatureMethod from an element.

Method Summary

Modifier and Type	Method	Description
final AlgorithmParameterSpec	getParameterSpec()
(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) static SignatureMethod	unmarshal(Element smElem)
(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

checkParams, equals, getAlgorithmType, getJCAAlgorithm, hashCode, marshal, marshalParams, paramsEqual, unmarshalParams

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

params

private SignatureMethodParameterSpec params

signature

private Signature signature

RSA_SHA224

static final String RSA_SHA224

See Also:

• Constant Field Values

RSA_SHA256

static final String RSA_SHA256

See Also:

• Constant Field Values

RSA_SHA384

static final String RSA_SHA384

See Also:

• Constant Field Values

RSA_SHA512

static final String RSA_SHA512

See Also:

• Constant Field Values

RSA_RIPEMD160

static final String RSA_RIPEMD160

See Also:

• Constant Field Values

ECDSA_SHA1

static final String ECDSA_SHA1

See Also:

• Constant Field Values

ECDSA_SHA224

static final String ECDSA_SHA224

See Also:

• Constant Field Values

ECDSA_SHA256

static final String ECDSA_SHA256

See Also:

• Constant Field Values

ECDSA_SHA384

static final String ECDSA_SHA384

See Also:

• Constant Field Values

ECDSA_SHA512

static final String ECDSA_SHA512

See Also:

• Constant Field Values

DSA_SHA256

static final String DSA_SHA256

See Also:

• Constant Field Values

ECDSA_RIPEMD160

static final String ECDSA_RIPEMD160

See Also:

• Constant Field Values

RSA_SHA1_MGF1

static final String RSA_SHA1_MGF1

See Also:

• Constant Field Values

RSA_SHA224_MGF1

static final String RSA_SHA224_MGF1

See Also:

• Constant Field Values

RSA_SHA256_MGF1

static final String RSA_SHA256_MGF1

See Also:

• Constant Field Values

RSA_SHA384_MGF1

static final String RSA_SHA384_MGF1

See Also:

• Constant Field Values

RSA_SHA512_MGF1

static final String RSA_SHA512_MGF1

See Also:

• Constant Field Values

RSA_RIPEMD160_MGF1

static final String RSA_RIPEMD160_MGF1

See Also:

• Constant Field Values

Constructor Details

DOMSignatureMethod

DOMSignatureMethod(AlgorithmParameterSpec params)
            throws InvalidAlgorithmParameterException

Creates a DOMSignatureMethod.

Parameters:

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

Throws:

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

DOMSignatureMethod

DOMSignatureMethod(Element smElem)
            throws MarshalException

Creates a DOMSignatureMethod from an element. This ctor invokes the unmarshalParams method to unmarshal any algorithm-specific input parameters.

Parameters:

smElem - a SignatureMethod element

Throws:

MarshalException

Method Details

unmarshal

static SignatureMethod unmarshal(Element smElem)
                          throws MarshalException

Throws:

MarshalException

getParameterSpec

public final AlgorithmParameterSpec getParameterSpec()

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