Copyright	This file is part of the package zxcvbn-hs. It is subject to the license terms in the LICENSE file found in the top-level directory of this distribution and at: https://code.devalot.com/sthenauth/zxcvbn-hs No part of this package including this file may be copied modified propagated or distributed except according to the terms contained in the LICENSE file.
License	MIT
Safe Haskell	None
Language	Haskell2010

Text.Password.Strength.Config

Contents

Description

Synopsis

Configuring word dictionaries, keyboards, etc.

A type to control which dictionaries, keyboard layouts, etc. will be used when estimating guesses.

Instances

Semigroup Config Source #
Instance details Defined in Text.Password.Strength.Internal.Config Methods (<>) :: Config -> Config -> Config # sconcat :: NonEmpty Config -> Config # stimes :: Integral b => b -> Config -> Config #
Monoid Config Source #
Instance details Defined in Text.Password.Strength.Internal.Config Methods mempty :: Config # mappend :: Config -> Config -> Config # mconcat :: [Config] -> Config #
HasConfig Config Source #
Instance details Defined in Text.Password.Strength.Internal.Config Methods config :: Lens' Config Config customFrequencyLists :: Lens' Config [Dictionary] Source # keyboardGraphs :: Lens' Config [AdjacencyTable] Source # obviousSequenceStart :: Lens' Config (Char -> Bool) Source # passwordLists :: Lens' Config [Dictionary] Source # wordFrequencyLists :: Lens' Config [Dictionary] Source #

Type alias for a frequency database.

Add a custom list of words for frequency lookup. The words should be ordered from most frequent to least frequent.

Lenses for the `Config` Type

passwordLists: Leaked password frequency lists.
wordFrequencyLists: Various word frequency lists.
customFrequencyLists: Custom word frequency lists. Usually includes information about the person whose password we are guessing and the application for which we are running. An easier way to add words to this list is to use the addCustomFrequencyList function.
keyboardGraphs: Keyboard adjacency graphs.
obviousSequenceStart: Predicate function that should return True for characters that are "obvious first choices" to start a sequence. For example, in English, a and A would be considered True.

Minimal complete definition

config

Instances

HasConfig Config Source #
Instance details Defined in Text.Password.Strength.Internal.Config Methods config :: Lens' Config Config customFrequencyLists :: Lens' Config [Dictionary] Source # keyboardGraphs :: Lens' Config [AdjacencyTable] Source # obviousSequenceStart :: Lens' Config (Char -> Bool) Source # passwordLists :: Lens' Config [Dictionary] Source # wordFrequencyLists :: Lens' Config [Dictionary] Source #