A B C D E F G H I J L M N O P Q R S T U V W

A

AbstractDictionaryRule - Class in org.passay

Provides common implementation for password dictionary rules.

AbstractDictionaryRule() - Constructor for class org.passay.AbstractDictionaryRule

AbstractFileWordList - Class in org.passay.dictionary

Common implementation for file based word lists.

AbstractFileWordList(RandomAccessFile, boolean, CharsetDecoder) - Constructor for class org.passay.dictionary.AbstractFileWordList

Creates a new abstract file word list from the supplied file.

AbstractFileWordList.FileWord - Class in org.passay.dictionary

Data structure containing word and byte offset into file where word begins in backing file.

AbstractMessageResolver - Class in org.passay

Provides a baseline implementation of AbstractMessageResolver.resolve(RuleResultDetail) which uses String.format(String, Object...) to resolve messages.

AbstractMessageResolver() - Constructor for class org.passay.AbstractMessageResolver

AbstractReference(String, String, PasswordData.Salt) - Constructor for class org.passay.PasswordData.AbstractReference

Creates a new abstract reference.

AbstractReference(String, String) - Constructor for class org.passay.PasswordData.AbstractReference

Creates a new abstract reference.

AbstractWordList - Class in org.passay.dictionary

Provides common operations implementations for word lists.

AbstractWordList() - Constructor for class org.passay.dictionary.AbstractWordList

addError(String, Map<String, Object>) - Method in class org.passay.RuleResult

Adds a new rule result detail with the given error details and sets the result of the rule verification to invalid.

addError(String[], Map<String, Object>) - Method in class org.passay.RuleResult

Adds a new rule result detail under multiple error codes.

addFile(String) - Method in class org.passay.dictionary.DictionaryBuilder

Adds a word list to the dictionary to be built.

addReader(Reader) - Method in class org.passay.dictionary.DictionaryBuilder

Adds a word list to the dictionary to be built.

addRules(String, List<Rule>) - Method in class org.passay.LengthComplexityRule

Adds the rules to invoke for the supplied interval.

addRules(String, Rule...) - Method in class org.passay.LengthComplexityRule

Adds the rules to invoke for the supplied interval.

AllowedCharacterRule - Class in org.passay

Rule for determining if a password contains allowed characters.

AllowedCharacterRule(char[]) - Constructor for class org.passay.AllowedCharacterRule

Create a new allowed character rule.

AllowedCharacterRule(char[], MatchBehavior) - Constructor for class org.passay.AllowedCharacterRule

Create a new allowed character rule.

AllowedCharacterRule(char[], boolean) - Constructor for class org.passay.AllowedCharacterRule

Create a new allowed character rule.

AllowedCharacterRule(char[], MatchBehavior, boolean) - Constructor for class org.passay.AllowedCharacterRule

Create a new allowed character rule.

AllowedRegexRule - Class in org.passay

Rule for determining if a password matches an allowed regular expression.

AllowedRegexRule(String) - Constructor for class org.passay.AllowedRegexRule

Creates a new allowed regex rule.

AllowedRegexRule(String, int) - Constructor for class org.passay.AllowedRegexRule

Creates a new allowed regex rule.

applyTo(String) - Method in class org.passay.PasswordData.PrefixSalt

applyTo(String) - Method in interface org.passay.PasswordData.Salt

Applies the salt to the password, returning the combined string to be digested.

applyTo(String) - Method in class org.passay.PasswordData.SuffixSalt

ArraySorter - Interface in org.passay.dictionary.sort

Interface for array sort implementations.

ArraysSort - Class in org.passay.dictionary.sort

Delegates sorting to Arrays.sort(Object[], Comparator).

ArraysSort() - Constructor for class org.passay.dictionary.sort.ArraysSort

ArrayWordList - Class in org.passay.dictionary

Provides a WordList backed by a string array.

ArrayWordList(String[]) - Constructor for class org.passay.dictionary.ArrayWordList

Creates a new case-sensitive word list backed by the given array.

ArrayWordList(String[], boolean) - Constructor for class org.passay.dictionary.ArrayWordList

Creates a new word list backed by the given array.

ArrayWordList(String[], boolean, ArraySorter) - Constructor for class org.passay.dictionary.ArrayWordList

Creates a new word list backed by the given array with optional sorting of the input string array.

B

binarySearch(WordList, String) - Static method in class org.passay.dictionary.WordLists

Performs a binary search of the given word list for the given word.

BloomFilterDictionary - Class in org.passay.dictionary

Dictionary that is backed by a Bloom Filter.

BloomFilterDictionary(BloomFilter<String>) - Constructor for class org.passay.dictionary.BloomFilterDictionary

Creates a new dictionary instance from the supplied BloomFilter.

BubbleSort - Class in org.passay.dictionary.sort

Provides an implementation of the bubble sort algorithm.

BubbleSort() - Constructor for class org.passay.dictionary.sort.BubbleSort

buffer() - Method in class org.passay.dictionary.AbstractFileWordList

Returns the buffer providing the backing file data.

buffer() - Method in class org.passay.dictionary.FileWordList

buffer() - Method in class org.passay.dictionary.MemoryMappedFileWordList

build() - Method in class org.passay.dictionary.DictionaryBuilder

Builds a dictionary from the configured properties.

C

CASE_INSENSITIVE_COMPARATOR - Static variable in class org.passay.dictionary.TernaryTree

Case insensitive comparator.

CASE_INSENSITIVE_COMPARATOR - Static variable in class org.passay.dictionary.WordLists

Case insensitive comparator.

CASE_SENSITIVE_COMPARATOR - Static variable in class org.passay.dictionary.TernaryTree

Case sensitive comparator.

CASE_SENSITIVE_COMPARATOR - Static variable in class org.passay.dictionary.WordLists

Case sensitive comparator.

CharacterCharacteristicsRule - Class in org.passay

Rule for determining if a password contains the desired mix of character types.

CharacterCharacteristicsRule() - Constructor for class org.passay.CharacterCharacteristicsRule

Default constructor.

CharacterCharacteristicsRule(CharacterRule...) - Constructor for class org.passay.CharacterCharacteristicsRule

Creates a new character characteristics rule.

CharacterCharacteristicsRule(List<CharacterRule>) - Constructor for class org.passay.CharacterCharacteristicsRule

Creates a new character characteristics rule.

CharacterCharacteristicsRule(int, CharacterRule...) - Constructor for class org.passay.CharacterCharacteristicsRule

Creates a new character characteristics rule.

CharacterCharacteristicsRule(int, List<CharacterRule>) - Constructor for class org.passay.CharacterCharacteristicsRule

Creates a new character characteristics rule.

CharacterData - Interface in org.passay

Input data used by CharacterRule.

characterData - Variable in class org.passay.CharacterRule

Character data for this rule.

CharacterOccurrencesRule - Class in org.passay

Validates that a password does not contain too many occurrences of the same character.

CharacterOccurrencesRule(int) - Constructor for class org.passay.CharacterOccurrencesRule

Creates a new character occurrences rule.

CharacterRule - Class in org.passay

Validates whether a password contains a certain number of a type of character.

CharacterRule(CharacterData) - Constructor for class org.passay.CharacterRule

Creates a new character rule.

CharacterRule(CharacterData, int) - Constructor for class org.passay.CharacterRule

Creates a new character rule.

CharacterSequence - Class in org.passay

Models a sequence of characters in one or more forms as strings of equal length where each string represents one form of characters in the sequence.

CharacterSequence(String...) - Constructor for class org.passay.CharacterSequence

Creates a new instance from one or more sequences.

CHARS - Static variable in class org.passay.WhitespaceRule

Characters: TAB,LF,VT,FF,CR,Space.

checkIsString(Object) - Method in class org.passay.dictionary.AbstractWordList

Deprecated.

this method is no longer used and will be removed in a future release

checkRange(int) - Method in class org.passay.dictionary.AbstractWordList

Throws an IndexOutOfBoundsException if the supplied index is less than 0 or greater than or equal to the size of this word list.

close() - Method in class org.passay.dictionary.AbstractFileWordList

Closes the underlying file and make the cache available for garbage collection.

comparator - Variable in class org.passay.dictionary.AbstractWordList

Word comparator.

comparator - Variable in class org.passay.dictionary.TernaryTree

Character comparator.

concatArrays(char[], char[]...) - Static method in class org.passay.PasswordUtils

Concatenates multiple character arrays together.

countMatchingCharacters(String, String) - Static method in class org.passay.PasswordUtils

Returns the number of characters in the supplied input that existing from the supplied characters string.

counts - Variable in class org.passay.RuleResultMetadata

Character count metadata.

createEntropy(List<? extends Rule>, PasswordData) - Static method in class org.passay.entropy.RandomPasswordEntropyFactory

Creates a new random password entropy.

createEntropy(List<? extends Rule>, PasswordData) - Static method in class org.passay.entropy.ShannonEntropyFactory

