# Argon2 Class

This class implements Argon2 cryptographic hashing function designed for password hashing and protecting against various types of attacks.

## Syntax

```text
Argon2
```

## Remarks

Argon2 is a memory-hard algorithm that can be used for secure key derivation. It supports three different variants of the algorithm.

To create a key using this component, start by setting the required properties:

- [Password](#password-property-argon2-class)
- [Salt](#salt-property-argon2-class)

Optionally, specify the [Algorithm](#algorithm-property-argon2-class) variant, [KeyLength](#keylength-property-argon2-class) in bytes, number of [Iterations](#iterations-property-argon2-class), degree of [Parallelism](#parallelism-property-argon2-class) and [MemoryCost](#memorycost-property-argon2-class) in kilobytes.

After calling the [CreateKey](#createkey-method-argon2-class) method, the [Key](#key-property-argon2-class) will be populated with the derived key.

NOTE: By default, the component uses the following values which are recommended by RFC 9106: Argon2id variant with 3 iterations, 4 degrees of parallelism, 64 MB of RAM, and 32 byte key length.

**Create Key Example**

```csharp
//Create a key using Argon2 component
Argon2 argon2 = new Argon2();
argon2.Password = "password";
argon2.Salt = "AAAABBBBCCCCDDDD"; //16 bytes string
argon2.UseHex = true; //hex encoded key
argon2.CreateKey();
Console.WriteLine(argon2.Key); //outputs the derived key, 32 bytes by default
```

## Property List

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

|  |  |
| --- | --- |
| [Algorithm](#algorithm-property-argon2-class) | The variant used to derive the key. |
| [Iterations](#iterations-property-argon2-class) | Number of iterations to perform. |
| [Key](#key-property-argon2-class) | The derived key. |
| [KeyLength](#keylength-property-argon2-class) | The desired length of the derived key (in bytes). |
| [MemoryCost](#memorycost-property-argon2-class) | The memory usage in kilobytes. |
| [Parallelism](#parallelism-property-argon2-class) | The degree of parallelism. |
| [Password](#password-property-argon2-class) | The password from which a derived key is generated. |
| [Salt](#salt-property-argon2-class) | The cryptographic salt used during key creation. |
| [UseHex](#usehex-property-argon2-class) | Whether the key 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-argon2-class) | Sets or retrieves a configuration setting. |
| [CreateKey](#createkey-method-argon2-class) | Derives a key from the specified password. |
| [Reset](#reset-method-argon2-class) | Resets the class. |

## 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-argon2-class) | Fired when information is available about errors during data delivery. |

## Config Settings

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

|  |  |
| --- | --- |
| [AssociatedData](#AssociatedData) | Optional associated data. |
| [Secret](#Secret) | Optional secret. |
| [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. |

# Algorithm Property ([Argon2](#argon2-class) Class)

The variant used to derive the key.

## Syntax

```text
ANSI (Cross Platform)
int GetAlgorithm();int SetAlgorithm(int iAlgorithm);

Unicode (Windows)
INT GetAlgorithm();INT SetAlgorithm(INT iAlgorithm);
```

## Possible Values

```text
A_ARGON_2D(0), A_ARGON_2I(1), A_ARGON_2ID(2)
```

## Default Value

2

## Remarks

This property specifies which type of algorithm to use. Possible values are:

|  |  |
| --- | --- |
| 0 (aArgon2d) | Argon2d maximizes resistance to GPU cracking attacks, but is more vulnerable to side-channel attacks. |
| 1 (aArgon2i) | Argon2i is optimized to resist side-channel attacks, but it is slower as it makes more passes over the memory to protect from tradeoff attacks. |
| 2 (aArgon2id - Default) | Argon2id is a hybrid of Argon2i and Argon2d which provides some of Argon2i's resistance to side-channel cache timing attacks and much of Argon2d's resistance to GPU cracking attacks. |

## Data Type

Integer

# Iterations Property ([Argon2](#argon2-class) Class)

Number of iterations to perform.

## Syntax

```text
ANSI (Cross Platform)
int GetIterations();int SetIterations(int iIterations);

Unicode (Windows)
INT GetIterations();INT SetIterations(INT iIterations);
```

## Default Value

3

## Remarks

The number of iterations is used to adjust the running time independently of the memory size. Valid values are from 1 to 2^(32)-1.

## Data Type

Integer

# Key Property ([Argon2](#argon2-class) Class)

The derived key.

## Syntax

```text
ANSI (Cross Platform)
int GetKey(char* &lpKey, int &lenKey);

Unicode (Windows)
INT GetKey(LPSTR &lpKey, INT &lenKey);
```

## Default Value

""

## Remarks

This property holds the derived key. After calling [CreateKey](#createkey-method-argon2-class) this property will be populated.

This property is read-only.

## Data Type

Binary String

# KeyLength Property ([Argon2](#argon2-class) Class)

The desired length of the derived key (in bytes).

## Syntax

```text
ANSI (Cross Platform)
int GetKeyLength();int SetKeyLength(int iKeyLength);

Unicode (Windows)
INT GetKeyLength();INT SetKeyLength(INT iKeyLength);
```

## Default Value

32

## Remarks

This property specifies the length of the key (in bytes) which will be created when [CreateKey](#createkey-method-argon2-class) is called. Valid values are from 4 to 2^(32)-1.

## Data Type

Integer

# MemoryCost Property ([Argon2](#argon2-class) Class)

The memory usage in kilobytes.

## Syntax

```text
ANSI (Cross Platform)
int GetMemoryCost();int SetMemoryCost(int iMemoryCost);

Unicode (Windows)
INT GetMemoryCost();INT SetMemoryCost(INT iMemoryCost);
```

## Default Value

65536

## Remarks

This property defines the memory used (in kilobytes) when calling [CreateKey](#createkey-method-argon2-class).

## Data Type

Integer

# Parallelism Property ([Argon2](#argon2-class) Class)

The degree of parallelism.

## Syntax

```text
ANSI (Cross Platform)
int GetParallelism();int SetParallelism(int iParallelism);

Unicode (Windows)
INT GetParallelism();INT SetParallelism(INT iParallelism);
```

## Default Value

4

## Remarks

This property specifies the number of lanes used when calling [CreateKey](#createkey-method-argon2-class).

## Data Type

Integer

# Password Property ([Argon2](#argon2-class) Class)

The password from which a derived key is generated.

## Syntax

```text
ANSI (Cross Platform)
int GetPassword(char* &lpPassword, int &lenPassword);int SetPassword(const char* lpPassword, int lenPassword);

Unicode (Windows)
INT GetPassword(LPSTR &lpPassword, INT &lenPassword);INT SetPassword(LPCSTR lpPassword, INT lenPassword);
```

## Default Value

""

## Remarks

This property specifies the password from which the derived key is created.

## Data Type

Binary String

# Salt Property ([Argon2](#argon2-class) Class)

The cryptographic salt used during key creation.

## Syntax

```text
ANSI (Cross Platform)
int GetSalt(char* &lpSalt, int &lenSalt);int SetSalt(const char* lpSalt, int lenSalt);

Unicode (Windows)
INT GetSalt(LPSTR &lpSalt, INT &lenSalt);INT SetSalt(LPCSTR lpSalt, INT lenSalt);
```

## Default Value

""

## Remarks

This property specifies the salt used when [CreateKey](#createkey-method-argon2-class) is called. The salt should be a unique value and should be at least 16 bytes in length.

## Data Type

Binary String

# UseHex Property ([Argon2](#argon2-class) Class)

Whether the key 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 the created [Key](#key-property-argon2-class) is hex encoded when calling [CreateKey](#createkey-method-argon2-class). The default value is *false*.

## Data Type

Boolean

# Config Method ([Argon2](#argon2-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-argon2-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-argon2-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 ([Argon2](#argon2-class) Class)

Derives a key from the specified password.

## Syntax

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

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

## Remarks

This method derives a key from the specified password using Argon2.

The following properties are applicable when calling this method:

- [Password](#password-property-argon2-class) (required)
- [Salt](#salt-property-argon2-class) (required)
- [Algorithm](#algorithm-property-argon2-class)
- [Iterations](#iterations-property-argon2-class)
- [KeyLength](#keylength-property-argon2-class)
- [MemoryCost](#memorycost-property-argon2-class)
- [Parallelism](#parallelism-property-argon2-class)

 This method populates the [Key](#key-property-argon2-class) property with the created (derived) key.

**Create Key Example**

```csharp
//Create a key using Argon2 component
Argon2 argon2 = new Argon2();
argon2.Password = "password";
argon2.Salt = "AAAABBBBCCCCDDDD"; //16 bytes string
argon2.UseHex = true; //hex encoded key
argon2.CreateKey();
Console.WriteLine(argon2.Key); //outputs the derived key, 32 bytes by default
```

## 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 ([Argon2](#argon2-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.)

# Error Event ([Argon2](#argon2-class) Class)

Fired when information is available about errors during data delivery.

## Syntax

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

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

## 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-argon2-class) section.

# Config Settings ([Argon2](#argon2-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-argon2-class) method.

### Argon2 Config Settings

**AssociatedData**: Optional associated data.The associated data parameter, which is used to input any additional data into the hash value. The data specified must be hex encoded. If used, it must have a length not greater than 2^(32)-1 bytes.

```csharp
Argon2 argon2 = new Argon2();
argon2.Password = "password";
argon2.Salt = "AAAABBBBCCCCDDDD";
argon2.Config("AssociatedData=040404040404040404040404"); //hex encoded value
argon2.CreateKey();
```

**Secret**: Optional secret.The secret parameter, which is used for keyed hashing. This allows a secret key to be input at hashing time into the value of the hash. The data specified must be hex encoded. This means that even if the salts and hashes are compromised, an attacker cannot use brute-force to find the password without the key. If used, it must have a length not greater than 2^(32)-1 bytes.

```csharp
Argon2 argon2 = new Argon2();
argon2.Password = "password";
argon2.Salt = "AAAABBBBCCCCDDDD";
argon2.Config("Secret=012345012345ABCD"); //hex encoded value
argon2.CreateKey();
```

### 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 ([Argon2](#argon2-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.

### Argon2 Errors

|  |  |
| --- | --- |
| 105 | An invalid parameter was specified. |
| 108 | An invalid key size was specified. |
| 116 | Password must be set. |
| 117 | An error occurred during hash calculation. |
| 118 | An invalid algorithm was specified. |