Rustls client config builder.

A ClientConfigBuilder with good defaults.

How to look up root certificates.

In-memory PEM-encoded certificates.

Assembled configuration for a Rustls client connection.

A logging callback. If it throws an exception, a note will be printed to stderr.

Note that this is a record selector, so you can use it as a setter:

>>> :{
setLogCallback :: LogCallback -> ClientConfig -> ClientConfig
setLogCallback logCallback clientConfig =
  clientConfig { clientConfigLogCallback = Just logCallback }
:}

Build a ClientConfigBuilder into a ClientConfig.

This is a relatively expensive operation, so it is a good idea to share one ClientConfig when creating multiple Connections.

Initialize a TLS connection as a client.

Rustls client config builder.

A ServerConfigBuilder with good defaults.

How to verify TLS client certificates.

Assembled configuration for a Rustls server connection.

A logging callback. If it throws an exception, a note will be printed to stderr.

Note that this is a record selector, so you can use it as a setter:

>>> :{
setLogCallback :: LogCallback -> ServerConfig -> ServerConfig
setLogCallback logCallback serverConfig =
  serverConfig { serverConfigLogCallback = Just logCallback }
:}

Build a ServerConfigBuilder into a ServerConfig.

This is a relatively expensive operation, so it is a good idea to share one ServerConfig when creating multiple Connections.

Initialize a TLS connection as a server.

A Rustls connection.

Type-level indicator whether a Connection is client- or server-side.

Read data from the Rustls Connection into a ByteString. The result will not be longer than the given length.

Write a ByteString to the Rustls Connection.

Ensure that the connection is handshaked. It is only necessary to call this if you want to obtain connection information. You can do so by providing a HandshakeQuery.

>>> :{
getALPNAndTLSVersion ::
  MonadIO m =>
  Connection side ->
  m (Maybe ALPNProtocol, TLSVersion)
getALPNAndTLSVersion conn =
  handshake conn $ (,) <$> getALPNProtocol <*> getTLSVersion
:}

A Monad to get TLS connection information via handshake.

Get the negotiated ALPN protocol, if any.

Get the negotiated TLS protocol version.

Get the negotiated cipher suite.

Get the SNI hostname set by the client, if any.

Get the i-th certificate provided by the peer.

Index 0 is the end entity certificate. Higher indices are certificates in the chain. Requesting an index higher than what is available returns Nothing.

Send a close_notify warning alert. This informs the peer that the connection is being closed.

A Rustls connection logging callback.

Allocate a new logging callback, taking a LogLevel and a message.

🚫 Make sure that its lifetime encloses those of the Connections which you configured to use it.

Rustls log level.

Read data from the Rustls Connection into the given buffer.

Write data to the Rustls Connection from the given buffer.

Combined version string of Rustls and rustls-ffi.

>>> version
"rustls-ffi/0.9.1/rustls/0.20.4"

Underlying data sources for Rustls.

An in-memory Backend.

An ALPN protocol ID. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for a list of registered IDs.

A complete chain of certificates plus a private key for the leaf certificate.

A DER-encoded certificate.

A TLS protocol version supported by Rustls.

The default TLSVersions used by Rustls. A subset of defaultTLSVersions.

All TLSVersions supported by Rustls.

A TLS cipher suite supported by Rustls.

Get the IANA value from a cipher suite. The bytes are interpreted in network order.

See https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-4 for a list.

Get the text representation of a cipher suite.

The default CipherSuites used by Rustls. A subset of allCipherSuites.

All CipherSuites supported by Rustls.

TLS exception thrown by Rustls.

Use displayException for a human-friendly representation.

Checks if the given RustlsException represents a certificate error.