io.netfall.libargon2

Class Argon2i

java.lang.Object

io.netfall.libargon2.Argon2i

All Implemented Interfaces:

Argon2

public class Argon2i
extends Object

Argon2i password hashing function.

Constructor Summary

Constructors

Constructor and Description
Argon2i() Constructor.
Argon2i(int saltLen, int hashLen) Constructor.

Method Summary

Modifier and Type	Method and Description
protected int	callLibraryHash(byte[] pwd, byte[] salt, Uint32_t iterations, Uint32_t memory, Uint32_t parallelism, byte[] encoded) Is called when the hash function of the native library should be called.
protected int	callLibraryVerify(byte[] encoded, byte[] pwd) Is called when the verify function of the native library should be called.
protected int	getHashLength() Returns the hash length in bytes.
String	hash(int iterations, int memory, int parallelism, char[] password) Hashes a password.
String	hash(int iterations, int memory, int parallelism, char[] password, Charset charset) Hashes a password.
String	hash(int iterations, int memory, int parallelism, String password) Hashes a password.
String	hash(int iterations, int memory, int parallelism, String password, Charset charset) Hashes a password.
boolean	verify(String hash, char[] password) Verifies a password against a hash.
boolean	verify(String hash, char[] password, Charset charset) Verifies a password against a hash.
boolean	verify(String hash, String password) Verifies a password against a hash.
boolean	verify(String hash, String password, Charset charset) Verifies a password against a hash.
void	wipeArray(char[] array) Wipes the data from the given array.

Methods inherited from class java.lang.Object

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

Constructor Detail

Argon2i

public Argon2i()

Constructor.

Uses default salt and hash lengths.

Argon2i

public Argon2i(int saltLen,
               int hashLen)

Constructor.

Parameters:

saltLen - Salt length in bytes.

hashLen - Hash length in bytes.

Method Detail

callLibraryHash

protected int callLibraryHash(byte[] pwd,
                              byte[] salt,
                              Uint32_t iterations,
                              Uint32_t memory,
                              Uint32_t parallelism,
                              byte[] encoded)

Is called when the hash function of the native library should be called.

Parameters:

pwd - Password.

salt - Salt.

iterations - Iterations.

memory - Memory.

parallelism - Parallelism.

encoded - Byte array to write the hash to.

Returns:

Return code.

callLibraryVerify

protected int callLibraryVerify(byte[] encoded,
                                byte[] pwd)

Is called when the verify function of the native library should be called.

Parameters:

encoded - Buffer.

pwd - Password.

Returns:

Return code.

getHashLength

protected int getHashLength()

Returns the hash length in bytes.

Returns:

Hash length in bytes.

hash

public String hash(int iterations,
                   int memory,
                   int parallelism,
                   char[] password)

Description copied from interface: Argon2

Hashes a password. Uses UTF-8 encoding.

Specified by:

hash in interface Argon2

Parameters:

iterations - Number of iterations

memory - Sets memory usage to x kibibytes

parallelism - Number of threads and compute lanes

password - Password to hash

Returns:

Hashed password.

hash

public String hash(int iterations,
                   int memory,
                   int parallelism,
                   char[] password,
                   Charset charset)

Description copied from interface: Argon2

Hashes a password.

Specified by:

hash in interface Argon2

Parameters:

iterations - Number of iterations

memory - Sets memory usage to x kibibytes

parallelism - Number of threads and compute lanes

password - Password to hash

charset - Charset of the password

Returns:

Hashed password.

hash

public String hash(int iterations,
                   int memory,
                   int parallelism,
                   String password,
                   Charset charset)

Description copied from interface: Argon2

Hashes a password.

Specified by:

hash in interface Argon2

Parameters:

iterations - Number of iterations

memory - Sets memory usage to x kibibytes

parallelism - Number of threads and compute lanes

password - Password to hash

charset - Charset of the password

Returns:

Hashed password.

hash

public String hash(int iterations,
                   int memory,
                   int parallelism,
                   String password)

Description copied from interface: Argon2

Hashes a password. Uses UTF-8 encoding.

Specified by:

hash in interface Argon2

Parameters:

iterations - Number of iterations

memory - Sets memory usage to x kibibytes

parallelism - Number of threads and compute lanes

password - Password to hash

Returns:

Hashed password.

verify

public boolean verify(String hash,
                      String password)

Description copied from interface: Argon2

Verifies a password against a hash. Uses UTF-8 encoding.

Specified by:

verify in interface Argon2

Parameters:

hash - Hash.

password - Password.

Returns:

True if the password matches the hash, false otherwise.

verify

public boolean verify(String hash,
                      String password,
                      Charset charset)

Description copied from interface: Argon2

Verifies a password against a hash.

Specified by:

verify in interface Argon2

Parameters:

hash - Hash.

password - Password.

charset - Charset of the password

Returns:

True if the password matches the hash, false otherwise.

verify

public boolean verify(String hash,
                      char[] password,
                      Charset charset)

Description copied from interface: Argon2

Verifies a password against a hash.

Specified by:

verify in interface Argon2

Parameters:

hash - Hash.

password - Password.

charset - Charset of the password

Returns:

True if the password matches the hash, false otherwise.

verify

public boolean verify(String hash,
                      char[] password)

Description copied from interface: Argon2

Verifies a password against a hash. Uses UTF-8 encoding.

Specified by:

verify in interface Argon2

Parameters:

hash - Hash.

password - Password.

Returns:

True if the password matches the hash, false otherwise.

wipeArray

public void wipeArray(char[] array)

Description copied from interface: Argon2

Wipes the data from the given array.

Use this method after hash creation / verification on the array which contains the user password.

Specified by:

wipeArray in interface Argon2

Parameters:

array - The array to wipe.