changeset 387:9921352225a9

Weekly periodic script to execute an action when any of given files are readable. Intended to trigger host-level actions after certbot actions in jails.
author Franz Glasner <fzglas.hg@dom66.de>
date Thu, 23 Feb 2023 09:08:20 +0100
parents 84d2735fe7f6
children 06fbd3c0f566
files Makefile docs/man/man8/local-bsdtools.rst etc/periodic/weekly/800.local-certbot-post-deploy pkg-plist
diffstat 4 files changed, 98 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/Makefile	Thu Feb 23 01:08:31 2023 +0100
+++ b/Makefile	Thu Feb 23 09:08:20 2023 +0100
@@ -52,7 +52,8 @@
 	${SED} -i "" -e "s|@@SIMPLEVERSIONSTR@@|${SIMPLEVERSIONSTR}|" ${WRKSRC}/${_rp}
 .endfor
 	${MKDIR} ${WRKSRC}/etc/periodic/daily
-.for _ef in etc/package-mapping.conf.sample etc/pkgtools.conf.sample etc/bsmtp2dma.conf.sample etc/periodic/daily/800.local-ipv6-refresh etc/periodic/daily/750.local-trim-zfs
+	${MKDIR} ${WRKSRC}/etc/periodic/weekly
+.for _ef in etc/package-mapping.conf.sample etc/pkgtools.conf.sample etc/bsmtp2dma.conf.sample etc/periodic/daily/800.local-ipv6-refresh etc/periodic/daily/750.local-trim-zfs etc/periodic/weekly/800.local-certbot-post-deploy
 	${CP} -v ${SRC}/${_ef} ${WRKSRC}/${_ef}
 	${SED} -i "" -e "s|@@SIMPLEVERSIONTAG@@|${SIMPLEVERSIONTAG}|" ${WRKSRC}/${_ef}
 .endfor
@@ -83,6 +84,10 @@
 .for _ps in 800.local-ipv6-refresh 750.local-trim-zfs
 	${INSTALL_SCRIPT} ${WRKSRC}/etc/periodic/daily/${_ps} ${STAGEDIR}${PREFIX}/etc/periodic/daily
 .endfor
+	${MKDIR} ${STAGEDIR}${PREFIX}/etc/periodic/weekly
+.for _ps in 800.local-certbot-post-deploy
+	${INSTALL_SCRIPT} ${WRKSRC}/etc/periodic/weekly/${_ps} ${STAGEDIR}${PREFIX}/etc/periodic/weekly
+.endfor
 
 post-install-DOCS-on:
 .for _mp in ${MANPAGES8:R}
--- a/docs/man/man8/local-bsdtools.rst	Thu Feb 23 01:08:31 2023 +0100
+++ b/docs/man/man8/local-bsdtools.rst	Thu Feb 23 09:08:20 2023 +0100
@@ -19,12 +19,17 @@
 - creating, installing and updating "thin jails"
 - recursively mounting of ZFS dataset hierarchies
 
-The package contains also a set of (daily) periodic scripts to
+The package contains also a set of daily periodic scripts to
 
 - trim ZFS pools
 - update the IPv6 neighbour cache
 
-The periodic scripts are disabled by default.
+The package contains also a set of weekly periodic scripts to
+
+- handle certbot post deploy actions
+  
+
+All the periodic scripts are disabled by default.
 
 
 See Also
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/etc/periodic/weekly/800.local-certbot-post-deploy	Thu Feb 23 09:08:20 2023 +0100
@@ -0,0 +1,84 @@
+#!/bin/sh
+# -*- indent-tabs-mode: nil; -*-
+#
+# @(#)@@SIMPLEVERSIONTAG@@
+#
+# Weekly script to indirectly trigger post deploy actions
+#
+# Must be executed **after** 500.certbot.
+# Otherwise an extra week of delay is encountered.
+#
+
+# If there is a global system configuration file, suck it in.
+if [ -r /etc/defaults/periodic.conf ]
+then
+    . /etc/defaults/periodic.conf
+    source_periodic_confs
+fi
+
+: ${weekly_local_certbot_post_deploy_enable:=NO}
+: ${weekly_local_certbot_post_deploy_files:=}
+# e.g. "service nginx onestatus"
+: ${weekly_local_certbot_post_deploy_condition:=}
+# e.g. "service nginx reload"
+: ${weekly_local_certbot_post_deploy_action:=}
+: ${weekly_local_certbot_post_deploy_files_remove:=YES}
+
+case "${weekly_local_certbot_post_deploy_enable}" in
+    [Yy][Ee][Ss])
+        echo
+        echo "Testing for newly renewed Let's Encrypt certificates"
+
+        rc=0
+
+        _do_action=""
+        _remove_files=""
+
+        for _f in ${weekly_local_certbot_post_deploy_files}; do
+            if [ -r "${_f}" ]; then
+                _do_action="yes"
+                case "${weekly_local_certbot_post_deploy_files_remove}" in
+                    [Yy][Ee][Ss])
+                        _remove_files="${_remove_files} ${_f}"
+                        ;;
+                esac
+            fi
+        done
+
+        if [ "${_do_action}" = "yes" ]; then
+            if [ -z "${weekly_local_certbot_post_deploy_action}" ]; then
+                echo "ERROR: no deploy action defined" 1>&2
+                exit 2
+            fi
+
+            echo "Deploying newly renewed Let's Encrypt certificates"
+            if [ -n "${weekly_local_certbot_post_deploy_condition}" ]; then
+                if ${weekly_local_certbot_post_deploy_condition} ; then
+                    ${weekly_local_certbot_post_deploy_action}
+                    rc=$?
+                else
+                    rc=1
+                fi
+            else
+                ${weekly_local_certbot_post_deploy_action}
+                rc=$?
+            fi
+
+            # Remove trigger files if configured to do so
+            if [ ${rc} -eq 0 ]; then
+                echo "Removing trigger files..."
+                for _rf in ${_remove_files}; do
+                    rm -fv "${_rf}"
+                done
+            fi
+        else
+            echo "No newly renewed Let's Encrypt certificates found"
+        fi
+        ;;
+
+    *)
+        rc=0
+        ;;
+esac
+
+exit ${rc}
--- a/pkg-plist	Thu Feb 23 01:08:31 2023 +0100
+++ b/pkg-plist	Thu Feb 23 09:08:20 2023 +0100
@@ -1,6 +1,7 @@
 @comment FILES
 etc/periodic/daily/750.local-trim-zfs
 etc/periodic/daily/800.local-ipv6-refresh
+etc/periodic/weekly/800.local-certbot-post-deploy
 sbin/bsmtp2dma
 sbin/check-ports
 sbin/fjail