io.netfall.libargon2

Interface Argon2

All Known Implementing Classes:

Argon2d, Argon2i

public interface Argon2

Argon2 password hashing function.

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

hash

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

Hashes a password. Uses UTF-8 encoding.

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

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

Hashes a password.

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

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

Hashes a password. Uses UTF-8 encoding.

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

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

Hashes a password.

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.

verify

boolean verify(String hash,
               String password)

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

Parameters:

hash - Hash.

password - Password.

Returns:

True if the password matches the hash, false otherwise.

verify

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

Verifies a password against a hash.

Parameters:

hash - Hash.

password - Password.

charset - Charset of the password

Returns:

True if the password matches the hash, false otherwise.

verify

boolean verify(String hash,
               char[] password)

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

Parameters:

hash - Hash.

password - Password.

Returns:

True if the password matches the hash, false otherwise.

verify

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

Verifies a password against a hash.

Parameters:

hash - Hash.

password - Password.

charset - Charset of the password

Returns:

True if the password matches the hash, false otherwise.

wipeArray

void wipeArray(char[] array)

Wipes the data from the given array.

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

Parameters:

array - The array to wipe.