package mirage-crypto

You can search for identifiers within the package.

in-package search v0.2.0

mirage-crypto
- Mirage_crypto
  - 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

Legend:
Library
Module
Module type
Parameter
Class
Class type

type key

type result = {

message : Cstruct.t;
tag : Cstruct.t;

}

The transformed message, packed with the authentication tag.

val of_secret : Cstruct.t -> key

Construct the encryption key corresponding to secret.

raises Invalid_argument
if the length of secret is not in key_sizes.

val key_sizes : int array

Key sizes allowed with this cipher.

val block_size : int

The size of a single block.

val encrypt : 
  key:key ->
  iv:Cstruct.t ->
  ?adata:Cstruct.t ->
  Cstruct.t ->
  result

encrypt ~key ~iv ?adata msg is the result containing msg encrypted under key, with iv as the initialization vector, and the authentication tag computed over both adata and msg.

raises Invalid_argument
if the length iv is 0.

val decrypt : 
  key:key ->
  iv:Cstruct.t ->
  ?adata:Cstruct.t ->
  Cstruct.t ->
  result

decrypt ~key ~iv ?adata msg is the result containing the inversion of encrypt and the same authentication tag.

raises Invalid_argument
if the length iv is 0.