package letsencrypt-mirage

You can search for identifiers within the package.

in-package search v0.2.0

letsencrypt-mirage
- LE
  - Make
    
    Stack
    
    IP
    
    TCP
    
    UDP
    
    Time
letsencrypt-mirage.http-server
- LE_http_server
  - Make
    
    Paf
    
    TCP
    
    TLS
    
    Stack
    
    IP
    
    TCP
    
    UDP
    
    Time

Legend:
Library
Module
Module type
Parameter
Class
Class type

type error = [

| `Read of TCP.error
| `Tls_alert of Tls.Packet.alert_type
| `Tls_failure of Tls.Engine.failure
| `Write of TCP.write_error

]

type write_error = [

| `Closed
| `Read of TCP.error
| `Tls_alert of Tls.Packet.alert_type
| `Tls_failure of Tls.Engine.failure
| `Write of TCP.write_error

]

val pp_error : error Fmt.t

val pp_write_error : write_error Fmt.t

type flow = Paf_mirage.Make(Stack.TCP).TLS.flow

val read : flow -> (Cstruct.t Mirage_flow.or_eof, error) Stdlib.result Lwt.t

val write : flow -> Cstruct.t -> (unit, write_error) Stdlib.result Lwt.t

val writev : flow -> Cstruct.t list -> (unit, write_error) Stdlib.result Lwt.t

val shutdown : flow -> [ `read | `read_write | `write ] -> unit Lwt.t

val close : flow -> unit Lwt.t

val no_close : flow -> unit

val to_close : flow -> unit

val epoch : flow -> (Tls.Core.epoch_data, unit) Stdlib.result

val reneg : 
  ?authenticator:X509.Authenticator.t ->
  ?acceptable_cas:X509.Distinguished_name.t list ->
  ?cert:Tls.Config.own_cert ->
  ?drop:bool ->
  flow ->
  (unit,
    [ `Closed
    | `Msg of string
    | `Read of TCP.error
    | `Tls_alert of Tls.Packet.alert_type
    | `Tls_failure of Tls.Engine.failure
    | `Write of TCP.write_error ])
    Stdlib.result
    Lwt.t

val key_update : 
  ?request:bool ->
  flow ->
  (unit,
    [ `Closed
    | `Msg of string
    | `Read of TCP.error
    | `Tls_alert of Tls.Packet.alert_type
    | `Tls_failure of Tls.Engine.failure
    | `Write of TCP.write_error ])
    Stdlib.result
    Lwt.t

val server_of_flow : 
  Tls.Config.server ->
  TCP.flow ->
  (flow, write_error) Stdlib.result Lwt.t

val client_of_flow : 
  Tls.Config.client ->
  ?host:[ `host ] Domain_name.t ->
  TCP.flow ->
  (flow, write_error) Stdlib.result Lwt.t