From mboxrd@z Thu Jan  1 00:00:00 1970
From: Adolf Belka <adolf.belka@ipfire.org>
To: development@lists.ipfire.org
Subject: Re: [PATCH 1/2] wsdd: Install wsdd - fixes bug13445
Date: Fri, 12 Jan 2024 12:14:58 +0100
Message-ID: <27e673f6-16fc-4fd0-a25c-271d02f8884f@ipfire.org>
In-Reply-To: <31ed55928f921d6f36c4559a2e41b4a9e1c53e1c@ipfire.org>
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="===============2414308718881288535=="
List-Id: <development.lists.ipfire.org>

--===============2414308718881288535==
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable

Hi Daniel,

On 11/01/2024 17:11, daniel.weismueller(a)ipfire.org wrote:
> Hi Adolf.
> We have looked at your work. First of all, thank you very much.
>=20
> Your scripts seems to work fine. I will start tomorrow to test them in=20
> whole. However we have made a few changes.
>=20
> In particular, we have adapted the code to the existing code in IPFire.
>=20
> Please take look at Michaels wsdd branch.
> https://git.ipfire.org/?p=3Dpeople/ms/ipfire-2.x.git;a=3Dshortlog;h=3Drefs/=
heads/wsdd <https://git.ipfire.org/?p=3Dpeople/ms/ipfire-2.x.git;a=3Dshortlog=
;h=3Drefs/heads/wsdd>

That looks very good. I clearly still have a bit to learn about how to=20
code in a more tidy manner.

I also see that Michael fixed the pid fault in the=20
loadproc/statusproc/killproc while I just created a workaround solution=20
for the wsdd initscript alone.
I did have a look at the code in the functions file but struggled to=20
understand it enough to be able to figure out what was giving the=20
problem I was experiencing.

I am glad that has been sorted and the initscript tidied up in line with=20
IPFire coding style.

Will try and remember that in future.

Regards,
Adolf.

