[Openvpn-devel,v2] Clarify that the tls-crypt-v2-verify has a very limited env set

Message ID 20240105142432.26298-1-gert@greenie.muc.de
State Accepted
Headers show
Series [Openvpn-devel,v2] Clarify that the tls-crypt-v2-verify has a very limited env set | expand

Commit Message

Gert Doering Jan. 5, 2024, 2:24 p.m. UTC
From: Arne Schwabe <arne@rfc2549.org>

Change-Id: Ida4d22455c51773b6713caf94a4b4fbe136a6ded
Signed-off-by: Arne Schwabe <arne@rfc2549.org>
Acked-by: Gert Doering <gert@greenie.muc.de>
---

This change was reviewed on Gerrit and approved by at least one
developer. I request to merge it to master.

Gerrit URL: https://gerrit.openvpn.net/c/openvpn/+/488
This mail reflects revision 2 of this Change.
Acked-by according to Gerrit (reflected above):
Gert Doering <gert@greenie.muc.de>

Comments

Gert Doering Jan. 5, 2024, 2:52 p.m. UTC | #1
More clear documentation helps avoid user frustration...

Your patch has been applied to the master and release/2.6 branch.

commit a9fe012ca64d81af37a08666d3e4e74250113db2 (master)
commit 322b11ab47763e0d062576cdc907351c700ef371 (release/2.6)
Author: Arne Schwabe
Date:   Fri Jan 5 15:24:32 2024 +0100

     Clarify that the tls-crypt-v2-verify has a very limited env set

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


--
kind regards,

Gert Doering

Patch

diff --git a/doc/man-sections/tls-options.rst b/doc/man-sections/tls-options.rst
index 4c45b10..460cecf 100644
--- a/doc/man-sections/tls-options.rst
+++ b/doc/man-sections/tls-options.rst
@@ -538,7 +538,9 @@ 
   stack (including the notoriously dangerous X.509 and ASN.1 stacks) to
   the connecting client.
 
-  OpenVPN supplies the following environment variables to the command:
+  OpenVPN supplies the following environment variables to the command (and
+  only these variables. The normal environment variables available for
+  other scripts are NOT present):
 
   * :code:`script_type` is set to :code:`tls-crypt-v2-verify`