# Argon2 Class

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

## Syntax

```text
ipworksencrypt.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. |
| [GUIAvailable](#GUIAvailable) | Whether or not a message loop is available for processing events. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseDaemonThreads](#UseDaemonThreads) | Whether threads created by the class are daemon threads. |
| [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. |
| [UseVirtualThreads](#UseVirtualThreads) | Whether threads created by the class use virtual threads instead of platform threads. |

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

The variant used to derive the key.

## Syntax

```text
public int getAlgorithm();
public void setAlgorithm(int algorithm);

Enumerated values:
  public final static int aArgon2d = 0;
  public final static int aArgon2i = 1;
  public final static int aArgon2id = 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. |

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

Number of iterations to perform.

## Syntax

```text
public int getIterations();
public void setIterations(int iterations);
```

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

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

The derived key.

## Syntax

```text
public byte[] getKey();
```

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

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

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

## Syntax

```text
public int getKeyLength();
public void setKeyLength(int keyLength);
```

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

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

The memory usage in kilobytes.

## Syntax

```text
public int getMemoryCost();
public void setMemoryCost(int memoryCost);
```

## Default Value

65536

## Remarks

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

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

The degree of parallelism.

## Syntax

```text
public int getParallelism();
public void setParallelism(int parallelism);
```

## Default Value

4

## Remarks

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

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

The password from which a derived key is generated.

## Syntax

```text
public byte[] getPassword();
public void setPassword(byte[] password);
```

## Default Value

""

## Remarks

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

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

The cryptographic salt used during key creation.

## Syntax

```text
public byte[] getSalt();
public void setSalt(byte[] salt);
```

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

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

Whether the key is hex encoded.

## Syntax

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

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

# Config Method ([Argon2](#argon2-class) Class)

Sets or retrieves a configuration setting.

## Syntax

```text
public String config(String configurationString);
```

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

# CreateKey Method ([Argon2](#argon2-class) Class)

Derives a key from the specified password.

## Syntax

```text
public void 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
```

# Reset Method ([Argon2](#argon2-class) Class)

Resets the class.

## Syntax

```text
public void reset();
```

## Remarks

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

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

Fired when information is available about errors during data delivery.

## Syntax

```text
public class DefaultArgon2EventListener implements Argon2EventListener {
  ...
  public void error(Argon2ErrorEvent e) {}
  ...
}

public class Argon2ErrorEvent {
  public int errorCode;
  public String description;
}
```

## Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class throws an exception.

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.

**GUIAvailable**: Whether or not a message loop is available for processing events.In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The class will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting [GUIAvailable](#GUIAvailable) to *false* will ensure that the class does not attempt to process external events.

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

**UseDaemonThreads**: Whether threads created by the class are daemon threads.If set to True (default), when the class creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the class will not set the Daemon property on the created thread. The default value is True.

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

The Java edition requires installation of the FIPS-certified Bouncy Castle library regardless of the target operating system. This can be downloaded from [https://www.bouncycastle.org/fips-java/](https://www.bouncycastle.org/fips-java/). Only the "Provider" library is needed. The jar file should then be installed in a JRE search path.

The following classes must be imported in the application in which the component will be used:

```text
import java.security.Security;
import org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider;
```

The Bouncy Castle provider must be added as a valid provider and must also be configured to operate in FIPS mode:

```text
System.setProperty("org.bouncycastle.fips.approved_only","true");
Security.addProvider(new BouncyCastleFipsProvider());
```

When [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) is *true*, Secure Sockets Layer (SSL)-enabled classes can optionally be configured to use the Transport Layer Security (TLS) Bouncy Castle library. When SSLProvider is set to *sslpAutomatic* (default) or *sslpInternal*, an internal TLS implementation is used, but all cryptographic operations are offloaded to the Bouncy Castle FIPS provider to achieve FIPS-compliant operation. If SSLProvider is set to *sslpPlatform*, the Bouncy Castle JSSE will be used in place of the internal TLS implementation.

To enable the use of the Bouncy Castle JSSE take the following steps in addition to the steps above. Both the Bouncy Castle FIPS provider and the Bouncy Castle JSSE must be configured to use the Bouncy Castle TLS library in FIPS mode. Obtain the Bouncy Castle TLS library from [https://www.bouncycastle.org/fips-java/](https://www.bouncycastle.org/fips-java/). The jar file should then be installed in a JRE search path.

The following classes must be imported in the application in which the component will be used:

```text
import java.security.Security;
import org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider;

//required to use BCJSSE when SSLProvider is set to sslpPlatform
import org.bouncycastle.jsse.provider.BouncyCastleJsseProvider;
```

The Bouncy Castle provider must be added as a valid provider and also must be configured to operate in FIPS mode:

```text
System.setProperty("org.bouncycastle.fips.approved_only","true");
Security.addProvider(new BouncyCastleFipsProvider());

//required to use BCJSSE when SSLProvider is set to sslpPlatform
Security.addProvider(new BouncyCastleJsseProvider("fips:BCFIPS"));

//optional - configure logging level of BCJSSE
Logger.getLogger("org.bouncycastle.jsse").setLevel(java.util.logging.Level.OFF);

//configure the class to use BCJSSE
component.setSSLProvider(1); //platform
component.config("UseFIPSCompliantAPI=true");
```

 NOTE: TLS 1.3 support requires the Bouncy Castle TLS library version 1.0.14 or later.

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

 This setting is set to *false* by default on all platforms.

**UseVirtualThreads**: Whether threads created by the class use virtual threads instead of platform threads.If set to *true*, when the class creates a thread, it will be created as a virtual thread instead of a platform thread. Virtual threads are lightweight threads managed by the JVM that are multiplexed onto a small pool of carrier threads, significantly reducing memory usage and platform thread count under high-concurrency workloads. Requires Java 24 or later. The default value is *false*.

# Trappable Errors ([Argon2](#argon2-class) Class)

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