Argon2 Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TipcArgon2

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, KeyLength in bytes, number of Iterations, degree of Parallelism and MemoryCost in kilobytes.

After calling the CreateKey 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 component with short descriptions. Click on the links for further details.

Method List

---

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

Event List

---

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

---

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

Algorithm Property (Argon2 Component)

The variant used to derive the key.

Syntax

__property TipcArgon2Algorithms Algorithm = { read=FAlgorithm, write=FSetAlgorithm };

enum TipcArgon2Algorithms {
  aArgon2d=0,
  aArgon2i=1,
  aArgon2id=2
};

Default Value

aArgon2id

Remarks

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

Data Type

Integer

Iterations Property (Argon2 Component)

Number of iterations to perform.

Syntax

__property int Iterations = { read=FIterations, write=FSetIterations };

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 Component)

The derived key.

Syntax

__property String Key = { read=FKey };
__property DynamicArray<Byte> KeyB = { read=FKeyB };

Default Value

""

Remarks

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

This property is read-only.

Data Type

Byte Array

KeyLength Property (Argon2 Component)

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

Syntax

__property int KeyLength = { read=FKeyLength, write=FSetKeyLength };

Default Value

32

Remarks

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

Data Type

Integer

MemoryCost Property (Argon2 Component)

The memory usage in kilobytes.

Syntax

__property int MemoryCost = { read=FMemoryCost, write=FSetMemoryCost };

Default Value

65536

Remarks

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

Data Type

Integer

Parallelism Property (Argon2 Component)

The degree of parallelism.

Syntax

__property int Parallelism = { read=FParallelism, write=FSetParallelism };

Default Value

4

Remarks

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

Data Type

Integer

Password Property (Argon2 Component)

The password from which a derived key is generated.

Syntax

__property String Password = { read=FPassword, write=FSetPassword };
__property DynamicArray<Byte> PasswordB = { read=FPasswordB, write=FSetPasswordB };

Default Value

""

Remarks

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

Data Type

Byte Array

Salt Property (Argon2 Component)

The cryptographic salt used during key creation.

Syntax

__property String Salt = { read=FSalt, write=FSetSalt };
__property DynamicArray<Byte> SaltB = { read=FSaltB, write=FSetSaltB };

Default Value

""

Remarks

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

Data Type

Byte Array

UseHex Property (Argon2 Component)

Whether the key is hex encoded.

Syntax

__property bool UseHex = { read=FUseHex, write=FSetUseHex };

Default Value

false

Remarks

This property specifies whether the created Key is hex encoded when calling CreateKey. The default value is false.

Data Type

Boolean

Config Method (Argon2 Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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.

CreateKey Method (Argon2 Component)

Derives a key from the specified password.

Syntax

void __fastcall CreateKey();

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
• KeyLength
• MemoryCost
• 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 (Argon2 Component)

Resets the component.

Syntax

void __fastcall Reset();

Remarks

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

Error Event (Argon2 Component)

Fired when information is available about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TipcArgon2ErrorEventParams;
typedef void __fastcall (__closure *TipcArgon2ErrorEvent)(System::TObject* Sender, TipcArgon2ErrorEventParams *e);
__property TipcArgon2ErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises 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 section.

Config Settings (Argon2 Component)

The component 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 component, access to these internal properties is provided through the Config method.

Argon2 Config Settings

Base Config Settings

Trappable Errors (Argon2 Component)

Argon2 Errors