org.antfarmer.ejce.password.encoder.bc

Class BcBcryptEncoder

java.lang.Object

org.antfarmer.ejce.password.AbstractConfigurablePasswordEncoder

org.antfarmer.ejce.password.encoder.AbstractBcryptPasswordEncoder

org.antfarmer.ejce.password.encoder.bc.BcBcryptEncoder

All Implemented Interfaces:

ConfigurablePasswordEncoder, PasswordEncoder

public class BcBcryptEncoder
extends AbstractBcryptPasswordEncoder

Password encoder using Bouncy Castle's OpenBSD BCrpyt implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_VERSION The default version '2b', if no value is specified.
static String	KEY_VERSION Property key for the version to use, 2a, 2y, or 2b.
static String	VERSION_2A The '2a' version.
static String	VERSION_2B The '2b' version.
static String	VERSION_2Y The '2y' version.

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

DEFAULT_STRENGTH, KEY_STRENGTH

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

KEY_PREFIX, KEY_RANDOM

Constructor Summary

Constructors

Constructor and Description
BcBcryptEncoder()

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_VERSION

public static final String KEY_VERSION

Property key for the version to use, 2a, 2y, or 2b. Default is 2b.

See Also:

Constant Field Values

VERSION_2A

public static final String VERSION_2A

The '2a' version.

See Also:

Constant Field Values

VERSION_2Y

public static final String VERSION_2Y

The '2y' version.

See Also:

Constant Field Values

VERSION_2B

public static final String VERSION_2B

The '2b' version.

See Also:

Constant Field Values

DEFAULT_VERSION

public static final String DEFAULT_VERSION

The default version '2b', if no value is specified.

See Also:

Constant Field Values

Constructor Detail

BcBcryptEncoder

public BcBcryptEncoder()

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