SymmetricCrypto Component
Properties Methods Events Configuration Settings Errors
The SymmetricCrypto component supports encrypting and decrypting messages.
Syntax
TsbiSymmetricCrypto
Remarks
SymmetricCrypto allows you to encrypt and decrypt messages.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
AssociatedData | Provides Associated Data for AEAD algorithms. |
BlockSize | The block size of the chosen symmetric cipher. |
EncryptionAlgorithm | The encryption algorithm to use for encrypting the data. |
HashAlgorithm | The hash algorithm to use during encryption. |
InputEncoding | The encoding to apply to the input data. |
Key | The key to use for the cryptographic operation. |
KeySize | Returns the cryptographic key size in bytes. |
MACAlgorithm | The (H)MAC algorithm to use during encryption. |
Mode | Specifies the symmetric cipher mode of operation. |
Nonce | Specifies the Nonce value to employ. |
OutputEncoding | The encoding to apply to the output data. |
Padding | The padding type to apply to the encrypted data. |
PayloadSize | Specifies the payload size, in bytes. |
StreamCipher | Returns true if the selected algorithms works as a stream cipher. |
TagSize | Specifies the AEAD tag size, in bytes. |
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 a buffer. |
DecryptFile | Decrypts a file. |
DecryptFinal | Finalization of decryption by blocks. |
DecryptInit | Initializes a per-block decryption process. |
DecryptUpdate | Decrypts the next block of encrypted data. |
Encrypt | Encrypts a buffer. |
EncryptFile | Encrypts a file. |
EncryptFinal | Finalization of encryption by blocks. |
EncryptInit | Initializes a per-block encryption process. |
EncryptUpdate | Encrypts the next block of 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 | Reports errors during encryption or decryption. |
Notification | This event notifies the application about an underlying control flow event. |
Progress | Reports the data encryption/decryption progress. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
Compress | Specifies whether the JSON output should be compressed. |
CTRLittleEndian | Specifies whether the little-endian representation should be employed in CTR mode. |
TempPath | Path for storing temporary files. |