# 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

**ipworksencrypt.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](#mldsacontext-property) | The ML-DSA context string. |
| [HashAlgorithm](#mldsahashalgorithm-property) | The hash algorithm used when PreHash is enabled. |
| [InputFile](#mldsainputfile-property) | The file to process. |
| [InputMessage](#mldsainputmessage-property) | The message to process. |
| [Key](#mldsakey-property) | The ML-DSA key. |
| [PreHash](#mldsaprehash-property) | Whether to use HashML-DSA when signing and verifying. |
| [Signature](#mldsasignature-property) | The signature. |
| [UseHex](#mldsausehex-property) | 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](#mldsaconfig-method) | Sets or retrieves a configuration setting. |
| [CreateKey](#mldsacreatekey-method) | Creates a new key. |
| [Reset](#mldsareset-method) | Resets the class. |
| [SetInputStream](#mldsasetinputstream-method) | Sets the stream from which the class will read data to encrypt or decrypt. |
| [Sign](#mldsasign-method) | Creates a signature. |
| [Verify](#mldsaverify-method) | 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](#mldsaerror-event) | Fired when information is available about errors during data delivery. |
| [Progress](#mldsaprogress-event) | 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. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

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

The ML-DSA context string.

## Syntax

```text
getContext(): Uint8Array;
setContext(context: Uint8Array): void;
```

## 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](#mldsasign-method) and [Verify](#mldsaverify-method).

The maximum length is 255 bytes.

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

The hash algorithm used when PreHash is enabled.

## Syntax

```text
getHashAlgorithm(): MLDSAHashAlgorithms;
setHashAlgorithm(hashAlgorithm: MLDSAHashAlgorithms): void;
enum MLDSAHashAlgorithms {
  mhaSHA256,
  mhaSHA384,
  mhaSHA512
}
```

## Default Value

0

## Remarks

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

Possible values are:

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

# [MLDSA](#mldsa-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](#mldsainputmessage-property)

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

- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.

# [MLDSA](#mldsa-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](#mldsainputfile-property)
- InputMessage

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

- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.

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

The ML-DSA key.

## Syntax

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

## Default Value

## Remarks

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

The private key is required before calling [Sign](#mldsasign-method), and the public key is required before calling [Verify](#mldsaverify-method).

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

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

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

Whether to use HashML-DSA when signing and verifying.

## Syntax

```text
isPreHash(): boolean;
setPreHash(preHash: boolean): void;
```

## 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](#mldsahashalgorithm-property) before signing or verifying. This supports a single pass over input data from [InputFile](#mldsainputfile-property) or .

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

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

The signature.

## Syntax

```text
getSignature(): Uint8Array;
setSignature(signature: Uint8Array): void;
```

## Default Value

""

## Remarks

This property holds the ML-DSA signature.

It is populated by [Sign](#mldsasign-method) and must be set before calling [Verify](#mldsaverify-method).

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

Whether the signature is hex encoded.

## Syntax

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

## Default Value

FALSE

## Remarks

This property specifies whether [Signature](#mldsasignature-property) is hex encoded.

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

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

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

Input data from [InputMessage](#mldsainputmessage-property), [InputFile](#mldsainputfile-property), or [SetInputStream](#mldsasetinputstream-method) is always processed as provided.

# [MLDSA](#mldsa-class).config Method

Sets or retrieves a configuration setting.

## Syntax

```text
async mldsa.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-ipworksencryptmldsa) 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-ipworksencryptmldsa), you must call *Config("PROPERTY")*. The value will be returned as a string.

# [MLDSA](#mldsa-class).createKey Method

Creates a new key.

## Syntax

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

## Remarks

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

# [MLDSA](#mldsa-class).reset Method

Resets the class.

## Syntax

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

## Remarks

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

# [MLDSA](#mldsa-class).setInputStream Method

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

## Syntax

```text
async mldsa.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](#mldsainputfile-property)
- [InputMessage](#mldsainputmessage-property)

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

- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.

# [MLDSA](#mldsa-class).sign Method

Creates a signature.

## Syntax

```text
async mldsa.sign(): Promise< void>
```

## Remarks

This method signs the data specified by [InputFile](#mldsainputfile-property) or [InputMessage](#mldsainputmessage-property) using the private key in [Key](#mldsakey-property) and populates [Signature](#mldsasignature-property).

# [MLDSA](#mldsa-class).verify Method

Verifies a signature.

## Syntax

```text
async mldsa.verify(): Promise< boolean>
```

## Remarks

This method verifies [Signature](#mldsasignature-property) for the data specified by [InputFile](#mldsainputfile-property) or [InputMessage](#mldsainputmessage-property) using the public key in [Key](#mldsakey-property). The result is returned.

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

Fired when information is available about errors during data delivery.

## Syntax

```text
mldsa.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-ipworksencryptmldsa) section.

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

Fired as progress is made.

## Syntax

```text
mldsa.on('Progress', listener: (e: {readonly bytesProcessed: number, readonly percentProcessed: number}) => void )
```

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

## 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** *string*
*Default Value: ""*

The raw ML-DSA private key.

 **PrivateKeyB** *Uint8Array*
*Default Value: ""*

The raw ML-DSA private key.

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

The raw ML-DSA public key.

 **PublicKeyB** *Uint8Array*
*Default Value: ""*

The raw ML-DSA public key.

## Constructors

```text
public MLDSAKey();
```

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

```text
public MLDSAKey(byte[] publicKey);
```

 The public key constructor assigns an existing public key.

```text
public MLDSAKey(byte[] publicKey, byte[] privateKey);
```

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

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

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