Skip to contentSkip to conversation

tls-crypt-v2: clarify --tls-crypt-v2-genkey man page section

PATCH In review Steffan Karger 3 participants 3 messages Oct 31, 2018 – Nov 18, 2018

lore
Share & tools
lore

Steffan Karger

author
#0 lore raw

PATCH 1/1 tls-crypt-v2: clarify --tls-crypt-v2-genkey man page section

As kitsune1 mentioned in IRC, this section should explain that "--tls-crypt-v2-genkey client" requires the user to supply the server key using "--tls-crypt-v2".

Signed-off-by Steffan Karger <[email protected]...>
---
 doc/openvpn.8 | 5 +++++
 1 file changed, 5 insertions(+)
doc/openvpn.8 +5 -0
index 94b5cc4..f38fba9 100644
@@ -5314,6 +5314,11 @@ If no metadata is supplied, OpenVPN will use a 64\-bit unix timestamp
 representing the current time in UTC, encoded in network order, as metadata for
 the generated key.
 
+A tls\-crypt\-v2 client key is wrapped using a server key.  To generate a
+client key, the user must therefore supply the server key using the
+.B \-\-tls\-crypt\-v2
+option.
+
 Servers can use
 .B \-\-tls\-crypt\-v2\-verify
 to specify a metadata verification command.
Signature · 1 line
2.7.4
Acked-by on v1 1/1
#1 lore raw

Hi,

Quoted 5 lines · Steffan Karger

As kitsune1 mentioned in IRC, this section should explain that "--tls-crypt-v2-genkey client" requires the user to supply the server key using "--tls-crypt-v2".

Signed-off-by Steffan Karger <[email protected]...>

Makes sense and, after listening to some people getting confused, it is good to clarify the procedure.

Acked-by Antonio Quartulli <[email protected]...>
Quoted 21 lines
---
 doc/openvpn.8 | 5 +++++
 1 file changed, 5 insertions(+)
doc/openvpn.8 +5 -0
index 94b5cc4..f38fba9 100644
@@ -5314,6 +5314,11 @@ If no metadata is supplied, OpenVPN will use a 64\-bit unix timestamp
 representing the current time in UTC, encoded in network order, as metadata for
 the generated key.
 
+A tls\-crypt\-v2 client key is wrapped using a server key.  To generate a
+client key, the user must therefore supply the server key using the
+.B \-\-tls\-crypt\-v2
+option.
+
 Servers can use
 .B \-\-tls\-crypt\-v2\-verify
 to specify a metadata verification command.
Signature · 1 line
Antonio Quartulli
#2 lore raw
In reply to Steffan Karger

Documentation is always welcome :-)

Your patch has been applied to the master branch.

commit 01039891ece9f38f7a17c80e5afc261ab5bcbaf3

Author: Steffan Karger
Date:   Wed Oct 31 11:22:57 2018 +0100
     tls-crypt-v2: clarify --tls-crypt-v2-genkey man page section

     Signed-off-by: Steffan Karger <[email protected]...>
     Acked-by: Antonio Quartulli <[email protected]...>
     Message-Id: <[email protected]...>
     URL: https://www.mail-archive.com/[email protected]/msg17865.html
     Signed-off-by: Gert Doering <[email protected]...>

--
kind regards,

Gert Doering