Merge pull request #3262 from bluca/sysusers

Install sysusers.d config for user/group

Author: jimklimov

Makefile.am

@@ -496,6 +496,7 @@ DISTCHECK_CONFIGURE_FLAGS = ${DISTCHECK_FLAGS}		\
  --with-systemdsystempresetdir='$${prefix}/usr/lib/systemd/system-preset' \
  --with-systemdshutdowndir='$${prefix}/lib/systemd/system-shutdown' \
  --with-systemdtmpfilesdir='$${prefix}/usr/lib/tmpfiles.d' \
+ --with-systemdsysusersdir='$${prefix}/usr/lib/sysusers.d' \
  --with-augeas-lenses-dir='$${prefix}/usr/share/augeas/lenses'		\
  --with-hotplug-dir='$${prefix}/etc/hotplug'		\
  --with-udev-dir='$${prefix}/etc/udev'			\
@@ -1262,6 +1263,12 @@ else !WITH_SYSTEMD_TMPFILES
 WITH_SYSTEMD_TMPFILES = false
 endif !WITH_SYSTEMD_TMPFILES
 
+if WITH_SYSTEMD_SYSUSERS
+WITH_SYSTEMD_SYSUSERS = true
+else !WITH_SYSTEMD_SYSUSERS
+WITH_SYSTEMD_SYSUSERS = false
+endif !WITH_SYSTEMD_SYSUSERS
+
 if WITH_SYSTEMD_PRESET
 WITH_SYSTEMD_PRESET = true
 else !WITH_SYSTEMD_PRESET
@@ -1413,6 +1420,10 @@ install-as-root:
 				echo "$@: Apply systemd-tmpfiles presets" >&2 ; \
 				$(SYSTEMD_TMPFILES_PROGRAM) --create || exit ; \
 			fi ; \
+			if $(WITH_SYSTEMD_SYSUSERS) ; then \
+				echo "$@: Apply systemd-sysusers presets" >&2 ; \
+				$(SYSTEMD_SYSUSERS_PROGRAM) || exit ; \
+			fi ; \
 			echo "$@: Learn systemd definition changes" >&2 ; \
 			$(SYSTEMD_SYSTEMCTL_PROGRAM) daemon-reload || exit ; \
 			APPLIED_SYSTEMD_PRESET=false ; \

NEWS.adoc

