Data.Hash.SipHash

Documentation

data SipHashKey

The Word46 constructor parameters represent the 128 bit key in little endian encoding.

Constructors

SipHashKey !Word64 !Word64

Instances

Show SipHashKey

Defined in Data.Hash.SipHash

Methods

showsPrec :: Int -> SipHashKey -> ShowS

show :: SipHashKey -> String

showList :: [SipHashKey] -> ShowS

Eq SipHashKey

Defined in Data.Hash.SipHash

Methods

(==) :: SipHashKey -> SipHashKey -> Bool

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

Ord SipHashKey

Defined in Data.Hash.SipHash

Methods

compare :: SipHashKey -> SipHashKey -> Ordering

(<) :: SipHashKey -> SipHashKey -> Bool

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

(>) :: SipHashKey -> SipHashKey -> Bool

(>=) :: SipHashKey -> SipHashKey -> Bool

max :: SipHashKey -> SipHashKey -> SipHashKey

min :: SipHashKey -> SipHashKey -> SipHashKey

newtype SipHash (c :: Nat) (d :: Nat)

SipHash with c compression rounds and d finalization rounds.

cf. http://cr.yp.to/siphash/siphash-20120918.pdf

Constructors

SipHash Word64

Instances

Show (SipHash c d)

Defined in Data.Hash.SipHash

Methods

showsPrec :: Int -> SipHash c d -> ShowS

show :: SipHash c d -> String

showList :: [SipHash c d] -> ShowS

Eq (SipHash c d)

Defined in Data.Hash.SipHash

Methods

(==) :: SipHash c d -> SipHash c d -> Bool

(/=) :: SipHash c d -> SipHash c d -> Bool

Ord (SipHash c d)

Defined in Data.Hash.SipHash

Methods

compare :: SipHash c d -> SipHash c d -> Ordering

(<) :: SipHash c d -> SipHash c d -> Bool

(<=) :: SipHash c d -> SipHash c d -> Bool

(>) :: SipHash c d -> SipHash c d -> Bool

(>=) :: SipHash c d -> SipHash c d -> Bool

max :: SipHash c d -> SipHash c d -> SipHash c d

min :: SipHash c d -> SipHash c d -> SipHash c d

(SipHashParam c, SipHashParam d) => IncrementalHash (SipHash c d)

Defined in Data.Hash.SipHash

Associated Types

type Context (SipHash c d)

Methods

update :: Context (SipHash c d) -> Ptr Word8 -> Int -> IO (Context (SipHash c d))

finalize :: Context (SipHash c d) -> SipHash c d

(SipHashParam c, SipHashParam d) => Hash (SipHash c d)

Defined in Data.Hash.SipHash

Associated Types

type Salt (SipHash c d)

Methods

initialize :: Salt (SipHash c d) -> Context (SipHash c d)

type Context (SipHash c d)

Defined in Data.Hash.SipHash

type Context (SipHash c d) = SipHashContext c d

type Salt (SipHash c d)

Defined in Data.Hash.SipHash

type Salt (SipHash c d) = SipHashKey

sipHash :: SipHashKey -> Ptr Word8 -> Int -> IO (SipHash 2 4)

SipHash, with recommended default parameters of c=2 and d=4.

The first and second argument is the 128 bit key, represented as two 64 bit words.

SipHash-c-d

sipHashCD :: forall c d. SipHashParam c => SipHashParam d => SipHashKey -> Ptr Word8 -> Int -> IO (SipHash c d)

Generic SipHash with c rounds per block and d finalization rounds.

The first and second argument is the 128 bit key, represented as two 64 bit words.

sipHash24 :: SipHashKey -> Ptr Word8 -> Int -> IO (SipHash 2 4)

SipHash-2-4

The first and second argument is the 128 bit key, represented as two 64 bit words.

sipHash13 :: SipHashKey -> Ptr Word8 -> Int -> IO (SipHash 1 3)

SipHash-1-3

The first and second argument is the 128 bit key, represented as two 64 bit words.

sipHash48 :: SipHashKey -> Ptr Word8 -> Int -> IO (SipHash 4 8)

SipHash-4-8

The first and second argument is the 128 bit key, represented as two 64 bit words.

Incremental SipHash

data SipHashContext (c :: Nat) (d :: Nat)

Internal mutable SipHashContext.

The first four arguments are the internal state values \(v_{0..3}\) and the last argument represents the pending bytes from an incomplete word of the last chunk of input.

sipHashInitialize :: SipHashKey -> SipHashContext c d

Initialize a new SipHashContext

sipHashUpdate :: forall (c :: Nat) (d :: Nat). SipHashParam c => SipHashContext c d -> Ptr Word8 -> Int -> IO (SipHashContext c d)

Incrementally add input bytes to an SipHash computation and update the internal context.

sipHashFinalize :: forall (c :: Nat) (d :: Nat). SipHashParam c => SipHashParam d => SipHashContext c d -> SipHash c d

Utils

module Data.Hash.Class.Pure.Salted