# Struct ipworksencrypt::ElGamal

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

## Syntax

```text
ipworksencrypt::ElGamal
```

## Remarks

The ElGamal struct 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 [create_key](#create_key-method-elgamal-struct).

After specifying a key, specify the data you wish to encrypt or decrypt. Call the [encrypt](#encrypt-method-elgamal-struct) or [decrypt](#decrypt-method-elgamal-struct) method to perform the operation.

**Input and Output Properties**

The struct 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:

- [input_file](#input_file-property-elgamal-struct)
- [input_message](#input_message-property-elgamal-struct)

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

- [output_file](#output_file-property-elgamal-struct)
- [output_message](#output_message-property-elgamal-struct): 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:

- [key_p](#key_p-property-elgamal-struct)
- [key_g](#key_g-property-elgamal-struct)
- [key_y](#key_y-property-elgamal-struct)

The struct also includes the [key_public_key](#key_public_key-property-elgamal-struct) 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 [key_public_key](#key_public_key-property-elgamal-struct), in which case the individual parameters must be sent.

The private key consists of the following parameters:

- [key_p](#key_p-property-elgamal-struct)
- [key_g](#key_g-property-elgamal-struct)
- [key_y](#key_y-property-elgamal-struct)
- [key_x](#key_x-property-elgamal-struct)

 The struct also includes the [key_private_key](#key_private_key-property-elgamal-struct) property which holds the PEM formatted private key for ease of use. This is helpful for storing the private key more easily.

### Object Lifetime

 The *new()* method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksEncrypt. Due to this, the ElGamal struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of ElGamal when you have finished using the instance.

## Property List

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

|  |  |
| --- | --- |
| [input_file](#input_file-property-elgamal-struct) | The file to process. |
| [input_message](#input_message-property-elgamal-struct) | The message to process. |
| [key_g](#key_g-property-elgamal-struct) | Represents the G parameter for the ElGamal algorithm. |
| [key_p](#key_p-property-elgamal-struct) | Represents the P parameter for the ElGamal algorithm. |
| [key_private_key](#key_private_key-property-elgamal-struct) | This property is a PEM formatted private key. |
| [key_public_key](#key_public_key-property-elgamal-struct) | This property is a PEM formatted public key. |
| [key_x](#key_x-property-elgamal-struct) | Represents the X parameter for the ElGamal algorithm. |
| [key_y](#key_y-property-elgamal-struct) | Represents the Y parameter for the ElGamal algorithm. |
| [output_file](#output_file-property-elgamal-struct) | The output file when encrypting or decrypting. |
| [output_message](#output_message-property-elgamal-struct) | The output message after processing. |
| [overwrite](#overwrite-property-elgamal-struct) | Indicates whether or not the struct should overwrite files. |
| [recipient_key_g](#recipient_key_g-property-elgamal-struct) | Represents the G parameter for the ElGamal algorithm. |
| [recipient_key_p](#recipient_key_p-property-elgamal-struct) | Represents the P parameter for the ElGamal algorithm. |
| [recipient_key_public_key](#recipient_key_public_key-property-elgamal-struct) | This property is a PEM formatted public key. |
| [recipient_key_y](#recipient_key_y-property-elgamal-struct) | Represents the Y parameter for the ElGamal algorithm. |
| [use_hex](#use_hex-property-elgamal-struct) | Whether input or output is hex encoded. |

## Method List

*The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [config](#config-method-elgamal-struct) | Sets or retrieves a configuration setting. |
| [create_key](#create_key-method-elgamal-struct) | Creates a new key. |
| [decrypt](#decrypt-method-elgamal-struct) | Decrypts the input data using the specified private key. |
| [encrypt](#encrypt-method-elgamal-struct) | Encrypts the input data using the recipient's public key. |
| [reset](#reset-method-elgamal-struct) | Resets the struct. |

## Event List

*The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [on_error](#on_error-event-elgamal-struct) | Fired when information is available about errors during data delivery. |

## Config Settings

*The following is a list of config settings for the struct 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. |

# input_file property ([ElGamal](#struct-ipworksencryptelgamal) Struct)

The file to process.

## Syntax

*Rust Syntax*

```text
fn input_file(&self ) -> Result<String, IPWorksEncryptError> fn set_input_file(&self, value : &str) ->  Option<IPWorksEncryptError>
fn set_input_file_ref(&self, value : &String) ->  Option<IPWorksEncryptError>
```

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

- input_file
- [input_message](#input_message-property-elgamal-struct)

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

- [output_file](#output_file-property-elgamal-struct)
- [output_message](#output_message-property-elgamal-struct): The output data is written to this property if no other destination is specified.

## Data Type

String

# input_message property ([ElGamal](#struct-ipworksencryptelgamal) Struct)

The message to process.

## Syntax

*Rust Syntax*

```text
fn input_message(&self ) -> Result<Vec<u8>, IPWorksEncryptError> fn set_input_message(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError>
fn set_input_message_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError>
```

## Default Value

""

## Remarks

This property specifies the message to be processed.

**Input and Output Properties**

The struct 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:

- [input_file](#input_file-property-elgamal-struct)
- input_message

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

- [output_file](#output_file-property-elgamal-struct)
- [output_message](#output_message-property-elgamal-struct): The output data is written to this property if no other destination is specified.

## Data Type

Vec

# key_g property ([ElGamal](#struct-ipworksencryptelgamal) Struct)

Represents the G parameter for the ElGamal algorithm.

## Syntax

*Rust Syntax*

```text
fn key_g(&self ) -> Result<Vec<u8>, IPWorksEncryptError> fn set_key_g(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError>
fn set_key_g_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError>
```

## Default Value

""

## Remarks

Represents the G parameter for the ElGamal algorithm.

## Data Type

Vec

# key_p property ([ElGamal](#struct-ipworksencryptelgamal) Struct)

Represents the P parameter for the ElGamal algorithm.

## Syntax

*Rust Syntax*

```text
fn key_p(&self ) -> Result<Vec<u8>, IPWorksEncryptError> fn set_key_p(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError>
fn set_key_p_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError>
```

## Default Value

""

## Remarks

Represents the P parameter for the ElGamal algorithm.

## Data Type

Vec

# key_private_key property ([ElGamal](#struct-ipworksencryptelgamal) Struct)

This property is a PEM formatted private key.

## Syntax

*Rust Syntax*

```text
fn key_private_key(&self ) -> Result<String, IPWorksEncryptError> fn set_key_private_key(&self, value : &str) ->  Option<IPWorksEncryptError>
fn set_key_private_key_ref(&self, value : &String) ->  Option<IPWorksEncryptError>
```

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

# key_public_key property ([ElGamal](#struct-ipworksencryptelgamal) Struct)

This property is a PEM formatted public key.

## Syntax

*Rust Syntax*

```text
fn key_public_key(&self ) -> Result<String, IPWorksEncryptError> fn set_key_public_key(&self, value : &str) ->  Option<IPWorksEncryptError>
fn set_key_public_key_ref(&self, value : &String) ->  Option<IPWorksEncryptError>
```

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

# key_x property ([ElGamal](#struct-ipworksencryptelgamal) Struct)

Represents the X parameter for the ElGamal algorithm.

## Syntax

*Rust Syntax*

```text
fn key_x(&self ) -> Result<Vec<u8>, IPWorksEncryptError> fn set_key_x(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError>
fn set_key_x_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError>
```

## Default Value

""

## Remarks

Represents the X parameter for the ElGamal algorithm.

## Data Type

Vec

# key_y property ([ElGamal](#struct-ipworksencryptelgamal) Struct)

Represents the Y parameter for the ElGamal algorithm.

## Syntax

*Rust Syntax*

```text
fn key_y(&self ) -> Result<Vec<u8>, IPWorksEncryptError> fn set_key_y(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError>
fn set_key_y_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError>
```

## Default Value

""

## Remarks

Represents the Y parameter for the ElGamal algorithm.

## Data Type

Vec

# output_file property ([ElGamal](#struct-ipworksencryptelgamal) Struct)

The output file when encrypting or decrypting.

## Syntax

*Rust Syntax*

```text
fn output_file(&self ) -> Result<String, IPWorksEncryptError> fn set_output_file(&self, value : &str) ->  Option<IPWorksEncryptError>
fn set_output_file_ref(&self, value : &String) ->  Option<IPWorksEncryptError>
```

## Default Value

""

## Remarks

This property specifies the file to which the output will be written when [encrypt](#encrypt-method-elgamal-struct) or [decrypt](#decrypt-method-elgamal-struct) is called. This may be set to an absolute or relative path.

This property is only applicable to [encrypt](#encrypt-method-elgamal-struct) and [decrypt](#decrypt-method-elgamal-struct).

**Input and Output Properties**

The struct 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:

- [input_file](#input_file-property-elgamal-struct)
- [input_message](#input_message-property-elgamal-struct)

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

- output_file
- [output_message](#output_message-property-elgamal-struct): The output data is written to this property if no other destination is specified.

## Data Type

String

# output_message property ([ElGamal](#struct-ipworksencryptelgamal) Struct)

The output message after processing.

## Syntax

*Rust Syntax*

```text
fn output_message(&self ) -> Result<Vec<u8>, IPWorksEncryptError>
```

## Default Value

""

## Remarks

This property will be populated with the output from the operation if [output_file](#output_file-property-elgamal-struct) is not set.

**Input and Output Properties**

The struct 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:

- [input_file](#input_file-property-elgamal-struct)
- [input_message](#input_message-property-elgamal-struct)

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

- [output_file](#output_file-property-elgamal-struct)
- output_message: The output data is written to this property if no other destination is specified.

This property is read-only.

## Data Type

Vec

# overwrite property ([ElGamal](#struct-ipworksencryptelgamal) Struct)

Indicates whether or not the struct should overwrite files.

## Syntax

*Rust Syntax*

```text
fn overwrite(&self ) -> Result<bool, IPWorksEncryptError> fn set_overwrite(&self, value : bool) ->  Option<IPWorksEncryptError>
```

## Default Value

false

## Remarks

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

## Data Type

bool

# recipient_key_g property ([ElGamal](#struct-ipworksencryptelgamal) Struct)

Represents the G parameter for the ElGamal algorithm.

## Syntax

*Rust Syntax*

```text
fn recipient_key_g(&self ) -> Result<Vec<u8>, IPWorksEncryptError> fn set_recipient_key_g(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError>
fn set_recipient_key_g_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError>
```

## Default Value

""

## Remarks

Represents the G parameter for the ElGamal algorithm.

## Data Type

Vec

# recipient_key_p property ([ElGamal](#struct-ipworksencryptelgamal) Struct)

Represents the P parameter for the ElGamal algorithm.

## Syntax

*Rust Syntax*

```text
fn recipient_key_p(&self ) -> Result<Vec<u8>, IPWorksEncryptError> fn set_recipient_key_p(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError>
fn set_recipient_key_p_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError>
```

## Default Value

""

## Remarks

Represents the P parameter for the ElGamal algorithm.

## Data Type

Vec

# recipient_key_public_key property ([ElGamal](#struct-ipworksencryptelgamal) Struct)

This property is a PEM formatted public key.

## Syntax

*Rust Syntax*

```text
fn recipient_key_public_key(&self ) -> Result<String, IPWorksEncryptError> fn set_recipient_key_public_key(&self, value : &str) ->  Option<IPWorksEncryptError>
fn set_recipient_key_public_key_ref(&self, value : &String) ->  Option<IPWorksEncryptError>
```

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

# recipient_key_y property ([ElGamal](#struct-ipworksencryptelgamal) Struct)

Represents the Y parameter for the ElGamal algorithm.

## Syntax

*Rust Syntax*

```text
fn recipient_key_y(&self ) -> Result<Vec<u8>, IPWorksEncryptError> fn set_recipient_key_y(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError>
fn set_recipient_key_y_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError>
```

## Default Value

""

## Remarks

Represents the Y parameter for the ElGamal algorithm.

## Data Type

Vec

# use_hex property ([ElGamal](#struct-ipworksencryptelgamal) Struct)

Whether input or output is hex encoded.

## Syntax

*Rust Syntax*

```text
fn use_hex(&self ) -> Result<bool, IPWorksEncryptError> fn set_use_hex(&self, value : bool) ->  Option<IPWorksEncryptError>
```

## Default Value

false

## Remarks

This property specifies whether the encrypted data is hex encoded.

If set to True, when [encrypt](#encrypt-method-elgamal-struct) is called the struct will perform the encryption as normal and then hex encode the output. [output_message](#output_message-property-elgamal-struct) or [output_file](#output_file-property-elgamal-struct) will hold hex encoded data.

If set to True, when [decrypt](#decrypt-method-elgamal-struct) is called the struct will expect [input_message](#input_message-property-elgamal-struct) or [input_file](#input_file-property-elgamal-struct) to hold hex encoded data. The struct will then hex decode the data and perform decryption as normal.

## Data Type

bool

# config method ([ElGamal](#struct-ipworksencryptelgamal) Struct)

Sets or retrieves a configuration setting.

## Syntax

*Rust Syntax*

```text
fn config(&self, configuration_string : &str) ->  Result<String, IPWorksEncryptError>
```

## Remarks

config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-elgamal-struct) for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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-elgamal-struct), you must call *Config("PROPERTY")*. The value will be returned as a string.

# create_key method ([ElGamal](#struct-ipworksencryptelgamal) Struct)

Creates a new key.

## Syntax

*Rust Syntax*

```text
fn create_key(&self) -> Result<(), IPWorksEncryptError>
```

## Remarks

This method creates a new public and private key.

When calling create_key the key 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:

- [key_p](#key_p-property-elgamal-struct)
- [key_g](#key_g-property-elgamal-struct)
- [key_y](#key_y-property-elgamal-struct)

The struct also includes the [key_public_key](#key_public_key-property-elgamal-struct) 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 [key_public_key](#key_public_key-property-elgamal-struct), in which case the individual parameters must be sent.

The private key consists of the following parameters:

- [key_p](#key_p-property-elgamal-struct)
- [key_g](#key_g-property-elgamal-struct)
- [key_y](#key_y-property-elgamal-struct)
- [key_x](#key_x-property-elgamal-struct)

 The struct also includes the [key_private_key](#key_private_key-property-elgamal-struct) property which holds the PEM formatted private key for ease of use. This is helpful for storing the private key more easily.

# decrypt method ([ElGamal](#struct-ipworksencryptelgamal) Struct)

Decrypts the input data using the specified private key.

## Syntax

*Rust Syntax*

```text
fn decrypt(&self) -> Result<(), IPWorksEncryptError>
```

## Remarks

This method decrypts the input data using the private key specified in key. Alternatively, a certificate may be specified by setting certificate.

**Input and Output Properties**

The struct 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:

- [input_file](#input_file-property-elgamal-struct)
- [input_message](#input_message-property-elgamal-struct)

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

- [output_file](#output_file-property-elgamal-struct)
- [output_message](#output_message-property-elgamal-struct): 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 |

# encrypt method ([ElGamal](#struct-ipworksencryptelgamal) Struct)

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

## Syntax

*Rust Syntax*

```text
fn encrypt(&self) -> Result<(), IPWorksEncryptError>
```

## Remarks

This method encrypts the input data using the public key specified in recipient_key. Alternatively, a certificate may be specified by setting recipient_cert.

**Input and Output Properties**

The struct 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:

- [input_file](#input_file-property-elgamal-struct)
- [input_message](#input_message-property-elgamal-struct)

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

- [output_file](#output_file-property-elgamal-struct)
- [output_message](#output_message-property-elgamal-struct): 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 |

# reset method ([ElGamal](#struct-ipworksencryptelgamal) Struct)

Resets the struct.

## Syntax

*Rust Syntax*

```text
fn reset(&self) -> Result<(), IPWorksEncryptError>
```

## Remarks

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

# on_error event ([ElGamal](#struct-ipworksencryptelgamal) Struct)

Fired when information is available about errors during data delivery.

## Syntax

*Rust Syntax*

```text
// ElGamalErrorEventArgs carries the ElGamal Error event's parameters.
pub struct ElGamalErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// ElGamalErrorEvent defines the signature of the ElGamal Error event's handler function.
pub trait ElGamalErrorEvent {
  fn on_error(&self, sender : ElGamal, e : &mut ElGamalErrorEventArgs);
}

impl <'a> ElGamal<'a> {
  pub fn on_error(&self) -> &'a dyn ElGamalErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn ElGamalErrorEvent);
  ...
}
```

## Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error.

The *error_code* 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-elgamal-struct) section.

# Config Settings ([ElGamal](#struct-ipworksencryptelgamal) Struct)

 The struct 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 struct, access to these *internal properties* is provided through the [config](#config-method-elgamal-struct) 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 struct 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 struct will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the struct 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](platforms.md) section.

# Trappable Errors ([ElGamal](#struct-ipworksencryptelgamal) Struct)

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