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

All Superinterfaces:

ElementConf, EncryptedTypeConf, OrderedElementConf

public interface EncryptedKeyConf

extends EncryptedTypeConf

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

Sender side
It represents a key used in next processing (encryption/signature).

• 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.
  • can provide stored (transported) key setEncodedStoredKey(byte[]). If the key is not set, it is generated.
  • must provide setReferences(org.systinet.wasp.security.ws.conf.EncryptionReferenceConf[]) references to EncryptedKeyConf or EncryptedDataConf that uses stored key.
  • must provide the name of encrypting algorithm using EncryptionMethodAlgorithm. Available values are: Constants.ALGO_ID_KEYTRANSPORT_RSA15, Constants.ALGO_ID_KEYTRANSPORT_RSAOAEP.
  • if selected encrypting algorithm requires properties, they must be specify using EncryptedTypeConf.setEncryptionMethodProperties(org.systinet.wasp.security.ws.conf.PropertyConf[]). Currently only Constants#ALGO_ID_KEYTRANSPORT_RSAOAEP requires follwoing properties:
    • mandatory: Constants.EMP_OAEPDigest
    • optional: Constants.EMP_OAEPParams
  • 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. It is not recommeded to set the key in persistent descriptor, because key is usually symmetric key that shall be changed for each message.
  The persistent configuration contains the same values as described in runtime configuration.

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

Since:

4.6

Component:

Security-Providers

Method Summary

byte[]	getEncodedStoredKey() Gets key that is stored in this EncryptedKey.
EncryptionReferenceConf[]	getReferences() Returns an array of EncryptionReferenceConf that represents ReferenceList element.
EncryptionReferenceConf	newReference() Creates new instance of EncryptionReferenceConf.
void	setEncodedStoredKey(byte[] key) Sets key that is stored in this EncryptedKey.
void	setReferences(EncryptionReferenceConf[] referenceList) Sets ReferenceList element with an array of EncryptionReferenceConf.

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

setReferences

public void setReferences(EncryptionReferenceConf[] referenceList)

Sets ReferenceList element with an array of EncryptionReferenceConf. XML Encryption's ReferenceList is an element that contains references to another EncryptedData or EncryptedKeys that use Key transported by this EncryptedKey.

Parameters:

referenceList - array of EncryptionReferenceConf

See Also:

newReference(), getReferences()

getReferences

public EncryptionReferenceConf[] getReferences()

Returns an array of EncryptionReferenceConf that represents ReferenceList element.

Returns:

referenced elements

See Also:

setReferences(EncryptionReferenceConf[])

newReference

public EncryptionReferenceConf newReference()

Creates new instance of EncryptionReferenceConf.

Returns:

instance that is supposed to be filled by valid data

See Also:

setReferences(EncryptionReferenceConf[])

setEncodedStoredKey

public void setEncodedStoredKey(byte[] key)

Sets key that is stored in this EncryptedKey. If key is not set then it is generated using SecureRandom in runtime.
It is not recommeded to set the key in persistent descriptor, because key is usually symmetric key that shall be changed for each message.

Parameters:

key - encoded key as returned by Key.getEncoded().

See Also:

getEncodedStoredKey()

getEncodedStoredKey

public byte[] getEncodedStoredKey()

Gets key that is stored in this EncryptedKey.

Returns:

byte array represeting key

See Also:

setEncodedStoredKey(byte[])