>=20
> -
>=20
>=20
> Daniel
>=20
> Am 10. Januar 2024 um 14:30 schrieb "Adolf Belka"=20
> <adolf.belka(a)ipfire.org=20
> <mailto:adolf.belka(a)ipfire.org?to=3D%22Adolf%20Belka%22%20%3Cadolf.belka%=
40ipfire.org%3E>>:
>=20
>     - lfs and toorfile created for wsdd
>=20
>     - wsdd added to make.sh script
>=20
>     - created install/update/uninstall scripts for wsdd that create an
>     unpriveleged user and
>=20
>     group.
>=20
>     - initscript created for wsdd. As wsdd is a python3 script, when it
>     is run as a daemon the
>=20
>     pidof command does not find any pid for wsdd. So a directory/file
>     for a pid file was
>=20
>     created. This is then passed to the loadproc and killproc commands.
>     After the loadproc
>=20
>     command has been created the pid is extracted from the ps aux
>     command and put into the
>=20
>     pid file. This then works when running the killproc command for it
>     to know what to go
>=20
>     and stop. The statusproc command does not have the ability to feed
>     in the pid from a
>=20
>     pid file and so it fails to find a running wsdd as it uses the pidof
>     command. Code was
>=20
>     added to the status section of the initscript to check if the pid
>     file exists and if so
>=20
>     to print the same command as used with the statusproc command, and
>     also the same
>=20
>     wording if the pid file does not exist because wsdd is not running.
>=20
>     - info from the ethernet/settings file is used to identify if only
>     green0 is available or
>=20
>     if blue0 is also used and based on this the appropriate interface
>     commands are added to
>=20
>     the wsdd command.
>=20
>     - wsdd is also set up to run in a chroot
>=20
>     - Has been tested on my vm testbed, initially by editing the files
>     on the vm clone. After
>=20
>     everything confiremd to be working, the build was successfully
>     carried out and the
>=20
>     .ipfire package was copied to a new vm clone installed and shown to
>     perform as expected.
>=20
>     This test only confirms that wsdd is correctly installed and
>     started. Shutsdown and
>=20
>     restarts on reboot successfully. Confirmed from the ps aux info that
>     wsdd has been
>=20
>     started with the correct options. Thge testing can not evaluate if
>     wsdd enables windows
>=20
>     systems newer than version 7 top be able to detect the samba shares
>     as I have no
>=20
>     windows systems.
>=20
>=20
>     Fixes: Bug13445
>=20
>     Tested-by: Adolf Belka <adolf.belka(a)ipfire.org>
>=20
>     Signed-off-by: Adolf Belka <adolf.belka(a)ipfire.org>
>=20
>     ---
>=20
>     config/rootfiles/packages/wsdd | 2 +
>=20
>     lfs/wsdd | 89 ++++++++++++++++++++++++++++++++++
>=20
>     make.sh | 1 +
>=20
>     src/initscripts/packages/wsdd | 63 ++++++++++++++++++++++++
>=20
>     src/paks/wsdd/install.sh | 40 +++++++++++++++
>=20
>     src/paks/wsdd/uninstall.sh | 30 ++++++++++++
>=20
>     src/paks/wsdd/update.sh | 27 +++++++++++
>=20
>     7 files changed, 252 insertions(+)
>=20
>     create mode 100644 config/rootfiles/packages/wsdd
>=20
>     create mode 100644 lfs/wsdd
>=20
>     create mode 100644 src/initscripts/packages/wsdd
>=20
>     create mode 100644 src/paks/wsdd/install.sh
>=20
>     create mode 100644 src/paks/wsdd/uninstall.sh
>=20
>     create mode 100644 src/paks/wsdd/update.sh
>=20
>=20
>     diff --git a/config/rootfiles/packages/wsdd
>     b/config/rootfiles/packages/wsdd
>=20
>     new file mode 100644
>=20
>     index 000000000..ce225043a
>=20
>     --- /dev/null
>=20
>     +++ b/config/rootfiles/packages/wsdd
>=20
>     @@ -0,0 +1,2 @@
>=20
>     +etc/rc.d/init.d/wsdd
>=20
>     +usr/bin/wsdd
>=20
>     diff --git a/lfs/wsdd b/lfs/wsdd
>=20
>     new file mode 100644
>=20
>     index 000000000..aa65e47ef
>=20
>     --- /dev/null
>=20
>     +++ b/lfs/wsdd
>=20
>     @@ -0,0 +1,89 @@
>=20
>     +######################################################################=
#########
>=20
>     +# #
>=20
>     +# IPFire.org - A linux based firewall #
>=20
>     +# Copyright (C) 2007-2024 IPFire Team <info(a)ipfire.org> #
>=20
>     +# #
>=20
>     +# This program is free software: you can redistribute it and/or
>     modify #
>=20
>     +# it under the terms of the GNU General Public License as published
>     by #
>=20
>     +# the Free Software Foundation, either version 3 of the License, or #
>=20
>     +# (at your option) any later version. #
>=20
>     +# #
>=20
>     +# This program is distributed in the hope that it will be useful, #
>=20
>     +# but WITHOUT ANY WARRANTY; without even the implied warranty of #
>=20
>     +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
>=20
>     +# GNU General Public License for more details. #
>=20
>     +# #
>=20
>     +# You should have received a copy of the GNU General Public License #
>=20
>     +# along with this program. If not, see
>     <http://www.gnu.org/licenses/> <http://www.gnu.org/licenses/>>. #
>=20
>     +# #
>=20
>     +######################################################################=
#########
>=20
>     +
>=20
>     +######################################################################=
#########
>=20
>     +# Definitions
>=20
>     +######################################################################=
#########
>=20
>     +
>=20
>     +include Config
>=20
>     +
>=20
>     +VER =3D 0.7.1
>=20
>     +SUMMARY =3D A Web Service Discovery host daemon.
>=20
>     +
>=20
>     +THISAPP =3D wsdd-$(VER)
>=20
>     +DL_FILE =3D $(THISAPP).tar.gz
>=20
>     +DL_FROM =3D $(URL_IPFIRE)
>=20
>     +DIR_APP =3D $(DIR_SRC)/$(THISAPP)
>=20
>     +TARGET =3D $(DIR_INFO)/$(THISAPP)
>=20
>     +PROG =3D wsdd
>=20
>     +PAK_VER =3D 1
>=20
>     +
>=20
>     +DEPS =3D
>=20
>     +
>=20
>     +SERVICES =3D wsdd
>=20
>     +
>=20
>     +######################################################################=
#########
>=20
>     +# Top-level Rules
>=20
>     +######################################################################=
#########
>=20
>     +
>=20
>     +objects =3D $(DL_FILE)
>=20
>     +
>=20
>     +$(DL_FILE) =3D $(DL_FROM)/$(DL_FILE)
>=20
>     +
>=20
>     +$(DL_FILE)_BLAKE2 =3D
>     ce43022c3bd9f7ff1fd7169ac0d5ab6b2ff78d35c221c05b2e20908a5772d563ab2aca5=
71d4e6ae48a55d19d4adcb9cde60f720ae47af8ee950198224fcfdb26
>=20
>     +
>=20
>     +install : $(TARGET)
>=20
>     +
>=20
>     +check : $(patsubst %,$(DIR_CHK)/%,$(objects))
>=20
>     +
>=20
>     +download :$(patsubst %,$(DIR_DL)/%,$(objects))
>=20
>     +
>=20
>     +b2 : $(subst %,%_BLAKE2,$(objects))
>=20
>     +
>=20
>     +dist:
>=20
>     + @$(PAK)
>=20
>     +
>=20
>     +######################################################################=
#########
>=20
>     +# Downloading, checking, b2sum
>=20
>     +######################################################################=
#########
>=20
>     +
>=20
>     +$(patsubst %,$(DIR_CHK)/%,$(objects)) :
>=20
>     + @$(CHECK)
>=20
>     +
>=20
>     +$(patsubst %,$(DIR_DL)/%,$(objects)) :
>=20
>     + @$(LOAD)
>=20
>     +
>=20
>     +$(subst %,%_BLAKE2,$(objects)) :
>=20
>     + @$(B2SUM)
>=20
>     +
>=20
>     +######################################################################=
#########
>=20
>     +# Installation Details
>=20
>     +######################################################################=
#########
>=20
>     +
>=20
>     +$(TARGET) : $(patsubst %,$(DIR_DL)/%,$(objects))
>=20
>     + @$(PREBUILD)
>=20
>     + @rm -rf $(DIR_APP) && cd $(DIR_SRC) && tar axf $(DIR_DL)/$(DL_FILE)
>=20
>     + cd $(DIR_APP) && cp src/wsdd.py /usr/bin/wsdd
>=20
>     +
>=20
>     + #install initscripts
>=20
>     + $(call INSTALL_INITSCRIPTS,$(SERVICES))
>=20
>     +
>=20
>     + @rm -rf $(DIR_APP)
>=20
>     + @$(POSTBUILD)
>=20
>     diff --git a/make.sh b/make.sh
>=20
>     index 06e09c9a3..5af3dedc3 100755
>=20
>     --- a/make.sh
>=20
>     +++ b/make.sh
>=20
>     @@ -1699,6 +1699,7 @@ buildipfire() {
>=20
>     lfsmake2 perl-MIME-Base32
>=20
>     lfsmake2 perl-URI-Encode
>=20
>     lfsmake2 rsnapshot
>=20
>     + lfsmake2 wsdd
>=20
>=20
>     # Kernelbuild ... current we have no platform that need
>=20
>     # multi kernel builds so KCFG is empty
>=20
>     diff --git a/src/initscripts/packages/wsdd
>     b/src/initscripts/packages/wsdd
>=20
>     new file mode 100644
>=20
>     index 000000000..c5207f872
>=20
>     --- /dev/null
>=20
>     +++ b/src/initscripts/packages/wsdd
>=20
>     @@ -0,0 +1,63 @@
>=20
>     +#!/bin/sh
>=20
>     +######################################################################=
#########
>=20
>     +# #
>=20
>     +# IPFire.org - A linux based firewall #
>=20
>     +# Copyright (C) 2007-2024 IPFire Team <info(a)ipfire.org> #
>=20
>     +# #
>=20
>     +# This program is free software: you can redistribute it and/or
>     modify #
>=20
>     +# it under the terms of the GNU General Public License as published
>     by #
>=20
>     +# the Free Software Foundation, either version 3 of the License, or #
>=20
>     +# (at your option) any later version. #
>=20
>     +# #
>=20
>     +# This program is distributed in the hope that it will be useful, #
>=20
>     +# but WITHOUT ANY WARRANTY; without even the implied warranty of #
>=20
>     +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
>=20
>     +# GNU General Public License for more details. #
>=20
>     +# #
>=20
>     +# You should have received a copy of the GNU General Public License #
>=20
>     +# along with this program. If not, see
>     <http://www.gnu.org/licenses/> <http://www.gnu.org/licenses/>>. #
>=20
>     +# #
>=20
>     +######################################################################=
#########
>=20
>     +
>=20
>     +. /etc/sysconfig/rc
>=20
>     +. $rc_functions
>=20
>     +
>=20
>     +eval $(/usr/local/bin/readhash /var/ipfire/ethernet/settings)
>=20
>     +
>=20
>     +# Create chroot directory for wsdd
>=20
>     +mkdir -p /var/run/wsdd
>=20
>     +
>=20
>     +INTERFACES=3D"-i ${GREEN_DEV}"
>=20
>     + if [ -n "${BLUE_DEV}" ]; then
>=20
>     + INTERFACES=3D"${INTERFACES} -i ${BLUE_DEV}"
>=20
>     + fi
>=20
>     +WSDD_WORKGROUP=3D"-w $(/usr/bin/testparm -s --parameter-name
>     workgroup 2>/dev/null)"
>=20
>     +WSDD_USER=3D"-u wsdd:wsdd"
>=20
>     +WSDD_CHROOT=3D"-c /var/run/wsdd"
>=20
>     +
>=20
>     +case "$1" in
>=20
>     + start)
>=20
>     + boot_mesg "Starting wsdd daemon..."
>=20
>     + loadproc -b /usr/bin/wsdd -4 ${WSDD_USER} ${INTERFACES}
>     ${WSDD_WORKGROUP} ${WSDD_CHROOT}
>=20
>     + sleep 1
>=20
>     + echo $(ps aux | grep "/usr/bin/wsdd" | grep -v grep | awk '{print
>     $2}') > /var/run/wsdd/pid
>=20
>     + ;;
>=20
>     + stop)
>=20
>     + boot_mesg "Stopping wsdd daemon..."
>=20
>     + killproc -p /var/run/wsdd/pid /usr/bin/wsdd
>=20
>     + ;;
>=20
>     + status)
>=20
>     + WSDD_PID=3D$(ps aux | grep "/usr/bin/wsdd" | grep -v grep | awk
>     '{print $2}')
>=20
>     + if [ -n "${WSDD_PID}" ]; then
>=20
>     + echo -e "\\033[1;36m /usr/bin/wsdd is running with Process"\
>=20
>     + "ID(s) $WSDD_PID.\\033[0;39m"
>=20
>     + else
>=20
>     + echo -e "\\033[1;36m /usr/bin/wsdd is not running.\\033[0;39m"
>=20
>     + fi
>=20
>     + ;;
>=20
>     + *)
>=20
>     + echo "Usage: $0 (start|stop|status)"
>=20
>     + exit 1
>=20
>     + ;;
>=20
>     +esac
>=20
>     +
>=20
>     diff --git a/src/paks/wsdd/install.sh b/src/paks/wsdd/install.sh
>=20
>     new file mode 100644
>=20
>     index 000000000..181b84eb9
>=20
>     --- /dev/null
>=20
>     +++ b/src/paks/wsdd/install.sh
>=20
>     @@ -0,0 +1,40 @@
>=20
>     +#!/bin/bash
>=20
>     +######################################################################=
######
>=20
>     +# #
>=20
>     +# This file is part of the IPFire Firewall. #
>=20
>     +# #
>=20
>     +# IPFire is free software; you can redistribute it and/or modify #
>=20
>     +# it under the terms of the GNU General Public License as published
>     by #
>=20
>     +# the Free Software Foundation; either version 2 of the License, or #
>=20
>     +# (at your option) any later version. #
>=20
>     +# #
>=20
>     +# IPFire is distributed in the hope that it will be useful, #
>=20
>     +# but WITHOUT ANY WARRANTY; without even the implied warranty of #
>=20
>     +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
>=20
>     +# GNU General Public License for more details. #
>=20
>     +# #
>=20
>     +# You should have received a copy of the GNU General Public License #
>=20
>     +# along with IPFire; if not, write to the Free Software #
>=20
>     +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
>     02111-1307 USA #
>=20
>     +# #
>=20
>     +# Copyright (C) 2007 IPFire-Team <info(a)ipfire.org>. #
>=20
>     +# #
>=20
>     +######################################################################=
######
>=20
>     +#
>=20
>     +. /opt/pakfire/lib/functions.sh
>=20
>     +
>=20
>     +# If the wsdd user does not exist yet, then create it and add to
>     wsdd group.
>=20
>     +if ! getent user wsdd >/dev/null; then
>=20
>     + useradd -r -U -d / -s /bin/false -c "wsdd user" wsdd
>=20
>     + usermod -a -G wsdd wsdd
>=20
>     +fi
>=20
>     +
>=20
>     +extract_files
>=20
>     +restore_backup ${NAME}
>=20
>     +
>=20
>     +# Create startlinks
>=20
>     +ln -sf ../init.d/wsdd /etc/rc.d/rc0.d/K35wsdd
>=20
>     +ln -sf ../init.d/wsdd /etc/rc.d/rc3.d/S65wsdd
>=20
>     +ln -sf ../init.d/wsdd /etc/rc.d/rc6.d/K35wsdd
>=20
>     +start_service ${NAME}
>=20
>     +exit 0
>=20
>     diff --git a/src/paks/wsdd/uninstall.sh b/src/paks/wsdd/uninstall.sh
>=20
>     new file mode 100644
>=20
>     index 000000000..4c52ee281
>=20
>     --- /dev/null
>=20
>     +++ b/src/paks/wsdd/uninstall.sh
>=20
>     @@ -0,0 +1,30 @@
>=20
>     +#!/bin/bash
>=20
>     +######################################################################=
######
>=20
>     +# #
>=20
>     +# This file is part of the IPFire Firewall. #
>=20
>     +# #
>=20
>     +# IPFire is free software; you can redistribute it and/or modify #
>=20
>     +# it under the terms of the GNU General Public License as published
>     by #
>=20
>     +# the Free Software Foundation; either version 2 of the License, or #
>=20
>     +# (at your option) any later version. #
>=20
>     +# #
>=20
>     +# IPFire is distributed in the hope that it will be useful, #
>=20
>     +# but WITHOUT ANY WARRANTY; without even the implied warranty of #
>=20
>     +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
>=20
>     +# GNU General Public License for more details. #
>=20
>     +# #
>=20
>     +# You should have received a copy of the GNU General Public License #
>=20
>     +# along with IPFire; if not, write to the Free Software #
>=20
>     +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
>     02111-1307 USA #
>=20
>     +# #
>=20
>     +# Copyright (C) 2007 IPFire-Team <info(a)ipfire.org>. #
>=20
>     +# #
>=20
>     +######################################################################=
######
>=20
>     +#
>=20
>     +. /opt/pakfire/lib/functions.sh
>=20
>     +stop_service ${NAME}
>=20
>     +make_backup ${NAME}
>=20
>     +remove_files
>=20
>     +# Remove all start links.
>=20
>     +rm -rf /etc/rc.d/rc*.d/*wsdd
>=20
>     +exit 0
>=20
>     diff --git a/src/paks/wsdd/update.sh b/src/paks/wsdd/update.sh
>=20
>     new file mode 100644
>=20
>     index 000000000..99776659c
>=20
>     --- /dev/null
>=20
>     +++ b/src/paks/wsdd/update.sh
>=20
>     @@ -0,0 +1,27 @@
>=20
>     +#!/bin/bash
>=20
>     +######################################################################=
######
>=20
>     +# #
>=20
>     +# This file is part of the IPFire Firewall. #
>=20
>     +# #
>=20
>     +# IPFire is free software; you can redistribute it and/or modify #
>=20
>     +# it under the terms of the GNU General Public License as published
>     by #
>=20
>     +# the Free Software Foundation; either version 2 of the License, or #
>=20
>     +# (at your option) any later version. #
>=20
>     +# #
>=20
>     +# IPFire is distributed in the hope that it will be useful, #
>=20
>     +# but WITHOUT ANY WARRANTY; without even the implied warranty of #
>=20
>     +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
>=20
>     +# GNU General Public License for more details. #
>=20
>     +# #
>=20
>     +# You should have received a copy of the GNU General Public License #
>=20
>     +# along with IPFire; if not, write to the Free Software #
>=20
>     +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
>     02111-1307 USA #
>=20
>     +# #
>=20
>     +# Copyright (C) 2007-2020 IPFire-Team <info(a)ipfire.org>. #
>=20
>     +# #
>=20
>     +######################################################################=
######
>=20
>     +#
>=20
>     +. /opt/pakfire/lib/functions.sh
>=20
>     +extract_backup_includes
>=20
>     +./uninstall.sh
>=20
>     +./install.sh
>=20
>     --=20
>=20
>     2.43.0
>=20
>=20

--=20
Sent from my laptop

--===============2414308718881288535==--