From: "reynir (Code Review)" Date: Wed, 24 Apr 2024 10:40:15 +0000 In-Reply-To: References: Reply-To: reynir@...2756..., arne-openvpn@...1227..., openvpn-devel@lists.sourceforge.net, frank@...2641... Message-ID: <977829409664bfc1e4ea8530361dc17a1eb0ec48-EmailReplacePatchSet-HTML@...2715...> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Disposition: inline Content-Type: multipart/alternative; boundary="iPCBDlW2Jbw="; charset=UTF-8 Subject: [Openvpn-devel] [S] Change in openvpn[master]: Only schedule_exit() once List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: plaisthos , flichtenheld Cc: openvpn-devel --iPCBDlW2Jbw= Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Attention is currently required from: plaisthos, reynir. Hello flichtenheld, plaisthos, I'd like you to reexamine a change. Please visit http://gerrit.openvpn.net/c/openvpn/+/555?usp=3Demail to look at the new patch set (#2). The following approvals got outdated and were removed: Code-Review-1 by reynir Change subject: Only schedule_exit() once ...................................................................... Only schedule_exit() once If an exit has already been scheduled we should not schedule it again. Otherwise, the exit signal is never emitted if the peer reschedules the exit before the timeout occurs. schedule_exit() now only takes the context as argument. The signal is hard coded to SIGTERM, and the interval is read directly from the context options. Furthermore, schedule_exit() now returns a bool signifying whether an exit was scheduled; false if exit is already scheduled. The call sites are updated accordingly. A notable difference is that management is only notified *once* when an exit is scheduled - we no longer notify management on redundant exit. Change-Id: I9457f005f4ba970502e6b667d9dc4299a588d661 Signed-off-by: Reynir Bj=C3=B6rnsson --- M src/openvpn/forward.c M src/openvpn/forward.h M src/openvpn/push.c 3 files changed, 16 insertions(+), 11 deletions(-) git pull ssh://gerrit.openvpn.net:29418/openvpn refs/changes/55/555/2 diff --git a/src/openvpn/forward.c b/src/openvpn/forward.c index 8d10f25..937fae4 100644 --- a/src/openvpn/forward.c +++ b/src/openvpn/forward.c @@ -514,17 +514,23 @@ } /* - * Schedule a signal n_seconds from now. + * Schedule a SIGTERM signal c->options.scheduled_exit_interval seconds fr= om now. */ -void -schedule_exit(struct context *c, const int n_seconds, const int signal) +bool +schedule_exit(struct context *c) { + const int n_seconds =3D c->options.scheduled_exit_interval; + /* don't reschedule if already scheduled. */ + if (event_timeout_defined(&c->c2.scheduled_exit)) { + return false; + } tls_set_single_session(c->c2.tls_multi); update_time(); reset_coarse_timers(c); event_timeout_init(&c->c2.scheduled_exit, n_seconds, now); - c->c2.scheduled_exit_signal =3D signal; + c->c2.scheduled_exit_signal =3D SIGTERM; msg(D_SCHED_EXIT, "Delayed exit in %d seconds", n_seconds); + return true; } /* diff --git a/src/openvpn/forward.h b/src/openvpn/forward.h index 6fb5a18..422c591 100644 --- a/src/openvpn/forward.h +++ b/src/openvpn/forward.h @@ -303,7 +303,7 @@ void process_ip_header(struct context *c, unsigned int flags, struct buffe= r *buf); -void schedule_exit(struct context *c, const int n_seconds, const int signa= l); +bool schedule_exit(struct context *c); static inline struct link_socket_info * get_link_socket_info(struct context *c) diff --git a/src/openvpn/push.c b/src/openvpn/push.c index 1b406b9..db1fd2e 100644 --- a/src/openvpn/push.c +++ b/src/openvpn/push.c @@ -191,6 +191,7 @@ receive_exit_message(struct context *c) { dmsg(D_STREAM_ERRORS, "CC-EEN exit message received by peer"); + bool notify_management =3D true; /* With control channel exit notification, we want to give the session * enough time to handle retransmits and acknowledgment, so that event= ual * retries from the client to resend the exit or ACKs will not trigger @@ -204,14 +205,14 @@ * */ if (c->options.mode =3D=3D MODE_SERVER) { - schedule_exit(c, c->options.scheduled_exit_interval, SIGTERM); + notify_management =3D schedule_exit(c); } else { register_signal(c->sig, SIGUSR1, "remote-exit"); } #ifdef ENABLE_MANAGEMENT - if (management) + if (management && notify_management) { management_notify(management, "info", "remote-exit", "EXIT"); } @@ -391,7 +392,7 @@ void send_auth_failed(struct context *c, const char *client_reason) { - if (event_timeout_defined(&c->c2.scheduled_exit)) + if (!schedule_exit(c)) { msg(D_TLS_DEBUG, "exit already scheduled for context"); return; @@ -401,8 +402,6 @@ static const char auth_failed[] =3D "AUTH_FAILED"; size_t len; - schedule_exit(c, c->options.scheduled_exit_interval, SIGTERM); - len =3D (client_reason ? strlen(client_reason)+1 : 0) + sizeof(auth_fa= iled); if (len > PUSH_BUNDLE_SIZE) { @@ -492,7 +491,7 @@ void send_restart(struct context *c, const char *kill_msg) { - schedule_exit(c, c->options.scheduled_exit_interval, SIGTERM); + schedule_exit(c); send_control_channel_string(c, kill_msg ? kill_msg : "RESTART", D_PUSH= ); } -- To view, visit http://gerrit.openvpn.net/c/openvpn/+/555?usp=3Demail To unsubscribe, or for help writing mail filters, visit http://gerrit.openv= pn.net/settings Gerrit-Project: openvpn Gerrit-Branch: master Gerrit-Change-Id: I9457f005f4ba970502e6b667d9dc4299a588d661 Gerrit-Change-Number: 555 Gerrit-PatchSet: 2 Gerrit-Owner: reynir Gerrit-Reviewer: flichtenheld Gerrit-Reviewer: plaisthos Gerrit-Reviewer: reynir Gerrit-CC: openvpn-devel Gerrit-Attention: plaisthos Gerrit-Attention: reynir Gerrit-MessageType: newpatchset --iPCBDlW2Jbw= Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable

Attention is currently required from: plaisthos, reynir.

reynir uploaded patch set #2 to this change.

View Change

The following approvals got outdated and were removed: Code-Review-1 by reynir

Only schedule_exit() once

If an exit has alr= eady been scheduled we should not schedule it again.
Otherwise, the exit= signal is never emitted if the peer reschedules the
exit before the tim= eout occurs.

schedule_exit() now only takes the context as argument.= The signal is
hard coded to SIGTERM, and the interval is read directly = from the
context options.

Furthermore, schedule_exit() now return= s a bool signifying whether an
exit was scheduled; false if exit is alre= ady scheduled. The call sites
are updated accordingly. A notable differe= nce is that management is only
notified *once* when an exit is scheduled= - we no longer notify
management on redundant exit.

Change-Id: I= 9457f005f4ba970502e6b667d9dc4299a588d661
Signed-off-by: Reynir Bj=C3=B6r= nsson <reynir@...2756...>
---
M src/openvpn/forward.c
M src/= openvpn/forward.h
M src/openvpn/push.c
3 files changed, 16 insertions= (+), 11 deletions(-)

git pull ssh://gerrit.openvpn.net:29418/open=
vpn refs/changes/55/555/2
diff --git a/src/openvpn/forward.c b/src/=
openvpn/forward.c
index 8d10f25..937fae4 100644
<= span>--- a/src/openvpn/forward.c
+++ b/src/openvpn/forward.= c
@@ -514,17 +514,23 @@
}
=
/*
-= * Schedule a signal n_seconds from now.
+ * Schedule a SIGTERM signal c->options.scheduled_e= xit_interval seconds from now.
*/
-void
-schedule_exit(struct context *c, const int n_seconds, const = int signal)
+bool
+schedule_exit(struct co= ntext *c)
{
+ const int n_seconds =3D c->options.scheduled_exit_interval;=
+ /* don't re= schedule if already scheduled. */
+ if (event_timeout_defined(&c->c2.scheduled_exit)) = {
+ return fal= se;
+ }
= tls_set_single_session(c->c2.tls_multi);
= update_time();
reset_coarse_timers(c);
event_timeout_init(&c->c2.scheduled_exit, n_seconds, now);
- c->c2.scheduled_e= xit_signal =3D signal;
+ return true;
<= span> }


