Encrypt and decrypt data with the Elgamal asymmetric key encryption algorithm for public-key cryptography.
ipworksencrypt_elgamal_open(); ipworksencrypt_elgamal_close($res); ipworksencrypt_elgamal_register_callback($res, $id, $function); ipworksencrypt_elgamal_get_last_error($res); ipworksencrypt_elgamal_get_last_error_code($res); ipworksencrypt_elgamal_set($res, $id, $index, $value); ipworksencrypt_elgamal_get($res, $id, $index); ipworksencrypt_elgamal_do_config($res, $configurationstring); ipworksencrypt_elgamal_do_createkey($res); ipworksencrypt_elgamal_do_decrypt($res); ipworksencrypt_elgamal_do_encrypt($res); ipworksencrypt_elgamal_do_reset($res);
The ElGamal class is used to encrypt/decrypt data with the Elgamal asymmetric key encryption algorithm for public-key cryptography.
To begin you must either specify an existing key or create a new key. Existing public or private keys may be specified by setting the Key* properties. To create a new key pair call CreateKey.
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:
When a valid source is found the search stops. The order in which the output properties are checked is as follows:
- OutputMessage: The output data is written to this property if no other destination is specified.
An Elgamal key is made up of a number of individual parameters.
The public key consists of the following parameters:
The class also includes the KeyPublicKey property which holds the PEM formatted public key for ease of use. This is helpful if you are in control of both signature creation and verification process. When sending the public key to a recipient note that not all implementations will support using the PEM formatted value in KeyPublicKey in which case the individual parameters must be sent.
The private key consists of the following parameters:KeyPrivateKey property which holds the PEM formatted private key for ease of use. This is helpful for storing the private key more easily.
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
|InputFile||The file to process.|
|InputMessage||The message to process.|
|KeyG||Represents the G parameter for the Elgamal algorithm.|
|KeyP||Represents the P parameter for the Elgamal algorithm.|
|KeyPrivateKey||This property is a PEM formatted private key.|
|KeyPublicKey||This property is a PEM formatted public key.|
|KeyX||Represents the X parameter for the Elgamal algorithm.|
|KeyY||Represents the Y parameter for the Elgamal algorithm.|
|OutputFile||The output file when encrypting or decrypting.|
|OutputMessage||The output message after processing.|
|Overwrite||Indicates whether or not the class should overwrite files.|
|RecipientKeyG||Represents the G parameter for the Elgamal algorithm.|
|RecipientKeyP||Represents the P parameter for the Elgamal algorithm.|
|RecipientKeyPublicKey||This property is a PEM formatted public key.|
|RecipientKeyY||Represents the Y parameter for the Elgamal algorithm.|
|UseHex||Whether input or output is hex encoded.|
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
|Config||Sets or retrieves a configuration setting.|
|CreateKey||Creates a new key.|
|Decrypt||Decrypts the input data using the specified private key.|
|Encrypt||Encrypts the input data using the recipient's public key.|
|Reset||Resets the class.|
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
|Error||Information about errors during data delivery.|
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
|KeySize||The size, in bits, of the secret key.|
|BuildInfo||Information about the product's build.|
|CodePage||The system code page used for Unicode to Multibyte translations.|
|LicenseInfo||Information about the current license.|
|ProcessIdleEvents||Whether the class uses its internal event loop to process events when the main thread is idle.|
|SelectWaitMillis||The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.|
|UseInternalSecurityAPI||Tells the class whether or not to use the system security libraries or an internal implementation.|