Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add SpamAssassin KAM #2418

Merged
merged 11 commits into from
Feb 21, 2022
Merged

Add SpamAssassin KAM #2418

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
a097020
add SpamAssassin KAM
georglauterbach Feb 18, 2022
66a0ea5
Add documentation for the KAM change
georglauterbach Feb 18, 2022
687cae2
Apply suggestions from code review
georglauterbach Feb 18, 2022
0be5e24
made `0` the default and correct mistake in Dockerfile
georglauterbach Feb 18, 2022
96c0c69
Update default (0) in `mailserver.evv` too
georglauterbach Feb 18, 2022
dd2aaed
re-add description in `mailserver.env`
georglauterbach Feb 18, 2022
a0d25cc
Apply suggestions from code review
georglauterbach Feb 19, 2022
c4c2ae7
Update target/scripts/startup/setup-stack.sh
georglauterbach Feb 19, 2022
14fc012
Merge branch 'master' into feature/add-SA-KAM
georglauterbach Feb 19, 2022
5e61fe6
Update target/scripts/startup/setup-stack.sh
georglauterbach Feb 20, 2022
1fa81ef
Update target/scripts/startup/setup-stack.sh
georglauterbach Feb 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 5 additions & 1 deletion Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,11 @@ COPY \
# hadolint ignore=SC2016
RUN \
sedfile -i -r 's/^(CRON)=0/\1=1/g' /etc/default/spamassassin && \
sedfile -i -r 's/^\$INIT restart/supervisorctl restart amavis/g' /etc/spamassassin/sa-update-hooks.d/amavisd-new
sedfile -i -r 's/^\$INIT restart/supervisorctl restart amavis/g' \
/etc/spamassassin/sa-update-hooks.d/amavisd-new && \
mkdir -p /etc/spamassassin/kam/ && \
curl -sSfLo /etc/spamassassin/kam/kam.sa-channels.mcgrail.com.key \
https://mcgrail.com/downloads/kam.sa-channels.mcgrail.com.key

# -----------------------------------------------
# --- PostSRSD, Postgrey & Amavis ---------------
Expand Down
16 changes: 12 additions & 4 deletions docs/content/config/environment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -345,16 +345,24 @@ Finally the logrotate interval **may** affect the period for generated reports.

##### SPAMASSASSIN_SPAM_TO_INBOX

- **1** => Spam messages will be delivered to the inbox and tagged as spam using `SA_SPAM_SUBJECT`.
- 0 => Spam messages will be bounced (_rejected_) without any notification (_dangerous_).
- **1** => Spam messages will be delivered to the inbox and tagged as spam using `SA_SPAM_SUBJECT`.

##### MOVE_SPAM_TO_JUNK
##### ENABLE_SPAMASSASSIN_KAM

- **1** => Spam messages will be delivered in the `Junk` folder.
- 0 => Spam messages will be delivered in the mailbox.
[KAM](https://mcgrail.com/template/projects#KAM1) is a 3rd party SpamAssassin ruleset, provided by the McGrail Foundation. If SpamAssassin is enabled, KAM can be used in addition to the default ruleset.

- **0** => KAM disabled
- 1 => KAM enabled

##### MOVE_SPAM_TO_JUNK

Spam messages can be moved in the Junk folder.
Note: this setting needs `SPAMASSASSIN_SPAM_TO_INBOX=1`

- 0 => Spam messages will be delivered in the mailbox.
- **1** => Spam messages will be delivered in the `Junk` folder.

##### SA_TAG

- **2.0** => add spam info headers if at, or above that level
Expand Down
10 changes: 9 additions & 1 deletion mailserver.env
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,15 @@ ENABLE_SPAMASSASSIN=0
# deliver spam messages in the inbox (eventually tagged using SA_SPAM_SUBJECT)
SPAMASSASSIN_SPAM_TO_INBOX=1

# spam messages will be moved in the Junk folder (SPAMASSASSIN_SPAM_TO_INBOX=1 required)
# KAM is a 3rd party SpamAssassin ruleset, provided by the McGrail Foundation.
# If SpamAssassin is enabled, KAM can be used in addition to the default ruleset.
# - **0** => KAM disabled
# - 1 => KAM enabled
#
# Note: only has an effect if `ENABLE_SPAMASSASSIN=1`
ENABLE_SPAMASSASSIN_KAM=0

# this setting needs `SPAMASSASSIN_SPAM_TO_INBOX=1`
MOVE_SPAM_TO_JUNK=1

# add spam info headers if at, or above that level:
Expand Down
1 change: 1 addition & 0 deletions target/scripts/start-mailserver.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ VARS[ENABLE_POSTGREY]="${ENABLE_POSTGREY:=0}"
VARS[ENABLE_QUOTAS]="${ENABLE_QUOTAS:=1}"
VARS[ENABLE_SASLAUTHD]="${ENABLE_SASLAUTHD:=0}"
VARS[ENABLE_SPAMASSASSIN]="${ENABLE_SPAMASSASSIN:=0}"
VARS[ENABLE_SPAMASSASSIN_KAM]="${ENABLE_SPAMASSASSIN_KAM:=0}"
VARS[ENABLE_SRS]="${ENABLE_SRS:=0}"
VARS[ENABLE_UPDATE_CHECK]="${ENABLE_UPDATE_CHECK:=1}"
VARS[FAIL2BAN_BLOCKTYPE]="${FAIL2BAN_BLOCKTYPE:=drop}"
Expand Down
17 changes: 17 additions & 0 deletions target/scripts/startup/setup-stack.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -960,6 +960,23 @@ function _setup_security_stack
sed -i "s|\$final_spam_destiny.*=.*$|\$final_spam_destiny = D_BOUNCE;|g" /etc/amavis/conf.d/49-docker-mailserver
sed -i "s|\$final_bad_header_destiny.*=.*$|\$final_bad_header_destiny = D_BOUNCE;|g" /etc/amavis/conf.d/49-docker-mailserver
fi

if [[ ${ENABLE_SPAMASSASSIN_KAM} -eq 1 ]]
then
_notify 'inf' 'Configuring Spamassassin KAM'
local SPAMASSASSIN_KAM_CRON_FILE=/etc/cron.daily/spamassassin_kam

sa-update --import /etc/spamassassin/kam/kam.sa-channels.mcgrail.com.key
cat >"${SPAMASSASSIN_KAM_CRON_FILE}" <<"EOM"
#! /bin/bash

sa-update --gpgkey 24C063D8 --channel kam.sa-channels.mcgrail.com && \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the GPG key is a bit small, could a full one be used ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you find the complete key, please, feel free to open a PR :D

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://mcgrail.com/template/kam.cf_channel
I will let you do it if you want ;)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link you posted shows the very same key this PR uses...

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, but for some reason they do use a short version.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this to be fine :D

/etc/init.d/spamassassin reload

EOM

chmod +x "${SPAMASSASSIN_KAM_CRON_FILE}"
georglauterbach marked this conversation as resolved.
Show resolved Hide resolved
fi
fi

# Clamav
Expand Down