package tls
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=e0e3cda664bbb510afd1f40a3c499326c02e2955785558e2d857e5ab4da445c5
sha512=1cf424a19a103ac8e0dcbae3673ebc5f774a867500cb12485d06a10f8af28580800e0a61e21da62ce7f695d695a03cad06f954930ef3b86f85b22fdae0c977d0
doc/tls.lwt/Tls_lwt/Unix/index.html
Module Tls_lwt.Unix
Low-level API
Unix API
It is the responsibility of the client to handle error conditions. The underlying file descriptors are not closed.
Constructors
val server_of_fd :
?trace:tracer ->
Tls.Config.server ->
Lwt_unix.file_descr ->
t Lwt.tserver_of_fd ?tracer server fd is t, after server-side TLS handshake of fd using server configuration.
val client_of_fd :
?trace:tracer ->
Tls.Config.client ->
?host:string ->
Lwt_unix.file_descr ->
t Lwt.tclient_of_fd ?tracer client ~host fd is t, after client-side TLS handshake of fd using client configuration and host.
val accept :
?trace:tracer ->
Tls.Config.server ->
Lwt_unix.file_descr ->
(t * Lwt_unix.sockaddr) Lwt.taccept ?tracer server fd is t, sockaddr, after accepting a client on fd and upgrading to a TLS connection.
val connect : ?trace:tracer -> Tls.Config.client -> (string * int) -> t Lwt.tconnect ?tracer client (host, port) is t, after successful connection to host on port and TLS upgrade.
Common stream operations
read t buffer is length, the number of bytes read into buffer.
val read_bytes : t -> Lwt_bytes.t -> int -> int -> int Lwt.tread_bytes t bytes offset len is read_bytes, the amount of bytes read.
val write_bytes : t -> Lwt_bytes.t -> int -> int -> unit Lwt.twrite_bytes t bytes offset length writes length bytes of bytes starting at offset to the session.
close t closes the TLS session by sending a close notify to the peer.
val reneg :
?authenticator:X509.Authenticator.t ->
?acceptable_cas:X509.Distinguished_name.t list ->
?cert:Tls.Config.own_cert ->
?drop:bool ->
t ->
unit 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 epoch : t -> [ `Ok of Tls.Core.epoch_data | `Error ]epoch t returns epoch, which contains information of the active session.