Mercurial > dnsbl
annotate xml/dnsbl.in @ 283:7438f79afeb0
Added tag stable-6-0-38 for changeset e276180647ab
| author | Carl Byington <carl@five-ten-sg.com> |
|---|---|
| date | Tue, 24 Dec 2013 08:22:01 -0800 |
| parents | 368572c57013 |
| children | 896b9393d3f0 |
| rev | line source |
|---|---|
| 108 | 1 <reference> |
| 2 <title>@PACKAGE@ Sendmail milter - Version @VERSION@</title> | |
| 3 <partintro> | |
| 4 <title>Packages</title> | |
|
201
752d4315675c
add reference to mercurial repository in the documentation
Carl Byington <carl@five-ten-sg.com>
parents:
187
diff
changeset
|
5 |
| 108 | 6 <para>The various source and binary packages are available at <ulink |
|
201
752d4315675c
add reference to mercurial repository in the documentation
Carl Byington <carl@five-ten-sg.com>
parents:
187
diff
changeset
|
7 url="http://www.five-ten-sg.com/@PACKAGE@/packages/">http://www.five-ten-sg.com/@PACKAGE@/packages/</ulink>. |
| 108 | 8 The most recent documentation is available at <ulink |
|
201
752d4315675c
add reference to mercurial repository in the documentation
Carl Byington <carl@five-ten-sg.com>
parents:
187
diff
changeset
|
9 url="http://www.five-ten-sg.com/@PACKAGE@/">http://www.five-ten-sg.com/@PACKAGE@/</ulink>. |
|
752d4315675c
add reference to mercurial repository in the documentation
Carl Byington <carl@five-ten-sg.com>
parents:
187
diff
changeset
|
10 </para> |
|
752d4315675c
add reference to mercurial repository in the documentation
Carl Byington <carl@five-ten-sg.com>
parents:
187
diff
changeset
|
11 |
|
752d4315675c
add reference to mercurial repository in the documentation
Carl Byington <carl@five-ten-sg.com>
parents:
187
diff
changeset
|
12 <para>A <ulink |
|
752d4315675c
add reference to mercurial repository in the documentation
Carl Byington <carl@five-ten-sg.com>
parents:
187
diff
changeset
|
13 url="http://www.selenic.com/mercurial/wiki/">Mercurial</ulink> source |
|
752d4315675c
add reference to mercurial repository in the documentation
Carl Byington <carl@five-ten-sg.com>
parents:
187
diff
changeset
|
14 code repository for this project is available at <ulink |
|
752d4315675c
add reference to mercurial repository in the documentation
Carl Byington <carl@five-ten-sg.com>
parents:
187
diff
changeset
|
15 url="http://hg.five-ten-sg.com/@PACKAGE@/">http://hg.five-ten-sg.com/@PACKAGE@/</ulink>. |
| 108 | 16 </para> |
| 94 | 17 |
| 108 | 18 </partintro> |
| 94 | 19 |
| 108 | 20 <refentry id="@PACKAGE@.1"> |
| 21 <refentryinfo> | |
|
270
f92f24950bd3
Use mozilla prefix list for tld checking, Enable surbl/uribl/dbl rhs lists
Carl Byington <carl@five-ten-sg.com>
parents:
268
diff
changeset
|
22 <date>2013-05-22</date> |
|
261
92a98e661a0b
update documentation for newer xml dtd
Carl Byington <carl@five-ten-sg.com>
parents:
259
diff
changeset
|
23 <author> |
|
92a98e661a0b
update documentation for newer xml dtd
Carl Byington <carl@five-ten-sg.com>
parents:
259
diff
changeset
|
24 <firstname>Carl</firstname> |
|
92a98e661a0b
update documentation for newer xml dtd
Carl Byington <carl@five-ten-sg.com>
parents:
259
diff
changeset
|
25 <surname>Byington</surname> |
|
92a98e661a0b
update documentation for newer xml dtd
Carl Byington <carl@five-ten-sg.com>
parents:
259
diff
changeset
|
26 <affiliation><orgname>510 Software Group</orgname></affiliation> |
|
92a98e661a0b
update documentation for newer xml dtd
Carl Byington <carl@five-ten-sg.com>
parents:
259
diff
changeset
|
27 </author> |
| 108 | 28 </refentryinfo> |
| 94 | 29 |
| 108 | 30 <refmeta> |
| 31 <refentrytitle>@PACKAGE@</refentrytitle> | |
| 32 <manvolnum>1</manvolnum> | |
| 33 <refmiscinfo>@PACKAGE@ @VERSION@</refmiscinfo> | |
| 34 </refmeta> | |
| 35 | |
| 36 <refnamediv id='name.1'> | |
| 37 <refname>@PACKAGE@</refname> | |
| 38 <refpurpose>a sendmail milter with per-user dnsbl filtering</refpurpose> | |
| 39 </refnamediv> | |
| 94 | 40 |
| 108 | 41 <refsynopsisdiv id='synopsis.1'> |
| 42 <title>Synopsis</title> | |
| 43 <cmdsynopsis> | |
| 44 <command>@PACKAGE@</command> | |
| 45 <arg><option>-c</option></arg> | |
| 46 <arg><option>-s</option></arg> | |
| 47 <arg><option>-d <replaceable class="parameter">n</replaceable></option></arg> | |
| 48 <arg><option>-e <replaceable class="parameter">from|to</replaceable></option></arg> | |
| 179 | 49 <arg><option>-b <replaceable class="parameter">local-domain-socket</replaceable></option></arg> |
| 108 | 50 <arg><option>-r <replaceable class="parameter">local-domain-socket</replaceable></option></arg> |
| 51 <arg><option>-p <replaceable class="parameter">sendmail-socket</replaceable></option></arg> | |
| 52 <arg><option>-t <replaceable class="parameter">timeout</replaceable></option></arg> | |
| 53 </cmdsynopsis> | |
| 54 </refsynopsisdiv> | |
| 94 | 55 |
| 108 | 56 <refsect1 id='options.1'> |
| 57 <title>Options</title> | |
| 58 <variablelist> | |
| 59 <varlistentry> | |
| 60 <term>-c</term> | |
| 111 | 61 <listitem><para> |
| 62 Load the configuration file, print a cannonical form | |
| 63 of the configuration on stdout, and exit. | |
| 64 </para></listitem> | |
| 108 | 65 </varlistentry> |
| 66 <varlistentry> | |
| 67 <term>-s</term> | |
| 111 | 68 <listitem><para> |
| 69 Stress test the configuration loading code by repeating | |
| 70 the load/free cycle in an infinite loop. | |
| 71 </para></listitem> | |
| 108 | 72 </varlistentry> |
| 73 <varlistentry> | |
| 74 <term>-d <replaceable class="parameter">n</replaceable></term> | |
| 111 | 75 <listitem><para> |
| 76 Set the debug level to <replaceable class="parameter">n</replaceable>. | |
| 77 </para></listitem> | |
| 108 | 78 </varlistentry> |
| 79 <varlistentry> | |
| 80 <term>-e <replaceable class="parameter">from|to</replaceable></term> | |
| 111 | 81 <listitem><para> |
| 82 Print the results of looking up the from and to addresses in the | |
| 83 current configuration. The | character is used to separate the from and to | |
| 84 addresses in the argument to the -e switch. | |
| 85 </para></listitem> | |
| 108 | 86 </varlistentry> |
| 87 <varlistentry> | |
| 179 | 88 <term>-b <replaceable class="parameter">local-domain-socket-file-name</replaceable></term> |
| 89 <listitem><para> | |
| 90 Set the local socket used for the connection to the dccifd daemon. | |
| 91 This is typically /var/dcc/dccifd. | |
| 92 </para></listitem> | |
| 93 </varlistentry> | |
| 94 <varlistentry> | |
| 95 <term>-r <replaceable class="parameter">local-domain-socket-file-name</replaceable></term> | |
| 111 | 96 <listitem><para> |
| 97 Set the local socket used for the connection to our own dns resolver processes. | |
| 98 </para></listitem> | |
| 108 | 99 </varlistentry> |
| 100 <varlistentry> | |
| 101 <term>-p <replaceable class="parameter">sendmail-socket</replaceable></term> | |
| 111 | 102 <listitem><para> |
| 103 Set the socket used for the milter connection to sendmail. This is either | |
| 104 "inet:port@ip-address" or "local:local-domain-socket-file-name". | |
| 105 </para></listitem> | |
| 108 | 106 </varlistentry> |
| 107 <varlistentry> | |
| 108 <term>-t <replaceable class="parameter">timeout</replaceable></term> | |
| 111 | 109 <listitem><para> |
| 110 Set the timeout in seconds used for communication with sendmail. | |
| 111 </para></listitem> | |
| 108 | 112 </varlistentry> |
| 113 </variablelist> | |
| 114 </refsect1> | |
| 94 | 115 |
| 111 | 116 <refsect1 id='usage.1'> |
| 108 | 117 <title>Usage</title> |
| 118 <para><command>@PACKAGE@</command> -c</para> | |
| 119 <para><command>@PACKAGE@</command> -s</para> | |
| 111 | 120 <para><command>@PACKAGE@</command> -e 'someone@aol.com|localname@mydomain.tld'</para> |
| 121 <para><command>@PACKAGE@</command> -d 10 -r resolver.sock -p local:dnsbl.sock</para> | |
| 122 </refsect1> | |
| 123 | |
| 124 <refsect1 id='installation.1'> | |
| 125 <title>Installation</title> | |
| 126 <para> | |
| 127 This is now a standard GNU autoconf/automake installation, so the normal | |
| 128 "./configure; make; su; make install" works. "make chkconfig" will | |
| 129 setup the init.d runlevel scripts. Alternatively, you can use the | |
| 130 source or binary RPMs at <ulink | |
| 131 url="http://www.five-ten-sg.com/@PACKAGE@/packages">http://www.five-ten-sg.com/@PACKAGE@/packages</ulink>. | |
| 132 </para> | |
| 133 <para> | |
| 134 Note that this has ONLY been tested on Linux, specifically RedHat Linux. | |
| 135 In particular, this milter makes no attempt to understand IPv6. Your | |
| 136 mileage will vary. You will need at a minimum a C++ compiler with a | |
| 137 minimally thread safe STL implementation. The distribution includes a | |
| 138 test.cpp program. If it fails this milter won't work. If it passes, | |
| 139 this milter might work. | |
| 140 </para> | |
| 141 <para> | |
| 142 Modify your sendmail.mc by removing all the "FEATURE(dnsbl" lines, add | |
| 143 the following line in your sendmail.mc and rebuild the .cf file | |
| 144 </para> | |
| 145 <para><screen>INPUT_MAIL_FILTER(`dnsbl', `S=local:/var/run/dnsbl/dnsbl.sock, F=T, T=C:30s;S:5m;R:5m;E:5m')</screen></para> | |
| 146 <para> | |
| 147 Modify the default <citerefentry> | |
| 148 <refentrytitle>@PACKAGE@.conf</refentrytitle> <manvolnum>5</manvolnum> | |
| 149 </citerefentry> configuration. | |
| 150 </para> | |
| 151 </refsect1> | |
| 152 | |
| 153 <refsect1 id='configuration.1'> | |
| 154 <title>Configuration</title> | |
| 155 <para> | |
| 156 The configuration file is documented in <citerefentry> | |
| 157 <refentrytitle>@PACKAGE@.conf</refentrytitle> <manvolnum>5</manvolnum> | |
| 158 </citerefentry>. Any change to the config file, or any file included | |
| 159 from that config file, will cause it to be reloaded within three | |
| 160 minutes. | |
| 161 </para> | |
| 108 | 162 </refsect1> |
| 94 | 163 |
| 108 | 164 <refsect1 id='introduction.1'> |
| 165 <title>Introduction</title> | |
| 166 <para> | |
| 167 Consider the case of a mail server that is acting as secondary MX for a | |
| 168 collection of clients, each of which has a collection of mail domains. | |
| 169 Each client may use their own collection of DNSBLs on their primary mail | |
| 170 server. We present here a mechanism whereby the backup mail server can | |
| 171 use the correct set of DNSBLs for each recipient for each message. As a | |
| 172 side-effect, it gives us the ability to customize the set of DNSBLs on a | |
| 183 | 173 per-recipient basis, so that fred@example.com could use LOCAL and the |
| 108 | 174 SBL, where all other users @example.com use only the SBL. |
| 175 </para> | |
| 176 <para> | |
| 177 This milter can also verify the envelope from/recipient pairs with the | |
| 178 primary MX server. This allows the backup mail servers to properly | |
| 179 reject mail sent to invalid addresses. Otherwise, the backup mail | |
| 180 servers will accept that mail, and then generate a bounce message when | |
| 181 the message is forwarded to the primary server (and rejected there with | |
| 127 | 182 no such user). These rejections are the primary cause of such backscatter. |
| 108 | 183 </para> |
| 184 <para> | |
| 185 This milter will also decode (uuencode, base64, mime, html entity, url | |
| 186 encodings) and scan for HTTP and HTTPS URLs and bare hostnames in the | |
| 187 body of the mail. If any of those host names have A or NS records on | |
| 188 the SBL (or a single configurable DNSBL), the mail will be rejected | |
| 189 unless previously whitelisted. This milter also counts the number of | |
| 190 invalid HTML tags, and can reject mail if that count exceeds your | |
| 191 specified limit. | |
| 192 </para> | |
| 193 <para> | |
|
259
be939802c64e
add recipient rate limits by email from address or domain
Carl Byington <carl@five-ten-sg.com>
parents:
255
diff
changeset
|
194 This milter can also impose hourly and daily rate |
|
be939802c64e
add recipient rate limits by email from address or domain
Carl Byington <carl@five-ten-sg.com>
parents:
255
diff
changeset
|
195 limits on the number of recipients accepted from SMTP |
|
be939802c64e
add recipient rate limits by email from address or domain
Carl Byington <carl@five-ten-sg.com>
parents:
255
diff
changeset
|
196 AUTH connections, that would otherwise be allowed to |
|
be939802c64e
add recipient rate limits by email from address or domain
Carl Byington <carl@five-ten-sg.com>
parents:
255
diff
changeset
|
197 relay thru this mail server with no spam filtering. If |
|
be939802c64e
add recipient rate limits by email from address or domain
Carl Byington <carl@five-ten-sg.com>
parents:
255
diff
changeset
|
198 the connection does not use SMTP AUTH, the rate limits |
|
be939802c64e
add recipient rate limits by email from address or domain
Carl Byington <carl@five-ten-sg.com>
parents:
255
diff
changeset
|
199 may be specified by the mail from email address or |
|
be939802c64e
add recipient rate limits by email from address or domain
Carl Byington <carl@five-ten-sg.com>
parents:
255
diff
changeset
|
200 domain. |
| 136 | 201 </para> |
| 202 <para> | |
| 162 | 203 Consider the case of a message from A to B passing thru this milter. If |
| 204 that message is not blocked, then we might eventually see a reply | |
| 156 | 205 message from B to A. If the filtering context for A includes an |
| 162 | 206 autowhite entry, and that context does <emphasis>not</emphasis> cover B |
| 207 as a recipient, then this milter will add an entry in that file to | |
| 208 whitelist such replies for a configurable time period. Suppose A and B | |
| 209 are in the same domain, or at least use the same filtering context. In | |
| 210 that case we don't want to add a whitelist entry for B, since that would | |
| 211 then allow spammers to send mail from B (forged) to B. Such autowhite | |
| 160 | 212 files need to be writeable by the dnsbl user, where all the other dnsbl |
| 213 configuration files only need to be readable by the dnsbl user. | |
| 156 | 214 </para> |
| 215 <para> | |
|
176
4ec928b24bab
allow manual whitelisting with stamp 1 to remove a whitelist entry
carl
parents:
175
diff
changeset
|
216 You can manually add such an autowhite entry, by appending a single |
|
4ec928b24bab
allow manual whitelisting with stamp 1 to remove a whitelist entry
carl
parents:
175
diff
changeset
|
217 text line to the autowhitelist file, using something like |
|
4ec928b24bab
allow manual whitelisting with stamp 1 to remove a whitelist entry
carl
parents:
175
diff
changeset
|
218 <command>echo "$mail 0" >>$autowhitefile</command>. |
|
4ec928b24bab
allow manual whitelisting with stamp 1 to remove a whitelist entry
carl
parents:
175
diff
changeset
|
219 You can manually remove such an autowhite entry, by appending a single |
|
4ec928b24bab
allow manual whitelisting with stamp 1 to remove a whitelist entry
carl
parents:
175
diff
changeset
|
220 text line to the autowhitelist file, using something like |
|
4ec928b24bab
allow manual whitelisting with stamp 1 to remove a whitelist entry
carl
parents:
175
diff
changeset
|
221 <command>echo "$mail 1" >>$autowhitefile</command>. |
|
4ec928b24bab
allow manual whitelisting with stamp 1 to remove a whitelist entry
carl
parents:
175
diff
changeset
|
222 </para> |
|
4ec928b24bab
allow manual whitelisting with stamp 1 to remove a whitelist entry
carl
parents:
175
diff
changeset
|
223 <para> |
| 108 | 224 The DNSBL milter reads a text configuration file (dnsbl.conf) on |
| 225 startup, and whenever the config file (or any of the referenced include | |
| 226 files) is changed. The entire configuration file is case insensitive. | |
| 227 If the configuration cannot be loaded due to a syntax error, the milter | |
| 228 will log the error and quit. If the configuration cannot be reloaded | |
| 229 after being modified, the milter will log the error and send an email to | |
| 152 | 230 root from dnsbl@$hostname. You probably want to add dnsbl@$hostname |
| 108 | 231 to your /etc/mail/virtusertable since otherwise sendmail will reject |
| 232 that message. | |
| 233 </para> | |
| 234 </refsect1> | |
| 94 | 235 |
| 111 | 236 <refsect1 id='dcc.1'> |
| 108 | 237 <title>DCC Issues</title> |
| 238 <para> | |
| 239 If you are also using the <ulink | |
| 240 url="http://www.rhyolite.com/anti-spam/dcc/">DCC</ulink> milter, there | |
| 241 are a few considerations. You may need to whitelist senders from the | |
| 242 DCC bulk detector, or from the DNS based lists. Those are two very | |
| 243 different reasons for whitelisting. The former is done thru the DCC | |
| 244 whiteclnt config file, the later is done thru the DNSBL milter config | |
| 245 file. | |
| 246 </para> | |
| 247 <para> | |
| 248 You may want to blacklist some specific senders or sending domains. | |
| 249 This could be done thru either the DCC (on a global basis, or for a | |
| 250 specific single recipient). We prefer to do such blacklisting via the | |
| 251 DNSBL milter config, since it can be done for a collection of recipient | |
| 252 mail domains. The DCC approach has the feature that you can capture the | |
| 253 entire message in the DCC log files. The DNSBL milter approach has the | |
| 254 feature that the mail is rejected earlier (at RCPT TO time), and the | |
| 255 sending machine just gets a generic "550 5.7.1 no such user" message. | |
| 256 </para> | |
| 257 <para> | |
| 258 The DCC whiteclnt file can be included in the DNSBL milter config by the | |
| 259 dcc_to and dcc_from statements. This will import the (env_to, env_from, | |
| 260 and substitute mail_host) entries from the DCC config into the DNSBL | |
| 261 config. This allows using the DCC config as the single point for | |
| 262 white/blacklisting. | |
| 263 </para> | |
| 264 <para> | |
| 265 Consider the case where you have multiple clients, each with their own | |
| 266 mail servers, and each running their own DCC milters. Each client is | |
| 267 using the DCC facilities for envelope from/to white/blacklisting. | |
| 268 Presumably you can use rsync or scp to fetch copies of your clients DCC | |
| 269 whiteclnt files on a regular basis. Your mail server, acting as a | |
| 270 backup MX for your clients, can use the DNSBL milter, and include those | |
| 271 client DCC config files. The envelope from/to white/blacklisting will | |
| 272 be appropriately tagged and used only for the domains controlled by each | |
| 273 of those clients. | |
| 274 </para> | |
| 179 | 275 <para> |
| 276 You can now use (via dccifd) different dcc filtering parameters on a per | |
| 277 context basis. See the dcc_greylist and dcc_bulk_threshold statements | |
| 278 in the <citerefentry> <refentrytitle>@PACKAGE@.conf</refentrytitle> | |
| 279 <manvolnum>5</manvolnum> </citerefentry> configuration. Those | |
| 280 statements are only active if you supply the <option>-b</option> option | |
| 281 on the dnsbl command line. If you use the dcc via the standard dcc | |
| 282 milter (dccm), then connections from clients that use SMTP AUTH are | |
| 283 still subject to greylisting. If you use the dcc via dccifd and this | |
| 284 milter, then connections from clients that use SMTP AUTH are never | |
| 180 | 285 subject to greylisting. As part of this per-user greylisting, you need |
| 286 to move the dnsblnogrey file from the config directory to something | |
| 287 like /var/dcc/userdirs/local/dnsblnogrey/whiteclnt so the dccifd will | |
| 288 properly ignore greylisting for those recipients that don't want it. | |
| 179 | 289 </para> |
| 108 | 290 </refsect1> |
| 94 | 291 |
| 111 | 292 <refsect1 id='definitions.1'> |
| 108 | 293 <title>Definitions</title> |
| 294 <para> | |
| 295 CONTEXT - a collection of parameters that defines the filtering context | |
| 296 to be used for a collection of envelope recipient addresses. The | |
| 297 context includes such things as the list of DNSBLs to be used, and the | |
| 298 various content filtering parameters. | |
| 299 </para> | |
| 300 <para> | |
| 301 DNSBL - a named DNS based blocking list is defined by a dns suffix (e.g. | |
| 302 sbl-xbl.spamhaus.org) and a message string that is used to generate the | |
| 303 "550 5.7.1" smtp error return code. The names of these DNSBLs will be | |
| 304 used to define the DNSBL-LISTs. | |
| 305 </para> | |
| 306 <para> | |
| 307 DNSBL-LIST - a named list of DNSBLs that will be used for specific | |
| 308 recipients or recipient domains. | |
| 309 </para> | |
| 249 | 310 <para> |
| 311 DNSWL - a named DNS based white list is defined by a dns suffix (e.g. | |
| 312 list.dnswl.org) and an integer level. If the level is greater than or | |
| 313 equal to x in the 127.0.z.x return code from the white list, then the | |
| 314 ip address is considered to match, and the message will be whitelisted. | |
| 315 The names of these DNSWLs will be used to define the DNSWL-LISTs. | |
| 316 </para> | |
| 317 <para> | |
| 318 DNSWL-LIST - a named list of DNSWLs that will be used for specific | |
| 319 recipients or recipient domains. | |
| 320 </para> | |
| 108 | 321 </refsect1> |
| 94 | 322 |
| 111 | 323 <refsect1 id='filtering.1'> |
| 108 | 324 <title>Filtering Procedure</title> |
| 325 <para> | |
| 152 | 326 The SMTP envelope 'from' and 'to' values are used in various checks. |
| 327 The first check is to see if a reply message (swapping the env_from and | |
| 160 | 328 env_to values) would be unconditionally blocked (just based on the |
| 329 envelope from address). That check is similar to the main check | |
| 330 described below, but there is no body content to be scanned, and there | |
| 331 is no client connection ip address to be checked against DNSBLs. If | |
| 332 such a reply message would be blocked, we also block the original | |
| 333 outgoing message. This prevents folks from sending mail to recipients | |
| 334 that are unable to reply. | |
| 152 | 335 </para> |
| 336 <para> | |
| 136 | 337 If the client has authenticated with sendmail, the rate limits are |
|
268
f941563c2a95
Add require_rdns checking
Carl Byington <carl@five-ten-sg.com>
parents:
263
diff
changeset
|
338 checked. If the authenticated user has not exceeded the hourly or daily rate |
|
f941563c2a95
Add require_rdns checking
Carl Byington <carl@five-ten-sg.com>
parents:
263
diff
changeset
|
339 limits, then the mail is accepted, the filtering contexts are not used, |
| 136 | 340 the dns lists are not checked, and the body content is not scanned. If |
| 341 the client has not authenticated with sendmail, we follow these steps | |
| 342 for each recipient. | |
| 108 | 343 </para> |
| 344 <orderedlist> | |
| 111 | 345 <listitem><para> |
| 108 | 346 The envelope to email address is used to find an initial filtering |
| 347 context. We first look for a context that specified the full email | |
| 348 address in the env_to statement. If that is not found, we look for a | |
| 349 context that specified the entire domain name of the envelope recipient | |
| 350 in the env_to statement. If that is not found, we look for a context | |
| 351 that specified the user@ part of the envelope recipient in the env_to | |
| 352 statement. If that is not found, we use the first top level context | |
| 353 defined in the config file. | |
| 111 | 354 </para></listitem> |
| 355 <listitem><para> | |
| 108 | 356 The initial filtering context may redirect to a child context based on |
| 357 the values in the initial context's env_from statement. We look for [1) | |
| 358 the full envelope from email address, 2) the domain name part of the | |
| 359 envelope from address, 3) the user@ part of the envelope from address] | |
| 360 in that context's env_from statement, with values that point to a child | |
| 361 context. If such an entry is found, we switch to that child filtering | |
| 362 context. | |
| 111 | 363 </para></listitem> |
| 364 <listitem><para> | |
| 108 | 365 We lookup [1) the full envelope from email address, 2) the domain name |
| 366 part of the envelope from address, 3) the user@ part of the envelope | |
| 367 from address] in the filtering context env_from statement. That results | |
| 368 in one of (white, black, unknown, inherit). | |
| 111 | 369 </para></listitem> |
| 370 <listitem><para> | |
| 108 | 371 If the answer is black, mail to this recipient is rejected with "no such |
| 372 user", and the dns lists are not checked. | |
| 111 | 373 </para></listitem> |
| 374 <listitem><para> | |
| 108 | 375 If the answer is white, mail to this recipient is accepted and the dns |
| 376 lists are not checked. | |
| 111 | 377 </para></listitem> |
| 378 <listitem><para> | |
| 108 | 379 If the answer is unknown, we don't reject yet, but the dns lists will be |
| 380 checked, and the content may be scanned. | |
| 111 | 381 </para></listitem> |
| 382 <listitem><para> | |
| 108 | 383 If the answer is inherit, we repeat the envelope from search in the |
| 384 parent context. | |
| 111 | 385 </para></listitem> |
| 386 <listitem><para> | |
|
233
5c3e9bf45bb5
Add whitelisting by regex expression filtering.
Carl Byington <carl@five-ten-sg.com>
parents:
216
diff
changeset
|
387 If the mail has not been accepted or rejected yet, and the filtering |
|
5c3e9bf45bb5
Add whitelisting by regex expression filtering.
Carl Byington <carl@five-ten-sg.com>
parents:
216
diff
changeset
|
388 context (or any ancestor context) specifies a non-empty whitelist regular |
|
5c3e9bf45bb5
Add whitelisting by regex expression filtering.
Carl Byington <carl@five-ten-sg.com>
parents:
216
diff
changeset
|
389 expression, then we check the envelope from value against that regex. |
|
5c3e9bf45bb5
Add whitelisting by regex expression filtering.
Carl Byington <carl@five-ten-sg.com>
parents:
216
diff
changeset
|
390 The mail is accepted if the envelope from value matches the specified regular |
|
5c3e9bf45bb5
Add whitelisting by regex expression filtering.
Carl Byington <carl@five-ten-sg.com>
parents:
216
diff
changeset
|
391 expression. |
|
5c3e9bf45bb5
Add whitelisting by regex expression filtering.
Carl Byington <carl@five-ten-sg.com>
parents:
216
diff
changeset
|
392 </para></listitem> |
|
5c3e9bf45bb5
Add whitelisting by regex expression filtering.
Carl Byington <carl@five-ten-sg.com>
parents:
216
diff
changeset
|
393 <listitem><para> |
| 249 | 394 If the mail has not been accepted or rejected yet, the dns white lists |
| 395 specified in the filtering context are checked and the mail is accepted | |
| 396 if any list has an A record for the standard dns based lookup scheme | |
| 397 (reversed octets of the client followed by the dns suffix) with a final | |
| 398 octet greater than or equal to the level specified for that dnswl. | |
| 399 </para></listitem> | |
| 400 <listitem><para> | |
| 401 If the mail has not been accepted or rejected yet, the dns black lists | |
| 168 | 402 specified in the filtering context are checked and the mail is rejected |
| 403 if any list has an A record for the standard dns based lookup scheme | |
| 404 (reversed octets of the client followed by the dns suffix). | |
| 405 </para></listitem> | |
| 406 <listitem><para> | |
| 407 If the mail has not been accepted or rejected yet, and the filtering | |
|
268
f941563c2a95
Add require_rdns checking
Carl Byington <carl@five-ten-sg.com>
parents:
263
diff
changeset
|
408 context (or any ancestor context) requires matching reverse dns client |
|
f941563c2a95
Add require_rdns checking
Carl Byington <carl@five-ten-sg.com>
parents:
263
diff
changeset
|
409 name, the mail is rejected if the client name is empty or forged. |
|
f941563c2a95
Add require_rdns checking
Carl Byington <carl@five-ten-sg.com>
parents:
263
diff
changeset
|
410 </para></listitem> |
|
f941563c2a95
Add require_rdns checking
Carl Byington <carl@five-ten-sg.com>
parents:
263
diff
changeset
|
411 <listitem><para> |
|
f941563c2a95
Add require_rdns checking
Carl Byington <carl@five-ten-sg.com>
parents:
263
diff
changeset
|
412 If the mail has not been accepted or rejected yet, and the filtering |
| 170 | 413 context (or any ancestor context) specifies a non-empty generic regular |
| 414 expression, then we check the fully qualified client name (obtained via | |
| 415 the sendmail macro "_"). The mail is rejected if the client name | |
| 416 matches the specified regular expression. | |
| 111 | 417 </para></listitem> |
| 418 <listitem><para> | |
| 108 | 419 If the mail has not been accepted or rejected yet, we look for a |
| 420 verification context, which is the closest ancestor of the filtering | |
| 421 context that both specifies a verification host, and which covers the | |
| 422 envelope to address. If we find such a verification context, and the | |
| 423 verification host is not our own hostname, we open an smtp conversation | |
| 424 with that verification host. The current envelope from and recipient to | |
| 425 values are passed to that verification host. If we receive a 5xy | |
| 426 response those commands, we reject the current recipient with "no such | |
| 427 user". | |
| 111 | 428 </para></listitem> |
| 429 <listitem><para> | |
| 108 | 430 If the mail has not been accepted or rejected yet, and the filtering |
| 431 context enables content filtering, and this is the first such recipient | |
| 432 in this smtp transaction, we set the content filtering parameters from | |
| 433 this context, and enable content filtering for the body of this message. | |
| 111 | 434 </para></listitem> |
| 108 | 435 </orderedlist> |
| 436 <para> | |
| 160 | 437 For each recipient that was accepted, we search for an autowhite entry |
| 438 starting in the reply filtering context. If an autowhite entry is found, | |
| 439 we add the recipient to that auto whitelist file. This will prevent reply | |
| 440 messages from being blocked by the dnsbl or content filtering. | |
| 441 </para> | |
| 442 <para> | |
| 108 | 443 If content filtering is enabled for this body, the mail text is decoded |
| 119 | 444 (uuencode, base64, mime, html entity, url encodings), and scanned for HTTP |
| 445 and HTTPS URLs or bare host names. Hostnames must be either ip address | |
| 446 literals, or must end in a string defined by the TLD list. The first | |
| 447 <configurable> host names are checked as follows. | |
| 448 </para> | |
| 449 <para> | |
| 450 The only known list that is suitable for the content filter DNSBL is the | |
| 451 SBL. If the content filter DNSBL is defined, and any of those host | |
| 452 names resolve to ip addresses that are on that DNSBL (or have | |
| 453 nameservers that are on that list), and the host name is not on the | |
| 454 <configurable> ignore list, the mail is rejected. | |
| 455 </para> | |
| 456 <para> | |
| 457 If the content uribl DNSBL is defined, and any of those host names are | |
| 458 on that DNSBL, and the host name is not on the <configurable> | |
|
270
f92f24950bd3
Use mozilla prefix list for tld checking, Enable surbl/uribl/dbl rhs lists
Carl Byington <carl@five-ten-sg.com>
parents:
268
diff
changeset
|
459 ignore list, the mail is rejected. There are three lists that are suitable |
|
f92f24950bd3
Use mozilla prefix list for tld checking, Enable surbl/uribl/dbl rhs lists
Carl Byington <carl@five-ten-sg.com>
parents:
268
diff
changeset
|
460 here, uribl, surbl, and dbl. |
| 119 | 461 </para> |
| 462 <para> | |
|
167
9b129ed78d7d
actually use spamassassin result, allow build without spam assassin, only call it if some recipient needs it.
carl
parents:
164
diff
changeset
|
463 If any non-whitelisted recipient has a filtering context with a non-zero |
|
9b129ed78d7d
actually use spamassassin result, allow build without spam assassin, only call it if some recipient needs it.
carl
parents:
164
diff
changeset
|
464 spamassassin limit, then the message is passed thru spamassassin (via |
|
9b129ed78d7d
actually use spamassassin result, allow build without spam assassin, only call it if some recipient needs it.
carl
parents:
164
diff
changeset
|
465 spamc), and the message is rejected for those recipients with spamassassin |
|
203
92a5c866bdfa
Verify from/to pairs even if they might be explicitly whitelisted.
Carl Byington <carl@five-ten-sg.com>
parents:
201
diff
changeset
|
466 limits less than the resulting spamassassin score. For example, a |
|
92a5c866bdfa
Verify from/to pairs even if they might be explicitly whitelisted.
Carl Byington <carl@five-ten-sg.com>
parents:
201
diff
changeset
|
467 spamassassin limit of three will reject messages with spamassassin scores |
|
246
8b0f16abee53
Add prvs decoding to envelope addresses
Carl Byington <carl@five-ten-sg.com>
parents:
233
diff
changeset
|
468 of four or greater. If the filtering context has a spamassassin limit of |
|
8b0f16abee53
Add prvs decoding to envelope addresses
Carl Byington <carl@five-ten-sg.com>
parents:
233
diff
changeset
|
469 zero, then spamassassin is not called (or if called the results are not used) |
|
8b0f16abee53
Add prvs decoding to envelope addresses
Carl Byington <carl@five-ten-sg.com>
parents:
233
diff
changeset
|
470 for this recipient. |
|
203
92a5c866bdfa
Verify from/to pairs even if they might be explicitly whitelisted.
Carl Byington <carl@five-ten-sg.com>
parents:
201
diff
changeset
|
471 </para> |
|
92a5c866bdfa
Verify from/to pairs even if they might be explicitly whitelisted.
Carl Byington <carl@five-ten-sg.com>
parents:
201
diff
changeset
|
472 <para> |
|
92a5c866bdfa
Verify from/to pairs even if they might be explicitly whitelisted.
Carl Byington <carl@five-ten-sg.com>
parents:
201
diff
changeset
|
473 If any non-whitelisted recipient has a filtering context that specifies |
|
92a5c866bdfa
Verify from/to pairs even if they might be explicitly whitelisted.
Carl Byington <carl@five-ten-sg.com>
parents:
201
diff
changeset
|
474 DCC greylisting, then the message is passed thru the DCC bulk detector, |
|
92a5c866bdfa
Verify from/to pairs even if they might be explicitly whitelisted.
Carl Byington <carl@five-ten-sg.com>
parents:
201
diff
changeset
|
475 and the message is greylisted (for all recipients) if the DCC says this |
|
92a5c866bdfa
Verify from/to pairs even if they might be explicitly whitelisted.
Carl Byington <carl@five-ten-sg.com>
parents:
201
diff
changeset
|
476 message should be delayed. |
|
92a5c866bdfa
Verify from/to pairs even if they might be explicitly whitelisted.
Carl Byington <carl@five-ten-sg.com>
parents:
201
diff
changeset
|
477 </para> |
|
92a5c866bdfa
Verify from/to pairs even if they might be explicitly whitelisted.
Carl Byington <carl@five-ten-sg.com>
parents:
201
diff
changeset
|
478 <para> |
|
92a5c866bdfa
Verify from/to pairs even if they might be explicitly whitelisted.
Carl Byington <carl@five-ten-sg.com>
parents:
201
diff
changeset
|
479 If any non-whitelisted recipient has a filtering context with a non-zero |
|
92a5c866bdfa
Verify from/to pairs even if they might be explicitly whitelisted.
Carl Byington <carl@five-ten-sg.com>
parents:
201
diff
changeset
|
480 DCC bulk threshold, then the message is passed thru the DCC bulk detector, |
|
92a5c866bdfa
Verify from/to pairs even if they might be explicitly whitelisted.
Carl Byington <carl@five-ten-sg.com>
parents:
201
diff
changeset
|
481 and the message is rejected for those recipients with DCC thresholds less |
|
92a5c866bdfa
Verify from/to pairs even if they might be explicitly whitelisted.
Carl Byington <carl@five-ten-sg.com>
parents:
201
diff
changeset
|
482 than or equal to the DCC bulk score. |
| 163 | 483 </para> |
| 484 <para> | |
| 119 | 485 We also scan for excessive bad html tags, and if a <configurable> |
| 486 limit is exceeded, the mail is rejected. | |
| 108 | 487 </para> |
| 488 </refsect1> | |
| 94 | 489 |
| 111 | 490 <refsect1 id='access.1'> |
| 108 | 491 <title>Sendmail access vs. DNSBL</title> |
| 492 <para> | |
| 493 With the standard sendmail.mc dnsbl FEATURE, the dnsbl checks may be | |
| 494 suppressed by entries in the /etc/mail/access database. For example, | |
| 495 suppose you control a /18 of address space, and have allocated some /24s | |
| 496 to some clients. You have access entries like | |
| 111 | 497 <literallayout class="monospaced"><![CDATA[ |
| 498 192.168.4 OK | |
| 499 192.168.17 OK]]></literallayout> | |
| 108 | 500 </para> |
| 501 <para> | |
| 502 to allow those clients to smarthost thru your mail server. Now if one | |
| 503 of those clients happens get infected with a virus that turns a machine | |
| 504 into an open proxy, and their 192.168.4.45 lands on the SBL-XBL, you | |
| 505 will still wind up allowing that infected machine to smarthost thru your | |
| 506 mail servers. | |
| 507 </para> | |
| 508 <para> | |
| 509 With this DNSBL milter, the sendmail access database cannot override the | |
| 510 dnsbl checks, so that machine won't be able to send mail to or thru your | |
| 511 smarthost mail server (unless the virus/proxy can use smtp-auth). | |
| 512 </para> | |
| 513 <para> | |
| 514 Using the standard sendmail features, you would add access entries to | |
| 515 allow hosts on your local network to relay thru your mail server. Those | |
| 516 OK entries in the sendmail access database will override all the dnsbl | |
| 517 checks. With this DNSBL milter, you will need to have the local users | |
| 518 authenticate with smtp-auth to get the same effect. You might find | |
| 519 <ulink | |
| 520 url="http://www.ists.dartmouth.edu/classroom/sendmail-ssl-how-to.php"> | |
| 521 these directions</ulink> helpful for setting up smtp-auth if you are on | |
| 522 RH Linux. | |
| 523 </para> | |
| 524 </refsect1> | |
| 94 | 525 |
| 111 | 526 <refsect1 id='performance.1'> |
| 108 | 527 <title>Performance Issues</title> |
| 528 <para> | |
| 529 Consider a high volume high performance machine running sendmail. Each | |
| 530 sendmail process can do its own dns resolution. Typically, such dns | |
| 531 resolver libraries are not thread safe, and so must be protected by some | |
| 532 sort of mutex in a threaded environment. When we add a milter to | |
| 533 sendmail, we now have a collection of sendmail processes, and a | |
| 534 collection of milter threads. | |
| 535 </para> | |
| 536 <para> | |
| 537 We will be doing a lot of dns lookups per mail message, and at least | |
| 538 some of those will take many tens of seconds. If all this dns work is | |
| 539 serialized inside the milter, we have an upper limit of about 25K mail | |
| 540 messages per day. That is clearly not sufficient for many sites. | |
| 541 </para> | |
| 542 <para> | |
| 543 Since we want to do parallel dns resolution across those milter threads, | |
| 544 we add another collection of dns resolver processes. Each sendmail | |
| 545 process is talking to a milter thread over a socket, and each milter | |
| 546 thread is talking to a dns resolver process over another socket. | |
| 547 </para> | |
| 548 <para> | |
| 549 Suppose we are processing 20 messages per second, and each message | |
| 550 requires 20 seconds of dns work. Then we will have 400 sendmail | |
| 551 processes, 400 milter threads, and 400 dns resolver processes. Of | |
| 552 course that steady state is very unlikely to happen. | |
| 553 </para> | |
| 554 </refsect1> | |
| 94 | 555 |
| 556 | |
| 111 | 557 <refsect1 id='rejected.1'> |
| 108 | 558 <title>Rejected Ideas</title> |
| 559 <para> | |
| 560 The following ideas have been considered and rejected. | |
| 561 </para> | |
| 562 <para> | |
| 111 | 563 Add max_recipients setting to the context configuration. Recipients in |
| 564 excess of that limit will be rejected, and all the non-whitelisted | |
| 565 recipients will be removed. Current spammers *very* rarely send more | |
| 566 than ten recipients in a single smtp transaction, so this won't stop any | |
| 108 | 567 significant amount of spam. |
| 568 </para> | |
| 569 <para> | |
| 570 Add poison addresses to the configuration. If any recipient is | |
| 571 poison, all recipients are rejected even if they would be whitelisted, | |
| 572 and the data is rejected if sent. I have a collection of spam trap | |
| 573 addresses that would be suitable for such use. Based on my log files, | |
| 574 any mail to those spam trap addresses is rejected based on either dnsbl | |
| 575 lookups or the DCC. So this won't result in blocking any additional | |
| 576 spam. | |
| 577 </para> | |
| 578 <para> | |
| 579 Add an option to only allow one recipient if the return path is | |
| 580 empty. Based on my log files, there is no mail that violates this | |
| 581 check. | |
| 582 </para> | |
| 583 <para> | |
| 584 Reject the mail if the envelope from domain name contains any MX | |
| 585 records pointing to 127.0.0.0/8. I don't see any significant amount of | |
| 586 spam sent with such domain names. | |
| 587 </para> | |
| 588 </refsect1> | |
| 94 | 589 |
| 108 | 590 <refsect1 id='todo.1'> |
| 591 <title>TODO</title> | |
| 592 <para> | |
| 593 The following ideas are under consideration. | |
| 594 </para> | |
| 595 <para> | |
| 276 | 596 Add config switch to require the HELO argument to resolve to an ip address. |
| 597 </para> | |
| 598 <para> | |
|
270
f92f24950bd3
Use mozilla prefix list for tld checking, Enable surbl/uribl/dbl rhs lists
Carl Byington <carl@five-ten-sg.com>
parents:
268
diff
changeset
|
599 Add white/unknown to config for smtp authenticated connections. Currently |
|
f92f24950bd3
Use mozilla prefix list for tld checking, Enable surbl/uribl/dbl rhs lists
Carl Byington <carl@five-ten-sg.com>
parents:
268
diff
changeset
|
600 any authenticated connection is fully whitelisted. This would allow normal |
|
f92f24950bd3
Use mozilla prefix list for tld checking, Enable surbl/uribl/dbl rhs lists
Carl Byington <carl@five-ten-sg.com>
parents:
268
diff
changeset
|
601 spam controls to be applied even to authenticated connections. Add |
|
f92f24950bd3
Use mozilla prefix list for tld checking, Enable surbl/uribl/dbl rhs lists
Carl Byington <carl@five-ten-sg.com>
parents:
268
diff
changeset
|
602 context/authenticated_dnsbl_list and context/content/authenticated. |
|
f92f24950bd3
Use mozilla prefix list for tld checking, Enable surbl/uribl/dbl rhs lists
Carl Byington <carl@five-ten-sg.com>
parents:
268
diff
changeset
|
603 </para> |
|
f92f24950bd3
Use mozilla prefix list for tld checking, Enable surbl/uribl/dbl rhs lists
Carl Byington <carl@five-ten-sg.com>
parents:
268
diff
changeset
|
604 <para> |
|
f92f24950bd3
Use mozilla prefix list for tld checking, Enable surbl/uribl/dbl rhs lists
Carl Byington <carl@five-ten-sg.com>
parents:
268
diff
changeset
|
605 Add an optional list of domains to be enforced on the env_from value for |
|
f92f24950bd3
Use mozilla prefix list for tld checking, Enable surbl/uribl/dbl rhs lists
Carl Byington <carl@five-ten-sg.com>
parents:
268
diff
changeset
|
606 authenticated connections. User abc could be restricted to envelope from |
|
f92f24950bd3
Use mozilla prefix list for tld checking, Enable surbl/uribl/dbl rhs lists
Carl Byington <carl@five-ten-sg.com>
parents:
268
diff
changeset
|
607 values of a.com and b.com, user def could be restricted to envelope from |
|
f92f24950bd3
Use mozilla prefix list for tld checking, Enable surbl/uribl/dbl rhs lists
Carl Byington <carl@five-ten-sg.com>
parents:
268
diff
changeset
|
608 values of dd.com and ee.com. |
|
f92f24950bd3
Use mozilla prefix list for tld checking, Enable surbl/uribl/dbl rhs lists
Carl Byington <carl@five-ten-sg.com>
parents:
268
diff
changeset
|
609 </para> |
|
f92f24950bd3
Use mozilla prefix list for tld checking, Enable surbl/uribl/dbl rhs lists
Carl Byington <carl@five-ten-sg.com>
parents:
268
diff
changeset
|
610 <para> |
| 115 | 611 Look for href="hostname/path" strings that are missing the required |
| 612 http:// protocol header. Such references are still clickable in common | |
| 613 mail software. | |
| 614 </para> | |
|
278
368572c57013
add limits on unique ip addresses per hour per authenticated user
Carl Byington <carl@five-ten-sg.com>
parents:
276
diff
changeset
|
615 <para> |
|
368572c57013
add limits on unique ip addresses per hour per authenticated user
Carl Byington <carl@five-ten-sg.com>
parents:
276
diff
changeset
|
616 Add trusted_spf list of domains for which we trust their spf data. Mail |
|
368572c57013
add limits on unique ip addresses per hour per authenticated user
Carl Byington <carl@five-ten-sg.com>
parents:
276
diff
changeset
|
617 from their listed ip addresses from their domain will be whitelisted. |
|
368572c57013
add limits on unique ip addresses per hour per authenticated user
Carl Byington <carl@five-ten-sg.com>
parents:
276
diff
changeset
|
618 </para> |
| 108 | 619 </refsect1> |
| 94 | 620 |
| 111 | 621 <refsect1 id='copyright.1'> |
| 108 | 622 <title>Copyright</title> |
| 623 <para> | |
|
261
92a98e661a0b
update documentation for newer xml dtd
Carl Byington <carl@five-ten-sg.com>
parents:
259
diff
changeset
|
624 Copyright (C) 2012 by 510 Software Group <carl@five-ten-sg.com> |
| 108 | 625 </para> |
| 626 <para> | |
| 627 This program is free software; you can redistribute it and/or modify it | |
| 628 under the terms of the GNU General Public License as published by the | |
| 160 | 629 Free Software Foundation; either version 3, or (at your option) any |
| 108 | 630 later version. |
| 631 </para> | |
| 632 <para> | |
| 633 You should have received a copy of the GNU General Public License along | |
| 634 with this program; see the file COPYING. If not, please write to the | |
| 635 Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. | |
| 636 </para> | |
| 637 </refsect1> | |
| 94 | 638 |
| 111 | 639 <refsect1 id='version.1'> |
|
201
752d4315675c
add reference to mercurial repository in the documentation
Carl Byington <carl@five-ten-sg.com>
parents:
187
diff
changeset
|
640 <title>Version</title> |
| 108 | 641 <para> |
|
201
752d4315675c
add reference to mercurial repository in the documentation
Carl Byington <carl@five-ten-sg.com>
parents:
187
diff
changeset
|
642 @VERSION@ |
| 108 | 643 </para> |
| 644 </refsect1> | |
| 645 </refentry> | |
| 646 | |
| 647 | |
| 648 <refentry id="@PACKAGE@.conf.5"> | |
| 649 <refentryinfo> | |
|
270
f92f24950bd3
Use mozilla prefix list for tld checking, Enable surbl/uribl/dbl rhs lists
Carl Byington <carl@five-ten-sg.com>
parents:
268
diff
changeset
|
650 <date>2013-05-22</date> |
|
261
92a98e661a0b
update documentation for newer xml dtd
Carl Byington <carl@five-ten-sg.com>
parents:
259
diff
changeset
|
651 <author> |
|
92a98e661a0b
update documentation for newer xml dtd
Carl Byington <carl@five-ten-sg.com>
parents:
259
diff
changeset
|
652 <firstname>Carl</firstname> |
|
92a98e661a0b
update documentation for newer xml dtd
Carl Byington <carl@five-ten-sg.com>
parents:
259
diff
changeset
|
653 <surname>Byington</surname> |
|
92a98e661a0b
update documentation for newer xml dtd
Carl Byington <carl@five-ten-sg.com>
parents:
259
diff
changeset
|
654 <affiliation><orgname>510 Software Group</orgname></affiliation> |
|
92a98e661a0b
update documentation for newer xml dtd
Carl Byington <carl@five-ten-sg.com>
parents:
259
diff
changeset
|
655 </author> |
| 108 | 656 </refentryinfo> |
| 94 | 657 |
| 108 | 658 <refmeta> |
| 659 <refentrytitle>@PACKAGE@.conf</refentrytitle> | |
| 660 <manvolnum>5</manvolnum> | |
| 661 <refmiscinfo>@PACKAGE@ @VERSION@</refmiscinfo> | |
| 662 </refmeta> | |
| 94 | 663 |
| 108 | 664 <refnamediv id='name.5'> |
| 665 <refname>@PACKAGE@.conf</refname> | |
| 111 | 666 <refpurpose>configuration file for @PACKAGE@ sendmail milter</refpurpose> |
| 108 | 667 </refnamediv> |
| 668 | |
| 669 <refsynopsisdiv id='synopsis.5'> | |
| 670 <title>Synopsis</title> | |
| 671 <cmdsynopsis> | |
| 672 <command>@PACKAGE@.conf</command> | |
| 673 </cmdsynopsis> | |
| 674 </refsynopsisdiv> | |
| 94 | 675 |
| 108 | 676 <refsect1 id='description.5'> |
| 677 <title>Description</title> | |
| 678 <para>The <command>@PACKAGE@.conf</command> configuration file is | |
|
148
9330b8d6a56b
add documentation fixes, allow env_from target of inherit
carl
parents:
144
diff
changeset
|
679 specified by this partial bnf description. Comments start with // |
|
9330b8d6a56b
add documentation fixes, allow env_from target of inherit
carl
parents:
144
diff
changeset
|
680 or # and extend to the end of the line. To include the contents |
|
9330b8d6a56b
add documentation fixes, allow env_from target of inherit
carl
parents:
144
diff
changeset
|
681 of some file verbatim in the dnsbl.conf file, use |
|
9330b8d6a56b
add documentation fixes, allow env_from target of inherit
carl
parents:
144
diff
changeset
|
682 <literallayout class="monospaced"><![CDATA[include "<file>";]]></literallayout> |
|
9330b8d6a56b
add documentation fixes, allow env_from target of inherit
carl
parents:
144
diff
changeset
|
683 </para> |
| 108 | 684 |
| 685 <literallayout class="monospaced"><![CDATA[ | |
| 686 CONFIG = {CONTEXT ";"}+ | |
| 687 CONTEXT = "context" NAME "{" {STATEMENT}+ "}" | |
| 249 | 688 STATEMENT = (DNSBL | DNSBLLIST | DNSWL | DNSWLLIST | CONTENT | ENV-TO |
| 689 | VERIFY | GENERIC | W_REGEX | AUTOWHITE | CONTEXT | ENV-FROM | |
|
268
f941563c2a95
Add require_rdns checking
Carl Byington <carl@five-ten-sg.com>
parents:
263
diff
changeset
|
690 | RATE-LIMIT | REQUIRERDNS) ";" |
| 108 | 691 |
| 124 | 692 DNSBL = "dnsbl" NAME DNSPREFIX ERROR-MSG1 |
|
255
d6d5c50b9278
Allow dnswl_list and dnsbl_list to be empty, to override lists specified in the ancestor contexts. Add daily recipient limits as a multiple of the hourly limits.
Carl Byington <carl@five-ten-sg.com>
parents:
253
diff
changeset
|
693 DNSBLLIST = "dnsbl_list" {NAME}* |
| 108 | 694 |
|
255
d6d5c50b9278
Allow dnswl_list and dnsbl_list to be empty, to override lists specified in the ancestor contexts. Add daily recipient limits as a multiple of the hourly limits.
Carl Byington <carl@five-ten-sg.com>
parents:
253
diff
changeset
|
695 DNSWL = "dnswl" NAME DNSPREFIX LEVEL |
|
d6d5c50b9278
Allow dnswl_list and dnsbl_list to be empty, to override lists specified in the ancestor contexts. Add daily recipient limits as a multiple of the hourly limits.
Carl Byington <carl@five-ten-sg.com>
parents:
253
diff
changeset
|
696 DNSWLLIST = "dnswl_list" {NAME}* |
|
d6d5c50b9278
Allow dnswl_list and dnsbl_list to be empty, to override lists specified in the ancestor contexts. Add daily recipient limits as a multiple of the hourly limits.
Carl Byington <carl@five-ten-sg.com>
parents:
253
diff
changeset
|
697 LEVEL = INTEGER |
| 94 | 698 |
|
268
f941563c2a95
Add require_rdns checking
Carl Byington <carl@five-ten-sg.com>
parents:
263
diff
changeset
|
699 REQUIRERDNS = "require_rdns" ("yes" | "no") |
|
f941563c2a95
Add require_rdns checking
Carl Byington <carl@five-ten-sg.com>
parents:
263
diff
changeset
|
700 |
| 108 | 701 CONTENT = "content" ("on" | "off") "{" {CONTENT-ST}+ "}" |
|
270
f92f24950bd3
Use mozilla prefix list for tld checking, Enable surbl/uribl/dbl rhs lists
Carl Byington <carl@five-ten-sg.com>
parents:
268
diff
changeset
|
702 CONTENT-ST = (FILTER | URIBL | IGNORE | TLD | HTML-TAGS | HTML-LIMIT | |
|
f92f24950bd3
Use mozilla prefix list for tld checking, Enable surbl/uribl/dbl rhs lists
Carl Byington <carl@five-ten-sg.com>
parents:
268
diff
changeset
|
703 HOST-LIMIT | SPAMASS | REQUIRE | DCCGREY | DCCBULK) ";" |
| 124 | 704 FILTER = "filter" DNSPREFIX ERROR-MSG2 |
| 705 URIBL = "uribl" DNSPREFIX ERROR-MSG3 | |
| 108 | 706 IGNORE = "ignore" "{" {HOSTNAME [";"]}+ "}" |
| 707 TLD = "tld" "{" {TLD [";"]}+ "}" | |
| 708 HTML-TAGS = "html_tags" "{" {HTMLTAG [";"]}+ "}" | |
| 124 | 709 ERROR-MSG1 = string containing exactly two %s replacement tokens |
| 710 both are replaced with the client ip address | |
| 711 ERROR-MSG2 = string containing exactly two %s replacement tokens | |
| 712 the first is replaced with the hostname, and the second | |
| 713 is replaced with the ip address | |
| 714 ERROR-MSG3 = string containing exactly two %s replacement tokens | |
| 715 both are replaced with the hostname | |
| 108 | 716 |
| 717 HTML-LIMIT = "html_limit" ("on" INTEGER ERROR-MSG | "off") | |
| 718 | |
| 111 | 719 HOST-LIMIT = "host_limit" ("on" INTEGER ERROR-MSG | "off" | |
| 720 "soft" INTEGER) | |
| 178 | 721 SPAMASS = "spamassassin" INTEGER |
| 722 REQUIRE = "require_match" ("yes" | "no") | |
| 723 DCCGREY = "dcc_greylist" ("yes" | "no") | |
| 724 DCCBULK = "dcc_bulk_threshold" (INTEGER | "many" | "off") | |
| 94 | 725 |
| 108 | 726 ENV-TO = "env_to" "{" {(TO-ADDR | DCC-TO)}+ "}" |
| 727 TO-ADDR = ADDRESS [";"] | |
| 728 DCC-TO = "dcc_to" ("ok" | "many") "{" DCCINCLUDEFILE "}" ";" | |
| 729 | |
| 730 VERIFY = "verify" HOSTNAME ";" | |
| 168 | 731 GENERIC = "generic" REGULAREXPRESSION ERROR-MSG4 ";" |
|
233
5c3e9bf45bb5
Add whitelisting by regex expression filtering.
Carl Byington <carl@five-ten-sg.com>
parents:
216
diff
changeset
|
732 W-REGEX = "white_regex" REGULAREXPRESSION ";" |
| 168 | 733 ERROR-MSG4 = string containing exactly one %s replacement token |
| 734 which is replaced with the client name | |
| 153 | 735 AUTOWHITE = "autowhite" DAYS FILENAME ";" |
| 108 | 736 |
| 737 ENV_FROM = "env_from" [DEFAULT] "{" {(FROM-ADDR | DCC-FROM)}+ "}" | |
| 738 FROM-ADDR = ADDRESS VALUE [";"] | |
| 739 DCC-FROM = "dcc_from" "{" DCCINCLUDEFILE "}" ";" | |
| 136 | 740 |
|
278
368572c57013
add limits on unique ip addresses per hour per authenticated user
Carl Byington <carl@five-ten-sg.com>
parents:
276
diff
changeset
|
741 RATE-LIMIT = "rate_limit" DEFAULT_RCPT_LIMIT DAILY_MULTIPLE_RCPT |
|
368572c57013
add limits on unique ip addresses per hour per authenticated user
Carl Byington <carl@five-ten-sg.com>
parents:
276
diff
changeset
|
742 DEFAULT_IP_LIMIT DAILY_MULTIPLE_IP "{" (RATE)+ "}" |
|
368572c57013
add limits on unique ip addresses per hour per authenticated user
Carl Byington <carl@five-ten-sg.com>
parents:
276
diff
changeset
|
743 RATE = USER RCPTLIMIT IPLIMIT ";" |
|
368572c57013
add limits on unique ip addresses per hour per authenticated user
Carl Byington <carl@five-ten-sg.com>
parents:
276
diff
changeset
|
744 RCPTLIMIT = INTEGER |
|
368572c57013
add limits on unique ip addresses per hour per authenticated user
Carl Byington <carl@five-ten-sg.com>
parents:
276
diff
changeset
|
745 DEFAULT_RCPT_LIMIT = INTEGER |
|
368572c57013
add limits on unique ip addresses per hour per authenticated user
Carl Byington <carl@five-ten-sg.com>
parents:
276
diff
changeset
|
746 DAILY_MULTIPLE_RCPT = INTEGER |
|
368572c57013
add limits on unique ip addresses per hour per authenticated user
Carl Byington <carl@five-ten-sg.com>
parents:
276
diff
changeset
|
747 DEFAULT_IP_LIMIT = INTEGER |
|
368572c57013
add limits on unique ip addresses per hour per authenticated user
Carl Byington <carl@five-ten-sg.com>
parents:
276
diff
changeset
|
748 DAILY_MULTIPLE_IP = INTEGER |
| 136 | 749 |
| 108 | 750 DEFAULT = ("white" | "black" | "unknown" | "inherit" | "") |
| 751 ADDRESS = (USER@ | DOMAIN | USER@DOMAIN) | |
|
148
9330b8d6a56b
add documentation fixes, allow env_from target of inherit
carl
parents:
144
diff
changeset
|
752 VALUE = ("white" | "black" | "unknown" | "inherit" | CHILD-CONTEXT-NAME)]]></literallayout> |
| 108 | 753 </refsect1> |
| 94 | 754 |
| 108 | 755 <refsect1 id='sample.5'> |
| 756 <title>Sample</title> | |
| 757 <literallayout class="monospaced"><![CDATA[ | |
| 127 | 758 context main-default { |
| 759 // outbound dnsbl filtering to catch our own customers that end up on the sbl | |
| 760 dnsbl sbl sbl-xbl.spamhaus.org "Mail from %s rejected - sbl; see http://www.spamhaus.org/query/bl?ip=%s"; | |
| 174 | 761 dnsbl_list sbl; |
| 127 | 762 |
| 763 // outbound content filtering to prevent our own customers from sending spam | |
| 764 content on { | |
| 765 filter sbl-xbl.spamhaus.org "Mail containing %s rejected - sbl; see http://www.spamhaus.org/query/bl?ip=%s"; | |
|
270
f92f24950bd3
Use mozilla prefix list for tld checking, Enable surbl/uribl/dbl rhs lists
Carl Byington <carl@five-ten-sg.com>
parents:
268
diff
changeset
|
766 uribl multi.surbl.org "Mail containing %s rejected - surbl; see http://www.surbl.org/surbl-analysis?d=%s"; |
|
259
be939802c64e
add recipient rate limits by email from address or domain
Carl Byington <carl@five-ten-sg.com>
parents:
255
diff
changeset
|
767 #uribl multi.uribl.com "Mail containing %s rejected - uribl; see http://l.uribl.com/?d=%s"; |
|
270
f92f24950bd3
Use mozilla prefix list for tld checking, Enable surbl/uribl/dbl rhs lists
Carl Byington <carl@five-ten-sg.com>
parents:
268
diff
changeset
|
768 #uribl dbl.spamhaus.org "Mail containing %s rejected - dbl; see http://www.spamhaus.org/query/domain?domain=%s"; |
| 127 | 769 ignore { include "hosts-ignore.conf"; }; |
| 770 tld { include "tld.conf"; }; | |
| 771 html_tags { include "html-tags.conf"; }; | |
| 772 html_limit on 20 "Mail containing excessive bad html tags rejected"; | |
| 773 html_limit off; | |
| 774 host_limit on 20 "Mail containing excessive host names rejected"; | |
| 775 host_limit soft 20; | |
| 178 | 776 spamassassin 4; |
| 777 require_match yes; | |
| 778 dcc_greylist yes; | |
| 779 dcc_bulk_threshold 50; | |
| 127 | 780 }; |
| 781 | |
|
278
368572c57013
add limits on unique ip addresses per hour per authenticated user
Carl Byington <carl@five-ten-sg.com>
parents:
276
diff
changeset
|
782 // backscatter prevention - do not send bounces for mail that we accepted but could not forward |
| 127 | 783 // we only send bounces to our own customers |
| 784 env_from unknown { | |
| 785 "<>" black; | |
| 786 }; | |
| 136 | 787 |
|
278
368572c57013
add limits on unique ip addresses per hour per authenticated user
Carl Byington <carl@five-ten-sg.com>
parents:
276
diff
changeset
|
788 // hourly recipient rate limit by smtp auth client id, or unauthenticated mail from address |
|
368572c57013
add limits on unique ip addresses per hour per authenticated user
Carl Byington <carl@five-ten-sg.com>
parents:
276
diff
changeset
|
789 // hourly unique ip addresses by smtp auth client id, or unauthenticated mail from address |
|
368572c57013
add limits on unique ip addresses per hour per authenticated user
Carl Byington <carl@five-ten-sg.com>
parents:
276
diff
changeset
|
790 // default hourly rate limit is 30 |
|
368572c57013
add limits on unique ip addresses per hour per authenticated user
Carl Byington <carl@five-ten-sg.com>
parents:
276
diff
changeset
|
791 // daily rate limits are 4 times the hourly limit |
|
368572c57013
add limits on unique ip addresses per hour per authenticated user
Carl Byington <carl@five-ten-sg.com>
parents:
276
diff
changeset
|
792 // default hourly unique ip addresses is 5 |
|
368572c57013
add limits on unique ip addresses per hour per authenticated user
Carl Byington <carl@five-ten-sg.com>
parents:
276
diff
changeset
|
793 // daily unique ip addresses are 4 times the hourly limit |
|
368572c57013
add limits on unique ip addresses per hour per authenticated user
Carl Byington <carl@five-ten-sg.com>
parents:
276
diff
changeset
|
794 rate_limit 30 4 5 4 { // default |
|
368572c57013
add limits on unique ip addresses per hour per authenticated user
Carl Byington <carl@five-ten-sg.com>
parents:
276
diff
changeset
|
795 fred 100 10; // override default limits |
|
368572c57013
add limits on unique ip addresses per hour per authenticated user
Carl Byington <carl@five-ten-sg.com>
parents:
276
diff
changeset
|
796 joe 10 2; // "" |
|
368572c57013
add limits on unique ip addresses per hour per authenticated user
Carl Byington <carl@five-ten-sg.com>
parents:
276
diff
changeset
|
797 "sam@somedomain.tld" 500 2; |
|
368572c57013
add limits on unique ip addresses per hour per authenticated user
Carl Byington <carl@five-ten-sg.com>
parents:
276
diff
changeset
|
798 "@otherdomain.tld" 100 2; |
| 136 | 799 }; |
| 127 | 800 }; |
| 801 | |
| 171 | 802 context main { |
| 803 dnsbl localp partial.blackholes.five-ten-sg.com "Mail from %s rejected - local; see http://www.five-ten-sg.com/blackhole.php?%s"; | |
| 108 | 804 dnsbl local blackholes.five-ten-sg.com "Mail from %s rejected - local; see http://www.five-ten-sg.com/blackhole.php?%s"; |
| 174 | 805 dnsbl sbl zen.spamhaus.org "Mail from %s rejected - sbl; see http://www.spamhaus.org/query/bl?ip=%s"; |
| 108 | 806 dnsbl xbl xbl.spamhaus.org "Mail from %s rejected - xbl; see http://www.spamhaus.org/query/bl?ip=%s"; |
| 249 | 807 dnswl dnswl.org list.dnswl.org 2; |
| 171 | 808 dnsbl_list local sbl; |
| 249 | 809 dnswl_list dnswl.org; |
|
268
f941563c2a95
Add require_rdns checking
Carl Byington <carl@five-ten-sg.com>
parents:
263
diff
changeset
|
810 require_rdns yes; |
| 94 | 811 |
| 108 | 812 content on { |
| 813 filter sbl-xbl.spamhaus.org "Mail containing %s rejected - sbl; see http://www.spamhaus.org/query/bl?ip=%s"; | |
|
270
f92f24950bd3
Use mozilla prefix list for tld checking, Enable surbl/uribl/dbl rhs lists
Carl Byington <carl@five-ten-sg.com>
parents:
268
diff
changeset
|
814 uribl multi.surbl.org "Mail containing %s rejected - surbl; see http://www.surbl.org/surbl-analysis?d=%s"; |
|
259
be939802c64e
add recipient rate limits by email from address or domain
Carl Byington <carl@five-ten-sg.com>
parents:
255
diff
changeset
|
815 #uribl multi.uribl.com "Mail containing %s rejected - uribl; see http://l.uribl.com/?d=%s"; |
|
270
f92f24950bd3
Use mozilla prefix list for tld checking, Enable surbl/uribl/dbl rhs lists
Carl Byington <carl@five-ten-sg.com>
parents:
268
diff
changeset
|
816 #uribl dbl.spamhaus.org "Mail containing %s rejected - dbl; see http://www.spamhaus.org/query/domain?domain=%s"; |
| 108 | 817 ignore { include "hosts-ignore.conf"; }; |
| 818 tld { include "tld.conf"; }; | |
| 819 html_tags { include "html-tags.conf"; }; | |
| 820 html_limit off; | |
| 821 host_limit soft 20; | |
| 178 | 822 spamassassin 5; |
| 823 require_match yes; | |
| 824 dcc_greylist yes; | |
| 825 dcc_bulk_threshold 20; | |
| 108 | 826 }; |
| 94 | 827 |
|
216
784030ac71f1
Never whitelist self addressed mail. Changes for Fedora 10 and const correctness.
Carl Byington <carl@five-ten-sg.com>
parents:
214
diff
changeset
|
828 generic "^dsl.static.*ttnet.net.tr$|(^|[x.-])(ppp|h|host)?([0-9]{1,3}[x.-](Red-|dynamic[x.-])?){4}" |
| 171 | 829 "your mail server %s seems to have a generic name"; |
| 830 | |
|
259
be939802c64e
add recipient rate limits by email from address or domain
Carl Byington <carl@five-ten-sg.com>
parents:
255
diff
changeset
|
831 white_regex "=example.com=user@yourhostingaccount.com$"; |
|
233
5c3e9bf45bb5
Add whitelisting by regex expression filtering.
Carl Byington <carl@five-ten-sg.com>
parents:
216
diff
changeset
|
832 |
| 108 | 833 env_to { |
| 171 | 834 # !! replace this with your domain names |
| 108 | 835 # child contexts are not allowed to specify recipient addresses outside these domains |
| 179 | 836 # if this is a backup-mx, you need to include here domains for which you relay to the primary mx |
| 174 | 837 include "/etc/mail/local-host-names"; |
| 108 | 838 }; |
| 94 | 839 |
| 108 | 840 context whitelist { |
| 841 content off {}; | |
| 842 env_to { | |
| 171 | 843 # dcc_to ok { include "/var/dcc/whitecommon"; }; |
| 108 | 844 }; |
| 845 env_from white {}; # white forces all unmatched from addresses (everyone in this case) to be whitelisted | |
| 846 # so all mail TO these env_to addresses is accepted | |
| 847 }; | |
| 94 | 848 |
| 171 | 849 context abuse { |
| 850 dnsbl_list xbl; | |
| 851 content off {}; | |
| 174 | 852 generic "^$ " " "; # regex cannot match, to disable generic rdns rejects |
| 171 | 853 env_to { |
| 854 abuse@ # no content filtering on abuse reports | |
| 855 postmaster@ # "" | |
| 856 }; | |
| 857 env_from unknown {}; # ignore all parent white/black listing | |
| 858 }; | |
| 859 | |
| 108 | 860 context minimal { |
| 171 | 861 dnsbl_list sbl; |
| 178 | 862 content on { |
| 863 spamassassin 10; | |
| 864 dcc_bulk_threshold many; | |
| 865 }; | |
| 171 | 866 generic "^$ " " "; # regex cannot match, to disable generic rdns rejects |
| 108 | 867 env_to { |
| 868 }; | |
| 869 }; | |
| 94 | 870 |
| 108 | 871 context blacklist { |
|
255
d6d5c50b9278
Allow dnswl_list and dnsbl_list to be empty, to override lists specified in the ancestor contexts. Add daily recipient limits as a multiple of the hourly limits.
Carl Byington <carl@five-ten-sg.com>
parents:
253
diff
changeset
|
872 dnsbl_list ; |
|
d6d5c50b9278
Allow dnswl_list and dnsbl_list to be empty, to override lists specified in the ancestor contexts. Add daily recipient limits as a multiple of the hourly limits.
Carl Byington <carl@five-ten-sg.com>
parents:
253
diff
changeset
|
873 dnswl_list ; |
| 108 | 874 env_to { |
| 171 | 875 # dcc_to many { include "/var/dcc/whitecommon"; }; |
| 108 | 876 }; |
| 877 env_from black {}; # black forces all unmatched from addresses (everyone in this case) to be blacklisted | |
| 878 # so all mail TO these env_to addresses is rejected | |
| 879 }; | |
| 94 | 880 |
| 171 | 881 env_from unknown { |
| 882 abuse@ abuse; # replies to abuse reports use the abuse context | |
| 883 # dcc_from { include "/var/dcc/whitecommon"; }; | |
| 108 | 884 }; |
| 885 | |
| 171 | 886 autowhite 90 "autowhite/my-auto-whitelist"; |
| 887 # install should create /etc/dnsbl/autowhite writable by userid dnsbl | |
| 108 | 888 };]]></literallayout> |
| 889 </refsect1> | |
| 94 | 890 |
| 111 | 891 <refsect1 id='version.5'> |
|
201
752d4315675c
add reference to mercurial repository in the documentation
Carl Byington <carl@five-ten-sg.com>
parents:
187
diff
changeset
|
892 <title>Version</title> |
| 108 | 893 <para> |
|
201
752d4315675c
add reference to mercurial repository in the documentation
Carl Byington <carl@five-ten-sg.com>
parents:
187
diff
changeset
|
894 @VERSION@ |
| 108 | 895 </para> |
| 896 </refsect1> | |
| 897 | |
| 898 </refentry> | |
| 899 </reference> |