Modulepgp-wordlist-0.1.0.3Haskell2010

Data.Text.PgpWordlist

Translate between binary data and a human-readable collection of words.

Synopsis

valuetoText :: ByteString -> Text

Inverse of fromText, modulo whitespace count.

Example1 expression

>>> toText (BSL.pack [104, 101, 108, 108, 111])"frighten glossary glucose handiwork gremlin"

valuefromText :: Text -> Either TranslationError ByteString

Convert a text of whitespace-separated words to their binary representation. The whitespace splitting behaviour is given by words.

Example1 expression

>>> fromText (T.pack "frighten glossary glucose handiwork gremlin")Right "hello"

Invalid words are recognized:

Example1 expression

>>> fromText (T.pack "frighten dragon glucose handiwork gremlin")Left (BadWord "dragon")

Typical mistakes include accidentally swapping numbers, which leads to a parity error:

Example1 expression

>>> fromText (T.pack "frighten glucose glossary handiwork gremlin")Left (BadParity "glucose" 108)

datadata TranslationError

Possible translation errors from a list of PGP words to binary format.

BadWord Text
Word is not recognized
BadParity Text Word8
Word is recognized, but from the wrong alphabet. Duplicates, omissions, and neighbour transpositions are often cause for this.

Instances3Eq, Ord, Show

Eq TranslationErrorDefined in pgp-wordlist-0.1.0.3 · Data.Text.PgpWordlist.Internal.Types
Ord TranslationErrorDefined in pgp-wordlist-0.1.0.3 · Data.Text.PgpWordlist.Internal.Types
Show TranslationErrorDefined in pgp-wordlist-0.1.0.3 · Data.Text.PgpWordlist.Internal.Types