org.antfarmer.ejce.password

Class AbstractConfigurablePasswordEncoder

java.lang.Object

org.antfarmer.ejce.password.AbstractConfigurablePasswordEncoder

All Implemented Interfaces:

ConfigurablePasswordEncoder, PasswordEncoder

Direct Known Subclasses:

AbstractArgon2PasswordEncoder, AbstractBcryptPasswordEncoder, AbstractPbkdf2PasswordEncoder, AbstractScryptPasswordEncoder

public abstract class AbstractConfigurablePasswordEncoder
extends Object
implements ConfigurablePasswordEncoder

Abstract ConfigurablePasswordEncoder containing configuration parsing methods.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_PREFIX Property key for a prefix to used to prefix encoded values to aid in identifying the type of hash.
static String	KEY_RANDOM Property key for the SecureRandom class name to use for generating salt.

Constructor Summary

Constructors

Constructor and Description
AbstractConfigurablePasswordEncoder()

Method Summary

Modifier and Type	Method and Description
void	configure(Properties parameters, String prefix) Configures and initializes the encoder using the given Properties.
protected byte[]	decodeBytes(String encoded) Decodes the given text using the default text encoder.
abstract void	doConfigure(Properties parameters, String prefix) Configures and initializes the encoder using the given Properties.
abstract String	doEncode(CharSequence rawPassword) Encode the raw password.
String	encode(CharSequence rawPassword) Encode the raw password.
protected String	encodeBytes(byte[] bytes) Encodes the given data using the default text encoder.
protected Charset	getCharset()
protected String	getPropertyName(String prefix, String baseName) Returns the property name for the given prefix and key baseName.
protected SecureRandom	getRandom(Properties parameters, String prefix) Returns a static SecureRandom matching the name configured in the given Properties.
protected TextEncoder	getTextEncoder()
abstract boolean	isMatch(CharSequence rawPassword, String encodedPassword) Verify the encoded password obtained from storage matches the submitted raw password after it too is encoded.
boolean	matches(CharSequence rawPassword, String encodedPassword) Verify the encoded password obtained from storage matches the submitted raw password after it too is encoded.
protected boolean	parseBoolean(Properties parameters, String prefix, String key, boolean defaultValue) Parses the property value as a boolean from the given parameters.
protected <T> T	parseInstance(String value) Parses the string as a class name and returns a new instance of that class.
protected int	parseInt(Properties parameters, String prefix, String key, int defaultValue) Parses the property value as an int from the given parameters.
protected Integer	parseInt(String value) Parses the given string as an integer.
protected String	parseString(Properties parameters, String prefix, String key, String defaultValue) Parses the property value from the given parameters.
protected byte[]	toBytes(CharSequence text) Converts the given CharSequence to bytes using the default charset.

Methods inherited from class java.lang.Object

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

Field Detail

KEY_RANDOM

public static final String KEY_RANDOM

Property key for the SecureRandom class name to use for generating salt.

See Also:

Constant Field Values

KEY_PREFIX

public static final String KEY_PREFIX

Property key for a prefix to used to prefix encoded values to aid in identifying the type of hash.

See Also:

Constant Field Values

Constructor Detail

AbstractConfigurablePasswordEncoder

public AbstractConfigurablePasswordEncoder()

Method Detail

getRandom

protected SecureRandom getRandom(Properties parameters,
                                 String prefix)

Returns a static SecureRandom matching the name configured in the given Properties.

Parameters:

parameters - the configuration parameters

prefix - the prefix for the Properties keys

Returns:

a static SecureRandom matching the name configured in the given Properties

parseInt

protected int parseInt(Properties parameters,
                       String prefix,
                       String key,
                       int defaultValue)

Parses the property value as an int from the given parameters.

Parameters:

parameters - the Properties

prefix - the property prefix

key - the property key

defaultValue - the default value if no value is configured

Returns:

the configured int value or the default value if not configured

parseInt

protected Integer parseInt(String value)

Parses the given string as an integer.

Parameters:

value - the input string

Returns:

the integer value of the given string, or null if the string is empty

parseInstance

protected <T> T parseInstance(String value)

Parses the string as a class name and returns a new instance of that class.

Type Parameters:

T - the returne type of the instance

Parameters:

value - the name of the class

Returns:

a new instance of the given class name

parseBoolean

protected boolean parseBoolean(Properties parameters,
                               String prefix,
                               String key,
                               boolean defaultValue)

Parses the property value as a boolean from the given parameters.

Parameters:

parameters - the Properties

prefix - the property prefix

key - the property key

defaultValue - the default value if no value is configured

Returns:

the configured boolean value or the default value if not configured

parseString

protected String parseString(Properties parameters,
                             String prefix,
                             String key,
                             String defaultValue)

Parses the property value from the given parameters.

Parameters:

parameters - the Properties

prefix - the property prefix

key - the property key

defaultValue - the default value if no value is configured

Returns:

the configured String value or the default value if not configured

getPropertyName

protected String getPropertyName(String prefix,
                                 String baseName)

Returns the property name for the given prefix and key baseName.

Parameters:

prefix - the property key prefix

baseName - the property key base name (may be null)

Returns:

the property name for the given prefix and key baseName

toBytes

protected byte[] toBytes(CharSequence text)

Converts the given CharSequence to bytes using the default charset.

Parameters:

text - the text

Returns:

the bytes representing the given text

encodeBytes

protected String encodeBytes(byte[] bytes)

Encodes the given data using the default text encoder.

Parameters:

bytes - the data

Returns:

the encoded representation of the given bytes

decodeBytes

protected byte[] decodeBytes(String encoded)

Decodes the given text using the default text encoder.

Parameters:

encoded - the encoded text

Returns:

the decoded data of the given text

getCharset

protected Charset getCharset()

Returns:

the default Charset (UTF-8)

getTextEncoder

protected TextEncoder getTextEncoder()

Returns:

the default TextEncoder (Base64)

configure

public final void configure(Properties parameters,
                            String prefix)

Configures and initializes the encoder using the given Properties.

Specified by:

configure in interface ConfigurablePasswordEncoder

Parameters:

parameters - the parameters

prefix - the property prefix

doConfigure

public abstract void doConfigure(Properties parameters,
                                 String prefix)

Configures and initializes the encoder using the given Properties.

Parameters:

parameters - the parameters

prefix - the prefix

encode

public final String encode(CharSequence rawPassword)

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

Specified by:

encode in interface PasswordEncoder

Parameters:

rawPassword - the raw password to encode

Returns:

the encoded password

matches

public final boolean matches(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:

matches in interface PasswordEncoder

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

doEncode

public abstract String doEncode(CharSequence rawPassword)

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

Parameters:

rawPassword - the raw password to encode

Returns:

the encoded password

isMatch

public abstract 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.

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