Z.Crypto.MAC

A Message Authentication Code algorithm computes a tag over a message utilizing a shared secret key. Thus a valid tag confirms the authenticity and integrity of the message. Only entities in possession of the shared secret key are able to verify the tag.

MAC type

data MACType

Constructors

CMAC BlockCipherType

A modern CBC-MAC variant that avoids the security problems of plain CBC-MAC. Approved by NIST. Also sometimes called OMAC.

GMAC BlockCipherType

GMAC is related to the GCM authenticated cipher mode. It is quite slow unless hardware support for carryless multiplications is available. A new nonce must be used with each message authenticated, or otherwise all security is lost.

CBC_MAC BlockCipherType

An older authentication code based on a block cipher. Serious security problems, in particular insecure if messages of several different lengths are authenticated. Avoid unless required for compatibility.

HMAC HashType

A message authentication code based on a hash function. Very commonly used.

Poly1305

A polynomial mac (similar to GMAC). Very fast, but tricky to use safely. Forms part of the ChaCha20Poly1305 AEAD mode. A new key must be used for each message, or all security is lost.

SipHash Int Int

A modern and very fast PRF. Produces only a 64-bit output. Defaults to “SipHash(2,4)” which is the recommended configuration, using 2 rounds for each input block and 4 rounds for finalization.

X9'19_MAC

A CBC-MAC variant sometimes used in finance. Always uses DES. Sometimes called the “DES retail MAC”, also standardized in ISO 9797-1. It is slow and has known attacks. Avoid unless required.

Instances

Eq MACType

Defined in Z.Crypto.MAC

Methods

(==) :: MACType -> MACType -> Bool

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

Ord MACType

Defined in Z.Crypto.MAC

Methods

compare :: MACType -> MACType -> Ordering

(<) :: MACType -> MACType -> Bool

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

(>) :: MACType -> MACType -> Bool

(>=) :: MACType -> MACType -> Bool

max :: MACType -> MACType -> MACType

min :: MACType -> MACType -> MACType

Read MACType

Defined in Z.Crypto.MAC

Methods

readsPrec :: Int -> ReadS MACType

readList :: ReadS [MACType]

readPrec :: ReadPrec MACType

readListPrec :: ReadPrec [MACType]

Show MACType

Defined in Z.Crypto.MAC

Methods

showsPrec :: Int -> MACType -> ShowS

show :: MACType -> String

showList :: [MACType] -> ShowS

Generic MACType

Defined in Z.Crypto.MAC

Associated Types

type Rep MACType :: Type -> Type

Methods

from :: MACType -> Rep MACType x

to :: Rep MACType x -> MACType

JSON MACType

Defined in Z.Crypto.MAC

Methods

fromValue :: Value -> Converter MACType

toValue :: MACType -> Value

encodeJSON :: MACType -> Builder ()

Print MACType

Defined in Z.Crypto.MAC

Methods

toUTF8BuilderP :: Int -> MACType -> Builder ()

type Rep MACType

Defined in Z.Crypto.MAC

type Rep MACType = D1 ('MetaData "MACType" "Z.Crypto.MAC" "Z-Botan-0.3.1.0-GbapUVQUdq6A2uFR3TMVx6" 'False) ((C1 ('MetaCons "CMAC" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BlockCipherType)) :+: (C1 ('MetaCons "GMAC" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BlockCipherType)) :+: C1 ('MetaCons "CBC_MAC" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BlockCipherType)))) :+: ((C1 ('MetaCons "HMAC" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HashType)) :+: C1 ('MetaCons "Poly1305" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "SipHash" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :+: C1 ('MetaCons "X9'19_MAC" 'PrefixI 'False) (U1 :: Type -> Type))))

data MAC

Instances

Show MAC

Defined in Z.Crypto.MAC

Methods

showsPrec :: Int -> MAC -> ShowS

show :: MAC -> String

showList :: [MAC] -> ShowS

Generic MAC

Defined in Z.Crypto.MAC

Associated Types

type Rep MAC :: Type -> Type

Methods

from :: MAC -> Rep MAC x

to :: Rep MAC x -> MAC

Print MAC

Defined in Z.Crypto.MAC

Methods

toUTF8BuilderP :: Int -> MAC -> Builder ()

type Rep MAC

Defined in Z.Crypto.MAC

type Rep MAC = D1 ('MetaData "MAC" "Z.Crypto.MAC" "Z-Botan-0.3.1.0-GbapUVQUdq6A2uFR3TMVx6" 'False) (C1 ('MetaCons "MAC" 'PrefixI 'True) (S1 ('MetaSel ('Just "macStruct") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 BotanStruct) :*: (S1 ('MetaSel ('Just "macName") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 CBytes) :*: S1 ('MetaSel ('Just "macSize") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Int))))

macName :: MAC -> CBytes

mac algo name

macSize :: MAC -> Int

mac output size in bytes

IUF interface

newMAC :: HasCallStack => MACType -> IO MAC

Create a new MAC object.

setKeyMAC :: HasCallStack => MAC -> Bytes -> IO ()

Set the random key.

updateMAC :: HasCallStack => MAC -> Bytes -> IO ()

Feed a chunk of input into a MAC object.

finalMAC :: HasCallStack => MAC -> IO Bytes

clearMAC :: HasCallStack => MAC -> IO ()

Reset the state of MAC object back to clean, as if no input has been supplied.

function interface

mac

Arguments

:: HasCallStack

=> MACType

-> Bytes

key

-> Bytes

input

-> Bytes

Directly compute a message's mac

macChunks :: HasCallStack => MACType -> Bytes -> [Bytes] -> Bytes

Directly compute a chunked message's mac.

BIO interface

sinkToMAC :: HasCallStack => MAC -> Sink Bytes

Trun MAC to a Bytes sink, update MAC by write bytes to the sink.

Internal helper

macTypeToCBytes :: MACType -> CBytes

withMAC :: MAC -> (BotanStructT -> IO r) -> IO r

Pass MAC to FFI as botan_mac_t.