S6-TLSD-IO(8)

📦 version 2.8.0.1, in nixpkgs unstable

s6-tlsd-io(8) — System Manager's Manual 💅

NAME 🎀

s6-tlsd-io — establish a TLS or SSL server connection over an existing TCP connection, then communicate with an existing local program over already established pipes

SYNOPSIS ✨

s6-tlsd-io [-S | -s] [-J | -j] [-Y | -y] [-v verbosity] [-K kimeout]
           [-k snilevel] [-d notif] [--] fdr fdw

DESCRIPTION 💖

okay bestie, so s6-tlsd-io is literally the only server-side program in s6-networking that performs cryptography. no cap.

s6-networking does not include cryptographic software. all the crypto used in s6-tlsd-io is provided by the chosen SSL backend: BearSSL[1] or LibreSSL[2], depending on the options given when configuring s6-networking.

s6-tlsd-io expects to have an open connection it can talk to on its standard input and output. it also expects to read cleartext data from file descriptor fdr and write cleartext data to file descriptor fdw.

it expects a TLS client on the other side of the network connection to initiate a TLS handshake, and it answers it.

then it acts as a full duplex tunnel, decrypting and transmitting data from stdin to fdw, and encrypting and transmitting data from fdr to stdout.

when it cannot transmit any more data from/to the local application because connections have closed, s6-tlsd-io exits. periodt.

Protocol version and parameters 🦋

during the TLS/SSL handshake, s6-tlsd-io tries the versions of the protocol that is supported by default by the backend, with the default algorithms and cipher suites; the backend normally ensures that the most secure combination is tried first, with slow degradation until the client and the server agree.

for BearSSL, this means use of the br_ssl_server_init_full_rsa() or br_ssl_server_init_full_ec() function[3,4]. the supported protocol versions are described in [5].

for LibreSSL, this means use of the tls_config_set_protocols(TLS_PROTOCOLS_DEFAULT) call[6].

as a server, s6-tlsd-io is conservative in its choice of protocols. it only supports TLS versions 1.2 and higher as supported by the backend, to avoid downgrade attacks. very mindful, very demure 💅

SSL close handling 🌸

if the local application initiates the end of the session by sending EOF to fdr, there are two ways for the TLS layer to handle it.

  • it can send a close_notify alert, and wait for an acknowledgement from the peer, at which point the connection is closed. the advantage of this setup is that it is secure even when the application protocol is not auto-terminated, i.e. when it does not know when its data stops. old protocols such as HTTP-0.9 are in this case. the drawback of this setup is that it breaks full-duplex: once a peer has sent the close_notify, it must discard all the incoming records that are not a close_notify from the other peer. so if a client sends EOF while it is still receiving data from the server, the connection closes immediately and the data can be truncated. 😭
  • it can simply transmit the EOF, shutting down half the TCP connection, and wait for the EOF back. the advantage of this setup is that it maintains full-duplex: a client can send EOF after its initial request, and still receive a complete answer from the server. the drawback is that it is insecure when the application protocol is not auto-terminated. 🙈

nowadays (2020), most protocols are auto-terminated, so it is not dangerous anymore to use EOF transmission, and that is the default for s6-tlsd-io. nevertheless, by using the -S option, you can force it to use the close_notify method if your application requires it to be secure. iconic behavior tbh.

