package mirage-crypto

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Core operations
All-in-one
Functions over iterators

mirage-crypto
- Mirage_crypto
  - AEAD
  - Chacha20
  - Cipher_block
    
    AES
    
    CBC
    
    CCM
    
    CTR
    
    ECB
    
    GCM
    
    DES
    
    CBC
    
    CTR
    
    ECB
    
    S
    
    CBC
    
    CCM
    
    CTR
    
    ECB
    
    GCM
  - Cipher_stream
    
    ARC4
    
    S
  - Hash
    
    MD5
    
    S
    
    SHA1
    
    SHA224
    
    SHA256
    
    SHA384
    
    SHA512
  - Poly1305

Legend:
Library
Module
Module type
Parameter
Class
Class type

val digest_size : int

Size of digests (in bytes).

Core operations

type t

Represents a running hash computation in a way suitable for appending inputs.

val empty : t

empty is the hash of the empty string.

val feed : t -> Cstruct.t -> t

feed t msg adds the information in msg to t.

feed is analogous to appending: feed (feed t msg1) msg2 = feed t (Cstruct.append msg1 msg2).

val get : t -> digest

get t is the digest corresponding to t.

All-in-one

Functions that operate on data stored in a single chunk.

val digest : Cstruct.t -> digest

digest msg is the digest of msg.

digest msg = get (feed empty msg)

val hmac : key:Cstruct.t -> Cstruct.t -> digest

hmac ~key bytes is the authentication code for bytes under the secret key, generated using the standard HMAC construction over this hash algorithm.

Functions over iterators

Functions that operate on arbitrary iterators. They can serve as a basis for other, more specialized aggregate hashing operations.

These functions are a little faster than using feed directly.

val feedi : t -> Cstruct.t iter -> t

feedi t iter = (let r = ref t in iter (fun msg -> r := feed !r msg); !r)

val digesti : Cstruct.t iter -> digest

digesti iter = feedi empty iter |> get

val hmaci : key:Cstruct.t -> Cstruct.t iter -> digest

See hmac.