| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Raaz.Core.Primitives
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.
- 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
Associated Types
type Implementation p :: * Source #
Associated type that captures an implementation of this primitive.
Instances
| Primitive BLAKE2s Source # | |
| Primitive BLAKE2b Source # | |
| Primitive SHA1 Source # | |
| Primitive SHA256 Source # | |
| Primitive SHA224 Source # | |
| Primitive SHA384 Source # | |
| Primitive SHA512 Source # | |
| Primitive ChaCha20 Source # | |
| Primitive (AES 128 CBC) Source # | The 128-bit aes cipher in cbc mode. |
| Primitive (AES 192 CBC) Source # | The 192-bit aes cipher in cbc mode. |
| Primitive (AES 256 CBC) Source # | The 256-bit aes cipher in cbc mode. |
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
Methods
bufferStartAlignment :: a -> Alignment Source #
The alignment expected for the buffer pointer.
Instances
| BlockAlgorithm (SomeHashI h) Source # | |
| BlockAlgorithm (SomeCipherI cipher) Source # | |
| BlockAlgorithm (HashI h m) Source # | |
| BlockAlgorithm (CipherI cipher encMem decMem) 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.
class Primitive p => Recommendation p where Source #
Primitives that have a recommended implementations.
Minimal complete definition
Methods
recommended :: p -> Implementation p Source #
The recommended implementation for the primitive.
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.
blocksOf :: Int -> p -> BLOCKS p Source #
The expression n specifies the message lengths in
units of the block length of the primitive blocksOf pp. 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.