package tls-miou-unix

  1. Overview
  2. Docs
Transport Layer Security purely in OCaml, Miou+Unix layer

Install 

dune-project
 Dependency

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

Authors

  1. R
    Romain Calascibetta <romain.calascibetta@gmail.com>

Maintainers

  1. R
    Romain Calascibetta <romain.calascibetta@gmail.com>

Sources

tls-2.1.2.tbz
sha256=d51940587bce9475c977c596904c8179dcd784d9ef6dd9afe3e634cca940c9f3
sha512=9d9e9ebc9bd4aa7a87bd438c5fbf38e3529cbd916c2995a25473a1f6d8443ae1ab99b89ba9d074272e00631aafa47bfcf4e23466fa28f1f10bb83167402b7268

doc/tls-miou-unix/Tls_miou_unix/index.html

Module Tls_miou_unixSource

Effectful operations using Miou for pure TLS.

The pure TLS is state and buffer in, state and buffer out. This module uses Miou (and its Unix layer) for communication over the network.

Sourceexception Tls_alert of Tls.Packet.alert_type
Sourceexception Tls_failure of Tls.Engine.failure
Sourceexception Closed_by_peer
Sourcetype t

Abstract type of a session.

Sourceval file_descr : t -> Miou_unix.file_descr

file_descr returns the underlying file-descriptor used by the given TLS socket.

Sourceval read : t -> ?off:int -> ?len:int -> bytes -> int

read fd buf ~off ~len reads up to len bytes (defaults to Bytes.length buf - off from the given TLS socket fd, storing them in byte sequence buf, starting at position off in buf (defaults to 0). It returns the actual number of characters read, between 0 and len (inclusive).

  • raises Unix_error

    raised by the system call Unix.read. The function handles Unix.EINTR, Unix.EAGAIN and Unix.EWOULDBLOCK exceptions and redo the system call.

Sourceval really_read : t -> ?off:int -> ?len:int -> bytes -> unit

really_read fd buf ~off ~len reads len bytes (defaults to Bytes.length buf - off) from the given TLS socket fd, storing them in byte sequence buf, starting at position off in buf (defaults to 0). If len = 0, really_read does nothing.

  • raises Unix_error

    raised by the system call Unix.read. The function handles Unix.EINTR, Unix.EAGAIN and Unix.EWOULDBLOCK exceptions and redo the system call.

  • raises End_of_file

    if Unix.read returns 0 before len characters have been read.

Sourceval write : t -> ?off:int -> ?len:int -> string -> unit

write t str ~off ~len writes len bytes (defaults to String.length str - off) from byte sequence str, starting at offset off (defaults to 0), to the given TLS socket fd.

  • raises Unix_error

    raised by the syscall call Unix.write. The function handles Unix.EINTR, Unix.EAGAIN and Unix.EWOULDBLOCK exceptions and redo the system call.

  • raises Closed_by_peer

    if t is connected to a peer whose reading end is closed. Similar to the EPIPE error for pipe/socket connected.

Sourceval close : t -> unit

close flow closes the TLS session and the underlying file-descriptor.

Sourceval shutdown : t -> [ `read | `write | `read_write ] -> unit

shutdown t direction closes the direction of the TLS session t. If `read_write or `write is closed, a TLS close-notify is sent to the other endpoint. If this results in a fully-closed session (or an errorneous session), the underlying file descriptor is closed.

Sourceval client_of_fd : Tls.Config.client -> ?read_buffer_size:int -> ?host:[ `host ] Domain_name.t -> ?ip:Ipaddr.t -> Miou_unix.file_descr -> t

client_of_flow client ~host ~ip fd is t, after client-side TLS handshake of fd using client configuration and host or ip.

Returns a TLS flow which may be fully active or half-closed.

  • raises End_of_file

    if the peer closes before the handshake completes.

Sourceval server_of_fd : Tls.Config.server -> ?read_buffer_size:int -> Miou_unix.file_descr -> t

server_of_fd server fd is t, after server-side TLS handshake of fd using server configuration.

Returns a TLS flow which may be fully active or half-closed.

  • raises End_of_file

    if the peer closes before the handshake completes.

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

connect authenticator (host, port) is t, a connected TLS connection to host on port using the default configuration and the authenticator.

Returns a TLS flow which may be fully active or half-closed.

Sourceval epoch : t -> Tls.Core.epoch_data option

epoch t returns epoch, which contains information of the session.