Creates a new shannon entropy.

createEntropy(boolean, PasswordData) - Static method in class org.passay.entropy.ShannonEntropyFactory

Creates a new shannon entropy.

createFromReader(Reader[]) - Static method in class org.passay.dictionary.WordLists

Creates a case-sensitive ArrayWordList by reading the contents of the given readers.

createFromReader(Reader[], boolean) - Static method in class org.passay.dictionary.WordLists

Creates an ArrayWordList by reading the contents of the given readers.

createFromReader(Reader[], boolean, ArraySorter) - Static method in class org.passay.dictionary.WordLists

Creates an ArrayWordList by reading the contents of the given file with support for sorting file contents.

createRuleResultDetailParameters(String) - Method in class org.passay.AbstractDictionaryRule

Creates the parameter data for the rule result detail.

createRuleResultDetailParameters(char) - Method in class org.passay.AllowedCharacterRule

Creates the parameter data for the rule result detail.

createRuleResultDetailParameters() - Method in class org.passay.AllowedRegexRule

Creates the parameter data for the rule result detail.

createRuleResultDetailParameters(int) - Method in class org.passay.CharacterCharacteristicsRule

Creates the parameter data for the rule result detail.

createRuleResultDetailParameters(char, int) - Method in class org.passay.CharacterOccurrencesRule

Creates the parameter data for the rule result detail.

createRuleResultDetailParameters(String) - Method in class org.passay.CharacterRule

Creates the parameter data for the rule result detail.

createRuleResultDetailParameters(int) - Method in class org.passay.HistoryRule

Creates the parameter data for the rule result detail.

createRuleResultDetailParameters(char) - Method in class org.passay.IllegalCharacterRule

Creates the parameter data for the rule result detail.

createRuleResultDetailParameters(String) - Method in class org.passay.IllegalRegexRule

Creates the parameter data for the rule result detail.

createRuleResultDetailParameters(int, int, int) - Method in class org.passay.LengthComplexityRule

Creates the parameter data for the rule result detail.

createRuleResultDetailParameters() - Method in class org.passay.LengthRule

Creates the parameter data for the rule result detail.

createRuleResultDetailParameters(int) - Method in class org.passay.NumberRangeRule

Creates the parameter data for the rule result detail.

createRuleResultDetailParameters(List<String>) - Method in class org.passay.RepeatCharactersRule

Creates the parameter data for the rule result detail.

createRuleResultDetailParameters(String) - Method in class org.passay.SourceRule

Creates the parameter data for the rule result detail.

createRuleResultDetailParameters(String) - Method in class org.passay.UsernameRule

Creates the parameter data for the rule result detail.

createRuleResultDetailParameters(char) - Method in class org.passay.WhitespaceRule

Creates the parameter data for the rule result detail.

createRuleResultMetadata(PasswordData) - Method in class org.passay.AllowedCharacterRule

Creates the rule result metadata.

createRuleResultMetadata(PasswordData) - Method in class org.passay.CharacterRule

Creates the rule result metadata.

createRuleResultMetadata(PasswordData) - Method in class org.passay.IllegalCharacterRule

Creates the rule result metadata.

createRuleResultMetadata(PasswordData) - Method in class org.passay.LengthRule

Creates the rule result metadata.

createRuleResultMetadata(PasswordData) - Method in class org.passay.WhitespaceRule

Creates the rule result metadata.

CyrillicCharacterData - Enum in org.passay

Cyrillic character data.

CyrillicModernCharacterData - Enum in org.passay

Cyrillic character data.

CyrillicModernSequenceData - Enum in org.passay

Cyrillic character sequence.

CyrillicSequenceData - Enum in org.passay

Cyrillic character sequence.

CzechCharacterData - Enum in org.passay

Czech character data.

CzechSequenceData - Enum in org.passay

Czech character sequence.

D

dataSource - Variable in class org.passay.dictionary.JDBCDictionary

JDBC data source.

DEFAULT_CACHE_PERCENT - Static variable in class org.passay.dictionary.AbstractFileWordList

Default cache percent.

DEFAULT_MESSAGE_PATH - Static variable in class org.passay.PropertiesMessageResolver

Classpath location of default message map.

DEFAULT_SEQUENCE_COUNT - Static variable in class org.passay.RepeatCharactersRule

Default number of sequences, value is 1.

DEFAULT_SEQUENCE_LENGTH - Static variable in class org.passay.IllegalSequenceRule

Default length of keyboard sequence, value is 5.

DEFAULT_SEQUENCE_LENGTH - Static variable in class org.passay.RepeatCharacterRegexRule

Default length of sequence, value is 5.

DEFAULT_SEQUENCE_LENGTH - Static variable in class org.passay.RepeatCharactersRule

Default length of sequence, value is 5.

details - Variable in class org.passay.RuleResult

Details associated with a password rule result.

Dictionary - Interface in org.passay.dictionary

Base interface for all dictionaries.

DictionaryBuilder - Class in org.passay.dictionary

Builder for common dictionary usage.

DictionaryBuilder() - Constructor for class org.passay.dictionary.DictionaryBuilder

DictionaryRule - Class in org.passay

Rule for determining if a password matches a dictionary word.

DictionaryRule() - Constructor for class org.passay.DictionaryRule

Creates a new dictionary rule without supplying a dictionary.

DictionaryRule(Dictionary) - Constructor for class org.passay.DictionaryRule

Creates a new dictionary rule.

DictionarySubstringRule - Class in org.passay

Rule for determining if a password contains a dictionary word with optional checking for reversed words.

DictionarySubstringRule() - Constructor for class org.passay.DictionarySubstringRule

Creates a new dictionary substring rule.

DictionarySubstringRule(Dictionary) - Constructor for class org.passay.DictionarySubstringRule

Creates a new dictionary substring rule.

DigestDictionaryRule - Class in org.passay

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

DigestDictionaryRule(HashBean<String>, Dictionary) - Constructor for class org.passay.DigestDictionaryRule

Creates new digest history rule which operates on password references that were digested with the supplied hash.

DigestDictionaryRule(HashBean<String>) - Constructor for class org.passay.DigestDictionaryRule

Creates new digest history rule which operates on password references that were digested with the supplied hash.

DigestHistoryRule - Class in org.passay

Rule for determining if a password matches one of any previous digested password a user has chosen.

DigestHistoryRule(HashBean<String>) - Constructor for class org.passay.DigestHistoryRule

Creates new digest history rule which operates on password references that were digested with the supplied hash.

DigestSourceRule - Class in org.passay

Rule for determining if a password matches a digested password from a different source.

DigestSourceRule(HashBean<String>) - Constructor for class org.passay.DigestSourceRule

Creates new digest source rule which operates on password references with the supplied label.

doWordSearch(String) - Method in class org.passay.AbstractDictionaryRule

Searches the dictionary with the supplied text.

doWordSearch(String) - Method in class org.passay.DictionaryRule

doWordSearch(String) - Method in class org.passay.DictionarySubstringRule

doWordSearch(String) - Method in class org.passay.DigestDictionaryRule

E

EnglishCharacterData - Enum in org.passay

English language character data.

EnglishSequenceData - Enum in org.passay

English character sequences.

Entropy - Interface in org.passay.entropy

Interface for entropy estimates.

ERROR_CODE - Static variable in class org.passay.AllowedCharacterRule

Error code for allowed character failures.

ERROR_CODE - Static variable in class org.passay.AllowedRegexRule

Error code for regex validation failures.

ERROR_CODE - Static variable in class org.passay.CharacterCharacteristicsRule

Error code for insufficient number of characteristics.

ERROR_CODE - Static variable in class org.passay.CharacterOccurrencesRule

Error code for too many occurrences of a character.

ERROR_CODE - Static variable in class org.passay.DictionaryRule

Error code for matching dictionary word.

ERROR_CODE - Static variable in class org.passay.DictionarySubstringRule

Error code for matching dictionary word.

ERROR_CODE - Static variable in class org.passay.DigestDictionaryRule

Error code for matching dictionary word.

ERROR_CODE - Static variable in class org.passay.HaveIBeenPwnedRule

Error code for exposed passwords.

ERROR_CODE - Static variable in class org.passay.HistoryRule

Error code for history violation.

ERROR_CODE - Static variable in class org.passay.IllegalCharacterRule

Error code for illegal character failures.

ERROR_CODE - Static variable in class org.passay.IllegalRegexRule

Error code for regex validation failures.

ERROR_CODE - Static variable in class org.passay.LengthComplexityRule

Error code for insufficient complexity.

ERROR_CODE - Static variable in class org.passay.NumberRangeRule

Error code for whitespace rule violation.

ERROR_CODE - Static variable in class org.passay.RepeatCharactersRule

Error code for regex validation failures.

ERROR_CODE - Static variable in class org.passay.SourceRule

Error code for regex validation failures.

ERROR_CODE - Static variable in class org.passay.UsernameRule

Error code for matching username.

ERROR_CODE - Static variable in class org.passay.WhitespaceRule

Error code for whitespace rule violation.

ERROR_CODE_MAX - Static variable in class org.passay.LengthRule

Error code for password too long.

ERROR_CODE_MIN - Static variable in class org.passay.LengthRule

Error code for password too short.

ERROR_CODE_REVERSED - Static variable in class org.passay.DictionaryRule

Error code for matching reversed dictionary word.

ERROR_CODE_REVERSED - Static variable in class org.passay.DictionarySubstringRule

Error code for matching reversed dictionary word.

ERROR_CODE_REVERSED - Static variable in class org.passay.DigestDictionaryRule

Error code for matching reversed dictionary word.

ERROR_CODE_REVERSED - Static variable in class org.passay.UsernameRule

Error code for matching reversed dictionary word.

ERROR_CODE_RULES - Static variable in class org.passay.LengthComplexityRule

Error code for missing complexity rules.

errorCodes - Variable in class org.passay.RuleResultDetail

Detail error codes.

estimate() - Method in interface org.passay.entropy.Entropy

Returns the estimated entropy bits of a password.

estimate() - Method in class org.passay.entropy.RandomPasswordEntropy

Returns the entropy bits of a randomly generated password given the size of the unique characters used (alphabetSize) and the size of the password.

estimate() - Method in class org.passay.entropy.ShannonEntropy

Returns the entropy bits of a user selected password.

estimateEntropy(PasswordData) - Method in class org.passay.PasswordValidator

Calculates the entropy of the given PasswordData based on the specified password rules specified.

executeStatement(String, Class<T>, Object...) - Method in class org.passay.dictionary.JDBCDictionary

Executes a prepared statement against the database.

exists(String) - Static method in enum org.passay.RuleResultMetadata.CountCategory

Deprecated.

use the standard RuleResultMetadata.CountCategory.valueOf(String) instead

F

file - Variable in class org.passay.dictionary.AbstractFileWordList

File containing words.

FileWordList - Class in org.passay.dictionary

Provides an implementation of a WordList that is backed by a file.

FileWordList(RandomAccessFile) - Constructor for class org.passay.dictionary.FileWordList

Creates a new case-sensitive word list from the supplied file.

FileWordList(RandomAccessFile, boolean) - Constructor for class org.passay.dictionary.FileWordList

Creates a new word list from the supplied file.

FileWordList(RandomAccessFile, boolean, int) - Constructor for class org.passay.dictionary.FileWordList

Creates a new word list from the supplied file.

FileWordList(RandomAccessFile, boolean, int, CharsetDecoder) - Constructor for class org.passay.dictionary.FileWordList

Creates a new word list from the supplied file.

FileWordList(RandomAccessFile, boolean, int, CharsetDecoder, boolean) - Constructor for class org.passay.dictionary.FileWordList

Creates a new word list from the supplied file.

fill() - Method in class org.passay.dictionary.AbstractFileWordList

Fills the buffer from the backing file.

fill() - Method in class org.passay.dictionary.FileWordList

fill() - Method in class org.passay.dictionary.MemoryMappedFileWordList

fillRandomCharacters(CharSequence, int, Appendable) - Method in class org.passay.PasswordGenerator

Fills the supplied target with count random characters from source.

FIRST_PHASE_BONUS - Static variable in class org.passay.entropy.ShannonEntropy

Entropy bonus of the first phase.

FIRST_PHASE_LENGTH - Static variable in class org.passay.entropy.ShannonEntropy

Length of the first phase.

G

generatePassword(int, CharacterRule...) - Method in class org.passay.PasswordGenerator

Deprecated.

use PasswordGenerator.generatePassword(int, Rule[])

generatePassword(int, T...) - Method in class org.passay.PasswordGenerator

See PasswordGenerator.generatePassword(int, List).

generatePassword(int, List<? extends Rule>) - Method in class org.passay.PasswordGenerator

Generates a password of the supplied length which meets the requirements of the supplied character rules.

GermanCharacterData - Enum in org.passay

german character data.

GermanSequenceData - Enum in org.passay

german character sequence.

get(int) - Method in class org.passay.dictionary.AbstractFileWordList

get(int) - Method in class org.passay.dictionary.ArrayWordList

get(int) - Method in interface org.passay.dictionary.WordList

Returns the word at the given 0-based index.

getAllowedCharacters() - Method in class org.passay.AllowedCharacterRule

Returns the allowed characters for this rule.

getBloomFilter() - Method in class org.passay.dictionary.BloomFilterDictionary

Returns the bloom filter used for searching.

getCharacterData() - Method in class org.passay.CharacterRule

Returns the character data for this rule.

getCharacters() - Method in interface org.passay.CharacterData

Returns the characters.

getCharacters() - Method in enum org.passay.CyrillicCharacterData

getCharacters() - Method in enum org.passay.CyrillicModernCharacterData

getCharacters() - Method in enum org.passay.CzechCharacterData

getCharacters() - Method in enum org.passay.EnglishCharacterData

getCharacters() - Method in enum org.passay.GermanCharacterData

getCharacters() - Method in enum org.passay.PolishCharacterData

getComparator() - Method in class org.passay.dictionary.AbstractWordList

getComparator() - Method in interface org.passay.dictionary.WordList

Returns the comparator that should be used to compare a search term with candidate words in the list.

getConnection() - Method in class org.passay.dictionary.JDBCDictionary

Returns a connection that is ready for use.

getCount(RuleResultMetadata.CountCategory) - Method in class org.passay.RuleResultMetadata

Returns the count for the supplied category.

getCounts() - Method in class org.passay.RuleResultMetadata

Returns an unmodifiable map of all count metadata.

getDefaultBundle() - Static method in class org.passay.ResourceBundleMessageResolver

Returns the default resource bundle which is found in passay.properties.

getDefaultProperties() - Static method in class org.passay.PropertiesMessageResolver

Returns the default mapping of message keys to message strings.

getDetails() - Method in class org.passay.RuleResult

Returns any details associated with the rule verification.

getDictionary() - Method in class org.passay.AbstractDictionaryRule

Returns the dictionary used to search for passwords.

getEqkid() - Method in class org.passay.dictionary.TernaryNode

Returns the eqkid node in relation to this node.

getErrorCode(boolean) - Method in class org.passay.AbstractDictionaryRule

Returns the error code for this rule.

getErrorCode() - Method in interface org.passay.CharacterData

Return the error code used for message resolution.

getErrorCode() - Method in enum org.passay.CyrillicCharacterData

getErrorCode() - Method in enum org.passay.CyrillicModernCharacterData

getErrorCode() - Method in enum org.passay.CyrillicModernSequenceData

getErrorCode() - Method in enum org.passay.CyrillicSequenceData

getErrorCode() - Method in enum org.passay.CzechCharacterData

getErrorCode() - Method in enum org.passay.CzechSequenceData

getErrorCode(boolean) - Method in class org.passay.DictionaryRule

getErrorCode(boolean) - Method in class org.passay.DictionarySubstringRule

getErrorCode(boolean) - Method in class org.passay.DigestDictionaryRule

getErrorCode() - Method in enum org.passay.EnglishCharacterData

getErrorCode() - Method in enum org.passay.EnglishSequenceData

getErrorCode() - Method in enum org.passay.GermanCharacterData

getErrorCode() - Method in enum org.passay.GermanSequenceData

getErrorCode() - Method in enum org.passay.PolishCharacterData

getErrorCode() - Method in enum org.passay.PolishSequenceData

getErrorCode() - Method in class org.passay.RuleResultDetail

Returns the least-specific error code.

getErrorCode() - Method in interface org.passay.SequenceData

Return the error code used for message resolution.

getErrorCodes() - Method in class org.passay.RuleResultDetail

Returns an array of error codes as provided at creation time.

getFile() - Method in class org.passay.dictionary.AbstractFileWordList

Returns the file backing this list.

getForms() - Method in class org.passay.CharacterSequence

getHikid() - Method in class org.passay.dictionary.TernaryNode

Returns the hikid node in relation to this node.

getIllegalCharacters() - Method in class org.passay.IllegalCharacterRule

Returns the illegal characters for this rule.

getLabel() - Method in class org.passay.PasswordData.AbstractReference

Returns the label.

getLocale() - Method in class org.passay.AbstractMessageResolver

Returns the locale used by this message resolver.

getLokid() - Method in class org.passay.dictionary.TernaryNode

Returns the lokid node in relation to this node.

getLowerRange() - Method in class org.passay.NumberRangeRule

Returns the lower range for this rule.

getMatchBehavior() - Method in class org.passay.AllowedCharacterRule

Returns the match behavior for this rule.

getMatchBehavior() - Method in class org.passay.IllegalCharacterRule

Returns the match behavior for this rule.

getMatchBehavior() - Method in class org.passay.NumberRangeRule

