Argon2 Module

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

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, 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 module with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

Algorithm Property (Argon2 Module)

The variant used to derive the key.

Syntax

• Swift
• Objective-C

public var algorithm: Argon2Algorithms {
  get {...}
  set {...}
}

public enum Argon2Algorithms: Int32 {
  case aArgon2d = 0
  case aArgon2i = 1
  case aArgon2id = 2
}

@property (nonatomic,readwrite,assign,getter=algorithm,setter=setAlgorithm:) int algorithm;

- (int)algorithm;
- (void)setAlgorithm :(int)newAlgorithm;

Default Value

2

Remarks

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

Iterations Property (Argon2 Module)

Number of iterations to perform.

Syntax

• Swift
• Objective-C

public var iterations: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=iterations,setter=setIterations:) int iterations;

- (int)iterations;
- (void)setIterations :(int)newIterations;

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

The derived key.

Syntax

• Swift
• Objective-C

public var key: String {
  get {...}
}

public var keyB: Data {
  get {...}
}

@property (nonatomic,readonly,assign,getter=key) NSString* key;

- (NSString*)key;

@property (nonatomic,readonly,assign,getter=keyB) NSData* keyB;

- (NSData*)keyB;

Default Value

""

Remarks

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

This property is read-only.

KeyLength Property (Argon2 Module)

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

Syntax

• Swift
• Objective-C

public var keyLength: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=keyLength,setter=setKeyLength:) int keyLength;

- (int)keyLength;
- (void)setKeyLength :(int)newKeyLength;

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.

MemoryCost Property (Argon2 Module)

The memory usage in kilobytes.

Syntax

• Swift
• Objective-C

public var memoryCost: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=memoryCost,setter=setMemoryCost:) int memoryCost;

- (int)memoryCost;
- (void)setMemoryCost :(int)newMemoryCost;

Default Value

65536

Remarks

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

Parallelism Property (Argon2 Module)

The degree of parallelism.

Syntax

• Swift
• Objective-C

public var parallelism: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=parallelism,setter=setParallelism:) int parallelism;

- (int)parallelism;
- (void)setParallelism :(int)newParallelism;

Default Value

4

Remarks

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

Password Property (Argon2 Module)

The password from which a derived key is generated.

Syntax

• Swift
• Objective-C

public var password: String {
  get {...}
  set {...}
}

public var passwordB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=password,setter=setPassword:) NSString* password;

- (NSString*)password;
- (void)setPassword :(NSString*)newPassword;

@property (nonatomic,readwrite,assign,getter=passwordB,setter=setPasswordB:) NSData* passwordB;

- (NSData*)passwordB;
- (void)setPasswordB :(NSData*)newPassword;

Default Value

""

Remarks

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

Salt Property (Argon2 Module)

The cryptographic salt used during key creation.

Syntax

• Swift
• Objective-C

public var salt: String {
  get {...}
  set {...}
}

public var saltB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=salt,setter=setSalt:) NSString* salt;

- (NSString*)salt;
- (void)setSalt :(NSString*)newSalt;

@property (nonatomic,readwrite,assign,getter=saltB,setter=setSaltB:) NSData* saltB;

- (NSData*)saltB;
- (void)setSaltB :(NSData*)newSalt;

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.

UseHex Property (Argon2 Module)

Whether the key is hex encoded.

Syntax

• Swift
• Objective-C

public var useHex: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=useHex,setter=setUseHex:) BOOL useHex;

- (BOOL)useHex;
- (void)setUseHex :(BOOL)newUseHex;

Default Value

False

Remarks

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

Config Method (Argon2 Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

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.

CreateKey Method (Argon2 Module)

Derives a key from the specified password.

Syntax

• Swift
• Objective-C

public func createKey() throws -> Void

- (void)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

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

Resets the component.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

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

Error Event (Argon2 Module)

Fired when information is available about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

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

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

Argon2 Config Settings

Base Config Settings

Trappable Errors (Argon2 Module)

Argon2 Errors