EzCrypt Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

IPWorksEncrypt_EzCrypt

Procedural Interface

 ipworksencrypt_ezcrypt_open();
 ipworksencrypt_ezcrypt_close($res);
 ipworksencrypt_ezcrypt_register_callback($res, $id, $function);
 ipworksencrypt_ezcrypt_get_last_error($res);
 ipworksencrypt_ezcrypt_get_last_error_code($res);
 ipworksencrypt_ezcrypt_set($res, $id, $index, $value);
 ipworksencrypt_ezcrypt_get($res, $id, $index);
 ipworksencrypt_ezcrypt_do_config($res, $configurationstring);
 ipworksencrypt_ezcrypt_do_decrypt($res);
 ipworksencrypt_ezcrypt_do_decryptblock($res, $inputbuffer, $lastblock);
 ipworksencrypt_ezcrypt_do_encrypt($res);
 ipworksencrypt_ezcrypt_do_encryptblock($res, $inputbuffer, $lastblock);
 ipworksencrypt_ezcrypt_do_reset($res);

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 class 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 class with short descriptions. Click on the links for further details.

Method List

---

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

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

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

Algorithm Property (IPWorksEncrypt_EzCrypt Class)

The symmetric algorithm.

Object Oriented Interface

public function getAlgorithm();
public function setAlgorithm($value);

Procedural Interface

ipworksencrypt_ezcrypt_get($res, 1 );
ipworksencrypt_ezcrypt_set($res, 1, $value );

Default Value

0

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 (IPWorksEncrypt_EzCrypt Class)

The cipher mode of operation.

Object Oriented Interface

public function getCipherMode();
public function setCipherMode($value);

Procedural Interface

ipworksencrypt_ezcrypt_get($res, 2 );
ipworksencrypt_ezcrypt_set($res, 2, $value );

Default Value

0

Remarks

The cipher mode of operation.

Possible values are:

Data Type

Integer

InputFile Property (IPWorksEncrypt_EzCrypt Class)

The file to process.

Object Oriented Interface

public function getInputFile();
public function setInputFile($value);

Procedural Interface

ipworksencrypt_ezcrypt_get($res, 3 );
ipworksencrypt_ezcrypt_set($res, 3, $value );

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 class 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 (IPWorksEncrypt_EzCrypt Class)

The message to process.

Object Oriented Interface

public function getInputMessage();
public function setInputMessage($value);

Procedural Interface

ipworksencrypt_ezcrypt_get($res, 4 );
ipworksencrypt_ezcrypt_set($res, 4, $value );

Default Value

''

Remarks

This property specifies the message to be processed.

Input and Output Properties

The class 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

Binary String

IV Property (IPWorksEncrypt_EzCrypt Class)

The initialization vector (IV).

Object Oriented Interface

public function getIV();
public function setIV($value);

Procedural Interface

ipworksencrypt_ezcrypt_get($res, 5 );
ipworksencrypt_ezcrypt_set($res, 5, $value );

Default Value

''

Remarks

This property specifies the initialization vector (IV). By default this property is empty and the class 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

Binary String

Key Property (IPWorksEncrypt_EzCrypt Class)

The secret key for the symmetric algorithm.

Object Oriented Interface

public function getKey();
public function setKey($value);

Procedural Interface

ipworksencrypt_ezcrypt_get($res, 6 );
ipworksencrypt_ezcrypt_set($res, 6, $value );

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 class 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

Binary String

KeyPassword Property (IPWorksEncrypt_EzCrypt Class)

A password to generate the Key and IV .

Object Oriented Interface

public function getKeyPassword();
public function setKeyPassword($value);

Procedural Interface

ipworksencrypt_ezcrypt_get($res, 7 );
ipworksencrypt_ezcrypt_set($res, 7, $value );

Default Value

''

Remarks

When this property is set the class 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 (IPWorksEncrypt_EzCrypt Class)

The output file when encrypting or decrypting.

Object Oriented Interface

public function getOutputFile();
public function setOutputFile($value);

Procedural Interface

ipworksencrypt_ezcrypt_get($res, 8 );
ipworksencrypt_ezcrypt_set($res, 8, $value );

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 class 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 (IPWorksEncrypt_EzCrypt Class)

The output message after processing.

Object Oriented Interface

public function getOutputMessage();

Procedural Interface

ipworksencrypt_ezcrypt_get($res, 9 );

Default Value

''

Remarks

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

Input and Output Properties

The class 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

Binary String

Overwrite Property (IPWorksEncrypt_EzCrypt Class)

Indicates whether or not the class should overwrite files.

Object Oriented Interface

public function getOverwrite();
public function setOverwrite($value);

Procedural Interface

ipworksencrypt_ezcrypt_get($res, 10 );
ipworksencrypt_ezcrypt_set($res, 10, $value );

Default Value

false

Remarks

This property indicates whether or not the class 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 (IPWorksEncrypt_EzCrypt Class)

The padding mode.

Object Oriented Interface

public function getPaddingMode();
public function setPaddingMode($value);

Procedural Interface

ipworksencrypt_ezcrypt_get($res, 11 );
ipworksencrypt_ezcrypt_set($res, 11, $value );

Default Value

0

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 (IPWorksEncrypt_EzCrypt Class)

Whether input or output is hex encoded.

Object Oriented Interface

public function getUseHex();
public function setUseHex($value);

Procedural Interface

ipworksencrypt_ezcrypt_get($res, 12 );
ipworksencrypt_ezcrypt_set($res, 12, $value );

Default Value

false

Remarks

This property specifies whether the encrypted data is hex encoded.

If set to True, when Encrypt is called the class 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 class will expect InputMessage or InputFile to hold hex encoded data. The class will then hex decode the data and perform decryption as normal.

Data Type

Boolean

Config Method (IPWorksEncrypt_EzCrypt Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksencrypt_ezcrypt_do_config($res, $configurationstring);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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 (IPWorksEncrypt_EzCrypt Class)

Decrypts the data.

Object Oriented Interface

public function doDecrypt();

Procedural Interface

ipworksencrypt_ezcrypt_do_decrypt($res);

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 class 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 (IPWorksEncrypt_EzCrypt Class)

Decrypts a block and returns the decrypted data.

Object Oriented Interface

public function doDecryptBlock($inputbuffer, $lastblock);

Procedural Interface

ipworksencrypt_ezcrypt_do_decryptblock($res, $inputbuffer, $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 (IPWorksEncrypt_EzCrypt Class)

Encrypts the data.

Object Oriented Interface

public function doEncrypt();

Procedural Interface

ipworksencrypt_ezcrypt_do_encrypt($res);

Remarks

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

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

Input and Output Properties

The class 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 (IPWorksEncrypt_EzCrypt Class)

Encrypts data and returns the encrypted block.

Object Oriented Interface

public function doEncryptBlock($inputbuffer, $lastblock);

Procedural Interface

ipworksencrypt_ezcrypt_do_encryptblock($res, $inputbuffer, $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 (IPWorksEncrypt_EzCrypt Class)

Resets the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksencrypt_ezcrypt_do_reset($res);

Remarks

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

Error Event (IPWorksEncrypt_EzCrypt Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksencrypt_ezcrypt_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

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 (IPWorksEncrypt_EzCrypt Class)

Fired as progress is made.

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

ipworksencrypt_ezcrypt_register_callback($res, 2, array($this, 'fireProgress'));

Parameter List

 'bytesprocessed'
 'percentprocessed'

Remarks

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

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 Class)

The class 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 class, access to these internal properties is provided through the Config method.

EzCrypt Config Settings

Base Config Settings

Trappable Errors (EzCrypt Class)

EzCrypt Errors