Crypto.PHKDF.Primitives

Documentation

data HmacKey

A cached, precomputed hmac key. It comes in two flavors, one that remembers the plaintext key, and one that doesn't, remembering only the precomputed hmac key.

Computing an hmac key typically requires two SHA256 blocks, unless the key itself is more than 64 bytes, in which case precomputing the key will require at least four SHA256 blocks.

Instances

Eq HmacKey

Defined in Crypto.Sha256.Hmac.Implementation

Methods

(==) :: HmacKey -> HmacKey -> Bool

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

Ord HmacKey

Defined in Crypto.Sha256.Hmac.Implementation

Methods

compare :: HmacKey -> HmacKey -> Ordering

(<) :: HmacKey -> HmacKey -> Bool

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

(>) :: HmacKey -> HmacKey -> Bool

(>=) :: HmacKey -> HmacKey -> Bool

max :: HmacKey -> HmacKey -> HmacKey

min :: HmacKey -> HmacKey -> HmacKey

hmacKey :: HmacKeyPlain -> HmacKey

data PhkdfCtx

phkdfCtx :: ByteString -> PhkdfCtx

initialize an empty phkdfStream context from a plaintext HMAC key.

phkdfCtx_init :: HmacKey -> PhkdfCtx

initialize an empty phkdfStream context from a plaintext or precomputed HMAC key.

phkdfCtx_initHashed :: HmacKeyHashed -> PhkdfCtx

initialize an empty phkdfStream context from a precomputed HMAC key.

phkdfCtx_initPrefixed :: ByteString -> HmacKeyPrefixed -> PhkdfCtx

initialize an empty phkdfStream context from a buffer-prefixed HMAC key.

phkdfCtx_initLike :: HmacKeyLike -> PhkdfCtx

initialize an empty phkdfStream context from a plaintext, precomputed, or buffer-prefixed HMAC key.

phkdfCtx_hmacKeyPlain :: PhkdfCtx -> Maybe HmacKeyPlain

phkdfCtx_hmacKeyHashed :: PhkdfCtx -> Maybe HmacKeyHashed

phkdfCtx_hmacKeyPrefixed :: PhkdfCtx -> HmacKeyPrefixed

phkdfCtx_hmacKey :: PhkdfCtx -> Maybe HmacKey

phkdfCtx_hmacKeyLike :: PhkdfCtx -> HmacKeyLike

phkdfCtx_toResetHmacCtx :: PhkdfCtx -> HmacCtx

initialize a new empty HMAC context from the key originally supplied to the PHKDF context, discarding all arguments already added.

phkdfCtx_reset :: PhkdfCtx -> PhkdfCtx

initialize a new empty phkdfStream context from the HMAC key originally supplied to the context, discarding all arguments already added.

phkdfCtx_feedArg :: ByteString -> PhkdfCtx -> PhkdfCtx

append a single string onto the end of phkdfStream's list of arguments.

phkdfCtx_feedArgs :: Foldable f => f ByteString -> PhkdfCtx -> PhkdfCtx

append zero or more strings onto the end of phkdfStream's list of arguments.

phkdfCtx_feedArgsBy :: Foldable f => (a -> ByteString) -> f a -> PhkdfCtx -> PhkdfCtx

phkdfCtx_feedArgConcat :: Foldable f => f ByteString -> PhkdfCtx -> PhkdfCtx

phkdfCtx_finalize :: (Int -> ByteString) -> Word32 -> ByteString -> PhkdfCtx -> ByteString

close out a phkdfStream context using the first mode of operation, examining only the first output block and discarding the rest of the stream.

phkdfCtx_finalizeHmac :: PhkdfCtx -> ByteString

"improperly" close out a PhkdfCtx as if it were a call to hmac instead of phkdfStream, though with a TupleHash message encoding.

phkdfCtx_toHmacCtx :: PhkdfCtx -> HmacCtx

Turn a PhkdfCtx into a incomplete call to hmac, with the option of adding additional data to the end of the message that need not be TupleHash encoded.

phkdfCtx_toStream :: (Int -> ByteString) -> Word32 -> ByteString -> PhkdfCtx -> Stream ByteString

close out a phkdfStream context with a given counter and tag

phkdfCtx_toGen :: (Int -> ByteString) -> Word32 -> ByteString -> PhkdfCtx -> PhkdfGen

data PhkdfSlowCtx

phkdfSlowCtx_extract :: (Int -> ByteString) -> Word32 -> ByteString -> ByteString -> Word32 -> PhkdfCtx -> PhkdfSlowCtx

close out a phkdfStream context with a call to phkdfSlowExtract, providing the counter, tag, fnName, and number of rounds to compute. Note that fnName is truncated to a length of 25-29 bytes long, depending upon the number of rounds specified. Thus the fnName is primarily intended to be a protocol constant.

phkdfSlowCtx_feedArg :: ByteString -> PhkdfSlowCtx -> PhkdfSlowCtx

Add a tweak to a call to phkdfSlowExtract.

phkdfSlowCtx_feedArgs :: Foldable f => f ByteString -> PhkdfSlowCtx -> PhkdfSlowCtx

Add zero or more tweaks to a call to phkdfSlowExtract.

phkdfSlowCtx_finalize :: (Int -> ByteString) -> PhkdfSlowCtx -> ByteString

finalize a call to phkdfSlowExtract, discarding all but the first block of the output stream

phkdfSlowCtx_toStream :: (Int -> ByteString) -> PhkdfSlowCtx -> Stream ByteString

finalize a call to phkdfSlowExtract

data PhkdfGen

phkdfGen :: ByteString -> ByteString -> Word32 -> ByteString -> PhkdfGen

phkdfGen_init :: HmacKey -> ByteString -> Word32 -> ByteString -> PhkdfGen

phkdfGen_initHashed :: HmacKeyHashed -> ByteString -> Word32 -> ByteString -> PhkdfGen

phkdfGen_initPrefixed :: HmacKeyPrefixed -> ByteString -> Word32 -> ByteString -> PhkdfGen

phkdfGen_initLike :: HmacKeyLike -> ByteString -> Word32 -> ByteString -> PhkdfGen

phkdfGen_hmacKeyPlain :: PhkdfGen -> Maybe HmacKeyPlain

phkdfGen_hmacKeyHashed :: PhkdfGen -> Maybe HmacKeyHashed

phkdfGen_hmacKeyPrefixed :: PhkdfGen -> HmacKeyPrefixed

phkdfGen_hmacKey :: PhkdfGen -> Maybe HmacKey

phkdfGen_hmacKeyLike :: PhkdfGen -> HmacKeyLike

phkdfGen_read :: PhkdfGen -> (ByteString, PhkdfGen)

phkdfGen_peek :: PhkdfGen -> Maybe ByteString

phkdfGen_toStream :: PhkdfGen -> Stream ByteString