de.mkammerer.argon2.jna.Argon2Library Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of argon2-jvm Show documentation
Show all versions of argon2-jvm Show documentation
Argon2 Binding for the JVM
package de.mkammerer.argon2.jna;
import com.sun.jna.Library;
import com.sun.jna.Native;
/**
* JNA bindings for Argon2.
*/
public interface Argon2Library extends Library {
/**
* Singleton instance.
*/
Argon2Library INSTANCE = (Argon2Library) Native.loadLibrary("argon2", Argon2Library.class);
/**
* Return code if everything is okay.
*/
int ARGON2_OK = 0;
/*
int argon2i_hash_encoded(const uint32_t t_cost, const uint32_t m_cost,
const uint32_t parallelism, const void *pwd,
const size_t pwdlen, const void *salt,
const size_t saltlen, const size_t hashlen,
char *encoded, const size_t encodedlen);
*/
/**
* Hashes a password with Argon2i, producing an encoded hash.
*
* @param t_cost Number of iterations
* @param m_cost Sets memory usage to m_cost kibibytes
* @param parallelism Number of threads and compute lanes
* @param pwd Pointer to password
* @param pwdlen Password size in bytes
* @param salt Pointer to salt
* @param saltlen Salt size in bytes
* @param hashlen Desired length of the hash in bytes
* @param encoded Buffer where to write the encoded hash
* @param encodedlen Size of the buffer (thus max size of the encoded hash)
* @return {@link #ARGON2_OK} if successful
*/
int argon2i_hash_encoded(JnaUint32 t_cost, JnaUint32 m_cost, JnaUint32 parallelism, byte[] pwd, Size_t pwdlen, byte[] salt, Size_t saltlen, Size_t hashlen, byte[] encoded, Size_t encodedlen);
/**
* Hashes a password with Argon2id, producing an encoded hash.
*
* @param t_cost Number of iterations
* @param m_cost Sets memory usage to m_cost kibibytes
* @param parallelism Number of threads and compute lanes
* @param pwd Pointer to password
* @param pwdlen Password size in bytes
* @param salt Pointer to salt
* @param saltlen Salt size in bytes
* @param hashlen Desired length of the hash in bytes
* @param encoded Buffer where to write the encoded hash
* @param encodedlen Size of the buffer (thus max size of the encoded hash)
* @return {@link #ARGON2_OK} if successful
*/
int argon2id_hash_encoded(JnaUint32 t_cost, JnaUint32 m_cost, JnaUint32 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.
*
* @param t_cost Number of iterations
* @param m_cost Sets memory usage to m_cost kibibytes
* @param parallelism Number of threads and compute lanes
* @param pwd Pointer to password
* @param pwdlen Password size in bytes
* @param salt Pointer to salt
* @param saltlen Salt size in bytes
* @param hashlen Desired length of the hash in bytes
* @param encoded Buffer where to write the encoded hash
* @param encodedlen Size of the buffer (thus max size of the encoded hash)
* @return {@link #ARGON2_OK} if successful
*/
int argon2d_hash_encoded(JnaUint32 t_cost, JnaUint32 m_cost, JnaUint32 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.
*
* @param t_cost Number of iterations
* @param m_cost Sets memory usage to m_cost kibibytes
* @param parallelism Number of threads and compute lanes
* @param pwd Pointer to password
* @param pwdlen Password size in bytes
* @param salt Pointer to salt
* @param saltlen Salt size in bytes
* @param hash Buffer where to write the raw hash
* @param hashlen Desired length of the hash in bytes
* @return {@link #ARGON2_OK} if successful
*/
int argon2i_hash_raw(JnaUint32 t_cost, JnaUint32 m_cost, JnaUint32 parallelism, byte[] pwd, Size_t pwdlen, byte[] salt, Size_t saltlen, byte[] hash, Size_t hashlen);
/**
* Hashes a password with Argon2id, producing an encoded hash.
*
* @param t_cost Number of iterations
* @param m_cost Sets memory usage to m_cost kibibytes
* @param parallelism Number of threads and compute lanes
* @param pwd Pointer to password
* @param pwdlen Password size in bytes
* @param salt Pointer to salt
* @param saltlen Salt size in bytes
* @param hash Buffer where to write the raw hash
* @param hashlen Desired length of the hash in bytes
* @return {@link #ARGON2_OK} if successful
*/
int argon2id_hash_raw(JnaUint32 t_cost, JnaUint32 m_cost, JnaUint32 parallelism, byte[] pwd, Size_t pwdlen, byte[] salt, Size_t saltlen, byte[] hash, Size_t hashlen);
/**
* Hashes a password with Argon2d, producing an encoded hash.
*
* @param t_cost Number of iterations
* @param m_cost Sets memory usage to m_cost kibibytes
* @param parallelism Number of threads and compute lanes
* @param pwd Pointer to password
* @param pwdlen Password size in bytes
* @param salt Pointer to salt
* @param saltlen Salt size in bytes
* @param hash Buffer where to write the raw hash
* @param hashlen Desired length of the hash in bytes
* @return {@link #ARGON2_OK} if successful
*/
int argon2d_hash_raw(JnaUint32 t_cost, JnaUint32 m_cost, JnaUint32 parallelism, byte[] pwd, Size_t pwdlen, byte[] salt, Size_t saltlen, byte[] hash, Size_t hashlen);
/**
* Verifies a password against an Argon2i encoded string.
*
* @param encoded String encoding parameters, salt, hash
* @param pwd Pointer to password
* @param pwdlen Password size in bytes
* @return ARGON2_OK if successful
*/
/*
int argon2i_verify(const char *encoded, const void *pwd, const size_t pwdlen);
*/
int argon2i_verify(byte[] encoded, byte[] pwd, Size_t pwdlen);
/**
* Verifies a password against an Argon2d encoded string.
*
* @param encoded String encoding parameters, salt, hash
* @param pwd Pointer to password
* @param pwdlen Password size in bytes
* @return ARGON2_OK if successful
*/
int argon2d_verify(byte[] encoded, byte[] pwd, Size_t pwdlen);
/**
* Verifies a password against an Argon2id encoded string.
*
* @param encoded String encoding parameters, salt, hash
* @param pwd Pointer to password
* @param pwdlen Password size in bytes
* @return ARGON2_OK if successful
*/
int argon2id_verify(byte[] encoded, byte[] pwd, Size_t pwdlen);
/**
* Returns the encoded hash length for the given input parameters.
*
* @param t_cost Number of iterations.
* @param m_cost Memory usage in kibibytes.
* @param parallelism Number of threads; used to compute lanes.
* @param saltlen Salt size in bytes.
* @param hashlen Hash size in bytes.
* @param type The argon2 type.
* @return The encoded hash length in bytes.
*/
Size_t argon2_encodedlen(JnaUint32 t_cost, JnaUint32 m_cost, JnaUint32 parallelism, JnaUint32 saltlen, JnaUint32 hashlen, Argon2_type type);
/**
* Get the associated error message for given error code.
*
* @param error_code Numeric error code.
* @return The error message associated with the given error code.
*/
String argon2_error_message(int error_code);
}