ChaCha Component

Properties   Methods   Events   Config Settings   Errors  

The ChaCha component can be used to encrypt and decrypt data with the ChaCha20 algorithm.

Syntax

TipcChaCha

Remarks

The component implements ChaCha20 as defined in RFC 7539. This may be used to both encrypt and decrypt data. The component also support Authenticated Encryption with Additional Data (AEAD) via AEAD_CHACHA20_POLY1305. To enable the use of AEAD set UseAEAD to True.

Data may be encrypted and decrypted in its entirety by calling Encrypt and Decrypt or chunk by chunk by calling EncryptBlock and DecryptBlock.

In all operations a Key and IV must be used. If IV is not set one is automatically generated. KeyPassword may be set in order to automatically generate both a Key and IV when a method is called. The same KeyPassword, or Key and IV pair are used on both sides of the operation data can be encrypted and decrypted.

Encrypt Notes

Encrypt will encrypt the specified data. The following properties are applicable:

• IV (required)
• Key (required)
• UseAEAD (optional)
• AdditionalAuthData (optional - applicable if UseAEAD is True);

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:

• InputFile
• InputMessage

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

Additional Notes

The Key property must be set to a 256 bit (32 byte) value. This is the only allowed value for ChaCha20. If KeyPassword is set both Key and IV will be automatically generated when Encrypt is called.

The IV should typically be set to a 96 bit (12 byte) value. See the IV property for details on using a 64 bit (8 byte) value. If IV is not set a 96 bit (12 byte) value will automatically be generated by the component when Encrypt is called.

InitialCounter may be set for specific cases where an initial counter of 1 is needed. The default value is 0 and is recommended.

During encryption the Progress event will fire as data is encrypted.

Encrypt Example

Chacha chacha = new Chacha(); chacha.KeyB = new byte[]{ 0xBB, 0x76, 0x17, 0xC9, 0x05, 0x73, 0x4A, 0x8D, 0x59, 0x9D, 0x7B, 0x0D, 0x86, 0x2A, 0x03, 0x82, 0x50, 0x6A, 0x70, 0xFB, 0xA8, 0x56, 0x47, 0x1B, 0x1E, 0x68, 0x0B, 0x2B, 0x34, 0x18, 0x0F, 0xE2 }; chacha.IVB = new byte[] { 0x0D, 0xE4, 0x43, 0x40, 0x29, 0xAD, 0x70, 0x7D, 0x7B, 0x32, 0xB5, 0xC7 }; chacha.InputMessage = "hello chacha!"; chacha.Encrypt(); //chacha.OutputMessageB contains the byte[] of the encrypted data. The above code produces the following encrypted bytes. // {0x35, 0xBA, 0x31, 0x60, 0x02, 0x77, 0x57, 0x06, 0x5F, 0x6E, 0xE0, 0xD4, 0x76}

AEAD Notes

When encrypting and UseAEAD is True AdditionalAuthData optionally holds data that is authenticated but not encrypted.

After encrypting the message the AuthTag property will be populated. To include the AuthTag in the output set IncludeAuthTag to True.

Encrypt with AEAD Example

Chacha chacha = new Chacha(); chacha.KeyB = new byte[] { 0xBB, 0x76, 0x17, 0xC9, 0x05, 0x73, 0x4A, 0x8D, 0x59, 0x9D, 0x7B, 0x0D, 0x86, 0x2A, 0x03, 0x82, 0x50, 0x6A, 0x70, 0xFB, 0xA8, 0x56, 0x47, 0x1B, 0x1E, 0x68, 0x0B, 0x2B, 0x34, 0x18, 0x0F, 0xE2 }; chacha.IVB = new byte[] { 0x0D, 0xE4, 0x43, 0x40, 0x29, 0xAD, 0x70, 0x7D, 0x7B, 0x32, 0xB5, 0xC7 }; chacha.UseAEAD = true; chacha.AdditionalAuthData = "my auth data."; chacha.InputMessage = "hello chacha!"; chacha.Encrypt(); //chacha.OutputMessageB contains the byte[] of the encrypted data. The above code produces the following encrypted bytes: // {0x67, 0xF5, 0xC7, 0xE4, 0xE6, 0xD6, 0xC2, 0xF4, 0x09, 0xE3, 0x90, 0xF2, 0x65} //chacha.AuthTagB contains the byte[] of the AuthTag. The above code produces the following authentication tag: // {0x46, 0x35, 0xFD, 0x33, 0x30, 0x52, 0xAA, 0x6B, 0xBA, 0x32, 0x16, 0xA6, 0x48, 0x12, 0x52, 0x78}

