package tezos-hacl-glue-unix

You can search for identifiers within the package.

in-package search v0.2.0

tezos-hacl-glue-unix
- Tezos_hacl_glue
  - Hacl
    
    Blake2b
    
    Box
    
    Ed25519
    
    Hash
    
    DIRECT_HASH
    
    INCREMENTAL_HASH
    
    Keccak_256
    
    S
    
    HMAC
    
    SHA256
    
    HMAC
    
    SHA3_256
    
    SHA3_512
    
    SHA512
    
    HMAC
    
    Nonce
    
    P256
    
    Rand
    
    SIGNATURE
    
    Secretbox

Legend:
Library
Module
Module type
Parameter
Class
Class type

type key

val keybytes : int

Size of the secret key

val tagbytes : int

Size of the message authentication tag

val unsafe_of_bytes : Bytes.t -> key

raises Invalid_argument
if argument is not keybytes bytes long

val blit_of_bytes : Bytes.t -> int -> key

raises Invalid_argument
if argument is not keybytes bytes long

val genkey : unit -> key

genkey () generates a secretbox key.

val secretbox : key:key -> nonce:Bytes.t -> msg:Bytes.t -> cmsg:Bytes.t -> unit

secretbox key nonce msg cmsg encrypts and authenticates the data in msg using key and nonce and outputs the authentication tag and the ciphertext in one buffer cmsg. For this reason, csmg needs to be tagbytes longer than msg.

val secretbox_open : 
  key:key ->
  nonce:Bytes.t ->
  cmsg:Bytes.t ->
  msg:Bytes.t ->
  bool

secretbox_open key nonce cmsg msg verifies and decrypts cmsg using key and nonce and outputs the plaintext in msg. As above, msg is expected to be tagbytes shorter than cmsg. Returns true if operation has succeeded, false otherwise.