@@ -338,6 +338,10 @@ several `FSD` notifications into one executed action. [PR #3097]
      prefer a `python3` if available, else `python2`, else `python`. [#1792]
    * The `configure` script should now try harder to report specifically
      the "purelib" location as `PYTHON*_SITE_PACKAGES`. [#1209]
+   * Added a `--with-systemdsysusersdir=PATH` option to have systemd pre-create
+     the user and group accounts for NUT, before packaging or manually executed
+     commands do (this is particularly important for immutable-image operating
+     environments). [PR #3262]
    * Streamlined handling of `--with-*` and `--enable-*` options using NUT 'm4'
      macros; fixed reporting help for options whose defaults are evaluated.
      [issue #3049, PR #3140]

autogen.sh

@@ -150,6 +150,12 @@ if [ ! -f scripts/systemd/nut-common-tmpfiles.conf.in ]; then
 	) > scripts/systemd/nut-common-tmpfiles.conf.in
 fi
 
+if [ ! -f scripts/systemd/nut-common-sysusers.conf.in ]; then
+	( echo '# autoconf requires this file exists before generating configure script;'
+	  echo '# it will be overwritten by running configure during an actual build'
+	) > scripts/systemd/nut-common-sysusers.conf.in
+fi
+
 # now we can safely call autoreconf
 if ( command -v dos2unix ) 2>/dev/null >/dev/null ; then
 	if ( dos2unix < configure.ac | cmp - configure.ac ) 2>/dev/null >/dev/null ; then

configure.ac

@@ -5114,6 +5114,46 @@ dnl What pathname would we embed into unit files ExecStartPre?
 dnl TODO? Any need to make it a --with-... argument?
 AC_PATH_PROG([SYSTEMD_TMPFILES_PROGRAM], [systemd-tmpfiles], [/usr/bin/systemd-tmpfiles])
 
+dnl Note: same as (systemd-)tmpfiles
+AC_MSG_CHECKING([whether to install sysusers.d files])
+NUT_ARG_WITH([systemdsysusersdir], [(DIRPATH|yes|no|auto)], [Directory for systemd sysusers.d scripts], [auto])
+systemdsysusersdir="${nut_with_systemdsysusersdir}"
+
+case "${systemdsysusersdir}" in
+	yes|auto|"")
+		AS_IF([test x"$have_PKG_CONFIG" = xyes],
+			[def_systemdsysusersdir="`$PKG_CONFIG --variable=sysusersdir systemd 2>/dev/null`" && test -n "$def_systemdsysusersdir" || \
+			 def_systemdsysusersdir="`$PKG_CONFIG --variable=sysusersdir libsystemd 2>/dev/null`" || def_systemdsysusersdir=""],
+			[def_systemdsysusersdir=""])
+
+		AS_IF([test x"${def_systemdsysusersdir}" = x], [
+			AS_IF([test "${systemdsysusersdir}" = yes],
+				[AC_MSG_ERROR([--with-systemdsysusersdir=${systemdsysusersdir} was requested, but PKG_CONFIG could not be queried for the system settings])])
+			systemdsysusersdir=""
+			], [systemdsysusersdir="${def_systemdsysusersdir}"])
+
+		unset def_systemdsysusersdir
+		;;
+	no)
+		systemdsysusersdir=""
+		;;
+	*)
+		AS_IF([test -d "${systemdsysusersdir}"], [],
+			[AC_MSG_WARN([--with-systemdsysusersdir='${systemdsysusersdir}' was requested, but that location does not currently exist in build environment - just so you know...])])
+		;;
+esac
+if test "${systemdsysusersdir}" = "auto" ; then systemdsysusersdir=""; fi
+if test -n "${systemdsysusersdir}"; then
+	AC_MSG_RESULT(using ${systemdsysusersdir})
+	NUT_REPORT_PATH_INTEGRATIONS([Systemd-sysusers configs], [${systemdsysusersdir}])
+else
+	AC_MSG_RESULT(no)
+fi
+AM_CONDITIONAL([WITH_SYSTEMD_SYSUSERS], [test x"${systemdsysusersdir}" != "x"])
+dnl What pathname would we embed into unit files ExecStartPre?
+dnl TODO? Any need to make it a --with-... argument?
+AC_PATH_PROG([SYSTEMD_SYSUSERS_PROGRAM], [systemd-sysusers], [/usr/bin/systemd-sysusers])
+
 
 dnl Note: we may want binaries with sd_notify and similar features regardless
 dnl of building and delivering unit files (which may be crafted separately).
@@ -6207,6 +6247,7 @@ AC_SUBST(systemdsystemunitdir)
 AC_SUBST(systemdsystempresetdir)
 AC_SUBST(systemdshutdowndir)
 AC_SUBST(systemdtmpfilesdir)
+AC_SUBST(systemdsysusersdir)
 AC_SUBST(auglensdir)
 AC_SUBST(auglenstestsdir)
 AC_SUBST(hotplugdir)
@@ -6685,6 +6726,39 @@ EOF])
 ])
 AC_MSG_RESULT([done])
 
+dnl ---------------------------------------------------------------------
+AC_MSG_CHECKING([whether to customize ${TOP_BUILDDIR}/scripts/systemd/nut-common-sysusers.conf.in for this system])
+AS_IF([test -n "$systemdsysusersdir"],
+    [mkdir -p "${TOP_BUILDDIR}"/scripts/systemd
+     cat > "${TOP_BUILDDIR}"/scripts/systemd/nut-common-sysusers.conf.in << EOF
+# Network UPS Tools (NUT) systemd integration
+# Distributed under the terms of GPLv2+
+# See https://networkupstools.org/
+# and https://github.com/networkupstools/nut/
+EOF
+    AS_IF([test -n "${RUN_AS_USER}" && test x"${RUN_AS_USER}" != xnobody && test x"${RUN_AS_USER}" != xroot],
+        dnl Locked users ('!') are supported since v257
+        AS_IF([test x"$have_PKG_CONFIG" = xyes && $PKG_CONFIG --atleast-version=257 systemd 2>/dev/null], [
+            cat >> "${TOP_BUILDDIR}"/scripts/systemd/nut-common-sysusers.conf.in << EOF
+u! @RUN_AS_USER@ - - @STATEPATH@
+EOF
+        ], [
+            cat >> "${TOP_BUILDDIR}"/scripts/systemd/nut-common-sysusers.conf.in << EOF
+u @RUN_AS_USER@ - - @STATEPATH@
+EOF
+        ])
+    )
+    AS_IF([test -n "${RUN_AS_GROUP}" && test x"${RUN_AS_GROUP}" != xnobody && test x"${RUN_AS_GROUP}" != xnogroup && test x"${RUN_AS_GROUP}" != xroot],
+        [cat >> "${TOP_BUILDDIR}"/scripts/systemd/nut-common-sysusers.conf.in << EOF
+g @RUN_AS_GROUP@
+EOF])
+    AS_IF([test -n "${RUN_AS_USER}" && test x"${RUN_AS_USER}" != xnobody && test x"${RUN_AS_USER}" != xroot && test -n "${RUN_AS_GROUP}" && test x"${RUN_AS_GROUP}" != xnobody && test x"${RUN_AS_GROUP}" != xnogroup && test x"${RUN_AS_GROUP}" != xroot],
+        [cat >> "${TOP_BUILDDIR}"/scripts/systemd/nut-common-sysusers.conf.in << EOF
+m @RUN_AS_USER@ @RUN_AS_GROUP@
+EOF])
+])
+AC_MSG_RESULT([done])
+
 dnl # ccache versions 4.5 and newer support namespacing of the objects
 dnl # to facilitate more targeted eviction with --evict-namespace and
 dnl # perhaps --evict-older-than options. Here we bolt a namespace with
