On This Page
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package tls-mirage
TLS module given a flow
Parameters
module F : Mirage_flow.SSignature
module FLOW = Ftype error = [ | `Tls_alert of Tls.Packet.alert_type| `Tls_failure of Tls.Engine.failure| `Read of F.error| `Write of F.write_error
]possible errors: incoming alert, processing failure, or a problem in the underlying flow.
The type for write errors.
we provide the FLOW interface
include Mirage_flow.S
with type error := error
and type write_error := write_error
val pp_error : error Fmt.tpp_error is the pretty-printer for errors.
val pp_write_error : write_error Fmt.tpp_write_error is the pretty-printer for write errors.
The type for flows. A flow represents the state of a single reliable stream that is connected to an endpoint.
val read : flow -> (Cstruct.t Mirage_flow.or_eof, error) Stdlib.result Lwt.tread flow blocks until some data is available and returns a fresh buffer containing it.
The returned buffer will be of a size convenient to the flow implementation, but will always have at least 1 byte.
If the remote endpoint calls close then calls to read will keep returning data until all the in-flight data has been read. read flow will return `Eof when the remote endpoint has called close and when there is no more in-flight data.
val write : flow -> Cstruct.t -> (unit, write_error) Stdlib.result Lwt.twrite flow buffer writes a buffer to the flow. 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, Error `Closed indicates that the connection is now closed and therefore the data could not be written. Other errors are possible.
val writev : flow -> Cstruct.t list -> (unit, write_error) Stdlib.result Lwt.twritev flow buffers writes a sequence of buffers to the flow. There is no indication when the buffers have actually been read and, therefore, they must not be reused. The result Ok () indicates success, Error `Closed indicates that the connection is now closed and therefore the data could not be written. Other errors are possible.
val close : flow -> unit Lwt.tclose flow flushes all pending writes and signals 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 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).
close flow waits until the remote endpoint has also called close before returning. At this point no data can flow in either direction and resources associated with the flow can be freed.
val reneg :
?authenticator:X509.Authenticator.t ->
?acceptable_cas:X509.Distinguished_name.t list ->
?cert:Tls.Config.own_cert ->
?drop:bool ->
flow ->
(unit, write_error) Stdlib.result Lwt.treneg ~authenticator ~acceptable_cas ~cert ~drop t renegotiates the session, and blocks until the renegotiation finished. Optionally, a new authenticator and acceptable_cas can be used. The own certificate can be adjusted by cert. If drop is true (the default), application data received before the renegotiation finished is dropped.
val key_update :
?request:bool ->
flow ->
(unit, write_error) Stdlib.result Lwt.tkey_update ~request t updates the traffic key and requests a traffic key update from the peer if request is provided and true (the default). This is only supported in TLS 1.3.
val client_of_flow :
Tls.Config.client ->
?host:string ->
FLOW.flow ->
(flow, write_error) Stdlib.result Lwt.tclient_of_flow client ~host flow upgrades the existing connection to TLS using the client configuration, using host as peer name.
val server_of_flow :
Tls.Config.server ->
FLOW.flow ->
(flow, write_error) Stdlib.result Lwt.tserver_of_flow server flow upgrades the flow to a TLS connection using the server configuration.
val epoch : flow -> (Tls.Core.epoch_data, unit) Stdlib.resultepoch flow extracts information of the established session.
On This Page