Integration Server 11.1 | Built-In Services Reference Guide | Security Folder | Summary of Elements in this Folder | pub.security:decryptAndVerify
 
pub.security:decryptAndVerify
WmPublic. Decrypts the encrypted data and verifies the associated digital signature.
Input Parameters
securityProvider
String Optional. The type of security provider. The valid values are:
*PGP (Pretty Good Privacy)
*JCE-KBE (Java Cryptography Extension-Key Based Encryption)
The default value is PGP.
data
Document The data that you want to decrypt and verify must be in one of the following formats. If multiple input parameters are supplied for data, the service throws an exception stating that only one parameter must be passed.
Key
Description
string
String Optional. The string that you want to decrypt and verify.
stream
java.io.InputStream Optional. The stream data that you want to decrypt and verify.
bytes
byte[ ] Optional. The byte array that you want to decrypt and verify.
file
String Optional. The absolute or relative path of the file that you want to decrypt and verify. If the file is outside the Integration Server or Microservices Runtime installation directory, provide the absolute path. Otherwise, place the file in your Integration Server or Microservices Runtime working directory.
The About page in Integration Server Administrator and Microservices Runtime Administrator displays the working directory. The watt.server.homeDir server configuration parameter also specifies the working directory.
loadAs
String. Optional The format in which the service returns the output. Set to:
*bytes to return the output as a byte array. This is the default.
*stream to return the output as a stream object.
*string to return the output as a string.
secretKey
Document The secret key to extract the private key required to decrypt the data.
For PGP, provide secretKeyBytes, secretKeyString, or secretKeyRingFile. If you provide secretKeyRingFile, you must also provide secretKeyAlias. Otherwise, the service throws an exception.
For JCE-KBE, provide secretKeyBytes, secretKeyString, or keyStoreAlias. If you provide keyStoreAlias, you must provide keyAlias. Otherwise, the service throws an exception.
Key
Description
secretKeyBytes
byte[ ] Optional. The secret key file in bytes.
Note:
Secret key files have a .asc extension for PGP.
secretKeyString
String Optional. The secret key as a string.
secret​KeyRingFile
String Optional. The absolute or relative path of the secret keyring file. The secret keyring file is a collection of secret keys with a unique key ID. If the file is outside the Integration Server or Microservices Runtime installation directory, provide the absolute path. Otherwise, place the file in your Integration Server or Microservices Runtime working directory. This parameter is specific to PGP.
The About page in Integration Server Administrator and Microservices Runtime Administrator displays the working directory. The watt.server.homeDir server configuration parameter also specifies the working directory.
Note:
Secret keyring files have a .skr extension for PGP.
secretKeyAlias
String Optional. The 64 bit (16 characters) key identifier of the secret key.
Note:
This parameter is required only when you use secretKeyRing​File.
secretKey ​Passphrase
String Password required to extract the private key from the secret key. This is the password provided while generating the secret key. This parameter is specific to PGP.
keyStoreAlias
String Optional. Applies only to JCE. The keystore alias that contains the private key used for decryption.
keyAlias
String Optional. Applies only to JCE. The private key alias in the keystore specified by the keyStoreAlias parameter that is used for decryption.
Note:
This parameter is required only when you use keyStoreAlias.
publicKey
Document The public key required to verify the digital signature associated with the data.
For PGP, provide publicKeyBytes, publicKeyString, or publicKeyRingFile. If you provide publicKeyRingFile, you must also provide publicKeyAlias. Otherwise, the service throws an exception.
For JCE-KBE, provide publicKeyBytes, publicKeyString, or truststoreAlias. If you provide truststoreAlias, you must also provide certAlias. Otherwise, the service throws an exception.
Key
Description
publicKeyBytes
Object List Optional. One or more public key files as byte arrays for PGP. JCE supports only a single public key file.
Note:
Public key files have a .asc extension.
publicKeyString
String List Optional. One or more public keys as strings for PGP. JCE supports only a single public key string.
public​KeyRingFile
String Optional. The absolute or relative path of the public keyring file. The public keyring file is a collection of public keys with a unique key ID. If the file is outside the Integration Server or Microservices Runtime installation directory, provide the absolute path. Otherwise, place the file in your Integration Server or Microservices Runtime working directory. This parameter is specific to PGP.
The About page in Integration Server Administrator and Microservices Runtime Administrator displays the working directory. The watt.server.homeDir server configuration parameter also specifies the working directory.
Note:
Public keyring files have a .pkr extension.
publicKeyAlias
String List Optional. One or more public key aliases as strings. A public key alias is the 64-bit (16 characters) key identifier of a public key.
Note:
This parameter is required only when you use publicKeyRingFile.
truststoreAlias
String Optional. Applies only to JCE. The alias for the truststore containing the public key and certificate.
Note:
This parameter is applicable only for JCE.
certAlias
String Optional. Applies only to JCE. The alias identifying a particular trusted certificate within a truststore.
Note:
This parameter is applicable only for JCE and is required only when you use truststoreAlias.
signingAlgorithm
String The signing algorithm to use.
*For PGP, select one of the following:
*MD5
*SHA256
*SHA384
*SHA512
The default value is SHA256 for PGP.
*For JCE, select one of the following:
*RSA
*SHA256withRSA
*SHA512withRSA
*SHA3-256withRSA
*SHA3-384withRSA
*SHA3-512withRSA
Note:
If the FIPS (Federal Information Processing Standards) mode is enabled, this service does not support the MD5 signing algorithm. FIPS mode can be enabled or disabled using the watt.security.fips.mode parameter. This is applicable only for PGP.
Note:
If the secret key for signing the data is of the DSA (Digital Signature Algorithm) key type, this service does not support the MD5 signing algorithm. This is applicable only for PGP.
cipher
String Optional. Applies only to JCE. The cipher for decryption. Select one of the following:
*RSA
*RSA/ECB/PKCS1Padding
*RSA/ECB/OAEPWithSHA-1AndMGF1Padding
*RSA/ECB/OAEPWithSHA-256AndMGF1Padding
*RSA/ECB/OAEPWithSHA-512AndMGF1Padding
*RSA/ECB/OAEPPadding
The default value is RSA.
Output Parameters
stream
java.io.OutputStream Conditional. Decrypted and verified data as an output stream. Returned when the loadAs input parameter is set to stream.
bytes
byte[ ] Conditional. Decrypted and verified data as bytes. Returned when the loadAs input parameter is set to bytes.
string
String Conditional. Decrypted and verified data as a string. Returned when the loadAs input parameter is set to string.
verified
Boolean Indicates whether the signature associated with the data is verified or not. A value of:
*true indicates that the signed data is verified.
*false indicates that the signed data is not verified.
status
String Indicates whether the data is successfully decrypted and verified. If successful, status is success. Otherwise, status contains failure along with an error message.
Usage Notes
Use the pub.security:decryptAndVerify service when an external system connected to Integration Server requires decrypted data with verified signature.
Prerequisites to use the pub.security:decryptAndVerify service:
*Generate a public-secret key pair for Integration Server.
*Make sure that the external system has access to Integration Server's public key.
*Make sure that Integration Server has access to external's system's public key.
Decryption and verification work as follows:
1. The external system sends the data encrypted with Integration Server's public key and signed with its secret key.
2. Integration Server receives the data and passes it to the pub.security:decryptAndVerify service.
3. The service uses the private key extracted from the secret key to decrypt the data.
4. The service then uses the external system's public key to verify the signature of the decrypted data.
5. The service returns the decrypted and verified data.
For PGP, conisder the following points:
*To decrypt and verify the data signed and encrypted for multiple users, you must provide your secret key and the users' public keys to the service. You can provide the public keys to the service as a list of byte arrays, strings, or a keyring file. If you provide a keyring file, you must also provide the public key aliases.
*Authentication keys used in this service must be in the PGP format and generated using the RSA encryption algorithm.
Note:
Authentication keys in the .ecc format are not supported.
For JCE, conisder the following points:
*You can decrypt and verify the data signed and encrypted for a single user only.
*The service supports a maximum data size that depends on the key size.