Returns the match behavior for this rule.

getMatchBehavior() - Method in class org.passay.WhitespaceRule

Returns the match behavior for this rule.

getMatchingCharacters(String, String) - Static method in class org.passay.PasswordUtils

Returns all the characters in the input string that are also in the characters array.

getMatchingCharacters(String, String, int) - Static method in class org.passay.PasswordUtils

Returns all the characters in the input string that are also in the characters string.

getMaximumLength() - Method in class org.passay.LengthRule

Returns the maximum password length.

getMessage(String) - Method in class org.passay.AbstractMessageResolver

Returns the message for the supplied key.

getMessage(String) - Method in class org.passay.PropertiesMessageResolver

getMessage(String) - Method in class org.passay.ResourceBundleMessageResolver

getMessageResolver() - Method in class org.passay.PasswordValidator

Returns the message resolver for this validator.

getMessages(RuleResult) - Method in class org.passay.PasswordValidator

Returns a list of human-readable messages by iterating over the details in a failed rule result.

getMetadata() - Method in class org.passay.RuleResult

Returns metadata associated with the rule verification.

getMinimumLength() - Method in class org.passay.LengthRule

Returns the minimum password length.

getNodeStats() - Method in class org.passay.dictionary.TernaryTree

Returns a histogram of how many words end at each depth.

getNumberOfCharacteristics() - Method in class org.passay.CharacterCharacteristicsRule

Returns the number of characteristics which currently must be satisfied in order for a password to meet the requirements of this rule.

getNumberOfCharacters() - Method in class org.passay.CharacterRule

Returns the number of characters which must exist in order for a password to meet the requirements of this rule.

getOrigin() - Method in class org.passay.PasswordData

Returns the origin.

getParameters() - Method in class org.passay.RuleResultDetail

Returns the parameters.

getPassword() - Method in class org.passay.PasswordData.AbstractReference

getPassword() - Method in class org.passay.PasswordData

Returns the password.

getPassword() - Method in interface org.passay.PasswordData.Reference

Returns the password associated with this reference.

getPasswordReferences() - Method in class org.passay.PasswordData

Returns the password references.

getPasswordReferences(Class<T>) - Method in class org.passay.PasswordData

Returns the password references that match the supplied reference type.

getPattern() - Method in class org.passay.AllowedRegexRule

Returns the pattern for this rule.

getPattern() - Method in class org.passay.IllegalRegexRule

Returns the pattern for this rule.

getReportFailure() - Method in class org.passay.CharacterCharacteristicsRule

Returns whether to add the rule result detail of this rule to the rule result.

getReportFailure() - Method in class org.passay.LengthComplexityRule

Returns whether to add the rule result detail of this rule to the rule result.

getReportRuleFailures() - Method in class org.passay.CharacterCharacteristicsRule

Returns whether to add the rule result detail for each character rule that fails to validate to the rule result.

getReportRuleFailures() - Method in class org.passay.LengthComplexityRule

Returns whether to add the rule result detail for each rule that fails to validate to the rule result.

getRetryCount() - Method in class org.passay.PasswordGenerator

Tracks the number retries.

getRules() - Method in class org.passay.CharacterCharacteristicsRule

Returns the character rules used by this rule.

getRules() - Method in class org.passay.LengthComplexityRule

Returns the password rules for this complexity rule.

getRules() - Method in class org.passay.PasswordValidator

Returns the password rules for this validator.

getSalt() - Method in class org.passay.PasswordData.AbstractReference

getSalt() - Method in interface org.passay.PasswordData.Reference

Returns the salt that was applied to the reference password before digesting it.

getSequenceData() - Method in class org.passay.IllegalSequenceRule

Returns the sequence data for this rule.

getSequenceLength() - Method in class org.passay.IllegalSequenceRule

Returns the sequence length for this rule.

getSequenceLength() - Method in class org.passay.RepeatCharacterRegexRule

Returns the sequence length for this rule.

getSequences() - Method in enum org.passay.CyrillicModernSequenceData

getSequences() - Method in enum org.passay.CyrillicSequenceData

getSequences() - Method in enum org.passay.CzechSequenceData

getSequences() - Method in enum org.passay.EnglishSequenceData

getSequences() - Method in enum org.passay.GermanSequenceData

getSequences() - Method in enum org.passay.PolishSequenceData

getSequences() - Method in interface org.passay.SequenceData

getSplitChar() - Method in class org.passay.dictionary.TernaryNode

Returns the split character.

getTernaryTree() - Method in class org.passay.dictionary.TernaryTreeDictionary

Returns the underlying ternary tree used by this dictionary.

getUpperRange() - Method in class org.passay.NumberRangeRule

Returns the upper range for this rule.

getUsername() - Method in class org.passay.PasswordData

Returns the username.

getValidCharacters() - Method in class org.passay.CharacterRule

Returns the characters that are considered valid for this rule.

getValues() - Method in class org.passay.RuleResultDetail

Returns the parameter values.

getWhitespaceCharacters() - Method in class org.passay.WhitespaceRule

Returns the whitespace characters for this rule.

getWordList() - Method in class org.passay.dictionary.WordListDictionary

Returns the word list used for searching.

getWords() - Method in class org.passay.dictionary.TernaryTree

Returns a list of all the words in this ternary tree.

H

hasCount(RuleResultMetadata.CountCategory) - Method in class org.passay.RuleResultMetadata

Returns whether a count exists for the supplied category.

HaveIBeenPwnedRule - Class in org.passay

Validates the password against the online database of haveibeenpwned.com optionally allowing the usage of found passwords, but returns the number of found matches in the metadata.

HaveIBeenPwnedRule(String) - Constructor for class org.passay.HaveIBeenPwnedRule

Create the rule, appName is required by the API.

HaveIBeenPwnedRule(String, String) - Constructor for class org.passay.HaveIBeenPwnedRule

Create the rule, appName is required by the API.

HistoricalReference(String) - Constructor for class org.passay.PasswordData.HistoricalReference

Creates a new historical reference.

HistoricalReference(String, String) - Constructor for class org.passay.PasswordData.HistoricalReference

Creates a new historical reference.

HistoricalReference(String, String, PasswordData.Salt) - Constructor for class org.passay.PasswordData.HistoricalReference

Creates a new historical reference.

HistoryRule - Class in org.passay

Rule for determining if a password matches one of any previous password a user has chosen.

HistoryRule() - Constructor for class org.passay.HistoryRule

Creates a new history rule.

HistoryRule(boolean) - Constructor for class org.passay.HistoryRule

Creates a new history rule.

I

IllegalCharacterRule - Class in org.passay

Rule for determining if a password contains an illegal character.

IllegalCharacterRule(char[]) - Constructor for class org.passay.IllegalCharacterRule

Create a new illegal character rule.

IllegalCharacterRule(char[], MatchBehavior) - Constructor for class org.passay.IllegalCharacterRule

Create a new illegal character rule.

IllegalCharacterRule(char[], boolean) - Constructor for class org.passay.IllegalCharacterRule

Create a new illegal character rule.

IllegalCharacterRule(char[], MatchBehavior, boolean) - Constructor for class org.passay.IllegalCharacterRule

Create a new illegal character rule.

IllegalRegexRule - Class in org.passay

Rule for determining if a password matches an illegal regular expression.

IllegalRegexRule(String) - Constructor for class org.passay.IllegalRegexRule

Creates a new illegal regex rule.

IllegalRegexRule(String, int) - Constructor for class org.passay.IllegalRegexRule

Creates a new illegal regex rule.

IllegalRegexRule(String, boolean) - Constructor for class org.passay.IllegalRegexRule

Creates a new illegal regex rule.

IllegalRegexRule(String, int, boolean) - Constructor for class org.passay.IllegalRegexRule

Creates a new illegal regex rule.

IllegalSequenceRule - Class in org.passay

Password validation rule that prevents illegal sequences of characters, e.g. keyboard, alphabetical, numeric.

IllegalSequenceRule(SequenceData) - Constructor for class org.passay.IllegalSequenceRule

Creates a new sequence rule with the supplied list of characters.

IllegalSequenceRule(SequenceData, int, boolean) - Constructor for class org.passay.IllegalSequenceRule

Creates a new sequence rule with the supplied list of characters.

IllegalSequenceRule(SequenceData, int, boolean, boolean) - Constructor for class org.passay.IllegalSequenceRule

Creates a new sequence rule with the supplied list of characters.

includes(int) - Method in class org.passay.LengthComplexityRule.Interval

Returns whether this interval includes the supplied integer.

initialize(int, boolean) - Method in class org.passay.dictionary.AbstractFileWordList

Reads words from the backing file to initialize the word list.

insert(String) - Method in class org.passay.dictionary.TernaryTree

Inserts the supplied word into this tree.

insert(String[]) - Method in class org.passay.dictionary.TernaryTree

Inserts the supplied array of words into this tree.

