License	BSD-style
Maintainer	Vincent Hanquez <vincent@snarc.org>
Stability	experimental
Portability	unknown
Safe Haskell	None
Language	Haskell2010

Crypto.Hash

Contents

Types
Functions
Hash methods parametrized by algorithm
Hash methods
Hash algorithms

Description

Generalized cryptographic hash interface, that you can use with cryptographic hash algorithm that belong to the HashAlgorithm type class.

import Crypto.Hash

sha1 :: ByteString -> Digest SHA1
sha1 = hash

hexSha3_512 :: ByteString -> String
hexSha3_512 bs = show (hash bs :: Digest SHA3_512)

Synopsis

data Context a
data Digest a
digestFromByteString :: forall a ba. ( HashAlgorithm a, ByteArrayAccess ba) => ba -> Maybe ( Digest a)
hashInitWith :: HashAlgorithm alg => alg -> Context alg
hashWith :: ( ByteArrayAccess ba, HashAlgorithm alg) => alg -> ba -> Digest alg
hashInit :: forall a. HashAlgorithm a => Context a
hashUpdates :: forall a ba. ( HashAlgorithm a, ByteArrayAccess ba) => Context a -> [ba] -> Context a
hashUpdate :: ( ByteArrayAccess ba, HashAlgorithm a) => Context a -> ba -> Context a
hashFinalize :: forall a. HashAlgorithm a => Context a -> Digest a
hashBlockSize :: HashAlgorithm a => a -> Int
hashDigestSize :: HashAlgorithm a => a -> Int
hash :: ( ByteArrayAccess ba, HashAlgorithm a) => ba -> Digest a
hashlazy :: HashAlgorithm a => ByteString -> Digest a
module Crypto.Hash.Algorithms

Types

data Context a Source #

Represent a context for a given hash algorithm.

Instances

Instances details

NFData ( Context a) Source #
Instance details Defined in Crypto.Hash.Types Methods rnf :: Context a -> () Source #
ByteArrayAccess ( Context a) Source #
Instance details Defined in Crypto.Hash.Types Methods length :: Context a -> Int Source # withByteArray :: Context a -> ( Ptr p -> IO a0) -> IO a0 Source # copyByteArrayToPtr :: Context a -> Ptr p -> IO () Source #

data Digest a Source #

Represent a digest for a given hash algorithm.

This type is an instance of ByteArrayAccess from package memory . Module Data.ByteArray provides many primitives to work with those values including conversion to other types.

Creating a digest from a bytearray is also possible with function digestFromByteString .

Instances

Instances details

Eq ( Digest a) Source #
Instance details Defined in Crypto.Hash.Types Methods (==) :: Digest a -> Digest a -> Bool Source # (/=) :: Digest a -> Digest a -> Bool Source #
Data a => Data ( Digest a) Source #
Instance details Defined in Crypto.Hash.Types Methods gfoldl :: ( forall d b. Data d => c (d -> b) -> d -> c b) -> ( forall g. g -> c g) -> Digest a -> c ( Digest a) Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c ( Digest a) Source # toConstr :: Digest a -> Constr Source # dataTypeOf :: Digest a -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c ( Digest a)) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c ( Digest a)) Source # gmapT :: ( forall b. Data b => b -> b) -> Digest a -> Digest a Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> Digest a -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> Digest a -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> Digest a -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> Digest a -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> Digest a -> m ( Digest a) Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> Digest a -> m ( Digest a) Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> Digest a -> m ( Digest a) Source #
Ord ( Digest a) Source #
Instance details Defined in Crypto.Hash.Types Methods compare :: Digest a -> Digest a -> Ordering Source # (<) :: Digest a -> Digest a -> Bool Source # (<=) :: Digest a -> Digest a -> Bool Source # (>) :: Digest a -> Digest a -> Bool Source # (>=) :: Digest a -> Digest a -> Bool Source # max :: Digest a -> Digest a -> Digest a Source # min :: Digest a -> Digest a -> Digest a Source #
HashAlgorithm a => Read ( Digest a) Source #
Instance details Defined in Crypto.Hash.Types Methods readsPrec :: Int -> ReadS ( Digest a) Source # readList :: ReadS [ Digest a] Source # readPrec :: ReadPrec ( Digest a) Source # readListPrec :: ReadPrec [ Digest a] Source #
Show ( Digest a) Source #
Instance details Defined in Crypto.Hash.Types Methods showsPrec :: Int -> Digest a -> ShowS Source # show :: Digest a -> String Source # showList :: [ Digest a] -> ShowS Source #
NFData ( Digest a) Source #
Instance details Defined in Crypto.Hash.Types Methods rnf :: Digest a -> () Source #
ByteArrayAccess ( Digest a) Source #
Instance details Defined in Crypto.Hash.Types Methods length :: Digest a -> Int Source # withByteArray :: Digest a -> ( Ptr p -> IO a0) -> IO a0 Source # copyByteArrayToPtr :: Digest a -> Ptr p -> IO () Source #

Functions

digestFromByteString :: forall a ba. ( HashAlgorithm a, ByteArrayAccess ba) => ba -> Maybe ( Digest a) Source #

Try to transform a bytearray into a Digest of specific algorithm.

If the digest is not the right size for the algorithm specified, then Nothing is returned.

Hash methods parametrized by algorithm

hashInitWith :: HashAlgorithm alg => alg -> Context alg Source #

Initialize a new context for a specified hash algorithm

hashWith :: ( ByteArrayAccess ba, HashAlgorithm alg) => alg -> ba -> Digest alg Source #

Run the hash function but takes an explicit hash algorithm parameter

Hash methods

hashInit :: forall a. HashAlgorithm a => Context a Source #

Initialize a new context for this hash algorithm

hashUpdates :: forall a ba. ( HashAlgorithm a, ByteArrayAccess ba) => Context a -> [ba] -> Context a Source #

Update the context with a list of strict bytestring, and return a new context with the updates.

hashUpdate :: ( ByteArrayAccess ba, HashAlgorithm a) => Context a -> ba -> Context a Source #

run hashUpdates on one single bytestring and return the updated context.

hashFinalize :: forall a. HashAlgorithm a => Context a -> Digest a Source #

Finalize a context and return a digest.

hashBlockSize :: HashAlgorithm a => a -> Int Source #

Get the block size of a hash algorithm

hashDigestSize :: HashAlgorithm a => a -> Int Source #

Get the digest size of a hash algorithm

hash :: ( ByteArrayAccess ba, HashAlgorithm a) => ba -> Digest a Source #

Hash a strict bytestring into a digest.

hashlazy :: HashAlgorithm a => ByteString -> Digest a Source #

Hash a lazy bytestring into a digest.

Hash algorithms

module Crypto.Hash.Algorithms