[Openvpn-devel] Fix client-pending-auth help message in management interface

Message ID 20210814044834.2236-1-selva.nair@gmail.com
State Accepted
Headers show
Series
  • [Openvpn-devel] Fix client-pending-auth help message in management interface
Related show

Commit Message

Selva Nair Aug. 14, 2021, 4:48 a.m.
From: Selva Nair <selva.nair@gmail.com>

- Add the missing timeout value that is required (not optional)
- Split the long line
- Also make the AUTH_PENDING state message format in
  management-notes.txt more precise.

Signed-off-by: Selva Nair <selva.nair@gmail.com>
---
 doc/management-notes.txt | 2 +-
 src/openvpn/manage.c     | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

Comments

Arne Schwabe Aug. 14, 2021, 11:30 a.m. | #1
Am 14.08.21 um 06:48 schrieb selva.nair@gmail.com:
> From: Selva Nair <selva.nair@gmail.com>
> 
> - Add the missing timeout value that is required (not optional)
> - Split the long line
> - Also make the AUTH_PENDING state message format in
>   management-notes.txt more precise.
> 
> Signed-off-by: Selva Nair <selva.nair@gmail.com>
> ---
>  doc/management-notes.txt | 2 +-
>  src/openvpn/manage.c     | 4 ++--
>  2 files changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/doc/management-notes.txt b/doc/management-notes.txt
> index c2034429..5b920fa5 100644
> --- a/doc/management-notes.txt
> +++ b/doc/management-notes.txt
> @@ -658,7 +658,7 @@ implementations the name IV_SSO is kept in lieu of a better name.
>  The management interface of the client receives notification of
>  pending auth via
>  
> ->STATE:datetime,AUTH_PENDING,[timeout number]
> +>STATE:datetime,AUTH_PENDING,[timeout number],,,,,
>  
>  If {EXTRA} is present the client is informed using INFOMSG
>  notification as
> diff --git a/src/openvpn/manage.c b/src/openvpn/manage.c
> index 86584c4b..f86c87f2 100644
> --- a/src/openvpn/manage.c
> +++ b/src/openvpn/manage.c
> @@ -104,8 +104,8 @@ man_help(void)
>      msg(M_CLIENT, "client-auth-nt CID KID : Authenticate client-id/key-id CID/KID");
>      msg(M_CLIENT, "client-deny CID KID R [CR] : Deny auth client-id/key-id CID/KID with log reason");
>      msg(M_CLIENT, "                             text R and optional client reason text CR");
> -    msg(M_CLIENT, "client-pending-auth CID MSG : Instruct OpenVPN to send AUTH_PENDING and INFO_PRE msg"
> -        "                          to the client and wait for a final client-auth/client-deny");
> +    msg(M_CLIENT, "client-pending-auth CID MSG timeout : Instruct OpenVPN to send AUTH_PENDING and INFO_PRE msg");
> +    msg(M_CLIENT, "                                      to the client and wait for a final client-auth/client-deny");
>      msg(M_CLIENT, "client-kill CID [M]    : Kill client instance CID with message M (def=RESTART)");
>      msg(M_CLIENT, "env-filter [level]     : Set env-var filter level");
>  #ifdef MANAGEMENT_PF
> 

Acked-By: Arne Schwabe <arne@rfc2549.org>
Gert Doering Aug. 14, 2021, 3:56 p.m. | #2
Thanks.

Your patch has been applied to the master branch.

commit 8b3ea9ea573adbf58b645943bd2d5bb20bc1b1a3
Author: Selva Nair
Date:   Sat Aug 14 00:48:34 2021 -0400

     Fix client-pending-auth help message in management interface

     Signed-off-by: Selva Nair <selva.nair@gmail.com>
     Message-Id: <20210814044834.2236-1-selva.nair@gmail.com>
     URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg22739.html
     Signed-off-by: Gert Doering <gert@greenie.muc.de>


--
kind regards,

Gert Doering

Patch

diff --git a/doc/management-notes.txt b/doc/management-notes.txt
index c2034429..5b920fa5 100644
--- a/doc/management-notes.txt
+++ b/doc/management-notes.txt
@@ -658,7 +658,7 @@  implementations the name IV_SSO is kept in lieu of a better name.
 The management interface of the client receives notification of
 pending auth via
 
->STATE:datetime,AUTH_PENDING,[timeout number]
+>STATE:datetime,AUTH_PENDING,[timeout number],,,,,
 
 If {EXTRA} is present the client is informed using INFOMSG
 notification as
diff --git a/src/openvpn/manage.c b/src/openvpn/manage.c
index 86584c4b..f86c87f2 100644
--- a/src/openvpn/manage.c
+++ b/src/openvpn/manage.c
@@ -104,8 +104,8 @@  man_help(void)
     msg(M_CLIENT, "client-auth-nt CID KID : Authenticate client-id/key-id CID/KID");
     msg(M_CLIENT, "client-deny CID KID R [CR] : Deny auth client-id/key-id CID/KID with log reason");
     msg(M_CLIENT, "                             text R and optional client reason text CR");
-    msg(M_CLIENT, "client-pending-auth CID MSG : Instruct OpenVPN to send AUTH_PENDING and INFO_PRE msg"
-        "                          to the client and wait for a final client-auth/client-deny");
+    msg(M_CLIENT, "client-pending-auth CID MSG timeout : Instruct OpenVPN to send AUTH_PENDING and INFO_PRE msg");
+    msg(M_CLIENT, "                                      to the client and wait for a final client-auth/client-deny");
     msg(M_CLIENT, "client-kill CID [M]    : Kill client instance CID with message M (def=RESTART)");
     msg(M_CLIENT, "env-filter [level]     : Set env-var filter level");
 #ifdef MANAGEMENT_PF