Crypto.Nettle.KeyedHash

Generic interface to calculate key based hashes.

Documentation

class KeyedHashAlgorithm k where

KeyedHashAlgorithm is a class for keyed hash algorithms that take a key and a message to produce a digest. The most popular example is HMAC.

Minimal complete definition

implKeyedHashDigestSize, implKeyedHashName, implKeyedHashInit, implKeyedHashUpdate, implKeyedHashFinalize

Methods

implKeyedHashDigestSize :: Tagged k Int

Digest size in bytes the keyed hash algorithm returns

implKeyedHashName :: Tagged k String

Name

implKeyedHashInit :: ByteString -> k

Initialize state from a key

implKeyedHashUpdate :: k -> ByteString -> k

Add more message data to the state

implKeyedHashUpdateLazy :: k -> ByteString -> k

Add more lazy message data to the state

implKeyedHashFinalize :: k -> ByteString

Produce final digest

Instances

KeyedHashAlgorithm UMAC128

KeyedHashAlgorithm UMAC96

KeyedHashAlgorithm UMAC64

KeyedHashAlgorithm UMAC32

HashAlgorithm a => KeyedHashAlgorithm (HMAC a)

data KeyedHash

KeyedHash hides the KeyedHashAlgorithm implementation.

Constructors

forall k . KeyedHashAlgorithm k => KeyedHash !k

keyedHashDigestSize :: KeyedHashAlgorithm k => k -> Int

Untagged variant of implKeyedHashDigestSize; takes a (possible undefined) key typed value from a KeyedHashAlgorithm instance as parameter.

keyedHashDigestSize' :: KeyedHash -> Int

Get implKeyedHashDigestSize from a KeyedHash

keyedHashName :: KeyedHashAlgorithm k => k -> String

Untagged variant of implKeyedHashName; takes a (possible undefined) key typed value from a KeyedHashAlgorithm instance as parameter.

keyedHashName' :: KeyedHash -> String

Get implKeyedHashName from a KeyedHash

keyedHashInit

Arguments

:: KeyedHashAlgorithm k

=> ByteString

key argument

-> Tagged k KeyedHash

Initialize a KeyedHash context from a key

keyedHashInit' :: KeyedHashAlgorithm k => k -> ByteString -> KeyedHash

Untagged variant of keyedHashInit; takes a (possible undefined) key typed value from a KeyedHashAlgorithm instance as parameter.

keyedHashUpdate :: KeyedHash -> ByteString -> KeyedHash

Add more message data to the context

keyedHashUpdateLazy :: KeyedHash -> ByteString -> KeyedHash

Add more lazy message data to the context

keyedHashFinalize :: KeyedHash -> ByteString

Produce final digest

keyedHash :: KeyedHashAlgorithm k => ByteString -> ByteString -> Tagged k ByteString

Helper to hash key and message in one step

Example:

untag (keyedHash (fromString "secretkey") (fromString "secret message") :: Tagged (HMAC SHA256) B.ByteString)

keyedHash' :: KeyedHashAlgorithm k => k -> ByteString -> ByteString -> ByteString

Untagged variant of keyedHash; takes a (possible undefined) key typed value from a KeyedHashAlgorithm instance as parameter.

Example:

keyedHash' (undefined :: HMAC SHA256) (fromString "secretkey") (fromString "secret message")

keyedHashLazy :: KeyedHashAlgorithm k => ByteString -> ByteString -> Tagged k ByteString

Helper to hash key and lazy message in one step

Example:

untag (keyedHashLazy (fromString "secretkey") (fromString "secret message") :: Tagged (HMAC SHA256) B.ByteString)

keyedHashLazy' :: KeyedHashAlgorithm k => k -> ByteString -> ByteString -> ByteString

Untagged variant of keyedHashLazy; takes a (possible undefined) key typed value from a KeyedHashAlgorithm instance as parameter.

Example:

keyedHashLazy' (undefined :: HMAC SHA256) (fromString "secretkey") (fromString "secret message")