org.antfarmer.ejce.password.encoder

Class Pbkdf2Encoder

java.lang.Object

org.antfarmer.ejce.password.AbstractConfigurablePasswordEncoder

org.antfarmer.ejce.password.encoder.AbstractPbkdf2PasswordEncoder

org.antfarmer.ejce.password.encoder.Pbkdf2Encoder

All Implemented Interfaces:

ConfigurablePasswordEncoder, PasswordEncoder

public class Pbkdf2Encoder
extends AbstractPbkdf2PasswordEncoder

A highly configurable password encoder using PBKDF2 algorithms.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALGORITHM_PBKDF2_HMAC_GOST The PBKDF2withHmacGOST3411 algorithm.
static String	ALGORITHM_PBKDF2_HMAC_SHA1 The PBKDF2withHmacSHA1 algorithm.
static String	ALGORITHM_PBKDF2_HMAC_SHA224 The PBKDF2withHmacSHA224 algorithm.
static String	ALGORITHM_PBKDF2_HMAC_SHA256 The PBKDF2withHmacSHA256 algorithm.
static String	ALGORITHM_PBKDF2_HMAC_SHA3_224 The PBKDF2withHmacSHA3-224 algorithm.
static String	ALGORITHM_PBKDF2_HMAC_SHA3_256 The PBKDF2withHmacSHA3-256 algorithm.
static String	ALGORITHM_PBKDF2_HMAC_SHA3_384 The PBKDF2withHmacSHA3-384 algorithm.
static String	ALGORITHM_PBKDF2_HMAC_SHA3_512 The PBKDF2withHmacSHA3-512 algorithm.
static String	ALGORITHM_PBKDF2_HMAC_SHA384 The PBKDF2withHmacSHA384 algorithm.
static String	ALGORITHM_PBKDF2_HMAC_SHA512 The PBKDF2withHmacSHA512 algorithm.
static String	DEFAULT_ALGORITHM The default algorithm value (PBKDF2withHmacSHA1 or PBKDF2withHmacSHA512 [JRE >= 1.8]), if no value is specified.
static int	DEFAULT_SALT_LENGTH The default salt length in bits if no value is specified.
static String	KEY_PROVIDER_CLASS Property key for the JCE provider class to be used to load the algorithm.
static String	KEY_PROVIDER_NAME Property key for the JCE provider name to be used to load the algorithm.
static String	KEY_SALT_LENGTH Property key for the salt length in bits.

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
Pbkdf2Encoder()

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

KEY_SALT_LENGTH

public static final String KEY_SALT_LENGTH

Property key for the salt length in bits. The default is currently 64.

See Also:

Constant Field Values

KEY_PROVIDER_NAME

public static final String KEY_PROVIDER_NAME

Property key for the JCE provider name to be used to load the algorithm.

See Also:

Constant Field Values

KEY_PROVIDER_CLASS

public static final String KEY_PROVIDER_CLASS

Property key for the JCE provider class to be used to load the algorithm.

See Also:

Constant Field Values

ALGORITHM_PBKDF2_HMAC_SHA1

public static final String ALGORITHM_PBKDF2_HMAC_SHA1

The PBKDF2withHmacSHA1 algorithm.

See Also:

Constant Field Values

ALGORITHM_PBKDF2_HMAC_SHA224

public static final String ALGORITHM_PBKDF2_HMAC_SHA224

The PBKDF2withHmacSHA224 algorithm.

See Also:

Constant Field Values

ALGORITHM_PBKDF2_HMAC_SHA256

public static final String ALGORITHM_PBKDF2_HMAC_SHA256

The PBKDF2withHmacSHA256 algorithm.

See Also:

Constant Field Values

ALGORITHM_PBKDF2_HMAC_SHA384

public static final String ALGORITHM_PBKDF2_HMAC_SHA384

The PBKDF2withHmacSHA384 algorithm.

See Also:

Constant Field Values

ALGORITHM_PBKDF2_HMAC_SHA512

public static final String ALGORITHM_PBKDF2_HMAC_SHA512

The PBKDF2withHmacSHA512 algorithm.

See Also:

Constant Field Values

ALGORITHM_PBKDF2_HMAC_SHA3_224

public static final String ALGORITHM_PBKDF2_HMAC_SHA3_224

The PBKDF2withHmacSHA3-224 algorithm.

See Also:

Constant Field Values

ALGORITHM_PBKDF2_HMAC_SHA3_256

public static final String ALGORITHM_PBKDF2_HMAC_SHA3_256

The PBKDF2withHmacSHA3-256 algorithm.

See Also:

Constant Field Values

ALGORITHM_PBKDF2_HMAC_SHA3_384

public static final String ALGORITHM_PBKDF2_HMAC_SHA3_384

The PBKDF2withHmacSHA3-384 algorithm.

See Also:

Constant Field Values

ALGORITHM_PBKDF2_HMAC_SHA3_512

public static final String ALGORITHM_PBKDF2_HMAC_SHA3_512

The PBKDF2withHmacSHA3-512 algorithm.

See Also:

Constant Field Values

ALGORITHM_PBKDF2_HMAC_GOST

public static final String ALGORITHM_PBKDF2_HMAC_GOST

The PBKDF2withHmacGOST3411 algorithm.

See Also:

Constant Field Values

DEFAULT_ALGORITHM

public static final String DEFAULT_ALGORITHM

The default algorithm value (PBKDF2withHmacSHA1 or PBKDF2withHmacSHA512 [JRE >= 1.8]), if no value is specified.

DEFAULT_SALT_LENGTH

public static final int DEFAULT_SALT_LENGTH

The default salt length in bits if no value is specified.

See Also:

Constant Field Values

Constructor Detail

Pbkdf2Encoder

public Pbkdf2Encoder()

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