cardano-crypto-1.1.1: Cryptography primitives for cardano
Maintainer nicolas.diprima@iohk.io
Safe Haskell None
Language Haskell2010

Cardano.Crypto.Encoding.Seed

Description

implementation of the proposal specification for Paper Wallet see https://github.com/input-output-hk/cardano-specs/blob/master/proposals/0001-PaperWallet.md

however we allow more genericity in the implementation to allow not only 12 mnemonic words to freeze but also 15, 18 and 21.

because the output mnemonic words are always 3 words longer (for the IV) we cannot use 24 words long mnemonic sentence.

assumption:

  • we use PBKDF2 with 'HMAC 512' to generate the OTP.
  • we use 10000 iteration for the PBKDF2
  • we use the 4 bytes IOHK for the CONSTANT
Synopsis

Documentation

data Entropy (n :: Nat ) Source #

BIP39's entropy is a byte array of a given size (in bits, see ValidEntropySize for the valid size).

To it is associated

Instances

Instances details
Eq ( Entropy n) Source #
Instance details

Defined in Crypto.Encoding.BIP39

Methods

(==) :: Entropy n -> Entropy n -> Bool Source #

(/=) :: Entropy n -> Entropy n -> Bool Source #

Show ( Entropy n) Source #
Instance details

Defined in Crypto.Encoding.BIP39

Methods

showsPrec :: Int -> Entropy n -> ShowS Source #

show :: Entropy n -> String Source #

showList :: [ Entropy n] -> ShowS Source #

NormalForm ( Entropy n) Source #
Instance details

Defined in Crypto.Encoding.BIP39

Methods

toNormalForm :: Entropy n -> () Source #

Arbitrary ( Entropy 96) Source #
Instance details

Defined in Crypto.Encoding.BIP39

Methods

arbitrary :: Gen ( Entropy 96) Source #

Arbitrary ( Entropy 128) Source #
Instance details

Defined in Crypto.Encoding.BIP39

Methods

arbitrary :: Gen ( Entropy 128) Source #

Arbitrary ( Entropy 160) Source #
Instance details

Defined in Crypto.Encoding.BIP39

Methods

arbitrary :: Gen ( Entropy 160) Source #

Arbitrary ( Entropy 192) Source #
Instance details

Defined in Crypto.Encoding.BIP39

Methods

arbitrary :: Gen ( Entropy 192) Source #

Arbitrary ( Entropy 224) Source #
Instance details

Defined in Crypto.Encoding.BIP39

Methods

arbitrary :: Gen ( Entropy 224) Source #

Arbitrary ( Entropy 256) Source #
Instance details

Defined in Crypto.Encoding.BIP39

Methods

arbitrary :: Gen ( Entropy 256) Source #

type Passphrase = String Source #

data MnemonicSentence (mw :: Nat ) Source #

Mnemonic Sentence is a list of WordIndex .

This is the generic representation of a mnemonic phrase that can be used for transalating to a different dictionary (example: English to Japanese).

This is mainly used to convert from/to the Entropy and for cardanoSlSeed

Instances

Instances details
ValidMnemonicSentence mw => IsList ( MnemonicSentence mw) Source #
Instance details

Defined in Crypto.Encoding.BIP39

Associated Types

type Item ( MnemonicSentence mw) Source #

Methods

fromList :: [ Item ( MnemonicSentence mw)] -> MnemonicSentence mw Source #

fromListN :: Int -> [ Item ( MnemonicSentence mw)] -> MnemonicSentence mw Source #

toList :: MnemonicSentence mw -> [ Item ( MnemonicSentence mw)] Source #

Eq ( MnemonicSentence mw) Source #
Instance details

Defined in Crypto.Encoding.BIP39

Methods

(==) :: MnemonicSentence mw -> MnemonicSentence mw -> Bool Source #

(/=) :: MnemonicSentence mw -> MnemonicSentence mw -> Bool Source #

Ord ( MnemonicSentence mw) Source #
Instance details

Defined in Crypto.Encoding.BIP39

Methods

compare :: MnemonicSentence mw -> MnemonicSentence mw -> Ordering Source #

(<) :: MnemonicSentence mw -> MnemonicSentence mw -> Bool Source #

(<=) :: MnemonicSentence mw -> MnemonicSentence mw -> Bool Source #

(>) :: MnemonicSentence mw -> MnemonicSentence mw -> Bool Source #

(>=) :: MnemonicSentence mw -> MnemonicSentence mw -> Bool Source #

max :: MnemonicSentence mw -> MnemonicSentence mw -> MnemonicSentence mw Source #

min :: MnemonicSentence mw -> MnemonicSentence mw -> MnemonicSentence mw Source #

Show ( MnemonicSentence mw) Source #
Instance details

Defined in Crypto.Encoding.BIP39

Methods

showsPrec :: Int -> MnemonicSentence mw -> ShowS Source #

show :: MnemonicSentence mw -> String Source #

showList :: [ MnemonicSentence mw] -> ShowS Source #

NormalForm ( MnemonicSentence mw) Source #
Instance details

Defined in Crypto.Encoding.BIP39

Methods

toNormalForm :: MnemonicSentence mw -> () Source #

type Item ( MnemonicSentence mw) Source #
Instance details

Defined in Crypto.Encoding.BIP39

type Item ( MnemonicSentence mw) = WordIndex

type ConsistentEntropy ent mw csz = ( ValidEntropySize ent, ValidChecksumSize ent csz, ValidMnemonicSentence mw, MnemonicWords ent ~ mw) Source #

Type Constraint Alias to check the entropy size, the number of mnemonic words and the checksum size is consistent. i.e. that the following is true:

| entropysize | checksumsize | entropysize + checksumsize | mnemonicsize | +---------------+--------------+----------------------------+--------------+ | 96 | 3 | 99 | 9 | | 128 | 4 | 132 | 12 | | 160 | 5 | 165 | 15 | | 192 | 6 | 198 | 18 | | 224 | 7 | 231 | 21 | | 256 | 8 | 264 | 24 |

This type constraint alias also perform all the GHC's cumbersome type level literal handling.

data ScrambleIV Source #

Instances

Instances details
Eq ScrambleIV Source #
Instance details

Defined in Cardano.Crypto.Encoding.Seed

Methods

(==) :: ScrambleIV -> ScrambleIV -> Bool Source #

(/=) :: ScrambleIV -> ScrambleIV -> Bool Source #

Ord ScrambleIV Source #
Instance details

Defined in Cardano.Crypto.Encoding.Seed

Methods

compare :: ScrambleIV -> ScrambleIV -> Ordering Source #

(<) :: ScrambleIV -> ScrambleIV -> Bool Source #

(<=) :: ScrambleIV -> ScrambleIV -> Bool Source #

(>) :: ScrambleIV -> ScrambleIV -> Bool Source #

(>=) :: ScrambleIV -> ScrambleIV -> Bool Source #

max :: ScrambleIV -> ScrambleIV -> ScrambleIV Source #

min :: ScrambleIV -> ScrambleIV -> ScrambleIV Source #

Show ScrambleIV Source #
Instance details

Defined in Cardano.Crypto.Encoding.Seed

Methods

showsPrec :: Int -> ScrambleIV -> ShowS Source #

show :: ScrambleIV -> String Source #

showList :: [ ScrambleIV ] -> ShowS Source #

ByteArrayAccess ScrambleIV Source #
Instance details

Defined in Cardano.Crypto.Encoding.Seed

Methods

length :: ScrambleIV -> Int Source #

withByteArray :: ScrambleIV -> ( Ptr p -> IO a) -> IO a Source #

copyByteArrayToPtr :: ScrambleIV -> Ptr p -> IO () Source #

Arbitrary ScrambleIV Source #
Instance details

Defined in Cardano.Crypto.Encoding.Seed

Methods

arbitrary :: Gen ScrambleIV Source #

mkScrambleIV :: ByteString -> CryptoFailable ScrambleIV Source #

scramble :: forall entropysizeI entropysizeO mnemonicsize scramblesize csI csO. ( ConsistentEntropy entropysizeI mnemonicsize csI, ConsistentEntropy entropysizeO scramblesize csO, (mnemonicsize + IVSizeWords ) ~ scramblesize, (entropysizeI + IVSizeBits ) ~ entropysizeO) => ScrambleIV -> Entropy entropysizeI -> Passphrase -> Entropy entropysizeO Source #

scramble the given entropy into an entropy slighly larger.

This entropy can then be converted to a mnemonic sentence: 

freeze iv mnemonics passphrase = entropyToWords . scramble iv entropy passphrase
  where
    entropy = case wordsToEntropy mnemonics of
        Nothing -> error "mnemonic to entropy failed"
        Just e  -> e

unscramble :: forall entropysizeI entropysizeO mnemonicsize scramblesize csI csO. ( ConsistentEntropy entropysizeI scramblesize csI, ConsistentEntropy entropysizeO mnemonicsize csO, (mnemonicsize + IVSizeWords ) ~ scramblesize, (entropysizeO + IVSizeBits ) ~ entropysizeI) => Entropy entropysizeI -> Passphrase -> Entropy entropysizeO Source #

The reverse operation of scramble

This function recovers the original entropy from the given scrambled entropy and the associated password. 

recover scrambled passphrase = entropyToWords entropysizeO .
    unscramble entropysizeI entropysizeO entropyScrambled passphrase
  where
    entropyScrambled = case wordsToEntropy entropysizeI scrambled of
        Nothing -> error "mnemonic to entropy failed"
        Just e  -> e

type IVSizeWords = 6 Source #

type IVSizeBits = 64 Source #

scrambleMnemonic :: forall entropysizeI entropysizeO mnemonicsize scramblesize csI csO. ( ConsistentEntropy entropysizeI mnemonicsize csI, ConsistentEntropy entropysizeO scramblesize csO, (mnemonicsize + IVSizeWords ) ~ scramblesize, (entropysizeI + IVSizeBits ) ~ entropysizeO) => Proxy entropysizeI -> ScrambleIV -> MnemonicSentence mnemonicsize -> Passphrase -> MnemonicSentence scramblesize Source #

helper function to scramble mnemonics