InsertionSort - Class in org.passay.dictionary.sort

Provides an implementation of the insertion sort algorithm.

InsertionSort() - Constructor for class org.passay.dictionary.sort.InsertionSort

intersects(LengthComplexityRule.Interval) - Method in class org.passay.LengthComplexityRule.Interval

Returns whether this interval intersects the supplied interval.

IO_ERROR_CODE - Static variable in class org.passay.HaveIBeenPwnedRule

Error code for API IO errors.

isEndOfWord() - Method in class org.passay.dictionary.TernaryNode

Returns whether this node is at the end of a word.

isIgnoreCase() - Method in class org.passay.UsernameRule

Returns whether to ignore the case of the username.

isMatchBackwards() - Method in class org.passay.AbstractDictionaryRule

Returns true if the verify method will search the password for dictionary words spelled backwards as well as forwards.

isMatchBackwards() - Method in class org.passay.UsernameRule

Returns whether to match the username backwards.

isValid() - Method in class org.passay.RuleResult

Returns whether the result of the rule verification is a valid password.

iterator() - Method in class org.passay.dictionary.AbstractWordList

iterator() - Method in interface org.passay.dictionary.WordList

Returns an iterator to traverse this word list from the 0th index.

J

JDBCDictionary - Class in org.passay.dictionary

Provides a Dictionary backed by a database table.

JDBCDictionary(DataSource, String, String) - Constructor for class org.passay.dictionary.JDBCDictionary

Creates a new JDBC dictionary.

L

length() - Method in class org.passay.CharacterSequence

LengthComplexityRule - Class in org.passay

Rule for determining if a password contains the desired complexity for a certain length.

LengthComplexityRule() - Constructor for class org.passay.LengthComplexityRule

LengthComplexityRule.Interval - Class in org.passay

Class that represents an interval of numbers and parses interval notation.

LengthRule - Class in org.passay

Rule for determining if a password is within a desired length.

LengthRule() - Constructor for class org.passay.LengthRule

Creates a new length rule with lengths unset.

LengthRule(int) - Constructor for class org.passay.LengthRule

Creates a new length rule with the supplied length.

LengthRule(int, int) - Constructor for class org.passay.LengthRule

Create a new length rule.

log2(double) - Static method in class org.passay.entropy.RandomPasswordEntropy

Returns the log base 2 of a given number.

M

main(String[]) - Static method in class org.passay.dictionary.TernaryTreeDictionary

Provides command line access to a ternary tree dictionary.

main(String[]) - Static method in class org.passay.dictionary.WordListDictionary

Provides command line access to this word list dictionary.

main(String[]) - Static method in class org.passay.PasswordCli

Provides command line access to password rules.

match(String, char) - Method in enum org.passay.MatchBehavior

Returns whether text matches the supplied string for this match type.

match(String, String) - Method in enum org.passay.MatchBehavior

Returns whether text matches the supplied string for this match type.

MatchBehavior - Enum in org.passay

Enum that defines how string matching should occur.

matches(int, char) - Method in class org.passay.CharacterSequence

Determines whether the character at the given index of the sequence matches the given value.

matches(String, PasswordData.Reference) - Method in class org.passay.DigestHistoryRule

Determines whether a digested password matches a reference value.

matches(String, PasswordData.Reference) - Method in class org.passay.DigestSourceRule

Determines whether a digested password matches a reference value.

matches(String, PasswordData.Reference) - Method in class org.passay.HistoryRule

Determines whether a password matches an historical password.

matches(String, PasswordData.Reference) - Method in class org.passay.SourceRule

Determines whether a password matches a source password.

maxOccurrences - Variable in class org.passay.CharacterOccurrencesRule

Maximum umber of occurrences to allow.

medianIterator() - Method in class org.passay.dictionary.AbstractWordList

medianIterator() - Method in interface org.passay.dictionary.WordList

Returns an iterator to traverse this word list by following a recursive sequence of medians.

MemoryMappedFileWordList - Class in org.passay.dictionary

Provides an implementation of a WordList that is backed by a file and leverages a MappedByteBuffer.

MemoryMappedFileWordList(RandomAccessFile) - Constructor for class org.passay.dictionary.MemoryMappedFileWordList

Creates a new case-sensitive word list from the supplied file.

MemoryMappedFileWordList(RandomAccessFile, boolean) - Constructor for class org.passay.dictionary.MemoryMappedFileWordList

Creates a new word list from the supplied file.

MemoryMappedFileWordList(RandomAccessFile, boolean, int) - Constructor for class org.passay.dictionary.MemoryMappedFileWordList

Creates a new word list from the supplied file.

MemoryMappedFileWordList(RandomAccessFile, boolean, int, CharsetDecoder) - Constructor for class org.passay.dictionary.MemoryMappedFileWordList

Creates a new word list from the supplied file.

MemoryMappedFileWordList(RandomAccessFile, boolean, int, CharsetDecoder, boolean) - Constructor for class org.passay.dictionary.MemoryMappedFileWordList

Creates a new word list from the supplied file.

merge(RuleResultMetadata) - Method in class org.passay.RuleResultMetadata

Merges the supplied metadata with this metadata.

MessageResolver - Interface in org.passay

Strategy pattern interface for resolving messages from password validation failures described by a RuleResultDetail object.

metadata - Variable in class org.passay.RuleResult

Metadata produced by a password rule.

MINIMUM_SEQUENCE_LENGTH - Static variable in class org.passay.IllegalSequenceRule

Minimum length of keyboard sequence, value is 3.

MINIMUM_SEQUENCE_LENGTH - Static variable in class org.passay.RepeatCharacterRegexRule

Minimum length of sequence, value is 3.

N

nearSearch(String, int) - Method in class org.passay.dictionary.TernaryTree

Return an array of strings which are near to the supplied word by the supplied distance.

nearSearch(String, int) - Method in class org.passay.dictionary.TernaryTreeDictionary

Returns an array of strings which are near to the supplied word by the supplied distance.

newPasswordData(PasswordData) - Static method in class org.passay.PasswordData

Returns a password data initialized with the supplied data.

NOT_FOUND - Static variable in class org.passay.dictionary.WordLists

Index returned when word not found by binary search.

NumberRangeRule - Class in org.passay

Rule for determining if a password contains any number within a defined range, lower inclusive, upper exclusive.

NumberRangeRule(int, int) - Constructor for class org.passay.NumberRangeRule

Creates a new number range rule.

NumberRangeRule(int, int, boolean) - Constructor for class org.passay.NumberRangeRule

Creates a new number range rule.

NumberRangeRule(int, int, MatchBehavior) - Constructor for class org.passay.NumberRangeRule

Creates a new number range rule.

NumberRangeRule(int, int, MatchBehavior, boolean) - Constructor for class org.passay.NumberRangeRule

Creates a new number range rule.

numCharacters - Variable in class org.passay.CharacterRule

Number of characters to require.

O

org.passay - package org.passay

org.passay.dictionary - package org.passay.dictionary

org.passay.dictionary.sort - package org.passay.dictionary.sort

org.passay.entropy - package org.passay.entropy

org.passay.spring - package org.passay.spring

P

parameters - Variable in class org.passay.RuleResultDetail

Additional parameters that provide information about validation failure.

partialSearch(String) - Method in class org.passay.dictionary.TernaryTree

Returns an array of strings which partially match the supplied word. word should be of the format '.e.e.e' Where the '.' character represents any valid character.

partialSearch(String) - Method in class org.passay.dictionary.TernaryTreeDictionary

Returns an array of strings which partially match the supplied word.

PasswordCli - Class in org.passay

Provides a simple command line interface to password validation.

PasswordData - Class in org.passay

Contains password related information used by rules to perform password validation.

PasswordData() - Constructor for class org.passay.PasswordData

Default constructor.

PasswordData(String) - Constructor for class org.passay.PasswordData

Creates a new password data.

PasswordData(String, String) - Constructor for class org.passay.PasswordData

Creates a new password data.

PasswordData(String, PasswordData.Origin) - Constructor for class org.passay.PasswordData

Creates a new password data.

PasswordData(String, String, PasswordData.Origin) - Constructor for class org.passay.PasswordData

Creates a new password data.

PasswordData(String, String, List<PasswordData.Reference>) - Constructor for class org.passay.PasswordData

Creates a new password data.

PasswordData.AbstractReference - Class in org.passay

Common password reference implementation.

PasswordData.HistoricalReference - Class in org.passay

Reference to an historical password.

PasswordData.Origin - Enum in org.passay

Enum to define the origin of a password.

PasswordData.PrefixSalt - Class in org.passay

A salt that is concatenated as a prefix to the password data.

PasswordData.Reference - Interface in org.passay

Reference to another password.

PasswordData.Salt - Interface in org.passay

Combines salt (additional external data) with a password before applying a digest algorithm to them.

PasswordData.SourceReference - Class in org.passay

Reference to a source password.