Encrypt Block Notes

EncryptBlock will encrypt the input data and return the encrypted block. The encrypted block will always be the same length as the decrypted data. The following properties are applicable:

• IV (required)
• Key (required)

InputBuffer specifies the input data to encrypt.

LastBlock specifies whether the block is the last block. Required when UseAEAD is True. When LastBlock is True the component will calculate the AuthTag value. If UseAEAD is False the value of LastBlock is not used.

EncryptBlock Example

Chacha chacha = new Chacha(); chacha.KeyB = new byte[] { 0xBB, 0x76, 0x17, 0xC9, 0x05, 0x73, 0x4A, 0x8D, 0x59, 0x9D, 0x7B, 0x0D, 0x86, 0x2A, 0x03, 0x82, 0x50, 0x6A, 0x70, 0xFB, 0xA8, 0x56, 0x47, 0x1B, 0x1E, 0x68, 0x0B, 0x2B, 0x34, 0x18, 0x0F, 0xE2 }; chacha.IVB = new byte[] { 0x0D, 0xE4, 0x43, 0x40, 0x29, 0xAD, 0x70, 0x7D, 0x7B, 0x32, 0xB5, 0xC7 }; chacha.UseAEAD = true; byte[] tempEncryptedBlock; //Encrypt any number of blocks of any size tempEncryptedBlock = chacha.EncryptBlock(part1, false); tempEncryptedBlock = chacha.EncryptBlock(part2, false); //Pass true for the last block tempEncryptedBlock = chacha.EncryptBlock(part3, true); //Save AuthTag for use when decrypting byte[] authTag = chacha.AuthTagB;

Decrypt Notes

Decrypt will decrypt the specified data. The following properties are applicable:

• IV (required)
• Key (required)
• UseAEAD (optional)
• AuthTag (conditional - required if UseAEAD is True)
• AdditionalAuthData (optional - applicable if UseAEAD is True);

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:

• InputFile
• InputMessage

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

Additional Notes

The Key property must be set to the 256 bit (32 byte) value originally used to encrypt the data. IV must be set to the original IV value used to encrypt the data.

If using a password, KeyPassword must be set to the same KeyPassword used when encrypting the data. This will automatically generate both Key and IV when Decrypt is called.

InitialCounter may be set for specific cases where an initial counter of 1 is needed. The default value is 0 and is recommended.

During decryption the Progress event will fire as data is decrypted.

Decrypt Example

Chacha chacha = new Chacha(); chacha.KeyB = new byte[] { 0xBB, 0x76, 0x17, 0xC9, 0x05, 0x73, 0x4A, 0x8D, 0x59, 0x9D, 0x7B, 0x0D, 0x86, 0x2A, 0x03, 0x82, 0x50, 0x6A, 0x70, 0xFB, 0xA8, 0x56, 0x47, 0x1B, 0x1E, 0x68, 0x0B, 0x2B, 0x34, 0x18, 0x0F, 0xE2 }; chacha.IVB = new byte[] { 0x0D, 0xE4, 0x43, 0x40, 0x29, 0xAD, 0x70, 0x7D, 0x7B, 0x32, 0xB5, 0xC7 }; chacha.InputMessageB = new byte[] { 0x35, 0xBA, 0x31, 0x60, 0x02, 0x77, 0x57, 0x06, 0x5F, 0x6E, 0xE0, 0xD4, 0x76 }; chacha.Decrypt(); Console.WriteLine(chacha.OutputMessage); //outputs "hello chacha!"

AEAD Notes

When decrypting AdditionalAuthData must be set to the same value that was specified when encrypting. AuthTag must be set to the AuthTag value produced when encrypting.

Note: IncludeAuthTag may be set to True if the AuthTag value was included in the encrypted message.

Decrypt with AEAD Example

