org.systinet.wasp.security.ws.conf
Interface SignatureConf

All Superinterfaces:

ElementConf, OrderedElementConf

public interface SignatureConf

extends OrderedElementConf

Represents Signature and its SignedInfo, defined by XML Signature specification.

Sender side

• Runtime configuration
  Overview of runtime configuration setup is described in MessageConf
  • must provide order in processing. For more information check OrderedElementConf.
  • can provide ElementConf.setWsuId(java.lang.String). For more information check ElementConf.
  • must specify what elements will be signed. If there are not wsuIds known, then only body can be signed (body is signed using digest algorithm Constants.ALGO_ID_DIGEST_SHA1 and transform algorithm Constants.TRANSFORM_C14N_EXCL_OMIT_COMMENTS. If there are wsuIds known, then the ReferenceConf are used to represent them.
  • setCanonicalizationMethod(java.lang.String) is used to on the element before generation of signature and authentication. It can be one of:
    • Constants.ALGO_ID_C14N_EXCL_OMIT_COMMENTS
    • Constants.ALGO_ID_C14N_EXCL_WITH_COMMENTS
    • Constants.ALGO_ID_C14N_OMIT_COMMENTS
    • Constants.ALGO_ID_C14N_WITH_COMMENTS
  • setSignatureMethod(java.lang.String) signature method is algorithm used for generating signature and authentication. It can be one of:
    • Constants.ALGO_ID_SIGNATURE_RSA
      the keys are RSA keys stored in X509Certificate, stored in Constants.ST_VALUE_TYPE_X509V3.
    • Constants.ALGO_ID_SIGNATURE_DSA
      the keys are DSA keys stored in X509Certificate, stored in Constants.ST_VALUE_TYPE_X509V3.
    • Constants.ALGO_ID_SIGNATURE_MAC_HMAC_SHA1
      the key is symmetric key that can be stored in Constants.ST_VALUE_TYPE_SYMMETRICKEY. The symmetric token can be also retrieved from Constants.ST_VALUE_TYPE_USERNAME security token - the WSO2 SOA Enablement Server uses PSHA1 algorithm to count symmetric key from values of username token.
  • optional setKeyInfo(org.systinet.wasp.security.ws.conf.KeyInfoConf) holds the signing and authotication key. Usually it contains reference to security token.
• Persistent configuration
  Overview of persistent configuration is described in WSSEProviderConf.
  The persistent configuration contains the same values as described in runtime configuration. It's schema is defined in WSSEGlobalConf.

Receiver
Receiver can check received message configuration's encrypted data using IncomingValidator.

Since:

4.6

Component:

Security-Providers

Method Summary

java.lang.String	getCanonicalizationMethod() Gets canonicalization method of XML Signature's SignedInfo elements.
KeyInfoConf	getKeyInfo() Gets configuration of key information that allows to sign and/or validate the XML Signature's SignedInfo.
ReferenceConf[]	getReferences() Gets references to signed objects.
java.lang.String	getSignatureMethod() Gets the algorithm that is used to convert the canonicalized signed info into the signature value.
java.lang.Boolean	getSignBody() Gets a flag that indicates whether to sign message body or not.
KeyInfoConf	newKeyInfo() Creates new instance of KeyInfoConf.
ReferenceConf	newReference() Creates new instance of ReferenceConf.
void	setCanonicalizationMethod(java.lang.String method) Sets canonicalization method that is used to canonicalize XML Signature's SignedInfo element.
void	setKeyInfo(KeyInfoConf keyInfo) Sets configuration of key information that allows to sign and/or validate the XML Signature's SignedInfo.
void	setReferences(ReferenceConf[] referenceConfs) Sets references to signed objects, mandatory part of SignedInfo.
void	setSignatureMethod(java.lang.String signatureMethod) Sets the algorithm that is used to convert the canonicalized signed info into the signature value.
void	setSignBody(java.lang.Boolean signBody) Sets a flag that indicates whether to sign message body or not.

Methods inherited from interface org.systinet.wasp.security.ws.conf.OrderedElementConf

getOrder, setOrder

Methods inherited from interface org.systinet.wasp.security.ws.conf.ElementConf

getWsuId, setWsuId

Method Detail

setReferences

public void setReferences(ReferenceConf[] referenceConfs)

Sets references to signed objects, mandatory part of SignedInfo.

Parameters:

referenceConfs - reference configurations

See Also:

getReferences(), newReference()

getReferences

public ReferenceConf[] getReferences()

Gets references to signed objects.

Returns:

reference configurations

See Also:

setReferences(org.systinet.wasp.security.ws.conf.ReferenceConf[])

newReference

public ReferenceConf newReference()

Creates new instance of ReferenceConf.

Returns:

instance that is supposed to be filled by valid data

See Also:

setReferences(org.systinet.wasp.security.ws.conf.ReferenceConf[])

setCanonicalizationMethod

public void setCanonicalizationMethod(java.lang.String method)

Sets canonicalization method that is used to canonicalize XML Signature's SignedInfo element.

Parameters:

method - canonicalization method identifier

See Also:

getCanonicalizationMethod(), Constants.ALGO_ID_C14N_EXCL_OMIT_COMMENTS, setCanonicalizationMethod(java.lang.String), Constants.ALGO_ID_C14N_EXCL_OMIT_COMMENTS, Constants.ALGO_ID_C14N_EXCL_WITH_COMMENTS, Constants.ALGO_ID_C14N_OMIT_COMMENTS, Constants.ALGO_ID_C14N_WITH_COMMENTS

getCanonicalizationMethod

public java.lang.String getCanonicalizationMethod()

Gets canonicalization method of XML Signature's SignedInfo elements.

Returns:

canonicaliztion method identifier

See Also:

setCanonicalizationMethod(java.lang.String), Constants.ALGO_ID_C14N_EXCL_OMIT_COMMENTS, Constants.ALGO_ID_C14N_EXCL_WITH_COMMENTS, Constants.ALGO_ID_C14N_OMIT_COMMENTS, Constants.ALGO_ID_C14N_WITH_COMMENTS

setSignatureMethod

public void setSignatureMethod(java.lang.String signatureMethod)

Sets the algorithm that is used to convert the canonicalized signed info into the signature value.

Parameters:

signatureMethod - signature method identifier

See Also:

getSignatureMethod(), Constants.ALGO_ID_SIGNATURE_RSA, Constants.ALGO_ID_SIGNATURE_DSA, Constants.ALGO_ID_SIGNATURE_MAC_HMAC_SHA1

getSignatureMethod

public java.lang.String getSignatureMethod()

Gets the algorithm that is used to convert the canonicalized signed info into the signature value.

Returns:

signature method identifier

See Also:

setSignatureMethod(java.lang.String), Constants.ALGO_ID_SIGNATURE_RSA, Constants.ALGO_ID_SIGNATURE_DSA, Constants.ALGO_ID_SIGNATURE_MAC_HMAC_SHA1

setKeyInfo

public void setKeyInfo(KeyInfoConf keyInfo)

Sets configuration of key information that allows to sign and/or validate the XML Signature's SignedInfo.

Parameters:

keyInfo - key info configuration

See Also:

newKeyInfo(), getKeyInfo()

getKeyInfo

public KeyInfoConf getKeyInfo()

Gets configuration of key information that allows to sign and/or validate the XML Signature's SignedInfo.

Returns:

key info configuration

See Also:

setKeyInfo(org.systinet.wasp.security.ws.conf.KeyInfoConf)

newKeyInfo

public KeyInfoConf newKeyInfo()

Creates new instance of KeyInfoConf.

Returns:

instance that is supposed to be filled by valid data

See Also:

setKeyInfo(org.systinet.wasp.security.ws.conf.KeyInfoConf)

setSignBody

public void setSignBody(java.lang.Boolean signBody)

Sets a flag that indicates whether to sign message body or not. It's a shortcut for adding reference to message body, but the reference URI of message body element is left to the implementation.

Parameters:

signBody - true indicates that message body will be signed.

See Also:

getSignBody(), setReferences(org.systinet.wasp.security.ws.conf.ReferenceConf[])

getSignBody

public java.lang.Boolean getSignBody()

Gets a flag that indicates whether to sign message body or not.

Returns:

sign message body or not

See Also:

setSignBody(Boolean)