package tls

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package tls

tls
- Tls
tls.lwt
- Tls_lwt
  - Unix
- X509_lwt
tls.mirage
- Tls_mirage
  - Make
    
    F
  - X509
    
    C
    
    KV

Legend:
Library
Module
Module type
Parameter
Class
Class type

TLS module given a flow

Parameters

module F : V1_LWT.FLOW

Signature

module FLOW = F

type error = [

| `Tls_alert of Tls.Packet.alert_type
| `Tls_failure of Tls.Engine.failure
| `Flow of FLOW.error

]

possible errors: incoming alert, processing failure, or a problem in the underlying flow.

type buffer = Cstruct.t

type +'a io = 'a Lwt.t

type tracer = Sexplib.Sexp.t -> unit

we provide the FLOW interface

include V1_LWT.FLOW
  with type error := error
   and type 'a io := 'a io
   and type buffer := buffer

type flow

The type for flows. A flow represents the state of a single stream that is connected to an endpoint.

val error_message : error -> string

Convert an error to a human-readable message, suitable for logging.

val read : flow -> [ `Ok of buffer | `Eof | `Error of error ] io

read flow will block until it either successfully reads a segment of data from the current flow, receives an Eof signifying that the connection is now closed, or an Error.

val write : flow -> buffer -> [ `Ok of unit | `Eof | `Error of error ] io

write flow buffer will block until buffer has been added to the send queue. There is no indication when the buffer has actually been read and, therefore, it must not be reused. The contents may be transmitted in separate packets, depending on the underlying transport. The result `Ok () indicates success, `Eof indicates that the connection is now closed and `Error indicates some other error.

val writev : flow -> buffer list -> [ `Ok of unit | `Eof | `Error of error ] io

writev flow buffers will block until the buffers have all been added to the send queue. There is no indication when the buffers have actually been read and, therefore, they must not be reused. The result `Ok () indicates success, `Eof indicates that the connection is now closed and `Error indicates some other error.

val close : flow -> unit io

close flow will flush all pending writes and signal the remote endpoint that there will be no future writes. Once the remote endpoint has read all pending data, it is expected that calls to read on the remote will return `Eof.

Note it is still possible for the remote endpoint to write to the flow and for the local endpoint to call read. This state where the local endpoint has called close but the remote endpoint has not called close is similar to that of a half-closed TCP connection or a Unix socket after shutdown(SHUTDOWN_WRITE).

The result unit io will become determined when the remote endpoint finishes calling write and calls close. At this point no data can flow in either direction and resources associated with the flow can be freed.

val reneg : flow -> [ `Ok of unit | `Eof | `Error of error ] Lwt.t

reneg flow renegotiates the session.

val client_of_flow : 
  ?trace:tracer ->
  Tls.Config.client ->
  string ->
  FLOW.flow ->
  [> `Ok of flow | `Error of error | `Eof ] Lwt.t

client_of_flow ?trace client hostname flow upgrades the existing connection to TLS using the client configuration and given hostname.

val server_of_flow : 
  ?trace:tracer ->
  Tls.Config.server ->
  FLOW.flow ->
  [> `Ok of flow | `Error of error | `Eof ] Lwt.t

server_of_flow ?tracer server flow upgrades the flow to a TLS connection using the server configuration.

val epoch : flow -> [ `Ok of Tls.Core.epoch_data | `Error ]

epoch flow extracts information of the established session.