io.netfall.libargon2.jna

Interface Argon2Library

All Superinterfaces:

com.sun.jna.Library

public interface Argon2Library
extends com.sun.jna.Library

JNA bindings for Argon2.

Nested Class Summary

Nested classes/interfaces inherited from interface com.sun.jna.Library

com.sun.jna.Library.Handler

Field Summary

Fields

Modifier and Type	Field and Description
static int	ARGON2_OK Return code if everything is okay.

Fields inherited from interface com.sun.jna.Library

OPTION_ALLOW_OBJECTS, OPTION_CALLING_CONVENTION, OPTION_CLASSLOADER, OPTION_FUNCTION_MAPPER, OPTION_INVOCATION_MAPPER, OPTION_OPEN_FLAGS, OPTION_STRING_ENCODING, OPTION_STRUCTURE_ALIGNMENT, OPTION_TYPE_MAPPER

Method Summary

Modifier and Type	Method and Description
Size_t	argon2_encodedlen(Uint32_t t_cost, Uint32_t m_cost, Uint32_t parallelism, Uint32_t saltlen, Uint32_t hashlen) Returns the encoded hash length for the given input parameters.
String	argon2_error_message(int error_code) Get the associated error message for given error code.
int	argon2d_hash_encoded(Uint32_t t_cost, Uint32_t m_cost, Uint32_t parallelism, byte[] pwd, Size_t pwdlen, byte[] salt, Size_t saltlen, Size_t hashlen, byte[] encoded, Size_t encodedlen) Hashes a password with Argon2d, producing an encoded hash.
int	argon2d_verify(byte[] encoded, byte[] pwd, Size_t pwdlen) Verifies a password against an Argon2d encoded string.
int	argon2i_hash_encoded(Uint32_t t_cost, Uint32_t m_cost, Uint32_t parallelism, byte[] pwd, Size_t pwdlen, byte[] salt, Size_t saltlen, Size_t hashlen, byte[] encoded, Size_t encodedlen) Hashes a password with Argon2i, producing an encoded hash.
int	argon2i_verify(byte[] encoded, byte[] pwd, Size_t pwdlen) Verifies a password against an Argon2i encoded string.

Field Detail

ARGON2_OK

static final int ARGON2_OK

Return code if everything is okay.

See Also:

Constant Field Values

Method Detail

argon2i_hash_encoded

int argon2i_hash_encoded(Uint32_t t_cost,
                         Uint32_t m_cost,
                         Uint32_t parallelism,
                         byte[] pwd,
                         Size_t pwdlen,
                         byte[] salt,
                         Size_t saltlen,
                         Size_t hashlen,
                         byte[] encoded,
                         Size_t encodedlen)

Hashes a password with Argon2i, producing an encoded hash.

Parameters:

t_cost - Number of iterations

m_cost - Sets memory usage to m_cost kibibytes

parallelism - Number of threads and compute lanes

pwd - Pointer to password

pwdlen - Password size in bytes

salt - Pointer to salt

saltlen - Salt size in bytes

hashlen - Desired length of the hash in bytes

encoded - Buffer where to write the encoded hash

encodedlen - Size of the buffer (thus max size of the encoded hash)

Returns:

ARGON2_OK if successful

argon2d_hash_encoded

int argon2d_hash_encoded(Uint32_t t_cost,
                         Uint32_t m_cost,
                         Uint32_t parallelism,
                         byte[] pwd,
                         Size_t pwdlen,
                         byte[] salt,
                         Size_t saltlen,
                         Size_t hashlen,
                         byte[] encoded,
                         Size_t encodedlen)

Hashes a password with Argon2d, producing an encoded hash.

Parameters:

t_cost - Number of iterations

m_cost - Sets memory usage to m_cost kibibytes

parallelism - Number of threads and compute lanes

pwd - Pointer to password

pwdlen - Password size in bytes

salt - Pointer to salt

saltlen - Salt size in bytes

hashlen - Desired length of the hash in bytes

encoded - Buffer where to write the encoded hash

encodedlen - Size of the buffer (thus max size of the encoded hash)

Returns:

ARGON2_OK if successful

argon2i_verify

int argon2i_verify(byte[] encoded,
                   byte[] pwd,
                   Size_t pwdlen)

Verifies a password against an Argon2i encoded string.

Parameters:

encoded - String encoding parameters, salt, hash

pwd - Pointer to password

pwdlen - Password size in bytes

Returns:

ARGON2_OK if successful

argon2d_verify

int argon2d_verify(byte[] encoded,
                   byte[] pwd,
                   Size_t pwdlen)

Verifies a password against an Argon2d encoded string.

Parameters:

encoded - String encoding parameters, salt, hash

pwd - Pointer to password

pwdlen - Password size in bytes

Returns:

ARGON2_OK if successful

argon2_encodedlen

Size_t argon2_encodedlen(Uint32_t t_cost,
                         Uint32_t m_cost,
                         Uint32_t parallelism,
                         Uint32_t saltlen,
                         Uint32_t hashlen)

Returns the encoded hash length for the given input parameters.

Parameters:

t_cost - Number of iterations.

m_cost - Memory usage in kibibytes.

parallelism - Number of threads; used to compute lanes.

saltlen - Salt size in bytes.

hashlen - Hash size in bytes.

Returns:

The encoded hash length in bytes.

argon2_error_message

String argon2_error_message(int error_code)

Get the associated error message for given error code.

Parameters:

error_code - Numeric error code.

Returns:

The error message associated with the given error code.