Package org.apache.ws.security.message
Class WSSecDKEncrypt
java.lang.Object
org.apache.ws.security.message.WSSecBase
org.apache.ws.security.message.WSSecDerivedKeyBase
org.apache.ws.security.message.WSSecDKEncrypt
Encrypts and signes parts of a message with derived keys derived from a
symmetric key. This symmetric key will be included as an EncryptedKey
- Author:
- Ruchith Fernando (ruchith.fernando@gmail.com)
-
Field Summary
FieldsFields inherited from class org.apache.ws.security.message.WSSecDerivedKeyBase
clientLabel, derivedKeyBytes, derivedKeyLength, dkt, dktId, document, envelope, ephemeralKey, serviceLabel, strElem, tokenIdentifier
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addExternalRefElement
(Element referenceList, WSSecHeader secHeader) Adds (prepends) the external Reference element to the Security header.build
(Document doc, WSSecHeader secHeader) static Element
createDataRefList
(Document doc, Element referenceList, Vector encDataRefs) encryptForExternalRef
(Element dataRef, Vector references) Encrypt one or more parts or elements of the message (external).protected int
The derived key will change depending on the sig/encr algorithm.void
Methods inherited from class org.apache.ws.security.message.WSSecDerivedKeyBase
appendDKElementToHeader, getdktElement, getId, getTokenIdentifier, prepare, prependDKElementToHeader, setClientLabel, setDerivedKeyLength, setExternalKey, setExternalKey, setServiceLabel, setWscVersion
Methods inherited from class org.apache.ws.security.message.WSSecBase
getKeyIdentifierType, setBodyID, setKeyIdentifierType, setParts, setUserInfo, setWsConfig, setWsuId
-
Field Details
-
symEncAlgo
-
-
Constructor Details
-
WSSecDKEncrypt
public WSSecDKEncrypt()
-
-
Method Details
-
build
public Document build(Document doc, WSSecHeader secHeader) throws WSSecurityException, org.apache.ws.security.conversation.ConversationException - Throws:
WSSecurityException
org.apache.ws.security.conversation.ConversationException
-
encryptForExternalRef
Encrypt one or more parts or elements of the message (external). This method takes a vector ofWSEncryptionPart
object that contain information about the elements to encrypt. The method call the encryption method, takes the reference information generated during encryption and add this to thexenc:Reference
element. This method can be called afterprepare()
and can be called multiple times to encrypt a number of parts or elements. The method generates axenc:Reference
element that must be added to the SecurityHeader. SeeaddExternalRefElement()
. If thedataRef
parameter isnull
the method creates and initializes a new Reference element.- Parameters:
dataRef
- Axenc:Reference
element ornull
references
- A vector containing WSEncryptionPart objects- Returns:
- Returns the updated
xenc:Reference
element - Throws:
WSSecurityException
-
addExternalRefElement
Adds (prepends) the external Reference element to the Security header. The reference element must be created by theencryptForExternalRef()
method. The method adds the reference element in the SecurityHeader.- Parameters:
secHeader
- The security header.dataRef
- The externalenc:Reference
element
-
createDataRefList
-
setSymmetricEncAlgorithm
-
getDerivedKeyLength
Description copied from class:WSSecDerivedKeyBase
The derived key will change depending on the sig/encr algorithm. Therefore the child classes are expected to provide this value.- Specified by:
getDerivedKeyLength
in classWSSecDerivedKeyBase
- Returns:
- Throws:
WSSecurityException
- See Also:
-