Module org.apache.santuario.xmlsec

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

Class DOMRSAPSSSignatureMethod

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

All Implemented Interfaces:

AlgorithmMethod, SignatureMethod, XMLStructure

Direct Known Subclasses:

DOMRSAPSSSignatureMethod.RSAPSS

public abstract class DOMRSAPSSSignatureMethod
extends AbstractDOMSignatureMethod

DOM-based abstract implementation of SignatureMethod for RSA-PSS.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final class	DOMRSAPSSSignatureMethod.RSAPSS

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 String	digestName
private static final String	DOM_SIGNATURE_PROVIDER
private static final System.Logger	LOG
private final SignatureMethodParameterSpec	params
(package private) static final String	RSA_PSS
private int	saltLength
private Signature	signature
private int	trailerField

Fields inherited from interface javax.xml.crypto.dsig.SignatureMethod

DSA_SHA1, DSA_SHA256, ECDSA_SHA1, ECDSA_SHA224, ECDSA_SHA256, ECDSA_SHA384, ECDSA_SHA512, HMAC_SHA1, HMAC_SHA224, HMAC_SHA256, HMAC_SHA384, HMAC_SHA512, RSA_SHA1, RSA_SHA224, RSA_SHA256, RSA_SHA384, RSA_SHA512, SHA1_RSA_MGF1, SHA224_RSA_MGF1, SHA256_RSA_MGF1, SHA384_RSA_MGF1, SHA512_RSA_MGF1

Constructor Summary

Constructors

Constructor	Description
DOMRSAPSSSignatureMethod(AlgorithmParameterSpec params)	Creates a DOMSignatureMethod.
DOMRSAPSSSignatureMethod(Element smElem)	Creates a DOMSignatureMethod 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.
private SignatureMethodParameterSpec	getDefaultParameterSpec()
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 org.apache.jcp.xml.dsig.internal.dom.AbstractDOMSignatureMethod

equals, getAlgorithmType, getJCAAlgorithm, hashCode, marshal

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 final SignatureMethodParameterSpec params

signature

private Signature signature

RSA_PSS

static final String RSA_PSS

See Also:

• Constant Field Values

trailerField

private int trailerField

saltLength

private int saltLength

digestName

private String digestName

Constructor Details

DOMRSAPSSSignatureMethod

DOMRSAPSSSignatureMethod(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

DOMRSAPSSSignatureMethod

DOMRSAPSSSignatureMethod(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

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()

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

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

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

getDefaultParameterSpec

private SignatureMethodParameterSpec getDefaultParameterSpec()