# Struct ipworksencrypt::MLDSA

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

## Syntax

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

### 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 MLDSA struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of MLDSA 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.*

|  |  |
| --- | --- |
| [context](#context-property-mldsa-struct) | The ML-DSA context string. |
| [hash_algorithm](#hash_algorithm-property-mldsa-struct) | The hash algorithm used when PreHash is enabled. |
| [input_file](#input_file-property-mldsa-struct) | The file to process. |
| [input_message](#input_message-property-mldsa-struct) | The message to process. |
| [key_private_key](#key_private_key-property-mldsa-struct) | The raw ML-DSA private key. |
| [key_public_key](#key_public_key-property-mldsa-struct) | The raw ML-DSA public key. |
| [pre_hash](#pre_hash-property-mldsa-struct) | Whether to use HashML-DSA when signing and verifying. |
| [signature](#signature-property-mldsa-struct) | The signature. |
| [use_hex](#use_hex-property-mldsa-struct) | Whether the signature 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-mldsa-struct) | Sets or retrieves a configuration setting. |
| [create_key](#create_key-method-mldsa-struct) | Creates a new key. |
| [reset](#reset-method-mldsa-struct) | Resets the struct. |
| [sign](#sign-method-mldsa-struct) | Creates a signature. |
| [verify](#verify-method-mldsa-struct) | Verifies a signature. |

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

## Config Settings

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

# context property ([MLDSA](#struct-ipworksencryptmldsa) Struct)

The ML-DSA context string.

## Syntax

*Rust Syntax*

```text
fn context(&self ) -> Result<Vec<u8>, IPWorksEncryptError> fn set_context(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError>
fn set_context_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError>
```

## 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-struct) and [verify](#verify-method-mldsa-struct).

The maximum length is 255 bytes.

## Data Type

Vec

# hash_algorithm property ([MLDSA](#struct-ipworksencryptmldsa) Struct)

The hash algorithm used when PreHash is enabled.

## Syntax

*Rust Syntax*

```text
fn hash_algorithm(&self ) -> Result<i32, IPWorksEncryptError> fn set_hash_algorithm(&self, value : i32) ->  Option<IPWorksEncryptError>
```

## Possible Values

```text
0   // SHA2561   // SHA3842   // SHA512
```

## Default Value

0

## Remarks

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

Possible values are:

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

## Data Type

i32

# input_file property ([MLDSA](#struct-ipworksencryptmldsa) 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-mldsa-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: The output data is written to this property if no other destination is specified.

## Data Type

String

# input_message property ([MLDSA](#struct-ipworksencryptmldsa) 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-mldsa-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_message: The output data is written to this property if no other destination is specified.

## Data Type

Vec

# key_private_key property ([MLDSA](#struct-ipworksencryptmldsa) Struct)

The raw ML-DSA private key.

## Syntax

*Rust Syntax*

```text
fn key_private_key(&self ) -> Result<Vec<u8>, IPWorksEncryptError> fn set_key_private_key(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError>
fn set_key_private_key_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError>
```

## Default Value

""

## Remarks

The raw ML-DSA private key.

## Data Type

Vec

# key_public_key property ([MLDSA](#struct-ipworksencryptmldsa) Struct)

The raw ML-DSA public key.

## Syntax

*Rust Syntax*

```text
fn key_public_key(&self ) -> Result<Vec<u8>, IPWorksEncryptError> fn set_key_public_key(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError>
fn set_key_public_key_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError>
```

## Default Value

""

## Remarks

The raw ML-DSA public key.

## Data Type

Vec

# pre_hash property ([MLDSA](#struct-ipworksencryptmldsa) Struct)

Whether to use HashML-DSA when signing and verifying.

## Syntax

*Rust Syntax*

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

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

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

## Data Type

bool

# signature property ([MLDSA](#struct-ipworksencryptmldsa) Struct)

The signature.

## Syntax

*Rust Syntax*

```text
fn signature(&self ) -> Result<Vec<u8>, IPWorksEncryptError> fn set_signature(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError>
fn set_signature_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError>
```

## Default Value

""

## Remarks

This property holds the ML-DSA signature.

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

## Data Type

Vec

# use_hex property ([MLDSA](#struct-ipworksencryptmldsa) Struct)

Whether the signature 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 [signature](#signature-property-mldsa-struct) is hex encoded.

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

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

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

Input data from [input_message](#input_message-property-mldsa-struct), [input_file](#input_file-property-mldsa-struct), or set_input_stream is always processed as provided.

## Data Type

bool

# config method ([MLDSA](#struct-ipworksencryptmldsa) 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-mldsa-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-mldsa-struct), you must call *Config("PROPERTY")*. The value will be returned as a string.

# create_key method ([MLDSA](#struct-ipworksencryptmldsa) Struct)

Creates a new key.

## Syntax

*Rust Syntax*

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

## Remarks

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

# reset method ([MLDSA](#struct-ipworksencryptmldsa) 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.

# sign method ([MLDSA](#struct-ipworksencryptmldsa) Struct)

Creates a signature.

## Syntax

*Rust Syntax*

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

## Remarks

This method signs the data specified by [input_file](#input_file-property-mldsa-struct) or [input_message](#input_message-property-mldsa-struct) using the private key in key and populates [signature](#signature-property-mldsa-struct).

# verify method ([MLDSA](#struct-ipworksencryptmldsa) Struct)

Verifies a signature.

## Syntax

*Rust Syntax*

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

## Remarks

This method verifies [signature](#signature-property-mldsa-struct) for the data specified by [input_file](#input_file-property-mldsa-struct) or [input_message](#input_message-property-mldsa-struct) using the public key in key. The result is returned.

# on_error event ([MLDSA](#struct-ipworksencryptmldsa) Struct)

Fired when information is available about errors during data delivery.

## Syntax

*Rust Syntax*

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

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

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

## 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-mldsa-struct) section.

# on_progress event ([MLDSA](#struct-ipworksencryptmldsa) Struct)

Fired as progress is made.

## Syntax

*Rust Syntax*

```text
// MLDSAProgressEventArgs carries the MLDSA Progress event's parameters.
pub struct MLDSAProgressEventArgs {
  fn bytes_processed(&self) -> i64
  fn percent_processed(&self) -> i32
}

// MLDSAProgressEvent defines the signature of the MLDSA Progress event's handler function.
pub trait MLDSAProgressEvent {
  fn on_progress(&self, sender : MLDSA, e : &mut MLDSAProgressEventArgs);
}

impl <'a> MLDSA<'a> {
  pub fn on_progress(&self) -> &'a dyn MLDSAProgressEvent;
  pub fn set_on_progress(&mut self, value : &'a dyn MLDSAProgressEvent);
  ...
}
```

## Remarks

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

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

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

# Config Settings ([MLDSA](#struct-ipworksencryptmldsa) 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-mldsa-struct) 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 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 ([MLDSA](#struct-ipworksencryptmldsa) Struct)

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