Elgamal Bean
Properties Methods Events Configuration Settings Errors
Encrypt and decrypt data with the Elgamal asymmetric key encryption algorithm for public-key cryptography.
Syntax
IPWorksEncrypt.Elgamal
Remarks
The ElGamal bean 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 Key. 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 bean 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.
An Elgamal key is made up of a number of individual parameters.
The public key consists of the following parameters:
The bean also includes the PublicKey field 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 bean also include the PrivateKey field 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 bean 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. |
| 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 bean 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 bean 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 bean with short descriptions. Click on the links for further details.
| KeySize | The size, in bits, of the secret key. |
| CodePage | The system code page used for Unicode to Multibyte translations. |