PasswordData.SuffixSalt - Class in org.passay

A salt that is concatenated as a suffix to the password data.

PasswordGenerator - Class in org.passay

Creates passwords that meet password character rule criteria.

PasswordGenerator() - Constructor for class org.passay.PasswordGenerator

Default constructor.

PasswordGenerator(Random) - Constructor for class org.passay.PasswordGenerator

Creates a new password generator with the supplied random.

PasswordUtils - Class in org.passay

Provides utility methods for this package.

PasswordValidator - Class in org.passay

The central component for evaluating multiple password rules against a candidate password.

PasswordValidator(Rule...) - Constructor for class org.passay.PasswordValidator

See PasswordValidator(List).

PasswordValidator(List<? extends Rule>) - Constructor for class org.passay.PasswordValidator

Creates a new password validator with a PropertiesMessageResolver.

PasswordValidator(MessageResolver, Rule...) - Constructor for class org.passay.PasswordValidator

See PasswordValidator(MessageResolver, List).

PasswordValidator(MessageResolver, List<? extends Rule>) - Constructor for class org.passay.PasswordValidator

Creates a new password validator.

pattern - Variable in class org.passay.AllowedRegexRule

Regex pattern.

pattern - Variable in class org.passay.IllegalRegexRule

Regex pattern.

PolishCharacterData - Enum in org.passay

Polish language character data.

PolishSequenceData - Enum in org.passay

Polish character sequences.

PrefixSalt(String) - Constructor for class org.passay.PasswordData.PrefixSalt

Creates a new salt with the given salt data.

print(Writer, boolean) - Method in class org.passay.dictionary.TernaryTree

Prints an ASCII representation of this ternary tree to the supplied writer.

print(Writer) - Method in class org.passay.dictionary.TernaryTree

Prints an ASCII representation of this ternary tree to the supplied writer.

PropertiesMessageResolver - Class in org.passay

Resolves messages from rule result details from a properties file.

PropertiesMessageResolver() - Constructor for class org.passay.PropertiesMessageResolver

Creates a new message resolver with the default message properties.

PropertiesMessageResolver(Properties) - Constructor for class org.passay.PropertiesMessageResolver

Creates a new message resolver with the supplied message properties.

putCount(RuleResultMetadata.CountCategory, int) - Method in class org.passay.RuleResultMetadata

Adds a count to the metadata.

Q

QuickSort - Class in org.passay.dictionary.sort

Provides an implementation of the quick sort algorithm.

QuickSort() - Constructor for class org.passay.dictionary.sort.QuickSort

R

randomize(CharBuffer) - Method in class org.passay.PasswordGenerator

Randomizes the contents of the given buffer.

RandomPasswordEntropy - Class in org.passay.entropy

Entropy bits estimate defined in NIST SP-800-63-1 Randomly Selected Passwords.

RandomPasswordEntropy(int, int) - Constructor for class org.passay.entropy.RandomPasswordEntropy

Creates a new random entropy estimate.

RandomPasswordEntropyFactory - Class in org.passay.entropy

Factory for creating RandomPasswordEntropy from password rules and password data.

readWord(int) - Method in class org.passay.dictionary.AbstractFileWordList

Reads the word from the file at the given index of the word list.

readWordList(Reader, List<String>) - Static method in class org.passay.dictionary.WordLists

Reads words, one per line, from a reader into the given word list.

readWords(Reader, List<String>) - Static method in class org.passay.dictionary.WordLists

Reads words, one per line, from a reader into the given word list.

readWords(InputStream, String, List<String>) - Static method in class org.passay.dictionary.WordLists

Reads words, one per line, from an input stream into the given word list.

readZippedWords(InputStream, String, String, List<String>) - Static method in class org.passay.dictionary.WordLists

Reads words, one per line, from an input stream into the given word list.

RepeatCharacterRegexRule - Class in org.passay

Rule for determining if a password contains a duplicate ASCII keyboard sequence.

RepeatCharacterRegexRule() - Constructor for class org.passay.RepeatCharacterRegexRule

Creates a new repeat character regex rule with the default sequence length.

RepeatCharacterRegexRule(int) - Constructor for class org.passay.RepeatCharacterRegexRule

Creates a new repeat character regex rule.

RepeatCharacterRegexRule(int, boolean) - Constructor for class org.passay.RepeatCharacterRegexRule

Creates a new repeat character regex rule.

RepeatCharactersRule - Class in org.passay

Rule for determining if a password contains multiple sequences of repeating characters.

RepeatCharactersRule() - Constructor for class org.passay.RepeatCharactersRule

Creates a new repeat characters rule for a single sequence of the default sequence length.

RepeatCharactersRule(int) - Constructor for class org.passay.RepeatCharactersRule

Creates a new repeat characters rule for a single sequence of the given length.

RepeatCharactersRule(int, int) - Constructor for class org.passay.RepeatCharactersRule

Creates a new repeat characters rule for the given number of sequences of the given length.

reportAllFailures - Variable in class org.passay.AllowedCharacterRule

Whether to report all sequence matches or just the first.

reportAllFailures - Variable in class org.passay.HistoryRule

Whether to report all history matches or just the first.

reportAllFailures - Variable in class org.passay.IllegalCharacterRule

Whether to report all sequence matches or just the first.

reportAllFailures - Variable in class org.passay.IllegalRegexRule

Whether to report all sequence matches or just the first.

reportAllFailures - Variable in class org.passay.IllegalSequenceRule

Whether to report all sequence matches or just the first.

reportAllFailures - Variable in class org.passay.NumberRangeRule

Whether to report all sequence matches or just the first.

reportAllFailures - Variable in class org.passay.SourceRule

Whether to report all source matches or just the first.

reportAllFailures - Variable in class org.passay.WhitespaceRule

Whether to report all whitespace matches or just the first.

resolve(RuleResultDetail) - Method in class org.passay.AbstractMessageResolver

resolve(RuleResultDetail) - Method in interface org.passay.MessageResolver

Resolves the message for the supplied rule result detail.

resolve(RuleResultDetail) - Method in class org.passay.spring.SpringMessageResolver

Resolves the message for the supplied rule result detail using Spring's MessageSource.

ResourceBundleMessageResolver - Class in org.passay

Resolves messages from rule result details from a resource bundle.

ResourceBundleMessageResolver() - Constructor for class org.passay.ResourceBundleMessageResolver

Creates a new message resolver with the default message map.

ResourceBundleMessageResolver(ResourceBundle) - Constructor for class org.passay.ResourceBundleMessageResolver

Creates a new message resolver with the supplied resource bundle.

Rule - Interface in org.passay

Interface for password strength rules.

RuleResult - Class in org.passay

Result of a password rule validation.

RuleResult() - Constructor for class org.passay.RuleResult

Creates a new rule result with its validity set to true.

RuleResult(boolean) - Constructor for class org.passay.RuleResult

Creates a new rule result.

RuleResult(boolean, RuleResultDetail) - Constructor for class org.passay.RuleResult

Creates a new rule result.

RuleResult(boolean, RuleResultMetadata) - Constructor for class org.passay.RuleResult

Creates a new rule result.

RuleResult(boolean, RuleResultDetail, RuleResultMetadata) - Constructor for class org.passay.RuleResult

Creates a new rule result.

RuleResultDetail - Class in org.passay

Describes an exact cause of a rule validation failure.

RuleResultDetail(String, Map<String, Object>) - Constructor for class org.passay.RuleResultDetail

Creates a new rule result detail.

RuleResultDetail(String[], Map<String, Object>) - Constructor for class org.passay.RuleResultDetail

Creates a new rule result detail.

RuleResultMetadata - Class in org.passay

Describes metadata relevant to the result of rule validation.

RuleResultMetadata() - Constructor for class org.passay.RuleResultMetadata

Creates a new rule result metadata.

RuleResultMetadata(RuleResultMetadata.CountCategory, int) - Constructor for class org.passay.RuleResultMetadata

Creates a new rule result metadata.

RuleResultMetadata.CountCategory - Enum in org.passay

Count category.

S

search(String) - Method in class org.passay.dictionary.BloomFilterDictionary

WARNING bloom filters may return true for a word that is NOT in the dictionary.

search(String) - Method in interface org.passay.dictionary.Dictionary

Returns whether the supplied word exists in the dictionary.

search(String) - Method in class org.passay.dictionary.JDBCDictionary

search(String) - Method in class org.passay.dictionary.TernaryTree

Returns whether the supplied word has been inserted into this ternary tree.

search(String) - Method in class org.passay.dictionary.TernaryTreeDictionary

search(String) - Method in class org.passay.dictionary.WordListDictionary

searchStatement - Variable in class org.passay.dictionary.JDBCDictionary

SQL search statement.

SECOND_PHASE_BONUS - Static variable in class org.passay.entropy.ShannonEntropy

Entropy bonus of the second phase.

