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

All Superinterfaces:

ElementConf

public interface MessageConf

extends ElementConf

Represents configuration of message's WS-Security and Timestamp headers. This interface is used for runtime configuration that is applied to next outgoing message, and persistent configuration (used MessageConf is given by Java method name) WSSEProviderConf.
Configuration contains

• configurations of setSecurityTokens(org.systinet.wasp.security.ws.conf.SecurityTokenConf[]), setEncryptedData(org.systinet.wasp.security.ws.conf.EncryptedDataConf[]), setEncryptedKeys(org.systinet.wasp.security.ws.conf.EncryptedKeyConf[]), setSignatures(org.systinet.wasp.security.ws.conf.SignatureConf[]) and setReferenceLists(org.systinet.wasp.security.ws.conf.ReferenceListConf[])
• configuration of security header processing: setMustUnderstand(java.lang.Boolean), setRole(java.lang.String), setNoSecurityHeader(java.lang.Boolean).
  If setNoSecurityHeader(java.lang.Boolean) is set to true, then no security header is generated, even if there are security tokens, encrypted keys, etc. This option allows to configure creation of "unsecure" message in WS-Security security provider usage.
• configuration of time stamp header as specified by WS-Security specification (setCreateTimestampHeader(java.lang.Boolean), setMustUnderstandTimestampHeader(java.lang.Boolean)
• flag that marks if the exception thrown in the code (of the service) has to be secured by the WS-Security setSecureFault(java.lang.Boolean)
• configuration of namespaces setWsseNamespace(java.lang.String), setWsuNamespace(java.lang.String)

Sender

• Runtime Configuration
  MessageConf's runtime configuration can be set in context data of CallContext, ServiceEndpoint or ServiceClient. The key is Constants.CD_MESSAGE_CONF. Configuration stored at CallContext has higher priority than configuration at service endpoint and service client.
  Runtime configuration can also contain configuration of represented by WSSEConf and IncomingValidator.

  Example:

  • Configuration on ServiceClient (usually of request message):

     Configurable configurable = Configurator.newRuntimeConfigurable();
     MessageConf messageConf = (MessageConf)configurable.narrow(MessageConf.class);
     ...setup messageConf (create SecurityToken EncryptedData, EncryptedKey, Signatures, ReferenceList)...
     ServiceClient serviceClient = ServiceClient.create(...);
     MyService ref = (MyService)serviceClient.createProxy( MyService.class );
     WaspSecurity.setInitiatingProvider(serviceClientContext, Constants.PROVIDER_NAME);
    
     // set it on service client
     serviceClient.getContext().getContextData().put( Constants.CD_MESSAGE_CONF, messageConf );
    
     // or set it on call context
     serviceClient.getCallContext().getContextData().put( Constants.CD_MESSAGE_CONF, messageConf );
     

  • Configuration on ServiceEndpoint (usually configuration of reply message):

     Configurable configurable = Configurator.newRuntimeConfigurable();
     MessageConf messageConf = (MessageConf)configurable.narrow(MessageConf.class);
     ...setup messageConf (create SecurityToken EncryptedData, EncryptedKey, Signatures, ReferenceList)...
     ServiceEndpointContext serviceEndpointContext = Current.getServiceEndpointContext();
     WaspSecurity.setInitiatingProvider(serviceEndpointContext, Constants.PROVIDER_NAME);
    
     // set it on service endpoint
     serviceEndpointContext.getContext().getContextData().put(Constants.CD_MESSAGE_CONF, messageConf);
    
     // or set it on call context - this code must be called in processing (e.g., service's code, validator,...)
     Current.getCallContext().getContextData().put(Constants.CD_MESSAGE_CONF, messageConf);
     

• Persistent Configuration
  Persistent configuration is described in WSSEProviderConf.

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

Since:

4.6

Component:

Security-Providers

Method Summary

java.lang.Boolean	getCreateTimestampHeader() Gets the flag that indicates Timestamp header presence.
EncryptedDataConf[]	getEncryptedData() Gets configuration of encrypted data.
EncryptedKeyConf[]	getEncryptedKeys() Gets configuration of encrypted keys.
java.lang.Boolean	getMustUnderstand() Gets the value of Soap mustUnderstand atribute of the Security header.
java.lang.Boolean	getMustUnderstandTimestampHeader() Gets the value of Soap mustUnderstand atribute of the Timestamp header.
java.lang.Boolean	getNoSecurityHeader() Disables generation of the security header.
ReferenceListConf[]	getReferenceLists() Gets configuration XML Encryption's reference lists to be contained in Security header.
java.lang.String	getRole() Gets the value of Soap role attribute of the Security header.
java.lang.Boolean	getSecureFault() Gets the flag that indicates whether to to apply WS-Security configuration to Soap faults or not.
SecurityTokenConf[]	getSecurityTokens() Gets configuration of security tokens.
SignatureConf[]	getSignatures() Gets configuration of signatures.
java.lang.String	getTimestampId() Sets ID of the timestamp so it can be signed.
java.lang.String	getVersion() Gets WS-Security version currently used.
java.lang.String	getWsseNamespace() Deprecated. Use getVersion() instead.
java.lang.String	getWsuNamespace() Deprecated. Use getVersion() instead.
EncryptedDataConf	newEncryptedData() Creates new instance of EncryptedDataConf.
EncryptedKeyConf	newEncryptedKey() Creates new instance of EncryptedKeyConf.
ReferenceListConf	newReferenceList() Creates new instance of ReferenceListConf.
SecurityTokenConf	newSecurityToken() Creates new instance of SecurityTokenConf.
SignatureConf	newSignature() Creates new instance of SignatureConf.
void	setCreateTimestampHeader(java.lang.Boolean flag) Sets the flag that indicates whether to generate Timestamp header or not.
void	setEncryptedData(EncryptedDataConf[] dataConfs) Sets configuration of encrypted data, originally defined by XML Encryption specification.
void	setEncryptedKeys(EncryptedKeyConf[] keyConfs) Sets configuration of encrypted keys, originally defined by XML Encryption specification.
void	setMustUnderstand(java.lang.Boolean flag) Sets the value of Soap mustUnderstand atribute of the Security header.
void	setMustUnderstandTimestampHeader(java.lang.Boolean flag) Sets the value of Soap mustUnderstand atribute of the Timestamp header.
void	setNoSecurityHeader(java.lang.Boolean flag) Disables generation of the security header.
void	setReferenceLists(ReferenceListConf[] referenceListConf) Sets configuration XML Encryption's reference lists to be contained in Security header.
void	setRole(java.lang.String role) Sets the value of Soap role attribute of the Security header.
void	setSecureFault(java.lang.Boolean secureFault) Sets the flag that indicates whether to apply WS-Security configuration to Soap faults or not.
void	setSecurityTokens(SecurityTokenConf[] tokenConfs) Sets configuration of security tokens.
void	setSignatures(SignatureConf[] signatureConfs) Sets configuration of signatures.
void	setTimestampId(java.lang.String id) Gets ID of the timestamp so it can be signed.
void	setVersion(java.lang.String version) Sets WS-Security version to be used.
void	setWsseNamespace(java.lang.String namespace) Deprecated. Use setVersion(java.lang.String) instead.
void	setWsuNamespace(java.lang.String namespace) Deprecated. Use setVersion(java.lang.String) instead.

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

getWsuId, setWsuId

Method Detail

setVersion

public void setVersion(java.lang.String version)

Sets WS-Security version to be used. Use one of the predefined constants:

• Constants.OASIS_1_0
• Constants.OASIS_1_0_ERRATA

Parameters:

version - version

Since:

6.5

getVersion

public java.lang.String getVersion()

Gets WS-Security version currently used. Returns one of the predefined constants (or null is not specified):

• Constants.OASIS_1_0
• Constants.OASIS_1_0_ERRATA

Returns:

WS-Security version

Since:

6.5

setWsseNamespace

public void setWsseNamespace(java.lang.String namespace)

Deprecated. Use setVersion(java.lang.String) instead.

Sets namespace for the WS-Security extensions.

Parameters:

namespace - wsse namespace

See Also:

getWsseNamespace(), Constants.DEFAULT_WSSE_NAMESPACE

getWsseNamespace

public java.lang.String getWsseNamespace()

Deprecated. Use getVersion() instead.

Gets namespace for the WS-Security extensions.

Returns:

wsse namespace

See Also:

setWsseNamespace(java.lang.String), Constants.DEFAULT_WSSE_NAMESPACE

setWsuNamespace

public void setWsuNamespace(java.lang.String namespace)

Deprecated. Use setVersion(java.lang.String) instead.

Sets namespace for WS Utils.

Parameters:

namespace - wsse namespace

See Also:

getWsuNamespace(), Constants.DEFAULT_WSU_NAMESPACE

getWsuNamespace

public java.lang.String getWsuNamespace()

Deprecated. Use getVersion() instead.

Gets namespace for WS Utils.

Returns:

wsu namespace

See Also:

setWsuNamespace(java.lang.String), Constants.DEFAULT_WSU_NAMESPACE

setRole

public void setRole(java.lang.String role)

Sets the value of Soap role attribute of the Security header.

Parameters:

role - value of Soap:role attribute

See Also:

getRole()

getRole

public java.lang.String getRole()

Gets the value of Soap role attribute of the Security header.

Returns:

value of Soap:role attribute, can be null

See Also:

setRole(java.lang.String)

setMustUnderstand

public void setMustUnderstand(java.lang.Boolean flag)

Sets the value of Soap mustUnderstand atribute of the Security header.

Parameters:

flag - the attribute value

See Also:

getMustUnderstand()

getMustUnderstand

public java.lang.Boolean getMustUnderstand()

Gets the value of Soap mustUnderstand atribute of the Security header.

Returns:

the attribute value

See Also:

setMustUnderstand(java.lang.Boolean)

setSecurityTokens

public void setSecurityTokens(SecurityTokenConf[] tokenConfs)

Sets configuration of security tokens.

Parameters:

tokenConfs - token configurations

See Also:

getSecurityTokens(), newSecurityToken()

getSecurityTokens

public SecurityTokenConf[] getSecurityTokens()

Gets configuration of security tokens.

Returns:

token configurations

See Also:

newSecurityToken()

newSecurityToken

public SecurityTokenConf newSecurityToken()

Creates new instance of SecurityTokenConf.

Returns:

instance that is supposed to be filled by valid data

See Also:

setSecurityTokens(SecurityTokenConf[])

setCreateTimestampHeader

public void setCreateTimestampHeader(java.lang.Boolean flag)

Sets the flag that indicates whether to generate Timestamp header or not.

Parameters:

flag - true to generate Timestamp header

See Also:

getCreateTimestampHeader(), setTimestampId(java.lang.String), getTimestampId()

getCreateTimestampHeader

public java.lang.Boolean getCreateTimestampHeader()

Gets the flag that indicates Timestamp header presence.

Returns:

true in the case of Timestamp header presence

See Also:

setCreateTimestampHeader(Boolean), setTimestampId(java.lang.String), getTimestampId()

getTimestampId

public java.lang.String getTimestampId()

Sets ID of the timestamp so it can be signed.

Returns:

the ID value

See Also:

setCreateTimestampHeader(java.lang.Boolean), getCreateTimestampHeader(), setTimestampId(java.lang.String)

setTimestampId

public void setTimestampId(java.lang.String id)

Gets ID of the timestamp so it can be signed.

Parameters:

id - the ID value

See Also:

setCreateTimestampHeader(java.lang.Boolean), getCreateTimestampHeader(), getTimestampId()

setSignatures

public void setSignatures(SignatureConf[] signatureConfs)

Sets configuration of signatures.

Parameters:

signatureConfs - signature configurations

See Also:

getSignatures(), newSignature()

getSignatures

public SignatureConf[] getSignatures()

Gets configuration of signatures.

Returns:

signature configurations

See Also:

setSignatures(org.systinet.wasp.security.ws.conf.SignatureConf[])

newSignature

public SignatureConf newSignature()

Creates new instance of SignatureConf.

Returns:

instance that is supposed to be filled by valid data

See Also:

setSignatures(SignatureConf[])

setEncryptedKeys

public void setEncryptedKeys(EncryptedKeyConf[] keyConfs)

Sets configuration of encrypted keys, originally defined by XML Encryption specification.

Parameters:

keyConfs - encrypted key configurations

See Also:

getEncryptedKeys(), newEncryptedKey()

getEncryptedKeys

public EncryptedKeyConf[] getEncryptedKeys()

Gets configuration of encrypted keys.

Returns:

encrypted key configurations

See Also:

setEncryptedKeys(org.systinet.wasp.security.ws.conf.EncryptedKeyConf[])

newEncryptedKey

public EncryptedKeyConf newEncryptedKey()

Creates new instance of EncryptedKeyConf.

Returns:

instance that is supposed to be filled by valid data

See Also:

setEncryptedKeys(EncryptedKeyConf[])

setEncryptedData

public void setEncryptedData(EncryptedDataConf[] dataConfs)

Sets configuration of encrypted data, originally defined by XML Encryption specification.

Parameters:

dataConfs - encrypted data configurations

See Also:

getEncryptedData(), newEncryptedData()

getEncryptedData

public EncryptedDataConf[] getEncryptedData()

Gets configuration of encrypted data.

Returns:

encrypted data configurations

See Also:

setEncryptedData(org.systinet.wasp.security.ws.conf.EncryptedDataConf[])

newEncryptedData

public EncryptedDataConf newEncryptedData()

Creates new instance of EncryptedDataConf.

Returns:

instance that is supposed to be filled by valid data

See Also:

setEncryptedData(EncryptedDataConf[])

setReferenceLists

public void setReferenceLists(ReferenceListConf[] referenceListConf)

Sets configuration XML Encryption's reference lists to be contained in Security header.

Parameters:

referenceListConf - ReferenceList configurations

See Also:

getReferenceLists(), newReferenceList()

getReferenceLists

public ReferenceListConf[] getReferenceLists()

Gets configuration XML Encryption's reference lists to be contained in Security header.

Returns:

ReferenceList configurations

See Also:

setReferenceLists(org.systinet.wasp.security.ws.conf.ReferenceListConf[])

newReferenceList

public ReferenceListConf newReferenceList()

Creates new instance of ReferenceListConf.

Returns:

instance that is supposed to be filled by valid data

See Also:

setReferenceLists(org.systinet.wasp.security.ws.conf.ReferenceListConf[])

setSecureFault

public void setSecureFault(java.lang.Boolean secureFault)

Sets the flag that indicates whether to apply WS-Security configuration to Soap faults or not. Default value is set to false. If set to true, the configuration of the WS-Security MUST be applicable to the Soap message which contains the Soap fault.

Parameters:

secureFault - true to sign SOAP fault

See Also:

getSecureFault()

getSecureFault

public java.lang.Boolean getSecureFault()

Gets the flag that indicates whether to to apply WS-Security configuration to Soap faults or not.

Returns:

secureFault flag or null to use default

See Also:

setSecureFault(java.lang.Boolean)

setMustUnderstandTimestampHeader

public void setMustUnderstandTimestampHeader(java.lang.Boolean flag)

Sets the value of Soap mustUnderstand atribute of the Timestamp header.

Parameters:

flag - the attribute value

See Also:

getMustUnderstandTimestampHeader()

getMustUnderstandTimestampHeader

public java.lang.Boolean getMustUnderstandTimestampHeader()

Gets the value of Soap mustUnderstand atribute of the Timestamp header.

Returns:

the attribute value

See Also:

setMustUnderstandTimestampHeader(java.lang.Boolean)

getNoSecurityHeader

public java.lang.Boolean getNoSecurityHeader()

Disables generation of the security header.

Returns:

the flag value

See Also:

setNoSecurityHeader(java.lang.Boolean)

setNoSecurityHeader

public void setNoSecurityHeader(java.lang.Boolean flag)

Disables generation of the security header.

Parameters:

flag - the flag value

See Also:

getNoSecurityHeader()