Chacha chacha = new Chacha(); chacha.KeyB = new byte[] { 0xBB, 0x76, 0x17, 0xC9, 0x05, 0x73, 0x4A, 0x8D, 0x59, 0x9D, 0x7B, 0x0D, 0x86, 0x2A, 0x03, 0x82, 0x50, 0x6A, 0x70, 0xFB, 0xA8, 0x56, 0x47, 0x1B, 0x1E, 0x68, 0x0B, 0x2B, 0x34, 0x18, 0x0F, 0xE2 }; chacha.IVB = new byte[] { 0x0D, 0xE4, 0x43, 0x40, 0x29, 0xAD, 0x70, 0x7D, 0x7B, 0x32, 0xB5, 0xC7 }; chacha.AuthTagB = new byte[] { 0x46, 0x35, 0xFD, 0x33, 0x30, 0x52, 0xAA, 0x6B, 0xBA, 0x32, 0x16, 0xA6, 0x48, 0x12, 0x52, 0x78 }; chacha.InputMessageB = new byte[] { 0x67, 0xF5, 0xC7, 0xE4, 0xE6, 0xD6, 0xC2, 0xF4, 0x09, 0xE3, 0x90, 0xF2, 0x65 }; chacha.UseAEAD = true; chacha.AdditionalAuthData = "my auth data."; chacha.Decrypt(); Console.WriteLine(chacha.OutputMessage); //outputs "hello chacha!"

Decrypt Block Notes

DecryptBlock will decrypt the input data and return the decrypted block. The decrypted block will always be the same length as the encrypted data. The following properties are applicable:

• IV (required)
• Key (required)

InputBuffer specifies the input data to decrypt.

LastBlock specifies whether the block is the last block. Required when UseAEAD is True. When LastBlock is True the component will validate the AuthTag value. If UseAEAD is False the value of LastBlock is not used.

DecryptBlock Example

Chacha chacha = new Chacha(); chacha.KeyB = new byte[] { 0xBB, 0x76, 0x17, 0xC9, 0x05, 0x73, 0x4A, 0x8D, 0x59, 0x9D, 0x7B, 0x0D, 0x86, 0x2A, 0x03, 0x82, 0x50, 0x6A, 0x70, 0xFB, 0xA8, 0x56, 0x47, 0x1B, 0x1E, 0x68, 0x0B, 0x2B, 0x34, 0x18, 0x0F, 0xE2 }; chacha.IVB = new byte[] { 0x0D, 0xE4, 0x43, 0x40, 0x29, 0xAD, 0x70, 0x7D, 0x7B, 0x32, 0xB5, 0xC7 }; chacha.UseAEAD = true; chacha.AuthTagB = authTag; //Value calculated during encryption. byte[] tempDecryptedBlock; //Decrypt any number of blocks of any size tempDecryptedBlock = chacha.DecryptBlock(part1, false); tempDecryptedBlock = chacha.DecryptBlock(part2, false); //Pass true for the last block tempDecryptedBlock = chacha.DecryptBlock(part3, true);

Property List

---

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

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.

Config Settings

---

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

AdditionalAuthData Property (ChaCha Component)

Additional Authentication Data (AAD) used when UseAEAD is True.

Syntax

__property String AdditionalAuthData = { read=FAdditionalAuthData, write=FSetAdditionalAuthData };
__property DynamicArray<Byte> AdditionalAuthDataB = { read=FAdditionalAuthDataB, write=FSetAdditionalAuthDataB };

Default Value

""

Remarks

This property specifies data that is authentication but not encrypted. This is only applicable when UseAEAD is True.

Note that AAD data is authenticated but not encrypted, so it is not included in the output.

Data Type

Byte Array

AuthTag Property (ChaCha Component)

The authentication tag used when UseAEAD is set to True.

Syntax

__property String AuthTag = { read=FAuthTag, write=FSetAuthTag };
__property DynamicArray<Byte> AuthTagB = { read=FAuthTagB, write=FSetAuthTagB };

Default Value

""

Remarks

This property holds the 128 bit authentication tag used when UseAEAD is set to True. It is only applicable when UseAEAD is True.

This is populated after calling Encrypt. To also include the value in the output set IncludeAuthTag to True.

This must be set before calling Decrypt. If the auth tag is included in the encrypted data set IncludeAuthTag to True before calling Decrypt.

Data Type

Byte Array

InputFile Property (ChaCha Component)

The file to process.

Syntax

__property String InputFile = { read=FInputFile, write=FSetInputFile };

Default Value

""

Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.

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:

• InputFile
• InputMessage

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

