EzCrypt Component

Properties   Methods   Events   Config Settings   Errors  

The EzCrypt component can be used to encrypt and decrypt data through various cryptographic algorithms.

Syntax

TipcEzCrypt

Remarks

The EzCrypt component can be used to encrypt and decrypt data through various cryptographic algorithms. The following algorithms are supported:

• AES
• Blowfish
• CAST
• DES
• IDEA
• RC2
• RC4
• TEA
• TripleDES
• Twofish
• Rijndael
• ChaCha
• XSalsa20

The Algorithm property specifies which algorithm is used.

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:

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

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();

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.

Algorithm Property (EzCrypt Component)

The symmetric algorithm.

Syntax

__property TipcEzCryptAlgorithms Algorithm = { read=FAlgorithm, write=FSetAlgorithm };

enum TipcEzCryptAlgorithms {
  ezAES=0,
  ezBlowfish=1,
  ezCAST=2,
  ezDES=3,
  ezIDEA=4,
  ezRC2=5,
  ezRC4=6,
  ezTEA=7,
  ezTripleDES=8,
  ezTwofish=9,
  ezRijndael=10,
  ezChaCha=11,
  ezXSalsa20=12
};

Default Value

ezAES

Remarks

This property specifies the symmetric algorithm to use. Possible values are:

• 0 (AES - default)
• 1 (Blowfish)
• 2 (CAST)
• 3 (DES)
• 4 (IDEA)
• 5 (RC2)
• 6 (RC4)
• 7 (TEA)
• 8 (TripleDES)
• 9 (Twofish)
• 10 (Rijndael)
• 11 (ChaCha)
• 12 (XSalsa20)

Data Type

Integer

CipherMode Property (EzCrypt Component)

The cipher mode of operation.

Syntax

__property TipcEzCryptCipherModes CipherMode = { read=FCipherMode, write=FSetCipherMode };

enum TipcEzCryptCipherModes {
  cmCBC=0,
  cmECB=1,
  cmOFB=2,
  cmCFB=3,
  cmCTS=4,
  cm8OFB=5,
  cm8CFB=7
};

Default Value

cmCBC

Remarks

The cipher mode of operation.

Possible values are:

Data Type

Integer

InputFile Property (EzCrypt 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 (EzCrypt 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 (EzCrypt 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). 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 property must be equal to the BlockSize divided by 8.

Data Type

Byte Array

Key Property (EzCrypt 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. The legal key size varies depending on the algorithm.

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

Legal Key and Block Sizes (in bits)

Note: When using TEA if Algorithm is set to XXTEA valid block sizes are 64 + n * 32. Where n is any positive integer.

The default KeySize is the Maximum Key Size.

Data Type

Byte Array

KeyPassword Property (EzCrypt 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.

The size of the Key generated is dependent on the value of KeySize.

Data Type

String

OutputFile Property (EzCrypt 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 (EzCrypt 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 (EzCrypt 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

PaddingMode Property (EzCrypt Component)

The padding mode.

Syntax

__property TipcEzCryptPaddingModes PaddingMode = { read=FPaddingMode, write=FSetPaddingMode };

enum TipcEzCryptPaddingModes {
  pmPKCS7=0,
  pmZeros=1,
  pmNone=2,
  pmANSIX923=3,
  pmISO10126=4
};

Default Value

pmPKCS7

Remarks

PaddingMode is used to pad the final input block to guarantee that it is the correct size required for the selected CipherMode. If the input size is a multiple of the cipher's BlockSize, an extra block of padding will be appended to the input. This enables the decrypting agent to know with certainty how many bytes of padding are included. Each mode pads the data differently. Possible values are:

When calling Decrypt the PaddingMode must match the value used when the data was encrypted.

Note: When using a value of 2 (pmNone), unless the length of input is an exact multiple of the cipher's input BlockSize, the final block of plaintext may be lost.

Data Type

Integer

UseHex Property (EzCrypt 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.

Data Type

Boolean

Config Method (EzCrypt 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 (EzCrypt Component)

Decrypts the data.

Syntax

void __fastcall Decrypt();

Remarks

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

• IV (required)
• Key (required)
• CipherMode
• PaddingMode

Note that CipherMode must be set to the same value used during encryption or the results may be unexpected. If the CipherMode value does not match the value used during encryption the operation may succeed but the decrypted data may not be correct.

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.

DecryptBlock Method (EzCrypt Component)

Decrypts a block and returns the decrypted data.

Syntax

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

Remarks

This method will decrypt the specified block and return the decrypted data.

InputBuffer specifies the encrypted block to decrypt.

LastBlock indicates whether the block is the last block.

Encrypt Method (EzCrypt Component)

Encrypts the data.

Syntax

void __fastcall Encrypt();

Remarks

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

• IV (required)
• Key (required)
• PaddingMode
• CipherMode

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.

EncryptBlock Method (EzCrypt Component)

Encrypts data and returns the encrypted block.

Syntax

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

Remarks

This method will encrypt the input data and return the encrypted block.

InputBuffer specifies the input data to encrypt.

LastBlock specifies whether the block is the last block.

Reset Method (EzCrypt 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 (EzCrypt Component)

Fired when information is available about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TipcEzCryptErrorEventParams;
typedef void __fastcall (__closure *TipcEzCryptErrorEvent)(System::TObject* Sender, TipcEzCryptErrorEventParams *e);
__property TipcEzCryptErrorEvent 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 (EzCrypt Component)

Fired as progress is made.

Syntax

typedef struct {
  __int64 BytesProcessed;
  int PercentProcessed;
} TipcEzCryptProgressEventParams;
typedef void __fastcall (__closure *TipcEzCryptProgressEvent)(System::TObject* Sender, TipcEzCryptProgressEventParams *e);
__property TipcEzCryptProgressEvent 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 (EzCrypt 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.

EzCrypt Config Settings

Base Config Settings

Trappable Errors (EzCrypt Component)

EzCrypt Errors