Options class

This class is used to define the options for the Zxcvbn class.

Implementers

Constructors

Options({Map<String, Matcher>? matchers, Map<String, List<String>>? l33tTable, Dictionary? dictionary, Translations? translations, AdjacencyGraphsMixin? graphs, bool? useLevenshteinDistance, int? levenshteinThreshold, int? l33tMaxSubstitutions, int? maxLength})

Properties

dictionary Dictionary?
Define dictionary that should be used to check against. The matcher will search the dictionaries for similar password with l33t speak and reversed words. The recommended sets are found in dart_zxcvbn_language_common and dart_zxcvbn_language_en.
getter/setter pair
graphs AdjacencyGraphsMixin?
Defines keyboard layouts as an object which are used to find sequences. Already implemented layouts can be found in dart_zxcvbn_language_common
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
l33tMaxSubstitutions int?
The l33t matcher will check how many characters can be exchanged with the l33t table. If they are to many it will decrease the calcTime significantly. So we cap it at a reasonable value by default which will probably already seems like a strong password anyway.
getter/setter pair
l33tTable Map<String, List<String>>?
Define an object with l33t substitutions. For example that an "a" can be exchanged with a "4" or a "@".
getter/setter pair
levenshteinThreshold int?
Defines how many characters can be different to match a dictionary word with the levenshtein algorithm.
getter/setter pair
matchers Map<String, Matcher>?
Any additional third-party matchers to use.
getter/setter pair
maxLength int?
Defines how many character of the password are checked. A password longer than the default are considered strong anyway, but it can be increased as pleased. Be aware that this could open some attack vectors.
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
translations Translations?
Defines an object with a key value match to translate the feedback given by this library. The default values are plain keys so that you can use your own i18n library. Already implemented language can be found with something like dart_zxcvbn_language_en.
getter/setter pair
useLevenshteinDistance bool?
Defines if the levenshtein algorithm should be used. This will be only used on the complete password and not on parts of it. This will decrease the calcTime a bit but will significantly improve the password check. The recommended sets are found in dart_zxcvbn_language_common and dart_zxcvbn_language_en.
getter/setter pair

Methods

addMatcher(String name, Matcher matcher) → void
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited