Mercurial > dnsbl
annotate xml/dnsbl.in @ 161:d384df37491f stable-6-02
allow manual updates to auto whitelist files
author | carl |
---|---|
date | Tue, 10 Jul 2007 14:09:23 -0700 |
parents | b3ed72ee6564 |
children | c4bce911c276 |
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> | |
161 | 15 <date>2007-07-10</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> | |
156 | 179 Consider the case of a message from A to B passing thru this milter. |
180 If that message is not blocked, then we might eventually see a reply | |
181 message from B to A. If the filtering context for A includes an | |
182 autowhite entry, then this milter will add an entry in that file to | |
160 | 183 whitelist such replies for a configurable time period. Such autowhite |
184 files need to be writeable by the dnsbl user, where all the other dnsbl | |
185 configuration files only need to be readable by the dnsbl user. | |
156 | 186 </para> |
187 <para> | |
108 | 188 The DNSBL milter reads a text configuration file (dnsbl.conf) on |
189 startup, and whenever the config file (or any of the referenced include | |
190 files) is changed. The entire configuration file is case insensitive. | |
191 If the configuration cannot be loaded due to a syntax error, the milter | |
192 will log the error and quit. If the configuration cannot be reloaded | |
193 after being modified, the milter will log the error and send an email to | |
152 | 194 root from dnsbl@$hostname. You probably want to add dnsbl@$hostname |
108 | 195 to your /etc/mail/virtusertable since otherwise sendmail will reject |
196 that message. | |
197 </para> | |
198 </refsect1> | |
94 | 199 |
111 | 200 <refsect1 id='dcc.1'> |
108 | 201 <title>DCC Issues</title> |
202 <para> | |
203 If you are also using the <ulink | |
204 url="http://www.rhyolite.com/anti-spam/dcc/">DCC</ulink> milter, there | |
205 are a few considerations. You may need to whitelist senders from the | |
206 DCC bulk detector, or from the DNS based lists. Those are two very | |
207 different reasons for whitelisting. The former is done thru the DCC | |
208 whiteclnt config file, the later is done thru the DNSBL milter config | |
209 file. | |
210 </para> | |
211 <para> | |
212 You may want to blacklist some specific senders or sending domains. | |
213 This could be done thru either the DCC (on a global basis, or for a | |
214 specific single recipient). We prefer to do such blacklisting via the | |
215 DNSBL milter config, since it can be done for a collection of recipient | |
216 mail domains. The DCC approach has the feature that you can capture the | |
217 entire message in the DCC log files. The DNSBL milter approach has the | |
218 feature that the mail is rejected earlier (at RCPT TO time), and the | |
219 sending machine just gets a generic "550 5.7.1 no such user" message. | |
220 </para> | |
221 <para> | |
222 The DCC whiteclnt file can be included in the DNSBL milter config by the | |
223 dcc_to and dcc_from statements. This will import the (env_to, env_from, | |
224 and substitute mail_host) entries from the DCC config into the DNSBL | |
225 config. This allows using the DCC config as the single point for | |
226 white/blacklisting. | |
227 </para> | |
228 <para> | |
229 Consider the case where you have multiple clients, each with their own | |
230 mail servers, and each running their own DCC milters. Each client is | |
231 using the DCC facilities for envelope from/to white/blacklisting. | |
232 Presumably you can use rsync or scp to fetch copies of your clients DCC | |
233 whiteclnt files on a regular basis. Your mail server, acting as a | |
234 backup MX for your clients, can use the DNSBL milter, and include those | |
235 client DCC config files. The envelope from/to white/blacklisting will | |
236 be appropriately tagged and used only for the domains controlled by each | |
237 of those clients. | |
238 </para> | |
239 </refsect1> | |
94 | 240 |
111 | 241 <refsect1 id='definitions.1'> |
108 | 242 <title>Definitions</title> |
243 <para> | |
244 CONTEXT - a collection of parameters that defines the filtering context | |
245 to be used for a collection of envelope recipient addresses. The | |
246 context includes such things as the list of DNSBLs to be used, and the | |
247 various content filtering parameters. | |
248 </para> | |
249 <para> | |
250 DNSBL - a named DNS based blocking list is defined by a dns suffix (e.g. | |
251 sbl-xbl.spamhaus.org) and a message string that is used to generate the | |
252 "550 5.7.1" smtp error return code. The names of these DNSBLs will be | |
253 used to define the DNSBL-LISTs. | |
254 </para> | |
255 <para> | |
256 DNSBL-LIST - a named list of DNSBLs that will be used for specific | |
257 recipients or recipient domains. | |
258 </para> | |
259 </refsect1> | |
94 | 260 |
111 | 261 <refsect1 id='filtering.1'> |
108 | 262 <title>Filtering Procedure</title> |
263 <para> | |
152 | 264 The SMTP envelope 'from' and 'to' values are used in various checks. |
265 The first check is to see if a reply message (swapping the env_from and | |
160 | 266 env_to values) would be unconditionally blocked (just based on the |
267 envelope from address). That check is similar to the main check | |
268 described below, but there is no body content to be scanned, and there | |
269 is no client connection ip address to be checked against DNSBLs. If | |
270 such a reply message would be blocked, we also block the original | |
271 outgoing message. This prevents folks from sending mail to recipients | |
272 that are unable to reply. | |
152 | 273 </para> |
274 <para> | |
136 | 275 If the client has authenticated with sendmail, the rate limits are |
276 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
|
277 limit, then the mail is accepted, the filtering contexts are not used, |
136 | 278 the dns lists are not checked, and the body content is not scanned. If |
279 the client has not authenticated with sendmail, we follow these steps | |
280 for each recipient. | |
108 | 281 </para> |
282 <orderedlist> | |
111 | 283 <listitem><para> |
108 | 284 The envelope to email address is used to find an initial filtering |
285 context. We first look for a context that specified the full email | |
286 address in the env_to statement. If that is not found, we look for a | |
287 context that specified the entire domain name of the envelope recipient | |
288 in the env_to statement. If that is not found, we look for a context | |
289 that specified the user@ part of the envelope recipient in the env_to | |
290 statement. If that is not found, we use the first top level context | |
291 defined in the config file. | |
111 | 292 </para></listitem> |
293 <listitem><para> | |
108 | 294 The initial filtering context may redirect to a child context based on |
295 the values in the initial context's env_from statement. We look for [1) | |
296 the full envelope from email address, 2) the domain name part of the | |
297 envelope from address, 3) the user@ part of the envelope from address] | |
298 in that context's env_from statement, with values that point to a child | |
299 context. If such an entry is found, we switch to that child filtering | |
300 context. | |
111 | 301 </para></listitem> |
302 <listitem><para> | |
108 | 303 We lookup [1) the full envelope from email address, 2) the domain name |
304 part of the envelope from address, 3) the user@ part of the envelope | |
305 from address] in the filtering context env_from statement. That results | |
306 in one of (white, black, unknown, inherit). | |
111 | 307 </para></listitem> |
308 <listitem><para> | |
108 | 309 If the answer is black, mail to this recipient is rejected with "no such |
310 user", and the dns lists are not checked. | |
111 | 311 </para></listitem> |
312 <listitem><para> | |
108 | 313 If the answer is white, mail to this recipient is accepted and the dns |
314 lists are not checked. | |
111 | 315 </para></listitem> |
316 <listitem><para> | |
108 | 317 If the answer is unknown, we don't reject yet, but the dns lists will be |
318 checked, and the content may be scanned. | |
111 | 319 </para></listitem> |
320 <listitem><para> | |
108 | 321 If the answer is inherit, we repeat the envelope from search in the |
322 parent context. | |
111 | 323 </para></listitem> |
324 <listitem><para> | |
108 | 325 The dns lists specified in the filtering context are checked and the |
326 mail is rejected if any list has an A record for the standard dns based | |
327 lookup scheme (reversed octets of the client followed by the dns | |
328 suffix). | |
111 | 329 </para></listitem> |
330 <listitem><para> | |
108 | 331 If the mail has not been accepted or rejected yet, we look for a |
332 verification context, which is the closest ancestor of the filtering | |
333 context that both specifies a verification host, and which covers the | |
334 envelope to address. If we find such a verification context, and the | |
335 verification host is not our own hostname, we open an smtp conversation | |
336 with that verification host. The current envelope from and recipient to | |
337 values are passed to that verification host. If we receive a 5xy | |
338 response those commands, we reject the current recipient with "no such | |
339 user". | |
111 | 340 </para></listitem> |
341 <listitem><para> | |
108 | 342 If the mail has not been accepted or rejected yet, and the filtering |
343 context enables content filtering, and this is the first such recipient | |
344 in this smtp transaction, we set the content filtering parameters from | |
345 this context, and enable content filtering for the body of this message. | |
111 | 346 </para></listitem> |
108 | 347 </orderedlist> |
348 <para> | |
160 | 349 For each recipient that was accepted, we search for an autowhite entry |
350 starting in the reply filtering context. If an autowhite entry is found, | |
351 we add the recipient to that auto whitelist file. This will prevent reply | |
352 messages from being blocked by the dnsbl or content filtering. | |
353 </para> | |
354 <para> | |
108 | 355 If content filtering is enabled for this body, the mail text is decoded |
119 | 356 (uuencode, base64, mime, html entity, url encodings), and scanned for HTTP |
357 and HTTPS URLs or bare host names. Hostnames must be either ip address | |
358 literals, or must end in a string defined by the TLD list. The first | |
359 <configurable> host names are checked as follows. | |
360 </para> | |
361 <para> | |
362 The only known list that is suitable for the content filter DNSBL is the | |
363 SBL. If the content filter DNSBL is defined, and any of those host | |
364 names resolve to ip addresses that are on that DNSBL (or have | |
365 nameservers that are on that list), and the host name is not on the | |
366 <configurable> ignore list, the mail is rejected. | |
367 </para> | |
368 <para> | |
369 If the content uribl DNSBL is defined, and any of those host names are | |
370 on that DNSBL, and the host name is not on the <configurable> | |
371 ignore list, the mail is rejected. | |
372 </para> | |
373 <para> | |
374 We also scan for excessive bad html tags, and if a <configurable> | |
375 limit is exceeded, the mail is rejected. | |
108 | 376 </para> |
377 </refsect1> | |
94 | 378 |
111 | 379 <refsect1 id='access.1'> |
108 | 380 <title>Sendmail access vs. DNSBL</title> |
381 <para> | |
382 With the standard sendmail.mc dnsbl FEATURE, the dnsbl checks may be | |
383 suppressed by entries in the /etc/mail/access database. For example, | |
384 suppose you control a /18 of address space, and have allocated some /24s | |
385 to some clients. You have access entries like | |
111 | 386 <literallayout class="monospaced"><![CDATA[ |
387 192.168.4 OK | |
388 192.168.17 OK]]></literallayout> | |
108 | 389 </para> |
390 <para> | |
391 to allow those clients to smarthost thru your mail server. Now if one | |
392 of those clients happens get infected with a virus that turns a machine | |
393 into an open proxy, and their 192.168.4.45 lands on the SBL-XBL, you | |
394 will still wind up allowing that infected machine to smarthost thru your | |
395 mail servers. | |
396 </para> | |
397 <para> | |
398 With this DNSBL milter, the sendmail access database cannot override the | |
399 dnsbl checks, so that machine won't be able to send mail to or thru your | |
400 smarthost mail server (unless the virus/proxy can use smtp-auth). | |
401 </para> | |
402 <para> | |
403 Using the standard sendmail features, you would add access entries to | |
404 allow hosts on your local network to relay thru your mail server. Those | |
405 OK entries in the sendmail access database will override all the dnsbl | |
406 checks. With this DNSBL milter, you will need to have the local users | |
407 authenticate with smtp-auth to get the same effect. You might find | |
408 <ulink | |
409 url="http://www.ists.dartmouth.edu/classroom/sendmail-ssl-how-to.php"> | |
410 these directions</ulink> helpful for setting up smtp-auth if you are on | |
411 RH Linux. | |
412 </para> | |
413 </refsect1> | |
94 | 414 |
111 | 415 <refsect1 id='performance.1'> |
108 | 416 <title>Performance Issues</title> |
417 <para> | |
418 Consider a high volume high performance machine running sendmail. Each | |
419 sendmail process can do its own dns resolution. Typically, such dns | |
420 resolver libraries are not thread safe, and so must be protected by some | |
421 sort of mutex in a threaded environment. When we add a milter to | |
422 sendmail, we now have a collection of sendmail processes, and a | |
423 collection of milter threads. | |
424 </para> | |
425 <para> | |
426 We will be doing a lot of dns lookups per mail message, and at least | |
427 some of those will take many tens of seconds. If all this dns work is | |
428 serialized inside the milter, we have an upper limit of about 25K mail | |
429 messages per day. That is clearly not sufficient for many sites. | |
430 </para> | |
431 <para> | |
432 Since we want to do parallel dns resolution across those milter threads, | |
433 we add another collection of dns resolver processes. Each sendmail | |
434 process is talking to a milter thread over a socket, and each milter | |
435 thread is talking to a dns resolver process over another socket. | |
436 </para> | |
437 <para> | |
438 Suppose we are processing 20 messages per second, and each message | |
439 requires 20 seconds of dns work. Then we will have 400 sendmail | |
440 processes, 400 milter threads, and 400 dns resolver processes. Of | |
441 course that steady state is very unlikely to happen. | |
442 </para> | |
443 </refsect1> | |
94 | 444 |
445 | |
111 | 446 <refsect1 id='rejected.1'> |
108 | 447 <title>Rejected Ideas</title> |
448 <para> | |
449 The following ideas have been considered and rejected. | |
450 </para> | |
451 <para> | |
111 | 452 Add max_recipients setting to the context configuration. Recipients in |
453 excess of that limit will be rejected, and all the non-whitelisted | |
454 recipients will be removed. Current spammers *very* rarely send more | |
455 than ten recipients in a single smtp transaction, so this won't stop any | |
108 | 456 significant amount of spam. |
457 </para> | |
458 <para> | |
459 Add poison addresses to the configuration. If any recipient is | |
460 poison, all recipients are rejected even if they would be whitelisted, | |
461 and the data is rejected if sent. I have a collection of spam trap | |
462 addresses that would be suitable for such use. Based on my log files, | |
463 any mail to those spam trap addresses is rejected based on either dnsbl | |
464 lookups or the DCC. So this won't result in blocking any additional | |
465 spam. | |
466 </para> | |
467 <para> | |
468 Add an option to only allow one recipient if the return path is | |
469 empty. Based on my log files, there is no mail that violates this | |
470 check. | |
471 </para> | |
472 <para> | |
473 Reject the mail if the envelope from domain name contains any MX | |
474 records pointing to 127.0.0.0/8. I don't see any significant amount of | |
475 spam sent with such domain names. | |
476 </para> | |
477 </refsect1> | |
94 | 478 |
108 | 479 <refsect1 id='todo.1'> |
480 <title>TODO</title> | |
481 <para> | |
482 The following ideas are under consideration. | |
483 </para> | |
484 <para> | |
485 Add a per-context option to reject mail if the number of digits in | |
486 the reverse dns client name exceeds some threshold. | |
487 </para> | |
115 | 488 <para> |
489 Look for href="hostname/path" strings that are missing the required | |
490 http:// protocol header. Such references are still clickable in common | |
491 mail software. | |
492 </para> | |
108 | 493 </refsect1> |
94 | 494 |
111 | 495 <refsect1 id='copyright.1'> |
108 | 496 <title>Copyright</title> |
497 <para> | |
498 Copyright (C) 2005 by 510 Software Group <carl@five-ten-sg.com> | |
499 </para> | |
500 <para> | |
501 This program is free software; you can redistribute it and/or modify it | |
502 under the terms of the GNU General Public License as published by the | |
160 | 503 Free Software Foundation; either version 3, or (at your option) any |
108 | 504 later version. |
505 </para> | |
506 <para> | |
507 You should have received a copy of the GNU General Public License along | |
508 with this program; see the file COPYING. If not, please write to the | |
509 Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. | |
510 </para> | |
511 </refsect1> | |
94 | 512 |
111 | 513 <refsect1 id='version.1'> |
514 <title>CVS Version</title> | |
108 | 515 <para> |
516 $Id$ | |
517 </para> | |
518 </refsect1> | |
519 </refentry> | |
520 | |
521 | |
522 <refentry id="@PACKAGE@.conf.5"> | |
523 <refentryinfo> | |
161 | 524 <date>2007-07-10</date> |
108 | 525 </refentryinfo> |
94 | 526 |
108 | 527 <refmeta> |
528 <refentrytitle>@PACKAGE@.conf</refentrytitle> | |
529 <manvolnum>5</manvolnum> | |
530 <refmiscinfo>@PACKAGE@ @VERSION@</refmiscinfo> | |
531 </refmeta> | |
94 | 532 |
108 | 533 <refnamediv id='name.5'> |
534 <refname>@PACKAGE@.conf</refname> | |
111 | 535 <refpurpose>configuration file for @PACKAGE@ sendmail milter</refpurpose> |
108 | 536 </refnamediv> |
537 | |
538 <refsynopsisdiv id='synopsis.5'> | |
539 <title>Synopsis</title> | |
540 <cmdsynopsis> | |
541 <command>@PACKAGE@.conf</command> | |
542 </cmdsynopsis> | |
543 </refsynopsisdiv> | |
94 | 544 |
108 | 545 <refsect1 id='description.5'> |
546 <title>Description</title> | |
547 <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
|
548 specified by this partial bnf description. Comments start with // |
9330b8d6a56b
add documentation fixes, allow env_from target of inherit
carl
parents:
144
diff
changeset
|
549 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
|
550 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
|
551 <literallayout class="monospaced"><![CDATA[include "<file>";]]></literallayout> |
9330b8d6a56b
add documentation fixes, allow env_from target of inherit
carl
parents:
144
diff
changeset
|
552 </para> |
108 | 553 |
554 <literallayout class="monospaced"><![CDATA[ | |
555 CONFIG = {CONTEXT ";"}+ | |
556 CONTEXT = "context" NAME "{" {STATEMENT}+ "}" | |
153 | 557 STATEMENT = (DNSBL | DNSBLLIST | CONTENT | ENV-TO | VERIFY | |
558 AUTOWHITE | CONTEXT | ENV-FROM | RATE-LIMIT) ";" | |
108 | 559 |
124 | 560 DNSBL = "dnsbl" NAME DNSPREFIX ERROR-MSG1 |
108 | 561 |
562 DNSBLLIST = "dnsbl_list" {NAME}+ | |
94 | 563 |
108 | 564 CONTENT = "content" ("on" | "off") "{" {CONTENT-ST}+ "}" |
119 | 565 CONTENT-ST = (FILTER | URIBL | IGNORE | TLD | CCTLD | HTML-TAGS | |
566 HTML-LIMIT | HOST-LIMIT) ";" | |
124 | 567 FILTER = "filter" DNSPREFIX ERROR-MSG2 |
568 URIBL = "uribl" DNSPREFIX ERROR-MSG3 | |
108 | 569 IGNORE = "ignore" "{" {HOSTNAME [";"]}+ "}" |
570 TLD = "tld" "{" {TLD [";"]}+ "}" | |
119 | 571 CCTLD = "cctld" "{" {TLD [";"]}+ "}" |
108 | 572 HTML-TAGS = "html_tags" "{" {HTMLTAG [";"]}+ "}" |
124 | 573 ERROR-MSG1 = string containing exactly two %s replacement tokens |
574 both are replaced with the client ip address | |
575 ERROR-MSG2 = string containing exactly two %s replacement tokens | |
576 the first is replaced with the hostname, and the second | |
577 is replaced with the ip address | |
578 ERROR-MSG3 = string containing exactly two %s replacement tokens | |
579 both are replaced with the hostname | |
108 | 580 |
581 HTML-LIMIT = "html_limit" ("on" INTEGER ERROR-MSG | "off") | |
582 | |
111 | 583 HOST-LIMIT = "host_limit" ("on" INTEGER ERROR-MSG | "off" | |
584 "soft" INTEGER) | |
94 | 585 |
108 | 586 ENV-TO = "env_to" "{" {(TO-ADDR | DCC-TO)}+ "}" |
587 TO-ADDR = ADDRESS [";"] | |
588 DCC-TO = "dcc_to" ("ok" | "many") "{" DCCINCLUDEFILE "}" ";" | |
589 | |
590 VERIFY = "verify" HOSTNAME ";" | |
153 | 591 AUTOWHITE = "autowhite" DAYS FILENAME ";" |
108 | 592 |
593 ENV_FROM = "env_from" [DEFAULT] "{" {(FROM-ADDR | DCC-FROM)}+ "}" | |
594 FROM-ADDR = ADDRESS VALUE [";"] | |
595 DCC-FROM = "dcc_from" "{" DCCINCLUDEFILE "}" ";" | |
136 | 596 |
140 | 597 RATE-LIMIT = "rate_limit" [DEFAULTLIMIT] "{" (RATE)+ "}" |
136 | 598 RATE = USER LIMIT [";"] |
599 | |
108 | 600 DEFAULT = ("white" | "black" | "unknown" | "inherit" | "") |
601 ADDRESS = (USER@ | DOMAIN | USER@DOMAIN) | |
148
9330b8d6a56b
add documentation fixes, allow env_from target of inherit
carl
parents:
144
diff
changeset
|
602 VALUE = ("white" | "black" | "unknown" | "inherit" | CHILD-CONTEXT-NAME)]]></literallayout> |
108 | 603 </refsect1> |
94 | 604 |
108 | 605 <refsect1 id='sample.5'> |
606 <title>Sample</title> | |
607 <literallayout class="monospaced"><![CDATA[ | |
127 | 608 context main-default { |
609 // outbound dnsbl filtering to catch our own customers that end up on the sbl | |
144
31ff00ea6bfb
allow parent/child to share a fully qualified env_to address
carl
parents:
140
diff
changeset
|
610 dnsbl localp partial.blackholes.five-ten-sg.com "Mail from %s rejected - local; see http://www.five-ten-sg.com/blackhole.php?%s"; |
127 | 611 dnsbl local blackholes.five-ten-sg.com "Mail from %s rejected - local; see http://www.five-ten-sg.com/blackhole.php?%s"; |
612 dnsbl sbl sbl-xbl.spamhaus.org "Mail from %s rejected - sbl; see http://www.spamhaus.org/query/bl?ip=%s"; | |
613 dnsbl dul dul.dnsbl.sorbs.net "Mail from %s rejected - dul; see http://www.sorbs.net/lookup.shtml?%s"; | |
614 dnsbl_list local sbl dul; | |
615 | |
616 // outbound content filtering to prevent our own customers from sending spam | |
617 content on { | |
618 filter sbl-xbl.spamhaus.org "Mail containing %s rejected - sbl; see http://www.spamhaus.org/query/bl?ip=%s"; | |
619 uribl multi.surbl.org "Mail containing %s rejected - surbl; see http://www.rulesemporium.com/cgi-bin/uribl.cgi?bl0=1&domain0=%s"; | |
620 #uribl black.uribl.com "Mail containing %s rejected - uribl; see http://l.uribl.com/?d=%s"; | |
621 ignore { include "hosts-ignore.conf"; }; | |
622 tld { include "tld.conf"; }; | |
623 cctld { include "cctld.conf"; }; | |
624 html_tags { include "html-tags.conf"; }; | |
625 html_limit on 20 "Mail containing excessive bad html tags rejected"; | |
626 html_limit off; | |
627 host_limit on 20 "Mail containing excessive host names rejected"; | |
628 host_limit soft 20; | |
629 }; | |
630 | |
631 // backscatter prevention - don't send bounces for mail that we accepted but could not forward | |
632 // we only send bounces to our own customers | |
633 env_from unknown { | |
634 "<>" black; | |
635 }; | |
136 | 636 |
144
31ff00ea6bfb
allow parent/child to share a fully qualified env_to address
carl
parents:
140
diff
changeset
|
637 // hourly recipient rate limit by smtp auth client id |
140 | 638 rate_limit 30 { // default |
136 | 639 fred 100; // override default limits |
140 | 640 joe 10; // "" |
136 | 641 }; |
127 | 642 }; |
643 | |
108 | 644 context sample { |
645 dnsbl local blackholes.five-ten-sg.com "Mail from %s rejected - local; see http://www.five-ten-sg.com/blackhole.php?%s"; | |
646 dnsbl sbl sbl-xbl.spamhaus.org "Mail from %s rejected - sbl; see http://www.spamhaus.org/query/bl?ip=%s"; | |
647 dnsbl xbl xbl.spamhaus.org "Mail from %s rejected - xbl; see http://www.spamhaus.org/query/bl?ip=%s"; | |
648 dnsbl dul dul.dnsbl.sorbs.net "Mail from %s rejected - dul; see http://www.sorbs.net/lookup.shtml?%s"; | |
649 dnsbl_list local sbl dul; | |
94 | 650 |
108 | 651 content on { |
652 filter sbl-xbl.spamhaus.org "Mail containing %s rejected - sbl; see http://www.spamhaus.org/query/bl?ip=%s"; | |
122 | 653 uribl multi.surbl.org "Mail containing %s rejected - surbl; see http://www.rulesemporium.com/cgi-bin/uribl.cgi?bl0=1&domain0=%s"; |
119 | 654 #uribl black.uribl.com "Mail containing %s rejected - uribl; see http://l.uribl.com/?d=%s"; |
108 | 655 ignore { include "hosts-ignore.conf"; }; |
656 tld { include "tld.conf"; }; | |
119 | 657 cctld { include "cctld.conf"; }; |
108 | 658 html_tags { include "html-tags.conf"; }; |
659 html_limit on 20 "Mail containing excessive bad html tags rejected"; | |
660 html_limit off; | |
661 host_limit on 20 "Mail containing excessive host names rejected"; | |
662 host_limit soft 20; | |
663 }; | |
94 | 664 |
108 | 665 env_to { |
666 # child contexts are not allowed to specify recipient addresses outside these domains | |
667 # leave this outer global context env_to empty to allow arbitrary recipients in child contexts | |
668 mydomain.com; | |
669 customer1.com; | |
670 customer1a.com; | |
671 customer1b.com; | |
672 customer2.com; | |
673 customer2a.com; | |
674 customer2b.com; | |
675 }; | |
94 | 676 |
108 | 677 context whitelist { |
678 content off {}; | |
679 env_to { | |
680 # dcc_to ok { include "/var/dcc/whitecommon"; }; # copy the dcc OK values (env_to) into this context | |
681 }; | |
682 env_from white {}; # white forces all unmatched from addresses (everyone in this case) to be whitelisted | |
683 # so all mail TO these env_to addresses is accepted | |
684 }; | |
94 | 685 |
108 | 686 context minimal { |
687 dnsbl_list sbl dul; | |
688 content on {}; | |
689 env_to { | |
690 sales@mydomain.com; | |
691 }; | |
692 }; | |
94 | 693 |
108 | 694 context blacklist { |
695 env_to { | |
696 dcc_to many { include "/var/dcc/whitecommon"; }; # copy the dcc MANY values (env_to) into this context | |
697 old-employee@mydomain.com; | |
698 }; | |
699 env_from black {}; # black forces all unmatched from addresses (everyone in this case) to be blacklisted | |
700 # so all mail TO these env_to addresses is rejected | |
701 }; | |
94 | 702 |
108 | 703 context vp { # special context for the vp |
704 env_to { | |
705 vp@mydomain.com; | |
706 }; | |
707 env_from inherit { | |
708 nai.com black; # the vp does not like nai | |
709 yahoo.com unknown; # override parent context blacklisting | |
710 mother@spammyisp.com white; # suppress dnsbl checking | |
711 }; | |
712 }; | |
713 | |
714 context customer1 { | |
715 dnsbl_list sbl dul; | |
716 env_to { | |
717 customer1.com; | |
718 customer1a.com; | |
719 customer1b.com; | |
720 }; | |
94 | 721 |
153 | 722 # we can reject unknown users |
108 | 723 verify mail.customer1.com; |
94 | 724 |
153 | 725 # whitelist anyone to whom we have sent mail in the last 90 days |
726 autowhite 90 "autowhite/customer1"; | |
727 | |
108 | 728 context customer1a { |
729 env_to { | |
730 customer1a.com; | |
148
9330b8d6a56b
add documentation fixes, allow env_from target of inherit
carl
parents:
144
diff
changeset
|
731 }; |
108 | 732 env_from black { # blacklist everything |
733 first@acceptable.com unknown; # except these specific envelope senders | |
734 second@another.com unknown; | |
735 yahoo.com inherit; # delegate to the parent | |
736 }; | |
737 }; | |
738 | |
739 env_from { # default value of the default is inherit | |
740 yahoo.com black; # no mail from yahoo | |
741 first@yahoo.com unknown; # except this one | |
742 }; | |
743 }; | |
94 | 744 |
108 | 745 context customer2 { |
746 dnsbl_list sbl; | |
747 env_to { | |
748 customer2.com; | |
749 customer2a.com; | |
750 customer2b.com; | |
751 }; | |
752 }; | |
104 | 753 |
149 | 754 # this is at the end, so that these abuse@ and postmaster@ entries will |
755 # override any conflicting entries inside the customer contexts. | |
756 context abuse { | |
757 dnsbl_list xbl; | |
758 content off {}; | |
759 env_to { | |
760 abuse@; # no content filtering on abuse reports | |
761 postmaster@; # "" | |
762 }; | |
763 env_from unknown {}; # ignore all parent white/black listing | |
764 }; | |
765 | |
108 | 766 env_from unknown { |
767 dcc_from { include "/var/dcc/whitecommon"; }; # copy the dcc OK/MANY values (env_from, substitute mail_host) into this context | |
768 abuse@ abuse; # replies to abuse reports use the abuse context | |
769 yahoo.com black; # don't take mail from yahoo | |
770 spammer@example.com black; | |
771 }; | |
772 };]]></literallayout> | |
773 </refsect1> | |
94 | 774 |
111 | 775 <refsect1 id='version.5'> |
776 <title>CVS Version</title> | |
108 | 777 <para> |
778 $Id$ | |
779 </para> | |
780 </refsect1> | |
781 | |
782 </refentry> | |
783 </reference> |