chiark - git - mdw - exim-config/blob - spam.m4

   1 ### -*-m4-*-
   2 ###
   3 ### Spam filtering for distorted.org.uk Exim configuration
   4 ###
   5 ### (c) 2012 Mark Wooding
   6 ###
   7
   8 ###----- Licensing notice ---------------------------------------------------
   9 ###
  10 ### This program is free software; you can redistribute it and/or modify
  11 ### it under the terms of the GNU General Public License as published by
  12 ### the Free Software Foundation; either version 2 of the License, or
  13 ### (at your option) any later version.
  14 ###
  15 ### This program is distributed in the hope that it will be useful,
  16 ### but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ### MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ### GNU General Public License for more details.
  19 ###
  20 ### You should have received a copy of the GNU General Public License
  21 ### along with this program; if not, write to the Free Software Foundation,
  22 ### Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23
  24 DIVERT(null)
  25 ###--------------------------------------------------------------------------
  26 ### Spam filtering.
  27
  28 SECTION(global, policy)m4_dnl
  29 spamd_address = CONF_spamd_address CONF_spamd_port
  30
  31 SECTION(routers, allspam)m4_dnl
  32 ## If we're verifying an address and the recipient has a `~/.mail/spam-limit'
  33 ## file, then look up the recipient and sender addresses to find a plausible
  34 ## limit and insert it into the `address_data' where the RCPT ACL can find
  35 ## it.  This router always declines, so it doesn't affect the overall outcome
  36 ## of the verification.
  37 fetch_spam_limit:
  38         driver = redirect
  39         data = :unknown:
  40         verify_only = true
  41         local_part_suffix = CONF_user_suffix_list
  42         local_part_suffix_optional = true
  43         check_local_user
  44         address_data = \
  45                 ${if def:address_data {$address_data}{}} \
  46                 ${if exists {CONF_userconf_dir/spam-limit} \
  47                      {${lookup {$local_part_prefix\
  48                                         $local_part\
  49                                         $local_part_suffix\
  50                                         @$domain/\
  51                                         $sender_address} \
  52                                nwildlsearch {CONF_userconf_dir/spam-limit} \
  53                                {spam_limit=$value} \
  54                                {}}} \
  55                      {}} \
  56                 ${if exists {CONF_userconf_dir/spam-limit.userv} \
  57                      {${run {timeout 5s -- \
  58                                 userv $local_part exim-spam-limit \
  59                                         $sender_address \
  60                                         $local_part_prefix \
  61                                         $local_part \
  62                                         $local_part_suffix \
  63                                         @$domain} \
  64                             {${if match{$value}{\N^[0-9]+$\N} \
  65                                   {spam_limit=$value} \
  66                                   {}}} \
  67                             {}}} \
  68                      {}}
  69
  70 SECTION(acl, rcpt-hooks)m4_dnl
  71         ## Do per-recipient spam-filter processing.
  72         require  acl = rcpt_spam
  73
  74 SECTION(acl, misc)m4_dnl
  75 rcpt_spam:
  76
  77         ## If the client is trusted, don't bother with any of this.
  78         accept   hosts = +trusted
  79
  80         ## Collect the user's spam threshold from the `address_data'
  81         ## variable, where it was left by the `fetch_spam_limit' router
  82         ## during recipient verification.  (This just saves duplicating this
  83         ## enormous expression.)
  84         warn     set acl_m_this_spam_limit = \
  85                         ${sg {${extract {spam_limit} \
  86                                         {${if def:address_data \
  87                                               {$address_data}{}}} \
  88                                         {$value}{nil}}} \
  89                              {^(|.*\\D.*)\$}{CONF_spam_max}}
  90
  91         ## If there's a spam limit already established, and it's different
  92         ## from this user's limit, then the sender will have to try this user
  93         ## again later.
  94         defer   !hosts = +trusted
  95                  message = "You'd better try this one later"
  96                  condition = ${if def:acl_m_spam_limit {true}{false}}
  97                  condition = ${if ={$acl_m_spam_limit} \
  98                                    {$acl_m_this_spam_limit} \
  99                                   {false}{true}}
 100
 101         ## There's no limit set yet, or the user's limit is the same as the
 102         ## existing one, or the client's local and we're not checking for
 103         ## spam anyway.  Whichever way, it's safe to set it now.
 104         warn     set acl_m_spam_limit = $acl_m_this_spam_limit
 105
 106         ## All done.
 107         accept
 108
 109 SECTION(acl, data-spam)m4_dnl
 110         ## Do spam checking.
 111         require  acl = data_spam
 112
 113 SECTION(acl, misc)m4_dnl
 114 data_spam:
 115
 116         ## If the client is trusted, don't bother with any of this.
 117         accept   hosts = +trusted
 118
 119         ## Check header validity.
 120         require  verify = header_syntax
 121
 122         ## Check the message for spam, comparing to the configured limit.
 123         deny     spam = exim:true
 124                  message = Tinned meat product detected ($spam_score)
 125                  condition = ${if >{$spam_score_int}{$acl_m_spam_limit} \
 126                                   {true}{false}}
 127
 128         ## Insert headers from the spam check now that we've decided to
 129         ## accept the message.
 130         warn
 131                  ## Convert the limit (currently 10x fixed point) into a
 132                  ## decimal for presentation.
 133                  set acl_m_spam_limit_presentation = \
 134                         ${sg{$acl_m_spam_limit}{\N(\d)$\N}{.\$1}}
 135
 136                  ## Convert the report into something less obnoxious.  Plain
 137                  ## old SpamAssassin has an `X-Spam-Status' header which
 138                  ## lists the matched rules and provides some other basic
 139                  ## information.  Try to extract something similar from the
 140                  ## report.
 141                  ##
 142                  ## This is rather fiddly.
 143
 144                  ## Firstly, escape angle brackets, because we'll be using
 145                  ## them for our own purposes.
 146                  set acl_m_spam_tests = ${sg{$spam_report}{([!<>])}{!\$1}}
 147
 148                  ## Trim off the blurb paragraph and the preview.  The rest
 149                  ## should be fairly well behaved.  Wrap double angle-
 150                  ## brackets around the remainder; these can't appear in the
 151                  ## body because we escaped them all earlier.
 152                  set acl_m_spam_tests = \
 153                         ${sg{$acl_m_spam_tests} \
 154                             {\N^(?s).*\n Content analysis details:(.*)$\N} \
 155                             {<<\$1>>}}
 156
 157                  ## Extract the information about the matching rules and
 158                  ## their scores.  Leave `<<...>>' around everything else.
 159                  set acl_m_spam_tests = \
 160                         ${sg{$acl_m_spam_tests} \
 161                             {\N(?s)\n\s*([\d.]+)\s+([-\w]+)\s\N} \
 162                             {>>\$2:\$1,<<}}
 163
 164                  ## Strip everything still in `<<...>>' pairs, including any
 165                  ## escaped characters inside.
 166                  set acl_m_spam_tests = \
 167                         ${sg{$acl_m_spam_tests}{\N(?s)<<([^!>]+|!.)*>>\N}{}}
 168
 169                  ## Trim off a trailing comma.
 170                  set acl_m_spam_tests = ${sg{$acl_m_spam_tests}{,\s*\$}{}}
 171
 172                  ## Undo the escaping.
 173                  set acl_m_spam_tests = ${sg{$acl_m_spam_tests}{!(.)}{\$1}}
 174
 175                  ## Insert the headers.
 176                  add_header = X-SpamAssassin-Score: \
 177                         $spam_score/$acl_m_spam_limit_presentation \
 178                         ($spam_bar)
 179                  add_header = X-SpamAssassin-Status: \
 180                         score=$spam_score, \
 181                         limit=$acl_m_spam_limit_presentation, \n\t\
 182                         tests=$acl_m_spam_tests
 183
 184
 185         ## We're good.
 186         accept
 187
 188 DIVERT(null)
 189 ###----- That's all, folks --------------------------------------------------