Elgamal Component

Properties Methods Events Configuration Settings Errors

Encrypt and decrypt data with the Elgamal asymmetric key encryption algorithm for public-key cryptography.

Syntax

TipcElgamal

Remarks

The ElGamal component 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.

After specifying a key, specify the data you wish to encrypt or decrypt. Call the Encrypt or Decrypt method to perform the operation.

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:

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

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

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

An Elgamal key is made up of a number of individual parameters.

The public key consists of the following parameters:

The component also includes the PublicKey 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 PublicKey in which case the individual parameters must be sent.

The private key consists of the following parameters:

The component also include the PrivateKey property which holds the PEM formatted private key for ease of use. This is helpful for storing the private key more easily.

Property List

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


InputFile	The file to process.
InputMessage	The message to process.
Key	The Elgamal key used for decryption.
OutputFile	The output file when encrypting or decrypting.
OutputMessage	The output message after processing.
Overwrite	Indicates whether or not the component should overwrite files.
RecipientKey	The recipient's public key used when encrypting.
UseHex	Whether input or output is hex encoded.

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.
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 component.
SetInputStream	Sets the stream from which the component will read data to encrypt or decrypt.

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	Information about errors during data delivery.

Configuration Settings

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


CloseInputStreamAfterProcessing	Determines whether or not the input stream is closed after processing.
CloseOutputStreamAfterProcessing	Determines whether or not the output stream is closed after processing.
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.
UseInternalSecurityAPI	Tells the component whether or not to use the system security libraries or an internal implementation.