package tls

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

High-level API

Transport Layer Security purely in OCaml

Install

dune-project

Dependency

github.com Readme Changelog BSD-2-Clause License Edit opam file Versions (15)

Authors

Maintainers

Sources

tls-0.15.4.tbz

sha256=5f8d1d56b06f6069efd1d0a3de0c45cb488d3d13eb7f132c84ec7ba3f0d1c382

sha512=333352cb90bd1a43763571373e61fea1c0ea31f81ef728069344bf807e5a1916d3e249260b37bae62128961f4f7cbfd3cb22b1541088aa241e4637aec7aa7876

doc/tls.lwt/Tls_lwt/index.html

Module `Tls_lwt`Source

Effectful operations using Lwt for pure TLS.

The pure TLS is state and buffer in, state and buffer out. This module uses Lwt for communication over the network.

This module implements a high-level API and a low-level API (in Unix). Most applications should use the high-level API described below.

Sourceexception Tls_alert of Tls.Packet.alert_type

Tls_alert exception received from the other endpoint

Sourceexception Tls_failure of Tls.Engine.failure

Tls_failure exception while processing incoming data

Sourcemodule Unix : sig ... end

Low-level API

High-level API

Sourcetype ic = Lwt_io.input_channel

Sourcetype oc = Lwt_io.output_channel

Source

val accept_ext : 
  Tls.Config.server ->
  Lwt_unix.file_descr ->
  ((ic * oc) * Lwt_unix.sockaddr) Lwt.t

accept_ext server fd is (ic, oc), sockaddr, the input and output channel from an accepted connection on the given fd, after upgrading to TLS using the server configuration.

Source

val accept : 
  Tls.Config.own_cert ->
  Lwt_unix.file_descr ->
  ((ic * oc) * Lwt_unix.sockaddr) Lwt.t

accept own_cert fd is (ic, oc), sockaddr, the input and output channel from the accepted connection on fd, using the default configuration with the given own_cert.

Sourceval connect_ext : Tls.Config.client -> (string * int) -> (ic * oc) Lwt.t

connect_ext client (host, port) is ic, oc, the input and output channel of a TLS connection to host on port using the client configuration.

Sourceval connect : X509.Authenticator.t -> (string * int) -> (ic * oc) Lwt.t

connect authenticator (host, port) is ic, oc, the input and output channel of a TLS connection to host on port using the default configuration and the authenticator.

Sourceval of_t : ?close:(unit -> unit Lwt.t) -> Unix.t -> ic * oc

of_t t is ic, oc, the input and output channel. close defaults to !Unix.close.