Package org.passay

Class DefaultPasswordValidator

java.lang.Object

org.passay.DefaultPasswordValidator

All Implemented Interfaces:

PasswordValidator

public class DefaultPasswordValidator
extends Object
implements PasswordValidator

Default implementation for evaluating multiple password rules against a candidate password. Supports a fail fast flag to indicate that rule validation should stop if any rule fails.

Field Summary

Fields

Modifier and Type	Field	Description
static final BiFunction<List<? extends Rule>,PasswordData,Entropy>	DEFAULT_ENTROPY_PROVIDER	Calculates the entropy of the given PasswordData based on the password rules specified.
private final BiFunction<List<? extends Rule>,PasswordData,Entropy>	entropyProvider	Entropy provider.
private final boolean	failFast	Whether password validation should fail fast.
private final MessageResolver	messageResolver	Message resolver.
static final BiFunction<List<? extends Rule>,PasswordData,Entropy>	NO_ENTROPY_PROVIDER	Entropy provider that returns -1.
static final MessageResolver	NULL_MESSAGE_RESOLVER	Message resolver that returns null for any rule result detail.
private final List<Rule>	passwordRules	Password rules.

Constructor Summary

Constructors

Constructor	Description
DefaultPasswordValidator(boolean failFast, BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider, List<? extends Rule> rules)	Creates a new default password validator.
DefaultPasswordValidator(boolean failFast, BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider, Rule... rules)	Creates a new default password validator.
DefaultPasswordValidator(boolean failFast, List<? extends Rule> rules)	Creates a new default password validator.
DefaultPasswordValidator(boolean failFast, MessageResolver resolver, BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider, List<? extends Rule> rules)	Creates a new default password validator.
DefaultPasswordValidator(boolean failFast, MessageResolver resolver, BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider, Rule... rules)	Creates a new default password validator.
DefaultPasswordValidator(boolean failFast, MessageResolver resolver, List<? extends Rule> rules)	Creates a new default password validator.
DefaultPasswordValidator(boolean failFast, MessageResolver resolver, Rule... rules)	Creates a new default password validator.
DefaultPasswordValidator(boolean failFast, Rule... rules)	Creates a new default password validator.
DefaultPasswordValidator(BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider, List<? extends Rule> rules)	Creates a new default password validator.
DefaultPasswordValidator(BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider, Rule... rules)	Creates a new default password validator.
DefaultPasswordValidator(List<? extends Rule> rules)	Creates a new default password validator.
DefaultPasswordValidator(MessageResolver resolver, BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider, List<? extends Rule> rules)	Creates a new default password validator.
DefaultPasswordValidator(MessageResolver resolver, BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider, Rule... rules)	Creates a new default password validator.
DefaultPasswordValidator(MessageResolver resolver, List<? extends Rule> rules)	Creates a new default password validator.
DefaultPasswordValidator(MessageResolver resolver, Rule... rules)	Creates a new default password validator.
DefaultPasswordValidator(Rule... rules)	Creates a new default password validator.

Method Summary

Modifier and Type	Method	Description
BiFunction<List<? extends Rule>,PasswordData,Entropy>	getEntropyProvider()	Returns the entropy provider for this validator.
MessageResolver	getMessageResolver()	Returns the message resolver for this validator.
List<? extends Rule>	getRules()	Returns the password rules for this validator.
String	toString()
ValidationResult	validate(PasswordData passwordData)	Validates the supplied password data against the rules in this validator.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_ENTROPY_PROVIDER

public static final BiFunction<List<? extends Rule>,PasswordData,Entropy> DEFAULT_ENTROPY_PROVIDER

Calculates the entropy of the given PasswordData based on the password rules specified. It's important to note that this function does NOT take into account IllegalRegexRule or AllowedRegexRule as the regular expressions driving the rules may be negative matches. The supplied password data must have an origin of Origin.Generated or Origin.User.

See Also:

• PDF Publication

NULL_MESSAGE_RESOLVER

public static final MessageResolver NULL_MESSAGE_RESOLVER

Message resolver that returns null for any rule result detail.

NO_ENTROPY_PROVIDER

public static final BiFunction<List<? extends Rule>,PasswordData,Entropy> NO_ENTROPY_PROVIDER

Entropy provider that returns -1.

passwordRules

private final List<Rule> passwordRules

Password rules.

failFast

private final boolean failFast

Whether password validation should fail fast.

messageResolver

private final MessageResolver messageResolver

Message resolver.

entropyProvider

private final BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider

Entropy provider.

Constructor Details

DefaultPasswordValidator

public DefaultPasswordValidator(Rule... rules)

Creates a new default password validator.

Parameters:

rules - to validate

DefaultPasswordValidator

public DefaultPasswordValidator(List<? extends Rule> rules)

