Elgamal Class
Properties Methods Events Config Settings Errors
Encrypt and decrypt data with the Elgamal asymmetric key encryption algorithm for public-key cryptography.
Syntax
Elgamal
Remarks
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.
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 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:
- 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 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:
The class also include the KeyPrivateKey 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 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. |
Method List
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. |
SetInputStream | Sets the stream from which the class will read data to encrypt or decrypt. |
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.
Error | Fired when information is available about errors during data delivery. |
Config Settings
The following is a list of config 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. |
MaskSensitive | Whether sensitive data is masked in log messages. |
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 | Whether or not to use the system security libraries or an internal implementation. |
InputFile Property (Elgamal Class)
The file to process.
Syntax
ANSI (Cross Platform) char* GetInputFile();
int SetInputFile(const char* lpszInputFile); Unicode (Windows) LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);
char* ipworksencrypt_elgamal_getinputfile(void* lpObj);
int ipworksencrypt_elgamal_setinputfile(void* lpObj, const char* lpszInputFile);
QString GetInputFile();
int SetInputFile(QString qsInputFile);
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:
- SetInputStream
- InputFile
- InputMessage
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.
Data Type
String
InputMessage Property (Elgamal Class)
The message to process.
Syntax
ANSI (Cross Platform) int GetInputMessage(char* &lpInputMessage, int &lenInputMessage);
int SetInputMessage(const char* lpInputMessage, int lenInputMessage); Unicode (Windows) INT GetInputMessage(LPSTR &lpInputMessage, INT &lenInputMessage);
INT SetInputMessage(LPCSTR lpInputMessage, INT lenInputMessage);
int ipworksencrypt_elgamal_getinputmessage(void* lpObj, char** lpInputMessage, int* lenInputMessage);
int ipworksencrypt_elgamal_setinputmessage(void* lpObj, const char* lpInputMessage, int lenInputMessage);
QByteArray GetInputMessage();
int SetInputMessage(QByteArray qbaInputMessage);
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:
- SetInputStream
- InputFile
- InputMessage
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.
Data Type
Binary String
KeyG Property (Elgamal Class)
Represents the G parameter for the Elgamal algorithm.
Syntax
ANSI (Cross Platform) int GetKeyG(char* &lpKeyG, int &lenKeyG);
int SetKeyG(const char* lpKeyG, int lenKeyG); Unicode (Windows) INT GetKeyG(LPSTR &lpKeyG, INT &lenKeyG);
INT SetKeyG(LPCSTR lpKeyG, INT lenKeyG);
int ipworksencrypt_elgamal_getkeyg(void* lpObj, char** lpKeyG, int* lenKeyG);
int ipworksencrypt_elgamal_setkeyg(void* lpObj, const char* lpKeyG, int lenKeyG);
QByteArray GetKeyG();
int SetKeyG(QByteArray qbaKeyG);
Default Value
""
Remarks
Represents the G parameter for the Elgamal algorithm.
Data Type
Binary String
KeyP Property (Elgamal Class)
Represents the P parameter for the Elgamal algorithm.
Syntax
ANSI (Cross Platform) int GetKeyP(char* &lpKeyP, int &lenKeyP);
int SetKeyP(const char* lpKeyP, int lenKeyP); Unicode (Windows) INT GetKeyP(LPSTR &lpKeyP, INT &lenKeyP);
INT SetKeyP(LPCSTR lpKeyP, INT lenKeyP);
int ipworksencrypt_elgamal_getkeyp(void* lpObj, char** lpKeyP, int* lenKeyP);
int ipworksencrypt_elgamal_setkeyp(void* lpObj, const char* lpKeyP, int lenKeyP);
QByteArray GetKeyP();
int SetKeyP(QByteArray qbaKeyP);
Default Value
""
Remarks
Represents the P parameter for the Elgamal algorithm.
Data Type
Binary String
KeyPrivateKey Property (Elgamal Class)
This property is a PEM formatted private key.
Syntax
ANSI (Cross Platform) char* GetKeyPrivateKey();
int SetKeyPrivateKey(const char* lpszKeyPrivateKey); Unicode (Windows) LPWSTR GetKeyPrivateKey();
INT SetKeyPrivateKey(LPCWSTR lpszKeyPrivateKey);
char* ipworksencrypt_elgamal_getkeyprivatekey(void* lpObj);
int ipworksencrypt_elgamal_setkeyprivatekey(void* lpObj, const char* lpszKeyPrivateKey);
QString GetKeyPrivateKey();
int SetKeyPrivateKey(QString qsKeyPrivateKey);
Default Value
""
Remarks
This property is a PEM formatted private key. The purpose of this property is to allow easier management of the private key parameters by using only a single value.
Data Type
String
KeyPublicKey Property (Elgamal Class)
This property is a PEM formatted public key.
Syntax
ANSI (Cross Platform) char* GetKeyPublicKey();
int SetKeyPublicKey(const char* lpszKeyPublicKey); Unicode (Windows) LPWSTR GetKeyPublicKey();
INT SetKeyPublicKey(LPCWSTR lpszKeyPublicKey);
char* ipworksencrypt_elgamal_getkeypublickey(void* lpObj);
int ipworksencrypt_elgamal_setkeypublickey(void* lpObj, const char* lpszKeyPublicKey);
QString GetKeyPublicKey();
int SetKeyPublicKey(QString qsKeyPublicKey);
Default Value
""
Remarks
This property is a PEM formatted public key. The purpose of this property is to allow easier management of the public key parameters by using only a single value.
Data Type
String
KeyX Property (Elgamal Class)
Represents the X parameter for the Elgamal algorithm.
Syntax
ANSI (Cross Platform) int GetKeyX(char* &lpKeyX, int &lenKeyX);
int SetKeyX(const char* lpKeyX, int lenKeyX); Unicode (Windows) INT GetKeyX(LPSTR &lpKeyX, INT &lenKeyX);
INT SetKeyX(LPCSTR lpKeyX, INT lenKeyX);
int ipworksencrypt_elgamal_getkeyx(void* lpObj, char** lpKeyX, int* lenKeyX);
int ipworksencrypt_elgamal_setkeyx(void* lpObj, const char* lpKeyX, int lenKeyX);
QByteArray GetKeyX();
int SetKeyX(QByteArray qbaKeyX);
Default Value
""
Remarks
Represents the X parameter for the Elgamal algorithm.
Data Type
Binary String
KeyY Property (Elgamal Class)
Represents the Y parameter for the Elgamal algorithm.
Syntax
ANSI (Cross Platform) int GetKeyY(char* &lpKeyY, int &lenKeyY);
int SetKeyY(const char* lpKeyY, int lenKeyY); Unicode (Windows) INT GetKeyY(LPSTR &lpKeyY, INT &lenKeyY);
INT SetKeyY(LPCSTR lpKeyY, INT lenKeyY);
int ipworksencrypt_elgamal_getkeyy(void* lpObj, char** lpKeyY, int* lenKeyY);
int ipworksencrypt_elgamal_setkeyy(void* lpObj, const char* lpKeyY, int lenKeyY);
QByteArray GetKeyY();
int SetKeyY(QByteArray qbaKeyY);
Default Value
""
Remarks
Represents the Y parameter for the Elgamal algorithm.
Data Type
Binary String
OutputFile Property (Elgamal Class)
The output file when encrypting or decrypting.
Syntax
ANSI (Cross Platform) char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile); Unicode (Windows) LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);
char* ipworksencrypt_elgamal_getoutputfile(void* lpObj);
int ipworksencrypt_elgamal_setoutputfile(void* lpObj, const char* lpszOutputFile);
QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);
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:
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.
Data Type
String
OutputMessage Property (Elgamal Class)
The output message after processing.
Syntax
ANSI (Cross Platform) int GetOutputMessage(char* &lpOutputMessage, int &lenOutputMessage); Unicode (Windows) INT GetOutputMessage(LPSTR &lpOutputMessage, INT &lenOutputMessage);
int ipworksencrypt_elgamal_getoutputmessage(void* lpObj, char** lpOutputMessage, int* lenOutputMessage);
QByteArray GetOutputMessage();
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:
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.
This property is read-only and not available at design time.
Data Type
Binary String
Overwrite Property (Elgamal Class)
Indicates whether or not the class should overwrite files.
Syntax
ANSI (Cross Platform) int GetOverwrite();
int SetOverwrite(int bOverwrite); Unicode (Windows) BOOL GetOverwrite();
INT SetOverwrite(BOOL bOverwrite);
int ipworksencrypt_elgamal_getoverwrite(void* lpObj);
int ipworksencrypt_elgamal_setoverwrite(void* lpObj, int bOverwrite);
bool GetOverwrite();
int SetOverwrite(bool bOverwrite);
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
RecipientKeyG Property (Elgamal Class)
Represents the G parameter for the Elgamal algorithm.
Syntax
ANSI (Cross Platform) int GetRecipientKeyG(char* &lpRecipientKeyG, int &lenRecipientKeyG);
int SetRecipientKeyG(const char* lpRecipientKeyG, int lenRecipientKeyG); Unicode (Windows) INT GetRecipientKeyG(LPSTR &lpRecipientKeyG, INT &lenRecipientKeyG);
INT SetRecipientKeyG(LPCSTR lpRecipientKeyG, INT lenRecipientKeyG);
int ipworksencrypt_elgamal_getrecipientkeyg(void* lpObj, char** lpRecipientKeyG, int* lenRecipientKeyG);
int ipworksencrypt_elgamal_setrecipientkeyg(void* lpObj, const char* lpRecipientKeyG, int lenRecipientKeyG);
QByteArray GetRecipientKeyG();
int SetRecipientKeyG(QByteArray qbaRecipientKeyG);
Default Value
""
Remarks
Represents the G parameter for the Elgamal algorithm.
Data Type
Binary String
RecipientKeyP Property (Elgamal Class)
Represents the P parameter for the Elgamal algorithm.
Syntax
ANSI (Cross Platform) int GetRecipientKeyP(char* &lpRecipientKeyP, int &lenRecipientKeyP);
int SetRecipientKeyP(const char* lpRecipientKeyP, int lenRecipientKeyP); Unicode (Windows) INT GetRecipientKeyP(LPSTR &lpRecipientKeyP, INT &lenRecipientKeyP);
INT SetRecipientKeyP(LPCSTR lpRecipientKeyP, INT lenRecipientKeyP);
int ipworksencrypt_elgamal_getrecipientkeyp(void* lpObj, char** lpRecipientKeyP, int* lenRecipientKeyP);
int ipworksencrypt_elgamal_setrecipientkeyp(void* lpObj, const char* lpRecipientKeyP, int lenRecipientKeyP);
QByteArray GetRecipientKeyP();
int SetRecipientKeyP(QByteArray qbaRecipientKeyP);
Default Value
""
Remarks
Represents the P parameter for the Elgamal algorithm.
Data Type
Binary String
RecipientKeyPublicKey Property (Elgamal Class)
This property is a PEM formatted public key.
Syntax
ANSI (Cross Platform) char* GetRecipientKeyPublicKey();
int SetRecipientKeyPublicKey(const char* lpszRecipientKeyPublicKey); Unicode (Windows) LPWSTR GetRecipientKeyPublicKey();
INT SetRecipientKeyPublicKey(LPCWSTR lpszRecipientKeyPublicKey);
char* ipworksencrypt_elgamal_getrecipientkeypublickey(void* lpObj);
int ipworksencrypt_elgamal_setrecipientkeypublickey(void* lpObj, const char* lpszRecipientKeyPublicKey);
QString GetRecipientKeyPublicKey();
int SetRecipientKeyPublicKey(QString qsRecipientKeyPublicKey);
Default Value
""
Remarks
This property is a PEM formatted public key. The purpose of this property is to allow easier management of the public key parameters by using only a single value.
Data Type
String
RecipientKeyY Property (Elgamal Class)
Represents the Y parameter for the Elgamal algorithm.
Syntax
ANSI (Cross Platform) int GetRecipientKeyY(char* &lpRecipientKeyY, int &lenRecipientKeyY);
int SetRecipientKeyY(const char* lpRecipientKeyY, int lenRecipientKeyY); Unicode (Windows) INT GetRecipientKeyY(LPSTR &lpRecipientKeyY, INT &lenRecipientKeyY);
INT SetRecipientKeyY(LPCSTR lpRecipientKeyY, INT lenRecipientKeyY);
int ipworksencrypt_elgamal_getrecipientkeyy(void* lpObj, char** lpRecipientKeyY, int* lenRecipientKeyY);
int ipworksencrypt_elgamal_setrecipientkeyy(void* lpObj, const char* lpRecipientKeyY, int lenRecipientKeyY);
QByteArray GetRecipientKeyY();
int SetRecipientKeyY(QByteArray qbaRecipientKeyY);
Default Value
""
Remarks
Represents the Y parameter for the Elgamal algorithm.
Data Type
Binary String
UseHex Property (Elgamal Class)
Whether input or output is hex encoded.
Syntax
ANSI (Cross Platform) int GetUseHex();
int SetUseHex(int bUseHex); Unicode (Windows) BOOL GetUseHex();
INT SetUseHex(BOOL bUseHex);
int ipworksencrypt_elgamal_getusehex(void* lpObj);
int ipworksencrypt_elgamal_setusehex(void* lpObj, int bUseHex);
bool GetUseHex();
int SetUseHex(bool bUseHex);
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 (Elgamal Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* ipworksencrypt_elgamal_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);
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.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
CreateKey Method (Elgamal Class)
Creates a new key.
Syntax
ANSI (Cross Platform) int CreateKey(); Unicode (Windows) INT CreateKey();
int ipworksencrypt_elgamal_createkey(void* lpObj);
int CreateKey();
Remarks
This method creates a new public and private key.
When calling CreateKey the Key* properties are populated with a new private and public key.
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:
The class also include the KeyPrivateKey property which holds the PEM formatted private key for ease of use. This is helpful for storing the private key more easily.Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Decrypt Method (Elgamal Class)
Decrypts the input data using the specified private key.
Syntax
ANSI (Cross Platform) int Decrypt(); Unicode (Windows) INT Decrypt();
int ipworksencrypt_elgamal_decrypt(void* lpObj);
int Decrypt();
Remarks
This method decrypts the input data using the private key specified in the Key* properties. Alternatively, a certificate may be specified by setting Certificate
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:
- 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.
Key Size and the Maximum Length of Data
RSA has an upper limit to the amount of data that can be encrypted or decrypted, also known as message length. This can typically be calculated as the size of the key minus the size of the RSA header and padding.
When not using OAEP, the following formula and table can be referenced. (RSA Key Bytes) - (Header Bytes) = Length of data, where Header Bytes is always 11.
RSA Key Length (bits) | Length (bits) | Length (bytes) |
1024 | 936 | 117 |
2048 | 1960 | 245 |
3072 | 2984 | 373 |
4096 | 4008 | 501 |
When using OAEP, the following formula and table can be referenced. (RSA Key Bytes) - (2 * Hash Length Bytes) - 2 = Length of data. The table below assumes SHA-256 for the hash, so Hash Length Bytes is 32.
RSA Key Length (bits) | Length (bits) | Length (bytes) |
1024 | 496 | 62 |
2048 | 1520 | 190 |
3072 | 2544 | 318 |
4096 | 3568 | 446 |
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Encrypt Method (Elgamal Class)
Encrypts the input data using the recipient's public key.
Syntax
ANSI (Cross Platform) int Encrypt(); Unicode (Windows) INT Encrypt();
int ipworksencrypt_elgamal_encrypt(void* lpObj);
int Encrypt();
Remarks
This method encrypts the input data using the public key specified in the RecipientKey* properties. Alternatively, a certificate may be specified by setting RecipientCert
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:
- 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.
Key Size and the Maximum Length of Data
RSA has an upper limit to the amount of data that can be encrypted or decrypted, also known as message length. This can typically be calculated as the size of the key minus the size of the RSA header and padding.
When not using OAEP, the following formula and table can be referenced. (RSA Key Bytes) - (Header Bytes) = Length of data, where Header Bytes is always 11.
RSA Key Length (bits) | Length (bits) | Length (bytes) |
1024 | 936 | 117 |
2048 | 1960 | 245 |
3072 | 2984 | 373 |
4096 | 4008 | 501 |
When using OAEP, the following formula and table can be referenced. (RSA Key Bytes) - (2 * Hash Length Bytes) - 2 = Length of data. The table below assumes SHA-256 for the hash, so Hash Length Bytes is 32.
RSA Key Length (bits) | Length (bits) | Length (bytes) |
1024 | 496 | 62 |
2048 | 1520 | 190 |
3072 | 2544 | 318 |
4096 | 3568 | 446 |
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Reset Method (Elgamal Class)
Resets the class.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int ipworksencrypt_elgamal_reset(void* lpObj);
int Reset();
Remarks
When called, the class will reset all of its properties to their default values.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SetInputStream Method (Elgamal Class)
Sets the stream from which the class will read data to encrypt or decrypt.
Syntax
ANSI (Cross Platform) int SetInputStream(IPWorksEncryptStream* sInputStream); Unicode (Windows) INT SetInputStream(IPWorksEncryptStream* sInputStream);
int ipworksencrypt_elgamal_setinputstream(void* lpObj, IPWorksEncryptStream* sInputStream);
int SetInputStream(IPWorksEncryptStream* sInputStream);
Remarks
This method sets the stream from which the class will read data 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:
- SetInputStream
- InputFile
- InputMessage
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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Error Event (Elgamal Class)
Fired when information is available about errors during data delivery.
Syntax
ANSI (Cross Platform) virtual int FireError(ElgamalErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } ElgamalErrorEventParams;
Unicode (Windows) virtual INT FireError(ElgamalErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } ElgamalErrorEventParams;
#define EID_ELGAMAL_ERROR 1 virtual INT IPWORKSENCRYPT_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class ElgamalErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(ElgamalErrorEventParams *e);
// Or, subclass Elgamal and override this emitter function. virtual int FireError(ElgamalErrorEventParams *e) {...}
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.
IPWorksEncryptStream Type
Syntax
IPWorksEncryptStream (declared in ipworksencrypt.h)
Remarks
The Elgamal class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the IPWorksEncryptStream interface and pass the Elgamal class an instance of that concrete class.
When implementing the IPWorksEncryptStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.
Config Settings (Elgamal 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.Elgamal Config Settings
This specifies the size, in bits, of the secret key. The minimum key size for Elgamal is 512. The maximum key size is 4096. Note that large values such as 4096 will impact performance. The default value is 1024.
Base Config Settings
When queried, this setting will return a string containing information about the product's build.
The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.
If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.
When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
Trappable Errors (Elgamal Class)
Error Handling (C++)
Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Elgamal Errors
102 No Key specified. | |
104 Cannot read or write file. | |
105 key parameters incorrect. | |
111 OutputFile already exists and Overwrite is False. | |
112 Invalid length of input message. | |
304 Cannot write file. | |
305 Cannot read file. | |
306 Cannot create file. | |
1301 Specified ElGamal parameters are invalid. | |
1302 Missing the data to encrypt/decrypt. | |
1303 Public key must be specified. | |
1304 Key must be specified. | |
1305 Invalid cipher length. The data may not have been encrypted with the public key corresponding to the specified private key data. | |
1306 Invalid cipher text. The data may not have been encrypted with the public key corresponding to the specified private key data. | |
1307 Inadequate padding. The data may not have been encrypted with the public key corresponding to the specified private key data. | |
1308 Missing delimiter. The data may not have been encrypted with the public key corresponding to the specified private key data. | |
1309 Message too long. |