Raaz.Hash

This module exposes all the cryptographic hash functions available under the raaz library.

Cryptographic hashes and hmacs.

The cryptographic hashes provided by raaz give the following guarantees:

1. Distinct hashes are distinct types and hence it is a compiler error to compare two different hashes.
2. A hash and its associated hmac are distinct types and hence it is an compile time error to compare a hash with its hmac.
3. The Eq instance for hashes and the corresponding hmacs use a constant time equality test and hence it is safe to check equality using the operator ==.

The functions hash, hashFile, and hashSource provide a rather high level interface for computing hashes. For hmacs the associated functions are hmac, hmacFile, and hmacSource

Encoding and displaying.

When interfacing with other applications or when printing output to users, it is often necessary to encode hash, hmac or their keys as strings. Applications usually present hashes encoded in base16. The Show and IsString instances for the hashes exposed here follow this convention.

More generaly, hashes, hmacs and their key are instances of type class Encodable and can hence can be encoded in any of the formats supported in raaz.

class (Primitive h, EndianStore h, Encodable h, Eq h, Implementation h ~ SomeHashI h) => Hash h

Type class capturing a cryptographic hash.

Minimal complete definition

additionalPadBlocks

Instances

Hash SHA1

Methods

additionalPadBlocks :: SHA1 -> BLOCKS SHA1

Hash SHA224

Methods

additionalPadBlocks :: SHA224 -> BLOCKS SHA224

Hash SHA256

Methods

additionalPadBlocks :: SHA256 -> BLOCKS SHA256

Hash SHA384

Methods

additionalPadBlocks :: SHA384 -> BLOCKS SHA384

Hash SHA512

Methods

additionalPadBlocks :: SHA512 -> BLOCKS SHA512

hash

Arguments

:: (Hash h, Recommendation h, PureByteSource src)

=> src

Message

-> h

Compute the hash of a pure byte source like, ByteString.

hashFile

Arguments

:: (Hash h, Recommendation h)

=> FilePath

File to be hashed

-> IO h

Compute the hash of file.

hashSource

Arguments

:: (Hash h, Recommendation h, ByteSource src)

=> src

Message

-> IO h

Compute the hash of a generic byte source.

data HMAC h

The HMAC associated to a hash value. The HMAC type is essentially the underlying hash type wrapped inside a newtype. Therefore, the Eq instance for HMAC is essentially the Eq instance for the underlying hash. It is safe against timing attack provided the underlying hash comparison is safe under timing attack.

Instances

Eq h => Eq (HMAC h)

Methods

(==) :: HMAC h -> HMAC h -> Bool

(/=) :: HMAC h -> HMAC h -> Bool

Show h => Show (HMAC h)

Methods

showsPrec :: Int -> HMAC h -> ShowS

show :: HMAC h -> String

showList :: [HMAC h] -> ShowS

IsString h => IsString (HMAC h)

Methods

fromString :: String -> HMAC h

Storable h => Storable (HMAC h)

Methods

sizeOf :: HMAC h -> Int

alignment :: HMAC h -> Int

peekElemOff :: Ptr (HMAC h) -> Int -> IO (HMAC h)

pokeElemOff :: Ptr (HMAC h) -> Int -> HMAC h -> IO ()

peekByteOff :: Ptr b -> Int -> IO (HMAC h)

pokeByteOff :: Ptr b -> Int -> HMAC h -> IO ()

peek :: Ptr (HMAC h) -> IO (HMAC h)

poke :: Ptr (HMAC h) -> HMAC h -> IO ()

EndianStore h => EndianStore (HMAC h)

Methods

store :: Pointer -> HMAC h -> IO ()

load :: Pointer -> IO (HMAC h)

Encodable h => Encodable (HMAC h)

Methods

toByteString :: HMAC h -> ByteString

fromByteString :: ByteString -> Maybe (HMAC h)

unsafeFromByteString :: ByteString -> HMAC h

Hash h => Symmetric (HMAC h)

Associated Types

type Key (HMAC h) :: *

(Hash h, Recommendation h) => Recommendation (HMAC h)

Methods

recommended :: HMAC h -> Implementation (HMAC h)

Hash h => Primitive (HMAC h)

Associated Types

type Implementation (HMAC h) :: *

Methods

blockSize :: HMAC h -> BYTES Int

type Key (HMAC h)

type Key (HMAC h)

type Implementation (HMAC h)

type Implementation (HMAC h) = Implementation h

hmac

Arguments

:: (Hash h, Recommendation h, PureByteSource src)

=> Key (HMAC h)

-> src

Message

-> HMAC h

Compute the hash of a pure byte source like, ByteString.

hmacFile

Arguments

:: (Hash h, Recommendation h)

=> Key (HMAC h)

-> FilePath

File to be hashed

-> IO (HMAC h)

Compute the hash of file.

hmacSource

Arguments

:: (Hash h, Recommendation h, ByteSource src)

=> Key (HMAC h)

-> src

Message

-> IO (HMAC h)

Compute the hash of a generic byte source.

Exposing individual hashes.

Individual hash and hmacs are exposed via their respective modules. These module also export the specialized variants for hashSource, hash and hashFile for specific hashes. For example, if you are interested only in say SHA512 you can import the module Raaz.Hash.Sha512. This will expose the functions sha512Source, sha512 and sha512File which are specialized variants of hashSource hash and hashFile respectively for the hash SHA512. For example, if you want to print the sha512 checksum of a file, you can use the following.

sha512Checksum :: FilePath -> IO ()
           -- print the sha512 checksum of a given file.
sha512Checksum fname =  sha512File fname >>= print

module Raaz.Hash.Sha1

module Raaz.Hash.Sha224

module Raaz.Hash.Sha256

module Raaz.Hash.Sha384

module Raaz.Hash.Sha512