cardano-wallet-core-2022.7.1: The Wallet Backend for a Cardano node.
Copyright © 2018-2021 IOHK
License Apache-2.0
Safe Haskell None
Language Haskell2010

Cardano.Wallet.Primitive.Passphrase

Description

Hashing of wallet passwords.

Synopsis

Passphrases from the user

newtype Passphrase (purpose :: Symbol ) Source #

An encapsulated passphrase. The inner format is free, but the wrapper helps readability in function signatures.

Some type parameters in use are:

  • "user" - a passphrase entered by the user through the API. The FromText instance enforces password length rules.
  • "lenient" - like "user" , except without a minimum length restriction in FromText .`
  • "encryption" - the user's passphrase, transformed so that it can be used as the key for encrypting wallet keys.
  • "salt" - the random salt part of a hashed passphrase.

Constructors

Passphrase

Fields

Instances

Instances details
Eq ( Passphrase purpose) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

(==) :: Passphrase purpose -> Passphrase purpose -> Bool Source #

(/=) :: Passphrase purpose -> Passphrase purpose -> Bool Source #

Show ( Passphrase purpose) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

showsPrec :: Int -> Passphrase purpose -> ShowS Source #

show :: Passphrase purpose -> String Source #

showList :: [ Passphrase purpose] -> ShowS Source #

Semigroup ( Passphrase purpose) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

(<>) :: Passphrase purpose -> Passphrase purpose -> Passphrase purpose Source #

sconcat :: NonEmpty ( Passphrase purpose) -> Passphrase purpose Source #

stimes :: Integral b => b -> Passphrase purpose -> Passphrase purpose Source #

Monoid ( Passphrase purpose) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

mempty :: Passphrase purpose Source #

mappend :: Passphrase purpose -> Passphrase purpose -> Passphrase purpose Source #

mconcat :: [ Passphrase purpose] -> Passphrase purpose Source #

NFData ( Passphrase purpose) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

rnf :: Passphrase purpose -> () Source #

ToJSON ( ApiT ( Passphrase purpose)) Source #
Instance details

Defined in Cardano.Wallet.Api.Types

Methods

toJSON :: ApiT ( Passphrase purpose) -> Value Source #

toEncoding :: ApiT ( Passphrase purpose) -> Encoding Source #

toJSONList :: [ ApiT ( Passphrase purpose)] -> Value Source #

toEncodingList :: [ ApiT ( Passphrase purpose)] -> Encoding Source #

( PassphraseMaxLength purpose, PassphraseMinLength purpose) => FromJSON ( ApiT ( Passphrase purpose)) Source #
Instance details

Defined in Cardano.Wallet.Api.Types

Methods

parseJSON :: Value -> Parser ( ApiT ( Passphrase purpose)) Source #

parseJSONList :: Value -> Parser [ ApiT ( Passphrase purpose)] Source #

ByteArrayAccess ( Passphrase purpose) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

length :: Passphrase purpose -> Int Source #

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

copyByteArrayToPtr :: Passphrase purpose -> Ptr p -> IO () Source #

ToText ( Passphrase purpose) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

toText :: Passphrase purpose -> Text Source #

( PassphraseMaxLength purpose, PassphraseMinLength purpose) => FromText ( Passphrase purpose) Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

fromText :: Text -> Either TextDecodingError ( Passphrase purpose) Source #

MonadRandom ((->) ( Passphrase "salt") :: Type -> Type ) Source #

Little trick to be able to provide our own "random" salt in order to deterministically re-compute a passphrase hash from a known salt. Note that, this boils down to giving an extra argument to the encryptPassphrase function which is the salt, in order to make it behave deterministically. 

encryptPassphrase
  :: MonadRandom m
  => Passphrase purpose
  -> m (Hash purpose)

 ~

encryptPassphrase
  :: Passphrase purpose
  -> Passphrase "salt"
  -> m (Hash purpose)

>>> encryptPassphrase pwd (Passphrase @"salt" salt)
Hash "..."
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

getRandomBytes :: ByteArray byteArray => Int -> Passphrase "salt" -> byteArray Source #

class PassphraseMinLength (purpose :: Symbol ) where Source #

Methods

passphraseMinLength :: Proxy purpose -> Int Source #

Minimal Length for a passphrase, for lack of better validations

Instances

Instances details
PassphraseMinLength "lenient" Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

passphraseMinLength :: Proxy "lenient" -> Int Source #

PassphraseMinLength "user" Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

passphraseMinLength :: Proxy "user" -> Int Source #

class PassphraseMaxLength (purpose :: Symbol ) where Source #

Methods

passphraseMaxLength :: Proxy purpose -> Int Source #

Maximum length for a passphrase

Instances

Instances details
PassphraseMaxLength "lenient" Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

passphraseMaxLength :: Proxy "lenient" -> Int Source #

PassphraseMaxLength "user" Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

passphraseMaxLength :: Proxy "user" -> Int Source #

validatePassphrase :: forall purpose. ( PassphraseMaxLength purpose, PassphraseMinLength purpose) => Text -> Either String ( Passphrase purpose) Source #

Wallet passphrases stored as hashes

newtype PassphraseHash Source #

Constructors

PassphraseHash

Fields

Instances

Instances details
Eq PassphraseHash Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

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

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

Ord PassphraseHash Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

compare :: PassphraseHash -> PassphraseHash -> Ordering Source #

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

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

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

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

max :: PassphraseHash -> PassphraseHash -> PassphraseHash Source #

min :: PassphraseHash -> PassphraseHash -> PassphraseHash Source #

Show PassphraseHash Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

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

show :: PassphraseHash -> String Source #

showList :: [ PassphraseHash ] -> ShowS Source #

Semigroup PassphraseHash Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

(<>) :: PassphraseHash -> PassphraseHash -> PassphraseHash Source #

sconcat :: NonEmpty PassphraseHash -> PassphraseHash Source #

stimes :: Integral b => b -> PassphraseHash -> PassphraseHash Source #

Monoid PassphraseHash Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

mempty :: PassphraseHash Source #

mappend :: PassphraseHash -> PassphraseHash -> PassphraseHash Source #

mconcat :: [ PassphraseHash ] -> PassphraseHash Source #

NFData PassphraseHash Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

rnf :: PassphraseHash -> () Source #

ByteArray PassphraseHash Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

allocRet :: Int -> ( Ptr p -> IO a) -> IO (a, PassphraseHash ) Source #

ByteArrayAccess PassphraseHash Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

length :: PassphraseHash -> Int Source #

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

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

ToText PassphraseHash Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

toText :: PassphraseHash -> Text Source #

ToJSON ( ApiT PassphraseHash ) Source #
Instance details

Defined in Cardano.Wallet.Api.Types

Methods

toJSON :: ApiT PassphraseHash -> Value Source #

toEncoding :: ApiT PassphraseHash -> Encoding Source #

toJSONList :: [ ApiT PassphraseHash ] -> Value Source #

toEncodingList :: [ ApiT PassphraseHash ] -> Encoding Source #

FromJSON ( ApiT PassphraseHash ) Source #
Instance details

Defined in Cardano.Wallet.Api.Types

Methods

parseJSON :: Value -> Parser ( ApiT PassphraseHash ) Source #

parseJSONList :: Value -> Parser [ ApiT PassphraseHash ] Source #

FromText ( ApiT PassphraseHash ) Source #
Instance details

Defined in Cardano.Wallet.Api.Types

Methods

fromText :: Text -> Either TextDecodingError ( ApiT PassphraseHash ) Source #

data PassphraseScheme Source #

A type to capture which encryption scheme should be used

Constructors

EncryptWithScrypt

Legacy encryption scheme for passphrases

EncryptWithPBKDF2

Encryption scheme used since cardano-wallet

Instances

Instances details
Eq PassphraseScheme Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

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

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

Ord PassphraseScheme Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

compare :: PassphraseScheme -> PassphraseScheme -> Ordering Source #

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

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

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

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

max :: PassphraseScheme -> PassphraseScheme -> PassphraseScheme Source #

min :: PassphraseScheme -> PassphraseScheme -> PassphraseScheme Source #

Read PassphraseScheme Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

readsPrec :: Int -> ReadS PassphraseScheme Source #

readList :: ReadS [ PassphraseScheme ] Source #

readPrec :: ReadPrec PassphraseScheme Source #

readListPrec :: ReadPrec [ PassphraseScheme ] Source #

Show PassphraseScheme Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

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

show :: PassphraseScheme -> String Source #

showList :: [ PassphraseScheme ] -> ShowS Source #

Generic PassphraseScheme Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Associated Types

type Rep PassphraseScheme :: Type -> Type Source #

Methods

from :: PassphraseScheme -> Rep PassphraseScheme x Source #

to :: Rep PassphraseScheme x -> PassphraseScheme Source #

NFData PassphraseScheme Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

rnf :: PassphraseScheme -> () Source #

PersistFieldSql PassphraseScheme Source #
Instance details

Defined in Cardano.Wallet.DB.Sqlite.Types

Methods

sqlType :: Proxy PassphraseScheme -> SqlType Source #

PersistField PassphraseScheme Source #
Instance details

Defined in Cardano.Wallet.DB.Sqlite.Types

Methods

toPersistValue :: PassphraseScheme -> PersistValue Source #

fromPersistValue :: PersistValue -> Either Text PassphraseScheme Source #

ToText PassphraseScheme Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

toText :: PassphraseScheme -> Text Source #

SymbolToField "walPassphraseScheme" Wallet ( Maybe PassphraseScheme ) Source #
Instance details

Defined in Cardano.Wallet.DB.Sqlite.Schema

Methods

symbolToField :: EntityField Wallet ( Maybe PassphraseScheme ) Source #

type Rep PassphraseScheme Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

type Rep PassphraseScheme = D1 (' MetaData "PassphraseScheme" "Cardano.Wallet.Primitive.Passphrase.Types" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "EncryptWithScrypt" ' PrefixI ' False ) ( U1 :: Type -> Type ) :+: C1 (' MetaCons "EncryptWithPBKDF2" ' PrefixI ' False ) ( U1 :: Type -> Type ))

currentPassphraseScheme :: PassphraseScheme Source #

data WalletPassphraseInfo Source #

Constructors

WalletPassphraseInfo

Fields

Instances

Instances details
Eq WalletPassphraseInfo Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

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

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

Ord WalletPassphraseInfo Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

compare :: WalletPassphraseInfo -> WalletPassphraseInfo -> Ordering Source #

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

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

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

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

max :: WalletPassphraseInfo -> WalletPassphraseInfo -> WalletPassphraseInfo Source #

min :: WalletPassphraseInfo -> WalletPassphraseInfo -> WalletPassphraseInfo Source #

Show WalletPassphraseInfo Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

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

show :: WalletPassphraseInfo -> String Source #

showList :: [ WalletPassphraseInfo ] -> ShowS Source #

Generic WalletPassphraseInfo Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Associated Types

type Rep WalletPassphraseInfo :: Type -> Type Source #

Methods

from :: WalletPassphraseInfo -> Rep WalletPassphraseInfo x Source #

to :: Rep WalletPassphraseInfo x -> WalletPassphraseInfo Source #

NFData WalletPassphraseInfo Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

rnf :: WalletPassphraseInfo -> () Source #

type Rep WalletPassphraseInfo Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

type Rep WalletPassphraseInfo = D1 (' MetaData "WalletPassphraseInfo" "Cardano.Wallet.Primitive.Passphrase.Types" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "WalletPassphraseInfo" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "lastUpdatedAt") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 UTCTime ) :*: S1 (' MetaSel (' Just "passphraseScheme") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 PassphraseScheme )))

Operations

encryptPassphrase :: MonadRandom m => Passphrase "user" -> m ( PassphraseScheme , PassphraseHash ) Source #

Hashes a Passphrase into a format that is suitable for storing on disk. It will always use the current scheme: pbkdf2-hmac-sha512.

encryptPassphrase' :: MonadRandom m => PassphraseScheme -> Passphrase "user" -> m PassphraseHash Source #

checkPassphrase :: PassphraseScheme -> Passphrase "user" -> PassphraseHash -> Either ErrWrongPassphrase () Source #

Check whether a Passphrase matches with a stored Hash

preparePassphrase :: PassphraseScheme -> Passphrase "user" -> Passphrase "encryption" Source #

Manipulation done on legacy passphrases before used for encryption.

changePassphraseXPrv Source #

Arguments

:: ( PassphraseScheme , Passphrase "user")

Old passphrase

-> ( PassphraseScheme , Passphrase "user")

New passphrase

-> XPrv

Key to re-encrypt

-> XPrv

Re-encrypts a wallet private key with a new passphrase.

  • *Important**: This function doesn't check that the old passphrase is correct! Caller is expected to have already checked that. Using an incorrect passphrase here will lead to very bad thing.

checkAndChangePassphraseXPrv Source #

Arguments

:: MonadRandom m
=> (( PassphraseScheme , PassphraseHash ), Passphrase "user")

Old passphrase

-> Passphrase "user"

New passphrase

-> XPrv

Key to re-encrypt

-> m ( Either ErrWrongPassphrase (( PassphraseScheme , PassphraseHash ), XPrv ))

Re-encrypts a wallet private key with a new passphrase.

data ErrWrongPassphrase Source #

Indicate a failure when checking for a given Passphrase match

Constructors

ErrWrongPassphrase
ErrPassphraseSchemeUnsupported PassphraseScheme

Instances

Instances details
Eq ErrWrongPassphrase Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

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

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

Show ErrWrongPassphrase Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

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

show :: ErrWrongPassphrase -> String Source #

showList :: [ ErrWrongPassphrase ] -> ShowS Source #

Generic ErrWrongPassphrase Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Associated Types

type Rep ErrWrongPassphrase :: Type -> Type Source #

Methods

from :: ErrWrongPassphrase -> Rep ErrWrongPassphrase x Source #

to :: Rep ErrWrongPassphrase x -> ErrWrongPassphrase Source #

NFData ErrWrongPassphrase Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

Methods

rnf :: ErrWrongPassphrase -> () Source #

type Rep ErrWrongPassphrase Source #
Instance details

Defined in Cardano.Wallet.Primitive.Passphrase.Types

type Rep ErrWrongPassphrase = D1 (' MetaData "ErrWrongPassphrase" "Cardano.Wallet.Primitive.Passphrase.Types" "cardano-wallet-core-2022.7.1-AGKhlyz9liLKN3QqZD1gj" ' False ) ( C1 (' MetaCons "ErrWrongPassphrase" ' PrefixI ' False ) ( U1 :: Type -> Type ) :+: C1 (' MetaCons "ErrPassphraseSchemeUnsupported" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 PassphraseScheme )))