Data.Gibberish

Generating Passwords

genPassword :: MonadRandom m => GenPasswordOpts -> m Word

Generate a password with the given options

genPasswords :: MonadRandom m => GenPasswordOpts -> m [Word]

Generate passwords with the given options. Warning: Do not use with the IO monad, instead use genPasswords'

genPasswords' :: MonadRandom m => GenPasswordOpts -> Int -> m [Word]

Generating Passphrases

genPassphrase :: MonadRandom m => GenPassphraseOpts -> m [Word]

Generate a passphrase with the given options. Warning: Do not use with the IO monad, instead use genPassphrash'

genPassphrase' :: MonadRandom m => GenPassphraseOpts -> Int -> m [Word]

Generate a passphrase with the given options and the given number of words.

The Pass Monad

type Pass gen = PassT gen Identity

Password/Passphrase generation monad parameterized by the type gen of the generator to carry

runPass :: Pass gen a -> gen -> (a, gen)

Run a generation computation with the given options and initial generator

evalPass :: Pass gen a -> gen -> a

Evaluate a generation computation with the given options and initial generator, discarding the final generator

usingPass :: gen -> Pass gen a -> (a, gen)

Shorter and more readable alias for flip runPassT.

The PassT Monad Transformer

newtype PassT gen m a

Password/Passphrase generation transformer monad parameterized by :

• gen - the generator.
• m - the inner monad.

Constructors

PassT

Fields

• unPass :: RandT gen m a

Instances

(RandomGen gen, Monad m) => MonadRandom (PassT gen m)

Defined in Data.Gibberish.Monad.Pass

Methods

getRandomR :: Random a => (a, a) -> PassT gen m a

getRandom :: Random a => PassT gen m a

getRandomRs :: Random a => (a, a) -> PassT gen m [a]

getRandoms :: Random a => PassT gen m [a]

MonadFail m => MonadFail (PassT gen m)

Defined in Data.Gibberish.Monad.Pass

Methods

fail :: String -> PassT gen m a

MonadIO m => MonadIO (PassT gen m)

Defined in Data.Gibberish.Monad.Pass

Methods

liftIO :: IO a -> PassT gen m a

Monad m => Applicative (PassT gen m)

Defined in Data.Gibberish.Monad.Pass

Methods

pure :: a -> PassT gen m a

(<*>) :: PassT gen m (a -> b) -> PassT gen m a -> PassT gen m b

liftA2 :: (a -> b -> c) -> PassT gen m a -> PassT gen m b -> PassT gen m c

(*>) :: PassT gen m a -> PassT gen m b -> PassT gen m b

(<*) :: PassT gen m a -> PassT gen m b -> PassT gen m a

Functor m => Functor (PassT gen m)

Defined in Data.Gibberish.Monad.Pass

Methods

fmap :: (a -> b) -> PassT gen m a -> PassT gen m b

(<$) :: a -> PassT gen m b -> PassT gen m a

Monad m => Monad (PassT gen m)

Defined in Data.Gibberish.Monad.Pass

Methods

(>>=) :: PassT gen m a -> (a -> PassT gen m b) -> PassT gen m b

(>>) :: PassT gen m a -> PassT gen m b -> PassT gen m b

return :: a -> PassT gen m a

runPassT :: PassT g m a -> g -> m (a, g)

Run a generation computation with the given options and initial generator

evalPassT :: Monad m => PassT g m a -> g -> m a

Evaluate a generation computation with the given options and initial generator, discarding the final generator

usingPassT :: g -> PassT g m a -> m (a, g)

Shorter and more readable alias for flip runPassT.

module Control.Monad.Random

Core Types

data GenPasswordOpts

Password generation options

Constructors

GenPasswordOpts

Fields

• woptsCapitals :: !Bool

  Include capitals?

• woptsDigits :: !Bool

  Include numerals?

• woptsSpecials :: !Bool

  Include special characters?

• woptsTrigraph :: Trigraph

  The trigraph to use

• woptsLength :: !Int

  The length of the password

Instances

Show GenPasswordOpts

Defined in Data.Gibberish.Types

Methods

showsPrec :: Int -> GenPasswordOpts -> ShowS

show :: GenPasswordOpts -> String

showList :: [GenPasswordOpts] -> ShowS

Eq GenPasswordOpts

Defined in Data.Gibberish.Types

Methods

(==) :: GenPasswordOpts -> GenPasswordOpts -> Bool

(/=) :: GenPasswordOpts -> GenPasswordOpts -> Bool

data GenPassphraseOpts

Passphrase generation options

Constructors

GenPassphraseOpts

Fields

• poptsCapitals :: !Bool

  Include capitals?

• poptsDigits :: !Bool

  Include numerals?

• poptsSpecials :: !Bool

  Include special characters?

• poptsTrigraph :: Trigraph

  The trigraph to use

• poptsMinLength :: !Int

  The mininum length of each word

• poptsMaxLength :: !Int

  The maximum length of each word

Instances

Show GenPassphraseOpts

Defined in Data.Gibberish.Types

Methods

showsPrec :: Int -> GenPassphraseOpts -> ShowS

show :: GenPassphraseOpts -> String

showList :: [GenPassphraseOpts] -> ShowS

Eq GenPassphraseOpts

Defined in Data.Gibberish.Types

Methods

(==) :: GenPassphraseOpts -> GenPassphraseOpts -> Bool

(/=) :: GenPassphraseOpts -> GenPassphraseOpts -> Bool

data Language

A language indicating the dictionary that generated a trigraph

Constructors

English

Spanish

CustomTrigraph TrigraphConfig

Instances

Show Language

Defined in Data.Gibberish.Types

Methods

showsPrec :: Int -> Language -> ShowS

show :: Language -> String

showList :: [Language] -> ShowS

Eq Language

Defined in Data.Gibberish.Types

Methods

(==) :: Language -> Language -> Bool

(/=) :: Language -> Language -> Bool

newtype TrigraphConfig

A path to a trigraph json config file

Constructors

TrigraphConfig

Fields

• unTrigraphConfig :: FilePath

Instances

Show TrigraphConfig

Defined in Data.Gibberish.Types

Methods

showsPrec :: Int -> TrigraphConfig -> ShowS

show :: TrigraphConfig -> String

showList :: [TrigraphConfig] -> ShowS

Eq TrigraphConfig

Defined in Data.Gibberish.Types

Methods

(==) :: TrigraphConfig -> TrigraphConfig -> Bool

(/=) :: TrigraphConfig -> TrigraphConfig -> Bool

newtype Trigraph

A trigraph is a mapping of all digrams to frequencies. That is, for a set of digrams, it contains the frequencies of all possible trigram candidates.

Constructors

Trigraph

Fields

• unTrigraph :: Map Digram Frequencies

Instances

FromJSON Trigraph

Defined in Data.Gibberish.Types

Methods

parseJSON :: Value -> Parser Trigraph

parseJSONList :: Value -> Parser [Trigraph]

omittedField :: Maybe Trigraph

ToJSON Trigraph

Defined in Data.Gibberish.Types

Methods

toJSON :: Trigraph -> Value

toEncoding :: Trigraph -> Encoding

toJSONList :: [Trigraph] -> Value

toEncodingList :: [Trigraph] -> Encoding

omitField :: Trigraph -> Bool

Show Trigraph

Defined in Data.Gibberish.Types

Methods

showsPrec :: Int -> Trigraph -> ShowS

show :: Trigraph -> String

showList :: [Trigraph] -> ShowS

NFData Trigraph

Defined in Data.Gibberish.Types

Methods

rnf :: Trigraph -> ()

Eq Trigraph

Defined in Data.Gibberish.Types

Methods

(==) :: Trigraph -> Trigraph -> Bool

(/=) :: Trigraph -> Trigraph -> Bool

newtype Word

A natural language word

Constructors

Word

Fields

• unWord :: Text

Instances

Show Word

Defined in Data.Gibberish.Types

Methods

showsPrec :: Int -> Word -> ShowS

show :: Word -> String

showList :: [Word] -> ShowS

Eq Word

Defined in Data.Gibberish.Types

Methods

(==) :: Word -> Word -> Bool

(/=) :: Word -> Word -> Bool

newtype Unigram

A unigram is a single letter

Constructors

Unigram

Fields

• unUnigram :: Char

Instances

FromJSON Unigram

Defined in Data.Gibberish.Types

Methods

parseJSON :: Value -> Parser Unigram

parseJSONList :: Value -> Parser [Unigram]

omittedField :: Maybe Unigram

FromJSONKey Unigram

Defined in Data.Gibberish.Types

Methods

fromJSONKey :: FromJSONKeyFunction Unigram

fromJSONKeyList :: FromJSONKeyFunction [Unigram]

ToJSON Unigram

Defined in Data.Gibberish.Types

Methods

toJSON :: Unigram -> Value

toEncoding :: Unigram -> Encoding

toJSONList :: [Unigram] -> Value

toEncodingList :: [Unigram] -> Encoding

omitField :: Unigram -> Bool

ToJSONKey Unigram

Defined in Data.Gibberish.Types

Methods

toJSONKey :: ToJSONKeyFunction Unigram

toJSONKeyList :: ToJSONKeyFunction [Unigram]

Show Unigram

Defined in Data.Gibberish.Types

Methods

showsPrec :: Int -> Unigram -> ShowS

show :: Unigram -> String

showList :: [Unigram] -> ShowS

NFData Unigram

Defined in Data.Gibberish.Types

Methods

rnf :: Unigram -> ()

Eq Unigram

Defined in Data.Gibberish.Types

Methods

(==) :: Unigram -> Unigram -> Bool

(/=) :: Unigram -> Unigram -> Bool

Ord Unigram

Defined in Data.Gibberish.Types

Methods

compare :: Unigram -> Unigram -> Ordering

(<) :: Unigram -> Unigram -> Bool

(<=) :: Unigram -> Unigram -> Bool

(>) :: Unigram -> Unigram -> Bool

(>=) :: Unigram -> Unigram -> Bool

max :: Unigram -> Unigram -> Unigram

min :: Unigram -> Unigram -> Unigram

data Digram

A digram is a sequence of two letters

Constructors

Digram Char Char

Instances

FromJSON Digram

Defined in Data.Gibberish.Types

Methods

parseJSON :: Value -> Parser Digram

parseJSONList :: Value -> Parser [Digram]

omittedField :: Maybe Digram

FromJSONKey Digram

Defined in Data.Gibberish.Types

Methods

fromJSONKey :: FromJSONKeyFunction Digram

fromJSONKeyList :: FromJSONKeyFunction [Digram]

ToJSON Digram

Defined in Data.Gibberish.Types

Methods

toJSON :: Digram -> Value

toEncoding :: Digram -> Encoding

toJSONList :: [Digram] -> Value

toEncodingList :: [Digram] -> Encoding

omitField :: Digram -> Bool

ToJSONKey Digram

Defined in Data.Gibberish.Types

Methods

toJSONKey :: ToJSONKeyFunction Digram

toJSONKeyList :: ToJSONKeyFunction [Digram]

Generic Digram

Defined in Data.Gibberish.Types

Associated Types

type Rep Digram :: Type -> Type

Methods

from :: Digram -> Rep Digram x

to :: Rep Digram x -> Digram

Show Digram

Defined in Data.Gibberish.Types

Methods

showsPrec :: Int -> Digram -> ShowS

show :: Digram -> String

showList :: [Digram] -> ShowS

NFData Digram

Defined in Data.Gibberish.Types

Methods

rnf :: Digram -> ()

Eq Digram

Defined in Data.Gibberish.Types

Methods

(==) :: Digram -> Digram -> Bool

(/=) :: Digram -> Digram -> Bool

Ord Digram

Defined in Data.Gibberish.Types

Methods

compare :: Digram -> Digram -> Ordering

(<) :: Digram -> Digram -> Bool

(<=) :: Digram -> Digram -> Bool

(>) :: Digram -> Digram -> Bool

(>=) :: Digram -> Digram -> Bool

max :: Digram -> Digram -> Digram

min :: Digram -> Digram -> Digram

TextShow Digram

Defined in Data.Gibberish.Types

Methods

showbPrec :: Int -> Digram -> Builder

showb :: Digram -> Builder

showbList :: [Digram] -> Builder

showtPrec :: Int -> Digram -> Text

showt :: Digram -> Text

showtList :: [Digram] -> Text

showtlPrec :: Int -> Digram -> Text

showtl :: Digram -> Text

showtlList :: [Digram] -> Text

type Rep Digram

Defined in Data.Gibberish.Types

type Rep Digram = D1 ('MetaData "Digram" "Data.Gibberish.Types" "gibberish-3.0.0.0-CtpaXLVJUM23TyUN22m77c" 'False) (C1 ('MetaCons "Digram" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Char) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Char)))

data Trigram

A trigrams is a sequence of three letters

Constructors

Trigram Char Char Char

Instances

Generic Trigram

Defined in Data.Gibberish.Types

Associated Types

type Rep Trigram :: Type -> Type

Methods

from :: Trigram -> Rep Trigram x

to :: Rep Trigram x -> Trigram

Show Trigram

Defined in Data.Gibberish.Types

Methods

showsPrec :: Int -> Trigram -> ShowS

show :: Trigram -> String

showList :: [Trigram] -> ShowS

NFData Trigram

Defined in Data.Gibberish.Types

Methods

rnf :: Trigram -> ()

Eq Trigram

Defined in Data.Gibberish.Types

Methods

(==) :: Trigram -> Trigram -> Bool

(/=) :: Trigram -> Trigram -> Bool

Ord Trigram

Defined in Data.Gibberish.Types

Methods

compare :: Trigram -> Trigram -> Ordering

(<) :: Trigram -> Trigram -> Bool

(<=) :: Trigram -> Trigram -> Bool

(>) :: Trigram -> Trigram -> Bool

(>=) :: Trigram -> Trigram -> Bool

max :: Trigram -> Trigram -> Trigram

min :: Trigram -> Trigram -> Trigram

type Rep Trigram

Defined in Data.Gibberish.Types

type Rep Trigram = D1 ('MetaData "Trigram" "Data.Gibberish.Types" "gibberish-3.0.0.0-CtpaXLVJUM23TyUN22m77c" 'False) (C1 ('MetaCons "Trigram" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Char) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Char) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Char))))

newtype Frequency

A frequency represents the number of times a given trigram occurs in a language

Constructors

Frequency

Fields

• unFrequency :: Int

Instances

FromJSON Frequency

Defined in Data.Gibberish.Types

Methods

parseJSON :: Value -> Parser Frequency

parseJSONList :: Value -> Parser [Frequency]

omittedField :: Maybe Frequency

ToJSON Frequency

Defined in Data.Gibberish.Types

Methods

toJSON :: Frequency -> Value

toEncoding :: Frequency -> Encoding

toJSONList :: [Frequency] -> Value

toEncodingList :: [Frequency] -> Encoding

omitField :: Frequency -> Bool

Enum Frequency

Defined in Data.Gibberish.Types

Methods

succ :: Frequency -> Frequency

pred :: Frequency -> Frequency

toEnum :: Int -> Frequency

fromEnum :: Frequency -> Int

enumFrom :: Frequency -> [Frequency]

enumFromThen :: Frequency -> Frequency -> [Frequency]

enumFromTo :: Frequency -> Frequency -> [Frequency]

enumFromThenTo :: Frequency -> Frequency -> Frequency -> [Frequency]

Num Frequency

Defined in Data.Gibberish.Types

Methods

(+) :: Frequency -> Frequency -> Frequency

(-) :: Frequency -> Frequency -> Frequency

(*) :: Frequency -> Frequency -> Frequency

negate :: Frequency -> Frequency

abs :: Frequency -> Frequency

signum :: Frequency -> Frequency

fromInteger :: Integer -> Frequency

Integral Frequency

Defined in Data.Gibberish.Types

Methods

quot :: Frequency -> Frequency -> Frequency

rem :: Frequency -> Frequency -> Frequency

div :: Frequency -> Frequency -> Frequency

mod :: Frequency -> Frequency -> Frequency

quotRem :: Frequency -> Frequency -> (Frequency, Frequency)

divMod :: Frequency -> Frequency -> (Frequency, Frequency)

toInteger :: Frequency -> Integer

Real Frequency

Defined in Data.Gibberish.Types

Methods

toRational :: Frequency -> Rational

Show Frequency

Defined in Data.Gibberish.Types

Methods

showsPrec :: Int -> Frequency -> ShowS

show :: Frequency -> String

showList :: [Frequency] -> ShowS

NFData Frequency

Defined in Data.Gibberish.Types

Methods

rnf :: Frequency -> ()

Eq Frequency

Defined in Data.Gibberish.Types

Methods

(==) :: Frequency -> Frequency -> Bool

(/=) :: Frequency -> Frequency -> Bool

Ord Frequency

Defined in Data.Gibberish.Types

Methods

compare :: Frequency -> Frequency -> Ordering

(<) :: Frequency -> Frequency -> Bool

(<=) :: Frequency -> Frequency -> Bool

(>) :: Frequency -> Frequency -> Bool

(>=) :: Frequency -> Frequency -> Bool

max :: Frequency -> Frequency -> Frequency

min :: Frequency -> Frequency -> Frequency

newtype Frequencies

Frequencies maps a unigram to a frequency

Constructors

Frequencies

Fields

• unFrequencies :: Map Unigram Frequency

Instances

FromJSON Frequencies

Defined in Data.Gibberish.Types

Methods

parseJSON :: Value -> Parser Frequencies

parseJSONList :: Value -> Parser [Frequencies]

omittedField :: Maybe Frequencies

ToJSON Frequencies

Defined in Data.Gibberish.Types

Methods

toJSON :: Frequencies -> Value

toEncoding :: Frequencies -> Encoding

toJSONList :: [Frequencies] -> Value

toEncodingList :: [Frequencies] -> Encoding

omitField :: Frequencies -> Bool

Show Frequencies

Defined in Data.Gibberish.Types

Methods

showsPrec :: Int -> Frequencies -> ShowS

show :: Frequencies -> String

showList :: [Frequencies] -> ShowS

NFData Frequencies

Defined in Data.Gibberish.Types

Methods

rnf :: Frequencies -> ()

Eq Frequencies

Defined in Data.Gibberish.Types

Methods

(==) :: Frequencies -> Frequencies -> Bool

(/=) :: Frequencies -> Frequencies -> Bool

Error Handling

data GibberishErr

Exceptions that can occur at runtime

Constructors

TrigraphNotFound FilePath

ImpossibleError

Instances

Exception GibberishErr

Defined in Data.Gibberish.Errors

Methods

toException :: GibberishErr -> SomeException

fromException :: SomeException -> Maybe GibberishErr

displayException :: GibberishErr -> String

Show GibberishErr

Defined in Data.Gibberish.Errors

Methods

showsPrec :: Int -> GibberishErr -> ShowS

show :: GibberishErr -> String

showList :: [GibberishErr] -> ShowS

Eq GibberishErr

Defined in Data.Gibberish.Errors

Methods

(==) :: GibberishErr -> GibberishErr -> Bool

(/=) :: GibberishErr -> GibberishErr -> Bool

isTrigraphNotFound :: GibberishErr -> Bool

isImpossibleError :: GibberishErr -> Bool

Working with Trigraphs

genTrigraph :: [Text] -> Trigraph

Generate trigraphs from a list of words

loadTrigraph :: Language -> IO Trigraph