EzCrypt Module
Properties Configuration Settings
The EzCrypt Transformer can be used to encrypt and decrypt data for regular transport.
Remarks
The EzCrypt 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
To use the EzCrypt Module, first select an Algorithm. Only symmetric algorithms are supported in the EzCrypt Module.
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 control the size of the key by setting the KeySize configuration setting. 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 EzCrypt Encode Module and configure it to read a target file. Add the EzCrypt 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 EzCrypt 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 EzCrypt Decode Module and configure it to read encrypted bytes. Add the EzCrypt 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 EzCrypt 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.
Algorithm | The symmetric algorithm. |
CipherMode | The cipher mode of operation. |
IV | The initialization vector used by the CipherMode to modify the ciphertext. |
Key | The secret key for the symmetric algorithm. |
KeyPassword | A password used by the transformer to generate the Key and IV . |
LogFile | The file to write logging information to at runtime. |
LogMode | What information gets logged during component execution. |
LogType | How information gets logged during component execution. |
Other | Defines a set of configuration settings to be used by the transformer. |
PaddingMode | The padding mode. |
RuntimeLicense | Specifies the component runtime license key. |
UseHex | Whether 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.
Algorithm | The symmetric algorithm. |
CipherMode | The cipher mode of operation. |
IV | The initialization vector used by the CipherMode to modify the ciphertext. |
Key | The secret key for the symmetric algorithm. |
KeyPassword | A password used by the transformer to generate the Key and IV . |
LogFile | The file to write logging information to at runtime. |
LogMode | What information gets logged during component execution. |
LogType | How information gets logged during component execution. |
Other | Defines a set of configuration settings to be used by the transformer. |
PaddingMode | The padding mode. |
RuntimeLicense | Specifies the component runtime license key. |
UseHex | Whether 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.
BlockSize | The block size, in bits, of the cryptographic operation. |
IncludeIV | Whether to prepend the IV to the output data and read the IV from the input data. |
KeyPasswordAlgorithm | The hash algorithm used to derive the Key and IV from the KeyPassword property. |
KeyPasswordIterations | The number of iterations performed when using KeyPassword to derive the Key and IV. |
KeyPasswordSalt | The salt value used in conjunction with the KeyPassword to derive the Key and IV. |
KeySize | The size, in bits, of secret key for the symmetric algorithm. |
TeaAlgorithm | The TEA algorithm. |