raaz-0.1.1: The raaz cryptographic library.

Safe Haskell | None
Language | Haskell2010

Raaz.Core.Primitives

Contents

- Primtives and their implementations.

Description

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.

Synopsis

- class BlockAlgorithm (Implementation p) => Primitive p where
  - type Implementation p :: *
- class Describable a => BlockAlgorithm a where
- type family Key prim :: *
- class Primitive p => Recommendation p where
- data BLOCKS p
- blocksOf :: Int -> p -> BLOCKS p
- allocBufferFor :: Primitive prim => Implementation prim -> BLOCKS prim -> (Pointer -> IO b) -> IO b

# Primtives and their implementations.

class BlockAlgorithm (Implementation p) => Primitive p where Source #

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.

Minimal complete definition

blockSize

Associated Types

type Implementation p :: * Source #

Associated type that captures an implementation of this primitive.

Methods

blockSize :: p -> BYTES Int Source #

The block size.

Instances

Primitive SHA1 Source # |
Associated Types type Implementation SHA1 :: * Source # Methods blockSize :: SHA1 -> BYTES Int Source #
Primitive SHA224 Source # |
Associated Types type Implementation SHA224 :: * Source # Methods blockSize :: SHA224 -> BYTES Int Source #
Primitive SHA256 Source # |
Associated Types type Implementation SHA256 :: * Source # Methods blockSize :: SHA256 -> BYTES Int Source #
Primitive SHA384 Source # |
Associated Types type Implementation SHA384 :: * Source # Methods blockSize :: SHA384 -> BYTES Int Source #
Primitive SHA512 Source # |
Associated Types type Implementation SHA512 :: * Source # Methods blockSize :: SHA512 -> BYTES Int Source #
Primitive ChaCha20 Source # |
Associated Types type Implementation ChaCha20 :: * Source # Methods blockSize :: ChaCha20 -> BYTES Int Source #
Primitive (AES 128 CBC) Source # | The 128-bit aes cipher in cbc mode.
Associated Types type Implementation (AES 128 CBC) :: * Source # Methods blockSize :: AES 128 CBC -> BYTES Int Source #
Primitive (AES 192 CBC) Source # | The 192-bit aes cipher in cbc mode.
Associated Types type Implementation (AES 192 CBC) :: * Source # Methods blockSize :: AES 192 CBC -> BYTES Int Source #
Primitive (AES 256 CBC) Source # | The 256-bit aes cipher in cbc mode.
Associated Types type Implementation (AES 256 CBC) :: * Source # Methods blockSize :: AES 256 CBC -> BYTES Int Source #

class Describable a => BlockAlgorithm a where Source #

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.

Minimal complete definition

bufferStartAlignment

Methods

bufferStartAlignment :: a -> Alignment Source #

The alignment expected for the buffer pointer.

Instances

BlockAlgorithm (SomeHashI h) Source # |
Methods bufferStartAlignment :: SomeHashI h -> Alignment Source #
BlockAlgorithm (SomeCipherI cipher) Source # |
Methods bufferStartAlignment :: SomeCipherI cipher -> Alignment Source #
BlockAlgorithm (HashI h m) Source # |
Methods bufferStartAlignment :: HashI h m -> Alignment Source #
BlockAlgorithm (CipherI cipher encMem decMem) Source # |
Methods bufferStartAlignment :: CipherI cipher encMem decMem -> Alignment Source #

type family Key prim :: * Source #

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 Source # |
type Key ChaCha20 = (KEY, IV, Counter)
type Key (HMAC h) Source # |
type Key (HMAC h)
type Key (AES 128 CBC) Source # |
type Key (AES 128 CBC) = (KEY128, IV)
type Key (AES 192 CBC) Source # |
type Key (AES 192 CBC) = (KEY192, IV)
type Key (AES 256 CBC) Source # |
type Key (AES 256 CBC) = (KEY256, IV)

class Primitive p => Recommendation p where Source #

Primitives that have a recommended implementations.

Minimal complete definition

recommended

Methods

recommended :: p -> Implementation p Source #

The recommended implementation for the primitive.

data BLOCKS p Source #

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) Source # |
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) Source # |
Methods (==) :: BLOCKS p -> BLOCKS p -> Bool # (/=) :: BLOCKS p -> BLOCKS p -> Bool #
Integral (BLOCKS p) Source # |
Methods quot :: BLOCKS p -> BLOCKS p -> BLOCKS p # rem :: BLOCKS p -> BLOCKS p -> BLOCKS p # div :: BLOCKS p -> BLOCKS p -> BLOCKS p # mod :: BLOCKS p -> BLOCKS p -> BLOCKS p # quotRem :: BLOCKS p -> BLOCKS p -> (BLOCKS p, BLOCKS p) # divMod :: BLOCKS p -> BLOCKS p -> (BLOCKS p, BLOCKS p) # toInteger :: BLOCKS p -> Integer #
Num (BLOCKS p) Source # |
Methods (+) :: BLOCKS p -> BLOCKS p -> BLOCKS p # (-) :: BLOCKS p -> BLOCKS p -> BLOCKS p # (*) :: BLOCKS p -> BLOCKS p -> BLOCKS p # negate :: BLOCKS p -> BLOCKS p # abs :: BLOCKS p -> BLOCKS p # signum :: BLOCKS p -> BLOCKS p # fromInteger :: Integer -> BLOCKS p #
Ord (BLOCKS p) Source # |
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 #
Real (BLOCKS p) Source # |
Methods toRational :: BLOCKS p -> Rational #
Show (BLOCKS p) Source # |
Methods showsPrec :: Int -> BLOCKS p -> ShowS # show :: BLOCKS p -> String # showList :: [BLOCKS p] -> ShowS #
Monoid (BLOCKS p) Source # |
Methods mempty :: BLOCKS p # mappend :: BLOCKS p -> BLOCKS p -> BLOCKS p # mconcat :: [BLOCKS p] -> BLOCKS p #
Primitive p => LengthUnit (BLOCKS p) Source # |
Methods inBytes :: BLOCKS p -> BYTES Int Source #

blocksOf :: Int -> p -> BLOCKS p Source #

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 Source #

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.