# MLDSA Class

The MLDSA class can be used to create and verify digital signatures using Module-Lattice-Based Digital Signature Algorithm (ML-DSA) cryptography.

## Syntax

```text
MLDSA
```

## Remarks

The MLDSA component can be used to create and verify digital signatures using Module-Lattice-Based Digital Signature Algorithm (ML-DSA) cryptography. Includes support for ML-DSA-44, ML-DSA-65, and ML-DSA-87 parameter sets.

Note that by default the component uses ML-DSA-44. You may specify the parameter set by setting [ParamSet](#ParamSet).

## Property List

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

|  |  |
| --- | --- |
| [Context](#context-property-mldsa-class) | The ML-DSA context string. |
| [HashAlgorithm](#hashalgorithm-property-mldsa-class) | The hash algorithm used when PreHash is enabled. |
| [InputFile](#inputfile-property-mldsa-class) | The file to process. |
| [InputMessage](#inputmessage-property-mldsa-class) | The message to process. |
| [Key](#key-property-mldsa-class) | The ML-DSA key. |
| [PreHash](#prehash-property-mldsa-class) | Whether to use HashML-DSA when signing and verifying. |
| [Signature](#signature-property-mldsa-class) | The signature. |
| [UseHex](#usehex-property-mldsa-class) | Whether the signature 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](#config-method-mldsa-class) | Sets or retrieves a configuration setting. |
| [CreateKey](#createkey-method-mldsa-class) | Creates a new key. |
| [Reset](#reset-method-mldsa-class) | Resets the class. |
| [SetInputStream](#setinputstream-method-mldsa-class) | Sets the stream from which the class will read data to encrypt or decrypt. |
| [Sign](#sign-method-mldsa-class) | Creates a signature. |
| [Verify](#verify-method-mldsa-class) | Verifies a signature. |

## 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](#error-event-mldsa-class) | Fired when information is available about errors during data delivery. |
| [Progress](#progress-event-mldsa-class) | Fired as progress is made. |

## Config Settings

*The following is a list of config settings for the class with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [ParamSet](#ParamSet) | The ML-DSA parameter set. |
| [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. |
| [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. |
| [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the class whether or not to use FIPS certified APIs. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# Context Property ([MLDSA](#mldsa-class) Class)

The ML-DSA context string.

## Syntax

```text
ANSI (Cross Platform)
int GetContext(char* &lpContext, int &lenContext);int SetContext(const char* lpContext, int lenContext);

Unicode (Windows)
INT GetContext(LPSTR &lpContext, INT &lenContext);INT SetContext(LPCSTR lpContext, INT lenContext);
```

## Default Value

""

## Remarks

This property specifies the optional ML-DSA context used when signing and verifying. This property may be empty. The default value is empty.

The same value must be specified when calling [Sign](#sign-method-mldsa-class) and [Verify](#verify-method-mldsa-class).

The maximum length is 255 bytes.

## Data Type

Binary String

# HashAlgorithm Property ([MLDSA](#mldsa-class) Class)

The hash algorithm used when PreHash is enabled.

## Syntax

```text
ANSI (Cross Platform)
int GetHashAlgorithm();int SetHashAlgorithm(int iHashAlgorithm);

Unicode (Windows)
INT GetHashAlgorithm();INT SetHashAlgorithm(INT iHashAlgorithm);
```

## Possible Values

```text
MHA_SHA256(0), MHA_SHA384(1), MHA_SHA512(2)
```

## Default Value

0

## Remarks

This property specifies the hash algorithm used to pre-hash input data when [PreHash](#prehash-property-mldsa-class) is set to *True*.

Possible values are:

- 0 (mhaSHA256 - default): SHA-256
- 1 (mhaSHA384): SHA-384
- 2 (mhaSHA512): SHA-512

## Data Type

Integer

# InputFile Property ([MLDSA](#mldsa-class) Class)

The file to process.

## Syntax

```text
ANSI (Cross Platform)
char* GetInputFile();int SetInputFile(const char* lpszInputFile);

Unicode (Windows)
LPWSTR GetInputFile();INT SetInputFile(LPCWSTR lpszInputFile);
```

## 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](#setinputstream-method-mldsa-class)
- InputFile
- [InputMessage](#inputmessage-property-mldsa-class)

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](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing).

## Data Type

String

# InputMessage Property ([MLDSA](#mldsa-class) Class)

The message to process.

## Syntax

```text
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);
```

## 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](#setinputstream-method-mldsa-class)
- [InputFile](#inputfile-property-mldsa-class)
- 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](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing).

## Data Type

Binary String

# Key Property ([MLDSA](#mldsa-class) Class)

The ML-DSA key.

## Syntax

```text
IPWorksEncryptMLDSAKey* GetKey();
int SetKey(IPWorksEncryptMLDSAKey* val);
```

## Remarks

This property specifies the ML-DSA public or private key.

The private key is required before calling [Sign](#sign-method-mldsa-class), and the public key is required before calling [Verify](#verify-method-mldsa-class).

ML-DSA keys are made up of raw private key and public key fields.

## Data Type

[IPWorksEncryptMLDSAKey](#mldsakey-type)

# PreHash Property ([MLDSA](#mldsa-class) Class)

Whether to use HashML-DSA when signing and verifying.

## Syntax

```text
ANSI (Cross Platform)
int GetPreHash();int SetPreHash(int bPreHash);

Unicode (Windows)
BOOL GetPreHash();INT SetPreHash(BOOL bPreHash);
```

## Default Value

FALSE

## Remarks

This property specifies whether the component uses HashML-DSA when signing and verifying.

If set to *True*, the input is pre-hashed using [HashAlgorithm](#hashalgorithm-property-mldsa-class) before signing or verifying. This supports a single pass over input data from [InputFile](#inputfile-property-mldsa-class) or .

If set to *False* (default), pure ML-DSA is used.

## Data Type

Boolean

# Signature Property ([MLDSA](#mldsa-class) Class)

The signature.

## Syntax

```text
ANSI (Cross Platform)
int GetSignature(char* &lpSignature, int &lenSignature);int SetSignature(const char* lpSignature, int lenSignature);

Unicode (Windows)
INT GetSignature(LPSTR &lpSignature, INT &lenSignature);INT SetSignature(LPCSTR lpSignature, INT lenSignature);
```

## Default Value

""

## Remarks

This property holds the ML-DSA signature.

It is populated by [Sign](#sign-method-mldsa-class) and must be set before calling [Verify](#verify-method-mldsa-class).

## Data Type

Binary String

# UseHex Property ([MLDSA](#mldsa-class) Class)

Whether the signature is hex encoded.

## Syntax

```text
ANSI (Cross Platform)
int GetUseHex();int SetUseHex(int bUseHex);

Unicode (Windows)
BOOL GetUseHex();INT SetUseHex(BOOL bUseHex);
```

## Default Value

FALSE

## Remarks

This property specifies whether [Signature](#signature-property-mldsa-class) is hex encoded.

If set to *False* (default), the signature is provided as-is with no encoding.

When [Sign](#sign-method-mldsa-class) is called and this property is set to *True*, [Signature](#signature-property-mldsa-class) is hex encoded when populated.

When [Verify](#verify-method-mldsa-class) is called and this property is set to *True*, [Signature](#signature-property-mldsa-class) is treated as hex encoded.

Input data from [InputMessage](#inputmessage-property-mldsa-class), [InputFile](#inputfile-property-mldsa-class), or [SetInputStream](#setinputstream-method-mldsa-class) is always processed as provided.

## Data Type

Boolean

# Config Method ([MLDSA](#mldsa-class) Class)

Sets or retrieves a configuration setting.

## Syntax

```text
ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-mldsa-class) 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-mldsa-class), 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 ([MLDSA](#mldsa-class) Class)

Creates a new key.

## Syntax

```text
ANSI (Cross Platform)
int CreateKey();

Unicode (Windows)
INT CreateKey();
```

## Remarks

CreateKey creates a new ML-DSA public and private key pair.

## 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 ([MLDSA](#mldsa-class) Class)

Resets the class.

## Syntax

```text
ANSI (Cross Platform)
int Reset();

Unicode (Windows)
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 ([MLDSA](#mldsa-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int SetInputStream(IPWorksEncryptStream* sInputStream);

Unicode (Windows)
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](#inputfile-property-mldsa-class)
- [InputMessage](#inputmessage-property-mldsa-class)

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](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#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.)

# Sign Method ([MLDSA](#mldsa-class) Class)

Creates a signature.

## Syntax

```text
ANSI (Cross Platform)
int Sign();

Unicode (Windows)
INT Sign();
```

## Remarks

This method signs the data specified by [InputFile](#inputfile-property-mldsa-class) or [InputMessage](#inputmessage-property-mldsa-class) using the private key in [Key](#key-property-mldsa-class) and populates [Signature](#signature-property-mldsa-class).

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

# Verify Method ([MLDSA](#mldsa-class) Class)

Verifies a signature.

## Syntax

```text
ANSI (Cross Platform)
bool Verify();

Unicode (Windows)
bool Verify();
```

## Remarks

This method verifies [Signature](#signature-property-mldsa-class) for the data specified by [InputFile](#inputfile-property-mldsa-class) or [InputMessage](#inputmessage-property-mldsa-class) using the public key in [Key](#key-property-mldsa-class). The result is returned.

## Error Handling (C++)

This method returns a Boolean 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.

# Error Event ([MLDSA](#mldsa-class) Class)

Fired when information is available about errors during data delivery.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireError(MLDSAErrorEventParams *e);
typedef struct {  int ErrorCode;  const char *Description;
  int reserved;
} MLDSAErrorEventParams;

Unicode (Windows)
virtual INT FireError(MLDSAErrorEventParams *e);
typedef struct {  INT ErrorCode;  LPCWSTR Description;
  INT reserved;
} MLDSAErrorEventParams;
```

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

# Progress Event ([MLDSA](#mldsa-class) Class)

Fired as progress is made.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireProgress(MLDSAProgressEventParams *e);
typedef struct {  int64 BytesProcessed;  int PercentProcessed;
  int reserved;
} MLDSAProgressEventParams;

Unicode (Windows)
virtual INT FireProgress(MLDSAProgressEventParams *e);
typedef struct {  LONG64 BytesProcessed;  INT PercentProcessed;
  INT reserved;
} MLDSAProgressEventParams;
```

## Remarks

This event is fired automatically as data is processed by the class.

The *PercentProcessed* parameter indicates the current status of the operation.

The *BytesProcessed* parameter holds the total number of bytes processed so far.

# MLDSAKey Type

Contains a raw ML-DSA key.

## Syntax

 *IPWorksEncryptMLDSAKey* (declared in *ipworksencrypt.h*)

## Remarks

This type contains the raw public and private key values used by the MLDSA component.

The following fields are available:

- [PrivateKey](#MLDSAKey_f_PrivateKey)

- [PublicKey](#MLDSAKey_f_PublicKey)

## Fields

 **PrivateKey** *char**
*Default Value: ""*

The raw ML-DSA private key.

 **PublicKey** *char**
*Default Value: ""*

The raw ML-DSA public key.

## Constructors

```text
MLDSAKey()
```

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

```text
MLDSAKey(const char* lpPublicKey, int lenPublicKey)
```

 The public key constructor assigns an existing public key.

```text
MLDSAKey(const char* lpPublicKey, int lenPublicKey, const char* lpPrivateKey, int lenPrivateKey)
```

 The private key constructor assigns an existing private key.

# IPWorksEncryptStream Type

## Syntax

 *IPWorksEncryptStream* (declared in *ipworksencrypt.h*)

## Remarks

 The MLDSA 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 MLDSA 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.

```text
bool CanRead() { return true; }
```

```text
bool CanSeek() { return true; }
```

```text
bool CanWrite() { return true; }
```

```text
int64 GetLength() = 0;
```

```text
void Close() {}
```

```text
int Flush() { return 0; }
```

```text
int Read(void* buffer, int count) = 0;
```

```text
int64 Seek(int64 offset, int seekOrigin) = 0;
```

```text
int Write(const void* buffer, int count) = 0;
```

|  |  |
| --- | --- |
| Properties |  |
| CanRead | Whether the stream supports reading. |
| CanSeek | Whether the stream supports seeking. |
| CanWrite | Whether the stream supports writing. |
| Length | Gets the length of the stream, in bytes. |
| Methods |  |
| Close | Closes the stream, releasing all resources currently allocated for it. This method is called automatically when an IPWorksEncryptStream object is deleted. |
| Flush | Forces all data held by the stream's buffers to be written out to storage. Must return 0 if flushing is successful; or -1 if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return 0. |
| Read | Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read. Buffer specifies the buffer to populate with data from the stream. Count specifies the number of bytes that should be read from the stream. Must return the total number of bytes read into Buffer; this may be less than Count if that many bytes are not currently available, or 0 if the end of the stream has been reached. Must return -1 if an error occurs, if reading is not supported, or if the stream is closed. |
| Seek | Sets the current position within the stream based on a particular point of origin. Offset specifies the offset in the stream to seek to, relative to SeekOrigin. Valid values for SeekOrigin are: 0: Seek from beginning. 1: Seek from current position. 2: Seek from end. Must return the new position within the stream; or -1 if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If -1 is returned, the current position within the stream must remain unchanged. Note: If the stream is not closed, it must always be possible to call this method with an Offset of 0 and a SeekOrigin of 1 to obtain the current position within the stream, even if seeking is not otherwise supported. |
| Write | Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written. Buffer specifies the buffer with data to write to the stream. Count specifies the number of bytes that should be written to the stream. Must return the total number of bytes written to the stream; this may be less than Count if that many bytes could not be written. Must return -1 if an error occurs, if writing is not supported, or if the stream is closed. |

# Config Settings ([MLDSA](#mldsa-class) 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](#config-method-mldsa-class) method.

### MLDSA Config Settings

**ParamSet**: The ML-DSA parameter set.This setting specifies the ML-DSA parameter set to use when creating keys. Possible values are:

- 44 (default)
- 65
- 87

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

**ProcessIdleEvents**: Whether the class uses its internal event loop to process events when the main thread is idle.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.

**SelectWaitMillis**: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.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.

**UseFIPSCompliantAPI**: Tells the class whether or not to use FIPS certified APIs.When set to *true*, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries.

On Linux, the C++ edition requires installation of the FIPS-enabled OpenSSL library. The OpenSSL FIPS provider version must be at least 3.0.0. For additional information and instructions regarding the installation and activation of the FIPS-enabled OpenSSL library, please refer to the following link: [https://github.com/openssl/openssl/blob/master/README-FIPS.md](https://github.com/openssl/openssl/blob/master/README-FIPS.md)

To ensure the class utilizes the FIPS-enabled OpenSSL library, the obfuscated source code should first be compiled with OpenSSL enabled, as described in the Supported Platforms section. Additionally, the FIPS module should be enabled and active. If the obfuscated source code is not compiled as mentioned, or the FIPS module is inactive, the class will throw an appropriate error assuming FIPS mode is enabled.

FIPS mode can be enabled by setting the *UseFIPSCompliantAPI* configuration setting to *true*. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details, please see the [FIPS 140-2 Compliance](https://www.nsoftware.com/kb/articles/fips.rst) article.

NOTE: This setting is applicable only on Windows.

NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details.

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

 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 ([MLDSA](#mldsa-class) 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.

### MLDSA Errors

|  |  |
| --- | --- |
| 102 | No Key specified. |
| 120 | Invalid parameter set. |
| 1701 | Specified ML-DSA key is invalid. |
| 1702 | Invalid parameter set. |
| 1703 | Public key must be specified. |
| 1704 | Private key must be specified. |
| 1705 | Input data must be specified. |
| 1706 | Signature must be specified. |
| 1707 | Signing failed. |
| 1708 | Verification failed. |
| 1709 | Invalid hash algorithm. |
| 1710 | Invalid context length. |