SECOND_PHASE_LENGTH - Static variable in class org.passay.entropy.ShannonEntropy

Length of the second phase.

seek(long) - Method in class org.passay.dictionary.AbstractFileWordList

Positions the read head of the backing file at the given byte offset.

seek(long) - Method in class org.passay.dictionary.FileWordList

seek(long) - Method in class org.passay.dictionary.MemoryMappedFileWordList

SelectionSort - Class in org.passay.dictionary.sort

Provides an implementation of the selection sort algorithm.

SelectionSort() - Constructor for class org.passay.dictionary.sort.SelectionSort

sequenceCount - Variable in class org.passay.RepeatCharactersRule

Number of sequences of repeating characters to match.

sequenceData - Variable in class org.passay.IllegalSequenceRule

Sequence data for this rule.

SequenceData - Interface in org.passay

Container for one or more CharacterSequence.

sequenceLength - Variable in class org.passay.IllegalSequenceRule

Number of characters in sequence to match.

sequenceLength - Variable in class org.passay.RepeatCharacterRegexRule

Number of characters in sequence to match.

sequenceLength - Variable in class org.passay.RepeatCharactersRule

Number of repeating characters to match in each sequence.

setAllowExposed(boolean) - Method in class org.passay.HaveIBeenPwnedRule

Whether passwords found in the API should be considered valid.

setAllowOnException(boolean) - Method in class org.passay.HaveIBeenPwnedRule

If an exception occurs during accessing the api, the password will be allowed, if set to true.

setCaseSensitive(boolean) - Method in class org.passay.dictionary.DictionaryBuilder

Sets the case sensitivity flag on the dictionary to be built.

setCharset(Charset) - Method in class org.passay.DigestDictionaryRule

Sets the character set to use when converting a candidate password to bytes prior to hashing.

setCharset(Charset) - Method in class org.passay.DigestHistoryRule

Sets the character set to use for undigested passwords.

setCharset(Charset) - Method in class org.passay.DigestSourceRule

Sets the character set to use for undigested passwords.

setConnectTimeout(Duration) - Method in class org.passay.HaveIBeenPwnedRule

maximum Duration for connecting to the API.

setDetails(RuleResultDetail...) - Method in class org.passay.RuleResult

Sets any details associated with the rule verification.

setDetails(List<RuleResultDetail>) - Method in class org.passay.RuleResult

Sets any details associated with the rule verification.

setDictionary(Dictionary) - Method in class org.passay.AbstractDictionaryRule

Sets the dictionary used to search for passwords.

setEndOfWord(boolean) - Method in class org.passay.dictionary.TernaryNode

Sets whether this node is at the end of a word.

setEqkid(TernaryNode) - Method in class org.passay.dictionary.TernaryNode

Sets the eqkid node in relation to this node.

setHikid(TernaryNode) - Method in class org.passay.dictionary.TernaryNode

Sets the hikid node in relation to this node.

setIgnoreCase(boolean) - Method in class org.passay.UsernameRule

Sets whether the verify method will ignore case when searching the for a username.

setLocale(Locale) - Method in class org.passay.AbstractMessageResolver

Sets the locale used by this message resolver.

setLokid(TernaryNode) - Method in class org.passay.dictionary.TernaryNode

Sets the lokid node in relation to this node.

setMatchBackwards(boolean) - Method in class org.passay.AbstractDictionaryRule

This causes the verify method to search the password for dictionary words spelled backwards as well as forwards.

setMatchBackwards(boolean) - Method in class org.passay.UsernameRule

Sets whether the verify method will search the password for the username spelled backwards as well as forwards.

setMaximumLength(int) - Method in class org.passay.LengthRule

Sets the maximum password length.

setMetadata(RuleResultMetadata) - Method in class org.passay.RuleResult

Sets metadata associated with the rule verification.

setMinimumLength(int) - Method in class org.passay.LengthRule

Sets the minimum password length.

setNumberOfCharacteristics(int) - Method in class org.passay.CharacterCharacteristicsRule

Sets the number of characteristics which must be satisfied in order for a password to meet the requirements of this rule.

setNumberOfCharacters(int) - Method in class org.passay.CharacterRule

Sets the number of characters to require in a password.

setOrigin(PasswordData.Origin) - Method in class org.passay.PasswordData

Sets the origin.

setPassword(String) - Method in class org.passay.PasswordData

Sets the password.

setPasswordReferences(PasswordData.Reference...) - Method in class org.passay.PasswordData

Sets the password references.

setPasswordReferences(List<PasswordData.Reference>) - Method in class org.passay.PasswordData

Sets the password references.

setReadTimeout(Duration) - Method in class org.passay.HaveIBeenPwnedRule

maximum Duration for reading from the API.

setReportFailure(boolean) - Method in class org.passay.CharacterCharacteristicsRule

Sets whether to add the rule result detail of this rule to the rule result.

setReportFailure(boolean) - Method in class org.passay.LengthComplexityRule

Sets whether to add the rule result detail of this rule to the rule result.

setReportRuleFailures(boolean) - Method in class org.passay.CharacterCharacteristicsRule

Sets whether to add the rule result detail for each character rule that fails to validate to the rule result.

setReportRuleFailures(boolean) - Method in class org.passay.LengthComplexityRule

Sets whether to add the rule result detail for each rule that fails to validate to the rule result.

setRules(List<CharacterRule>) - Method in class org.passay.CharacterCharacteristicsRule

Sets the character rules used by this rule.

setRules(CharacterRule...) - Method in class org.passay.CharacterCharacteristicsRule

Sets the character rules used by this rule.

setSplitChar(char) - Method in class org.passay.dictionary.TernaryNode

Sets the split character.

setUsername(String) - Method in class org.passay.PasswordData

Sets the username.

setValid(boolean) - Method in class org.passay.RuleResult

Sets whether the result of the rule verification is a valid password.

SHANNON_COMPOSITION_SIEVE - Static variable in class org.passay.entropy.ShannonEntropy

Array used for determining composition "bonus" for calculating the Shannon entropy estimate.

SHANNON_DICTIONARY_SIEVE - Static variable in class org.passay.entropy.ShannonEntropy

Array used for determining dictionary entropy "bonus" for calculating the Shannon entropy estimate.

ShannonEntropy - Class in org.passay.entropy

Entropy bits estimate defined in NIST SP-800-63-1 User Selected Passwords.

ShannonEntropy(boolean, boolean, int) - Constructor for class org.passay.entropy.ShannonEntropy

Creates a new shannon entropy estimate.

ShannonEntropyFactory - Class in org.passay.entropy

Factory for creating ShannonEntropy from password rules and password data.

size - Variable in class org.passay.dictionary.AbstractFileWordList

Number of words in the file.

size() - Method in class org.passay.dictionary.AbstractFileWordList

size() - Method in class org.passay.dictionary.ArrayWordList

size() - Method in class org.passay.dictionary.BloomFilterDictionary

Returns an estimate for the number of words added to the dictionary.

size() - Method in interface org.passay.dictionary.Dictionary

Returns the number of words in this dictionary

size() - Method in class org.passay.dictionary.JDBCDictionary

size() - Method in class org.passay.dictionary.TernaryTreeDictionary

size() - Method in interface org.passay.dictionary.WordList

Returns the number of words in the list.

size() - Method in class org.passay.dictionary.WordListDictionary

sizeStatement - Variable in class org.passay.dictionary.JDBCDictionary

SQL size statement.

sort(String[]) - Method in interface org.passay.dictionary.sort.ArraySorter

This will sort the supplied string array.

sort(String[], Comparator<String>) - Method in interface org.passay.dictionary.sort.ArraySorter

This will sort the supplied string array.

sort(String[]) - Method in class org.passay.dictionary.sort.ArraysSort

sort(String[], Comparator<String>) - Method in class org.passay.dictionary.sort.ArraysSort

sort(String[], Comparator<String>) - Method in class org.passay.dictionary.sort.BubbleSort

sort(String[], Comparator<String>) - Method in class org.passay.dictionary.sort.InsertionSort

sort(String[], Comparator<String>) - Method in class org.passay.dictionary.sort.QuickSort

sort(String[], Comparator<String>, int, int) - Static method in class org.passay.dictionary.sort.QuickSort

This will sort the supplied array beginning at the lo index and ending at the hi index, using the quick sort algorithm.

sort(String[], Comparator<String>) - Method in class org.passay.dictionary.sort.SelectionSort

SourceReference(String) - Constructor for class org.passay.PasswordData.SourceReference

Creates a new source reference.

SourceReference(String, String) - Constructor for class org.passay.PasswordData.SourceReference

Creates a new source reference.

SourceReference(String, String, PasswordData.Salt) - Constructor for class org.passay.PasswordData.SourceReference

Creates a new source reference.

SourceRule - Class in org.passay

Rule for determining if a password matches a password from a different source.

SourceRule() - Constructor for class org.passay.SourceRule

