package hacl-star

  1. Overview
  2. Docs
package hacl-star
Legend:
Library
Module
Module type
Parameter
Class
Class type
module type Buffer = sig ... end

Abstract representation of buffers

module CBytes : Buffer with type t = Stdlib.Bytes.t and type buf = Stdlib.Bytes.t Ctypes.ocaml

Representation of Bytes.t buffers

module Hacl_Hash : sig ... end
module Hacl_Spec : sig ... end
module Hacl_Streaming_Types : sig ... end
val max_uint32 : Z.t
val max_uint64 : Z.t
val pow2_31 : Z.t
val check_max_buffer_len : int -> unit
module AEADDefs : sig ... end
module HashDefs : sig ... end
module type Chacha20_Poly1305_generic = sig ... end
module type Curve25519_generic = sig ... end

See here for detailed usage instructions.

module type EdDSA_generic = sig ... end

See here for detailed usage instructions.

module type HashFunction_generic = sig ... end
module type MAC_generic = sig ... end

For Poly1305, buffers have the following size constraints:

module type HKDF_generic = sig ... end

Buffers have the following size constraints with respect to the digest size of the underlying hash function, digest_len:

module type ECDSA_generic = sig ... end

Buffers have the following size constraints:

module type Blake2_generic = sig ... end

Buffers have the following size constraints:

module type Curve25519 = Curve25519_generic with type bytes = CBytes.t

See here for detailed usage instructions.

module type EdDSA = EdDSA_generic with type bytes = CBytes.t

See here for detailed usage instructions.

module type MAC = MAC_generic with type bytes = CBytes.t

For Poly1305, buffers have the following size constraints:

module type HKDF = HKDF_generic with type bytes = CBytes.t

Buffers have the following size constraints with respect to the digest size of the underlying hash function, digest_len:

module type ECDSA = ECDSA_generic with type bytes = CBytes.t

Buffers have the following size constraints:

module type Blake2 = Blake2_generic with type bytes = CBytes.t

Buffers have the following size constraints:

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct