From: "cron2 (Code Review)" Date: Thu, 4 Jul 2024 20:29:49 +0000 In-Reply-To: References: Reply-To: gert@...1296..., arne-openvpn@...1227..., samuli@...515..., openvpn-devel@lists.sourceforge.net, frank@...2641... Message-ID: <12433c23e89ea7fa172c49009fec5b6ace424c2d-HTML@...2715...> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Disposition: inline Content-Type: multipart/alternative; boundary="mja70thcdn0="; charset=UTF-8 Subject: [Openvpn-devel] [M] Change in openvpn[master]: t_server_null: multiple improvements and fixes List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: mattock Cc: flichtenheld , plaisthos , openvpn-devel --mja70thcdn0= Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable cron2 has submitted this change. ( http://gerrit.openvpn.net/c/openvpn/+/66= 9?usp=3Demail ) Change subject: t_server_null: multiple improvements and fixes ...................................................................... t_server_null: multiple improvements and fixes - exit after a timeout if unable to kill servers - use sudo or equivalent only for server stop/start - use /bin/sh directly instead of through /usr/bin/env - simplify sudo call in the sample rc file - remove misleading and outdated documentation - make it work on OpenBSD 7.5 - make it work on NetBSD 10.0 - make server logs readable by normal users Change-Id: I2cce8ad4e0d262e1404ab1eb6ff673d8590b6b3a Signed-off-by: Samuli Sepp=C3=A4nen Acked-by: Frank Lichtenheld Message-Id: <20240704133337.26595-1-gert@...1296...> URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg28= 871.html Signed-off-by: Gert Doering --- M doc/t_server_null.rst M tests/t_server_null.rc-sample M tests/t_server_null.sh M tests/t_server_null_client.sh M tests/t_server_null_default.rc M tests/t_server_null_server.sh M tests/t_server_null_stress.sh 7 files changed, 64 insertions(+), 40 deletions(-) diff --git a/doc/t_server_null.rst b/doc/t_server_null.rst index e3a098a..5fe9080 100644 --- a/doc/t_server_null.rst +++ b/doc/t_server_null.rst @@ -43,6 +43,12 @@ * run as root * a privilege escalation tool (sudo, doas, su) and the permission to bec= ome root +If you use "doas" you should enable nopass feature in */etc/doas.conf*. For +example to allow users in the *wheel* group to run commands without a pass= word +prompt:: + + permit nopass keepenv :wheel + Technical implementation ------------------------ @@ -73,13 +79,6 @@ * Waits until servers have launched. Then launch all clients, wait f= or them to exit and then check test results by parsing the client log files= . Each client kills itself after some delay using an "--up" script. -Note that "make check" moves on once *t_server_null_client.sh* has exited.= At -that point *t_server_null_server.sh* is still running, because it exists o= nly -after waiting a few seconds for more client connections to potentially app= ear. -This is a feature and not a bug, but means that launching "make check" run= s too -quickly might cause test failures or unexpected behavior such as leftover -OpenVPN server processes. - Configuration ------------- diff --git a/tests/t_server_null.rc-sample b/tests/t_server_null.rc-sample index 28c3773..98d7869 100644 --- a/tests/t_server_null.rc-sample +++ b/tests/t_server_null.rc-sample @@ -1,6 +1,5 @@ # Uncomment to run tests with sudo -#SUDO_EXEC=3D`which sudo` -#RUN_SUDO=3D"${SUDO_EXEC} -E" +#RUN_SUDO=3D"sudo -E" TEST_RUN_LIST=3D"1 2 3 10 11" diff --git a/tests/t_server_null.sh b/tests/t_server_null.sh index 0e53ba4..7627edf 100755 --- a/tests/t_server_null.sh +++ b/tests/t_server_null.sh @@ -1,4 +1,4 @@ -#!/usr/bin/env sh +#!/bin/sh # TSERVER_NULL_SKIP_RC=3D"${TSERVER_NULL_SKIP_RC:-77}" @@ -57,12 +57,7 @@ srcdir=3D"${srcdir:-.}" -if [ -z "${RUN_SUDO}" ]; then - "${srcdir}/t_server_null_server.sh" & -else - $RUN_SUDO "${srcdir}/t_server_null_server.sh" & -fi - +"${srcdir}/t_server_null_server.sh" & "${srcdir}/t_server_null_client.sh" retval=3D$? diff --git a/tests/t_server_null_client.sh b/tests/t_server_null_client.sh index 8890007..e7dd332 100755 --- a/tests/t_server_null_client.sh +++ b/tests/t_server_null_client.sh @@ -1,4 +1,4 @@ -#!/usr/bin/env sh +#!/bin/sh launch_client() { test_name=3D$1 @@ -76,19 +76,22 @@ count=3D0 server_max_wait=3D15 while [ $count -lt $server_max_wait ]; do - server_pids=3D"" - server_count=3D$(set|grep 'SERVER_NAME_'|wc -l) + servers_up=3D0 + server_count=3D$(echo $TEST_SERVER_LIST|wc -w) # We need to trim single-quotes because some shells return quoted valu= es # and some don't. Using "set -o posix" which would resolve this proble= m is # not supported in all shells. + # + # While inactive server configurations may get checked they won't incr= ease + # the active server count as the processes won't be running. for i in `set|grep 'SERVER_NAME_'|cut -d "=3D" -f 2|tr -d "[\']"`; do server_pid=3D$(cat $i.pid 2> /dev/null) - server_pids=3D"${server_pids} ${server_pid}" + if ps -p $server_pid > /dev/null 2>&1; then + servers_up=3D$(( $servers_up + 1 )) + fi done - servers_up=3D$(ps -p $server_pids 2>/dev/null|sed '1d'|wc -l) - echo "OpenVPN test servers up: ${servers_up}/${server_count}" if [ $servers_up -ge $server_count ]; then @@ -101,6 +104,7 @@ if [ $count -eq $server_max_wait ]; then retval=3D1 + exit $retval fi done diff --git a/tests/t_server_null_default.rc b/tests/t_server_null_default.rc index 63b6bcd..825bb52 100755 --- a/tests/t_server_null_default.rc +++ b/tests/t_server_null_default.rc @@ -24,7 +24,7 @@ MAX_CLIENTS=3D"10" CLIENT_MATCH=3D"Test-Client" SERVER_EXEC=3D"${top_builddir}/src/openvpn/openvpn" -SERVER_BASE_OPTS=3D"--daemon --local 127.0.0.1 --dev tun --topology subnet= --server 10.29.41.0 255.255.255.0 --max-clients $MAX_CLIENTS --persist-tun= --verb 3" +SERVER_BASE_OPTS=3D"--daemon --local 127.0.0.1 --dev tun --topology subnet= --max-clients $MAX_CLIENTS --persist-tun --verb 3" SERVER_CIPHER_OPTS=3D"" SERVER_CERT_OPTS=3D"--ca ${CA} --dh ${DH} --cert ${SERVER_CERT} --key ${SE= RVER_KEY} --tls-auth ${TA} 0" SERVER_CONF_BASE=3D"${SERVER_BASE_OPTS} ${SERVER_CIPHER_OPTS} ${SERVER_CER= T_OPTS}" @@ -32,14 +32,16 @@ TEST_SERVER_LIST=3D"1 2" SERVER_NAME_1=3D"t_server_null_server-1194_udp" +SERVER_SERVER_1=3D"--server 10.29.41.0 255.255.255.0" SERVER_MGMT_PORT_1=3D"11194" SERVER_EXEC_1=3D"${SERVER_EXEC}" -SERVER_CONF_1=3D"${SERVER_CONF_BASE} --lport 1194 --proto udp --management= 127.0.0.1 ${SERVER_MGMT_PORT_1}" +SERVER_CONF_1=3D"${SERVER_CONF_BASE} ${SERVER_SERVER_1} --lport 1194 --pro= to udp --management 127.0.0.1 ${SERVER_MGMT_PORT_1}" SERVER_NAME_2=3D"t_server_null_server-1195_tcp" +SERVER_SERVER_2=3D"--server 10.29.42.0 255.255.255.0" SERVER_MGMT_PORT_2=3D"11195" SERVER_EXEC_2=3D"${SERVER_EXEC}" -SERVER_CONF_2=3D"${SERVER_CONF_BASE} --lport 1195 --proto tcp --management= 127.0.0.1 ${SERVER_MGMT_PORT_2}" +SERVER_CONF_2=3D"${SERVER_CONF_BASE} ${SERVER_SERVER_2} --lport 1195 --pro= to tcp --management 127.0.0.1 ${SERVER_MGMT_PORT_2}" # Test client configurations CLIENT_EXEC=3D"${top_builddir}/src/openvpn/openvpn" diff --git a/tests/t_server_null_server.sh b/tests/t_server_null_server.sh index 9bc0c88..e5906ee 100755 --- a/tests/t_server_null_server.sh +++ b/tests/t_server_null_server.sh @@ -1,4 +1,4 @@ -#!/usr/bin/env sh +#!/bin/sh launch_server() { server_name=3D$1 @@ -8,18 +8,28 @@ status=3D"${server_name}.status" pid=3D"${server_name}.pid" - # Ensure that old status, log and pid files are gone - rm -f "${status}" "${log}" "${pid}" - - "${server_exec}" \ - $server_conf \ - --status "${status}" 1 \ - --log "${log}" \ - --writepid "${pid}" \ - --explicit-exit-notify 3 - + if [ -z "${RUN_SUDO}" ]; then + rm -f "${status}" "${log}" "${pid}" + "${server_exec}" \ + $server_conf \ + --status "${status}" 1 \ + --log "${log}" \ + --writepid "${pid}" \ + --explicit-exit-notify 3 + else + $RUN_SUDO rm -f "${status}" "${log}" "${pid}" + $RUN_SUDO "${server_exec}" \ + $server_conf \ + --status "${status}" 1 \ + --log "${log}" \ + --writepid "${pid}" \ + --explicit-exit-notify 3 + fi } +# Make server log files readable by normal users +umask 022 + # Load base/default configuration . "${srcdir}/t_server_null_default.rc" || exit 1 =20 @@ -64,15 +74,30 @@ echo "All clients have disconnected from all servers" +# Make sure that the server processes are truly dead before exiting. If a +# server process does not exit in 15 seconds assume it never will, move on= and +# hope for the best. +echo "Waiting for servers to exit" for PID_FILE in $server_pid_files do SERVER_PID=3D$(cat "${PID_FILE}") - $KILL_EXEC "${SERVER_PID}" - # Make sure that the server processes are truly dead before exiting - while : + if [ -z "${RUN_SUDO}" ]; then + $KILL_EXEC "${SERVER_PID}" + else + $RUN_SUDO $KILL_EXEC "${SERVER_PID}" + fi + + count=3D0 + maxcount=3D75 + while [ $count -le $maxcount ] do ps -p "${SERVER_PID}" > /dev/null || break + count=3D$(( count + 1)) sleep 0.2 done + + if [ $count -ge $maxcount ]; then + echo "WARNING: could not kill server with pid ${SERVER_PID}!" + fi done diff --git a/tests/t_server_null_stress.sh b/tests/t_server_null_stress.sh index 1281397..0bb9452 100755 --- a/tests/t_server_null_stress.sh +++ b/tests/t_server_null_stress.sh @@ -1,4 +1,4 @@ -#!/usr/bin/env sh +#!/bin/sh # # Run this stress test as root to avoid sudo authorization from timing out. -- To view, visit http://gerrit.openvpn.net/c/openvpn/+/669?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: I2cce8ad4e0d262e1404ab1eb6ff673d8590b6b3a Gerrit-Change-Number: 669 Gerrit-PatchSet: 6 Gerrit-Owner: mattock Gerrit-Reviewer: cron2 Gerrit-Reviewer: flichtenheld Gerrit-Reviewer: plaisthos Gerrit-CC: openvpn-devel Gerrit-MessageType: merged --mja70thcdn0= Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable

cron2 submitted this change.

View Change

t_server_null: multiple improvements and fixes=


- exit after a timeout if unable to kill servers
- use sudo or e= quivalent only for server stop/start
- use /bin/sh directly instead of t= hrough /usr/bin/env
- simplify sudo call in the sample rc file
- remo= ve misleading and outdated documentation
- make it work on OpenBSD 7.5- make it work on NetBSD 10.0
- make server logs readable by normal us= ers

Change-Id: I2cce8ad4e0d262e1404ab1eb6ff673d8590b6b3a
Signed-o= ff-by: Samuli Sepp=C3=A4nen <samuli.seppanen@...277...>
Acked-by: = Frank Lichtenheld <frank@...2641...>
Message-Id: <2024070413333= 7.26595-1-gert@...1296...>
URL: https://www.mail-archive.com/openvpn-= devel@lists.sourceforge.net/msg28871.html
Signed-off-by: Gert Doering &l= t;gert@...1296...>
---
M doc/t_server_null.rst
M tests/t_server= _null.rc-sample
M tests/t_server_null.sh
M tests/t_server_null_client= .sh
M tests/t_server_null_default.rc
M tests/t_server_null_server.sh<= br>M tests/t_server_null_stress.sh
7 files changed, 64 insertions(+), 40= deletions(-)

diff --git a/doc/t_server_null.rst b/doc/t_server_null.rst
index e3a098a..5fe9080 100644
--- a/doc/t_server_null.rs= t
+++ b/doc/t_server_null.rst
@@ -43,6 +43,= 12 @@
* run as root
* a privilege esc= alation tool (sudo, doas, su) and the permission to become root
<= span>
+If you use &q= uot;doas" you should enable nopass feature in */etc/doas.conf*. For
+example to allow users= in the *wheel* group to run commands without a password
+prompt::
+
+ permit nopass keepenv :wheel
+
Technical implementation
------------------------


@@ -73,13 += 79,6 @@

* Waits until servers have= launched. Then launch all clients, wait for them to exit and then check te= st results by parsing the client log files. Each client kills itself after = some delay using an "--up" script.

-Note that "make check" m= oves on once *t_server_null_client.sh* has exited. At
-that point *t_server_null_server.sh* is sti= ll running, because it exists only
-after waiting a few seconds for more client connections to pot= entially appear.
-This = is a feature and not a bug, but means that launching "make check"= runs too
-quickly migh= t cause test failures or unexpected behavior such as leftover
-OpenVPN server processes.-
Configuration=
-------------

diff --gi= t a/tests/t_server_null.rc-sample b/tests/t_server_null.rc-sampleindex 28c3773..98d7869 100644
--- a/tests/t_server_n= ull.rc-sample
+++ b/tests/t_server_null.rc-sample@@ -1,6 +1,5 @@
# Uncomment to run tests with sudo<= /span>
-#SUDO_EXEC=3D`which su= do`
-#RUN_SUDO=3D"= ${SUDO_EXEC} -E"
+#RUN_SUDO=3D"sudo -E"

TEST_R= UN_LIST=3D"1 2 3 10 11"

diff --= git a/tests/t_server_null.sh b/tests/t_server_null.sh
index= 0e53ba4..7627edf 100755
--- a/tests/t_server_null.sh
+++ b/tests/t_server_null.sh
@@ -1,4 +1,4 @@

-#!/usr/bin/env sh<= br>+#!/bin/sh
= #
TSERVER_NULL_SKIP_RC=3D"${TSERVER_NULL_SKIP_RC:-77}= "

@@ -57,12 +57,7 @@

srcdir=3D"${srcdir:-.}"

-if [ -z "${RUN_SUDO}= " ]; then
- &qu= ot;${srcdir}/t_server_null_server.sh" &
-else
- $RUN_SUDO "${srcdir}/t_server_null_server.sh" &=
-fi
-
+"${srcdir}/t_server_null_server.sh" &<= br> "${srcdir}/t_server_null_client.sh"
re= tval=3D$?

diff --git a/tests/t_server_nul= l_client.sh b/tests/t_server_null_client.sh
index 8890007..= e7dd332 100755
--- a/tests/t_server_null_client.sh+++ b/tests/t_server_null_client.sh
@@ -1,4 +1,4 @@=
-#!/usr/bin/env sh

+#!/bin/sh

launch_client() {
test_name=3D$1=
@@ -76,19 +76,22 @@
count=3D0
<= span> server_max_wait=3D15
while [ $count -lt $server_max_= wait ]; do
- server_= pids=3D""
- = server_count=3D$(set|grep 'SERVER_NAME_'|wc -l)
+ servers_up=3D0
+ server_count=3D$(echo $TEST_SERVER= _LIST|wc -w)

# We need to trim singl= e-quotes because some shells return quoted values
# an= d some don't. Using "set -o posix" which would resolve this p= roblem is
# not supported in all shells.
+ #
+ # While inactive server configurations may = get checked they won't increase
+ # the active server count as the processes won't be= running.
for i in `set|grep 'SERVER_NAME_'|cu= t -d "=3D" -f 2|tr -d "[\']"`; do
= server_pid=3D$(cat $i.pid 2> /dev/null)
- server_pids=3D"${server_pids} ${s= erver_pid}"
+ = if ps -p $server_pid > /dev/null 2>&1; then
+ servers_up=3D$(( $server= s_up + 1 ))
+ = fi
done

- servers_up=3D$(ps -p $server_pids 2>/dev/nu= ll|sed '1d'|wc -l)
-
echo "OpenVPN test servers up: ${servers_up= }/${server_count}"

if [ $server= s_up -ge $server_count ]; then
@@ -101,6 +104,7 @@
if [ $count -eq $server_max_wait ]; then

retval=3D1
+ exit $retval
fi
= done

diff --git a/tests/t_server_null_def= ault.rc b/tests/t_server_null_default.rc
index 63b6bcd..825= bb52 100755
--- a/tests/t_server_null_default.rc
= +++ b/tests/t_server_null_default.rc
@@ -24,7 +24,7 @= @
MAX_CLIENTS=3D"10"
CLIENT_MAT= CH=3D"Test-Client"
SERVER_EXEC=3D"${top_bui= lddir}/src/openvpn/openvpn"
-SERVER_BASE_OPTS=3D"--daemon --local 127.0.0.1 --dev tun --= topology subnet --server 10.29.41.0 255.255.255.0 --max-clients $MAX_CLIENT= S --persist-tun --verb 3"
+SERVER_BASE_OPTS=3D"--daemon --local 127.0.0.1 --dev tun --= topology subnet --max-clients $MAX_CLIENTS --persist-tun --verb 3"

SERVER_CIPHER_OPTS=3D""
SERVER_CER= T_OPTS=3D"--ca ${CA} --dh ${DH} --cert ${SERVER_CERT} --key ${SERVER_K= EY} --tls-auth ${TA} 0"
SERVER_CONF_BASE=3D"${SE= RVER_BASE_OPTS} ${SERVER_CIPHER_OPTS} ${SERVER_CERT_OPTS}"
<= span>@@ -32,14 +32,16 @@
TEST_SERVER_LIST=3D"1 2"= ;

SERVER_NAME_1=3D"t_server_null_se= rver-1194_udp"
+= SERVER_SERVER_1=3D"--server 10.29.41.0 255.255.255.0"
<= span> SERVER_MGMT_PORT_1=3D"11194"
SERVER_EXEC_1= =3D"${SERVER_EXEC}"
-SERVER_CONF_1=3D"${SERVER_CONF_BASE} --lport 1194 --proto udp = --management 127.0.0.1 ${SERVER_MGMT_PORT_1}"
+SERVER_CONF_1=3D"${SERVER_CONF_BASE} ${= SERVER_SERVER_1} --lport 1194 --proto udp --management 127.0.0.1 ${SERVER_M= GMT_PORT_1}"

SERVER_NAME_2=3D"= t_server_null_server-1195_tcp"
+SERVER_SERVER_2=3D"--server 10.29.42.0 255.255.255.0&q= uot;
SERVER_MGMT_PORT_2=3D"11195"
SERVER_EXEC_2=3D"${SERVER_EXEC}"
-SERVER_CONF_2=3D"${SERVER_CONF_BASE} --lport 1= 195 --proto tcp --management 127.0.0.1 ${SERVER_MGMT_PORT_2}"+SERVER_CONF_2=3D"${SERV= ER_CONF_BASE} ${SERVER_SERVER_2} --lport 1195 --proto tcp --management 127.= 0.0.1 ${SERVER_MGMT_PORT_2}"

# Test= client configurations
CLIENT_EXEC=3D"${top_builddir}= /src/openvpn/openvpn"
diff --git a/tests/t_server_null= _server.sh b/tests/t_server_null_server.sh
index 9bc0c88..e= 5906ee 100755
--- a/tests/t_server_null_server.sh+++ b/tests/t_server_null_server.sh
@@ -1,4 +1,4 @@<= /span>
-#!/usr/bin/env sh

+#!/bin/sh

launch_server() {
server_name=3D$= 1
@@ -8,18 +8,28 @@
status=3D"${s= erver_name}.status"
pid=3D"${server_name}.pi= d"

- # Ensure that old status, log and pid files are gone
- rm -f "${status}" &quo= t;${log}" "${pid}"
-
- "= ;${server_exec}" \
- $server_conf \
- --log "${log}" \
- --writepid "${pid}" = \
- --explicit-e= xit-notify 3
-+ if [ -z "${RUN_SUDO= }" ]; then
+ = rm -f "${status}" "${log}" "${pid}"
+ "${server_ex= ec}" \
+ = $server_conf \
+ = --status "${status}" 1 \
+ --log "${log}" \
+ --writepid "${pid}" = \
+ --explici= t-exit-notify 3
+ = else
+ $RUN_SU= DO rm -f "${status}" "${log}" "${pid}"=
+ $RUN_SUDO "${= server_exec}" \
= + $server_conf \
+ --status "${status}" 1 \=
+ --log &= quot;${log}" \
+= --writepid "${pid}" \
+ --explicit-exit-notify 3<= /span>
+ fi
}


+# Make server log files readable by normal users
+umask 022
+
# Load base/default configuration=
. "${srcdir}/t_server_null_default.rc" || exit = 1

@@ -64,15 +74,30 @@

echo "All clients have disconnected from all servers&q= uot;

+# server process = does not exit in 15 seconds assume it never will, move on and
+# hope for the best.

+echo "Waiting for servers t= o exit"

for PID_FILE in $server_pid_files
<= span> do
SERVER_PID=3D$(cat "${PID_FILE}")
- $KILL_EXEC "${= SERVER_PID}"

- # Make sure that the server processes are truly dead befo= re exiting
- while :=
+ if [ -z "$= {RUN_SUDO}" ]; then
+ $KILL_EXEC "${SERVER_PID}"
+ else
+ $RUN_SUDO $KILL_EXEC "${SERVER_PID}"
+ fi
+

+ count=3D0
+ maxcount=3D75
+ while [ $count -le $maxcount ]
do
ps -p "${SERVER_PID}" > /dev/null || br= eak
+ count=3D= $(( count + 1))
sleep 0.2
don= e
+
+ if [ $count -ge $maxcount ]; then=
+ echo "= WARNING: could not kill server with pid ${SERVER_PID}!"
+ fi

done
diff --git a/tests/t_server_null_stress.sh b/tests/t_server_null= _stress.sh
index 1281397..0bb9452 100755
--= - a/tests/t_server_null_stress.sh
+++ b/tests/t_server_null= _stress.sh
@@ -1,4 +1,4 @@
-#!/usr/bin/env sh
+#!/bin/sh
#
# Run this= stress test as root to avoid sudo authorization from timing out.

To view, visit change 669. To unsub= scribe, or for help writing mail filters, visit settings.

Gerrit-Project: openvpn
Gerrit-Branch: master
Gerrit-Change-Id: I2cce8ad4e0d262e1404ab1eb6ff= 673d8590b6b3a
Gerrit-Change-Number: 669
Gerrit-PatchSet: 6
Gerrit-Owner: mattock <samuli@...515...>=
Gerrit-Reviewer: cron2 <gert@...1296...>=
Gerrit-Reviewer: flichtenheld <frank@...2716...= 1...>
Gerrit-Reviewer: plaisthos <arne-openvpn@...1186...= .1227...>
Gerrit-CC: openvpn-devel <openvpn-devel@...1484...= ts.sourceforge.net>
Gerrit-MessageType: merged
--mja70thcdn0=--