diff options
author | Laurent Bercot <ska-skaware@skarnet.org> | 2023-09-30 09:37:46 +0000 |
---|---|---|
committer | Laurent Bercot <ska@appnovation.com> | 2023-09-30 09:37:46 +0000 |
commit | 9dbc40d83a89ef735d94dc235aa825135aef5407 (patch) | |
tree | 19ae4f22cd2e20d79c11444c840cc9a4f9e1e6d1 | |
parent | bef76b45f480aa41209efdec09fc6bb0bfde7cbe (diff) | |
download | s6-networking-9dbc40d83a89ef735d94dc235aa825135aef5407.tar.xz |
s6-tlsserver bugfix, doc updates
Signed-off-by: Laurent Bercot <ska@appnovation.com>
-rw-r--r-- | .gitignore | 8 | ||||
-rw-r--r-- | NEWS | 15 | ||||
-rw-r--r-- | doc/s6-tlsclient.html | 32 | ||||
-rw-r--r-- | doc/s6-tlsserver.html | 59 | ||||
-rw-r--r-- | doc/upgrade.html | 2 | ||||
-rw-r--r-- | src/tls/s6-tlsserver.c | 23 |
6 files changed, 64 insertions, 75 deletions
@@ -13,13 +13,9 @@ /s6-taiclockd /s6-tcpclient /s6-tcpserver +/s6-tcpserver-socketbinder +/s6-tcpserverd /s6-tcpserver-access -/s6-tcpserver4 -/s6-tcpserver4-socketbinder -/s6-tcpserver4d -/s6-tcpserver6 -/s6-tcpserver6-socketbinder -/s6-tcpserver6d /s6-tlsc /s6-tlsclient /s6-tlsd @@ -4,8 +4,19 @@ In 2.6.0.0 ---------- - Bugfixes. - - Major performance improvements. - - Removed extra warning on s6-tcpserver-access with no ruleset. + - s6-tcpserver has been unified! no ipv4 and ipv6 separation anymore. + * the only programs in the superserver chain are now s6-tcpserver, +s6-tcpserver-socketbinder, and s6-tcpserverd. + * s6-tcpserver-access still exists, should now run under s6-tcpserverd, +still invoked once per connection. Doesn't spam the log anymore when +invoked with no ruleset. + * Options -4 and -6 removed from s6-tcpserver and s6-tlsserver. +Protocol detection happens when the cmdline address is scanned. + * Option -e removed from s6-tlsserver. It should now always invoke +s6-tcpserver-access when needed (and only then). + - Major performance improvements. s6-tcpserverd does not fork on +systems that support posix_spawn. Also, its lookups are now logarithmic +instead of linear (which only matters on *heavy* loads). In 2.5.1.3 diff --git a/doc/s6-tlsclient.html b/doc/s6-tlsclient.html index fc357a7..287c02c 100644 --- a/doc/s6-tlsclient.html +++ b/doc/s6-tlsclient.html @@ -118,7 +118,7 @@ variables will not appear in <em>prog</em>'s environment. <h2> Options </h2> <p> - <tt>s6-tlsclient</tt> accepts a myriad of options, most of which are + <tt>s6-tlsclient</tt> accepts a myriad of options, all of which are passed as is to the correct executable. Not giving any options will generally work: the defaults are sensible. </p> @@ -126,25 +126,27 @@ generally work: the defaults are sensible. <h3> Options passed as is to s6-tcpclient </h3> <ul> - <li> <tt>-q</tt>, <tt>-Q</tt>, <tt>-v</tt> </li> - <li> <tt>-4</tt>, <tt>-6</tt> </li> - <li> <tt>-d</tt>, <tt>-D</tt> </li> - <li> <tt>-r</tt>, <tt>-R</tt> </li> - <li> <tt>-h</tt>, <tt>-H</tt>, <tt>-l <em>localname</em></tt> </li> - <li> <tt>-n</tt>, <tt>-N</tt> </li> - <li> <tt>-t <em>timeout</em></tt> </li> - <li> <tt>-i <em>localip</em></tt>, <tt>-p <em>localport</em></tt> </li> - <li> <tt>-T <em>timeoutconn</em></tt> </li> + <li> <tt>-q</tt>, <tt>-Q</tt>, <tt>-v</tt> : be quiet, normally verbose, or verbose </li> + <li> <tt>-4</tt>, <tt>-6</tt> : stick to IPv4 or IPv6 addresses </li> + <li> <tt>-d</tt>, <tt>-D</tt> : enable or disable Nagle's algorithm </li> + <li> <tt>-r</tt>, <tt>-R</tt> : enable or disable IDENT lookup </li> + <li> <tt>-h</tt>, <tt>-H</tt> : enable or disable DNS lookups </li> + <li> <tt>-l <em>localname</em></tt> : get the local name from the command line, not from a DNS lookup </li> + <li> <tt>-n</tt>, <tt>-N</tt> : qualify the host or not when resolving it </li> + <li> <tt>-t <em>timeout</em></tt> : global timeout on the connection attempt </li> + <li> <tt>-i <em>localip</em></tt>, <tt>-p <em>localport</em></tt> : force local socket parameters </li> + <li> <tt>-T <em>timeoutconn</em></tt> : configurable connection timeouts </li> </ul> <h3> Options passed as is to s6-tlsc </h3> <ul> - <li> <tt>-Z</tt>, <tt>-z</tt> </li> - <li> <tt>-S</tt>, <tt>-s</tt> </li> - <li> <tt>-Y</tt>, <tt>-y</tt> </li> - <li> <tt>-k <em>servername</em></tt> </li> - <li> <tt>-K <em>kimeout</em></tt> </li> + <li> <tt>-Z</tt>, <tt>-z</tt> : keep or remove the <a href="s6-tlsc-io.html">s6-tlsc-io</a>-specific +variables from the application's environment </li> + <li> <tt>-S</tt>, <tt>-s</tt> : use close_notify or EOF to signal the end of a TLS connection </li> + <li> <tt>-Y</tt>, <tt>-y</tt> : don't send, or send, a client certificate </li> + <li> <tt>-k <em>servername</em></tt> : use SNI and provide a server name </li> + <li> <tt>-K <em>kimeout</em></tt> : set a timeout for the TLS handshake </li> </ul> <h2> Example </h2> diff --git a/doc/s6-tlsserver.html b/doc/s6-tlsserver.html index b338326..d1ca3e2 100644 --- a/doc/s6-tlsserver.html +++ b/doc/s6-tlsserver.html @@ -41,8 +41,7 @@ listens to TCP connections on IP address <em>ip</em> port <em>port</em> and forks a command line for every connection. Note that <a href="s6-tcpserver.html">s6-tcpserver</a> also rewrites itself into a more complex command line (the final long-lived -process being <a href="s6-tcpserver4d.html">s6-tcpserver4d</a> -or <a href="s6-tcpserver4d.html">s6-tcpserver6d</a>), +process being <a href="s6-tcpserverd.html">s6-tcpserverd</a>), so your end command line may look a lot longer in <tt>ps</tt> than what you originally wrote. This is normal and healthy. </li> <li> (if applicable) <a href="s6-tcpserver-access.html">s6-tcpserver-access</a>, @@ -73,9 +72,8 @@ be a network socket - they will be pipes. <p> <tt>s6-tlsserver</tt> reacts to the same signals as -<a href="s6-tcpserver4d.html">s6-tcpserver4d</a> or -<a href="s6-tcpserver6d.html">s6-tcpserver6d</a>, -one of which is the long-lived process hanging around. +<a href="s6-tcpserverd.html">s6-tcpserverd</a>, +which is the long-lived process hanging around. </p> <h2> Environment variables </h2> @@ -104,9 +102,8 @@ every <a href="s6-tlsd.html">s6-tlsd</a> invocation: <p> <em>prog...</em> is run with the following variables added to, -or removed from, its environment by <a href="s6-tcpserver4d.html">s6-tcpserver4d</a> -or <a href="s6-tcpserver6d.html">s6-tcpserver6d</a>, and possibly -by <a href="s6-tcpserver-access.html">s6-tcpserver-access</a>: +or removed from, its environment by <a href="s6-tcpserverd.html">s6-tcpserverd</a> +and possibly by <a href="s6-tcpserver-access.html">s6-tcpserver-access</a>: </p> <ul> @@ -142,28 +139,17 @@ variables will not appear in <em>prog</em>'s environment. <h2> Options </h2> <p> - <tt>s6-tlsserver</tt> accepts a myriad of options, most of which are + <tt>s6-tlsserver</tt> accepts a myriad of options, all of which are passed as is to the correct executable. Not giving any options will generally work, but unless you're running a very public server (such as a Web server) or base your access control on client certificates, you probably still want TCP access rules. </p> -<h3> Options handled directly by s6-tlsserver </h3> - -<ul> - <li> <tt>-e</tt>: : indicates that -<a href="s6-tcpserver-access.html">s6-tcpserver-access</a> should -be invoked, even if no other option requires it, even in the absence -of an access control ruleset. This ensures that <em>prog...</em> -will always have access to environment variables such as TCPLOCALPORT. </li> -</ul> - <h3> Options passed as is to s6-tcpserver </h3> <ul> <li> <tt>-q</tt>, <tt>-Q</tt>, <tt>-v</tt> </li> - <li> <tt>-4</tt>, <tt>-6</tt> </li> <li> <tt>-1</tt> </li> <li> <tt>-c <em>maxconn</em></tt> </li> <li> <tt>-C <em>localmaxconn</em></tt> </li> @@ -174,31 +160,34 @@ will always have access to environment variables such as TCPLOCALPORT. </li> <ul> <li> The verbosity level, if not default, as <tt>-v0</tt> or <tt>-v2</tt> </li> - <li> <tt>-w</tt>, <tt>-W</tt> </li> - <li> <tt>-d</tt>, <tt>-D</tt> </li> - <li> <tt>-r</tt>, <tt>-R</tt> </li> - <li> <tt>-p</tt>, <tt>-P</tt> </li> - <li> <tt>-h</tt>, <tt>-H</tt>, <tt>-l <em>localname</em></tt> </li> - <li> <tt>-B <em>banner</em></tt> </li> - <li> <tt>-t <em>timeout</em></tt> </li> - <li> <tt>-i <em>rulesdir</em></tt>, <tt>-x <em>rulesfile</em></tt> </li> + <li> <tt>-w</tt>, <tt>-W</tt> : be strict or tolerant with DNS or IDENT resolution errors </li> + <li> <tt>-d</tt>, <tt>-D</tt> : enable or disable Nagle's algorithm </li> + <li> <tt>-r</tt>, <tt>-R</tt> : enable or disable IDENT lookups </li> + <li> <tt>-p</tt>, <tt>-P</tt> : enable or disable paranoid DNS cross-checking </li> + <li> <tt>-h</tt>, <tt>-H</tt> : enable or disable DNS lookups </li> + <li> <tt>-l <em>localname</em></tt> : get the local name from the command line, not from DNS </li> + <li> <tt>-B <em>banner</em></tt> : initial server-side banner </li> + <li> <tt>-t <em>timeout</em></tt> : set a timeout for all the lookups </li> + <li> <tt>-i <em>rulesdir</em></tt>, <tt>-x <em>rulesfile</em></tt> : TCP access control </li> </ul> <h3> Options passed as is to s6-tlsd </h3> <ul> - <li> <tt>-Z</tt>, <tt>-z</tt> </li> - <li> <tt>-S</tt>, <tt>-s</tt> </li> - <li> <tt>-Y</tt>, <tt>-y</tt> </li> - <li> <tt>-K <em>kimeout</em></tt> </li> - <li> <tt>-k <em>snilevel</em></tt> </li> + <li> <tt>-Z</tt>, <tt>-z</tt> : keep or remove the <a href="s6-tlsd-io.html">s6-tlsd-io</a>-specific +variables from the application's environment </li> + <li> <tt>-S</tt>, <tt>-s</tt> : use close_notify or EOF to signal the end of a TLS connection </li> + <li> <tt>-Y</tt>, <tt>-y</tt> : request an optional or a mandatory client certificate </li> + <li> <tt>-K <em>kimeout</em></tt> : set a timeout for the TLS handshake </li> + <li> <tt>-k <em>snilevel</em></tt> : support SNI-based certificate chains </li> </ul> <h3> Options passed to s6-applyuidgid </h3> <ul> - <li> <tt>-u <em>uid</em></tt>, <tt>-g <em>gid</em></tt>, <tt>-G <em>gidlist</em></tt> </li> - <li> <tt>-U</tt> (passed as <tt>-Uz</tt>) </li> + <li> <tt>-u <em>uid</em></tt>, <tt>-g <em>gid</em></tt>, <tt>-G <em>gidlist</em></tt> : set uid, gid, or supplementary group list </li> + <li> <tt>-U</tt> (passed as <tt>-Uz</tt>) : get the uid, gid and supplementary group list from the UID, GID and GIDLIST variables, +and remove these variables from the application's environment </li> </ul> <h2> Example </h2> diff --git a/doc/upgrade.html b/doc/upgrade.html index 0f20319..1ef9c25 100644 --- a/doc/upgrade.html +++ b/doc/upgrade.html @@ -53,6 +53,8 @@ the same interface except that the <tt>-4</tt> and <tt>-6</tt> options have been removed, and that is still a wrapper around the others. </li> </ul> </li> + <li> <tt>-e</tt>, <tt>-4</tt> and <tt>-6</tt> options removed from +<a href="s6-tlsserver.html">s6-tlsserver</a> </li> </ul> <h2> in 2.5.1.3 </h2> diff --git a/src/tls/s6-tlsserver.c b/src/tls/s6-tlsserver.c index deffe0d..be96f39 100644 --- a/src/tls/s6-tlsserver.c +++ b/src/tls/s6-tlsserver.c @@ -12,8 +12,8 @@ #include <s6-networking/config.h> -#define USAGE "s6-tlsserver [ -e ] [ options ] ip port prog...\n" \ -"s6-tcpserver options: [ -q | -Q | -v ] [ -4 | -6 ] [ -1 ] [ -c maxconn ] [ -C localmaxconn ] [ -b backlog ] [ -G gidlist ] [ -g gid ] [ -u uid ] [ -U ]\n" \ +#define USAGE "s6-tlsserver [ options ] ip port prog...\n" \ +"s6-tcpserver options: [ -q | -Q | -v ] [ -1 ] [ -c maxconn ] [ -C localmaxconn ] [ -b backlog ] [ -G gidlist ] [ -g gid ] [ -u uid ] [ -U ]\n" \ "s6-tcpserver-access options: [ -W | -w ] [ -D | -d ] [ -H | -h ] [ -R | -r ] [ -P | -p ] [ -l localname ] [ -B banner ] [ -t timeout ] [ -i rulesdir | -x rulesfile ]\n" \ "s6-tlsd options: [ -S | -s ] [ -Y | -y ] [ -K timeout ] [ -Z | -z ] [ -k snilevel ]" @@ -36,7 +36,6 @@ struct options_s unsigned int kimeout ; unsigned int snilevel ; unsigned int verbosity : 2 ; - unsigned int flag46 : 2 ; unsigned int flag1 : 1 ; unsigned int flagU : 1 ; unsigned int flagw : 1 ; @@ -49,8 +48,6 @@ struct options_s unsigned int flagy : 1 ; unsigned int flagY : 1 ; unsigned int flagZ : 1 ; - unsigned int forceaccess : 1 ; - unsigned int doaccess : 1 ; unsigned int doapply : 1 ; } ; @@ -69,7 +66,6 @@ struct options_s .kimeout = 0, \ .verbosity = 1, \ .snilevel = 0, \ - .flag46 = 0, \ .flag1 = 0, \ .flagU = 0, \ .flagw = 0, \ @@ -82,8 +78,6 @@ struct options_s .flagy = 0, \ .flagY = 0, \ .flagZ = 0, \ - .forceaccess = 0, \ - .doaccess = 1, \ .doapply = 0 \ } @@ -95,15 +89,13 @@ int main (int argc, char const *const *argv) subgetopt l = SUBGETOPT_ZERO ; for (;;) { - int opt = subgetopt_r(argc, argv, "qQv461c:C:b:G:g:u:UWwDdHhRrPpl:eB:t:i:x:SsYyK:Zzk:", &l) ; + int opt = subgetopt_r(argc, argv, "qQv1c:C:b:G:g:u:UWwDdHhRrPpl:B:t:i:x:SsYyK:Zzk:", &l) ; if (opt == -1) break ; switch (opt) { case 'q' : o.verbosity = 0 ; break ; case 'Q' : o.verbosity = 1 ; break ; case 'v' : o.verbosity = 2 ; break ; - case '4' : o.flag46 = 1 ; break ; - case '6' : o.flag46 = 2 ; break ; case '1' : o.flag1 = 1 ; break ; case 'c' : if (!uint0_scan(l.arg, &o.maxconn)) dieusage() ; if (!o.maxconn) o.maxconn = 1 ; break ; case 'C' : if (!uint0_scan(l.arg, &o.localmaxconn)) dieusage() ; if (!o.localmaxconn) o.localmaxconn = 1 ; break ; @@ -123,7 +115,6 @@ int main (int argc, char const *const *argv) case 'P' : o.flagp = 0 ; break ; case 'p' : o.flagp = 1 ; break ; case 'l' : o.localname = l.arg ; break ; - case 'e' : o.forceaccess = 1 ; break ; case 'B' : o.banner = l.arg ; break ; case 't' : if (!uint0_scan(l.arg, &o.timeout)) dieusage() ; break ; case 'i' : o.rules = l.arg ; o.rulesx = 0 ; break ; @@ -143,13 +134,12 @@ int main (int argc, char const *const *argv) if (argc < 3) dieusage() ; } - o.doaccess = o.forceaccess || o.flagw || o.flagD || !o.flagH || o.flagr || o.flagp || o.localname || o.banner || o.timeout || o.rules ; - { size_t pos = 0 ; unsigned int m = 0 ; char fmt[UINT_FMT * 6 + UID_FMT + GID_FMT * (NGROUPS_MAX + 1)] ; - char const *newargv[50 + argc] ; + char const *newargv[49 + argc] ; + int doaccess = o.flagw || o.flagD || !o.flagH || o.flagr || o.flagp || o.localname || o.banner || o.timeout || o.rules ; newargv[m++] = S6_NETWORKING_BINPREFIX "s6-tcpserver" ; if (o.verbosity != 1) { @@ -157,7 +147,6 @@ int main (int argc, char const *const *argv) pos = uint_fmt(fmt, o.verbosity) ; fmt[pos++] = 0 ; } - if (o.flag46) newargv[m++] = o.flag46 == 1 ? "-4" : "-6" ; if (o.flag1) newargv[m++] = "-1" ; if (o.maxconn) { @@ -183,7 +172,7 @@ int main (int argc, char const *const *argv) newargv[m++] = "--" ; newargv[m++] = *argv++ ; newargv[m++] = *argv++ ; - if (o.doaccess) + if (doaccess) { newargv[m++] = S6_NETWORKING_BINPREFIX "s6-tcpserver-access" ; if (o.verbosity != 1) |