me.gosimple.nbvcxz.resources

Class ConfigurationBuilder

java.lang.Object

me.gosimple.nbvcxz.resources.ConfigurationBuilder

public class ConfigurationBuilder
extends Object

Builder class for creating Configuration.

Author:

Adam Brusselback.

Constructor Summary

Constructors

Constructor and Description
ConfigurationBuilder()

Method Summary

Modifier and Type	Method and Description
Configuration	createConfiguration() Creates the Configuration object using all values set in this builder, or default values if unset.
static List<AdjacencyGraph>	getDefaultAdjacencyGraphs()
static long	getDefaultCombinationAlgorithmTimeout()
static List<Dictionary>	getDefaultDictionaries()
static Boolean	getDefaultDistanceCalc()
static Map<String,Long>	getDefaultGuessTypes()
static Map<Character,Character>	getDefaultLeetTable()
static double	getDefaultMinimumEntropy()
static List<PasswordMatcher>	getDefaultPasswordMatchers()
static Pattern	getDefaultYearPattern()
ConfigurationBuilder	setAdjacencyGraphs(List<AdjacencyGraph> adjacencyGraphs) AdjacencyGraphs are used to find spacial patterns within passwords (e.g.
ConfigurationBuilder	setCombinationAlgorithmTimeout(Long combinationAlgorithmTimeout) Timeout for the findBestCombination algorithm.
ConfigurationBuilder	setDictionaries(List<Dictionary> dictionaries) Dictionaries are used by the DictionaryMatcher to find common words, names, and known passwords within the password.
ConfigurationBuilder	setDistanceCalc(Boolean distanceCalc) Distance based dictionary calculations which provide support for misspelling detection, at the expense of performance.
ConfigurationBuilder	setGuessTypes(Map<String,Long> guessTypes) Guess types are used to calculate how long an attack would take using that method using guesses/sec.
ConfigurationBuilder	setLeetTable(Map<Character,Character> leetTable) The leet table is used to check within a password for common character substitutions (e.g.
ConfigurationBuilder	setLocale(Locale locale) Supported locales are en, and fr.
ConfigurationBuilder	setMinimumEntropy(Double minimumEntropy) Used to check if the password is secure enough, and give feedback if not.
ConfigurationBuilder	setPasswordMatchers(List<PasswordMatcher> passwordMatchers) PasswordMatcher are what look for different patterns within the password and create an associated Match object.
ConfigurationBuilder	setYearPattern(Pattern yearPattern) Year patterns are used to look for years within a password.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationBuilder

public ConfigurationBuilder()

Method Detail

getDefaultPasswordMatchers

public static List<PasswordMatcher> getDefaultPasswordMatchers()

Returns:

Includes all standard password matchers included with Nbvcxz.

getDefaultGuessTypes

public static Map<String,Long> getDefaultGuessTypes()

Returns:

The default list of guess types and associated values of guesses per second. This list was compiled in February 2017 using a baseline of what could be bought for roughly $20k usd for the offline attack values. In the case this library is no longer maintained (or you choose to stay on an old version of it), we will scale the existing values by Moore's law.

getDefaultDictionaries

public static List<Dictionary> getDefaultDictionaries()

Returns:

Returns all the dictionaries included with Nbvcxz. Namely there is a dictionary for common passwords, english male names, english female names, english surnames, and common english words.

getDefaultAdjacencyGraphs

public static List<AdjacencyGraph> getDefaultAdjacencyGraphs()

Returns:

Default keyboard adjacency graphs for standard querty, standard keypad, and mac keypad

getDefaultLeetTable

public static Map<Character,Character> getDefaultLeetTable()

Returns:

The default table of common english leet substitutions

getDefaultYearPattern

public static Pattern getDefaultYearPattern()

Returns:

The default pattern for years includes years 1900-2029

getDefaultMinimumEntropy

public static double getDefaultMinimumEntropy()

Returns:

The default value for minimum entropy is 35.

getDefaultDistanceCalc

public static Boolean getDefaultDistanceCalc()

Returns:

the default is false

getDefaultCombinationAlgorithmTimeout

public static long getDefaultCombinationAlgorithmTimeout()

Returns:

The default value for minimum entropy is 35.

setPasswordMatchers

public ConfigurationBuilder setPasswordMatchers(List<PasswordMatcher> passwordMatchers)

PasswordMatcher are what look for different patterns within the password and create an associated Match object.
Users of this library can implement their own PasswordMatcher and Match classes, here is where you would register them.

Parameters:

passwordMatchers - List of matchers

Returns:

Builder

setGuessTypes

public ConfigurationBuilder setGuessTypes(Map<String,Long> guessTypes)

Guess types are used to calculate how long an attack would take using that method using guesses/sec.

Parameters:

guessTypes - key is a description of the type of guess, value is how many guesses per second

Returns:

Builder

setDictionaries

public ConfigurationBuilder setDictionaries(List<Dictionary> dictionaries)

Dictionaries are used by the DictionaryMatcher to find common words, names, and known passwords within the password.

Parameters:

dictionaries - List of dictionaries

Returns:

Builder

setAdjacencyGraphs

public ConfigurationBuilder setAdjacencyGraphs(List<AdjacencyGraph> adjacencyGraphs)

AdjacencyGraphs are used to find spacial patterns within passwords (e.g. asdfghj).

Parameters:

adjacencyGraphs - List of adjacencyGraphs

Returns:

Builder

setLeetTable

public ConfigurationBuilder setLeetTable(Map<Character,Character> leetTable)

The leet table is used to check within a password for common character substitutions (e.g. s to $).

Parameters:

leetTable - Map for leetTable

Returns:

Builder

setYearPattern

public ConfigurationBuilder setYearPattern(Pattern yearPattern)

Year patterns are used to look for years within a password.

Parameters:

yearPattern - Pattern for year matching

Returns:

Builder

setMinimumEntropy

public ConfigurationBuilder setMinimumEntropy(Double minimumEntropy)

Used to check if the password is secure enough, and give feedback if not.
Should be a positive value.

Parameters:

minimumEntropy - Value for minimumEntropy

Returns:

Builder

setLocale

public ConfigurationBuilder setLocale(Locale locale)

Supported locales are en, and fr.
Default locale is en.

Parameters:

locale - Locale for localization

Returns:

Builder

setDistanceCalc

public ConfigurationBuilder setDistanceCalc(Boolean distanceCalc)

Distance based dictionary calculations which provide support for misspelling detection, at the expense of performance. This will slow down calculations by an order of magnitude.

Parameters:

distanceCalc - true to enable distance based dictionary calculations

Returns:

Builder

setCombinationAlgorithmTimeout

public ConfigurationBuilder setCombinationAlgorithmTimeout(Long combinationAlgorithmTimeout)

Timeout for the findBestCombination algorithm. If there are too many possible matches at each position of the password, the algorithm can take too long to get an answer and we must fall back to a simpler algorithm.

To disable the findBestMatches calculation and always fall back to the faster, less accurate one, set to 0.

Parameters:

combinationAlgorithmTimeout - The time in ms to timeout

Returns:

Builder

createConfiguration

public Configuration createConfiguration()

Creates the Configuration object using all values set in this builder, or default values if unset.

Returns:

Configuration object from builder