Rijndael Component
Properties Methods Events Configuration Settings Errors
The Rijndael component can be used to encrypt and decrypt data through the Rijndael symmetric algorithm.
Syntax
TipcRijndael
Remarks
The Rijndael component can be used to encrypt and decrypt data through the Rijndael symmetric algorithm. Includes support for key sizes of 128, 192, and 256 bits, as well as block sizes of 128, 192, and 256 bits.
To begin simply specify the data you wish to encrypt or decrypt.
Input and Output Properties
The component will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found the search stops. The order in which the output properties are checked is as follows:
- SetOutputStream
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.
Before encrypting you must have a valid Key and IV. There are a few options available to you in regards to key management. The easiest option is to simply set KeyPassword. When KeyPassword is set the component will automatically create a Key and IV using the PKCS5 password digest algorithm. This means there is only one value you need to keep track of.
If you wish to have more control over the Key and IV values you may specify the properties yourself. If IV is left empty, one will be created for you when you call Encrypt or Decrypt.
A simple example:
Component.InputFile = "C:\MyFile.txt"; Component.OutputFile = "C:\Encrypted.txt"; Component.KeyPassword = "password"; Component.Encrypt();
Note that by default the component uses a key size of 256 bits and a block size of 128 bits. You may specify the key size by setting KeySize and the block size by setting BlockSize.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
CipherMode | The cipher mode of operation. |
InputFile | The file to process. |
InputMessage | The message to process. |
IV | The initialization vector (IV). |
Key | The secret key for the symmetric algorithm. |
KeyPassword | A password to generate the Key and IV . |
OutputFile | The output file when encrypting or decrypting. |
OutputMessage | The output message after processing. |
Overwrite | Indicates whether or not the component should overwrite files. |
PaddingMode | The padding mode. |
UseHex | Whether input or output is hex encoded. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
Decrypt | Decrypts the data. |
DecryptBlock | Decrypts a block and returns the decrypted data. |
Encrypt | Encrypts the data. |
EncryptBlock | Encrypts data and returns the encrypted block. |
Reset | Resets the component. |
SetInputStream | Sets the stream from which the component will read data to encrypt or decrypt. |
SetOutputStream | Sets the stream to which the component will write encrypted or decrypted data. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
Error | Information about errors during data delivery. |
Progress | Fired as progress is made. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
BlockSize | The block size, in bits, of the cryptographic operation. |
CloseInputStreamAfterProcessing | Determines whether or not the input stream is closed after processing. |
CloseOutputStreamAfterProcessing | Determines whether or not the output stream is closed after processing. |
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. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |