Crypto.Saltine.Core.Password

Password hashing and key derivation

When in doubt, just use one of [ interactivePolicy, moderatePolicy, sensitivePolicy ], but this module also allows you to fine-tune parameters for specific circumstances.

This module uses the Text type for passwords, because this seems to be the only reasonable way to get consistent encodings across locales and architectures, short of letting users mess around with ByteStrings themselves.

Documentation

data Salt

Salt for deriving keys from passwords

Instances

Data Salt

Defined in Crypto.Saltine.Internal.Password

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Salt -> c Salt

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Salt

toConstr :: Salt -> Constr

dataTypeOf :: Salt -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Salt)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Salt)

gmapT :: (forall b. Data b => b -> b) -> Salt -> Salt

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Salt -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Salt -> r

gmapQ :: (forall d. Data d => d -> u) -> Salt -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Salt -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Salt -> m Salt

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Salt -> m Salt

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Salt -> m Salt

Generic Salt

Defined in Crypto.Saltine.Internal.Password

Associated Types

type Rep Salt :: Type -> Type

Methods

from :: Salt -> Rep Salt x

to :: Rep Salt x -> Salt

Show Salt

Defined in Crypto.Saltine.Internal.Password

Methods

showsPrec :: Int -> Salt -> ShowS

show :: Salt -> String

showList :: [Salt] -> ShowS

NFData Salt

Defined in Crypto.Saltine.Internal.Password

Methods

rnf :: Salt -> ()

Eq Salt

Defined in Crypto.Saltine.Internal.Password

Methods

(==) :: Salt -> Salt -> Bool

(/=) :: Salt -> Salt -> Bool

Ord Salt

Defined in Crypto.Saltine.Internal.Password

Methods

compare :: Salt -> Salt -> Ordering

(<) :: Salt -> Salt -> Bool

(<=) :: Salt -> Salt -> Bool

(>) :: Salt -> Salt -> Bool

(>=) :: Salt -> Salt -> Bool

max :: Salt -> Salt -> Salt

min :: Salt -> Salt -> Salt

Hashable Salt

Defined in Crypto.Saltine.Internal.Password

Methods

hashWithSalt :: Int -> Salt -> Int

hash :: Salt -> Int

IsEncoding Salt

Defined in Crypto.Saltine.Internal.Password

Methods

encode :: Salt -> ByteString

decode :: ByteString -> Maybe Salt

encoded :: (Choice p, Applicative f) => p Salt (f Salt) -> p ByteString (f ByteString)

type Rep Salt

Defined in Crypto.Saltine.Internal.Password

type Rep Salt = D1 ('MetaData "Salt" "Crypto.Saltine.Internal.Password" "saltine-0.2.1.0-inplace" 'True) (C1 ('MetaCons "Salt" 'PrefixI 'True) (S1 ('MetaSel ('Just "unSalt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

newSalt :: IO Salt

needsRehash :: Opslimit -> Memlimit -> PasswordHash -> Maybe Bool

Indicates whether a password needs to be rehashed, because the opslimit/memlimit parameters used to hash the password are inconsistent with the supplied values. Returns Nothing if the hash appears to be invalid. Internally this function will always use the current DefaultAlgorithm and hence will give undefined results if a different algorithm was used to hash the password.

pwhashStr :: Text -> Policy -> IO (Maybe PasswordHash)

Hashes a password according to the policy This function is non-deterministic and hence in IO. Since this function may cause a huge amount of memory to be allocated, it will return Nothing if the allocation failed and on any other error.

pwhashStrVerify :: PasswordHash -> Text -> Bool

Verifies that a certain password hash was constructed from the supplied password

pwhash :: Text -> Int -> Salt -> Policy -> Maybe ByteString

Derives a key of the specified length from a password using a salt according to the provided policy. Since this function may cause a huge amount of memory to be allocated, it will return Nothing if the allocation failed and on any other error.

data Policy

Wrapper for opslimit, memlimit and algorithm

Constructors

Policy

Fields

• opsPolicy :: Opslimit
• memPolicy :: Memlimit
• algPolicy :: Algorithm

Instances

Data Policy

Defined in Crypto.Saltine.Internal.Password

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Policy -> c Policy

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Policy

toConstr :: Policy -> Constr

dataTypeOf :: Policy -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Policy)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Policy)

gmapT :: (forall b. Data b => b -> b) -> Policy -> Policy

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Policy -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Policy -> r

gmapQ :: (forall d. Data d => d -> u) -> Policy -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Policy -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Policy -> m Policy

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Policy -> m Policy

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Policy -> m Policy

Generic Policy

Defined in Crypto.Saltine.Internal.Password

Associated Types

type Rep Policy :: Type -> Type

Methods

from :: Policy -> Rep Policy x

to :: Rep Policy x -> Policy

Show Policy

Defined in Crypto.Saltine.Internal.Password

Methods

showsPrec :: Int -> Policy -> ShowS

show :: Policy -> String

showList :: [Policy] -> ShowS

Eq Policy

Defined in Crypto.Saltine.Internal.Password

Methods

(==) :: Policy -> Policy -> Bool

(/=) :: Policy -> Policy -> Bool

Ord Policy

Defined in Crypto.Saltine.Internal.Password

Methods

compare :: Policy -> Policy -> Ordering

(<) :: Policy -> Policy -> Bool

(<=) :: Policy -> Policy -> Bool

(>) :: Policy -> Policy -> Bool

(>=) :: Policy -> Policy -> Bool

max :: Policy -> Policy -> Policy

min :: Policy -> Policy -> Policy

Hashable Policy

Defined in Crypto.Saltine.Internal.Password

Methods

hashWithSalt :: Int -> Policy -> Int

hash :: Policy -> Int

type Rep Policy

Defined in Crypto.Saltine.Internal.Password

type Rep Policy = D1 ('MetaData "Policy" "Crypto.Saltine.Internal.Password" "saltine-0.2.1.0-inplace" 'False) (C1 ('MetaCons "Policy" 'PrefixI 'True) (S1 ('MetaSel ('Just "opsPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Opslimit) :*: (S1 ('MetaSel ('Just "memPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Memlimit) :*: S1 ('MetaSel ('Just "algPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Algorithm))))

interactivePolicy :: Policy

moderatePolicy :: Policy

Moderate policy with a balance of speed and security

Takes approximately 1 second on a typical desktop computer and requires 256 MiB of dedicated RAM

sensitivePolicy :: Policy

High-security policy designed to make attacking the password extremely expensive

Takes several seconds on a typical desktop computer and requires 1024 MiB of dedicated RAM

data Opslimit

Wrapper type for the operations used by password hashing

Instances

Data Opslimit

Defined in Crypto.Saltine.Internal.Password

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Opslimit -> c Opslimit

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Opslimit

toConstr :: Opslimit -> Constr

dataTypeOf :: Opslimit -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Opslimit)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Opslimit)

gmapT :: (forall b. Data b => b -> b) -> Opslimit -> Opslimit

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Opslimit -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Opslimit -> r

gmapQ :: (forall d. Data d => d -> u) -> Opslimit -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Opslimit -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Opslimit -> m Opslimit

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Opslimit -> m Opslimit

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Opslimit -> m Opslimit

Generic Opslimit

Defined in Crypto.Saltine.Internal.Password

Associated Types

type Rep Opslimit :: Type -> Type

Methods

from :: Opslimit -> Rep Opslimit x

to :: Rep Opslimit x -> Opslimit

Show Opslimit

Defined in Crypto.Saltine.Internal.Password

Methods

showsPrec :: Int -> Opslimit -> ShowS

show :: Opslimit -> String

showList :: [Opslimit] -> ShowS

NFData Opslimit

Defined in Crypto.Saltine.Internal.Password

Methods

rnf :: Opslimit -> ()

Eq Opslimit

Defined in Crypto.Saltine.Internal.Password

Methods

(==) :: Opslimit -> Opslimit -> Bool

(/=) :: Opslimit -> Opslimit -> Bool

Ord Opslimit

Defined in Crypto.Saltine.Internal.Password

Methods

compare :: Opslimit -> Opslimit -> Ordering

(<) :: Opslimit -> Opslimit -> Bool

(<=) :: Opslimit -> Opslimit -> Bool

(>) :: Opslimit -> Opslimit -> Bool

(>=) :: Opslimit -> Opslimit -> Bool

max :: Opslimit -> Opslimit -> Opslimit

min :: Opslimit -> Opslimit -> Opslimit

Hashable Opslimit

Defined in Crypto.Saltine.Internal.Password

Methods

hashWithSalt :: Int -> Opslimit -> Int

hash :: Opslimit -> Int

type Rep Opslimit

Defined in Crypto.Saltine.Internal.Password

type Rep Opslimit = D1 ('MetaData "Opslimit" "Crypto.Saltine.Internal.Password" "saltine-0.2.1.0-inplace" 'True) (C1 ('MetaCons "Opslimit" 'PrefixI 'True) (S1 ('MetaSel ('Just "getOpslimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

opslimit :: Algorithm -> Int -> Maybe Opslimit

Smart constructor for opslimit

getOpslimit :: Opslimit -> Int

minOpslimit :: Algorithm -> Opslimit

maxOpslimit :: Algorithm -> Opslimit

opslimitInteractive :: Algorithm -> Opslimit

opslimitModerate :: Algorithm -> Opslimit

opslimitSensitive :: Algorithm -> Opslimit

data Memlimit

Wrapper type for the memory used by password hashing

Instances

Data Memlimit

Defined in Crypto.Saltine.Internal.Password

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Memlimit -> c Memlimit

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Memlimit

toConstr :: Memlimit -> Constr

dataTypeOf :: Memlimit -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Memlimit)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Memlimit)

gmapT :: (forall b. Data b => b -> b) -> Memlimit -> Memlimit

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Memlimit -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Memlimit -> r

gmapQ :: (forall d. Data d => d -> u) -> Memlimit -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Memlimit -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Memlimit -> m Memlimit

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Memlimit -> m Memlimit

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Memlimit -> m Memlimit

Generic Memlimit

Defined in Crypto.Saltine.Internal.Password

Associated Types

type Rep Memlimit :: Type -> Type

Methods

from :: Memlimit -> Rep Memlimit x

to :: Rep Memlimit x -> Memlimit

Show Memlimit

Defined in Crypto.Saltine.Internal.Password

Methods

showsPrec :: Int -> Memlimit -> ShowS

show :: Memlimit -> String

showList :: [Memlimit] -> ShowS

NFData Memlimit

Defined in Crypto.Saltine.Internal.Password

Methods

rnf :: Memlimit -> ()

Eq Memlimit

Defined in Crypto.Saltine.Internal.Password

Methods

(==) :: Memlimit -> Memlimit -> Bool

(/=) :: Memlimit -> Memlimit -> Bool

Ord Memlimit

Defined in Crypto.Saltine.Internal.Password

Methods

compare :: Memlimit -> Memlimit -> Ordering

(<) :: Memlimit -> Memlimit -> Bool

(<=) :: Memlimit -> Memlimit -> Bool

(>) :: Memlimit -> Memlimit -> Bool

(>=) :: Memlimit -> Memlimit -> Bool

max :: Memlimit -> Memlimit -> Memlimit

min :: Memlimit -> Memlimit -> Memlimit

Hashable Memlimit

Defined in Crypto.Saltine.Internal.Password

Methods

hashWithSalt :: Int -> Memlimit -> Int

hash :: Memlimit -> Int

type Rep Memlimit

Defined in Crypto.Saltine.Internal.Password

type Rep Memlimit = D1 ('MetaData "Memlimit" "Crypto.Saltine.Internal.Password" "saltine-0.2.1.0-inplace" 'True) (C1 ('MetaCons "Memlimit" 'PrefixI 'True) (S1 ('MetaSel ('Just "getMemlimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

memlimit :: Algorithm -> Int -> Maybe Memlimit

Smart constructor for memlimit

getMemlimit :: Memlimit -> Int

minMemlimit :: Algorithm -> Memlimit

maxMemlimit :: Algorithm -> Memlimit

memlimitInteractive :: Algorithm -> Memlimit

memlimitModerate :: Algorithm -> Memlimit

memlimitSensitive :: Algorithm -> Memlimit

data Algorithm

Algorithms known to Libsodium, as an enum datatype

Instances

Data Algorithm

Defined in Crypto.Saltine.Internal.Password

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Algorithm -> c Algorithm

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Algorithm

toConstr :: Algorithm -> Constr

dataTypeOf :: Algorithm -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Algorithm)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Algorithm)

gmapT :: (forall b. Data b => b -> b) -> Algorithm -> Algorithm

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Algorithm -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Algorithm -> r

gmapQ :: (forall d. Data d => d -> u) -> Algorithm -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Algorithm -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Algorithm -> m Algorithm

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Algorithm -> m Algorithm

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Algorithm -> m Algorithm

Bounded Algorithm

Defined in Crypto.Saltine.Internal.Password

Methods

minBound :: Algorithm

maxBound :: Algorithm

Enum Algorithm

Defined in Crypto.Saltine.Internal.Password

Methods

succ :: Algorithm -> Algorithm

pred :: Algorithm -> Algorithm

toEnum :: Int -> Algorithm

fromEnum :: Algorithm -> Int

enumFrom :: Algorithm -> [Algorithm]

enumFromThen :: Algorithm -> Algorithm -> [Algorithm]

enumFromTo :: Algorithm -> Algorithm -> [Algorithm]

enumFromThenTo :: Algorithm -> Algorithm -> Algorithm -> [Algorithm]

Generic Algorithm

Defined in Crypto.Saltine.Internal.Password

Associated Types

type Rep Algorithm :: Type -> Type

Methods

from :: Algorithm -> Rep Algorithm x

to :: Rep Algorithm x -> Algorithm

Show Algorithm

Defined in Crypto.Saltine.Internal.Password

Methods

showsPrec :: Int -> Algorithm -> ShowS

show :: Algorithm -> String

showList :: [Algorithm] -> ShowS

Eq Algorithm

Defined in Crypto.Saltine.Internal.Password

Methods

(==) :: Algorithm -> Algorithm -> Bool

(/=) :: Algorithm -> Algorithm -> Bool

Ord Algorithm

Defined in Crypto.Saltine.Internal.Password

Methods

compare :: Algorithm -> Algorithm -> Ordering

(<) :: Algorithm -> Algorithm -> Bool

(<=) :: Algorithm -> Algorithm -> Bool

(>) :: Algorithm -> Algorithm -> Bool

(>=) :: Algorithm -> Algorithm -> Bool

max :: Algorithm -> Algorithm -> Algorithm

min :: Algorithm -> Algorithm -> Algorithm

Hashable Algorithm

Defined in Crypto.Saltine.Internal.Password

Methods

hashWithSalt :: Int -> Algorithm -> Int

hash :: Algorithm -> Int

type Rep Algorithm

Defined in Crypto.Saltine.Internal.Password

type Rep Algorithm = D1 ('MetaData "Algorithm" "Crypto.Saltine.Internal.Password" "saltine-0.2.1.0-inplace" 'False) (C1 ('MetaCons "DefaultAlgorithm" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Argon2i13" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Argon2id13" 'PrefixI 'False) (U1 :: Type -> Type)))

defaultAlgorithm :: Algorithm