org.antfarmer.ejce.password.encoder.spring

Class SpringPbkdf2Encoder

java.lang.Object

org.antfarmer.ejce.password.AbstractConfigurablePasswordEncoder

org.antfarmer.ejce.password.encoder.AbstractPbkdf2PasswordEncoder

org.antfarmer.ejce.password.encoder.spring.SpringPbkdf2Encoder

All Implemented Interfaces:

ConfigurablePasswordEncoder, PasswordEncoder

public class SpringPbkdf2Encoder
extends AbstractPbkdf2PasswordEncoder

Password encoder using Spring's PBKDF2 implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ALGORITHM The default algorithm value (PBKDF2WithHmacSHA512), if no value is specified.
static String	KEY_ENCODE_HEX Property key for the flag indicating whether to encode values using a hex encoder.

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

DEFAULT_HASH_LENGTH, DEFAULT_ITERATIONS, KEY_ALGORITHM, KEY_HASH_LENGTH, KEY_ITERATIONS, KEY_SECRET

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

KEY_PREFIX, KEY_RANDOM

Constructor Summary

Constructors

Constructor and Description
SpringPbkdf2Encoder()

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

Field Detail

DEFAULT_ALGORITHM

public static final String DEFAULT_ALGORITHM

The default algorithm value (PBKDF2WithHmacSHA512), if no value is specified.

KEY_ENCODE_HEX

public static final String KEY_ENCODE_HEX

Property key for the flag indicating whether to encode values using a hex encoder. The default is false.

See Also:

Constant Field Values

Constructor Detail

SpringPbkdf2Encoder

public SpringPbkdf2Encoder()

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