Creates a new default password validator.

Parameters:

rules - to validate

DefaultPasswordValidator

public DefaultPasswordValidator(boolean failFast,
 Rule... rules)

Creates a new default password validator.

Parameters:

failFast - whether rule validation should fail fast

rules - to validate

DefaultPasswordValidator

public DefaultPasswordValidator(boolean failFast,
 List<? extends Rule> rules)

Creates a new default password validator.

Parameters:

failFast - whether rule validation should fail fast

rules - to validate

DefaultPasswordValidator

public DefaultPasswordValidator(MessageResolver resolver,
 Rule... rules)

Creates a new default password validator.

Parameters:

resolver - message resolver.

rules - to validate

DefaultPasswordValidator

public DefaultPasswordValidator(MessageResolver resolver,
 List<? extends Rule> rules)

Creates a new default password validator.

Parameters:

resolver - message resolver.

rules - to validate

DefaultPasswordValidator

public DefaultPasswordValidator(boolean failFast,
 MessageResolver resolver,
 Rule... rules)

Creates a new default password validator.

Parameters:

failFast - whether rule validation should fail fast

resolver - message resolver.

rules - to validate

DefaultPasswordValidator

public DefaultPasswordValidator(boolean failFast,
 MessageResolver resolver,
 List<? extends Rule> rules)

Creates a new default password validator.

Parameters:

failFast - whether rule validation should fail fast

resolver - message resolver.

rules - to validate

DefaultPasswordValidator

public DefaultPasswordValidator(BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider,
 Rule... rules)

Creates a new default password validator.

Parameters:

entropyProvider - to calculate entropy estimate

rules - to validate

DefaultPasswordValidator

public DefaultPasswordValidator(BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider,
 List<? extends Rule> rules)

Creates a new default password validator.

Parameters:

entropyProvider - to calculate entropy estimate

rules - to validate

DefaultPasswordValidator

public DefaultPasswordValidator(boolean failFast,
 BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider,
 Rule... rules)

Creates a new default password validator.

Parameters:

failFast - whether rule validation should fail fast

entropyProvider - to calculate entropy estimate

rules - to validate

DefaultPasswordValidator

public DefaultPasswordValidator(boolean failFast,
 BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider,
 List<? extends Rule> rules)

Creates a new default password validator.

Parameters:

failFast - whether rule validation should fail fast

entropyProvider - to calculate entropy estimate

rules - to validate

DefaultPasswordValidator

public DefaultPasswordValidator(MessageResolver resolver,
 BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider,
 Rule... rules)

Creates a new default password validator.

Parameters:

resolver - message resolver.

entropyProvider - to calculate entropy estimate

rules - to validate

DefaultPasswordValidator

public DefaultPasswordValidator(MessageResolver resolver,
 BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider,
 List<? extends Rule> rules)

Creates a new default password validator.

Parameters:

resolver - message resolver.

entropyProvider - to calculate entropy estimate

rules - to validate

DefaultPasswordValidator

public DefaultPasswordValidator(boolean failFast,
 MessageResolver resolver,
 BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider,
 Rule... rules)

Creates a new default password validator.

Parameters:

failFast - whether rule validation should fail fast

resolver - message resolver.

entropyProvider - to calculate entropy estimate

rules - to validate

DefaultPasswordValidator

public DefaultPasswordValidator(boolean failFast,
 MessageResolver resolver,
 BiFunction<List<? extends Rule>,PasswordData,Entropy> entropyProvider,
 List<? extends Rule> rules)

Creates a new default password validator.

Parameters:

failFast - whether rule validation should fail fast

resolver - message resolver.

entropyProvider - to calculate entropy estimate

rules - to validate

Method Details

getRules

public List<? extends Rule> getRules()

Description copied from interface: PasswordValidator

Returns the password rules for this validator.

Specified by:

getRules in interface PasswordValidator

Returns:

unmodifiable list of password rules

getMessageResolver

public MessageResolver getMessageResolver()

Description copied from interface: PasswordValidator

Returns the message resolver for this validator.

Specified by:

getMessageResolver in interface PasswordValidator

Returns:

message resolver

getEntropyProvider

public BiFunction<List<? extends Rule>,PasswordData,Entropy> getEntropyProvider()

Description copied from interface: PasswordValidator

Returns the entropy provider for this validator.

Specified by:

getEntropyProvider in interface PasswordValidator

Returns:

entropy provider

validate

public ValidationResult validate(PasswordData passwordData)

Description copied from interface: PasswordValidator

Validates the supplied password data against the rules in this validator.

Specified by:

validate in interface PasswordValidator

Parameters:

passwordData - to validate

Returns:

validation result

toString

public String toString()

Overrides:

toString in class Object