Data Type

String

InputMessage Property (ChaCha Component)

The message to process.

Syntax

__property String InputMessage = { read=FInputMessage, write=FSetInputMessage };
__property DynamicArray<Byte> InputMessageB = { read=FInputMessageB, write=FSetInputMessageB };

Default Value

""

Remarks

This property specifies the message to be processed.

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:

• InputFile
• InputMessage

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

Data Type

Byte Array

IV Property (ChaCha Component)

The initialization vector (IV).

Syntax

__property String IV = { read=FIV, write=FSetIV };
__property DynamicArray<Byte> IVB = { read=FIVB, write=FSetIVB };

Default Value

""

Remarks

This property specifies the initialization vector (IV). This is also referred to as the nonce. By default this property is empty and the component will automatically generate a new IV value if KeyPassword or Key is set before Encrypt or EncryptBlock is called.

The size of the IV may be either 96 bits in length (12 bytes) or 64 bits in length (8 bytes).

Compatibility Notes

A 96 bit length value is used for implementations implementing RFC 7539. A 64 bit length value may be used by implementations that follow the original draft of ChaCha. When using a 96 bit length value the maximum file size of data is 256 GB.

If another entity is performing the decryption and it is not known whether it supports 64 bit length values, choose a 96 bit length value by default. This follows the RFC and should be the most widely implemented value.

The component supports both lengths.

Note: If Key is specified but IV is not, an IV will be automatically generated. To control the length of the IV that is generated set IVLength.

Data Type

Byte Array

Key Property (ChaCha Component)

The secret key for the symmetric algorithm.

Syntax

__property String Key = { read=FKey, write=FSetKey };
__property DynamicArray<Byte> KeyB = { read=FKeyB, write=FSetKeyB };

Default Value

""

Remarks

This secret key is used both for encryption and decryption. The secret key should be known only to the sender and the receiver. This key must be 256 bits in length (32 bytes).

If this property is left empty and KeyPassword is specified, a Key value will be generated by the component as necessary.

Data Type

Byte Array

KeyPassword Property (ChaCha Component)

A password to generate the Key and IV .

Syntax

__property String KeyPassword = { read=FKeyPassword, write=FSetKeyPassword };

Default Value

""

Remarks

When this property is set the component will calculate values for Key and IV using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly.

Data Type

String

OutputFile Property (ChaCha Component)

The output file when encrypting or decrypting.

Syntax

__property String OutputFile = { read=FOutputFile, write=FSetOutputFile };

Default Value

""

Remarks

This property specifies the file to which the output will be written when Encrypt or Decrypt is called. This may be set to an absolute or relative path.

This property is only applicable to Encrypt and 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:

• InputFile
• InputMessage

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

Data Type

String

OutputMessage Property (ChaCha Component)

The output message after processing.

Syntax

__property String OutputMessage = { read=FOutputMessage };
__property DynamicArray<Byte> OutputMessageB = { read=FOutputMessageB };

Default Value

""

Remarks

This property will be populated with the output from the operation if OutputFile is not set.

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:

• InputFile
• InputMessage

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

This property is read-only and not available at design time.

Data Type

Byte Array

Overwrite Property (ChaCha Component)

Indicates whether or not the component should overwrite files.

Syntax

__property bool Overwrite = { read=FOverwrite, write=FSetOverwrite };

Default Value

false

Remarks

This property indicates whether or not the component will overwrite OutputFile. If Overwrite is False, an error will be thrown whenever OutputFile exists before an operation. The default value is False.

Data Type

Boolean

UseAEAD Property (ChaCha Component)

Whether to use AEAD (Authenticated Encryption with Additional Data).

Syntax

__property bool UseAEAD = { read=FUseAEAD, write=FSetUseAEAD };

Default Value

false

Remarks

If this property is set to True the component uses the algorithm AEAD_CHACHA20_POLY1305 as defined in RFC 7539 to construct a message using AEAD. See Encrypt and Decrypt for details.

Data Type

Boolean

UseHex Property (ChaCha Component)

Whether input or output is hex encoded.

Syntax

__property bool UseHex = { read=FUseHex, write=FSetUseHex };

Default Value

false

Remarks

This property specifies whether the encrypted data is hex encoded.

If set to True, when Encrypt is called the component will perform the encryption as normal and then hex encode the output. OutputMessage or OutputFile will hold hex encoded data.

If set to True, when Decrypt is called the component will expect InputMessage or InputFile to hold hex encoded data. The component will then hex decode the data and perform decryption as normal.

AEAD Notes

When UseAEAD is set to True this property also applies to AuthTag. After calling Encrypt AuthTag will hold a hex encoded value. Before calling Decrypt AuthTag must be set to a hex encoded value.

Data Type

Boolean

Config Method (ChaCha Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These 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.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Decrypt Method (ChaCha Component)

Decrypts the data.

Syntax

void __fastcall Decrypt();

Remarks

Decrypt will decrypt the specified data. The following properties are applicable:

• IV (required)
• Key (required)
• UseAEAD (optional)
• AuthTag (conditional - required if UseAEAD is True)
• AdditionalAuthData (optional - applicable if UseAEAD is True);

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:

• InputFile
• InputMessage

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

Additional Notes

The Key property must be set to the 256 bit (32 byte) value originally used to encrypt the data. IV must be set to the original IV value used to encrypt the data.

If using a password, KeyPassword must be set to the same KeyPassword used when encrypting the data. This will automatically generate both Key and IV when Decrypt is called.

InitialCounter may be set for specific cases where an initial counter of 1 is needed. The default value is 0 and is recommended.

During decryption the Progress event will fire as data is decrypted.

Decrypt Example

Chacha chacha = new Chacha(); chacha.KeyB = new byte[] { 0xBB, 0x76, 0x17, 0xC9, 0x05, 0x73, 0x4A, 0x8D, 0x59, 0x9D, 0x7B, 0x0D, 0x86, 0x2A, 0x03, 0x82, 0x50, 0x6A, 0x70, 0xFB, 0xA8, 0x56, 0x47, 0x1B, 0x1E, 0x68, 0x0B, 0x2B, 0x34, 0x18, 0x0F, 0xE2 }; chacha.IVB = new byte[] { 0x0D, 0xE4, 0x43, 0x40, 0x29, 0xAD, 0x70, 0x7D, 0x7B, 0x32, 0xB5, 0xC7 }; chacha.InputMessageB = new byte[] { 0x35, 0xBA, 0x31, 0x60, 0x02, 0x77, 0x57, 0x06, 0x5F, 0x6E, 0xE0, 0xD4, 0x76 }; chacha.Decrypt(); Console.WriteLine(chacha.OutputMessage); //outputs "hello chacha!"

AEAD Notes

When decrypting AdditionalAuthData must be set to the same value that was specified when encrypting. AuthTag must be set to the AuthTag value produced when encrypting.

Note: IncludeAuthTag may be set to True if the AuthTag value was included in the encrypted message.

Decrypt with AEAD Example

Chacha chacha = new Chacha(); chacha.KeyB = new byte[] { 0xBB, 0x76, 0x17, 0xC9, 0x05, 0x73, 0x4A, 0x8D, 0x59, 0x9D, 0x7B, 0x0D, 0x86, 0x2A, 0x03, 0x82, 0x50, 0x6A, 0x70, 0xFB, 0xA8, 0x56, 0x47, 0x1B, 0x1E, 0x68, 0x0B, 0x2B, 0x34, 0x18, 0x0F, 0xE2 }; chacha.IVB = new byte[] { 0x0D, 0xE4, 0x43, 0x40, 0x29, 0xAD, 0x70, 0x7D, 0x7B, 0x32, 0xB5, 0xC7 }; chacha.AuthTagB = new byte[] { 0x46, 0x35, 0xFD, 0x33, 0x30, 0x52, 0xAA, 0x6B, 0xBA, 0x32, 0x16, 0xA6, 0x48, 0x12, 0x52, 0x78 }; chacha.InputMessageB = new byte[] { 0x67, 0xF5, 0xC7, 0xE4, 0xE6, 0xD6, 0xC2, 0xF4, 0x09, 0xE3, 0x90, 0xF2, 0x65 }; chacha.UseAEAD = true; chacha.AdditionalAuthData = "my auth data."; chacha.Decrypt(); Console.WriteLine(chacha.OutputMessage); //outputs "hello chacha!"

DecryptBlock Method (ChaCha Component)

Decrypts a block and returns the decrypted data.

Syntax

DynamicArray<Byte> __fastcall DecryptBlock(DynamicArray<Byte> InputBuffer, bool LastBlock);

Remarks

DecryptBlock will decrypt the input data and return the decrypted block. The decrypted block will always be the same length as the encrypted data. The following properties are applicable:

• IV (required)
• Key (required)

InputBuffer specifies the input data to decrypt.

LastBlock specifies whether the block is the last block. Required when UseAEAD is True. When LastBlock is True the component will validate the AuthTag value. If UseAEAD is False the value of LastBlock is not used.

DecryptBlock Example

Chacha chacha = new Chacha(); chacha.KeyB = new byte[] { 0xBB, 0x76, 0x17, 0xC9, 0x05, 0x73, 0x4A, 0x8D, 0x59, 0x9D, 0x7B, 0x0D, 0x86, 0x2A, 0x03, 0x82, 0x50, 0x6A, 0x70, 0xFB, 0xA8, 0x56, 0x47, 0x1B, 0x1E, 0x68, 0x0B, 0x2B, 0x34, 0x18, 0x0F, 0xE2 }; chacha.IVB = new byte[] { 0x0D, 0xE4, 0x43, 0x40, 0x29, 0xAD, 0x70, 0x7D, 0x7B, 0x32, 0xB5, 0xC7 }; chacha.UseAEAD = true; chacha.AuthTagB = authTag; //Value calculated during encryption. byte[] tempDecryptedBlock; //Decrypt any number of blocks of any size tempDecryptedBlock = chacha.DecryptBlock(part1, false); tempDecryptedBlock = chacha.DecryptBlock(part2, false); //Pass true for the last block tempDecryptedBlock = chacha.DecryptBlock(part3, true);

Encrypt Method (ChaCha Component)

Encrypts the data.

Syntax

void __fastcall Encrypt();

Remarks

Encrypt will encrypt the specified data. The following properties are applicable:

• IV (required)
• Key (required)
• UseAEAD (optional)
• AdditionalAuthData (optional - applicable if UseAEAD is True);

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:

• InputFile
• InputMessage

When a valid source is found, the search stops. The order in which the output properties are checked is as follows:

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

Additional Notes

The Key property must be set to a 256 bit (32 byte) value. This is the only allowed value for ChaCha20. If KeyPassword is set both Key and IV will be automatically generated when Encrypt is called.

The IV should typically be set to a 96 bit (12 byte) value. See the IV property for details on using a 64 bit (8 byte) value. If IV is not set a 96 bit (12 byte) value will automatically be generated by the component when Encrypt is called.

InitialCounter may be set for specific cases where an initial counter of 1 is needed. The default value is 0 and is recommended.

During encryption the Progress event will fire as data is encrypted.

Encrypt Example

Chacha chacha = new Chacha(); chacha.KeyB = new byte[]{ 0xBB, 0x76, 0x17, 0xC9, 0x05, 0x73, 0x4A, 0x8D, 0x59, 0x9D, 0x7B, 0x0D, 0x86, 0x2A, 0x03, 0x82, 0x50, 0x6A, 0x70, 0xFB, 0xA8, 0x56, 0x47, 0x1B, 0x1E, 0x68, 0x0B, 0x2B, 0x34, 0x18, 0x0F, 0xE2 }; chacha.IVB = new byte[] { 0x0D, 0xE4, 0x43, 0x40, 0x29, 0xAD, 0x70, 0x7D, 0x7B, 0x32, 0xB5, 0xC7 }; chacha.InputMessage = "hello chacha!"; chacha.Encrypt(); //chacha.OutputMessageB contains the byte[] of the encrypted data. The above code produces the following encrypted bytes. // {0x35, 0xBA, 0x31, 0x60, 0x02, 0x77, 0x57, 0x06, 0x5F, 0x6E, 0xE0, 0xD4, 0x76}

AEAD Notes

When encrypting and UseAEAD is True AdditionalAuthData optionally holds data that is authenticated but not encrypted.

After encrypting the message the AuthTag property will be populated. To include the AuthTag in the output set IncludeAuthTag to True.

Encrypt with AEAD Example

Chacha chacha = new Chacha(); chacha.KeyB = new byte[] { 0xBB, 0x76, 0x17, 0xC9, 0x05, 0x73, 0x4A, 0x8D, 0x59, 0x9D, 0x7B, 0x0D, 0x86, 0x2A, 0x03, 0x82, 0x50, 0x6A, 0x70, 0xFB, 0xA8, 0x56, 0x47, 0x1B, 0x1E, 0x68, 0x0B, 0x2B, 0x34, 0x18, 0x0F, 0xE2 }; chacha.IVB = new byte[] { 0x0D, 0xE4, 0x43, 0x40, 0x29, 0xAD, 0x70, 0x7D, 0x7B, 0x32, 0xB5, 0xC7 }; chacha.UseAEAD = true; chacha.AdditionalAuthData = "my auth data."; chacha.InputMessage = "hello chacha!"; chacha.Encrypt(); //chacha.OutputMessageB contains the byte[] of the encrypted data. The above code produces the following encrypted bytes: // {0x67, 0xF5, 0xC7, 0xE4, 0xE6, 0xD6, 0xC2, 0xF4, 0x09, 0xE3, 0x90, 0xF2, 0x65} //chacha.AuthTagB contains the byte[] of the AuthTag. The above code produces the following authentication tag: // {0x46, 0x35, 0xFD, 0x33, 0x30, 0x52, 0xAA, 0x6B, 0xBA, 0x32, 0x16, 0xA6, 0x48, 0x12, 0x52, 0x78}

EncryptBlock Method (ChaCha Component)

Encrypts data and returns the encrypted block.

Syntax

DynamicArray<Byte> __fastcall EncryptBlock(DynamicArray<Byte> InputBuffer, bool LastBlock);

Remarks

EncryptBlock will encrypt the input data and return the encrypted block. The encrypted block will always be the same length as the decrypted data. The following properties are applicable:

• IV (required)
• Key (required)

InputBuffer specifies the input data to encrypt.

LastBlock specifies whether the block is the last block. Required when UseAEAD is True. When LastBlock is True the component will calculate the AuthTag value. If UseAEAD is False the value of LastBlock is not used.

EncryptBlock Example

Chacha chacha = new Chacha(); chacha.KeyB = new byte[] { 0xBB, 0x76, 0x17, 0xC9, 0x05, 0x73, 0x4A, 0x8D, 0x59, 0x9D, 0x7B, 0x0D, 0x86, 0x2A, 0x03, 0x82, 0x50, 0x6A, 0x70, 0xFB, 0xA8, 0x56, 0x47, 0x1B, 0x1E, 0x68, 0x0B, 0x2B, 0x34, 0x18, 0x0F, 0xE2 }; chacha.IVB = new byte[] { 0x0D, 0xE4, 0x43, 0x40, 0x29, 0xAD, 0x70, 0x7D, 0x7B, 0x32, 0xB5, 0xC7 }; chacha.UseAEAD = true; byte[] tempEncryptedBlock; //Encrypt any number of blocks of any size tempEncryptedBlock = chacha.EncryptBlock(part1, false); tempEncryptedBlock = chacha.EncryptBlock(part2, false); //Pass true for the last block tempEncryptedBlock = chacha.EncryptBlock(part3, true); //Save AuthTag for use when decrypting byte[] authTag = chacha.AuthTagB;

Reset Method (ChaCha Component)

Resets the component.

Syntax

void __fastcall Reset();

Remarks

When called, the component will reset all of its properties to their default values.

Error Event (ChaCha Component)

Fired when information is available about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TipcChaChaErrorEventParams;
typedef void __fastcall (__closure *TipcChaChaErrorEvent)(System::TObject* Sender, TipcChaChaErrorEventParams *e);
__property TipcChaChaErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Progress Event (ChaCha Component)

Fired as progress is made.

Syntax

typedef struct {
  __int64 BytesProcessed;
  int PercentProcessed;
} TipcChaChaProgressEventParams;
typedef void __fastcall (__closure *TipcChaChaProgressEvent)(System::TObject* Sender, TipcChaChaProgressEventParams *e);
__property TipcChaChaProgressEvent OnProgress = { read=FOnProgress, write=FOnProgress };

Remarks

This event is fired automatically as data is processed by the component.

The PercentProcessed parameter indicates the current status of the operation.

The BytesProcessed parameter holds the total number of bytes processed so far.

Config Settings (ChaCha Component)

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.

ChaCha Config Settings

Base Config Settings

Trappable Errors (ChaCha Component)

ChaCha Errors