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

All Superinterfaces:

ElementConf, EncryptedTypeConf, OrderedElementConf

public interface EncryptedDataConf

extends EncryptedTypeConf

Represents configuration of EncryptedData element defined by XML Encryption specification. It is based on EncryptedTypeConf.

Sender side
It represents a part of message that will be encrypted using specified algorithms and keys.

• 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 in message will be encrypted. If the wsu:Id of element is known then setEncryptionTargetId(java.lang.String). Otherwise only Body element can be specify using setEncryptBody(java.lang.Boolean). There can be only one specified element.
  • must provide how the element will be encrypted - either whole element or content of the element. It is set by setEncryptElementContent(java.lang.Boolean).
  • must provide the name of encrypting algorithm using EncryptionMethodAlgorithm. Available values are: Constants.ALGO_ID_BLOCKCIPHER_TRIPLEDES, Constants.ALGO_ID_BLOCKCIPHER_AES128 , Constants.ALGO_ID_BLOCKCIPHER_AES192 and Constants.ALGO_ID_BLOCKCIPHER_AES256 .
  • if selected encrypting algorithm requires properties, they must be specify using EncryptedTypeConf.setEncryptionMethodProperties(org.systinet.wasp.security.ws.conf.PropertyConf[]). Currently available alogrithms does not requires properties.
  • if the encrypting key is stored in another EncryptedKey then configuration of KeyInfo must be . Otherwise the KeyInfo must be provided and set using EncryptedTypeConf.setKeyInfo(org.systinet.wasp.security.ws.conf.KeyInfoConf).
  • if used algorithm use initialization vector, then it can be set using EncryptedTypeConf.setIV(byte[]).
• 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.Boolean	getEncryptBody() Returns Boolean.TRUE if Body is encrypted.
java.lang.Boolean	getEncryptElementContent() Returns selected mode of element encryption.
java.lang.String	getEncryptionTargetId() Returns Id of element that is selected for encryption or null if it is not set.
void	setEncryptBody(java.lang.Boolean encryptBody) Sets encryption target to the message Body.
void	setEncryptElementContent(java.lang.Boolean encryptElementContent) Sets mode of encryption.
void	setEncryptionTargetId(java.lang.String targetId) Sets identifier of element selected for encryption.

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

getEncryptionMethodAlgorithm, getEncryptionMethodProperties, getIV, getKeyInfo, newEncryptionMethodProperty, newKeyInfo, setEncryptionMethodAlgorithm, setEncryptionMethodProperties, setIV, setKeyInfo

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

setEncryptElementContent

public void setEncryptElementContent(java.lang.Boolean encryptElementContent)

Sets mode of encryption. If it is set to true, it encrypts element content, otherwise it encrypts the whole element.

Parameters:

encryptElementContent - type of encryption (content/whole element)

See Also:

getEncryptElementContent()

getEncryptElementContent

public java.lang.Boolean getEncryptElementContent()

Returns selected mode of element encryption.

Returns:

selected type of element encryption.

See Also:

setEncryptElementContent(Boolean)

setEncryptBody

public void setEncryptBody(java.lang.Boolean encryptBody)

Sets encryption target to the message Body. If it is set then the encryptionTargetId MUST be set to null. This method sets encryption target identifier to body identifier.

Parameters:

encryptBody - declares if it encrypts Body element of SOAP message

See Also:

getEncryptBody(), setEncryptionTargetId(String)

getEncryptBody

public java.lang.Boolean getEncryptBody()

Returns Boolean.TRUE if Body is encrypted.

Returns:

Boolean.TRUE if SOAP Body is encrypted.

See Also:

setEncryptBody(Boolean)

setEncryptionTargetId

public void setEncryptionTargetId(java.lang.String targetId)

Sets identifier of element selected for encryption. If it is set, the encryptBody should remain unset or set to null.

Parameters:

targetId - identifier of element selected for encryption

See Also:

getEncryptionTargetId(), setEncryptBody(Boolean)

getEncryptionTargetId

public java.lang.String getEncryptionTargetId()

Returns Id of element that is selected for encryption or null if it is not set.

Returns:

Id of element that is selected for encryption

See Also:

setEncryptionTargetId(String)