# ElGamal Class

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

## Syntax

**ipworksencrypt.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 [Key](#elgamalkey-property). To create a new key pair, call [CreateKey](#elgamalcreatekey-method).

After specifying a key, specify the data you wish to encrypt or decrypt. Call the [Encrypt](#elgamalencrypt-method) or [Decrypt](#elgamaldecrypt-method) 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:

- [InputFile](#elgamalinputfile-property)
- [InputMessage](#elgamalinputmessage-property)

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

- [OutputFile](#elgamaloutputfile-property)
- [OutputMessage](#elgamaloutputmessage-property): 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:

- KeyP
- KeyG
- KeyY

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:

- KeyP
- KeyG
- KeyY
- KeyX

 The class also includes 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](#elgamalinputfile-property) | The file to process. |
| [InputMessage](#elgamalinputmessage-property) | The message to process. |
| [Key](#elgamalkey-property) | The ElGamal key used for decryption. |
| [OutputFile](#elgamaloutputfile-property) | The output file when encrypting or decrypting. |
| [OutputMessage](#elgamaloutputmessage-property) | The output message after processing. |
| [Overwrite](#elgamaloverwrite-property) | Indicates whether or not the class should overwrite files. |
| [RecipientKey](#elgamalrecipientkey-property) | The recipient's public key used when encrypting. |
| [UseHex](#elgamalusehex-property) | 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](#elgamalconfig-method) | Sets or retrieves a configuration setting. |
| [CreateKey](#elgamalcreatekey-method) | Creates a new key. |
| [Decrypt](#elgamaldecrypt-method) | Decrypts the input data using the specified private key. |
| [Encrypt](#elgamalencrypt-method) | Encrypts the input data using the recipient's public key. |
| [Reset](#elgamalreset-method) | Resets the class. |
| [SetInputStream](#elgamalsetinputstream-method) | 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](#elgamalerror-event) | 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](#KeySize) | The size, in bits, of the secret key. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# [ElGamal](#elgamal-class).InputFile Property

The file to process.

## Syntax

```text
getInputFile(): string;
setInputFile(inputFile: string): void;
```

## 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](#elgamalinputmessage-property)

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

- [OutputFile](#elgamaloutputfile-property)
- [OutputMessage](#elgamaloutputmessage-property): The output data is written to this property if no other destination is specified.

# [ElGamal](#elgamal-class).InputMessage Property

The message to process.

## Syntax

```text
getInputMessage(): Uint8Array;
setInputMessage(inputMessage: Uint8Array): void;
```

## 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](#elgamalinputfile-property)
- InputMessage

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

- [OutputFile](#elgamaloutputfile-property)
- [OutputMessage](#elgamaloutputmessage-property): The output data is written to this property if no other destination is specified.

# [ElGamal](#elgamal-class).Key Property

The ElGamal key used for decryption.

## Syntax

```text
getKey(): ElGamalKey;
setKey(key: ElGamalKey): void;
```

## Default Value

## Remarks

This property specifies the ElGamal key used to decrypt data. This property must be set before calling [Decrypt](#elgamaldecrypt-method).

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

The public key consists of the following parameters:

- KeyP
- KeyG
- KeyY

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:

- KeyP
- KeyG
- KeyY
- KeyX

 The class also includes the KeyPrivateKey property which holds the PEM formatted private key for ease of use. This is helpful for storing the private key more easily.

 Please refer to the [ElGamalKey](#elgamalkey-type) type for a complete list of fields.

# [ElGamal](#elgamal-class).OutputFile Property

The output file when encrypting or decrypting.

## Syntax

```text
getOutputFile(): string;
setOutputFile(outputFile: string): void;
```

## Default Value

""

## Remarks

This property specifies the file to which the output will be written when [Encrypt](#elgamalencrypt-method) or [Decrypt](#elgamaldecrypt-method) is called. This may be set to an absolute or relative path.

This property is only applicable to [Encrypt](#elgamalencrypt-method) and [Decrypt](#elgamaldecrypt-method).

**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](#elgamalinputfile-property)
- [InputMessage](#elgamalinputmessage-property)

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

- OutputFile
- [OutputMessage](#elgamaloutputmessage-property): The output data is written to this property if no other destination is specified.

# [ElGamal](#elgamal-class).OutputMessage Property

The output message after processing.

## Syntax

```text
getOutputMessage(): Uint8Array;
```

## Default Value

""

## Remarks

This property will be populated with the output from the operation if [OutputFile](#elgamaloutputfile-property) 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](#elgamalinputfile-property)
- [InputMessage](#elgamalinputmessage-property)

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

- [OutputFile](#elgamaloutputfile-property)
- 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.

# [ElGamal](#elgamal-class).Overwrite Property

Indicates whether or not the class should overwrite files.

## Syntax

```text
isOverwrite(): boolean;
setOverwrite(overwrite: boolean): void;
```

## Default Value

FALSE

## Remarks

This property indicates whether or not the class will overwrite [OutputFile](#elgamaloutputfile-property). If Overwrite is False, an error will be thrown whenever [OutputFile](#elgamaloutputfile-property) exists before an operation. The default value is False.

# [ElGamal](#elgamal-class).RecipientKey Property

The recipient's public key used when encrypting.

## Syntax

```text
getRecipientKey(): ElGamalKey;
setRecipientKey(recipientKey: ElGamalKey): void;
```

## Default Value

## Remarks

This property specifies the recipient's public key. This property must be set before calling [Encrypt](#elgamalencrypt-method).

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

The public key consists of the following parameters:

- KeyP
- KeyG
- KeyY

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:

- KeyP
- KeyG
- KeyY
- KeyX

 The class also includes the KeyPrivateKey property which holds the PEM formatted private key for ease of use. This is helpful for storing the private key more easily.

 Please refer to the [ElGamalKey](#elgamalkey-type) type for a complete list of fields.

# [ElGamal](#elgamal-class).UseHex Property

Whether input or output is hex encoded.

## Syntax

```text
isUseHex(): boolean;
setUseHex(useHex: boolean): void;
```

## Default Value

FALSE

## Remarks

This property specifies whether the encrypted data is hex encoded.

If set to True, when [Encrypt](#elgamalencrypt-method) is called the class will perform the encryption as normal and then hex encode the output. [OutputMessage](#elgamaloutputmessage-property) or [OutputFile](#elgamaloutputfile-property) will hold hex encoded data.

If set to True, when [Decrypt](#elgamaldecrypt-method) is called the class will expect [InputMessage](#elgamalinputmessage-property) or [InputFile](#elgamalinputfile-property) to hold hex encoded data. The class will then hex decode the data and perform decryption as normal.

# [ElGamal](#elgamal-class).config Method

Sets or retrieves a configuration setting.

## Syntax

```text
async elgamal.config(configurationString : string): Promise< string>
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-class-ipworksencryptelgamal) 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](#config-settings-class-ipworksencryptelgamal), you must call *Config("PROPERTY")*. The value will be returned as a string.

# [ElGamal](#elgamal-class).createKey Method

Creates a new key.

## Syntax

```text
async elgamal.createKey(): Promise< void>
```

## Remarks

This method creates a new public and private key.

When calling CreateKey the [Key](#elgamalkey-property) property is 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:

- KeyP
- KeyG
- KeyY

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:

- KeyP
- KeyG
- KeyY
- KeyX

 The class also includes the KeyPrivateKey property which holds the PEM formatted private key for ease of use. This is helpful for storing the private key more easily.

# [ElGamal](#elgamal-class).decrypt Method

Decrypts the input data using the specified private key.

## Syntax

```text
async elgamal.decrypt(): Promise< void>
```

## Remarks

This method decrypts the input data using the private key specified in [Key](#elgamalkey-property). 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:

- [InputFile](#elgamalinputfile-property)
- [InputMessage](#elgamalinputmessage-property)

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

- [OutputFile](#elgamaloutputfile-property)
- [OutputMessage](#elgamaloutputmessage-property): The output data is written to this property if no other destination is specified.

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

# [ElGamal](#elgamal-class).encrypt Method

Encrypts the input data using the recipient's public key.

## Syntax

```text
async elgamal.encrypt(): Promise< void>
```

## Remarks

This method encrypts the input data using the public key specified in [RecipientKey](#elgamalrecipientkey-property). 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:

- [InputFile](#elgamalinputfile-property)
- [InputMessage](#elgamalinputmessage-property)

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

- [OutputFile](#elgamaloutputfile-property)
- [OutputMessage](#elgamaloutputmessage-property): The output data is written to this property if no other destination is specified.

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

# [ElGamal](#elgamal-class).reset Method

Resets the class.

## Syntax

```text
async elgamal.reset(): Promise< void>
```

## Remarks

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

# [ElGamal](#elgamal-class).setInputStream Method

Sets the stream from which the class will read data to encrypt or decrypt.

## Syntax

```text
async elgamal.setInputStream(inputStream : ReadableStream): Promise< void>
```

## 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:

- [InputFile](#elgamalinputfile-property)
- [InputMessage](#elgamalinputmessage-property)

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

- [OutputFile](#elgamaloutputfile-property)
- [OutputMessage](#elgamaloutputmessage-property): The output data is written to this property if no other destination is specified.

# [ElGamal](#elgamal-class).Error Event

Fired when information is available about errors during data delivery.

## Syntax

```text
elgamal.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void )
```

## Remarks

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

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](#trappable-errors-class-ipworksencryptelgamal) section.

# ElGamalKey Type

Contains the typical parameters for the ElGamal algorithm.

## Remarks

This type is made up of fields that represent the private and public key parameters used by the ElGamal algorithm.

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

The public key consists of the following parameters:

- KeyP
- KeyG
- KeyY

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:

- KeyP
- KeyG
- KeyY
- KeyX

 The class also includes the 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 fields are available:

- [G](#ElGamalKey_f_G)

- [P](#ElGamalKey_f_P)

- [PrivateKey](#ElGamalKey_f_PrivateKey)

- [PublicKey](#ElGamalKey_f_PublicKey)

- [X](#ElGamalKey_f_X)

- [Y](#ElGamalKey_f_Y)

## Fields

 **G** *string*
*Default Value: ""*

Represents the G parameter for the ElGamal algorithm.

 **GB** *Uint8Array*
*Default Value: ""*

Represents the G parameter for the ElGamal algorithm.

 **P** *string*
*Default Value: ""*

Represents the P parameter for the ElGamal algorithm.

 **PB** *Uint8Array*
*Default Value: ""*

Represents the P parameter for the ElGamal algorithm.

 **PrivateKey** *string*
*Default Value: ""*

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.

 **PublicKey** *string*
*Default Value: ""*

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.

 **X** *string*
*Default Value: ""*

Represents the X parameter for the ElGamal algorithm.

 **XB** *Uint8Array*
*Default Value: ""*

Represents the X parameter for the ElGamal algorithm.

 **Y** *string*
*Default Value: ""*

Represents the Y parameter for the ElGamal algorithm.

 **YB** *Uint8Array*
*Default Value: ""*

Represents the Y parameter for the ElGamal algorithm.

## Constructors

```text
public ElGamalKey();
```

 The default constructor creates a new ElGamalKey instance but does not assign a public or private key.

```text
public ElGamalKey(byte[] P, byte[] G, byte[] Y);
```

 The public key constructor assigns an existing public key.

```text
public ElGamalKey(byte[] P, byte[] G, byte[] Y, byte[] X);
```

 The private key constructor assigns an existing private key.

# ReadableStream Type

## Syntax

```text
interface ReadableStream {
  read(buffer: Uint8Array, offset: number, length: number): Promise<number>;
  readSync(buffer: Uint8Array, offset: number, length: number): number;
  available(): number;
  close(): void;
  mark():void;
  reset():void;
  markSupported():boolean;
}
```

## Remarks

 The ElGamal class includes one or more API methods that accept a stream object as a parameter. To use such API members, create a custom object that implements the ReadableStream interface, and pass an instance of this object to the ElGamal class.

 When implementing the ReadableStream interface's properties and methods, they must behave as described below. If the implementation does not behave as expected, undefined behavior may occur.

```text
read(buffer: Uint8Array, offset: number, length: number): Promise <number> { }
```

```text
readSync(buffer: Uint8Array, offset: number, length: number): number { }
```

```text
available(): number { }
```

```text
close(): void { }
```

```text
mark(): void { }
```

```text
reset(): void { }
```

```text
markSupported(): boolean { }
```

|  |  |
| --- | --- |
| Methods |  |
| The following parameters are supported | buffer: The buffer to store the read data. <br> offset: The starting position within the buffer to write data.<br> length: The maximum number of bytes to read.<br> |
| read | Reads data from the stream into the provided buffer. This method must be implemented.<br> Returns a promise resolving to the number of bytes read, -1 if no data is available. |
| readSync | Synchronously reads data from the stream into the buffer. Returns the number of bytes read, -1 if no data is available. |
| available | Returns the number of bytes available for reading. This method must be implemented.<br> |
| close | Closes the stream and releases associated resources. |
| mark | Marks the current position in this stream. |
| reset | Repositions this stream to the position at the time the mark method was last called. |
| markSupported | Tests if this stream supports the mark and reset methods. Returns true if this stream supports the mark and reset methods; false otherwise. |

# WriteableStream Type

## Syntax

```text
interface WriteableStream {
  write(data: Uint8Array, offset: number, length: number): Promise<void>;
  writeSync(data: Uint8Array, offset: number, length: number): void;
  close(): void;
}
```

## Remarks

 The ElGamal class includes one or more API methods that accept a stream object as a parameter. To use such API members, create a custom object that implements the WriteableStream interface, and pass an instance of this object to the ElGamal class.

 When implementing the WriteableStream interface's properties and methods, they must behave as described below. If the implementation does not behave as expected, undefined behavior may occur.

```text
write(data: Uint8Array, offset: number, length: number): Promise <void> { }
```

```text
writeSync(data: Uint8Array, offset: number, length: number): void { }
```

```text
close(): void { }
```

|  |  |
| --- | --- |
| Methods |  |
| The following parameters are supported | data: The buffer containing the data to write.<br> offset: The starting position in the buffer to read data from.<br> length: The maximum number of bytes to write.<br> |
| write | Asynchronously writes data from the provided buffer to the stream. This method must be implemented.<br> Returns a promise that resolves when the write operation completes. |
| writeSync | Synchronously writes data from the buffer to the stream. |
| close | Closes the stream and releases associated resources. |

# Config Settings (*class *ipworksencrypt.[elgamal](#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](#elgamalconfig-method) method.

### ElGamal Config Settings

**KeySize**: The size, in bits, of the secret key.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

**BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build.

**CodePage**: The system code page used for Unicode to Multibyte translations.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 |

 The following is a list of valid code page identifiers for Mac OS only:

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

**LicenseInfo**: Information about the current license.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.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.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*.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. 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.

 This setting is set to *false* by default on all platforms.

# Trappable Errors (*class *ipworksencrypt.[elgamal](#elgamal-class))

### 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. |