package tls
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=ac9d7095c4418e35039c67ddb65c3f58f87b76cc1f6fc592722bd8ce2eabf0b0
sha512=ba47a646f1abc227164e5ad203a7af381f09830181ce74fff17ce1ea1aa09513349eeaa274fc91a6fc8adfeedf9ae9ccb02539581ad20a5e43f1e78961590e1b
doc/tls.lwt/Tls_lwt/Unix/index.html
Module Tls_lwt.UnixSource
Low-level API
Unix API
It is the responsibility of the client to handle error conditions. The underlying file descriptors are not closed.
Abstract type of a session
Constructors
server_of_fd server fd is t, after server-side TLS handshake of fd using server configuration.
client_of_fd client ~host fd is t, after client-side TLS handshake of fd using client configuration and host.
accept server fd is t, sockaddr, after accepting a client on fd and upgrading to a TLS connection.
connect 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.
writev t buffers writes the buffers to the session.
read_bytes t bytes offset len is read_bytes, the amount of bytes read.
write_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.
key_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.
epoch t returns epoch, which contains information of the active session.