AES Pipeline Component
Properties Configuration Settings
The AES Pipeline Component can be used to encrypt and decrypt data for regular transport.
Remarks
The AES Pipeline Component contains an encoder and a decoder that receive messages from the BizTalk Message Engine 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 pipeline component 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.
Encoder Property List
The following is the full list of the properties of the encoder pipeline component with short descriptions. Click on the links for further details.
AdditionalAuthData | Additional authentication data (AAD) used in GCM mode. |
CipherMode | Controls how the pipeline component uses the IV to modify the cipher algorithm. |
IV | The initialization vector used by the CipherMode to modify the ciphertext. |
Key | The raw key used by the cipher. |
KeyPassword | A password used by the pipeline component to generate the Key and IV . |
KeySize | The size of the Key . |
Other | Defines a set of configuration settings to be used by the pipeline component. |
PaddingMode | Used by the cipher to pad the last block of input text. |
RuntimeLicense | Specifies the component runtime license key. |
TransportLog | Tells the component where and how to report information about its operations. |
Decoder Property List
The following is the full list of the properties of the decoder pipeline component with short descriptions. Click on the links for further details.
AdditionalAuthData | Additional authentication data (AAD) used in GCM mode. |
CipherMode | Controls how the pipeline component uses the IV to modify the cipher algorithm. |
IV | The initialization vector used by the CipherMode to modify the ciphertext. |
Key | The raw key used by the cipher. |
KeyPassword | A password used by the pipeline component to generate the Key and IV . |
KeySize | The size of the Key . |
Other | Defines a set of configuration settings to be used by the pipeline component. |
PaddingMode | Used by the cipher to pad the last block of input text. |
RuntimeLicense | Specifies the component runtime license key. |
TransportLog | Tells the component where and how to report information about its operations. |
Configuration Settings
The following is a list of configuration settings for the pipeline component with short descriptions. Click on the links for further details.
AuthTagLength | The authentication tag length used in GCM mode. |
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. |
PipelineOptions | Options defining the validation and protection functionality of the pipeline component. |