Argon2 Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

class 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
• salt

Optionally, specify the algorithm variant, key_length in bytes, number of iterations, degree of parallelism and memory_cost in kilobytes.

After calling the create_key method, the key 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

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

Method List

---

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

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.

Config Settings

---

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

algorithm Property

The variant used to derive the key.

Syntax

def get_algorithm() -> int: ...
def set_algorithm(value: int) -> None: ...

algorithm = property(get_algorithm, set_algorithm)

Default Value

2

Remarks

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

iterations Property

Number of iterations to perform.

Syntax

def get_iterations() -> int: ...
def set_iterations(value: int) -> None: ...

iterations = property(get_iterations, set_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

The derived key.

Syntax

def get_key() -> bytes: ...

key = property(get_key, None)

Default Value

""

Remarks

This property holds the derived key. After calling create_key this property will be populated.

This property is read-only.

key_length Property

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

Syntax

def get_key_length() -> int: ...
def set_key_length(value: int) -> None: ...

key_length = property(get_key_length, set_key_length)

Default Value

32

Remarks

This property specifies the length of the key (in bytes) which will be created when create_key is called. Valid values are from 4 to 2^(32)-1.

memory_cost Property

The memory usage in kilobytes.

Syntax

def get_memory_cost() -> int: ...
def set_memory_cost(value: int) -> None: ...

memory_cost = property(get_memory_cost, set_memory_cost)

Default Value

65536

Remarks

This property defines the memory used (in kilobytes) when calling create_key.

parallelism Property

The degree of parallelism.

Syntax

def get_parallelism() -> int: ...
def set_parallelism(value: int) -> None: ...

parallelism = property(get_parallelism, set_parallelism)

Default Value

4

Remarks

This property specifies the number of lanes used when calling create_key.

password Property

The password from which a derived key is generated.

Syntax

def get_password() -> bytes: ...
def set_password(value: bytes) -> None: ...

password = property(get_password, set_password)

Default Value

""

Remarks

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

salt Property

The cryptographic salt used during key creation.

Syntax

def get_salt() -> bytes: ...
def set_salt(value: bytes) -> None: ...

salt = property(get_salt, set_salt)

Default Value

""

Remarks

This property specifies the salt used when create_key is called. The salt should be a unique value and should be at least 16 bytes in length.

use_hex Property

Whether the key is hex encoded.

Syntax

def get_use_hex() -> bool: ...
def set_use_hex(value: bool) -> None: ...

use_hex = property(get_use_hex, set_use_hex)

Default Value

FALSE

Remarks

This property specifies whether the created key is hex encoded when calling create_key. The default value is False.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings 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, you must call Config("PROPERTY"). The value will be returned as a string.

create_key Method

Derives a key from the specified password.

Syntax

def create_key() -> None: ...

Remarks

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

The following properties are applicable when calling this method:

• password (required)
• salt (required)
• algorithm
• iterations
• key_length
• memory_cost
• parallelism

This method populates the key property with the created (derived) key.

Create Key Example

//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

Resets the class.

Syntax

def reset() -> None: ...

Remarks

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

on_error Event

Fired when information is available about errors during data delivery.

Syntax

class Argon2ErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class Argon2:
@property
def on_error() -> Callable[[Argon2ErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[Argon2ErrorEventParams], None]) -> None: ...

Remarks

The on_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 section.

Argon2 Config Settings

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

Argon2 Config Settings

Base Config Settings

Argon2 Errors

Argon2 Errors