annotate xml/sample.conf @ 80:d554e41f2886

start coding on new config syntax
author carl
date Sat, 16 Jul 2005 20:25:35 -0700
parents 81f1e400e8ab
children 7e4a90e5f213
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
15a7e942adec updates to use dcc conf files
carl
parents: 0
diff changeset
1 # $Id$
0
96a9758165cd Initial revision
carl
parents:
diff changeset
2 #
75
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
3
80
d554e41f2886 start coding on new config syntax
carl
parents: 76
diff changeset
4 # Partial bnf description of this configuration language. Any sequence of
d554e41f2886 start coding on new config syntax
carl
parents: 76
diff changeset
5 # three tokens ("include" FILENAME ";") are replaced by the content of the
d554e41f2886 start coding on new config syntax
carl
parents: 76
diff changeset
6 # specified file.
d554e41f2886 start coding on new config syntax
carl
parents: 76
diff changeset
7 #
56
57607387263d updates for 3.6, better documentation on removing content filtering, missing some files in cvs
carl
parents: 54
diff changeset
8 #
75
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
9 # CONFIG = {CONTEXT ";"}+
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
10 # CONTEXT = "context" NAME "{" {STATEMENT}+ "}"
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
11 # STATEMENT = (DNSBL | DNSBLLIST | CONTENT | ENV-TO | CONTEXT | ENV-FROM) ";"
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
12
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
13 # DNSBL = "dnsbl" NAME DNSPREFIX ERROR-MSG
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
14
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
15 # DNSBLLIST = "dnsbl_list" {NAME}+
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
16
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
17 # CONTENT = "content" ("on" | "off") "{" {CONTENT-STATEMENT}+ "}"
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
18 # CONTENT-STATEMENT = (FILTER | IGNORE | TLD | HTML-TAGS | HTML-LIMIT | HOST-LIMIT) ";"
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
19 # FILTER = "filter" DNSPREFIX ERROR-MSG
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
20 # IGNORE = "ignore" "{" {HOSTNAME [";"]}+ "}"
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
21 # TLD = "tld" "{" {TLD [";"]}+ "}"
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
22 # HTML-TAGS = "html_tags" "{" {HTMLTAG [";"]}+ "}"
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
23 # ERROR-MSG = string containing exactly two %s replacement tokens for the client ip address
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
24
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
25 # HTML-LIMIT = "html_limit" ("on" INTEGER ERROR-MSG | "off")
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
26
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
27 # HOST-LIMIT = "host_limit" ("on" INTEGER ERROR-MSG | "off" | "soft" INTEGER)
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
28
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
29 # ENV-TO = "env_to" "{" {(TO-ADDR | DCC-TO)}+ "}"
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
30 # TO-ADDR = ADDRESS [";"]
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
31 # DCC-TO = "dcc_to" ("ok" | "many") "{" DCCINCLUDEFILE "}" ";"
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
32
80
d554e41f2886 start coding on new config syntax
carl
parents: 76
diff changeset
33 # ENV_FROM = "env_from" [DEFAULT] "{" {(FROM-ADDR | DCC-FROM)}+ "}"
75
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
34 # FROM-ADDR = ADDRESS VALUE [";"]
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
35 # DCC-FROM = "dcc_from" "{" DCCINCLUDEFILE "}" ";"
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
36 # DEFAULT = ("white" | "black" | "unknown" | "inherit" | "")
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
37 # ADDRESS = (USER@ | DOMAIN | USER@DOMAIN)
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
38 # VALUE = ("white" | "black" | "unknown" | CHILD-CONTEXT-NAME
24
2e23b7184d2b start coding for bad html tag detection
carl
parents: 20
diff changeset
39
2e23b7184d2b start coding for bad html tag detection
carl
parents: 20
diff changeset
40
75
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
41 context sample {
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
42 dnsbl local blackholes.five-ten-sg.com "Mail from %s rejected - local; see http://www.five-ten-sg.com/blackhole.php?%s";
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
43 dnsbl spews blackholes.spews.org "Mail from %s rejected - spews; see http://www.spews.org/ask.cgi?x=%s";
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
44 dnsbl sbl sbl-xbl.spamhaus.org "Mail from %s rejected - sbl; see http://www.spamhaus.org/query/bl?ip=%s";
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
45 dnsbl xbl xbl.spamhaus.org "Mail from %s rejected - xbl; see http://www.spamhaus.org/query/bl?ip=%s";
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
46 dnsbl_list local sbl;
0
96a9758165cd Initial revision
carl
parents:
diff changeset
47
75
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
48 content on {
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
49 filter sbl-xbl.spamhaus.org "Mail containing %s rejected - sbl; see http://www.spamhaus.org/query/bl?ip=%s";
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
50 ignore { include "hosts-ignore.conf"; };
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
51 tld { include "tld.conf"; };
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
52 html_tags { include "html-tags.conf"; };
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
53 html_limit off;
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
54 host_limit on 20 "Mail containing excessive bad html tags rejected";
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
55 host_limit soft 20;
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
56 };
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
57
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
58 env_to {
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
59 mydomain.com; # child contexts are not allowed to specify recipient addresses outside these domains
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
60 customer1.com;
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
61 customer1a.com;
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
62 customer1b.com;
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
63 customer2.com;
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
64 customer2a.com;
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
65 customer2b.com;
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
66 };
0
96a9758165cd Initial revision
carl
parents:
diff changeset
67
75
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
68 context whitelist {
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
69 content off {};
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
70 env_to {
80
d554e41f2886 start coding on new config syntax
carl
parents: 76
diff changeset
71 # dcc_to ok { include "/var/dcc/whitecommon"; }; # copy the dcc OK values (env_to) into this context
75
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
72 };
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
73 env_from white {}; # white forces all unmatched from addresses (everyone in this case) to be whitelisted
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
74 # so all mail TO these env_to addresses is accepted
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
75 };
0
96a9758165cd Initial revision
carl
parents:
diff changeset
76
75
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
77 context abuse {
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
78 dnsbl_list xbl;
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
79 content off {};
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
80 env_to {
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
81 abuse@; # no content filtering on abuse reports
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
82 postmaster@; # ""
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
83 };
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
84 env_from unknown {}; # ignore all parent white/black listing
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
85 };
0
96a9758165cd Initial revision
carl
parents:
diff changeset
86
75
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
87 context minimal {
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
88 dnsbl_list sbl;
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
89 content on {};
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
90 env_to {
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
91 sales@mydomain.com;
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
92 };
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
93 };
0
96a9758165cd Initial revision
carl
parents:
diff changeset
94
75
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
95 context blacklist {
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
96 env_to {
80
d554e41f2886 start coding on new config syntax
carl
parents: 76
diff changeset
97 dcc_to many { include "/var/dcc/whitecommon"; }; # copy the dcc MANY values (env_to) into this context
75
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
98 old-employee@mydomain.com;
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
99 };
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
100 env_from black {}; # black forces all unmatched from addresses (everyone in this case) to be blacklisted
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
101 # so all mail TO these env_to addresses is rejected
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
102 };
0
96a9758165cd Initial revision
carl
parents:
diff changeset
103
75
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
104 context vp { # special context for the vp
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
105 env_to {
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
106 vp@mydomain.com;
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
107 };
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
108 env_from inherit {
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
109 nai.com black; # the vp does not like nai
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
110 yahoo.com unknown; # override parent context blacklisting
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
111 mother@spammyisp.com white; # suppress dnsbl checking
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
112 };
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
113 };
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
114
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
115 context customer1 {
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
116 dnsbl_list sbl;
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
117 env_to {
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
118 customer1.com;
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
119 customer1a.com;
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
120 customer1b.com;
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
121 };
0
96a9758165cd Initial revision
carl
parents:
diff changeset
122
75
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
123 context customer1a {
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
124 env_to {
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
125 customer1a.com;
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
126 }
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
127 env_from black { # blacklist everything
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
128 first@acceptable.com unknown; # except these specific envelope senders
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
129 second@another.com unknown;
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
130 yahoo.com inherit; # delegate to the parent
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
131 };
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
132 };
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
133
80
d554e41f2886 start coding on new config syntax
carl
parents: 76
diff changeset
134 env_from { # default value of the default is inherit
75
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
135 yahoo.com black; # no mail from yahoo
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
136 first@yahoo.com unknown; # except this one
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
137 };
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
138 };
0
96a9758165cd Initial revision
carl
parents:
diff changeset
139
75
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
140 context customer2 {
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
141 dnsbl_list sbl spews;
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
142 env_to {
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
143 customer2.com;
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
144 customer2a.com;
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
145 customer2b.com;
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
146 };
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
147 };
0
96a9758165cd Initial revision
carl
parents:
diff changeset
148
75
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
149 env_from unknown {
80
d554e41f2886 start coding on new config syntax
carl
parents: 76
diff changeset
150 dcc_from { include "/var/dcc/whitecommon"; }; # copy the dcc OK/MANY values (env_from, substitute mail_host) into this context
75
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
151 abuse@ abuse; # replies to abuse reports use the abuse context
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
152 yahoo.com black; # don't take mail from yahoo
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
153 spammer@example.com black;
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
154 };
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
155 };
1142e46be550 start coding on new config syntax
carl
parents: 57
diff changeset
156