Module org.apache.santuario.xmlsec
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:
javax.xml.crypto.AlgorithmMethod,javax.xml.crypto.dsig.SignatureMethod,javax.xml.crypto.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 classDOMRSAPSSSignatureMethod.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 java.lang.StringdigestNameprivate static java.lang.StringDOM_SIGNATURE_PROVIDERprivate static java.lang.System.LoggerLOGprivate javax.xml.crypto.dsig.spec.SignatureMethodParameterSpecparams(package private) static java.lang.StringRSA_PSSprivate intsaltLengthprivate java.security.Signaturesignatureprivate inttrailerField-
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(java.security.spec.AlgorithmParameterSpec params)Creates aDOMSignatureMethod.DOMRSAPSSSignatureMethod(org.w3c.dom.Element smElem)Creates aDOMSignatureMethodfrom an element.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description (package private) voidcheckParams(javax.xml.crypto.dsig.spec.SignatureMethodParameterSpec params)Checks if the specified parameters are valid for this algorithm.private javax.xml.crypto.dsig.spec.SignatureMethodParameterSpecgetDefaultParameterSpec()java.security.spec.AlgorithmParameterSpecgetParameterSpec()(package private) voidmarshalParams(org.w3c.dom.Element parent, java.lang.String prefix)Marshals the algorithm-specific parameters to an Element and appends it to the specified parent element.(package private) booleanparamsEqual(java.security.spec.AlgorithmParameterSpec spec)Returns true if parameters are equal; false otherwise.(package private) byte[]sign(java.security.Key key, javax.xml.crypto.dsig.SignedInfo si, javax.xml.crypto.dsig.XMLSignContext context)Signs the bytes with the specified key, using the underlying Signature or Mac algorithm.(package private) javax.xml.crypto.dsig.spec.SignatureMethodParameterSpecunmarshalParams(org.w3c.dom.Element paramsElem)UnmarshalsSignatureMethodParameterSpecfrom the specifiedElement.(package private) booleanverify(java.security.Key key, javax.xml.crypto.dsig.SignedInfo si, byte[] sig, javax.xml.crypto.dsig.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
-
-
-
-
Field Detail
-
DOM_SIGNATURE_PROVIDER
private static final java.lang.String DOM_SIGNATURE_PROVIDER
- See Also:
- Constant Field Values
-
LOG
private static final java.lang.System.Logger LOG
-
params
private final javax.xml.crypto.dsig.spec.SignatureMethodParameterSpec params
-
signature
private java.security.Signature signature
-
RSA_PSS
static final java.lang.String RSA_PSS
- See Also:
- Constant Field Values
-
trailerField
private int trailerField
-
saltLength
private int saltLength
-
digestName
private java.lang.String digestName
-
-
Constructor Detail
-
DOMRSAPSSSignatureMethod
DOMRSAPSSSignatureMethod(java.security.spec.AlgorithmParameterSpec params) throws java.security.InvalidAlgorithmParameterExceptionCreates aDOMSignatureMethod.- Parameters:
params- the algorithm-specific params (may benull)- Throws:
java.security.InvalidAlgorithmParameterException- if the parameters are not appropriate for this signature method
-
DOMRSAPSSSignatureMethod
DOMRSAPSSSignatureMethod(org.w3c.dom.Element smElem) throws javax.xml.crypto.MarshalExceptionCreates aDOMSignatureMethodfrom an element. This ctor invokes theunmarshalParamsmethod to unmarshal any algorithm-specific input parameters.- Parameters:
smElem- a SignatureMethod element- Throws:
javax.xml.crypto.MarshalException
-
-
Method Detail
-
checkParams
void checkParams(javax.xml.crypto.dsig.spec.SignatureMethodParameterSpec params) throws java.security.InvalidAlgorithmParameterExceptionDescription copied from class:AbstractDOMSignatureMethodChecks 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:
checkParamsin classAbstractDOMSignatureMethod- Parameters:
params- the algorithm-specific params (may benull)- Throws:
java.security.InvalidAlgorithmParameterException- if the parameters are not appropriate for this signature method
-
getParameterSpec
public final java.security.spec.AlgorithmParameterSpec getParameterSpec()
-
marshalParams
void marshalParams(org.w3c.dom.Element parent, java.lang.String prefix) throws javax.xml.crypto.MarshalExceptionDescription copied from class:AbstractDOMSignatureMethodMarshals 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:
marshalParamsin classAbstractDOMSignatureMethod- Parameters:
parent- the parent element to append the parameters toprefix- the algorithm parameters prefix to use- Throws:
javax.xml.crypto.MarshalException- if the parameters cannot be marshalled
-
unmarshalParams
javax.xml.crypto.dsig.spec.SignatureMethodParameterSpec unmarshalParams(org.w3c.dom.Element paramsElem) throws javax.xml.crypto.MarshalExceptionDescription copied from class:AbstractDOMSignatureMethodUnmarshalsSignatureMethodParameterSpecfrom the specifiedElement. By default, this method throws an exception since most SignatureMethod algorithms do not have parameters. Subclasses should override it if they have parameters.- Overrides:
unmarshalParamsin classAbstractDOMSignatureMethod- Parameters:
paramsElem- theElementholding the input params- Returns:
- the algorithm-specific
SignatureMethodParameterSpec - Throws:
javax.xml.crypto.MarshalException- if the parameters cannot be unmarshalled
-
verify
boolean verify(java.security.Key key, javax.xml.crypto.dsig.SignedInfo si, byte[] sig, javax.xml.crypto.dsig.XMLValidateContext context) throws java.security.InvalidKeyException, java.security.SignatureException, javax.xml.crypto.dsig.XMLSignatureExceptionDescription copied from class:AbstractDOMSignatureMethodVerifies the passed-in signature with the specified key, using the underlying Signature or Mac algorithm.- Specified by:
verifyin classAbstractDOMSignatureMethod- Parameters:
key- the verification keysi- the SignedInfosig- the signature bytes to be verifiedcontext- the XMLValidateContext- Returns:
trueif the signature verified successfully,falseif not- Throws:
java.security.InvalidKeyException- if the key is improperly encoded, of the wrong type, or parameters are missing, etcjava.security.SignatureException- if an unexpected error occurs, such as the passed in signature is improperly encodedjavax.xml.crypto.dsig.XMLSignatureException- if an unexpected error occurs
-
sign
byte[] sign(java.security.Key key, javax.xml.crypto.dsig.SignedInfo si, javax.xml.crypto.dsig.XMLSignContext context) throws java.security.InvalidKeyException, javax.xml.crypto.dsig.XMLSignatureExceptionDescription copied from class:AbstractDOMSignatureMethodSigns the bytes with the specified key, using the underlying Signature or Mac algorithm.- Specified by:
signin classAbstractDOMSignatureMethod- Parameters:
key- the signing keysi- the SignedInfocontext- the XMLSignContext- Returns:
- the signature
- Throws:
java.security.InvalidKeyException- if the key is improperly encoded, of the wrong type, or parameters are missing, etcjavax.xml.crypto.dsig.XMLSignatureException- if an unexpected error occurs
-
paramsEqual
boolean paramsEqual(java.security.spec.AlgorithmParameterSpec spec)
Description copied from class:AbstractDOMSignatureMethodReturns true if parameters are equal; false otherwise. Subclasses should override this method to compare algorithm-specific parameters.- Overrides:
paramsEqualin classAbstractDOMSignatureMethod
-
getDefaultParameterSpec
private javax.xml.crypto.dsig.spec.SignatureMethodParameterSpec getDefaultParameterSpec()
-
-