/n software Connectors for MuleSoft

Questions / Feedback?

AES Module

Properties   Configuration Settings  

The AES Transformer can be used to encrypt and decrypt data for regular transport.

Remarks

The AES Module contains an encoder and a decoder that receive Mule Messages from the Mule Project and perform cryptographic operations on the data. The encoder will produce an encrypted file that the decoder can then decrypt, making it possible to add secure storage to your business process.

Configuration

Since AES is a symmetric-key algorithm, the settings for the Encode operations and Decode operations are the exact same.

First set the KeySize to determine the strength of the cipher to be used. Next, set the KeyPassword to allow the module to generate the cryptographic Key and IV. Alternatively, you may set the Key and IV properties directly. Note that the same password may be used for the encoder and decoder to generate the same key and IV.

You can change how the cryptography is performed by setting the CipherMode and PaddingMode properties.

Encrypt Example

Add a File Read connector in front of the AES Encode Module and configure it to read a target file. Add the AES Encode Module behind it and configure it with a KeyPassword. That is all that is required to begin encrypting data.

The module will write the encrypted bytes to the payload of the Mule Message. You can specify a File Write connector behind AES Encode to write the encrypted bytes to disk or perform your own further processing.

Decrypt Example

Add a File Read connector in front of the AES Decode Module and configure it to read encrypted bytes. Add the AES Decode Module behind it specify the same KeyPassword. That is all that is required to begin decrypting the data.

The module will write the decrypted bytes to the payload of the Mule Message. You can specify a File Write connector behind AES Decode to write the plaintext bytes to disk or perform your own further processing.

Encoder Property List


The following is the full list of the properties of the encoder module with short descriptions. Click on the links for further details.

AdditionalAuthDataAdditional authentication data (AAD) used in GCM mode.
CipherModeControls how the transformer uses the IV to modify the cipher algorithm.
IVThe initialization vector used by the CipherMode to modify the ciphertext.
KeyThe raw key used by the cipher.
KeyPasswordA password used by the transformer to generate the Key and IV .
KeySizeThe size of the Key .
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during connector execution.
LogTypeHow information gets logged during connector execution.
OtherDefines a set of configuration settings to be used by the transformer.
PaddingModeUsed by the cipher to pad the last block of input text.
RuntimeLicenseSpecifies the connector runtime license key.
UseHexWhether input or output is hex encoded.

Decoder Property List


The following is the full list of the properties of the decoder module with short descriptions. Click on the links for further details.

AdditionalAuthDataAdditional authentication data (AAD) used in GCM mode.
CipherModeControls how the transformer uses the IV to modify the cipher algorithm.
IVThe initialization vector used by the CipherMode to modify the ciphertext.
KeyThe raw key used by the cipher.
KeyPasswordA password used by the transformer to generate the Key and IV .
KeySizeThe size of the Key .
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during connector execution.
LogTypeHow information gets logged during connector execution.
OtherDefines a set of configuration settings to be used by the transformer.
PaddingModeUsed by the cipher to pad the last block of input text.
RuntimeLicenseSpecifies the connector runtime license key.
UseHexWhether input or output is hex encoded.

Configuration Settings


The following is a list of configuration settings for the module with short descriptions. Click on the links for further details.

AuthTagLengthThe authentication tag length used in GCM mode.
IncludeIVWhether to prepend the IV to the output data and read the IV from the input data.
KeyPasswordAlgorithmThe hash algorithm used to derive the Key and IV from the KeyPassword property.
KeyPasswordIterationsThe number of iterations performed when using KeyPassword to derive the Key and IV.
KeyPasswordSaltThe salt value used in conjunction with the KeyPassword to derive the Key and IV.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
/n software Connectors for MuleSoft - Version 20.0 [Build 7722]