/*
diff --git a/= src/openvpn/forward.h b/src/openvpn/forward.h
index 6fb5a18= ..422c591 100644
--- a/src/openvpn/forward.h
+++ b/src/openvpn/forward.h
@@ -303,7 +303,7 @@
void process_ip_header(struct context *c, unsigne= d int flags, struct buffer *buf);

-void schedule_exit(struct context *c, const= int n_seconds, const int signal);
+bool schedule_exit(struct context *c);

static inline struct link_socket_info *
get_= link_socket_info(struct context *c)
diff --git a/src/openvp= n/push.c b/src/openvpn/push.c
index 1b406b9..db1fd2e 100644=
--- a/src/openvpn/push.c
+++ b/src/openvpn= /push.c
@@ -191,6 +191,7 @@
receive_exit_m= essage(struct context *c)
{
dmsg(D_ST= REAM_ERRORS, "CC-EEN exit message received by peer");
<= span style=3D"color: hsl(120, 100%, 40%);">+ bool notify_management =3D = true;

/* With control channel exit notification, we wa= nt to give the session
* enough time to handle retran= smits and acknowledgment, so that eventual
* retries = from the client to resend the exit or ACKs will not trigger
@@ -204,14 +205,14 @@
* */
if (= c->options.mode =3D=3D MODE_SERVER)
{
- schedule_exit(c, c->opti= ons.scheduled_exit_interval, SIGTERM);
+ notify_management =3D schedule_exit(c); }
else
{
<= span> register_signal(c->sig, SIGUSR1, "remote-exit");=
}
#ifdef ENABLE_MANAGEMENT- if (management)
<= span style=3D"color: hsl(120, 100%, 40%);">+ if (management && n= otify_management)
{
managemen= t_notify(management, "info", "remote-exit", "EXIT&= quot;);
}
@@ -391,7 +392,7 @@ void
send_auth_failed(struct context *c, const ch= ar *client_reason)
{
- if (event_timeout_defined(&c->c2.scheduled_exit)= )
+ if (!schedule_= exit(c))
{
msg(D_TLS_DEBUG, &= quot;exit already scheduled for context");
re= turn;
@@ -401,8 +402,6 @@
static const= char auth_failed[] =3D "AUTH_FAILED";
size_= t len;

-
le= n =3D (client_reason ? strlen(client_reason)+1 : 0) + sizeof(auth_failed);<= /span>
if (len > PUSH_BUNDLE_SIZE)
{<= /span>
@@ -492,7 +491,7 @@
void
= send_restart(struct context *c, const char *kill_msg)
{
- schedule_exit(c, c-&= gt;options.scheduled_exit_interval, SIGTERM);
+ schedule_exit(c);
send_c= ontrol_channel_string(c, kill_msg ? kill_msg : "RESTART", D_PUSH)= ;
}


= To view, visit change 555. To unsubscribe, or for help writing mail filters, vis= it settings.

Gerrit-Project: openvpn
Gerrit-Branch: master
Gerrit-Change-Id: I9457f005f4ba970502e6b667d9d= c4299a588d661
Gerrit-Change-Number: 555
Gerrit-PatchSet: 2
Gerrit-Owner: reynir <reynir@...2756...>=
Gerrit-Reviewer: flichtenheld <frank@...2716...= 1...>
Gerrit-Reviewer: plaisthos <arne-openvpn@...1186...= .1227...>
Gerrit-Reviewer: reynir <reynir@...2756...&= gt;
Gerrit-CC: openvpn-devel <openvpn-devel@...1484...= ts.sourceforge.net>
Gerrit-Attention: plaisthos <arne-openvpn@...220...= ..1227...>
Gerrit-Attention: reynir <reynir@...2756...= >
Gerrit-MessageType: newpatchset
--iPCBDlW2Jbw=--