Module org.apache.santuario.xmlsec

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

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.AbstractEDDSASignatureMethod, DOMSignatureMethod.AbstractP1363FormatSignatureMethod, DOMSignatureMethod.AbstractRSASignatureMethod

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 class	DOMSignatureMethod.AbstractDSASignatureMethod
(package private) static class	DOMSignatureMethod.AbstractECDSASignatureMethod
(package private) static class	DOMSignatureMethod.AbstractEDDSASignatureMethod
(package private) static class	DOMSignatureMethod.AbstractP1363FormatSignatureMethod	Abstract class to support signature algorithms that sign and verify signatures in the IEEE P1363 format.
(package private) static class	DOMSignatureMethod.AbstractRSAPSSSignatureMethod
(package private) static class	DOMSignatureMethod.AbstractRSASignatureMethod
(package private) static final class	DOMSignatureMethod.EDDSA_ED25519
(package private) static final class	DOMSignatureMethod.EDDSA_ED448
(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.SHA3_224withECDSA
(package private) static final class	DOMSignatureMethod.SHA3_224withRSAandMGF1
(package private) static final class	DOMSignatureMethod.SHA3_256withECDSA
(package private) static final class	DOMSignatureMethod.SHA3_256withRSAandMGF1
(package private) static final class	DOMSignatureMethod.SHA3_384withECDSA
(package private) static final class	DOMSignatureMethod.SHA3_384withRSAandMGF1
(package private) static final class	DOMSignatureMethod.SHA3_512withECDSA
(package private) static final class	DOMSignatureMethod.SHA3_512withRSAandMGF1
(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 org.apache.jcp.xml.dsig.internal.dom.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_SHA3_224
(package private) static final String	ECDSA_SHA3_256
(package private) static final String	ECDSA_SHA3_384
(package private) static final String	ECDSA_SHA3_512
(package private) static final String	ECDSA_SHA384
(package private) static final String	ECDSA_SHA512
(package private) static final String	ED25519
(package private) static final String	ED448
private static final System.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_SHA3_224_MGF1
(package private) static final String	RSA_SHA3_256_MGF1
(package private) static final String	RSA_SHA3_384_MGF1
(package private) static final String	RSA_SHA3_512_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 javax.xml.crypto.dsig.SignatureMethod

DSA_SHA1, HMAC_SHA1, HMAC_SHA224, HMAC_SHA256, HMAC_SHA384, HMAC_SHA512, RSA_SHA1, SHA1_RSA_MGF1, SHA224_RSA_MGF1, SHA256_RSA_MGF1, SHA384_RSA_MGF1, SHA512_RSA_MGF1

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) Signature	getSignature(Provider p)	Returns an instance of Signature from the specified Provider.
(package private) abstract byte[]	postSignFormat(Key key, byte[] sig)	Returns the signature bytes with any additional formatting necessary for the signature algorithm used.
(package private) abstract byte[]	preVerifyFormat(Key key, byte[] sig)	Returns the signature bytes with any conversions that are necessary before the signature can be verified.
(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 org.apache.jcp.xml.dsig.internal.dom.AbstractDOMSignatureMethod

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

Methods inherited from class org.apache.jcp.xml.dsig.internal.dom.DOMStructure

equalsContent, isFeatureSupported

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.xml.crypto.AlgorithmMethod

getAlgorithm

Methods inherited from interface javax.xml.crypto.XMLStructure

isFeatureSupported

Field Details

DOM_SIGNATURE_PROVIDER

private static final String DOM_SIGNATURE_PROVIDER

See Also:

• Constant Field Values

LOG

private static final System.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

ED25519

static final String ED25519

See Also:

• Constant Field Values

ED448

static final String ED448

See Also:

• Constant Field Values

ECDSA_SHA3_224

static final String ECDSA_SHA3_224

See Also:

• Constant Field Values

ECDSA_SHA3_256

static final String ECDSA_SHA3_256

See Also:

• Constant Field Values

ECDSA_SHA3_384

static final String ECDSA_SHA3_384

See Also:

• Constant Field Values

ECDSA_SHA3_512

static final String ECDSA_SHA3_512

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

RSA_SHA3_224_MGF1

static final String RSA_SHA3_224_MGF1

See Also:

• Constant Field Values

RSA_SHA3_256_MGF1

static final String RSA_SHA3_256_MGF1

See Also:

• Constant Field Values

RSA_SHA3_384_MGF1

static final String RSA_SHA3_384_MGF1

See Also:

• Constant Field Values

RSA_SHA3_512_MGF1

static final String RSA_SHA3_512_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

postSignFormat

abstract byte[] postSignFormat(Key key,
 byte[] sig)
                        throws IOException

Returns the signature bytes with any additional formatting necessary for the signature algorithm used. For RSA signatures, no changes are required, and this method should simply return back sig. For DSA and ECDSA, this method should return the signature in the IEEE P1363 format, the concatenation of r and s.

Parameters:

key - the key used to sign

sig - the signature returned by Signature.sign()

Returns:

the formatted signature

Throws:

IOException

preVerifyFormat

abstract byte[] preVerifyFormat(Key key,
 byte[] sig)
                         throws IOException

Returns the signature bytes with any conversions that are necessary before the signature can be verified. For RSA signatures, no changes are required, and this method should simply return back sig. For DSA and ECDSA, this method should return the signature in the DER-encoded ASN.1 format.

Parameters:

key - the key used to sign

sig - the signature

Returns:

the formatted signature

Throws:

IOException

unmarshal

static SignatureMethod unmarshal(Element smElem)
                          throws MarshalException

Throws:

MarshalException

getParameterSpec

public final AlgorithmParameterSpec getParameterSpec()

getSignature

Signature getSignature(Provider p)
                throws NoSuchAlgorithmException

Returns an instance of Signature from the specified Provider. The algorithm is specified by the getJCAAlgorithm() method.

Parameters:

p - the Provider to use

Returns:

an instance of Signature implementing the algorithm specified by getJCAAlgorithm()

Throws:

NoSuchAlgorithmException - if the Provider does not support the signature algorithm

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