-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/

-- | Password strength estimation
--   
--   This is a Haskell binding to the C port of the zxcvbn password
--   strength estimator, from https://github.com/tsyrogit/zxcvbn-c
--   
--   An article on the reasons for zxcvbn is at
--   https://tech.dropox.com/2012/04/zxcvbn-realistic-password-strength-estimation
@package zxcvbn-c
@version 1.0.1

module Text.Password.Strength
type Password = String

-- | List of words that would be particularly bad in the password, to
--   suppliment the built-in word lists. The name of the user is a good
--   candidate to include here.
type UserDict = [String]

-- | Entropy estimation in bits.
type Entropy = Double
estimate :: Password -> UserDict -> Entropy
