summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2023-11-10 11:28:19 +0000
committerLaurent Bercot <ska@appnovation.com>2023-11-10 11:28:19 +0000
commit1e10d30b41b65dbd520e01adc5fe686cb92b0f12 (patch)
tree32af8327cb6bb9aa6bbd5e20ee7a2cc1f9c95263 /doc
parentc930181234bfb31fba0136d866e6e75633acafe0 (diff)
downloads6-networking-1e10d30b41b65dbd520e01adc5fe686cb92b0f12.tar.xz
Prepare for 2.7.0.0. Better s6-tlsc-io interface.
Signed-off-by: Laurent Bercot <ska@appnovation.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/index.html2
-rw-r--r--doc/s6-tlsc-io.html12
-rw-r--r--doc/upgrade.html12
3 files changed, 19 insertions, 7 deletions
diff --git a/doc/index.html b/doc/index.html
index 8cd5f2e..95294f2 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -91,7 +91,7 @@ run-time requirement if you link against its shared version. </li>
<ul>
<li> The current released version of s6-networking is
-<a href="s6-networking-2.6.0.0.tar.gz">2.6.0.0</a>. </li>
+<a href="s6-networking-2.7.0.0.tar.gz">2.7.0.0</a>. </li>
<li> Alternatively, you can checkout a copy of the
<a href="//git.skarnet.org/cgi-bin/cgit.cgi/s6-networking/">s6-networking
git repository</a>:
diff --git a/doc/s6-tlsc-io.html b/doc/s6-tlsc-io.html
index 4466293..b4bb154 100644
--- a/doc/s6-tlsc-io.html
+++ b/doc/s6-tlsc-io.html
@@ -42,14 +42,14 @@ the options given when configuring s6-networking.
</pre>
<ul>
- <li> s6-tlsc-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 <em>fdr</em> and write cleartext
-data to file descriptor <em>fdw</em>. </li>
+ <li> s6-tlsc-io expects to read cleartext data to stdin, and write
+cleartext data to stdout. It also expects descriptors <em>fdr</em> and
+<em>fdw</em> to be open (typically connected to the network), to
+respectively read ciphertext from and write ciphertext to. </li>
<li> It initiates a TLS handshake over the network connection,
expecting a TLS server on the other side. </li>
- <li> Then it acts as a full duplex tunnel, decrypting and transmitting
-data from stdin to <em>fdw</em>, and encrypting and transmitting data
+ <li> Then it acts as a full duplex tunnel, encrypting and transmitting
+data from stdin to <em>fdw</em>, and decrypting and transmitting data
from <em>fdr</em> to stdout. </li>
<li> When it cannot transmit any more data from/to the local application
because connections have closed, <tt>s6-tlsc-io</tt> exits. </li>
diff --git a/doc/upgrade.html b/doc/upgrade.html
index 1ef9c25..292030e 100644
--- a/doc/upgrade.html
+++ b/doc/upgrade.html
@@ -18,6 +18,18 @@
<h1> What has changed in s6-networking </h1>
+<h2> in 2.7.0.0 </h2>
+
+<ul>
+ <li> <a href="s6-tlsc-io.html">s6-tlsc-io</a> has changed
+interfaces: now it uses stdin/stdout as the <em>local</em>
+side, and the descriptors given as arguments as the <em>remote</em>
+side. This allows users to invoke it directly when it is relevant. </li>
+ <li> Consequently, <a href="s6-tlsc.html">s6-tlsc</a> and
+<a href="s6-ucpistlsc.html">s6-ucspitlsc</a> have changed how they invoke
+<a href="s6-tlsc-io.html">s6-tlsc-io</a>. </li>
+</ul>
+
<h2> in 2.6.0.0 </h2>
<ul>