AES Configuration
The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.AES Configuration Settings
| AdditionalAuthData: Additional authentication data (AAD) used in GCM mode.This setting optionally specifies additional authentication data. The data specified must be hex encoded. This is only applicable when CipherMode is set to 6 (cmGCM). This may be set prior to calling Encrypt or Decrypt. Note that AAD data is authenticated but not encrypted, so it is not included in OutputMessage | |
| AuthTag: The authentication tag used in GCM mode.This setting is only applicable when CipherMode is set to 6 (cmGCM). This is populated with a hex encoded value after calling Encrypt. It must be specified with a hex encoded value before calling Decrypt. | |
AuthTagLength: The authentication tag length used in GCM mode.This setting is only applicable when CipherMode is set to 6 (cmGCM).
This may be set before calling Encrypt. The default value is 96. Valid values are
| |
| IncludeAuthTag: Whether to append the authentication tag to the cipher text in GCM mode.This setting controls whether AuthTag is appended to the cipher text. This may be useful in cases where the other party knows to look for the authentication tag at the end of the data. The default value is False. | |
| KeySize: The size, in bits, of secret key for the symmetric algorithm.The legal key sizes vary depending on the algorithm. The KeySize and BlockSize
configuration settings may be set to specify the key and block size (in bits).
This setting is only applicable when KeyPassword is specified. Note that when using the EzCrypt component, KeySize should be set after setting the Algorithm property. | |
| BlockSize: The block size, in bits, of the cryptographic operation.The block size is a basic data unit in the operation of encrypt or decrypt. Messages longer than the block size are seen as successive blocks. If the message is shorter than the block size, the message will be padded with extra bits to reach the block size according to PaddingMode.
Different symmetric algorithm has different valid block sizes.
The following algorithms have a fixed block size: AES, CAST, DES, IDEA, RC2, TripleDES, Blowfish, and Twofish. | |
| IncludeIV: Whether to prepend the IV to the output data and read the IV from the input data.If this config is true, the IV will be automatically prepended to the output data when calling Encrypt. When calling Decrypt and this setting is True, the IV is automatically extracted form the ciphertext. The default value is False. | |
KeyPasswordAlgorithm: The hash algorithm used to derive the Key and IV from the KeyPassword property.This configuration setting specifies which hash algorithm will be used when deriving the Key and IV from KeyPassword.
The default value is "MD5". Possible values are:
| |
| KeyPasswordSalt: The salt value used in conjunction with the KeyPassword to derive the Key and IV.This configuration setting specifies the hex encoded salt value to be used along with the KeyPassword when calculating values for Key and IV. |
Base Configuration Settings
| CodePage: The system code page used for Unicode to Multibyte translations.
The default code page is the Active Code Page (0).
The following is a list of valid code page identifiers:
|