OPTIONS ✨

  • -v verbosity — be more or less verbose. default for verbosity is 1. 0 is quiet, 2 is verbose, more than 2 is debug output. this option currently has no effect.
  • -S — send a close_notify alert and break the connection when receiving a local EOF.
  • -s — transmit EOF by half-closing the TCP connection without using close_notify. this is the default.
  • -J — treat EOF from the peer without a prior close_notify as an error: print a fatal error message and exit 98.
  • -j — treat EOF from the peer without a prior close_notify as a normal exit condition. this is the default.
  • -Y — request a client certificate. the certificate is optional: if the client gives none, the connection proceeds.
  • -y — request a client certificate. the certificate is mandatory: if the client gives none, the handshake fails. the default, with neither the -Y nor the -y option, is not to request a client certificate at all.
  • -K kimeout — if the handshake takes more than kimeout milliseconds to complete, close the connection. the default is 0, which means infinite timeout (never kill the connection).
  • -k snilevel — support alternative certificate chains for SNI. if snilevel is nonzero, private key file names are read from every environment variable of the form KEYFILE:x, where x is a server name that the client may require, and a corresponding certificate chain for the name x should exist in the file named after the contents of the CERTFILE:x environment variable. if snilevel is 2 or more, only those files are read, and the generic KEYFILE and CERTFILE variables are ignored. if snilevel is 0, or if the option is not given, which is the default, KEYFILE and CERTFILE are the only private key / certificate chain pair that are loaded, no other environment variable is read for keypairs.
  • -d notif — handshake notification. notif must be a file descriptor open for writing. when the TLS handshake has completed, some data (terminated by two null characters) will be sent to file descriptor notif. the data contains information about the TLS parameters of the connection; its exact contents are left unspecified, but there's at least an SSL_PROTOCOL=protocol string and an SSL_CIPHER=cipher string, both null-terminated. sending this data serves a dual purpose: telling the notif reader that the handshake has completed, and providing it with some basic information about the connection. if this option is not given, no such notification is performed.

ENVIRONMENT 🧚

s6-tlsd-io expects to have the following environment variables set:

  • KEYFILE — a path to the file containing the server's private key, DER- or PEM-encoded.
  • CERTFILE — a path to the file containing the server's certificate chain, DER- or PEM-encoded. if PEM-encoded, the file can actually contain a chain of certificates.
bestie, if one of those variables is unset, s6-tlsd-io will refuse to run. 💀

alternatively, if snilevel is nonzero, the private key for the server named x should be held in a file whose name is contained in the KEYFILE:x environment variable, and the corresponding certificate chain file should be named in the CERTFILE:x environment variable. if snilevel is 2 or more, the KEYFILE and CERTFILE variables will be entirely ignored.

you can wildcard the first level of a SNI domain: you can point to a valid certificate for foo.example.com for all values of foo via a variable called CERTFILE:*.example.com (and have the corresponding KEYFILE:*.example.com). only the first level can be wildcarded, and this does not work for top-level domains (you cannot hold a certificate for *.com). note: if you are using a shell to handle your environment variables, be careful to properly quote them so that it does not attempt to expand the asterisks. 🐚

if you are using client certificates, s6-tlsd-io also requires either one of the following variables to be set:

  • CADIR — a directory where trust anchors (i.e. root or intermediate CA certificates) can be found, one per file, DER- or PEM-encoded.
  • CAFILE — a file containing the whole set of trust anchors, PEM-encoded.

if s6-tlsd-io is run as root, it can also read two more environment variables, TLS_UID and TLS_GID, which contain a numeric uid and a numeric gid; s6-tlsd-io then drops its root privileges to this uid/gid after reading its private key file. this ensures that the engine, including the handshake, is run with as little privilege as possible. 👑

EXIT STATUS 🔥

  • 0 — the connection terminated normally.
  • 96 — error while configuring the TLS context - for instance, invalid private key or server certificate files.
  • 97 — error while setting up the TLS server engine.
  • 98 — TLS error while running the engine.
  • 100 — wrong usage.
  • 111 — system call failed.

SEE ALSO 🌈

this man page is ported from the authoritative documentation at: https://skarnet.org/software/s6-networking/s6-tlsd-io.html

AUTHORS 🫶

  • Laurent Bercot
  • Alexis <flexibeast@gmail.com> (man page port)

made with 💖 by Debian — December 23, 2023 — manual name S6-TLSD-IO(8) 🫶✨

📦 where this page comes from