Creates a new source rule.

SourceRule(boolean) - Constructor for class org.passay.SourceRule

Creates a new source rule.

SpringMessageResolver - Class in org.passay.spring

Provides implementation for resolving validation message using Spring's MessageSource.

SpringMessageResolver(MessageSource) - Constructor for class org.passay.spring.SpringMessageResolver

Create a new instance with the locale associated with the current thread.

SpringMessageResolver(MessageSource, Locale) - Constructor for class org.passay.spring.SpringMessageResolver

Create a new instance with the specified locale.

SuffixSalt(String) - Constructor for class org.passay.PasswordData.SuffixSalt

Creates a new salt with the given salt data.

T

TernaryNode - Class in org.passay.dictionary

Implementation of a node contained in a ternary tree.

TernaryNode(char) - Constructor for class org.passay.dictionary.TernaryNode

Create a new ternary node with the supplied character.

TernaryTree - Class in org.passay.dictionary

Implementation of a ternary tree.

TernaryTree() - Constructor for class org.passay.dictionary.TernaryTree

Creates an empty case sensitive ternary tree.

TernaryTree(boolean) - Constructor for class org.passay.dictionary.TernaryTree

Creates an empty ternary tree with the given case sensitivity.

TernaryTreeDictionary - Class in org.passay.dictionary

Provides fast searching for dictionary words using a ternary tree.

TernaryTreeDictionary(WordList) - Constructor for class org.passay.dictionary.TernaryTreeDictionary

Creates a new balanced tree dictionary from the supplied WordList.

TernaryTreeDictionary(WordList, boolean) - Constructor for class org.passay.dictionary.TernaryTreeDictionary

Creates a new dictionary instance from the given WordList.

TernaryTreeDictionary(TernaryTree) - Constructor for class org.passay.dictionary.TernaryTreeDictionary

Creates a dictionary that uses the supplied ternary tree for dictionary searches.

THIRD_PHASE_BONUS - Static variable in class org.passay.entropy.ShannonEntropy

Entropy bonus of the third phase.

THIRD_PHASE_LENGTH - Static variable in class org.passay.entropy.ShannonEntropy

Length of the second phase.

toString() - Method in class org.passay.AbstractDictionaryRule

toString() - Method in class org.passay.AllowedCharacterRule

toString() - Method in class org.passay.AllowedRegexRule

toString() - Method in class org.passay.CharacterCharacteristicsRule

toString() - Method in class org.passay.CharacterOccurrencesRule

toString() - Method in class org.passay.CharacterRule

toString() - Method in class org.passay.dictionary.AbstractFileWordList

toString() - Method in class org.passay.dictionary.ArrayWordList

toString() - Method in class org.passay.dictionary.BloomFilterDictionary

toString() - Method in class org.passay.dictionary.WordListDictionary

toString() - Method in class org.passay.IllegalCharacterRule

toString() - Method in class org.passay.IllegalRegexRule

toString() - Method in class org.passay.IllegalSequenceRule

toString() - Method in class org.passay.LengthComplexityRule.Interval

toString() - Method in class org.passay.LengthComplexityRule

toString() - Method in class org.passay.LengthRule

toString() - Method in enum org.passay.MatchBehavior

toString() - Method in class org.passay.NumberRangeRule

toString() - Method in class org.passay.PasswordData.AbstractReference

toString() - Method in class org.passay.PasswordData

toString() - Method in class org.passay.PasswordValidator

toString() - Method in class org.passay.RuleResult

toString() - Method in class org.passay.RuleResultDetail

toString() - Method in class org.passay.RuleResultMetadata

toString() - Method in class org.passay.UsernameRule

toString() - Method in class org.passay.WhitespaceRule

tree - Variable in class org.passay.dictionary.TernaryTreeDictionary

Ternary tree used for searching.

U

upperSnakeName() - Method in enum org.passay.MatchBehavior

Returns the name of this match behavior in upper case snake casing.

UsernameRule - Class in org.passay

Rule for determining if a password contains the username associated with that password.

UsernameRule() - Constructor for class org.passay.UsernameRule

Default constructor.

UsernameRule(MatchBehavior) - Constructor for class org.passay.UsernameRule

Create a new username rule.

UsernameRule(boolean, boolean) - Constructor for class org.passay.UsernameRule

Create a new username rule.

UsernameRule(boolean, boolean, MatchBehavior) - Constructor for class org.passay.UsernameRule

Create a new username rule.

V

valid - Variable in class org.passay.RuleResult

Whether password rule was successful.

validate(PasswordData) - Method in class org.passay.AbstractDictionaryRule

validate(PasswordData) - Method in class org.passay.AllowedCharacterRule

validate(PasswordData) - Method in class org.passay.AllowedRegexRule

validate(PasswordData) - Method in class org.passay.CharacterCharacteristicsRule

validate(PasswordData) - Method in class org.passay.CharacterOccurrencesRule

validate(PasswordData) - Method in class org.passay.CharacterRule

validate(PasswordData) - Method in class org.passay.HaveIBeenPwnedRule

validate(PasswordData) - Method in class org.passay.HistoryRule

validate(PasswordData) - Method in class org.passay.IllegalCharacterRule

validate(PasswordData) - Method in class org.passay.IllegalRegexRule

validate(PasswordData) - Method in class org.passay.IllegalSequenceRule

validate(PasswordData) - Method in class org.passay.LengthComplexityRule

validate(PasswordData) - Method in class org.passay.LengthRule

validate(PasswordData) - Method in class org.passay.NumberRangeRule

validate(PasswordData) - Method in class org.passay.PasswordValidator

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

validate(PasswordData) - Method in class org.passay.RepeatCharactersRule

validate(PasswordData) - Method in interface org.passay.Rule

Validates the supplied password data per the requirements of this rule.

validate(PasswordData) - Method in class org.passay.SourceRule

validate(PasswordData) - Method in class org.passay.UsernameRule

validate(PasswordData) - Method in class org.passay.WhitespaceRule

valueOf(String) - Static method in enum org.passay.CyrillicCharacterData

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.passay.CyrillicModernCharacterData

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.passay.CyrillicModernSequenceData

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.passay.CyrillicSequenceData

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.passay.CzechCharacterData

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.passay.CzechSequenceData

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.passay.EnglishCharacterData

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.passay.EnglishSequenceData

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.passay.GermanCharacterData

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.passay.GermanSequenceData

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.passay.MatchBehavior

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.passay.PasswordData.Origin

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.passay.PolishCharacterData

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.passay.PolishSequenceData

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.passay.RuleResultMetadata.CountCategory

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.passay.CyrillicCharacterData

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.passay.CyrillicModernCharacterData

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.passay.CyrillicModernSequenceData

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.passay.CyrillicSequenceData

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.passay.CzechCharacterData

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.passay.CzechSequenceData

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.passay.EnglishCharacterData

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.passay.EnglishSequenceData

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.passay.GermanCharacterData

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.passay.GermanSequenceData

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.passay.MatchBehavior

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.passay.PasswordData.Origin

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.passay.PolishCharacterData

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.passay.PolishSequenceData

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.passay.RuleResultMetadata.CountCategory

Returns an array containing the constants of this enum type, in the order they are declared.

W

WhitespaceRule - Class in org.passay

Rule for determining if a password contains whitespace characters.

WhitespaceRule() - Constructor for class org.passay.WhitespaceRule

Creates a new whitespace rule.

WhitespaceRule(MatchBehavior) - Constructor for class org.passay.WhitespaceRule

Creates a new whitespace rule.

WhitespaceRule(char[]) - Constructor for class org.passay.WhitespaceRule

Creates a new whitespace rule.

WhitespaceRule(MatchBehavior, boolean) - Constructor for class org.passay.WhitespaceRule

Creates a new whitespace rule.

WhitespaceRule(char[], MatchBehavior) - Constructor for class org.passay.WhitespaceRule

Creates a new whitespace rule.

WhitespaceRule(char[], boolean) - Constructor for class org.passay.WhitespaceRule

Creates a new whitespace rule.

WhitespaceRule(char[], MatchBehavior, boolean) - Constructor for class org.passay.WhitespaceRule

Creates a new whitespace rule.

WordList - Interface in org.passay.dictionary

Represents a random-access list of words.

wordList - Variable in class org.passay.dictionary.WordListDictionary

list used for searching.

WordListDictionary - Class in org.passay.dictionary

Provides fast searching for dictionary words using a word list.

WordListDictionary(WordList) - Constructor for class org.passay.dictionary.WordListDictionary

Creates a new dictionary instance from the supplied WordList.

WordLists - Class in org.passay.dictionary

Utility class for common operations on word lists.

words - Variable in class org.passay.dictionary.ArrayWordList

file containing words.

wrapSequence - Variable in class org.passay.IllegalSequenceRule

Whether or not to wrap a sequence when searching for matches.

A B C D E F G H I J L M N O P Q R S T U V W