Raaz.Core.Primitives

Generic cryptographic block primtives and their implementations. This module exposes low-level generic code used in the raaz system. Most likely, one would not need to stoop so low and it might be better to use a more high level interface.

Primtives and their implementations.

class BlockAlgorithm (Implementation p) => Primitive p where

The type class that captures an abstract block cryptographic primitive. Bulk cryptographic primitives like hashes, ciphers etc often acts on blocks of data. The size of the block is captured by the member blockSize.

As a library, raaz believes in providing multiple implementations for a given primitive. The associated type Implementation captures implementations of the primitive.

For use in production code, the library recommends a particular implementation using the Recommendation class. By default this is the implementation used when no explicit implementation is specified.

Associated Types

type Implementation p :: *

Associated type that captures an implementation of this primitive.

Methods

blockSize :: p -> BYTES Int

The block size.

Instances

Primitive ChaCha20

Defined in Raaz.Cipher.ChaCha20.Internal

Associated Types

type Implementation ChaCha20

Methods

blockSize :: ChaCha20 -> BYTES Int

Primitive BLAKE2s

Defined in Raaz.Hash.Blake2.Internal

Associated Types

type Implementation BLAKE2s

Methods

blockSize :: BLAKE2s -> BYTES Int

Primitive BLAKE2b

Defined in Raaz.Hash.Blake2.Internal

Associated Types

type Implementation BLAKE2b

Methods

blockSize :: BLAKE2b -> BYTES Int

Primitive SHA1

Defined in Raaz.Hash.Sha1.Internal

Associated Types

type Implementation SHA1

Methods

blockSize :: SHA1 -> BYTES Int

Primitive SHA224

Defined in Raaz.Hash.Sha224.Internal

Associated Types

type Implementation SHA224

Methods

blockSize :: SHA224 -> BYTES Int

Primitive SHA256

Defined in Raaz.Hash.Sha256.Internal

Associated Types

type Implementation SHA256

Methods

blockSize :: SHA256 -> BYTES Int

Primitive SHA384

Defined in Raaz.Hash.Sha384.Internal

Associated Types

type Implementation SHA384

Methods

blockSize :: SHA384 -> BYTES Int

Primitive SHA512

Defined in Raaz.Hash.Sha512.Internal

Associated Types

type Implementation SHA512

Methods

blockSize :: SHA512 -> BYTES Int

