-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implementation of mnemonic generation and key derivation
- Loading branch information
Showing
4 changed files
with
223 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,155 @@ | ||
| {-# LANGUAGE DataKinds #-} | ||
| {-# LANGUAGE InstanceSigs #-} | ||
| {-# LANGUAGE TypeApplications #-} | ||
|
|
||
| module Cardano.Api.Keys.Mnemonics | ||
| ( MnemonicSize (..) | ||
| , generateMnemonic | ||
| , MnemonicToSigningStakeKeyError (..) | ||
| , SecondFactor | ||
| , ExtendedSigningKeyRole (..) | ||
| , signingKeyFromMnemonic | ||
| ) | ||
| where | ||
|
|
||
| import Cardano.Api.Keys.Class (Key (..)) | ||
| import Cardano.Api.Keys.Shelley (AsType, PaymentExtendedKey, | ||
| SigningKey (PaymentExtendedSigningKey, StakeExtendedSigningKey), | ||
| StakeExtendedKey) | ||
| import Cardano.Api.SerialiseRaw (SerialiseAsRawBytesError) | ||
|
|
||
| import Cardano.Address.Derivation (Depth (..), DerivationType (..), HardDerivation (..), | ||
| Index, XPrv, genMasterKeyFromMnemonic, indexFromWord32) | ||
| import Cardano.Address.Style.Shelley (Role (..), Shelley (..)) | ||
| import Cardano.Mnemonic (MkSomeMnemonic (mkSomeMnemonic), MkSomeMnemonicError (..), | ||
| SomeMnemonic, entropyToMnemonic, genEntropy, mnemonicToText, someMnemonicToBytes) | ||
|
|
||
| import Control.Monad.IO.Class (MonadIO, liftIO) | ||
| import qualified Data.ByteArray as BA | ||
| import Data.ByteString (ByteString) | ||
| import Data.Either.Combinators (mapLeft, maybeToRight) | ||
| import Data.Text (Text) | ||
| import Data.Word (Word32) | ||
|
|
||
| -- | The size of a mnemonic sentence. | ||
| -- The size is given in the number of words in the sentence. | ||
| -- The allowed sizes are 9, 12, 15, 18, 21, and 24. | ||
| data MnemonicSize | ||
| = MS_9 | ||
| | MS_12 | ||
| | MS_15 | ||
| | MS_18 | ||
| | MS_21 | ||
| | MS_24 | ||
| deriving (Eq, Show) | ||
|
|
||
| -- | Generate a mnemonic sentence of the given size. | ||
| generateMnemonic | ||
| :: MonadIO m | ||
| => MnemonicSize | ||
| -- ^ The size of the mnemonic sentence to generate. | ||
| -- Must be one of 9, 12, 15, 18, 21, or 24. | ||
| -> m [Text] | ||
| generateMnemonic MS_9 = liftIO (mnemonicToText @9 . entropyToMnemonic <$> genEntropy) | ||
| generateMnemonic MS_12 = liftIO (mnemonicToText @12 . entropyToMnemonic <$> genEntropy) | ||
| generateMnemonic MS_15 = liftIO (mnemonicToText @15 . entropyToMnemonic <$> genEntropy) | ||
| generateMnemonic MS_18 = liftIO (mnemonicToText @18 . entropyToMnemonic <$> genEntropy) | ||
| generateMnemonic MS_21 = liftIO (mnemonicToText @21 . entropyToMnemonic <$> genEntropy) | ||
| generateMnemonic MS_24 = liftIO (mnemonicToText @24 . entropyToMnemonic <$> genEntropy) | ||
|
|
||
| -- | Errors that can occur when converting a mnemonic sentence to a signing key | ||
| -- using the 'signingStakeKeyFromMnemonic' function. | ||
| data MnemonicToSigningStakeKeyError | ||
| = InvalidMnemonicError String | ||
| | InvalidSecondFactorMnemonicError String | ||
| | InvalidAccountNumberError Word32 | ||
| | InvalidPaymentKeyNoError Word32 | ||
| | InternalErrorConvertingToByteString SerialiseAsRawBytesError | ||
| deriving (Eq, Show) | ||
|
|
||
| -- | The second factor for the key derivation. | ||
| data SecondFactor | ||
| = -- | Use a mnemonic sentence as the second factor. | ||
| FromMnemonic [Text] | ||
| | -- | Use a raw byte string as the second factor. | ||
| FromByteString ByteString | ||
| deriving (Eq, Show) | ||
|
|
||
| class ExtendedSigningKeyRole keyrole where | ||
| -- | Convert the key role to a derivation role. | ||
| asDerivationRole :: AsType keyrole -> Role | ||
|
|
||
| -- | Convert an extended private key to a SigningKey. | ||
| asSigningKeyRole :: XPrv -> SigningKey keyrole | ||
|
|
||
| -- | ExtendedSigningKeyRole instance for the PaymentExtendedKey key role. | ||
| instance ExtendedSigningKeyRole PaymentExtendedKey where | ||
| asDerivationRole :: AsType PaymentExtendedKey -> Role | ||
| asDerivationRole _ = UTxOExternal | ||
|
|
||
| asSigningKeyRole :: XPrv -> SigningKey PaymentExtendedKey | ||
| asSigningKeyRole = PaymentExtendedSigningKey | ||
|
|
||
| -- | ExtendedSigningKeyRole instance for the StakeExtendedKey key role. | ||
| instance ExtendedSigningKeyRole StakeExtendedKey where | ||
| asDerivationRole :: AsType StakeExtendedKey -> Role | ||
| asDerivationRole _ = Stake | ||
|
|
||
| asSigningKeyRole :: XPrv -> SigningKey StakeExtendedKey | ||
| asSigningKeyRole = StakeExtendedSigningKey | ||
|
|
||
| -- | Generate a signing key from a mnemonic sentence. | ||
| -- A derivation path is like a file path in a file system. It specifies the | ||
| -- location of a key in the key tree. The path is a list of indices, one for each | ||
| -- level of the tree. The indices are separated by a forward slash (/). | ||
| -- In this function we only ask for two indices: the account number and the | ||
| -- payment key number. Each account can have multiple payment keys. | ||
| signingKeyFromMnemonic | ||
| :: ExtendedSigningKeyRole keyrole | ||
| => AsType keyrole | ||
| -- ^ Type of the extended signing key to generate. | ||
| -> [Text] | ||
| -- ^ The mnemonic sentence. The length must be one of 9, 12, 15, 18, 21, or 24. | ||
| -- Each element of the list must be a single word. | ||
| -> Maybe SecondFactor | ||
| -- ^ The second factor for the key derivation. If 'Nothing', the key is derived | ||
| -- without a second factor. | ||
| -> Word32 | ||
| -- ^ The account number in the derivation path. First account is 0. | ||
| -> Word32 | ||
| -- ^ The payment key number in the derivation path. First key is 0. | ||
| -> Either MnemonicToSigningStakeKeyError (SigningKey keyrole) | ||
| signingKeyFromMnemonic role mnemonicWords mSecondFactor accNo payKeyNo = do | ||
| -- Convert raw types to the ones used in the cardano-addresses library | ||
| someMnemonic <- mapLeft InvalidMnemonicError $ wordsToSomeMnemonic mnemonicWords | ||
| secondFactorBytes <- toSecondFactor mSecondFactor | ||
| accIx <- | ||
| maybeToRight (InvalidAccountNumberError accNo) $ | ||
| indexFromWord32 @(Index 'Hardened 'AccountK) (0x80000000 + accNo) | ||
| payKeyIx <- | ||
| maybeToRight (InvalidPaymentKeyNoError payKeyNo) $ indexFromWord32 @(Index 'Soft 'PaymentK) payKeyNo | ||
|
|
||
| -- Derive the rootk key | ||
| let rootK = genMasterKeyFromMnemonic someMnemonic secondFactorBytes :: Shelley 'RootK XPrv | ||
| -- Derive the account key | ||
| accK = deriveAccountPrivateKey rootK accIx | ||
| -- Derive the payment key | ||
| prvK = deriveAddressPrivateKey accK (asDerivationRole role) payKeyIx | ||
|
|
||
| -- Finally we wrap it in the API type | ||
| return $ asSigningKeyRole $ getKey prvK | ||
| where | ||
| -- Convert the ByteString to a SigningKey | ||
|
|
||
| -- Convert the mnemonic sentence to a SomeMnemonic value | ||
| wordsToSomeMnemonic :: [Text] -> Either String SomeMnemonic | ||
| wordsToSomeMnemonic = mapLeft getMkSomeMnemonicError . mkSomeMnemonic @[9, 12, 15, 18, 21, 24] | ||
|
|
||
| -- Convert the second factor to a ScrubbedBytes value or mempty if none | ||
| toSecondFactor :: Maybe SecondFactor -> Either MnemonicToSigningStakeKeyError BA.ScrubbedBytes | ||
| toSecondFactor Nothing = return mempty | ||
| toSecondFactor (Just (FromMnemonic secondFactorWords)) = | ||
| someMnemonicToBytes | ||
| <$> mapLeft InvalidSecondFactorMnemonicError (wordsToSomeMnemonic secondFactorWords) | ||
| toSecondFactor (Just (FromByteString secondFactorBytes)) = | ||
| return $ BA.convert secondFactorBytes |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters