2014-04-14 15:26:48 +01:00
|
|
|
{ config, lib, pkgs, ... }:
|
2012-08-03 14:11:28 +01:00
|
|
|
|
2014-04-14 15:26:48 +01:00
|
|
|
with lib;
|
2012-08-03 14:11:28 +01:00
|
|
|
|
|
|
|
let
|
|
|
|
cfg = config.services.spamassassin;
|
2017-06-10 08:35:35 +01:00
|
|
|
spamassassin-local-cf = pkgs.writeText "local.cf" cfg.config;
|
|
|
|
|
2012-08-03 14:11:28 +01:00
|
|
|
in
|
|
|
|
|
|
|
|
{
|
|
|
|
options = {
|
|
|
|
|
|
|
|
services.spamassassin = {
|
|
|
|
enable = mkOption {
|
|
|
|
default = false;
|
2017-06-10 08:35:35 +01:00
|
|
|
description = "Whether to run the SpamAssassin daemon";
|
2012-08-03 14:11:28 +01:00
|
|
|
};
|
|
|
|
|
2012-09-27 16:12:25 +01:00
|
|
|
debug = mkOption {
|
|
|
|
default = false;
|
2017-06-10 08:35:35 +01:00
|
|
|
description = "Whether to run the SpamAssassin daemon in debug mode";
|
2012-09-27 16:12:25 +01:00
|
|
|
};
|
|
|
|
|
2017-06-10 08:35:35 +01:00
|
|
|
config = mkOption {
|
|
|
|
type = types.lines;
|
|
|
|
description = ''
|
|
|
|
The SpamAssassin local.cf config
|
|
|
|
|
|
|
|
If you are using this configuration:
|
|
|
|
add_header all Status _YESNO_, score=_SCORE_ required=_REQD_ tests=_TESTS_ autolearn=_AUTOLEARN_ version=_VERSION_
|
|
|
|
|
|
|
|
Then you can Use this sieve filter:
|
|
|
|
require ["fileinto", "reject", "envelope"];
|
2017-09-27 13:37:56 +01:00
|
|
|
|
2017-06-10 08:35:35 +01:00
|
|
|
if header :contains "X-Spam-Flag" "YES" {
|
|
|
|
fileinto "spam";
|
|
|
|
}
|
|
|
|
|
|
|
|
Or this procmail filter:
|
|
|
|
:0:
|
|
|
|
* ^X-Spam-Flag: YES
|
|
|
|
/var/vpopmail/domains/lastlog.de/js/.maildir/.spam/new
|
|
|
|
|
|
|
|
To filter your messages based on the additional mail headers added by spamassassin.
|
|
|
|
'';
|
|
|
|
example = ''
|
|
|
|
#rewrite_header Subject [***** SPAM _SCORE_ *****]
|
|
|
|
required_score 5.0
|
|
|
|
use_bayes 1
|
|
|
|
bayes_auto_learn 1
|
|
|
|
add_header all Status _YESNO_, score=_SCORE_ required=_REQD_ tests=_TESTS_ autolearn=_AUTOLEARN_ version=_VERSION_
|
|
|
|
'';
|
|
|
|
default = "";
|
|
|
|
};
|
2012-08-03 14:11:28 +01:00
|
|
|
|
2017-06-10 08:35:35 +01:00
|
|
|
initPreConf = mkOption {
|
2019-12-24 22:19:05 +00:00
|
|
|
type = with types; either str path;
|
2017-06-10 08:35:35 +01:00
|
|
|
description = "The SpamAssassin init.pre config.";
|
2019-12-24 22:19:05 +00:00
|
|
|
apply = val: if builtins.isPath val then val else pkgs.writeText "init.pre" val;
|
2017-09-27 13:37:56 +01:00
|
|
|
default =
|
|
|
|
''
|
2017-06-10 08:35:35 +01:00
|
|
|
#
|
|
|
|
# to update this list, run this command in the rules directory:
|
2017-09-27 13:37:56 +01:00
|
|
|
# grep 'loadplugin.*Mail::SpamAssassin::Plugin::.*' -o -h * | sort | uniq
|
2017-06-10 08:35:35 +01:00
|
|
|
#
|
|
|
|
|
|
|
|
#loadplugin Mail::SpamAssassin::Plugin::AccessDB
|
|
|
|
#loadplugin Mail::SpamAssassin::Plugin::AntiVirus
|
|
|
|
loadplugin Mail::SpamAssassin::Plugin::AskDNS
|
|
|
|
# loadplugin Mail::SpamAssassin::Plugin::ASN
|
|
|
|
loadplugin Mail::SpamAssassin::Plugin::AutoLearnThreshold
|
|
|
|
#loadplugin Mail::SpamAssassin::Plugin::AWL
|
|
|
|
loadplugin Mail::SpamAssassin::Plugin::Bayes
|
|
|
|
loadplugin Mail::SpamAssassin::Plugin::BodyEval
|
|
|
|
loadplugin Mail::SpamAssassin::Plugin::Check
|
|
|
|
#loadplugin Mail::SpamAssassin::Plugin::DCC
|
|
|
|
loadplugin Mail::SpamAssassin::Plugin::DKIM
|
|
|
|
loadplugin Mail::SpamAssassin::Plugin::DNSEval
|
|
|
|
loadplugin Mail::SpamAssassin::Plugin::FreeMail
|
|
|
|
loadplugin Mail::SpamAssassin::Plugin::Hashcash
|
|
|
|
loadplugin Mail::SpamAssassin::Plugin::HeaderEval
|
|
|
|
loadplugin Mail::SpamAssassin::Plugin::HTMLEval
|
|
|
|
loadplugin Mail::SpamAssassin::Plugin::HTTPSMismatch
|
|
|
|
loadplugin Mail::SpamAssassin::Plugin::ImageInfo
|
|
|
|
loadplugin Mail::SpamAssassin::Plugin::MIMEEval
|
|
|
|
loadplugin Mail::SpamAssassin::Plugin::MIMEHeader
|
|
|
|
# loadplugin Mail::SpamAssassin::Plugin::PDFInfo
|
|
|
|
#loadplugin Mail::SpamAssassin::Plugin::PhishTag
|
|
|
|
loadplugin Mail::SpamAssassin::Plugin::Pyzor
|
|
|
|
loadplugin Mail::SpamAssassin::Plugin::Razor2
|
|
|
|
# loadplugin Mail::SpamAssassin::Plugin::RelayCountry
|
|
|
|
loadplugin Mail::SpamAssassin::Plugin::RelayEval
|
|
|
|
loadplugin Mail::SpamAssassin::Plugin::ReplaceTags
|
|
|
|
# loadplugin Mail::SpamAssassin::Plugin::Rule2XSBody
|
|
|
|
# loadplugin Mail::SpamAssassin::Plugin::Shortcircuit
|
|
|
|
loadplugin Mail::SpamAssassin::Plugin::SpamCop
|
|
|
|
loadplugin Mail::SpamAssassin::Plugin::SPF
|
|
|
|
#loadplugin Mail::SpamAssassin::Plugin::TextCat
|
|
|
|
# loadplugin Mail::SpamAssassin::Plugin::TxRep
|
|
|
|
loadplugin Mail::SpamAssassin::Plugin::URIDetail
|
|
|
|
loadplugin Mail::SpamAssassin::Plugin::URIDNSBL
|
|
|
|
loadplugin Mail::SpamAssassin::Plugin::URIEval
|
|
|
|
# loadplugin Mail::SpamAssassin::Plugin::URILocalBL
|
|
|
|
loadplugin Mail::SpamAssassin::Plugin::VBounce
|
|
|
|
loadplugin Mail::SpamAssassin::Plugin::WhiteListSubject
|
|
|
|
loadplugin Mail::SpamAssassin::Plugin::WLBLEval
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
};
|
2012-08-03 14:11:28 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
config = mkIf cfg.enable {
|
2019-12-24 22:15:05 +00:00
|
|
|
environment.etc."mail/spamassassin/init.pre".source = cfg.initPreConf;
|
|
|
|
environment.etc."mail/spamassassin/local.cf".source = spamassassin-local-cf;
|
2012-08-03 14:11:28 +01:00
|
|
|
|
2012-08-03 17:07:06 +01:00
|
|
|
# Allow users to run 'spamc'.
|
2019-12-24 22:15:05 +00:00
|
|
|
environment.systemPackages = [ pkgs.spamassassin ];
|
2012-08-03 14:11:28 +01:00
|
|
|
|
2019-09-14 18:51:29 +01:00
|
|
|
users.users.spamd = {
|
2012-09-27 23:06:52 +01:00
|
|
|
description = "Spam Assassin Daemon";
|
|
|
|
uid = config.ids.uids.spamd;
|
|
|
|
group = "spamd";
|
|
|
|
};
|
|
|
|
|
2019-09-14 18:51:29 +01:00
|
|
|
users.groups.spamd = {
|
2012-09-27 23:06:52 +01:00
|
|
|
gid = config.ids.gids.spamd;
|
|
|
|
};
|
2012-08-28 15:27:28 +01:00
|
|
|
|
2017-06-10 08:35:35 +01:00
|
|
|
systemd.services.sa-update = {
|
|
|
|
script = ''
|
2017-09-27 13:37:56 +01:00
|
|
|
set +e
|
2019-12-24 22:15:05 +00:00
|
|
|
${pkgs.su}/bin/su -s "${pkgs.bash}/bin/bash" -c "${pkgs.spamassassin}/bin/sa-update --gpghomedir=/var/lib/spamassassin/sa-update-keys/" spamd
|
2017-06-10 08:35:35 +01:00
|
|
|
|
|
|
|
v=$?
|
|
|
|
set -e
|
|
|
|
if [ $v -gt 1 ]; then
|
|
|
|
echo "sa-update execution error"
|
|
|
|
exit $v
|
|
|
|
fi
|
|
|
|
if [ $v -eq 0 ]; then
|
|
|
|
systemctl reload spamd.service
|
|
|
|
fi
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
2017-09-27 13:37:56 +01:00
|
|
|
systemd.timers.sa-update = {
|
2017-06-10 08:35:35 +01:00
|
|
|
description = "sa-update-service";
|
|
|
|
partOf = [ "sa-update.service" ];
|
|
|
|
wantedBy = [ "timers.target" ];
|
|
|
|
timerConfig = {
|
|
|
|
OnCalendar = "1:*";
|
|
|
|
Persistent = true;
|
|
|
|
};
|
|
|
|
};
|
|
|
|
|
2016-01-06 06:50:18 +00:00
|
|
|
systemd.services.spamd = {
|
2012-08-03 14:11:28 +01:00
|
|
|
description = "Spam Assassin Server";
|
2013-01-24 17:34:13 +00:00
|
|
|
|
|
|
|
wantedBy = [ "multi-user.target" ];
|
|
|
|
after = [ "network.target" ];
|
|
|
|
|
2017-06-10 08:35:35 +01:00
|
|
|
serviceConfig = {
|
2019-12-24 22:15:05 +00:00
|
|
|
ExecStart = "${pkgs.spamassassin}/bin/spamd ${optionalString cfg.debug "-D"} --username=spamd --groupname=spamd --virtual-config-dir=/var/lib/spamassassin/user-%u --allow-tell --pidfile=/run/spamd.pid";
|
2017-06-10 08:35:35 +01:00
|
|
|
ExecReload = "${pkgs.coreutils}/bin/kill -HUP $MAINPID";
|
|
|
|
};
|
|
|
|
|
|
|
|
# 0 and 1 no error, exitcode > 1 means error:
|
|
|
|
# https://spamassassin.apache.org/full/3.1.x/doc/sa-update.html#exit_codes
|
|
|
|
preStart = ''
|
|
|
|
echo "Recreating '/var/lib/spamasassin' with creating '3.004001' (or similar) and 'sa-update-keys'"
|
|
|
|
mkdir -p /var/lib/spamassassin
|
|
|
|
chown spamd:spamd /var/lib/spamassassin -R
|
2017-09-27 13:37:56 +01:00
|
|
|
set +e
|
2019-12-24 22:15:05 +00:00
|
|
|
${pkgs.su}/bin/su -s "${pkgs.bash}/bin/bash" -c "${pkgs.spamassassin}/bin/sa-update --gpghomedir=/var/lib/spamassassin/sa-update-keys/" spamd
|
2017-06-10 08:35:35 +01:00
|
|
|
v=$?
|
|
|
|
set -e
|
|
|
|
if [ $v -gt 1 ]; then
|
|
|
|
echo "sa-update execution error"
|
|
|
|
exit $v
|
|
|
|
fi
|
|
|
|
chown spamd:spamd /var/lib/spamassassin -R
|
|
|
|
'';
|
2012-08-03 14:11:28 +01:00
|
|
|
};
|
|
|
|
};
|
|
|
|
}
|