Application Programming Interface Guide > Built-in Procedures > Procedures Reference > ProcessSecurityHeader
 
ProcessSecurityHeader
Process a WS Security SOAP header in a SOAP envelope. If the envelope contains a WS Security header with the specified actor, it is processed. All security elements in the header are evaluated. If any header security elements indicate that the envelope contains signed elements, the signatures of those elements is verified. If any header security elements indicate that the envelope contains encrypted elements, those elements are decrypted.
Location
/lib/services/
Inputs
envelope: A SOAP envelope, which may include a WS Security header.
actor: Which WS Security header to process. It may be NULL.
keyStore: A serialized Java key store containing certificates used to verify signatures and decrypt elements. It may be NULL.
keyStoreType: The type of key store. It must be JKS or PKCS12. May be NULL only if keyStore is NULL.
keyStorePassword: The password of the key store and of all private keys within it. May be NULL.
Output
envelope: The SOAP envelope. Some elements may have been decrypted.
Exceptions
IllegalArgumentException: If any of the arguments are invalid.
SecurityException: If the security elements in the message are invalid or unsupported.
SecurityException: If a signature could not be verified.
SecurityException: If an encrypted element could not be decrypted.