@@ -6888,6 +6962,7 @@ AC_CONFIG_FILES([
  scripts/systemd/Makefile
  scripts/systemd/nut.target
  scripts/systemd/nut-common-tmpfiles.conf
+ scripts/systemd/nut-common-sysusers.conf
  scripts/systemd/nut-driver.target
  scripts/systemd/nut-driver@.service
  scripts/systemd/nut-logger.service

docs/configure.txt

@@ -1123,11 +1123,13 @@ Use `--with-systemdshutdowndir` to detect the settings using pkg-config.
 Use `--with-systemdshutdowndir=no` to disable this feature altogether.
 
 	--with-systemdtmpfilesdir=PATH
+	--with-systemdsysusersdir=PATH
 
-Where to install Linux systemd configuration for tmpfiles handling (the
-automatically created locations for PID, state and similar run-time files).
-Useless and harmless on other OSes, including Linux distributions
-without systemd, just adding a little noise to configure script output.
+Where to install Linux systemd configuration for tmpfiles and sysusers
+handling (the automatically created locations for user/group, PID,
+state and similar run-time files). Useless and harmless on other OSes,
+including Linux distributions without systemd, just adding a little
+noise to configure script output.
 
 Use `--with-systemdtmpfilesdir` to detect the settings using pkg-config.
 

docs/nut.dict

@@ -3284,8 +3284,10 @@ systemd
 systemdshutdowndir
 systemdsystempresetdir
 systemdsystemunitdir
+systemdsysusersdir
 systemdtmpfilesdir
 systemtest
+sysusers
 sysutils
 sysvinit
 tagname

scripts/systemd/.gitignore

@@ -1,6 +1,8 @@
-# Note: nut-common-tmpfiles.conf.in is also generated, by configure script
+# Note: nut-common-tmpfiles.conf.in/nut-common-sysusers.conf.in are also generated, by configure script
 /nut-common-tmpfiles.conf.in
 /nut-common-tmpfiles.conf
+/nut-common-sysusers.conf.in
+/nut-common-sysusers.conf
 /nut.target
 # Singular nut-driver.service is obsolete, help with old build workspaces:
 /nut-driver.service

scripts/systemd/Makefile.am

@@ -26,6 +26,9 @@ endif !WITH_LIBSYSTEMD_INHIBITOR
 systemdtmpfiles_DATA = \
         nut-common-tmpfiles.conf
 
+systemdsysusers_DATA = \
+        nut-common-sysusers.conf
+
 systemdsystempreset_DATA = \
         nut-systemd.preset
 
@@ -50,7 +53,7 @@ EXTRA_DIST += \
 	nut-driver-enumerator-daemon-activator.service.in \
 	nut-driver-enumerator-daemon.service.in
 
-# NOTE: Do not EXTRA_DIST nut-common-tmpfiles.conf.in - it is generated per build
+# NOTE: Do not EXTRA_DIST nut-common-tmpfiles.conf.in/nut-common-sysusers.conf.in - they are generated per build
 endif !HAVE_SYSTEMD
 
 SPELLCHECK_SRC = README.adoc
@@ -80,4 +83,4 @@ CLEANFILES = *-spellchecked
 MAINTAINERCLEANFILES = Makefile.in .dirstamp
 
 # Generated by autogen.sh and needed to run the configure script:
-MAINTAINERCLEANFILES += nut-common-tmpfiles.conf.in
+MAINTAINERCLEANFILES += nut-common-tmpfiles.conf.in nut-common-sysusers.conf.in