pub.security.xml:decryptXML

Hybrid Integration 10.2 | Integrating On-Premises Applications | Integration Server Built-In Services | Security Folder | pub.security.xml:decryptXML

WmPublic. Decrypts the encrypted XML, and returns the XML as either a string or stream object.

Input Parameters

xmldata	String Optional. Encrypted XML that needs to be decrypted as plain text.
xmlStream	InputStream Optional. Encrypted XML in the form of an input stream. Note: If both xmldata and xmlStream are provided, xmlStream takes precedence; Integration Server uses the xmlStream value and returns only decryptedXMLStream.
keyStoreAlias	String Optional. Alias of the keystore that contains the private key used for decryption.
keyAlias	String Optional. Alias of the private key, contained in the keystore specified by the keyStoreAlias parameter, that is used for decryption.
encoding	String Optional. Specifies the encoding to use if the encoding cannot be extracted from the XML. If encoding is not specified in the XML document or in the encoding parameter, Integration Server uses UTF-8. The encoding value must be a valid IANA encoding.

Output Parameters

decryptedXMLData	String Conditional. Decrypted XML data. decryptedXMLData is returned when the input parameter xmldata is provided.
decryptedXMLStream	Object Conditional. A decrypted XML OutputStream object. decryptedXMLStream is returned when the input parameter xmlStream is provided.

Usage Notes

There are several prerequisites to using pub.security.xml:decryptXML:

Certificates must be configured for Integration Server and the client with which it is exchanging secure XML.

The sending, encrypting client must have access to Integration Server's public key before the document exchange can occur.

Integration Server stores its certificates in keystores and truststores. You must configure a keystore and truststore for Integration Server before using the XML encryption services.

You access the public and private keys for Integration Server through aliases. For information about Integration Server keystores and truststores, refer to webMethods Integration Server Administrator’s Guide.

The pub.security.xml:decryptXML service works as follows:

1. The external system sends the XML document encrypted with the Integration Server's public key.

2. Integration Server receives the document and passes it to the XML service.

3. Integration Server uses the private key member of the key pair to decrypt the XML.

4. The decrypted XML is returned from the service.

If both xmldata and xmlStream are provided, xmlStream takes precedence; Integration Server uses the xmlStream value and returns only decryptedXMLStream.

keyAlias and keyStoreAlias should either both be provided or both be absent from the input. If no value is provided for these parameters, Integration Server uses the private key/certificate specified for the Decryption Key. If no value is specified for Decryption Key, Integration Server uses the SSL Key.

For information about configuring the Decryption Key and SSL Key keystore aliases, refer to webMethods Integration Server Administrator’s Guide.