From d046ab5b57a662678b169eaa9c5c2edcc7c1450d Mon Sep 17 00:00:00 2001
From: Brennan Kinney <5098581+polarathene@users.noreply.github.com>
Date: Sat, 15 Feb 2025 21:24:40 +1300
Subject: [PATCH] chore: Add notes for legacy packages

---
 .../scripts/startup/setup.d/dmarc_dkim_spf.sh | 40 ++++++++++++++++++-
 .../scripts/startup/setup.d/security/misc.sh  | 36 +++++++++++++++++
 2 files changed, 75 insertions(+), 1 deletion(-)

diff --git a/target/scripts/startup/setup.d/dmarc_dkim_spf.sh b/target/scripts/startup/setup.d/dmarc_dkim_spf.sh
index c0d731f2..00700cad 100644
--- a/target/scripts/startup/setup.d/dmarc_dkim_spf.sh
+++ b/target/scripts/startup/setup.d/dmarc_dkim_spf.sh
@@ -1,5 +1,39 @@
 #!/bin/bash
 
+# Legacy service support for DKIM, DMARC, SPF
+# TODO: Migrate this file into a common legacy feature dir
+
+# Debian 12 package: opendkim 2.11.0
+# https://salsa.debian.org/debian/opendkim
+# Official project page (no HTTPS available):
+# http://www.opendkim.org/
+# Links to SourceForge for project source which directs users to Github:
+# Last commit Dec 2022:
+# https://github.com/trusteddomainproject/OpenDKIM/tree/develop
+# Last release 2.11.0 (Nov 2018):
+# https://github.com/trusteddomainproject/OpenDKIM/releases
+
+# Debian 12 package: opendmarc 1.4.2
+# https://salsa.debian.org/kitterman/opendmarc
+# Official project page (no HTTPS available):
+# http://www.trusteddomain.org/opendmarc/
+# Links to SourceForge for project source which directs users to Github (since April 2021):
+# Last commit Dec 2021:
+# https://github.com/trusteddomainproject/OpenDMARC/branches/all
+# Last release 1.4.2 (Dec 2021):
+# https://github.com/trusteddomainproject/OpenDMARC/blob/master/RELEASE_NOTES
+
+# Debian 12 package: postfix-policyd-spf-python 3.0.4 (April 2023)
+# https://salsa.debian.org/python-team/packages/spf-engine
+# Previously `policyd-spf` until Dec 2016, then renamed to `spf-engine`:
+# https://launchpad.net/pypolicyd-spf
+# https://salsa.debian.org/kitterman/postfix-policyd-spf-perl
+# Official project page + repo:
+# https://code.launchpad.net/spf-engine
+# Last commit and release 3.1.0 (Aug 2024):
+# https://git.launchpad.net/spf-engine/
+
+
 # Set up OpenDKIM
 #
 # ## Attention
@@ -23,7 +57,11 @@ function _setup_opendkim() {
     # check if any keys are available
     if [[ -e /tmp/docker-mailserver/opendkim/KeyTable ]]; then
       cp -a /tmp/docker-mailserver/opendkim/* /etc/opendkim/
-      _log 'trace' "DKIM keys added for: $(find /etc/opendkim/keys/ -maxdepth 1 -type f -printf '%f ')"
+
+      local DKIM_DOMAINS
+      DKIM_DOMAINS=$(find /etc/opendkim/keys/ -maxdepth 1 -type f -printf '%f ')
+      _log 'trace' "DKIM keys added for: ${DKIM_DOMAINS}"
+
       chown -R opendkim:opendkim /etc/opendkim/
       chmod -R 0700 /etc/opendkim/keys/
     else
diff --git a/target/scripts/startup/setup.d/security/misc.sh b/target/scripts/startup/setup.d/security/misc.sh
index 444589df..453cad07 100644
--- a/target/scripts/startup/setup.d/security/misc.sh
+++ b/target/scripts/startup/setup.d/security/misc.sh
@@ -1,5 +1,41 @@
 #!/bin/bash
 
+# Legacy service support with Postgrey, SpamAssassin, Amavis
+# TODO: Migrate these services into a common legacy feature dir
+
+# Debian 12 package: postgrey 1.37
+# https://salsa.debian.org/debian/postgrey
+# Official project page:
+# https://postgrey.schweikert.ch/
+# Last commit Feb 2024 (mostly whitelist updates since 2016):
+# https://github.com/schweikert/postgrey
+# Last release 1.37 (Sep 2016):
+# https://github.com/schweikert/postgrey/tags
+
+# Debian 12 package: spamassassin 4.0.0 (Dec 2022)
+# Lack of 4.0.1 potentially causing regression/bugs in DMS v14+
+# https://salsa.debian.org/debian/spamassassin
+# Official project page:
+# https://spamassassin.apache.org/
+# NOTE: Github repo is a mirror (antiquated process for contributions/reports)
+# Last commit Feb 2025:
+# https://github.com/apache/spamassassin
+# Last release 4.0.1 (March 2024):
+# https://github.com/apache/spamassassin/tags
+
+# Debian 12 package: amavisd-new 2.13.0 (Jan 2023)
+# https://salsa.debian.org/debian/amavisd-new
+# Official project page:
+# https://www.ijs.si/software/amavisd/
+# https://www.amavis.org/
+# Last announced release 2.11.0 (2016) + 2.11.1 (Oct 2018):
+# https://www.ijs.si/software/amavisd/release-notes.txt
+# Development migrated to Gitlab with release 2.12.0 (July 2019)
+# Last commit Feb 2025:
+# https://gitlab.com/amavis/amavis
+# Last release 2.13.1 (March 2024):
+# https://gitlab.com/amavis/amavis/-/tags
+
 function _setup_security_stack() {
   _log 'debug' 'Setting up Security Stack'