org.antfarmer.ejce.password.encoder

Class Argon2JvmEncoder

java.lang.Object

org.antfarmer.ejce.password.AbstractConfigurablePasswordEncoder

org.antfarmer.ejce.password.encoder.AbstractArgon2PasswordEncoder

org.antfarmer.ejce.password.encoder.Argon2JvmEncoder

All Implemented Interfaces:

ConfigurablePasswordEncoder, PasswordEncoder

public class Argon2JvmEncoder
extends AbstractArgon2PasswordEncoder

Password encoder using the Argon2 library via JNA, provided by phxql/argon2-jvm project.

Field Summary

Fields inherited from class org.antfarmer.ejce.password.encoder.AbstractArgon2PasswordEncoder

DEFAULT_HASH_LENGTH, DEFAULT_ITERATIONS, DEFAULT_MEMORY_SIZE, DEFAULT_PARALLELISM, DEFAULT_SALT_LENGTH, DEFAULT_TYPE, KEY_HASH_LENGTH, KEY_ITERATIONS, KEY_MEMORY_SIZE, KEY_PARALLELISM, KEY_SALT_LENGTH, KEY_TYPE, TYPE_D, TYPE_I, TYPE_ID

Fields inherited from class org.antfarmer.ejce.password.AbstractConfigurablePasswordEncoder

KEY_PREFIX, KEY_RANDOM

Constructor Summary

Constructors

Constructor and Description
Argon2JvmEncoder()

Method Summary

Modifier and Type	Method and Description
void	doConfigure(Properties parameters, String prefix) Configures and initializes the encoder using the given Properties.
String	doEncode(CharSequence rawPassword) Encode the raw password.
boolean	isMatch(CharSequence rawPassword, String encodedPassword) Verify the encoded password obtained from storage matches the submitted raw password after it too is encoded.

Methods inherited from class org.antfarmer.ejce.password.AbstractConfigurablePasswordEncoder

configure, decodeBytes, encode, encodeBytes, getCharset, getPropertyName, getRandom, getTextEncoder, matches, parseBoolean, parseInstance, parseInt, parseInt, parseString, toBytes

Methods inherited from class java.lang.Object

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

Constructor Detail

Argon2JvmEncoder

public Argon2JvmEncoder()

Method Detail

doConfigure

public void doConfigure(Properties parameters,
                        String prefix)

Configures and initializes the encoder using the given Properties.

Specified by:

doConfigure in class AbstractConfigurablePasswordEncoder

Parameters:

parameters - the parameters

prefix - the prefix

doEncode

public String doEncode(CharSequence rawPassword)

Encode the raw password. This should combine a message digest (hash) function with randomly generated salt.

Specified by:

doEncode in class AbstractConfigurablePasswordEncoder

Parameters:

rawPassword - the raw password to encode

Returns:

the encoded password

isMatch

public boolean isMatch(CharSequence rawPassword,
                       String encodedPassword)

Verify the encoded password obtained from storage matches the submitted raw password after it too is encoded. Returns true if the passwords match, false if they do not. The stored password itself is never decoded.

Specified by:

isMatch in class AbstractConfigurablePasswordEncoder

Parameters:

rawPassword - the raw password to encode and match

encodedPassword - the encoded password from storage to compare with

Returns:

true if the raw password, after encoding, matches the encoded password from storage