[Openvpn-devel] Make received OCC exit messages more visible in log.

Message ID 20230814060409.50742-1-gert@greenie.muc.de
State Accepted
Headers show
Series [Openvpn-devel] Make received OCC exit messages more visible in log. | expand

Commit Message

Gert Doering Aug. 14, 2023, 6:04 a.m. UTC
Currently, OCC exit messages are only logged at some high debug level
(and if OpenVPN compiled with DEBUG), while control-channel EEN messages
are logged on verb 1.  Make this consistent, both in wording and in
log level.

Both messages are prefixed with the "channel" where the exit message
came in.

Signed-off-by: Gert Doering <gert@greenie.muc.de>
---
 src/openvpn/occ.c  | 2 +-
 src/openvpn/push.c | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

Comments

Frank Lichtenheld Aug. 14, 2023, 9:02 a.m. UTC | #1
On Mon, Aug 14, 2023 at 08:04:09AM +0200, Gert Doering wrote:
> Currently, OCC exit messages are only logged at some high debug level
> (and if OpenVPN compiled with DEBUG), while control-channel EEN messages
> are logged on verb 1.  Make this consistent, both in wording and in
> log level.
> 
> Both messages are prefixed with the "channel" where the exit message
> came in.

Makes sense to me.

Acked-by: Frank Lichtenheld <frank@lichtenheld.com>
Gert Doering Aug. 14, 2023, 9:31 a.m. UTC | #2
Tested, of course :-) - with a 2.5 client, I now have

2023-08-14 11:26:27 client25 OCC exit message received by peer
2023-08-14 11:26:27 client25 SIGUSR1[soft,remote-exit] received, client-instance restarting

in my server logs.

With a 2.6 client, this becomes:

2023-08-14 11:29:01 client26 CC-EEN exit message received by peer
2023-08-14 11:29:01 client26 Delayed exit in 5 seconds
2023-08-14 11:29:06 client26 SIGTERM[soft,delayed-exit] received, client-instance exiting

(interesting that one does SIGUSR1 and the other does SIGTERM - but for
the multi server side it ends up in the same code path "clean up client
instance, done")

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

commit 5f910a42b86e90f1893a668ee280422b6587ada1 (master)
commit 6e68d8c5d5304d56de588f4584e2dc6266d2f129 (HEAD -> release/2.6)
Author: Gert Doering
Date:   Mon Aug 14 08:04:09 2023 +0200

     Make received OCC exit messages more visible in log.

     Signed-off-by: Gert Doering <gert@greenie.muc.de>
     Acked-by: Frank Lichtenheld <frank@lichtenheld.com>
     Message-Id: <20230814060409.50742-1-gert@greenie.muc.de>
     URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg26949.html
     Signed-off-by: Gert Doering <gert@greenie.muc.de>


--
kind regards,

Gert Doering

Patch

diff --git a/src/openvpn/occ.c b/src/openvpn/occ.c
index 8541f6ec..2871449e 100644
--- a/src/openvpn/occ.c
+++ b/src/openvpn/occ.c
@@ -427,7 +427,7 @@  process_received_occ_msg(struct context *c)
             break;
 
         case OCC_EXIT:
-            dmsg(D_PACKET_CONTENT, "RECEIVED OCC_EXIT");
+            dmsg(D_STREAM_ERRORS, "OCC exit message received by peer");
             register_signal(c->sig, SIGUSR1, "remote-exit");
             break;
     }
diff --git a/src/openvpn/push.c b/src/openvpn/push.c
index 01e7cd6e..5f5755ab 100644
--- a/src/openvpn/push.c
+++ b/src/openvpn/push.c
@@ -190,7 +190,7 @@  server_pushed_signal(struct context *c, const struct buffer *buffer, const bool
 void
 receive_exit_message(struct context *c)
 {
-    dmsg(D_STREAM_ERRORS, "Exit message received by peer");
+    dmsg(D_STREAM_ERRORS, "CC-EEN exit message received by peer");
     /* With control channel exit notification, we want to give the session
      * enough time to handle retransmits and acknowledgment, so that eventual
      * retries from the client to resend the exit or ACKs will not trigger