| Copyright | © 2018-2021 IOHK |
|---|---|
| License | Apache-2.0 |
| Safe Haskell | None |
| Language | Haskell2010 |
Cardano.Wallet.Primitive.Passphrase.Types
Description
Synopsis
- newtype Passphrase (purpose :: Symbol ) = Passphrase { }
-
class
PassphraseMinLength
(purpose ::
Symbol
)
where
- passphraseMinLength :: Proxy purpose -> Int
-
class
PassphraseMaxLength
(purpose ::
Symbol
)
where
- passphraseMaxLength :: Proxy purpose -> Int
- validatePassphrase :: forall purpose. ( PassphraseMaxLength purpose, PassphraseMinLength purpose) => Text -> Either String ( Passphrase purpose)
- newtype PassphraseHash = PassphraseHash { }
- data PassphraseScheme
- data WalletPassphraseInfo = WalletPassphraseInfo { }
- data ErrWrongPassphrase
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. TheFromTextinstance enforces password length rules. -
"lenient"- like"user", except without a minimum length restriction inFromText.` -
"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
| Eq ( Passphrase purpose) Source # | |
|
Defined in Cardano.Wallet.Primitive.Passphrase.Types Methods (==) :: Passphrase purpose -> Passphrase purpose -> Bool Source # (/=) :: Passphrase purpose -> Passphrase purpose -> Bool Source # |
|
| Show ( Passphrase purpose) Source # | |
|
Defined in Cardano.Wallet.Primitive.Passphrase.Types |
|
| Semigroup ( Passphrase purpose) Source # | |
|
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 # | |
|
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 # | |
|
Defined in Cardano.Wallet.Primitive.Passphrase.Types Methods rnf :: Passphrase purpose -> () Source # |
|
| ToJSON ( ApiT ( Passphrase purpose)) Source # | |
|
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 # | |
|
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 # | |
|
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 # | |
|
Defined in Cardano.Wallet.Primitive.Passphrase.Types Methods toText :: Passphrase purpose -> Text Source # |
|
| ( PassphraseMaxLength purpose, PassphraseMinLength purpose) => FromText ( Passphrase purpose) Source # | |
|
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 :: MonadRandom m => Passphrase purpose -> m (Hash purpose) ~ encryptPassphrase :: Passphrase purpose -> Passphrase "salt" -> m (Hash purpose)
|
|
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
| PassphraseMinLength "lenient" Source # | |
|
Defined in Cardano.Wallet.Primitive.Passphrase.Types Methods passphraseMinLength :: Proxy "lenient" -> Int Source # |
|
| PassphraseMinLength "user" Source # | |
|
Defined in Cardano.Wallet.Primitive.Passphrase.Types Methods passphraseMinLength :: Proxy "user" -> Int Source # |
|
class PassphraseMaxLength (purpose :: Symbol ) where Source #
Instances
| PassphraseMaxLength "lenient" Source # | |
|
Defined in Cardano.Wallet.Primitive.Passphrase.Types Methods passphraseMaxLength :: Proxy "lenient" -> Int Source # |
|
| PassphraseMaxLength "user" Source # | |
|
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
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
data WalletPassphraseInfo Source #
Constructors
| WalletPassphraseInfo | |
|
Fields |
|
Instances
Error types
data ErrWrongPassphrase Source #
Indicate a failure when checking for a given
Passphrase
match