package mirage-crypto

You can search for identifiers within the package.

in-package search v0.2.0

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

include AEAD

type key

The abstract type for the key.

val authenticate_encrypt : 
  key:key ->
  nonce:Cstruct.t ->
  ?adata:Cstruct.t ->
  Cstruct.t ->
  Cstruct.t

authenticate_encrypt ~key ~nonce ~adata msg encrypts msg with key and nonce, and appends an authentication tag computed over the encrypted msg, using key, nonce, and adata.

raises Invalid_argument
if nonce is not of the right size.

val authenticate_decrypt : 
  key:key ->
  nonce:Cstruct.t ->
  ?adata:Cstruct.t ->
  Cstruct.t ->
  Cstruct.t option

authenticate_decrypt ~key ~nonce ~adata msg splits msg into encrypted data and authentication tag, computes the authentication tag using key, nonce, and adata, and decrypts the encrypted data. If the authentication tags match, the decrypted data is returned.

raises Invalid_argument
if nonce is not of the right size.

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 tag_size : int

The size of the authentication tag.