[Openvpn-devel,1/2] Correct tls-crypt-v2 metadata length in man page

Message ID 20221126162648.150678-1-maximilian.fillinger@foxcrypto.com
State Accepted
Headers show
Series [Openvpn-devel,1/2] Correct tls-crypt-v2 metadata length in man page | expand

Commit Message

Maximilian Fillinger Nov. 26, 2022, 4:26 p.m. UTC
The manual page claims that the client metadata can be up to 735 bytes
(encoded as upt to 980 characters base64), but the actual maximum length
is 733 bytes which is also encoded as 980 characters in base64.

Signed-off-by: Max Fillinger <maximilian.fillinger@foxcrypto.com>
---
 doc/man-sections/encryption-options.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Comments

Arne Schwabe Dec. 12, 2022, 11:54 a.m. UTC | #1
Am 26.11.22 um 17:26 schrieb Max Fillinger:
> The manual page claims that the client metadata can be up to 735 bytes
> (encoded as upt to 980 characters base64), but the actual maximum length
> is 733 bytes which is also encoded as 980 characters in base64.
> 
> Signed-off-by: Max Fillinger <maximilian.fillinger@foxcrypto.com>

Acked-By: Arne Schwabe <arne@rfc2549.org>
Gert Doering Dec. 12, 2022, 12:05 p.m. UTC | #2
Your patch has been applied to the master and release/2.6 branch.

commit 0bd2fa38fb70ad9022c05ffa67b2bd8751ca5a5b (master)
commit acc7ecc2721adf3628b1bf8eca4365663259844c (release/2.6)
Author: Max Fillinger
Date:   Sat Nov 26 17:26:47 2022 +0100

     Correct tls-crypt-v2 metadata length in man page

     Signed-off-by: Max Fillinger <maximilian.fillinger@foxcrypto.com>
     Acked-by: Arne Schwabe <arne@rfc2549.org>
     Message-Id: <20221126162648.150678-1-maximilian.fillinger@foxcrypto.com>
     URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg25546.html
     Signed-off-by: Gert Doering <gert@greenie.muc.de>


--
kind regards,

Gert Doering

Patch

diff --git a/doc/man-sections/encryption-options.rst b/doc/man-sections/encryption-options.rst
index ee34f14e..abc73d90 100644
--- a/doc/man-sections/encryption-options.rst
+++ b/doc/man-sections/encryption-options.rst
@@ -104,7 +104,8 @@  Generating key material
 
     If supplied, include the supplied ``metadata`` in the wrapped client
     key. This metadata must be supplied in base64-encoded form. The
-    metadata must be at most 735 bytes long (980 bytes in base64).
+    metadata must be at most 733 bytes long (980 characters in base64, though
+    note that 980 base64 characters can encode more than 733 bytes).
 
     If no metadata is supplied, OpenVPN will use a 64-bit unix timestamp
     representing the current time in UTC, encoded in network order, as