Package org.passay.rule

Class DigestDictionaryRule

java.lang.Object

org.passay.rule.AbstractDictionaryRule

org.passay.rule.DigestDictionaryRule

All Implemented Interfaces:

Rule

public class DigestDictionaryRule
extends AbstractDictionaryRule

Rule for determining if a password matches a digested password that is stored in a dictionary.

Field Summary

Fields

Modifier and Type	Field	Description
private final Charset	charset	Character set to use for undigested passwords.
static final String	ERROR_CODE	Error code for matching dictionary word.
static final String	ERROR_CODE_REVERSED	Error code for matching reversed dictionary word.
private final org.cryptacular.bean.HashBean<CharSequence>	hashBean	Hash bean to use for comparing hashed passwords.

Constructor Summary

Constructors

Constructor	Description
DigestDictionaryRule(org.cryptacular.bean.HashBean<CharSequence> bean, Dictionary dict)	Creates new digest history rule which operates on password references that were digested with the supplied hash.
DigestDictionaryRule(org.cryptacular.bean.HashBean<CharSequence> bean, Dictionary dict, boolean matchBackwards)	Creates new digest history rule which operates on password references that were digested with the supplied hash.
DigestDictionaryRule(org.cryptacular.bean.HashBean<CharSequence> bean, Dictionary dict, boolean matchBackwards, Charset set)	Creates new digest history rule which operates on password references that were digested with the supplied hash.

Method Summary

Modifier and Type	Method	Description
protected CharSequence	doWordSearch(UnicodeString text)	Searches the dictionary with the supplied text.
protected String	getErrorCode(boolean backwards)	Returns the error code for this rule.

Methods inherited from class org.passay.rule.AbstractDictionaryRule

createRuleResultDetailParameters, getDictionary, isMatchBackwards, toString, validate

Methods inherited from class java.lang.Object

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

Field Details

ERROR_CODE

public static final String ERROR_CODE

Error code for matching dictionary word.

See Also:

• Constant Field Values

ERROR_CODE_REVERSED

public static final String ERROR_CODE_REVERSED

Error code for matching reversed dictionary word.

See Also:

• Constant Field Values

hashBean

private final org.cryptacular.bean.HashBean<CharSequence> hashBean

Hash bean to use for comparing hashed passwords.

charset

private final Charset charset

Character set to use for undigested passwords.

Constructor Details

DigestDictionaryRule

public DigestDictionaryRule(org.cryptacular.bean.HashBean<CharSequence> bean,
 Dictionary dict)

Creates new digest history rule which operates on password references that were digested with the supplied hash. The dictionary should be ready to use when passed to this constructor.

Parameters:

dict - to use for searching

bean - encoding hash bean

DigestDictionaryRule

public DigestDictionaryRule(org.cryptacular.bean.HashBean<CharSequence> bean,
 Dictionary dict,
 boolean matchBackwards)

Creates new digest history rule which operates on password references that were digested with the supplied hash. The dictionary should be ready to use when passed to this constructor.

Parameters:

dict - to use for searching

bean - encoding hash bean

matchBackwards - whether to match dictionary words backwards

DigestDictionaryRule

public DigestDictionaryRule(org.cryptacular.bean.HashBean<CharSequence> bean,
 Dictionary dict,
 boolean matchBackwards,
 Charset set)

Creates new digest history rule which operates on password references that were digested with the supplied hash. The dictionary should be ready to use when passed to this constructor.

Parameters:

dict - to use for searching

bean - encoding hash bean

matchBackwards - whether to match dictionary words backwards

set - to use for undigested passwords

Method Details

doWordSearch

protected CharSequence doWordSearch(UnicodeString text)

Description copied from class: AbstractDictionaryRule

Searches the dictionary with the supplied text.

Specified by:

doWordSearch in class AbstractDictionaryRule

Parameters:

text - to search dictionary with

Returns:

matching word

getErrorCode

protected String getErrorCode(boolean backwards)

Description copied from class: AbstractDictionaryRule

Returns the error code for this rule.

Specified by:

getErrorCode in class AbstractDictionaryRule

Parameters:

backwards - whether to return the error code for a backwards match

Returns:

properties error code