Package org.apache.shiro.crypto.support.hashes.argon2

Class Argon2HashProvider.Parameters

java.lang.Object

org.apache.shiro.crypto.support.hashes.argon2.Argon2HashProvider.Parameters

Enclosing class:

Argon2HashProvider

public static final class Argon2HashProvider.Parameters
extends Object

Parameters for the Argon2Hash class.

This class contains public constants only. The constants starting with PARAMETER_ are the parameter names recognized by the HashSpi.HashFactory.generate(HashRequest) method.

The constants starting with DEFAULT_ are their respective default values.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_ALGORITHM_NAME	Default algorithm name.
static final int	DEFAULT_ALGORITHM_VERSION	Default algorithm version.
static final int	DEFAULT_ITERATIONS	Default iterations.
static final int	DEFAULT_MEMORY_KIB	Default memory kib.
static final int	DEFAULT_OUTPUT_LENGTH_BITS	Default output length bits.
static final int	DEFAULT_PARALLELISM	Default parallelism number.
static final String	PARAMETER_ALGORITHM_NAME	Parameter for modifying the internal algorithm used by Argon2.
static final String	PARAMETER_ALGORITHM_VERSION	Argon2 algorithm version.
static final String	PARAMETER_ITERATIONS	Argon2 parameter iterations.
static final String	PARAMETER_MEMORY_KIB	Argon2 parameter memory kib.
static final String	PARAMETER_OUTPUT_LENGTH_BITS	The output length (in bits) of the resulting data section.
static final String	PARAMETER_PARALLELISM	Argon2 parameter parallelism.
static final String	PARAMETER_SALT	The salt to use.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_ALGORITHM_NAME

public static final String DEFAULT_ALGORITHM_NAME

Default algorithm name.

See Also:

• Constant Field Values

DEFAULT_ALGORITHM_VERSION

public static final int DEFAULT_ALGORITHM_VERSION

Default algorithm version.

See Also:

• Constant Field Values

DEFAULT_ITERATIONS

public static final int DEFAULT_ITERATIONS

Default iterations.

See Also:

• Constant Field Values

DEFAULT_MEMORY_KIB

public static final int DEFAULT_MEMORY_KIB

Default memory kib.

See Also:

• Constant Field Values

DEFAULT_PARALLELISM

public static final int DEFAULT_PARALLELISM

Default parallelism number.

See Also:

• Constant Field Values

DEFAULT_OUTPUT_LENGTH_BITS

public static final int DEFAULT_OUTPUT_LENGTH_BITS

Default output length bits.

See Also:

• Constant Field Values

PARAMETER_ALGORITHM_NAME

public static final String PARAMETER_ALGORITHM_NAME

Parameter for modifying the internal algorithm used by Argon2.

Valid values are argon2i (optimized to resist side-channel attacks), argon2d (maximizes resistance to GPU cracking attacks) and argon2id (a hybrid version).

The default value is "argon2id" when this parameter is not specified.

See Also:

• Constant Field Values

PARAMETER_ALGORITHM_VERSION

public static final String PARAMETER_ALGORITHM_VERSION

Argon2 algorithm version.

See Also:

• Constant Field Values

PARAMETER_SALT

public static final String PARAMETER_SALT

The salt to use.

The value for this parameter accepts a Base64-encoded 16byte (128bit) salt.

As for any KDF, do not use a static salt value for multiple passwords.

The default value is a new random 128bit-salt, if this parameter is not specified.

See Also:

• Constant Field Values

PARAMETER_ITERATIONS

public static final String PARAMETER_ITERATIONS

Argon2 parameter iterations.

See Also:

• Constant Field Values

PARAMETER_MEMORY_KIB

public static final String PARAMETER_MEMORY_KIB

Argon2 parameter memory kib.

See Also:

• Constant Field Values

PARAMETER_PARALLELISM

public static final String PARAMETER_PARALLELISM

Argon2 parameter parallelism.

See Also:

• Constant Field Values

PARAMETER_OUTPUT_LENGTH_BITS

public static final String PARAMETER_OUTPUT_LENGTH_BITS

The output length (in bits) of the resulting data section.

Argon2 allows to modify the length of the generated output.

The default value is 256 when this parameter is not specified.

See Also:

• Constant Field Values