1 # POSTLICYD configuration
3 # Postlicyd configuration contains:
4 # - a set of filter definition
5 # - the entry point in the filters for each smtp states
7 # The configuration format use 2 types of data:
8 # Token: [[:alpha:]]([[:alnum:]_]*)
9 # String: string format is a bit more complex. It can be one of the two following
11 # - C-like strings "[^\n\r]*". In this kind of string, the \ character is used to
12 # escape any character \c = c (\n = n, \\ = \, ...). This format allow non-ascii
13 # strings and string concatenation " abcd " "ef" = " abcd ef".
14 # - ASCII-only strings can be written without double-quotes. They can be splitted
15 # into several lines using shell-like escaping of EOL. A string begins and ends on
16 # on a non-blank character. This king of string can not contain semi-colons.
18 # The following format are equivalent:
22 # (2) "this is a string"
27 # Most of the configuration use a format:
30 # When not in a string, spaces and line breaks are ignored. You can use comments
31 # everywhere out of a string. It starts with a '#' character and ends at the end of the
32 # line. Comments are strictly equivalents to white spaces.
36 # A definition of a filter contains:
37 # - the name of the filter. This name MUST be uniq (non-uniq names can lead to undefined
40 # - a list of type-specific parameters
41 # - a list of hooks (on_hookname)
44 # A filter look likes that:
48 # param1 = parameter value 1;
56 # A filter can returns different values. Each return value is given a name. The
57 # configuration associates an action to run to a return value name.
59 # The action can be either a postfix access(5) value or a filter name. Postfix access
60 # parameters must be prefixed by 'postfix:'.
63 # on_match = postfix:REJECT Blacklisted;
66 # Current defined filter types are:
67 # - iplist: match the client_address against one or more blacklist files from a rbl
69 # - file: (no)?lock:weight:filename
70 # declare a file to load. If lock is given, the klist is locked into the
71 # RAM. The weight is a number giving the weight of this blaclist file in the
73 # - soft_threshold: score (default: 1)
74 # minimum score to match the soft_match return value
75 # - hard_threshold: score (default: 1)
76 # minimum score to match the hard_match return value
78 # The score of a query is the sum of the weight of the blacklist it matched.
79 # - If the IP can not be parsed, returns error
80 # - If the score is strictly greater >= than hard_threshold, returns hard_match
81 # - If the score is strictly greater >= than soft_threshold, returns soft_match
82 # - Else, returns fail
85 spamhaus_and_abuseat {
89 file = lock:10:/var/spool/postlicyd/rbl.spamhaus.org;
90 file = lock:1:/var/spool/postlicyd/cbl.abuseat.org;
95 on_soft_match = greylist;
96 on_hard_match = postfix:REJECT optional text;
98 on_error = postfix:DUNNO;
102 # - strlist: match strings from the query against a list of list.
104 # - file: (no)?lock:(partial-)?(pre|suf)fix:weight:filename
105 # declare a file to load. If lock is given, the list is locked into the
106 # RAM. Prefix/Suffix is a parameter to tell the matcher which is the most
107 # efficient storage order. The strings are internally stored into a trie that
108 # allow high compression if a lot of prefix are shared by several strings. If
109 # you choose "prefix", string are stored in the natural order in memory and
110 # prefix compression is performed. If you choose "suffix", strings are stored
111 # in reverse order in memory and suffix compression is performed. If you add "partial-"
112 # to the match order, the entry will match if the file contains a prefix (resp. suffix)
113 # of the string. The weight is a number giving the weight of this list in the string score.
115 # * a file that contains ".polytechnique.org" in "partial-suffix" mode will match
116 # all subdomains of "polytechnique.org".
117 # * a file that contains "postmaster@" in "partial-prefix" mode will match all
119 # * a file open without "partial-" modifier match exact strings.
120 # - rbldns: (no)?lock:weight:filename
121 # declare a rbldns zone file to load. This is exactly the same as file excepted that it wraps
122 # parsing of hostname to split them into 2 categories:
123 # * names beginning with '*' are sorted as 'domains' and are matched as suffix
124 # * names starting with an alphanumirical character are sorted as 'hostnames' and are
125 # process via exact matching.
126 # - soft_threshold: score (default: 1)
127 # minimum score to match the soft_match return value
128 # - hard_threshold: score (default: 1)
129 # minimum score to match the hard_match return value
130 # - fields: field_name(,field_name)*
131 # list of field the match the string against.
132 # currently only email OR hostname fields are supported. You MUST choose only
133 # one of these types per strlist, and be carefull that the field you requested
134 # are available in the protocol state you want to use this filter for.
135 # * hostname fields: helo_name, client_name, reverse_client_name, sender_domain,
137 # * email fields: sender, recipient
138 # No space is allowed in this parameter.
140 # The score of a query is the sum of the weight of the list it matched.
141 # - If the score is strictly greater >= than hard_threshold, returns hard_match
142 # - If the score is strictly greater >= than soft_threshold, returns soft_match
143 # - Else, returns fail
145 # - to match helo_name, you must be on HELO state or later
146 # (stmpd_helo_restrictions)
147 # - to match sender, you must be on MAIL state or later
148 # (smtpd_sender_restrictions)
149 # - to match recipient, you must on RCPT state (stmpd_recipient_restrictions)
150 # - client_name and reverse_client_name are always available
152 # Whitelist some clients
157 file = lock:1:suffix:/var/spool/postlicyd/client_whitelist;
158 rbldns = lock:1:/va/spool/postlicyd/abuse.rfc-ignorant.org;
159 fields = client_name,sender_domain,helo_name;
162 on_hard_match = postfix:OK;
163 on_fail = spamhaus_and_abuseat;
167 # - greylist: greylister
169 # - path: /my/path/ (required)
170 # path where to store the greylist database
171 # - prefix: name (default: "")
172 # prefix to the name of the greylist database
173 # - lookup_by_host: boolean (default: false)
174 # perform lookup per host instead of domain.
175 # - delay: number (default: 300)
176 # number of seconds the client must wait before retrial.
177 # - retry_window: (default: 2 * 24 * 3600)
178 # number of seconds we wait for a retry.
179 # - client_awl: number (default: 5)
180 # number of successful greylisting before the client get whitelisted (0 means,
181 # no-auto-whitelist).
182 # - max_age: number (default: 30 * 3600)
183 # lifetime of a greylist/whitelist session: ie, if a client does ne reappear during
184 # max_age seconds, the entries associated to this client are invalidated.
186 # - if the client is whitelisted, returns whitelist
187 # - if the client is greylisted, returns greylist
188 # - if a error occured (not currently possible), returns error
190 # this filter is a recipient filter and works in RCPT state only
191 # (smtpd_recipient_restrictions).
193 # Perform greylisting
198 path = /var/spool/postlicyd/;
202 on_greylist = postfix:DEFER_IF_PERMIT optional text;
203 on_whitelist = postfix:OK;
207 # - match: direct matching against the query fields
209 # - match_all: boolean
210 # if true, the filter won't match until all conditions
211 # are verified. If false, the filter match on the first
212 # verified condition.
213 # - condition: field_name OP (value)
214 # * the field_name is one of the field name of the query
215 # emitted by postfix. This list with description of each
216 # field is available at:
217 # http://www.postfix.org/SMTPD_POLICY_README.html
218 # postlicyd also support fields sender_domain and recipient_domain
219 # * OP is an operator. Available operators are:
220 # == field_name is strictly equal to value
221 # =i field_name is case insensitively equal to value
222 # != field_name is not equal to value
223 # !i field_name is not case insensitively equal to value
224 # >= field_name contains value
225 # >i field_name contains case insensitively value
226 # <= field_name is contained by value
227 # <i field_name is contained case insensitively by value
228 # #= field_name is empty or not set
229 # #i field_name is not empty
231 # - if the conditions are verified (according to match_all strategy), return match
232 # - if the conditions are not verified, return fail
234 # match one of the condition: "stress mode activated", "client_name contains debian.org" or
235 # "recipient is empty"
241 condition = stress == yes;
242 condition = client_name >= debian.org;
243 condition = recipient #=;
246 on_match = postfix:OK;
253 # Access policy daemon can be used at several protocol states. For each of this states,
254 # you can define a different entry point in the filtering tree. This entry points have
255 # the following format:
257 # state = filter_name;
259 # The filter_name MUST be one of the filter you previously defined.
261 # The available states are:
262 # - client_filter: called on CONNECT state (smtpd_client_restrictions)
263 # - helo_filter (or ehlo_filter): called on HELO/EHLO command (smtpd_helo_restrictions)
264 # - sender_filter: called on the MAIL FROM command (stmpd_sender_restrictions)
265 # - recipient_filter: called on the RCPT TO command (smtpd_recipient_restrictions)
266 # - data_filter: called on the DATA command (smtpd_data_restrictions)
267 # - end_of_data_filter: called on the END-OF-DATA command
268 # (smtpd_end_of_data_restrictions)
269 # - etrn_filter: called on the ETRN command (stmpd_etrn_restrictions)
270 # - verify_filter: called on the VRFY command (no postfix hook ?)
272 recipient_filter = client_whitelist;
277 # Port to which the server is bound. The default is 10000. If the port is specified as
278 # a command line parameter, the value specified on command line overides this value.
280 # You must RESTART the server to change the port (reload does not affect the port).
284 # vim:set syntax=conf: