Commit | Line | Data |
---|---|---|
7bafa7d9 TK |
1 | From time to time, experimental features may be added to Exim. |
2 | While a feature is experimental, there will be a build-time | |
3 | option whose name starts "EXPERIMENTAL_" that must be set in | |
4 | order to include the feature. This file contains information | |
d36a0501 PP |
5 | about experimental features, all of which are unstable and |
6 | liable to incompatible change. | |
ee161e8f PH |
7 | |
8 | ||
4c04137d | 9 | Brightmail AntiSpam (BMI) support |
ee161e8f PH |
10 | -------------------------------------------------------------- |
11 | ||
12 | Brightmail AntiSpam is a commercial package. Please see | |
13 | http://www.brightmail.com for more information on | |
14 | the product. For the sake of clarity, we'll refer to it as | |
15 | "BMI" from now on. | |
16 | ||
17 | ||
18 | 0) BMI concept and implementation overview | |
19 | ||
20 | In contrast to how spam-scanning with SpamAssassin is | |
21 | implemented in exiscan-acl, BMI is more suited for per | |
22 | -recipient scanning of messages. However, each messages is | |
23 | scanned only once, but multiple "verdicts" for multiple | |
24 | recipients can be returned from the BMI server. The exiscan | |
25 | implementation passes the message to the BMI server just | |
26 | before accepting it. It then adds the retrieved verdicts to | |
27 | the messages header file in the spool. These verdicts can then | |
28 | be queried in routers, where operation is per-recipient | |
29 | instead of per-message. To use BMI, you need to take the | |
30 | following steps: | |
31 | ||
32 | 1) Compile Exim with BMI support | |
3ec3e3bb | 33 | 2) Set up main BMI options (top section of Exim config file) |
ee161e8f PH |
34 | 3) Set up ACL control statement (ACL section of the config |
35 | file) | |
36 | 4) Set up your routers to use BMI verdicts (routers section | |
37 | of the config file). | |
38 | 5) (Optional) Set up per-recipient opt-in information. | |
39 | ||
8ff3788c | 40 | These four steps are explained in more details below. |
ee161e8f PH |
41 | |
42 | 1) Adding support for BMI at compile time | |
43 | ||
44 | To compile with BMI support, you need to link Exim against | |
4c04137d | 45 | the Brightmail client SDK, consisting of a library |
ee161e8f PH |
46 | (libbmiclient_single.so) and a header file (bmi_api.h). |
47 | You'll also need to explicitly set a flag in the Makefile to | |
48 | include BMI support in the Exim binary. Both can be achieved | |
49 | with these lines in Local/Makefile: | |
50 | ||
51 | EXPERIMENTAL_BRIGHTMAIL=yes | |
47bbda99 | 52 | CFLAGS=-I/path/to/the/dir/with/the/includefile |
ee161e8f | 53 | EXTRALIBS_EXIM=-L/path/to/the/dir/with/the/library -lbmiclient_single |
8ff3788c | 54 | |
ee161e8f PH |
55 | If you use other CFLAGS or EXTRALIBS_EXIM settings then |
56 | merge the content of these lines with them. | |
57 | ||
7c0c8547 | 58 | Note for BMI6.x users: You'll also have to add -lxml2_single |
ee161e8f PH |
59 | to the EXTRALIBS_EXIM line. Users of 5.5x do not need to do |
60 | this. | |
8ff3788c | 61 | |
ee161e8f PH |
62 | You should also include the location of |
63 | libbmiclient_single.so in your dynamic linker configuration | |
64 | file (usually /etc/ld.so.conf) and run "ldconfig" | |
65 | afterwards, or else the produced Exim binary will not be | |
66 | able to find the library file. | |
67 | ||
68 | ||
3ec3e3bb | 69 | 2) Setting up BMI support in the Exim main configuration |
ee161e8f | 70 | |
3ec3e3bb | 71 | To enable BMI support in the main Exim configuration, you |
ee161e8f PH |
72 | should set the path to the main BMI configuration file with |
73 | the "bmi_config_file" option, like this: | |
8ff3788c | 74 | |
ee161e8f | 75 | bmi_config_file = /opt/brightmail/etc/brightmail.cfg |
8ff3788c | 76 | |
3ec3e3bb | 77 | This must go into section 1 of Exim's configuration file (You |
ee161e8f PH |
78 | can put it right on top). If you omit this option, it |
79 | defaults to /opt/brightmail/etc/brightmail.cfg. | |
80 | ||
81 | Note for BMI6.x users: This file is in XML format in V6.xx | |
82 | and its name is /opt/brightmail/etc/bmiconfig.xml. So BMI | |
83 | 6.x users MUST set the bmi_config_file option. | |
8ff3788c | 84 | |
ee161e8f PH |
85 | |
86 | 3) Set up ACL control statement | |
87 | ||
88 | To optimize performance, it makes sense only to process | |
89 | messages coming from remote, untrusted sources with the BMI | |
90 | server. To set up a messages for processing by the BMI | |
91 | server, you MUST set the "bmi_run" control statement in any | |
92 | ACL for an incoming message. You will typically do this in | |
93 | an "accept" block in the "acl_check_rcpt" ACL. You should | |
94 | use the "accept" block(s) that accept messages from remote | |
95 | servers for your own domain(s). Here is an example that uses | |
3ec3e3bb | 96 | the "accept" blocks from Exim's default configuration file: |
8ff3788c | 97 | |
ee161e8f PH |
98 | |
99 | accept domains = +local_domains | |
100 | endpass | |
101 | verify = recipient | |
102 | control = bmi_run | |
103 | ||
104 | accept domains = +relay_to_domains | |
105 | endpass | |
106 | verify = recipient | |
107 | control = bmi_run | |
8ff3788c | 108 | |
ee161e8f PH |
109 | If bmi_run is not set in any ACL during reception of the |
110 | message, it will NOT be passed to the BMI server. | |
111 | ||
112 | ||
113 | 4) Setting up routers to use BMI verdicts | |
114 | ||
115 | When a message has been run through the BMI server, one or | |
116 | more "verdicts" are present. Different recipients can have | |
117 | different verdicts. Each recipient is treated individually | |
118 | during routing, so you can query the verdicts by recipient | |
3ec3e3bb | 119 | at that stage. From Exim's view, a verdict can have the |
ee161e8f | 120 | following outcomes: |
8ff3788c | 121 | |
ee161e8f PH |
122 | o deliver the message normally |
123 | o deliver the message to an alternate location | |
124 | o do not deliver the message | |
8ff3788c | 125 | |
ee161e8f PH |
126 | To query the verdict for a recipient, the implementation |
127 | offers the following tools: | |
8ff3788c TK |
128 | |
129 | ||
ee161e8f PH |
130 | - Boolean router preconditions. These can be used in any |
131 | router. For a simple implementation of BMI, these may be | |
132 | all that you need. The following preconditions are | |
133 | available: | |
8ff3788c | 134 | |
ee161e8f | 135 | o bmi_deliver_default |
8ff3788c | 136 | |
ee161e8f PH |
137 | This precondition is TRUE if the verdict for the |
138 | recipient is to deliver the message normally. If the | |
139 | message has not been processed by the BMI server, this | |
140 | variable defaults to TRUE. | |
8ff3788c | 141 | |
ee161e8f | 142 | o bmi_deliver_alternate |
8ff3788c | 143 | |
ee161e8f PH |
144 | This precondition is TRUE if the verdict for the |
145 | recipient is to deliver the message to an alternate | |
146 | location. You can get the location string from the | |
147 | $bmi_alt_location expansion variable if you need it. See | |
148 | further below. If the message has not been processed by | |
149 | the BMI server, this variable defaults to FALSE. | |
8ff3788c | 150 | |
ee161e8f | 151 | o bmi_dont_deliver |
8ff3788c | 152 | |
ee161e8f PH |
153 | This precondition is TRUE if the verdict for the |
154 | recipient is NOT to deliver the message to the | |
155 | recipient. You will typically use this precondition in a | |
156 | top-level blackhole router, like this: | |
8ff3788c | 157 | |
ee161e8f PH |
158 | # don't deliver messages handled by the BMI server |
159 | bmi_blackhole: | |
160 | driver = redirect | |
161 | bmi_dont_deliver | |
162 | data = :blackhole: | |
8ff3788c | 163 | |
ee161e8f PH |
164 | This router should be on top of all others, so messages |
165 | that should not be delivered do not reach other routers | |
166 | at all. If the message has not been processed by | |
167 | the BMI server, this variable defaults to FALSE. | |
8ff3788c TK |
168 | |
169 | ||
ee161e8f PH |
170 | - A list router precondition to query if rules "fired" on |
171 | the message for the recipient. Its name is "bmi_rule". You | |
172 | use it by passing it a colon-separated list of rule | |
173 | numbers. You can use this condition to route messages that | |
174 | matched specific rules. Here is an example: | |
8ff3788c | 175 | |
ee161e8f PH |
176 | # special router for BMI rule #5, #8 and #11 |
177 | bmi_rule_redirect: | |
178 | driver = redirect | |
179 | bmi_rule = 5:8:11 | |
180 | data = postmaster@mydomain.com | |
8ff3788c TK |
181 | |
182 | ||
ee161e8f PH |
183 | - Expansion variables. Several expansion variables are set |
184 | during routing. You can use them in custom router | |
185 | conditions, for example. The following variables are | |
186 | available: | |
8ff3788c | 187 | |
ee161e8f | 188 | o $bmi_base64_verdict |
8ff3788c | 189 | |
ee161e8f PH |
190 | This variable will contain the BASE64 encoded verdict |
191 | for the recipient being routed. You can use it to add a | |
192 | header to messages for tracking purposes, for example: | |
8ff3788c | 193 | |
ee161e8f PH |
194 | localuser: |
195 | driver = accept | |
196 | check_local_user | |
197 | headers_add = X-Brightmail-Verdict: $bmi_base64_verdict | |
198 | transport = local_delivery | |
8ff3788c | 199 | |
ee161e8f PH |
200 | If there is no verdict available for the recipient being |
201 | routed, this variable contains the empty string. | |
8ff3788c | 202 | |
ee161e8f | 203 | o $bmi_base64_tracker_verdict |
8ff3788c | 204 | |
ee161e8f PH |
205 | This variable will contain a BASE64 encoded subset of |
206 | the verdict information concerning the "rules" that | |
207 | fired on the message. You can add this string to a | |
208 | header, commonly named "X-Brightmail-Tracker". Example: | |
8ff3788c | 209 | |
ee161e8f PH |
210 | localuser: |
211 | driver = accept | |
212 | check_local_user | |
213 | headers_add = X-Brightmail-Tracker: $bmi_base64_tracker_verdict | |
214 | transport = local_delivery | |
8ff3788c | 215 | |
ee161e8f PH |
216 | If there is no verdict available for the recipient being |
217 | routed, this variable contains the empty string. | |
8ff3788c | 218 | |
ee161e8f | 219 | o $bmi_alt_location |
8ff3788c | 220 | |
ee161e8f PH |
221 | If the verdict is to redirect the message to an |
222 | alternate location, this variable will contain the | |
223 | alternate location string returned by the BMI server. In | |
224 | its default configuration, this is a header-like string | |
225 | that can be added to the message with "headers_add". If | |
226 | there is no verdict available for the recipient being | |
227 | routed, or if the message is to be delivered normally, | |
228 | this variable contains the empty string. | |
8ff3788c | 229 | |
ee161e8f | 230 | o $bmi_deliver |
8ff3788c | 231 | |
ee161e8f PH |
232 | This is an additional integer variable that can be used |
233 | to query if the message should be delivered at all. You | |
234 | should use router preconditions instead if possible. | |
8ff3788c | 235 | |
ee161e8f PH |
236 | $bmi_deliver is '0': the message should NOT be delivered. |
237 | $bmi_deliver is '1': the message should be delivered. | |
8ff3788c TK |
238 | |
239 | ||
ee161e8f PH |
240 | IMPORTANT NOTE: Verdict inheritance. |
241 | The message is passed to the BMI server during message | |
242 | reception, using the target addresses from the RCPT TO: | |
243 | commands in the SMTP transaction. If recipients get expanded | |
244 | or re-written (for example by aliasing), the new address(es) | |
245 | inherit the verdict from the original address. This means | |
246 | that verdicts also apply to all "child" addresses generated | |
247 | from top-level addresses that were sent to the BMI server. | |
8ff3788c TK |
248 | |
249 | ||
ee161e8f PH |
250 | 5) Using per-recipient opt-in information (Optional) |
251 | ||
252 | The BMI server features multiple scanning "profiles" for | |
253 | individual recipients. These are usually stored in a LDAP | |
254 | server and are queried by the BMI server itself. However, | |
255 | you can also pass opt-in data for each recipient from the | |
256 | MTA to the BMI server. This is particularly useful if you | |
3ec3e3bb | 257 | already look up recipient data in Exim anyway (which can |
ee161e8f PH |
258 | also be stored in a SQL database or other source). This |
259 | implementation enables you to pass opt-in data to the BMI | |
260 | server in the RCPT ACL. This works by setting the | |
261 | 'bmi_optin' modifier in a block of that ACL. If should be | |
262 | set to a list of comma-separated strings that identify the | |
263 | features which the BMI server should use for that particular | |
264 | recipient. Ideally, you would use the 'bmi_optin' modifier | |
265 | in the same ACL block where you set the 'bmi_run' control | |
266 | flag. Here is an example that will pull opt-in data for each | |
267 | recipient from a flat file called | |
268 | '/etc/exim/bmi_optin_data'. | |
8ff3788c | 269 | |
ee161e8f | 270 | The file format: |
8ff3788c | 271 | |
ee161e8f PH |
272 | user1@mydomain.com: <OPTIN STRING1>:<OPTIN STRING2> |
273 | user2@thatdomain.com: <OPTIN STRING3> | |
8ff3788c TK |
274 | |
275 | ||
ee161e8f | 276 | The example: |
8ff3788c | 277 | |
ee161e8f PH |
278 | accept domains = +relay_to_domains |
279 | endpass | |
280 | verify = recipient | |
281 | bmi_optin = ${lookup{$local_part@$domain}lsearch{/etc/exim/bmi_optin_data}} | |
8ff3788c TK |
282 | control = bmi_run |
283 | ||
ee161e8f | 284 | Of course, you can also use any other lookup method that |
3ec3e3bb | 285 | Exim supports, including LDAP, Postgres, MySQL, Oracle etc., |
ee161e8f PH |
286 | as long as the result is a list of colon-separated opt-in |
287 | strings. | |
8ff3788c | 288 | |
ee161e8f PH |
289 | For a list of available opt-in strings, please contact your |
290 | Brightmail representative. | |
ee161e8f | 291 | |
8ff3788c TK |
292 | |
293 | ||
294 | ||
0b23848a | 295 | Sender Policy Framework (SPF) support |
ee161e8f PH |
296 | -------------------------------------------------------------- |
297 | ||
f413481d | 298 | To learn more about SPF, visit http://www.openspf.org. This |
ee161e8f PH |
299 | document does not explain the SPF fundamentals, you should |
300 | read and understand the implications of deploying SPF on your | |
301 | system before doing so. | |
302 | ||
8ff3788c | 303 | SPF support is added via the libspf2 library. Visit |
ee161e8f PH |
304 | |
305 | http://www.libspf2.org/ | |
8ff3788c | 306 | |
ee161e8f PH |
307 | to obtain a copy, then compile and install it. By default, |
308 | this will put headers in /usr/local/include and the static | |
309 | library in /usr/local/lib. | |
310 | ||
3ec3e3bb | 311 | To compile Exim with SPF support, set these additional flags in |
ee161e8f PH |
312 | Local/Makefile: |
313 | ||
314 | EXPERIMENTAL_SPF=yes | |
315 | CFLAGS=-DSPF -I/usr/local/include | |
316 | EXTRALIBS_EXIM=-L/usr/local/lib -lspf2 | |
317 | ||
318 | This assumes that the libspf2 files are installed in | |
319 | their default locations. | |
320 | ||
321 | You can now run SPF checks in incoming SMTP by using the "spf" | |
322 | ACL condition in either the MAIL, RCPT or DATA ACLs. When | |
d36a0501 | 323 | using it in the RCPT ACL, you can make the checks dependent on |
ee161e8f PH |
324 | the RCPT address (or domain), so you can check SPF records |
325 | only for certain target domains. This gives you the | |
326 | possibility to opt-out certain customers that do not want | |
327 | their mail to be subject to SPF checking. | |
328 | ||
329 | The spf condition takes a list of strings on its right-hand | |
330 | side. These strings describe the outcome of the SPF check for | |
331 | which the spf condition should succeed. Valid strings are: | |
332 | ||
333 | o pass The SPF check passed, the sending host | |
334 | is positively verified by SPF. | |
335 | o fail The SPF check failed, the sending host | |
336 | is NOT allowed to send mail for the domain | |
337 | in the envelope-from address. | |
338 | o softfail The SPF check failed, but the queried | |
339 | domain can't absolutely confirm that this | |
340 | is a forgery. | |
341 | o none The queried domain does not publish SPF | |
342 | records. | |
343 | o neutral The SPF check returned a "neutral" state. | |
344 | This means the queried domain has published | |
345 | a SPF record, but wants to allow outside | |
346 | servers to send mail under its domain as well. | |
8ddef691 TL |
347 | This should be treated like "none". |
348 | o permerror This indicates a syntax error in the SPF | |
349 | record of the queried domain. You may deny | |
350 | messages when this occurs. (Changed in 4.83) | |
351 | o temperror This indicates a temporary error during all | |
3ec3e3bb | 352 | processing, including Exim's SPF processing. |
ee161e8f | 353 | You may defer messages when this occurs. |
8ddef691 | 354 | (Changed in 4.83) |
982650ec TL |
355 | o err_temp Same as permerror, deprecated in 4.83, will be |
356 | removed in a future release. | |
357 | o err_perm Same as temperror, deprecated in 4.83, will be | |
358 | removed in a future release. | |
8ff3788c | 359 | |
ee161e8f | 360 | You can prefix each string with an exclamation mark to invert |
982650ec | 361 | its meaning, for example "!fail" will match all results but |
ee161e8f PH |
362 | "fail". The string list is evaluated left-to-right, in a |
363 | short-circuit fashion. When a string matches the outcome of | |
364 | the SPF check, the condition succeeds. If none of the listed | |
365 | strings matches the outcome of the SPF check, the condition | |
366 | fails. | |
367 | ||
f413481d TK |
368 | Here is an example to fail forgery attempts from domains that |
369 | publish SPF records: | |
ee161e8f PH |
370 | |
371 | /* ----------------- | |
f413481d TK |
372 | deny message = $sender_host_address is not allowed to send mail from ${if def:sender_address_domain {$sender_address_domain}{$sender_helo_name}}. \ |
373 | Please see http://www.openspf.org/Why?scope=${if def:sender_address_domain {mfrom}{helo}};identity=${if def:sender_address_domain {$sender_address}{$sender_helo_name}};ip=$sender_host_address | |
ee161e8f PH |
374 | spf = fail |
375 | --------------------- */ | |
376 | ||
377 | You can also give special treatment to specific domains: | |
378 | ||
379 | /* ----------------- | |
380 | deny message = AOL sender, but not from AOL-approved relay. | |
381 | sender_domains = aol.com | |
382 | spf = fail:neutral | |
383 | --------------------- */ | |
384 | ||
385 | Explanation: AOL publishes SPF records, but is liberal and | |
386 | still allows non-approved relays to send mail from aol.com. | |
387 | This will result in a "neutral" state, while mail from genuine | |
388 | AOL servers will result in "pass". The example above takes | |
389 | this into account and treats "neutral" like "fail", but only | |
390 | for aol.com. Please note that this violates the SPF draft. | |
391 | ||
392 | When the spf condition has run, it sets up several expansion | |
393 | variables. | |
394 | ||
395 | $spf_header_comment | |
396 | This contains a human-readable string describing the outcome | |
397 | of the SPF check. You can add it to a custom header or use | |
398 | it for logging purposes. | |
8ff3788c | 399 | |
ee161e8f | 400 | $spf_received |
8fe685ad | 401 | This contains a complete Received-SPF: header that can be |
ee161e8f PH |
402 | added to the message. Please note that according to the SPF |
403 | draft, this header must be added at the top of the header | |
404 | list. Please see section 10 on how you can do this. | |
8ff3788c | 405 | |
65a7d8c3 NM |
406 | Note: in case of "Best-guess" (see below), the convention is |
407 | to put this string in a header called X-SPF-Guess: instead. | |
408 | ||
ee161e8f PH |
409 | $spf_result |
410 | This contains the outcome of the SPF check in string form, | |
8ddef691 TL |
411 | one of pass, fail, softfail, none, neutral, permerror or |
412 | temperror. | |
8ff3788c | 413 | |
ee161e8f PH |
414 | $spf_smtp_comment |
415 | This contains a string that can be used in a SMTP response | |
416 | to the calling party. Useful for "fail". | |
8ff3788c | 417 | |
65a7d8c3 NM |
418 | In addition to SPF, you can also perform checks for so-called |
419 | "Best-guess". Strictly speaking, "Best-guess" is not standard | |
420 | SPF, but it is supported by the same framework that enables SPF | |
421 | capability. Refer to http://www.openspf.org/FAQ/Best_guess_record | |
422 | for a description of what it means. | |
423 | ||
424 | To access this feature, simply use the spf_guess condition in place | |
425 | of the spf one. For example: | |
426 | ||
427 | /* ----------------- | |
428 | deny message = $sender_host_address doesn't look trustworthy to me | |
429 | spf_guess = fail | |
430 | --------------------- */ | |
431 | ||
432 | In case you decide to reject messages based on this check, you | |
433 | should note that although it uses the same framework, "Best-guess" | |
434 | is NOT SPF, and therefore you should not mention SPF at all in your | |
435 | reject message. | |
436 | ||
437 | When the spf_guess condition has run, it sets up the same expansion | |
438 | variables as when spf condition is run, described above. | |
439 | ||
d36a0501 | 440 | Additionally, since Best-guess is not standardized, you may redefine |
65a7d8c3 NM |
441 | what "Best-guess" means to you by redefining spf_guess variable in |
442 | global config. For example, the following: | |
443 | ||
444 | /* ----------------- | |
445 | spf_guess = v=spf1 a/16 mx/16 ptr ?all | |
446 | --------------------- */ | |
447 | ||
448 | would relax host matching rules to a broader network range. | |
8ff3788c | 449 | |
ee161e8f | 450 | |
950aa3fb JH |
451 | A lookup expansion is also available. It takes an email |
452 | address as the key and an IP address as the database: | |
453 | ||
43042f3d | 454 | ${lookup {username@domain} spf {ip.ip.ip.ip}} |
950aa3fb JH |
455 | |
456 | The lookup will return the same result strings as they can appear in | |
457 | $spf_result (pass,fail,softfail,neutral,none,err_perm,err_temp). | |
458 | Currently, only IPv4 addresses are supported. | |
459 | ||
460 | ||
461 | ||
0b23848a | 462 | SRS (Sender Rewriting Scheme) Support |
ee161e8f PH |
463 | -------------------------------------------------------------- |
464 | ||
465 | Exiscan currently includes SRS support via Miles Wilton's | |
8ff3788c | 466 | libsrs_alt library. The current version of the supported |
f413521a | 467 | library is 0.5, there are reports of 1.0 working. |
ee161e8f PH |
468 | |
469 | In order to use SRS, you must get a copy of libsrs_alt from | |
470 | ||
f413521a PP |
471 | https://opsec.eu/src/srs/ |
472 | ||
473 | (not the original source, which has disappeared.) | |
ee161e8f PH |
474 | |
475 | Unpack the tarball, then refer to MTAs/README.EXIM | |
476 | to proceed. You need to set | |
477 | ||
478 | EXPERIMENTAL_SRS=yes | |
479 | ||
480 | in your Local/Makefile. | |
481 | ||
482 | ||
f413521a | 483 | |
0e1ccf44 PP |
484 | DCC Support |
485 | -------------------------------------------------------------- | |
d36254f2 | 486 | Distributed Checksum Clearinghouse; http://www.rhyolite.com/dcc/ |
0e1ccf44 PP |
487 | |
488 | *) Building exim | |
489 | ||
490 | In order to build exim with DCC support add | |
491 | ||
492 | EXPERIMENTAL_DCC=yes | |
493 | ||
494 | to your Makefile. (Re-)build/install exim. exim -d should show | |
495 | EXPERIMENTAL_DCC under "Support for". | |
496 | ||
497 | ||
498 | *) Configuration | |
499 | ||
500 | In the main section of exim.cf add at least | |
501 | dccifd_address = /usr/local/dcc/var/dccifd | |
502 | or | |
503 | dccifd_address = <ip> <port> | |
504 | ||
505 | In the DATA ACL you can use the new condition | |
506 | dcc = * | |
507 | ||
508 | After that "$dcc_header" contains the X-DCC-Header. | |
509 | ||
d36a0501 | 510 | Return values are: |
0e1ccf44 PP |
511 | fail for overall "R", "G" from dccifd |
512 | defer for overall "T" from dccifd | |
513 | accept for overall "A", "S" from dccifd | |
514 | ||
515 | dcc = */defer_ok works as for spamd. | |
516 | ||
517 | The "$dcc_result" variable contains the overall result from DCC | |
518 | answer. There will an X-DCC: header added to the mail. | |
519 | ||
520 | Usually you'll use | |
521 | defer !dcc = * | |
522 | to greylist with DCC. | |
523 | ||
524 | If you set, in the main section, | |
525 | dcc_direct_add_header = true | |
526 | then the dcc header will be added "in deep" and if the spool | |
527 | file was already written it gets removed. This forces Exim to | |
528 | write it again if needed. This helps to get the DCC Header | |
529 | through to eg. SpamAssassin. | |
530 | ||
531 | If you want to pass even more headers in the middle of the | |
532 | DATA stage you can set | |
533 | $acl_m_dcc_add_header | |
05c39afa | 534 | to tell the DCC routines to add more information; eg, you might set |
0e1ccf44 PP |
535 | this to some results from ClamAV. Be careful. Header syntax is |
536 | not checked and is added "as is". | |
537 | ||
05c39afa JH |
538 | In case you've troubles with sites sending the same queue items from several |
539 | hosts and fail to get through greylisting you can use | |
540 | $acl_m_dcc_override_client_ip | |
541 | ||
542 | Setting $acl_m_dcc_override_client_ip to an IP address overrides the default | |
543 | of $sender_host_address. eg. use the following ACL in DATA stage: | |
544 | ||
545 | warn set acl_m_dcc_override_client_ip = \ | |
546 | ${lookup{$sender_helo_name}nwildlsearch{/etc/mail/multipleip_sites}{$value}{}} | |
547 | condition = ${if def:acl_m_dcc_override_client_ip} | |
548 | log_message = dbg: acl_m_dcc_override_client_ip set to \ | |
549 | $acl_m_dcc_override_client_ip | |
550 | ||
551 | Then set something like | |
552 | # cat /etc/mail/multipleip_sites | |
553 | mout-xforward.gmx.net 82.165.159.12 | |
554 | mout.gmx.net 212.227.15.16 | |
555 | ||
4c04137d | 556 | Use a reasonable IP. eg. one the sending cluster actually uses. |
0e1ccf44 | 557 | |
1899bab2 TL |
558 | DMARC Support |
559 | -------------------------------------------------------------- | |
560 | ||
561 | DMARC combines feedback from SPF, DKIM, and header From: in order | |
562 | to attempt to provide better indicators of the authenticity of an | |
563 | email. This document does not explain the fundamentals, you | |
564 | should read and understand how it works by visiting the website at | |
565 | http://www.dmarc.org/. | |
566 | ||
567 | DMARC support is added via the libopendmarc library. Visit: | |
568 | ||
569 | http://sourceforge.net/projects/opendmarc/ | |
570 | ||
571 | to obtain a copy, or find it in your favorite rpm package | |
572 | repository. If building from source, this description assumes | |
573 | that headers will be in /usr/local/include, and that the libraries | |
574 | are in /usr/local/lib. | |
575 | ||
576 | 1. To compile Exim with DMARC support, you must first enable SPF. | |
577 | Please read the above section on enabling the EXPERIMENTAL_SPF | |
578 | feature. You must also have DKIM support, so you cannot set the | |
579 | DISABLE_DKIM feature. Once both of those conditions have been met | |
580 | you can enable DMARC in Local/Makefile: | |
581 | ||
582 | EXPERIMENTAL_DMARC=yes | |
583 | LDFLAGS += -lopendmarc | |
584 | # CFLAGS += -I/usr/local/include | |
585 | # LDFLAGS += -L/usr/local/lib | |
586 | ||
587 | The first line sets the feature to include the correct code, and | |
588 | the second line says to link the libopendmarc libraries into the | |
589 | exim binary. The commented out lines should be uncommented if you | |
590 | built opendmarc from source and installed in the default location. | |
591 | Adjust the paths if you installed them elsewhere, but you do not | |
592 | need to uncomment them if an rpm (or you) installed them in the | |
593 | package controlled locations (/usr/include and /usr/lib). | |
594 | ||
595 | ||
596 | 2. Use the following global settings to configure DMARC: | |
597 | ||
9f765fee | 598 | Optional: |
1899bab2 TL |
599 | dmarc_tld_file Defines the location of a text file of valid |
600 | top level domains the opendmarc library uses | |
601 | during domain parsing. Maintained by Mozilla, | |
602 | the most current version can be downloaded | |
603 | from a link at http://publicsuffix.org/list/. | |
9f765fee HSHR |
604 | If unset, "/etc/exim/opendmarc.tlds" (hardcoded) |
605 | is used. | |
1899bab2 TL |
606 | |
607 | Optional: | |
608 | dmarc_history_file Defines the location of a file to log results | |
609 | of dmarc verification on inbound emails. The | |
610 | contents are importable by the opendmarc tools | |
611 | which will manage the data, send out DMARC | |
612 | reports, and expire the data. Make sure the | |
613 | directory of this file is writable by the user | |
614 | exim runs as. | |
615 | ||
616 | dmarc_forensic_sender The email address to use when sending a | |
617 | forensic report detailing alignment failures | |
618 | if a sender domain's dmarc record specifies it | |
619 | and you have configured Exim to send them. | |
620 | Default: do-not-reply@$default_hostname | |
621 | ||
622 | ||
623 | 3. By default, the DMARC processing will run for any remote, | |
624 | non-authenticated user. It makes sense to only verify DMARC | |
625 | status of messages coming from remote, untrusted sources. You can | |
626 | use standard conditions such as hosts, senders, etc, to decide that | |
627 | DMARC verification should *not* be performed for them and disable | |
628 | DMARC with a control setting: | |
629 | ||
12d0043d | 630 | control = dmarc_disable_verify |
1899bab2 TL |
631 | |
632 | A DMARC record can also specify a "forensic address", which gives | |
633 | exim an email address to submit reports about failed alignment. | |
634 | Exim does not do this by default because in certain conditions it | |
635 | results in unintended information leakage (what lists a user might | |
636 | be subscribed to, etc). You must configure exim to submit forensic | |
637 | reports to the owner of the domain. If the DMARC record contains a | |
638 | forensic address and you specify the control statement below, then | |
639 | exim will send these forensic emails. It's also advised that you | |
640 | configure a dmarc_forensic_sender because the default sender address | |
641 | construction might be inadequate. | |
642 | ||
7b2f71c1 | 643 | control = dmarc_enable_forensic |
1899bab2 TL |
644 | |
645 | (AGAIN: You can choose not to send these forensic reports by simply | |
7b2f71c1 | 646 | not putting the dmarc_enable_forensic control line at any point in |
1899bab2 TL |
647 | your exim config. If you don't tell it to send them, it will not |
648 | send them.) | |
649 | ||
650 | There are no options to either control. Both must appear before | |
651 | the DATA acl. | |
652 | ||
653 | ||
654 | 4. You can now run DMARC checks in incoming SMTP by using the | |
655 | "dmarc_status" ACL condition in the DATA ACL. You are required to | |
656 | call the spf condition first in the ACLs, then the "dmarc_status" | |
657 | condition. Putting this condition in the ACLs is required in order | |
658 | for a DMARC check to actually occur. All of the variables are set | |
659 | up before the DATA ACL, but there is no actual DMARC check that | |
660 | occurs until a "dmarc_status" condition is encountered in the ACLs. | |
661 | ||
662 | The dmarc_status condition takes a list of strings on its | |
663 | right-hand side. These strings describe recommended action based | |
664 | on the DMARC check. To understand what the policy recommendations | |
665 | mean, refer to the DMARC website above. Valid strings are: | |
666 | ||
667 | o accept The DMARC check passed and the library recommends | |
668 | accepting the email. | |
669 | o reject The DMARC check failed and the library recommends | |
670 | rejecting the email. | |
671 | o quarantine The DMARC check failed and the library recommends | |
672 | keeping it for further inspection. | |
7a8678e6 | 673 | o none The DMARC check passed and the library recommends |
674 | no specific action, neutral. | |
1899bab2 TL |
675 | o norecord No policy section in the DMARC record for this |
676 | sender domain. | |
677 | o nofrom Unable to determine the domain of the sender. | |
7a8678e6 | 678 | o temperror Library error or dns error. |
05070e30 | 679 | o off The DMARC check was disabled for this email. |
1899bab2 TL |
680 | |
681 | You can prefix each string with an exclamation mark to invert its | |
682 | meaning, for example "!accept" will match all results but | |
683 | "accept". The string list is evaluated left-to-right in a | |
684 | short-circuit fashion. When a string matches the outcome of the | |
685 | DMARC check, the condition succeeds. If none of the listed | |
686 | strings matches the outcome of the DMARC check, the condition | |
687 | fails. | |
688 | ||
689 | Of course, you can also use any other lookup method that Exim | |
690 | supports, including LDAP, Postgres, MySQL, etc, as long as the | |
8c8b8274 | 691 | result is a list of colon-separated strings. |
1899bab2 TL |
692 | |
693 | Several expansion variables are set before the DATA ACL is | |
694 | processed, and you can use them in this ACL. The following | |
695 | expansion variables are available: | |
696 | ||
697 | o $dmarc_status | |
698 | This is a one word status indicating what the DMARC library | |
8c8b8274 TL |
699 | thinks of the email. It is a combination of the results of |
700 | DMARC record lookup and the SPF/DKIM/DMARC processing results | |
701 | (if a DMARC record was found). The actual policy declared | |
702 | in the DMARC record is in a separate expansion variable. | |
1899bab2 TL |
703 | |
704 | o $dmarc_status_text | |
705 | This is a slightly longer, human readable status. | |
706 | ||
707 | o $dmarc_used_domain | |
708 | This is the domain which DMARC used to look up the DMARC | |
709 | policy record. | |
710 | ||
8c8b8274 TL |
711 | o $dmarc_domain_policy |
712 | This is the policy declared in the DMARC record. Valid values | |
713 | are "none", "reject" and "quarantine". It is blank when there | |
714 | is any error, including no DMARC record. | |
715 | ||
1899bab2 TL |
716 | o $dmarc_ar_header |
717 | This is the entire Authentication-Results header which you can | |
718 | add using an add_header modifier. | |
719 | ||
720 | ||
721 | 5. How to enable DMARC advanced operation: | |
722 | By default, Exim's DMARC configuration is intended to be | |
723 | non-intrusive and conservative. To facilitate this, Exim will not | |
724 | create any type of logging files without explicit configuration by | |
725 | you, the admin. Nor will Exim send out any emails/reports about | |
726 | DMARC issues without explicit configuration by you, the admin (other | |
727 | than typical bounce messages that may come about due to ACL | |
728 | processing or failure delivery issues). | |
729 | ||
730 | In order to log statistics suitable to be imported by the opendmarc | |
731 | tools, you need to: | |
732 | a. Configure the global setting dmarc_history_file. | |
733 | b. Configure cron jobs to call the appropriate opendmarc history | |
734 | import scripts and truncating the dmarc_history_file. | |
735 | ||
736 | In order to send forensic reports, you need to: | |
737 | a. Configure the global setting dmarc_forensic_sender. | |
738 | b. Configure, somewhere before the DATA ACL, the control option to | |
739 | enable sending DMARC forensic reports. | |
740 | ||
741 | ||
742 | 6. Example usage: | |
743 | (RCPT ACL) | |
744 | warn domains = +local_domains | |
745 | hosts = +local_hosts | |
12d0043d | 746 | control = dmarc_disable_verify |
1899bab2 TL |
747 | |
748 | warn !domains = +screwed_up_dmarc_records | |
749 | control = dmarc_enable_forensic | |
750 | ||
8c8b8274 TL |
751 | warn condition = (lookup if destined to mailing list) |
752 | set acl_m_mailing_list = 1 | |
753 | ||
1899bab2 TL |
754 | (DATA ACL) |
755 | warn dmarc_status = accept : none : off | |
756 | !authenticated = * | |
757 | log_message = DMARC DEBUG: $dmarc_status $dmarc_used_domain | |
758 | add_header = $dmarc_ar_header | |
759 | ||
760 | warn dmarc_status = !accept | |
761 | !authenticated = * | |
762 | log_message = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain | |
763 | ||
764 | warn dmarc_status = quarantine | |
765 | !authenticated = * | |
766 | set $acl_m_quarantine = 1 | |
767 | # Do something in a transport with this flag variable | |
768 | ||
8c8b8274 TL |
769 | deny condition = ${if eq{$dmarc_domain_policy}{reject}} |
770 | condition = ${if eq{$acl_m_mailing_list}{1}} | |
771 | message = Messages from $dmarc_used_domain break mailing lists | |
772 | ||
1899bab2 TL |
773 | deny dmarc_status = reject |
774 | !authenticated = * | |
7b2f71c1 | 775 | message = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT |
1899bab2 TL |
776 | |
777 | ||
778 | ||
043b1248 JH |
779 | DANE |
780 | ------------------------------------------------------------ | |
7cac846b JH |
781 | DNS-based Authentication of Named Entities, as applied |
782 | to SMTP over TLS, provides assurance to a client that | |
783 | it is actually talking to the server it wants to rather | |
784 | than some attacker operating a Man In The Middle (MITM) | |
785 | operation. The latter can terminate the TLS connection | |
786 | you make, and make another one to the server (so both | |
787 | you and the server still think you have an encrypted | |
788 | connection) and, if one of the "well known" set of | |
789 | Certificate Authorities has been suborned - something | |
790 | which *has* been seen already (2014), a verifiable | |
791 | certificate (if you're using normal root CAs, eg. the | |
792 | Mozilla set, as your trust anchors). | |
793 | ||
794 | What DANE does is replace the CAs with the DNS as the | |
795 | trust anchor. The assurance is limited to a) the possibility | |
796 | that the DNS has been suborned, b) mistakes made by the | |
797 | admins of the target server. The attack surface presented | |
798 | by (a) is thought to be smaller than that of the set | |
799 | of root CAs. | |
800 | ||
0e66b3b6 JH |
801 | It also allows the server to declare (implicitly) that |
802 | connections to it should use TLS. An MITM could simply | |
803 | fail to pass on a server's STARTTLS. | |
804 | ||
7cac846b JH |
805 | DANE scales better than having to maintain (and |
806 | side-channel communicate) copies of server certificates | |
807 | for every possible target server. It also scales | |
808 | (slightly) better than having to maintain on an SMTP | |
809 | client a copy of the standard CAs bundle. It also | |
810 | means not having to pay a CA for certificates. | |
811 | ||
812 | DANE requires a server operator to do three things: | |
813 | 1) run DNSSEC. This provides assurance to clients | |
814 | that DNS lookups they do for the server have not | |
401a8935 JH |
815 | been tampered with. The domain MX record applying |
816 | to this server, its A record, its TLSA record and | |
817 | any associated CNAME records must all be covered by | |
818 | DNSSEC. | |
7cac846b JH |
819 | 2) add TLSA DNS records. These say what the server |
820 | certificate for a TLS connection should be. | |
821 | 3) offer a server certificate, or certificate chain, | |
822 | in TLS connections which is traceable to the one | |
823 | defined by (one of?) the TSLA records | |
824 | ||
825 | There are no changes to Exim specific to server-side | |
826 | operation of DANE. | |
827 | ||
828 | The TLSA record for the server may have "certificate | |
0e66b3b6 | 829 | usage" of DANE-TA(2) or DANE-EE(3). The latter specifies |
7cac846b JH |
830 | the End Entity directly, i.e. the certificate involved |
831 | is that of the server (and should be the sole one transmitted | |
832 | during the TLS handshake); this is appropriate for a | |
833 | single system, using a self-signed certificate. | |
0e66b3b6 | 834 | DANE-TA usage is effectively declaring a specific CA |
7cac846b JH |
835 | to be used; this might be a private CA or a public, |
836 | well-known one. A private CA at simplest is just | |
837 | a self-signed certificate which is used to sign | |
838 | cerver certificates, but running one securely does | |
839 | require careful arrangement. If a private CA is used | |
840 | then either all clients must be primed with it, or | |
841 | (probably simpler) the server TLS handshake must transmit | |
842 | the entire certificate chain from CA to server-certificate. | |
843 | If a public CA is used then all clients must be primed with it | |
844 | (losing one advantage of DANE) - but the attack surface is | |
845 | reduced from all public CAs to that single CA. | |
0e66b3b6 | 846 | DANE-TA is commonly used for several services and/or |
7cac846b JH |
847 | servers, each having a TLSA query-domain CNAME record, |
848 | all of which point to a single TLSA record. | |
849 | ||
850 | The TLSA record should have a Selector field of SPKI(1) | |
401a8935 JH |
851 | and a Matching Type field of SHA2-512(2). |
852 | ||
853 | At the time of writing, https://www.huque.com/bin/gen_tlsa | |
854 | is useful for quickly generating TLSA records; and commands like | |
855 | ||
856 | openssl x509 -in -pubkey -noout <certificate.pem \ | |
857 | | openssl rsa -outform der -pubin 2>/dev/null \ | |
858 | | openssl sha512 \ | |
859 | | awk '{print $2}' | |
860 | ||
861 | are workable for 4th-field hashes. | |
7cac846b | 862 | |
0e66b3b6 | 863 | For use with the DANE-TA model, server certificates |
7cac846b JH |
864 | must have a correct name (SubjectName or SubjectAltName). |
865 | ||
866 | The use of OCSP-stapling should be considered, allowing | |
867 | for fast revocation of certificates (which would otherwise | |
eeb9276b | 868 | be limited by the DNS TTL on the TLSA records). However, |
0e66b3b6 | 869 | this is likely to only be usable with DANE-TA. NOTE: the |
fca41d5a JH |
870 | default of requesting OCSP for all hosts is modified iff |
871 | DANE is in use, to: | |
872 | ||
873 | hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \ | |
874 | {= {4}{$tls_out_tlsa_usage}} } \ | |
594706ea | 875 | {*}{}} |
fca41d5a JH |
876 | |
877 | The (new) variable $tls_out_tlsa_usage is a bitfield with | |
878 | numbered bits set for TLSA record usage codes. | |
879 | The zero above means DANE was not in use, | |
0e66b3b6 JH |
880 | the four means that only DANE-TA usage TLSA records were |
881 | found. If the definition of hosts_request_ocsp includes the | |
882 | string "tls_out_tlsa_usage", they are re-expanded in time to | |
883 | control the OCSP request. | |
594706ea | 884 | |
fca41d5a | 885 | This modification of hosts_request_ocsp is only done if |
036ed0db JH |
886 | it has the default value of "*". Admins who change it, and |
887 | those who use hosts_require_ocsp, should consider the interaction | |
888 | with DANE in their OCSP settings. | |
7cac846b JH |
889 | |
890 | ||
7a31d643 | 891 | For client-side DANE there are two new smtp transport options, |
4b0fe319 | 892 | hosts_try_dane and hosts_require_dane. |
7a31d643 | 893 | [ should they be domain-based rather than host-based? ] |
7cac846b | 894 | |
4b0fe319 JH |
895 | Hosts_require_dane will result in failure if the target host |
896 | is not DNSSEC-secured. | |
897 | ||
7cac846b JH |
898 | DANE will only be usable if the target host has DNSSEC-secured |
899 | MX, A and TLSA records. | |
900 | ||
0e66b3b6 | 901 | A TLSA lookup will be done if either of the above options match |
4c04137d | 902 | and the host-lookup succeeded using dnssec. |
3750d68d | 903 | If a TLSA lookup is done and succeeds, a DANE-verified TLS connection |
4b0fe319 JH |
904 | will be required for the host. If it does not, the host will not |
905 | be used; there is no fallback to non-DANE or non-TLS. | |
7cac846b | 906 | |
3750d68d JH |
907 | If DANE is requested and useable (see above) the following transport |
908 | options are ignored: | |
0e66b3b6 | 909 | hosts_require_tls |
043b1248 JH |
910 | tls_verify_hosts |
911 | tls_try_verify_hosts | |
912 | tls_verify_certificates | |
913 | tls_crl | |
914 | tls_verify_cert_hostnames | |
043b1248 | 915 | |
3750d68d JH |
916 | If DANE is not usable, whether requested or not, and CA-anchored |
917 | verification evaluation is wanted, the above variables should be set | |
918 | appropriately. | |
919 | ||
7cac846b JH |
920 | Currently dnssec_request_domains must be active (need to think about that) |
921 | and dnssec_require_domains is ignored. | |
043b1248 | 922 | |
eeb9276b JH |
923 | If verification was successful using DANE then the "CV" item |
924 | in the delivery log line will show as "CV=dane". | |
925 | ||
594706ea JH |
926 | There is a new variable $tls_out_dane which will have "yes" if |
927 | verification succeeded using DANE and "no" otherwise (only useful | |
8d692470 | 928 | in combination with EXPERIMENTAL_EVENT), and a new variable |
594706ea JH |
929 | $tls_out_tlsa_usage (detailed above). |
930 | ||
e51c7be2 | 931 | |
c65be124 | 932 | |
895fbaf2 JH |
933 | DSN extra information |
934 | --------------------- | |
935 | If compiled with EXPERIMENTAL_DSN_INFO extra information will be added | |
936 | to DSN fail messages ("bounces"), when available. The intent is to aid | |
937 | tracing of specific failing messages, when presented with a "bounce" | |
938 | complaint and needing to search logs. | |
939 | ||
940 | ||
941 | The remote MTA IP address, with port number if nonstandard. | |
942 | Example: | |
943 | Remote-MTA: X-ip; [127.0.0.1]:587 | |
944 | Rationale: | |
945 | Several addresses may correspond to the (already available) | |
946 | dns name for the remote MTA. | |
947 | ||
948 | The remote MTA connect-time greeting. | |
949 | Example: | |
950 | X-Remote-MTA-smtp-greeting: X-str; 220 the.local.host.name ESMTP Exim x.yz Tue, 2 Mar 1999 09:44:33 +0000 | |
951 | Rationale: | |
952 | This string sometimes presents the remote MTA's idea of its | |
953 | own name, and sometimes identifies the MTA software. | |
954 | ||
955 | The remote MTA response to HELO or EHLO. | |
956 | Example: | |
957 | X-Remote-MTA-helo-response: X-str; 250-the.local.host.name Hello localhost [127.0.0.1] | |
958 | Limitations: | |
959 | Only the first line of a multiline response is recorded. | |
960 | Rationale: | |
961 | This string sometimes presents the remote MTA's view of | |
962 | the peer IP connecting to it. | |
963 | ||
964 | The reporting MTA detailed diagnostic. | |
965 | Example: | |
966 | X-Exim-Diagnostic: X-str; SMTP error from remote mail server after RCPT TO:<d3@myhost.test.ex>: 550 hard error | |
967 | Rationale: | |
4c04137d | 968 | This string sometimes give extra information over the |
895fbaf2 JH |
969 | existing (already available) Diagnostic-Code field. |
970 | ||
971 | ||
972 | Note that non-RFC-documented field names and data types are used. | |
973 | ||
974 | ||
5bde3efa ACK |
975 | LMDB Lookup support |
976 | ------------------- | |
977 | LMDB is an ultra-fast, ultra-compact, crash-proof key-value embedded data store. | |
4c04137d | 978 | It is modeled loosely on the BerkeleyDB API. You should read about the feature |
5bde3efa ACK |
979 | set as well as operation modes at https://symas.com/products/lightning-memory-mapped-database/ |
980 | ||
981 | LMDB single key lookup support is provided by linking to the LMDB C library. | |
982 | The current implementation does not support writing to the LMDB database. | |
983 | ||
984 | Visit https://github.com/LMDB/lmdb to download the library or find it in your | |
985 | operating systems package repository. | |
986 | ||
987 | If building from source, this description assumes that headers will be in | |
988 | /usr/local/include, and that the libraries are in /usr/local/lib. | |
989 | ||
990 | 1. In order to build exim with LMDB lookup support add or uncomment | |
991 | ||
992 | EXPERIMENTAL_LMDB=yes | |
993 | ||
994 | to your Local/Makefile. (Re-)build/install exim. exim -d should show | |
995 | Experimental_LMDB in the line "Support for:". | |
996 | ||
997 | EXPERIMENTAL_LMDB=yes | |
998 | LDFLAGS += -llmdb | |
999 | # CFLAGS += -I/usr/local/include | |
1000 | # LDFLAGS += -L/usr/local/lib | |
1001 | ||
1002 | The first line sets the feature to include the correct code, and | |
1003 | the second line says to link the LMDB libraries into the | |
1004 | exim binary. The commented out lines should be uncommented if you | |
1005 | built LMDB from source and installed in the default location. | |
1006 | Adjust the paths if you installed them elsewhere, but you do not | |
1007 | need to uncomment them if an rpm (or you) installed them in the | |
1008 | package controlled locations (/usr/include and /usr/lib). | |
1009 | ||
1010 | 2. Create your LMDB files, you can use the mdb_load utility which is | |
1011 | part of the LMDB distribution our your favourite language bindings. | |
1012 | ||
1013 | 3. Add the single key lookups to your exim.conf file, example lookups | |
1014 | are below. | |
1015 | ||
1016 | ${lookup{$sender_address_domain}lmdb{/var/lib/baruwa/data/db/relaydomains.mdb}{$value}} | |
1017 | ${lookup{$sender_address_domain}lmdb{/var/lib/baruwa/data/db/relaydomains.mdb}{$value}fail} | |
1018 | ${lookup{$sender_address_domain}lmdb{/var/lib/baruwa/data/db/relaydomains.mdb}} | |
895fbaf2 | 1019 | |
ed0512a1 | 1020 | |
3369a853 ACK |
1021 | Queuefile transport |
1022 | ------------------- | |
1023 | Queuefile is a pseudo transport which does not perform final delivery. | |
1024 | It simply copies the exim spool files out of the spool directory into | |
1025 | an external directory retaining the exim spool format. | |
1026 | ||
1027 | The spool files can then be processed by external processes and then | |
1028 | requeued into exim spool directories for final delivery. | |
1029 | ||
1030 | The motivation/inspiration for the transport is to allow external | |
1031 | processes to access email queued by exim and have access to all the | |
1032 | information which would not be available if the messages were delivered | |
1033 | to the process in the standard email formats. | |
1034 | ||
1035 | The mailscanner package is one of the processes that can take advantage | |
1036 | of this transport to filter email. | |
1037 | ||
1038 | The transport can be used in the same way as the other existing transports, | |
1039 | i.e by configuring a router to route mail to a transport configured with | |
1040 | the queuefile driver. | |
1041 | ||
1042 | The transport only takes one option: | |
1043 | ||
1044 | * directory - This is used to specify the directory messages should be | |
1045 | copied to | |
1046 | ||
1047 | The generic transport options (body_only, current_directory, disable_logging, | |
1048 | debug_print, delivery_date_add, envelope_to_add, event_action, group, | |
1049 | headers_add, headers_only, headers_remove, headers_rewrite, home_directory, | |
1050 | initgroups, max_parallel, message_size_limit, rcpt_include_affixes, | |
1051 | retry_use_local_part, return_path, return_path_add, shadow_condition, | |
1052 | shadow_transport, transport_filter, transport_filter_timeout, user) are | |
1053 | ignored. | |
1054 | ||
1055 | Sample configuration: | |
1056 | ||
1057 | (Router) | |
1058 | ||
1059 | scan: | |
1060 | driver = accept | |
1061 | transport = scan | |
1062 | ||
1063 | (Transport) | |
1064 | ||
1065 | scan: | |
1066 | driver = queuefile | |
1067 | directory = /var/spool/baruwa-scanner/input | |
1068 | ||
1069 | ||
1070 | In order to build exim with Queuefile transport support add or uncomment | |
1071 | ||
1072 | EXPERIMENTAL_QUEUEFILE=yes | |
1073 | ||
1074 | to your Local/Makefile. (Re-)build/install exim. exim -d should show | |
1075 | Experimental_QUEUEFILE in the line "Support for:". | |
1076 | ||
1077 | ||
ee161e8f PH |
1078 | -------------------------------------------------------------- |
1079 | End of file | |
1080 | -------------------------------------------------------------- |