Primitive (AES 128 'CBC)

The 128-bit aes cipher in cbc mode.

Defined in Raaz.Cipher.AES.Internal

Associated Types

type Implementation (AES 128 'CBC)

Methods

blockSize :: AES 128 'CBC -> BYTES Int

Primitive (AES 192 'CBC)

The 192-bit aes cipher in cbc mode.

Defined in Raaz.Cipher.AES.Internal

Associated Types

type Implementation (AES 192 'CBC)

Methods

blockSize :: AES 192 'CBC -> BYTES Int

Primitive (AES 256 'CBC)

The 256-bit aes cipher in cbc mode.

Defined in Raaz.Cipher.AES.Internal

Associated Types

type Implementation (AES 256 'CBC)

Methods

blockSize :: AES 256 'CBC -> BYTES Int

class Describable a => BlockAlgorithm a where

Implementation of block primitives work on buffers. Often for optimal performance, and in some case for safety, we need restrictions on the size and alignment of the buffer pointer. This type class captures such restrictions.

Methods

bufferStartAlignment :: a -> Alignment

The alignment expected for the buffer pointer.

Instances

BlockAlgorithm (SomeCipherI cipher)

Defined in Raaz.Cipher.Internal

Methods

bufferStartAlignment :: SomeCipherI cipher -> Alignment

BlockAlgorithm (SomeHashI h)

Defined in Raaz.Hash.Internal

Methods

bufferStartAlignment :: SomeHashI h -> Alignment

BlockAlgorithm (HashI h m)

Defined in Raaz.Hash.Internal

Methods

bufferStartAlignment :: HashI h m -> Alignment

BlockAlgorithm (CipherI cipher encMem decMem)

Defined in Raaz.Cipher.Internal

Methods

bufferStartAlignment :: CipherI cipher encMem decMem -> Alignment

type family Key prim :: *

Some primitives like ciphers have an encryption/decryption key. This type family captures the key associated with a primitive if it has any.

Instances

type Key ChaCha20

The key for ChaCha20.

Defined in Raaz.Cipher.ChaCha20.Internal

type Key ChaCha20 = (KEY, IV, Counter)

type Key (HMAC h)

Defined in Raaz.Hash.Internal.HMAC

type Key (HMAC h)

type Key (AES 128 'CBC)

Key is (KEY128,IV) pair.

Defined in Raaz.Cipher.AES.Internal

type Key (AES 128 'CBC) = (KEY128, IV)

type Key (AES 192 'CBC)

Key is (KEY192,IV) pair.

Defined in Raaz.Cipher.AES.Internal

type Key (AES 192 'CBC) = (KEY192, IV)

type Key (AES 256 'CBC)

Key is (KEY256,IV) pair.

Defined in Raaz.Cipher.AES.Internal

type Key (AES 256 'CBC) = (KEY256, IV)

class Primitive p => Recommendation p where

Primitives that have a recommended implementations.

Methods

recommended :: p -> Implementation p

The recommended implementation for the primitive.

Instances

Recommendation ChaCha20

Defined in Raaz.Cipher.ChaCha20.Recommendation

Methods

recommended :: ChaCha20 -> Implementation ChaCha20

Recommendation BLAKE2s

Recommended implementation for balke2s.

Defined in Raaz.Hash.Blake2.Recommendation

Methods

recommended :: BLAKE2s -> Implementation BLAKE2s

Recommendation BLAKE2b

Recommended implementation for blake2b.

Defined in Raaz.Hash.Blake2.Recommendation

Methods

recommended :: BLAKE2b -> Implementation BLAKE2b

Recommendation SHA1

Recommended implementation for SHA1.

Defined in Raaz.Hash.Sha1.Recommendation

Methods

recommended :: SHA1 -> Implementation SHA1

Recommendation SHA224

Recommended implementation for SHA224.

Defined in Raaz.Hash.Sha224.Recommendation

Methods

recommended :: SHA224 -> Implementation SHA224

Recommendation SHA256

Recommended implementation for SHA256.

Defined in Raaz.Hash.Sha256.Recommendation

Methods

recommended :: SHA256 -> Implementation SHA256

Recommendation SHA384

Recommended implementation for SHA384.

Defined in Raaz.Hash.Sha384.Recommendation

Methods

recommended :: SHA384 -> Implementation SHA384

Recommendation SHA512

Recommend implementation for SHA512.

Defined in Raaz.Hash.Sha512.Recommendation

Methods

recommended :: SHA512 -> Implementation SHA512

Recommendation (AES 128 'CBC)

Recommended implementation of AES-128 cbc

Defined in Raaz.Cipher.AES.Recommendation

Methods

recommended :: AES 128 'CBC -> Implementation (AES 128 'CBC)

Recommendation (AES 192 'CBC)

Recommended implementation of AES-192 cbc

Defined in Raaz.Cipher.AES.Recommendation

Methods

recommended :: AES 192 'CBC -> Implementation (AES 192 'CBC)

Recommendation (AES 256 'CBC)

Recommended implementation of AES-256 cbc

Defined in Raaz.Cipher.AES.Recommendation

Methods

recommended :: AES 256 'CBC -> Implementation (AES 256 'CBC)

data BLOCKS p

Type safe message length in units of blocks of the primitive. When dealing with buffer lengths for a primitive, it is often better to use the type safe units BLOCKS. Functions in the raaz package that take lengths usually allow any type safe length as long as they can be converted to bytes. This can avoid a lot of tedious and error prone length calculations.

Instances

Enum (BLOCKS p)

Defined in Raaz.Core.Primitives

Methods

succ :: BLOCKS p -> BLOCKS p

pred :: BLOCKS p -> BLOCKS p

toEnum :: Int -> BLOCKS p

fromEnum :: BLOCKS p -> Int

enumFrom :: BLOCKS p -> [BLOCKS p]

enumFromThen :: BLOCKS p -> BLOCKS p -> [BLOCKS p]

enumFromTo :: BLOCKS p -> BLOCKS p -> [BLOCKS p]

enumFromThenTo :: BLOCKS p -> BLOCKS p -> BLOCKS p -> [BLOCKS p]

Eq (BLOCKS p)

Defined in Raaz.Core.Primitives

Methods

(==) :: BLOCKS p -> BLOCKS p -> Bool

(/=) :: BLOCKS p -> BLOCKS p -> Bool

Ord (BLOCKS p)

Defined in Raaz.Core.Primitives

Methods

compare :: BLOCKS p -> BLOCKS p -> Ordering

(<) :: BLOCKS p -> BLOCKS p -> Bool

(<=) :: BLOCKS p -> BLOCKS p -> Bool

(>) :: BLOCKS p -> BLOCKS p -> Bool

(>=) :: BLOCKS p -> BLOCKS p -> Bool

max :: BLOCKS p -> BLOCKS p -> BLOCKS p

min :: BLOCKS p -> BLOCKS p -> BLOCKS p

Show (BLOCKS p)

Defined in Raaz.Core.Primitives

Methods

showsPrec :: Int -> BLOCKS p -> ShowS

show :: BLOCKS p -> String

showList :: [BLOCKS p] -> ShowS

Semigroup (BLOCKS p)

Defined in Raaz.Core.Primitives

Methods

(<>) :: BLOCKS p -> BLOCKS p -> BLOCKS p

sconcat :: NonEmpty (BLOCKS p) -> BLOCKS p

stimes :: Integral b => b -> BLOCKS p -> BLOCKS p

Monoid (BLOCKS p)

Defined in Raaz.Core.Primitives

Methods

mempty :: BLOCKS p

mappend :: BLOCKS p -> BLOCKS p -> BLOCKS p

mconcat :: [BLOCKS p] -> BLOCKS p

Primitive p => LengthUnit (BLOCKS p)

Defined in Raaz.Core.Primitives

Methods

inBytes :: BLOCKS p -> BYTES Int

blocksOf :: Int -> p -> BLOCKS p

The expression n blocksOf p specifies the message lengths in units of the block length of the primitive p. This expression is sometimes required to make the type checker happy.

allocBufferFor :: Primitive prim => Implementation prim -> BLOCKS prim -> (Pointer -> IO b) -> IO b

Allocate a buffer a particular implementation of a primitive prim. algorithm algo. It ensures that the memory passed is aligned according to the demands of the implementation.