org.opensaml.xmlsec.signature.support

Class SignatureSupport

java.lang.Object

org.opensaml.xmlsec.signature.support.SignatureSupport

public final class SignatureSupport
extends Object

Helper methods for working with XML Signature.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	SignatureSupport() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
private static Logger	getLogger() Get an SLF4J Logger.
static void	prepareSignatureParams(Signature signature, SignatureSigningParameters parameters) Prepare a Signature with necessary additional information prior to signing.
static void	signObject(SignableXMLObject signable, SignatureSigningParameters parameters) Signs a SignableXMLObject.

Methods inherited from class java.lang.Object

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

Constructor Detail

SignatureSupport

private SignatureSupport()

Constructor.

Method Detail

getLogger

@Nonnull
private static Logger getLogger()

Get an SLF4J Logger.

Returns:

a Logger instance

prepareSignatureParams

public static void prepareSignatureParams(@Nonnull
                          Signature signature,
                          @Nonnull
                          SignatureSigningParameters parameters)
                                   throws SecurityException

Prepare a Signature with necessary additional information prior to signing.

NOTE:Since this operation modifies the specified Signature object, it should be called prior to marshalling the Signature object.

The following Signature values will be added:

• signing credential
• signature algorithm URI
• canonicalization algorithm URI
• reference digest method
• HMAC output length (if applicable and a value is configured)
• a KeyInfo element representing the signing credential

Existing (non-null) values of these parameters on the specified signature will NOT be overwritten, however.

All values are determined by the specified SignatureSigningParameters. If no value for a required parameter is specified or included on the passed signature, a SecurityException will be thrown.

Parameters:

signature - the Signature to be updated

parameters - the signing parameters to use

Throws:

SecurityException - thrown if a required parameter is not supplied in the parameters instance or available on the Signature instance

signObject

public static void signObject(@Nonnull
              SignableXMLObject signable,
              @Nonnull
              SignatureSigningParameters parameters)
                       throws SecurityException,
                              org.opensaml.core.xml.io.MarshallingException,
                              SignatureException

Signs a SignableXMLObject.

Parameters:

signable - the signable XMLObject to sign

parameters - the signing parameters to use

Throws:

SecurityException - if there is a problem preparing the signature

org.opensaml.core.xml.io.MarshallingException - if there is a problem marshalling the XMLObject

SignatureException - if there is a problem with the signature operation