Reference

CrackTimesDisplay

offline_fast_hashing_1e10_per_second instance-attribute

offline_fast_hashing_1e10_per_second

offline_slow_hashing_1e4_per_second instance-attribute

offline_slow_hashing_1e4_per_second

online_no_throttling_10_per_second instance-attribute

online_no_throttling_10_per_second

online_throttling_100_per_hour instance-attribute

online_throttling_100_per_hour

CrackTimesSeconds

offline_fast_hashing_1e10_per_second instance-attribute

offline_fast_hashing_1e10_per_second

offline_slow_hashing_1e4_per_second instance-attribute

offline_slow_hashing_1e4_per_second

online_no_throttling_10_per_second instance-attribute

online_no_throttling_10_per_second

online_throttling_100_per_hour instance-attribute

online_throttling_100_per_hour

Entropy

Result of a password strength check.

calc_time instance-attribute

calc_time

How long it took to calculate the answer.

crack_times_display instance-attribute

crack_times_display

Same as crack_times_seconds, with friendlier display string values.

crack_times_seconds instance-attribute

crack_times_seconds

List of back-of-the-envelope crack time estimations based on a few scenarios.

feedback instance-attribute

feedback

Verbal feedback to help choose better passwords. Set when score <= 2.

guesses instance-attribute

guesses

Estimated guesses needed to crack the password

guesses_log10 instance-attribute

guesses_log10

Order of magnitude of guesses.

score instance-attribute

score

Overall strength score from 0-4. Any score less than 3 should be considered too weak.

Feedback

suggestions instance-attribute

suggestions

warning instance-attribute

warning

Suggestion

Bases: Enum

AddAnotherWordOrTwo class-attribute instance-attribute

AddAnotherWordOrTwo = auto()

AllUppercaseIsAlmostAsEasyToGuessAsAllLowercase class-attribute instance-attribute

AllUppercaseIsAlmostAsEasyToGuessAsAllLowercase = auto()

AvoidDatesAndYearsThatAreAssociatedWithYou class-attribute instance-attribute

AvoidDatesAndYearsThatAreAssociatedWithYou = auto()

AvoidRecentYears class-attribute instance-attribute

AvoidRecentYears = auto()

AvoidRepeatedWordsAndCharacters class-attribute instance-attribute

AvoidRepeatedWordsAndCharacters = auto()

AvoidSequences class-attribute instance-attribute

AvoidSequences = auto()

AvoidYearsThatAreAssociatedWithYou class-attribute instance-attribute

AvoidYearsThatAreAssociatedWithYou = auto()

CapitalizationDoesntHelpVeryMuch class-attribute instance-attribute

CapitalizationDoesntHelpVeryMuch = auto()

NoNeedForSymbolsDigitsOrUppercaseLetters class-attribute instance-attribute

NoNeedForSymbolsDigitsOrUppercaseLetters = auto()

PredictableSubstitutionsDontHelpVeryMuch class-attribute instance-attribute

PredictableSubstitutionsDontHelpVeryMuch = auto()

ReversedWordsArentMuchHarderToGuess class-attribute instance-attribute

ReversedWordsArentMuchHarderToGuess = auto()

UseAFewWordsAvoidCommonPhrases class-attribute instance-attribute

UseAFewWordsAvoidCommonPhrases = auto()

UseALongerKeyboardPatternWithMoreTurns class-attribute instance-attribute

UseALongerKeyboardPatternWithMoreTurns = auto()

Warning

Bases: Enum

AWordByItselfIsEasyToGuess class-attribute instance-attribute

AWordByItselfIsEasyToGuess = auto()

CommonNamesAndSurnamesAreEasyToGuess class-attribute instance-attribute

CommonNamesAndSurnamesAreEasyToGuess = auto()

DatesAreOftenEasyToGuess class-attribute instance-attribute

DatesAreOftenEasyToGuess = auto()

NamesAndSurnamesByThemselvesAreEasyToGuess class-attribute instance-attribute

NamesAndSurnamesByThemselvesAreEasyToGuess = auto()

RecentYearsAreEasyToGuess class-attribute instance-attribute

RecentYearsAreEasyToGuess = auto()

RepeatsLikeAaaAreEasyToGuess class-attribute instance-attribute

RepeatsLikeAaaAreEasyToGuess = auto()

RepeatsLikeAbcAbcAreOnlySlightlyHarderToGuess class-attribute instance-attribute

RepeatsLikeAbcAbcAreOnlySlightlyHarderToGuess = auto()

SequencesLikeAbcAreEasyToGuess class-attribute instance-attribute

SequencesLikeAbcAreEasyToGuess = auto()

ShortKeyboardPatternsAreEasyToGuess class-attribute instance-attribute

ShortKeyboardPatternsAreEasyToGuess = auto()

StraightRowsOfKeysAreEasyToGuess class-attribute instance-attribute

StraightRowsOfKeysAreEasyToGuess = auto()

ThisIsACommonPassword class-attribute instance-attribute

ThisIsACommonPassword = auto()

ThisIsATop100Password class-attribute instance-attribute

ThisIsATop100Password = auto()

ThisIsATop10Password class-attribute instance-attribute

ThisIsATop10Password = auto()

ThisIsSimilarToACommonlyUsedPassword class-attribute instance-attribute

ThisIsSimilarToACommonlyUsedPassword = auto()

zxcvbn

zxcvbn(password, user_inputs=None)

Measure the strength of a password.

Parameters:

Name	Type	Description	Default
password	str	The password to check.	required
user_inputs	list[str] | None	Optional list of strings input by the user	None

Returns:

Type	Description
Entropy	An Entropy object.