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