BLAKE3.IO

Hashing

init

Arguments

:: Ptr HasherInternal

Will be mutated.

-> IO ()

Initialize a HasherInternal.

update

Arguments

:: ByteArrayAccess bin

=> Ptr HasherInternal

Will be mutated.

-> [bin]

-> IO ()

Update HasherInternal state with new data.

finalize

Arguments

:: KnownNat len

=> Ptr HasherInternal

Will be mutated.

-> IO (Digest len)

Finalize HasherInternal state and obtain a digest.

The HasherInternal is mutated.

data Hasher

Immutable BLAKE3 hashing state.

Obtain with hasher or hasherKeyed.

allocRetHasher

Arguments

:: (Ptr HasherInternal -> IO a)

Initialize HASHER_SIZE bytes.

-> IO (a, Hasher)

Allocate Hasher.

The Hasher is wiped and freed as soon as it becomes unused.

data Digest (len :: Nat)

Output from BLAKE3 algorithm, of len bytes.

The default digest length for BLAKE3 is DEFAULT_DIGEST_LEN.

Instances

Eq (Digest len)

Constant time.

Defined in BLAKE3.IO

Methods

(==) :: Digest len -> Digest len -> Bool

(/=) :: Digest len -> Digest len -> Bool

Show (Digest len)

Base 16 (hexadecimal).

Defined in BLAKE3.IO

Methods

showsPrec :: Int -> Digest len -> ShowS

show :: Digest len -> String

showList :: [Digest len] -> ShowS

ByteArrayAccess (Digest len)

Defined in BLAKE3.IO

Methods

length :: Digest len -> Int

withByteArray :: Digest len -> (Ptr p -> IO a) -> IO a

copyByteArrayToPtr :: Digest len -> Ptr p -> IO ()

allocRetDigest

Arguments

:: KnownNat len

=> (Ptr Word8 -> IO a)

Initialize len bytes.

-> IO (a, Digest len)

Allocate a Digest.

The Digest is wiped and freed as soon as it becomes unused.

Memory

data HasherInternal

Opaque datatype of size HASHER_SIZE and alignment HASHER_ALIGNMENT.

Obtain with withHasherInternal.

copyHasher

Arguments

:: Hasher

-> IO Hasher

Copy an inmutable Hasher.

withHasherInternal

Arguments

:: Hasher

-> (Ptr HasherInternal -> IO a)

Read or write.

-> IO a

Mutate the given Hasher.

Keyed hashing

data Key

Key used for keyed hashing mode.

Obtain with key.

See hashKeyed.

Instances

Eq Key

Constant time.

Defined in BLAKE3.IO

Methods

(==) :: Key -> Key -> Bool

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

Show Key

Base 16 (hexadecimal).

Defined in BLAKE3.IO

Methods

showsPrec :: Int -> Key -> ShowS

show :: Key -> String

showList :: [Key] -> ShowS

ByteArrayAccess Key

Defined in BLAKE3.IO

Methods

length :: Key -> Int

withByteArray :: Key -> (Ptr p -> IO a) -> IO a

copyByteArrayToPtr :: Key -> Ptr p -> IO ()

key

Arguments

:: ByteArrayAccess bin

=> bin

Key bytes. Must have length KEY_LEN.

-> Maybe Key

Obtain a Key for use in BLAKE3 keyed hashing.

See hashKeyed.

allocRetKey

Arguments

:: (Ptr Word8 -> IO a)

Initialize KEY_LEN bytes.

-> IO (a, Key)

Allocate a Key.

The Key is wiped and freed as soon as it becomes unused.

initKeyed

Arguments

:: Ptr HasherInternal

Will be mutated.

-> Key

-> IO ()

Initialize a HasherInternal in keyed mode.

Key derivation

data Context

Context for BLAKE3 key derivation. Obtain with context.

Instances

Eq Context

Defined in BLAKE3.IO

Methods

(==) :: Context -> Context -> Bool

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

Show Context

Base 16 (hexadecimal).

Defined in BLAKE3.IO

Methods

showsPrec :: Int -> Context -> ShowS

show :: Context -> String

showList :: [Context] -> ShowS

IsString Context

fromString is a partial function that fails if the given String contains Chars outside the range [toEnum 0 .. toEnum 255]. See context.

Defined in BLAKE3.IO

Methods

fromString :: String -> Context

context

Arguments

:: ByteArrayAccess bin

=> bin

If bin contains null bytes, this function returns Nothing.

-> Maybe Context

Obtain a Context for BLAKE3 key derivation.

The context should be hardcoded, globally unique, and application-specific.

A good format for the context string is:

[application] [commit timestamp] [purpose]

For example:

example.com 2019-12-25 16:18:03 session tokens v1

initDerive

Arguments

:: Ptr HasherInternal

Will be mutated.

-> Context

-> IO ()

Initialize a HasherInternal in derivation mode.

The input key material must be provided afterwards, using update.

Constants

type HASHER_ALIGNMENT = 8

type HASHER_SIZE = 1912

In bytes.

type KEY_LEN = 32

In bytes.

type BLOCK_SIZE = 64

In bytes.

type DEFAULT_DIGEST_LEN = 32

In bytes.