Index of types

A
aead_cipher [Ciphersuite]
alert_level [Packet]
alert_type [Packet]
any_ciphersuite [Packet]
authenticator [X509_lwt]

authenticator

B
block_cipher [Ciphersuite]
buffer [Tls_mirage.Make]
C
certchain [Config]

certificate chain and private key of the first certificate

ciphersuite [Ciphersuite]
client [Config]

opaque type of a client configuration

client_certificate_type [Packet]
client_extension [Core]
client_hello [Core]
compression_method [Packet]
config [Config]

configuration parameters

content_type [Packet]
D
dh_parameters [Core]
E
ec_basis_type [Packet]
ec_char_parameters [Core]
ec_curve [Core]
ec_curve_type [Packet]
ec_parameters [Core]
ec_point_format [Packet]
ec_prime_parameters [Core]
epoch [Engine]

polymorphic variant of session information.

epoch_data [Core]

information about an open session

error [Tls_mirage.Make]

possible errors: incoming alert, processing failure, or a problem in the underlying flow.

error [Engine]

failures which can be mitigated by reconfiguration

extension_type [Packet]
F
failure [Engine]

type of failures

fatal [Engine]

failures from received garbage or lack of features

H
handshake_type [Packet]
hash_algorithm [Packet]
I
ic [Tls_lwt]
io [Tls_mirage.Make]
K
key_exchange_algorithm [Ciphersuite]

sum type of all possible key exchange methods

M
master_secret [Core]

the master secret of a TLS connection

max_fragment_length [Packet]
N
named_curve_type [Packet]
O
oc [Tls_lwt]
own_cert [Config]

polymorphic variant of own certificates

P
payload_protection [Ciphersuite]
priv [X509_lwt]

private material: a certificate chain and a RSA private key

R
ret [Engine]

result type of Engine.handle_tls: either failed to handle the incoming buffer (`Fail) with Engine.failure and potentially a message to send to the other endpoint, or sucessful operation (`Ok) with a new Engine.state, an end of file (`Eof), or an incoming (`Alert).

S
server [Config]

opaque type of a server configuration

server_extension [Core]
server_hello [Core]
session_cache [Config]
signature_algorithm_type [Packet]
state [Engine]

The abstract type of a TLS state.

stream_cipher [Ciphersuite]
T
t [Tls_lwt.Unix]

Abstract type of a session

t [Core.SessionID]
tls_alert [Core]
tls_any_version [Core]
tls_body [Core]
tls_handshake [Core]
tls_hdr [Core]
tls_version [Core]
tracer [Tls_mirage.Make]
tracer [Tls_lwt]

tracing of TLS sessions

W
write_error [Tls_mirage.Make]

The type for write errors.