ACL modifier
[exim.git] / src / src / acl.c
CommitLineData
059ec3d9
PH
1/*************************************************
2* Exim - an Internet mail transport agent *
3*************************************************/
4
80fea873 5/* Copyright (c) University of Cambridge 1995 - 2016 */
059ec3d9
PH
6/* See the file NOTICE for conditions of use and distribution. */
7
8/* Code for handling Access Control Lists (ACLs) */
9
10#include "exim.h"
11
12
13/* Default callout timeout */
14
15#define CALLOUT_TIMEOUT_DEFAULT 30
16
17/* ACL verb codes - keep in step with the table of verbs that follows */
18
19enum { ACL_ACCEPT, ACL_DEFER, ACL_DENY, ACL_DISCARD, ACL_DROP, ACL_REQUIRE,
20 ACL_WARN };
21
22/* ACL verbs */
23
f9d04f08
JH
24static uschar *verbs[] = {
25 US"accept",
26 US"defer",
27 US"deny",
28 US"discard",
29 US"drop",
30 US"require",
059ec3d9
PH
31 US"warn" };
32
4e88a19f
PH
33/* For each verb, the conditions for which "message" or "log_message" are used
34are held as a bitmap. This is to avoid expanding the strings unnecessarily. For
35"accept", the FAIL case is used only after "endpass", but that is selected in
36the code. */
37
38static int msgcond[] = {
39 (1<<OK) | (1<<FAIL) | (1<<FAIL_DROP), /* accept */
40 (1<<OK), /* defer */
41 (1<<OK), /* deny */
42 (1<<OK) | (1<<FAIL) | (1<<FAIL_DROP), /* discard */
43 (1<<OK), /* drop */
44 (1<<FAIL) | (1<<FAIL_DROP), /* require */
45 (1<<OK) /* warn */
46 };
059ec3d9
PH
47
48/* ACL condition and modifier codes - keep in step with the table that
71fafd95
PH
49follows, and the cond_expand_at_top and uschar cond_modifiers tables lower
50down. */
059ec3d9 51
71fafd95
PH
52enum { ACLC_ACL,
53 ACLC_ADD_HEADER,
54 ACLC_AUTHENTICATED,
8523533c
TK
55#ifdef EXPERIMENTAL_BRIGHTMAIL
56 ACLC_BMI_OPTIN,
57#endif
71fafd95 58 ACLC_CONDITION,
c3611384 59 ACLC_CONTINUE,
71fafd95 60 ACLC_CONTROL,
6a8f9482
TK
61#ifdef EXPERIMENTAL_DCC
62 ACLC_DCC,
63#endif
8523533c
TK
64#ifdef WITH_CONTENT_SCAN
65 ACLC_DECODE,
66#endif
67 ACLC_DELAY,
80a47a2c
TK
68#ifndef DISABLE_DKIM
69 ACLC_DKIM_SIGNER,
70 ACLC_DKIM_STATUS,
fb2274d4 71#endif
4840604e
TL
72#ifdef EXPERIMENTAL_DMARC
73 ACLC_DMARC_STATUS,
74#endif
71fafd95
PH
75 ACLC_DNSLISTS,
76 ACLC_DOMAINS,
77 ACLC_ENCRYPTED,
78 ACLC_ENDPASS,
79 ACLC_HOSTS,
80 ACLC_LOCAL_PARTS,
81 ACLC_LOG_MESSAGE,
6ea85e9a 82 ACLC_LOG_REJECT_TARGET,
71fafd95 83 ACLC_LOGWRITE,
8523533c
TK
84#ifdef WITH_CONTENT_SCAN
85 ACLC_MALWARE,
86#endif
87 ACLC_MESSAGE,
88#ifdef WITH_CONTENT_SCAN
89 ACLC_MIME_REGEX,
90#endif
b0b9dbb1 91 ACLC_QUEUE,
870f6ba8 92 ACLC_RATELIMIT,
8523533c
TK
93 ACLC_RECIPIENTS,
94#ifdef WITH_CONTENT_SCAN
95 ACLC_REGEX,
96#endif
e7568d51 97 ACLC_REMOVE_HEADER,
71fafd95
PH
98 ACLC_SENDER_DOMAINS,
99 ACLC_SENDERS,
100 ACLC_SET,
8523533c 101#ifdef WITH_CONTENT_SCAN
8e669ac1 102 ACLC_SPAM,
8523533c
TK
103#endif
104#ifdef EXPERIMENTAL_SPF
105 ACLC_SPF,
65a7d8c3 106 ACLC_SPF_GUESS,
8523533c 107#endif
b0019c78 108 ACLC_UDPSEND,
8523533c 109 ACLC_VERIFY };
059ec3d9 110
c3611384 111/* ACL conditions/modifiers: "delay", "control", "continue", "endpass",
b0b9dbb1 112"message", "log_message", "log_reject_target", "logwrite", "queue" and "set" are
c3611384
PH
113modifiers that look like conditions but always return TRUE. They are used for
114their side effects. */
059ec3d9 115
9a26b6b2
PH
116static uschar *conditions[] = {
117 US"acl",
71fafd95 118 US"add_header",
9a26b6b2 119 US"authenticated",
8523533c
TK
120#ifdef EXPERIMENTAL_BRIGHTMAIL
121 US"bmi_optin",
122#endif
123 US"condition",
c3611384 124 US"continue",
8e669ac1 125 US"control",
6a8f9482
TK
126#ifdef EXPERIMENTAL_DCC
127 US"dcc",
128#endif
8523533c
TK
129#ifdef WITH_CONTENT_SCAN
130 US"decode",
131#endif
132 US"delay",
80a47a2c
TK
133#ifndef DISABLE_DKIM
134 US"dkim_signers",
135 US"dkim_status",
fb2274d4 136#endif
4840604e
TL
137#ifdef EXPERIMENTAL_DMARC
138 US"dmarc_status",
139#endif
6ea85e9a
PH
140 US"dnslists",
141 US"domains",
142 US"encrypted",
143 US"endpass",
144 US"hosts",
145 US"local_parts",
146 US"log_message",
147 US"log_reject_target",
148 US"logwrite",
8523533c
TK
149#ifdef WITH_CONTENT_SCAN
150 US"malware",
151#endif
152 US"message",
153#ifdef WITH_CONTENT_SCAN
154 US"mime_regex",
155#endif
b0b9dbb1 156 US"queue",
870f6ba8 157 US"ratelimit",
8523533c
TK
158 US"recipients",
159#ifdef WITH_CONTENT_SCAN
160 US"regex",
161#endif
e7568d51 162 US"remove_header",
b0b9dbb1
JH
163 US"sender_domains",
164 US"senders",
165 US"set",
8523533c
TK
166#ifdef WITH_CONTENT_SCAN
167 US"spam",
168#endif
169#ifdef EXPERIMENTAL_SPF
170 US"spf",
65a7d8c3 171 US"spf_guess",
8523533c 172#endif
b0019c78 173 US"udpsend",
059ec3d9 174 US"verify" };
8e669ac1 175
c5fcb476 176
9a26b6b2
PH
177/* Return values from decode_control(); keep in step with the table of names
178that follows! */
179
180enum {
c46782ef 181 CONTROL_AUTH_UNADVERTISED,
3c8b3577 182#ifdef EXPERIMENTAL_BRIGHTMAIL
9a26b6b2 183 CONTROL_BMI_RUN,
3c8b3577 184#endif
ed7f7860 185 CONTROL_DEBUG,
3c8b3577 186#ifndef DISABLE_DKIM
f7572e5a 187 CONTROL_DKIM_VERIFY,
3c8b3577
JH
188#endif
189#ifdef EXPERIMENTAL_DMARC
4840604e
TL
190 CONTROL_DMARC_VERIFY,
191 CONTROL_DMARC_FORENSIC,
3c8b3577 192#endif
13363eba 193 CONTROL_DSCP,
c46782ef
PH
194 CONTROL_ERROR,
195 CONTROL_CASEFUL_LOCAL_PART,
196 CONTROL_CASELOWER_LOCAL_PART,
e4bdf652 197 CONTROL_CUTTHROUGH_DELIVERY,
c46782ef
PH
198 CONTROL_ENFORCE_SYNC,
199 CONTROL_NO_ENFORCE_SYNC,
200 CONTROL_FREEZE,
201 CONTROL_QUEUE_ONLY,
202 CONTROL_SUBMISSION,
203 CONTROL_SUPPRESS_LOCAL_FIXUPS,
3c8b3577 204#ifdef WITH_CONTENT_SCAN
9a26b6b2 205 CONTROL_NO_MBOX_UNSPOOL,
3c8b3577 206#endif
c46782ef
PH
207 CONTROL_FAKEDEFER,
208 CONTROL_FAKEREJECT,
8c5d388a 209#ifdef SUPPORT_I18N
3c8b3577
JH
210 CONTROL_UTF8_DOWNCONVERT,
211#endif
cf8b11a5 212 CONTROL_NO_MULTILINE,
047bdd8c 213 CONTROL_NO_PIPELINING,
4c590bd1
PH
214 CONTROL_NO_DELAY_FLUSH,
215 CONTROL_NO_CALLOUT_FLUSH
c46782ef 216};
9a26b6b2 217
8800895a
PH
218/* ACL control names; keep in step with the table above! This list is used for
219turning ids into names. The actual list of recognized names is in the variable
220control_def controls_list[] below. The fact that there are two lists is a mess
221and should be tidied up. */
9a26b6b2
PH
222
223static uschar *controls[] = {
c46782ef 224 US"allow_auth_unadvertised",
3c8b3577 225#ifdef EXPERIMENTAL_BRIGHTMAIL
9a26b6b2 226 US"bmi_run",
3c8b3577 227#endif
ed7f7860 228 US"debug",
3c8b3577 229#ifndef DISABLE_DKIM
80a47a2c 230 US"dkim_disable_verify",
3c8b3577
JH
231#endif
232#ifdef EXPERIMENTAL_DMARC
4840604e
TL
233 US"dmarc_disable_verify",
234 US"dmarc_enable_forensic",
3c8b3577 235#endif
13363eba 236 US"dscp",
c46782ef
PH
237 US"error",
238 US"caseful_local_part",
239 US"caselower_local_part",
e4bdf652 240 US"cutthrough_delivery",
c46782ef
PH
241 US"enforce_sync",
242 US"no_enforce_sync",
243 US"freeze",
244 US"queue_only",
245 US"submission",
246 US"suppress_local_fixups",
3c8b3577 247#ifdef WITH_CONTENT_SCAN
9a26b6b2 248 US"no_mbox_unspool",
3c8b3577 249#endif
cf8b11a5
PH
250 US"fakedefer",
251 US"fakereject",
8c5d388a 252#ifdef SUPPORT_I18N
3c8b3577
JH
253 US"utf8_downconvert",
254#endif
aa6dc513 255 US"no_multiline_responses",
cf8b11a5 256 US"no_pipelining",
4c590bd1
PH
257 US"no_delay_flush",
258 US"no_callout_flush"
c46782ef 259};
059ec3d9 260
047bdd8c 261/* Flags to indicate for which conditions/modifiers a string expansion is done
059ec3d9
PH
262at the outer level. In the other cases, expansion already occurs in the
263checking functions. */
264
265static uschar cond_expand_at_top[] = {
7421ecab 266 FALSE, /* acl */
3e536984 267 TRUE, /* add_header */
059ec3d9 268 FALSE, /* authenticated */
8523533c
TK
269#ifdef EXPERIMENTAL_BRIGHTMAIL
270 TRUE, /* bmi_optin */
8e669ac1 271#endif
059ec3d9 272 TRUE, /* condition */
c3611384 273 TRUE, /* continue */
059ec3d9 274 TRUE, /* control */
6a8f9482
TK
275#ifdef EXPERIMENTAL_DCC
276 TRUE, /* dcc */
277#endif
8523533c
TK
278#ifdef WITH_CONTENT_SCAN
279 TRUE, /* decode */
280#endif
059ec3d9 281 TRUE, /* delay */
80a47a2c
TK
282#ifndef DISABLE_DKIM
283 TRUE, /* dkim_signers */
284 TRUE, /* dkim_status */
fb2274d4 285#endif
4840604e
TL
286#ifdef EXPERIMENTAL_DMARC
287 TRUE, /* dmarc_status */
288#endif
059ec3d9
PH
289 TRUE, /* dnslists */
290 FALSE, /* domains */
291 FALSE, /* encrypted */
292 TRUE, /* endpass */
293 FALSE, /* hosts */
294 FALSE, /* local_parts */
295 TRUE, /* log_message */
6ea85e9a 296 TRUE, /* log_reject_target */
059ec3d9 297 TRUE, /* logwrite */
8523533c
TK
298#ifdef WITH_CONTENT_SCAN
299 TRUE, /* malware */
300#endif
059ec3d9 301 TRUE, /* message */
8523533c
TK
302#ifdef WITH_CONTENT_SCAN
303 TRUE, /* mime_regex */
304#endif
b0b9dbb1 305 TRUE, /* queue */
870f6ba8 306 TRUE, /* ratelimit */
059ec3d9 307 FALSE, /* recipients */
8523533c
TK
308#ifdef WITH_CONTENT_SCAN
309 TRUE, /* regex */
310#endif
e7568d51 311 TRUE, /* remove_header */
059ec3d9
PH
312 FALSE, /* sender_domains */
313 FALSE, /* senders */
314 TRUE, /* set */
8523533c
TK
315#ifdef WITH_CONTENT_SCAN
316 TRUE, /* spam */
317#endif
318#ifdef EXPERIMENTAL_SPF
319 TRUE, /* spf */
65a7d8c3 320 TRUE, /* spf_guess */
8523533c 321#endif
b0019c78 322 TRUE, /* udpsend */
059ec3d9
PH
323 TRUE /* verify */
324};
325
326/* Flags to identify the modifiers */
327
328static uschar cond_modifiers[] = {
329 FALSE, /* acl */
3e536984 330 TRUE, /* add_header */
059ec3d9 331 FALSE, /* authenticated */
8523533c
TK
332#ifdef EXPERIMENTAL_BRIGHTMAIL
333 TRUE, /* bmi_optin */
8e669ac1 334#endif
059ec3d9 335 FALSE, /* condition */
c3611384 336 TRUE, /* continue */
059ec3d9 337 TRUE, /* control */
6a8f9482
TK
338#ifdef EXPERIMENTAL_DCC
339 FALSE, /* dcc */
340#endif
8523533c
TK
341#ifdef WITH_CONTENT_SCAN
342 FALSE, /* decode */
343#endif
059ec3d9 344 TRUE, /* delay */
80a47a2c
TK
345#ifndef DISABLE_DKIM
346 FALSE, /* dkim_signers */
347 FALSE, /* dkim_status */
fb2274d4 348#endif
4840604e
TL
349#ifdef EXPERIMENTAL_DMARC
350 FALSE, /* dmarc_status */
351#endif
059ec3d9
PH
352 FALSE, /* dnslists */
353 FALSE, /* domains */
354 FALSE, /* encrypted */
355 TRUE, /* endpass */
356 FALSE, /* hosts */
357 FALSE, /* local_parts */
358 TRUE, /* log_message */
6ea85e9a 359 TRUE, /* log_reject_target */
8523533c
TK
360 TRUE, /* logwrite */
361#ifdef WITH_CONTENT_SCAN
362 FALSE, /* malware */
363#endif
059ec3d9 364 TRUE, /* message */
8523533c
TK
365#ifdef WITH_CONTENT_SCAN
366 FALSE, /* mime_regex */
367#endif
b0b9dbb1 368 TRUE, /* queue */
870f6ba8 369 FALSE, /* ratelimit */
059ec3d9 370 FALSE, /* recipients */
8523533c
TK
371#ifdef WITH_CONTENT_SCAN
372 FALSE, /* regex */
373#endif
e7568d51 374 TRUE, /* remove_header */
059ec3d9
PH
375 FALSE, /* sender_domains */
376 FALSE, /* senders */
377 TRUE, /* set */
8523533c
TK
378#ifdef WITH_CONTENT_SCAN
379 FALSE, /* spam */
380#endif
381#ifdef EXPERIMENTAL_SPF
382 FALSE, /* spf */
65a7d8c3 383 FALSE, /* spf_guess */
8523533c 384#endif
b0019c78 385 TRUE, /* udpsend */
059ec3d9
PH
386 FALSE /* verify */
387};
388
c3611384 389/* Bit map vector of which conditions and modifiers are not allowed at certain
8f128379
PH
390times. For each condition and modifier, there's a bitmap of dis-allowed times.
391For some, it is easier to specify the negation of a small number of allowed
392times. */
059ec3d9
PH
393
394static unsigned int cond_forbids[] = {
395 0, /* acl */
8e669ac1 396
71fafd95 397 (unsigned int)
45b91596 398 ~((1<<ACL_WHERE_MAIL)|(1<<ACL_WHERE_RCPT)| /* add_header */
71fafd95 399 (1<<ACL_WHERE_PREDATA)|(1<<ACL_WHERE_DATA)|
8ccd00b1 400 #ifndef DISABLE_PRDR
fd98a5c6
JH
401 (1<<ACL_WHERE_PRDR)|
402 #endif
45b91596 403 (1<<ACL_WHERE_MIME)|(1<<ACL_WHERE_NOTSMTP)|
67caae1f 404 (1<<ACL_WHERE_DKIM)|
45b91596 405 (1<<ACL_WHERE_NOTSMTP_START)),
71fafd95 406
45b91596
PH
407 (1<<ACL_WHERE_NOTSMTP)| /* authenticated */
408 (1<<ACL_WHERE_NOTSMTP_START)|
409 (1<<ACL_WHERE_CONNECT)|(1<<ACL_WHERE_HELO),
8e669ac1 410
71fafd95 411 #ifdef EXPERIMENTAL_BRIGHTMAIL
3864bb8e 412 (1<<ACL_WHERE_AUTH)| /* bmi_optin */
8523533c
TK
413 (1<<ACL_WHERE_CONNECT)|(1<<ACL_WHERE_HELO)|
414 (1<<ACL_WHERE_DATA)|(1<<ACL_WHERE_MIME)|
8ccd00b1 415 #ifndef DISABLE_PRDR
fd98a5c6
JH
416 (1<<ACL_WHERE_PRDR)|
417 #endif
8e669ac1 418 (1<<ACL_WHERE_ETRN)|(1<<ACL_WHERE_EXPN)|
8523533c
TK
419 (1<<ACL_WHERE_MAILAUTH)|
420 (1<<ACL_WHERE_MAIL)|(1<<ACL_WHERE_STARTTLS)|
45b91596
PH
421 (1<<ACL_WHERE_VRFY)|(1<<ACL_WHERE_PREDATA)|
422 (1<<ACL_WHERE_NOTSMTP_START),
71fafd95 423 #endif
8e669ac1 424
059ec3d9 425 0, /* condition */
8e669ac1 426
c3611384
PH
427 0, /* continue */
428
059ec3d9 429 /* Certain types of control are always allowed, so we let it through
2f079f46 430 always and check in the control processing itself. */
8e669ac1 431
059ec3d9 432 0, /* control */
8e669ac1 433
6a8f9482
TK
434 #ifdef EXPERIMENTAL_DCC
435 (unsigned int)
fd98a5c6 436 ~((1<<ACL_WHERE_DATA)| /* dcc */
8ccd00b1 437 #ifndef DISABLE_PRDR
fd98a5c6 438 (1<<ACL_WHERE_PRDR)|
8ccd00b1 439 #endif
fd98a5c6 440 (1<<ACL_WHERE_NOTSMTP)),
6a8f9482
TK
441 #endif
442
71fafd95 443 #ifdef WITH_CONTENT_SCAN
2f079f46
PH
444 (unsigned int)
445 ~(1<<ACL_WHERE_MIME), /* decode */
71fafd95 446 #endif
8523533c 447
8f128379 448 (1<<ACL_WHERE_NOTQUIT), /* delay */
8e669ac1 449
80a47a2c
TK
450 #ifndef DISABLE_DKIM
451 (unsigned int)
452 ~(1<<ACL_WHERE_DKIM), /* dkim_signers */
84330b7b 453
80a47a2c
TK
454 (unsigned int)
455 ~(1<<ACL_WHERE_DKIM), /* dkim_status */
71fafd95 456 #endif
fb2274d4 457
4840604e
TL
458 #ifdef EXPERIMENTAL_DMARC
459 (unsigned int)
460 ~(1<<ACL_WHERE_DATA), /* dmarc_status */
461 #endif
462
379ba7d0
JH
463 /* Explicit key lookups can be made in non-smtp ACLs so pass
464 always and check in the verify processing itself. */
465
466 0, /* dnslists */
059ec3d9 467
2f079f46 468 (unsigned int)
fd98a5c6 469 ~((1<<ACL_WHERE_RCPT) /* domains */
4f6ae5c3 470 |(1<<ACL_WHERE_VRFY)
8ccd00b1 471 #ifndef DISABLE_PRDR
fd98a5c6
JH
472 |(1<<ACL_WHERE_PRDR)
473 #endif
474 ),
059ec3d9 475
45b91596
PH
476 (1<<ACL_WHERE_NOTSMTP)| /* encrypted */
477 (1<<ACL_WHERE_CONNECT)|
478 (1<<ACL_WHERE_NOTSMTP_START)|
059ec3d9 479 (1<<ACL_WHERE_HELO),
8e669ac1 480
059ec3d9 481 0, /* endpass */
8e669ac1 482
45b91596
PH
483 (1<<ACL_WHERE_NOTSMTP)| /* hosts */
484 (1<<ACL_WHERE_NOTSMTP_START),
059ec3d9 485
2f079f46 486 (unsigned int)
fd98a5c6 487 ~((1<<ACL_WHERE_RCPT) /* local_parts */
4f6ae5c3 488 |(1<<ACL_WHERE_VRFY)
2e6afa4f 489 #ifndef DISABLE_PRDR
fd98a5c6
JH
490 |(1<<ACL_WHERE_PRDR)
491 #endif
492 ),
059ec3d9
PH
493
494 0, /* log_message */
8e669ac1 495
6ea85e9a
PH
496 0, /* log_reject_target */
497
059ec3d9 498 0, /* logwrite */
8e669ac1 499
71fafd95 500 #ifdef WITH_CONTENT_SCAN
2f079f46 501 (unsigned int)
fd98a5c6 502 ~((1<<ACL_WHERE_DATA)| /* malware */
8ccd00b1 503 #ifndef DISABLE_PRDR
fd98a5c6 504 (1<<ACL_WHERE_PRDR)|
8ccd00b1 505 #endif
fd98a5c6 506 (1<<ACL_WHERE_NOTSMTP)),
71fafd95 507 #endif
8523533c 508
059ec3d9
PH
509 0, /* message */
510
71fafd95 511 #ifdef WITH_CONTENT_SCAN
2f079f46
PH
512 (unsigned int)
513 ~(1<<ACL_WHERE_MIME), /* mime_regex */
71fafd95 514 #endif
8523533c 515
b0b9dbb1 516 0, /* queue */
870f6ba8
TF
517 0, /* ratelimit */
518
2f079f46
PH
519 (unsigned int)
520 ~(1<<ACL_WHERE_RCPT), /* recipients */
059ec3d9 521
71fafd95 522 #ifdef WITH_CONTENT_SCAN
2f079f46 523 (unsigned int)
fd98a5c6 524 ~((1<<ACL_WHERE_DATA)| /* regex */
8ccd00b1 525 #ifndef DISABLE_PRDR
fd98a5c6 526 (1<<ACL_WHERE_PRDR)|
8ccd00b1 527 #endif
fd98a5c6 528 (1<<ACL_WHERE_NOTSMTP)|
2f079f46 529 (1<<ACL_WHERE_MIME)),
71fafd95 530 #endif
8523533c 531
e7568d51
TL
532 (unsigned int)
533 ~((1<<ACL_WHERE_MAIL)|(1<<ACL_WHERE_RCPT)| /* remove_header */
534 (1<<ACL_WHERE_PREDATA)|(1<<ACL_WHERE_DATA)|
8ccd00b1 535 #ifndef DISABLE_PRDR
fd98a5c6
JH
536 (1<<ACL_WHERE_PRDR)|
537 #endif
e7568d51
TL
538 (1<<ACL_WHERE_MIME)|(1<<ACL_WHERE_NOTSMTP)|
539 (1<<ACL_WHERE_NOTSMTP_START)),
540
059ec3d9
PH
541 (1<<ACL_WHERE_AUTH)|(1<<ACL_WHERE_CONNECT)| /* sender_domains */
542 (1<<ACL_WHERE_HELO)|
543 (1<<ACL_WHERE_MAILAUTH)|(1<<ACL_WHERE_QUIT)|
544 (1<<ACL_WHERE_ETRN)|(1<<ACL_WHERE_EXPN)|
545 (1<<ACL_WHERE_STARTTLS)|(1<<ACL_WHERE_VRFY),
546
547 (1<<ACL_WHERE_AUTH)|(1<<ACL_WHERE_CONNECT)| /* senders */
548 (1<<ACL_WHERE_HELO)|
549 (1<<ACL_WHERE_MAILAUTH)|(1<<ACL_WHERE_QUIT)|
550 (1<<ACL_WHERE_ETRN)|(1<<ACL_WHERE_EXPN)|
551 (1<<ACL_WHERE_STARTTLS)|(1<<ACL_WHERE_VRFY),
552
553 0, /* set */
554
71fafd95 555 #ifdef WITH_CONTENT_SCAN
2f079f46 556 (unsigned int)
fd98a5c6 557 ~((1<<ACL_WHERE_DATA)| /* spam */
8ccd00b1 558 #ifndef DISABLE_PRDR
fd98a5c6 559 (1<<ACL_WHERE_PRDR)|
8ccd00b1 560 #endif
fd98a5c6 561 (1<<ACL_WHERE_NOTSMTP)),
71fafd95 562 #endif
8523533c 563
71fafd95 564 #ifdef EXPERIMENTAL_SPF
8523533c
TK
565 (1<<ACL_WHERE_AUTH)|(1<<ACL_WHERE_CONNECT)| /* spf */
566 (1<<ACL_WHERE_HELO)|
567 (1<<ACL_WHERE_MAILAUTH)|
568 (1<<ACL_WHERE_ETRN)|(1<<ACL_WHERE_EXPN)|
45b91596
PH
569 (1<<ACL_WHERE_STARTTLS)|(1<<ACL_WHERE_VRFY)|
570 (1<<ACL_WHERE_NOTSMTP)|
571 (1<<ACL_WHERE_NOTSMTP_START),
65a7d8c3
NM
572
573 (1<<ACL_WHERE_AUTH)|(1<<ACL_WHERE_CONNECT)| /* spf_guess */
574 (1<<ACL_WHERE_HELO)|
575 (1<<ACL_WHERE_MAILAUTH)|
576 (1<<ACL_WHERE_ETRN)|(1<<ACL_WHERE_EXPN)|
577 (1<<ACL_WHERE_STARTTLS)|(1<<ACL_WHERE_VRFY)|
578 (1<<ACL_WHERE_NOTSMTP)|
579 (1<<ACL_WHERE_NOTSMTP_START),
71fafd95 580 #endif
8523533c 581
b0019c78
TF
582 0, /* udpsend */
583
059ec3d9
PH
584 /* Certain types of verify are always allowed, so we let it through
585 always and check in the verify function itself */
586
587 0 /* verify */
059ec3d9
PH
588};
589
590
c5fcb476
PH
591/* Bit map vector of which controls are not allowed at certain times. For
592each control, there's a bitmap of dis-allowed times. For some, it is easier to
593specify the negation of a small number of allowed times. */
594
595static unsigned int control_forbids[] = {
c46782ef
PH
596 (unsigned int)
597 ~((1<<ACL_WHERE_CONNECT)|(1<<ACL_WHERE_HELO)), /* allow_auth_unadvertised */
598
3c8b3577 599#ifdef EXPERIMENTAL_BRIGHTMAIL
8523533c 600 0, /* bmi_run */
3c8b3577 601#endif
c46782ef 602
ed7f7860
PP
603 0, /* debug */
604
3c8b3577 605#ifndef DISABLE_DKIM
80a47a2c 606 (1<<ACL_WHERE_DATA)|(1<<ACL_WHERE_NOTSMTP)| /* dkim_disable_verify */
3c8b3577 607# ifndef DISABLE_PRDR
fd98a5c6 608 (1<<ACL_WHERE_PRDR)|
3c8b3577 609# endif
f7572e5a 610 (1<<ACL_WHERE_NOTSMTP_START),
3c8b3577 611#endif
f7572e5a 612
3c8b3577 613#ifdef EXPERIMENTAL_DMARC
4840604e
TL
614 (1<<ACL_WHERE_DATA)|(1<<ACL_WHERE_NOTSMTP)| /* dmarc_disable_verify */
615 (1<<ACL_WHERE_NOTSMTP_START),
616 (1<<ACL_WHERE_DATA)|(1<<ACL_WHERE_NOTSMTP)| /* dmarc_enable_forensic */
617 (1<<ACL_WHERE_NOTSMTP_START),
3c8b3577 618#endif
4840604e 619
13363eba
PP
620 (1<<ACL_WHERE_NOTSMTP)|
621 (1<<ACL_WHERE_NOTSMTP_START)|
622 (1<<ACL_WHERE_NOTQUIT), /* dscp */
623
c5fcb476 624 0, /* error */
8e669ac1
PH
625
626 (unsigned int)
c5fcb476 627 ~(1<<ACL_WHERE_RCPT), /* caseful_local_part */
8e669ac1
PH
628
629 (unsigned int)
c5fcb476 630 ~(1<<ACL_WHERE_RCPT), /* caselower_local_part */
8e669ac1 631
e4bdf652
JH
632 (unsigned int)
633 0, /* cutthrough_delivery */
634
45b91596
PH
635 (1<<ACL_WHERE_NOTSMTP)| /* enforce_sync */
636 (1<<ACL_WHERE_NOTSMTP_START),
8e669ac1 637
45b91596
PH
638 (1<<ACL_WHERE_NOTSMTP)| /* no_enforce_sync */
639 (1<<ACL_WHERE_NOTSMTP_START),
8e669ac1
PH
640
641 (unsigned int)
c5fcb476
PH
642 ~((1<<ACL_WHERE_MAIL)|(1<<ACL_WHERE_RCPT)| /* freeze */
643 (1<<ACL_WHERE_PREDATA)|(1<<ACL_WHERE_DATA)|
fd98a5c6 644 // (1<<ACL_WHERE_PRDR)| /* Not allow one user to freeze for all */
e715ad22 645 (1<<ACL_WHERE_NOTSMTP)|(1<<ACL_WHERE_MIME)),
8e669ac1
PH
646
647 (unsigned int)
c5fcb476
PH
648 ~((1<<ACL_WHERE_MAIL)|(1<<ACL_WHERE_RCPT)| /* queue_only */
649 (1<<ACL_WHERE_PREDATA)|(1<<ACL_WHERE_DATA)|
fd98a5c6 650 // (1<<ACL_WHERE_PRDR)| /* Not allow one user to freeze for all */
e715ad22 651 (1<<ACL_WHERE_NOTSMTP)|(1<<ACL_WHERE_MIME)),
8e669ac1
PH
652
653 (unsigned int)
c5fcb476 654 ~((1<<ACL_WHERE_MAIL)|(1<<ACL_WHERE_RCPT)| /* submission */
8e669ac1 655 (1<<ACL_WHERE_PREDATA)),
8523533c 656
8800895a
PH
657 (unsigned int)
658 ~((1<<ACL_WHERE_MAIL)|(1<<ACL_WHERE_RCPT)| /* suppress_local_fixups */
45b91596
PH
659 (1<<ACL_WHERE_PREDATA)|
660 (1<<ACL_WHERE_NOTSMTP_START)),
8800895a 661
3c8b3577 662#ifdef WITH_CONTENT_SCAN
8e669ac1 663 (unsigned int)
14d57970 664 ~((1<<ACL_WHERE_MAIL)|(1<<ACL_WHERE_RCPT)| /* no_mbox_unspool */
e715ad22 665 (1<<ACL_WHERE_PREDATA)|(1<<ACL_WHERE_DATA)|
fd98a5c6 666 // (1<<ACL_WHERE_PRDR)| /* Not allow one user to freeze for all */
e715ad22 667 (1<<ACL_WHERE_MIME)),
3c8b3577 668#endif
a6c4ab60 669
8e669ac1 670 (unsigned int)
29aba418
TF
671 ~((1<<ACL_WHERE_MAIL)|(1<<ACL_WHERE_RCPT)| /* fakedefer */
672 (1<<ACL_WHERE_PREDATA)|(1<<ACL_WHERE_DATA)|
3c8b3577 673#ifndef DISABLE_PRDR
fd98a5c6 674 (1<<ACL_WHERE_PRDR)|
3c8b3577 675#endif
29aba418
TF
676 (1<<ACL_WHERE_MIME)),
677
678 (unsigned int)
a6c4ab60 679 ~((1<<ACL_WHERE_MAIL)|(1<<ACL_WHERE_RCPT)| /* fakereject */
e715ad22 680 (1<<ACL_WHERE_PREDATA)|(1<<ACL_WHERE_DATA)|
3c8b3577 681#ifndef DISABLE_PRDR
fd98a5c6 682 (1<<ACL_WHERE_PRDR)|
3c8b3577 683#endif
e715ad22 684 (1<<ACL_WHERE_MIME)),
8523533c 685
8c5d388a 686#ifdef SUPPORT_I18N
3c8b3577
JH
687 0, /* utf8_downconvert */
688#endif
689
45b91596 690 (1<<ACL_WHERE_NOTSMTP)| /* no_multiline */
cf8b11a5
PH
691 (1<<ACL_WHERE_NOTSMTP_START),
692
693 (1<<ACL_WHERE_NOTSMTP)| /* no_pipelining */
047bdd8c
PH
694 (1<<ACL_WHERE_NOTSMTP_START),
695
696 (1<<ACL_WHERE_NOTSMTP)| /* no_delay_flush */
4c590bd1
PH
697 (1<<ACL_WHERE_NOTSMTP_START),
698
699 (1<<ACL_WHERE_NOTSMTP)| /* no_callout_flush */
45b91596 700 (1<<ACL_WHERE_NOTSMTP_START)
c5fcb476
PH
701};
702
703/* Structure listing various control arguments, with their characteristics. */
059ec3d9
PH
704
705typedef struct control_def {
706 uschar *name;
707 int value; /* CONTROL_xxx value */
059ec3d9
PH
708 BOOL has_option; /* Has /option(s) following */
709} control_def;
710
711static control_def controls_list[] = {
3c8b3577 712 { US"allow_auth_unadvertised", CONTROL_AUTH_UNADVERTISED, FALSE },
8523533c 713#ifdef EXPERIMENTAL_BRIGHTMAIL
3c8b3577 714 { US"bmi_run", CONTROL_BMI_RUN, FALSE },
8523533c 715#endif
3c8b3577 716 { US"debug", CONTROL_DEBUG, TRUE },
80a47a2c 717#ifndef DISABLE_DKIM
3c8b3577 718 { US"dkim_disable_verify", CONTROL_DKIM_VERIFY, FALSE },
f7572e5a 719#endif
4840604e 720#ifdef EXPERIMENTAL_DMARC
3c8b3577
JH
721 { US"dmarc_disable_verify", CONTROL_DMARC_VERIFY, FALSE },
722 { US"dmarc_enable_forensic", CONTROL_DMARC_FORENSIC, FALSE },
4840604e 723#endif
3c8b3577
JH
724 { US"dscp", CONTROL_DSCP, TRUE },
725 { US"caseful_local_part", CONTROL_CASEFUL_LOCAL_PART, FALSE },
726 { US"caselower_local_part", CONTROL_CASELOWER_LOCAL_PART, FALSE },
727 { US"enforce_sync", CONTROL_ENFORCE_SYNC, FALSE },
728 { US"freeze", CONTROL_FREEZE, TRUE },
729 { US"no_callout_flush", CONTROL_NO_CALLOUT_FLUSH, FALSE },
730 { US"no_delay_flush", CONTROL_NO_DELAY_FLUSH, FALSE },
731 { US"no_enforce_sync", CONTROL_NO_ENFORCE_SYNC, FALSE },
732 { US"no_multiline_responses", CONTROL_NO_MULTILINE, FALSE },
733 { US"no_pipelining", CONTROL_NO_PIPELINING, FALSE },
734 { US"queue_only", CONTROL_QUEUE_ONLY, FALSE },
8523533c 735#ifdef WITH_CONTENT_SCAN
3c8b3577 736 { US"no_mbox_unspool", CONTROL_NO_MBOX_UNSPOOL, FALSE },
8523533c 737#endif
3c8b3577
JH
738 { US"fakedefer", CONTROL_FAKEDEFER, TRUE },
739 { US"fakereject", CONTROL_FAKEREJECT, TRUE },
740 { US"submission", CONTROL_SUBMISSION, TRUE },
e4bdf652 741 { US"suppress_local_fixups", CONTROL_SUPPRESS_LOCAL_FIXUPS, FALSE },
3c8b3577 742 { US"cutthrough_delivery", CONTROL_CUTTHROUGH_DELIVERY, FALSE },
8c5d388a 743#ifdef SUPPORT_I18N
3c8b3577
JH
744 { US"utf8_downconvert", CONTROL_UTF8_DOWNCONVERT, TRUE }
745#endif
059ec3d9
PH
746 };
747
e5a9dba6
PH
748/* Support data structures for Client SMTP Authorization. acl_verify_csa()
749caches its result in a tree to avoid repeated DNS queries. The result is an
750integer code which is used as an index into the following tables of
751explanatory strings and verification return codes. */
752
753static tree_node *csa_cache = NULL;
754
755enum { CSA_UNKNOWN, CSA_OK, CSA_DEFER_SRV, CSA_DEFER_ADDR,
756 CSA_FAIL_EXPLICIT, CSA_FAIL_DOMAIN, CSA_FAIL_NOADDR, CSA_FAIL_MISMATCH };
757
758/* The acl_verify_csa() return code is translated into an acl_verify() return
759code using the following table. It is OK unless the client is definitely not
760authorized. This is because CSA is supposed to be optional for sending sites,
761so recipients should not be too strict about checking it - especially because
762DNS problems are quite likely to occur. It's possible to use $csa_status in
763further ACL conditions to distinguish ok, unknown, and defer if required, but
764the aim is to make the usual configuration simple. */
765
766static int csa_return_code[] = {
767 OK, OK, OK, OK,
768 FAIL, FAIL, FAIL, FAIL
769};
770
771static uschar *csa_status_string[] = {
772 US"unknown", US"ok", US"defer", US"defer",
773 US"fail", US"fail", US"fail", US"fail"
774};
775
776static uschar *csa_reason_string[] = {
777 US"unknown",
778 US"ok",
779 US"deferred (SRV lookup failed)",
780 US"deferred (target address lookup failed)",
781 US"failed (explicit authorization required)",
782 US"failed (host name not authorized)",
783 US"failed (no authorized addresses)",
784 US"failed (client address mismatch)"
785};
786
c99ce5c9
TF
787/* Options for the ratelimit condition. Note that there are two variants of
788the per_rcpt option, depending on the ACL that is used to measure the rate.
789However any ACL must be able to look up per_rcpt rates in /noupdate mode,
790so the two variants must have the same internal representation as well as
791the same configuration string. */
792
793enum {
794 RATE_PER_WHAT, RATE_PER_CLASH, RATE_PER_ADDR, RATE_PER_BYTE, RATE_PER_CMD,
795 RATE_PER_CONN, RATE_PER_MAIL, RATE_PER_RCPT, RATE_PER_ALLRCPTS
796};
797
798#define RATE_SET(var,new) \
799 (((var) == RATE_PER_WHAT) ? ((var) = RATE_##new) : ((var) = RATE_PER_CLASH))
800
801static uschar *ratelimit_option_string[] = {
802 US"?", US"!", US"per_addr", US"per_byte", US"per_cmd",
803 US"per_conn", US"per_mail", US"per_rcpt", US"per_rcpt"
804};
805
059ec3d9
PH
806/* Enable recursion between acl_check_internal() and acl_check_condition() */
807
55414b25 808static int acl_check_wargs(int, address_item *, const uschar *, int, uschar **,
f60d98e8 809 uschar **);
059ec3d9
PH
810
811
812/*************************************************
813* Pick out name from list *
814*************************************************/
815
816/* Use a binary chop method
817
818Arguments:
819 name name to find
820 list list of names
821 end size of list
822
823Returns: offset in list, or -1 if not found
824*/
825
826static int
827acl_checkname(uschar *name, uschar **list, int end)
828{
829int start = 0;
830
831while (start < end)
832 {
833 int mid = (start + end)/2;
834 int c = Ustrcmp(name, list[mid]);
835 if (c == 0) return mid;
836 if (c < 0) end = mid; else start = mid + 1;
837 }
838
839return -1;
840}
841
842
843/*************************************************
844* Read and parse one ACL *
845*************************************************/
846
847/* This function is called both from readconf in order to parse the ACLs in the
848configuration file, and also when an ACL is encountered dynamically (e.g. as
849the result of an expansion). It is given a function to call in order to
850retrieve the lines of the ACL. This function handles skipping comments and
851blank lines (where relevant).
852
853Arguments:
854 func function to get next line of ACL
855 error where to put an error message
856
857Returns: pointer to ACL, or NULL
858 NULL can be legal (empty ACL); in this case error will be NULL
859*/
860
861acl_block *
862acl_read(uschar *(*func)(void), uschar **error)
863{
864acl_block *yield = NULL;
865acl_block **lastp = &yield;
866acl_block *this = NULL;
867acl_condition_block *cond;
868acl_condition_block **condp = NULL;
869uschar *s;
870
871*error = NULL;
872
873while ((s = (*func)()) != NULL)
874 {
875 int v, c;
876 BOOL negated = FALSE;
877 uschar *saveline = s;
878 uschar name[64];
879
880 /* Conditions (but not verbs) are allowed to be negated by an initial
881 exclamation mark. */
882
883 while (isspace(*s)) s++;
884 if (*s == '!')
885 {
886 negated = TRUE;
887 s++;
888 }
889
cf00dad6
PH
890 /* Read the name of a verb or a condition, or the start of a new ACL, which
891 can be started by a name, or by a macro definition. */
059ec3d9
PH
892
893 s = readconf_readname(name, sizeof(name), s);
b8dc3e4a 894 if (*s == ':' || (isupper(name[0]) && *s == '=')) return yield;
059ec3d9
PH
895
896 /* If a verb is unrecognized, it may be another condition or modifier that
897 continues the previous verb. */
898
899 v = acl_checkname(name, verbs, sizeof(verbs)/sizeof(char *));
900 if (v < 0)
901 {
902 if (this == NULL)
903 {
4e167a8c
PH
904 *error = string_sprintf("unknown ACL verb \"%s\" in \"%s\"", name,
905 saveline);
059ec3d9
PH
906 return NULL;
907 }
908 }
909
910 /* New verb */
911
912 else
913 {
914 if (negated)
915 {
916 *error = string_sprintf("malformed ACL line \"%s\"", saveline);
917 return NULL;
918 }
919 this = store_get(sizeof(acl_block));
920 *lastp = this;
921 lastp = &(this->next);
922 this->next = NULL;
923 this->verb = v;
924 this->condition = NULL;
925 condp = &(this->condition);
926 if (*s == 0) continue; /* No condition on this line */
927 if (*s == '!')
928 {
929 negated = TRUE;
930 s++;
931 }
932 s = readconf_readname(name, sizeof(name), s); /* Condition name */
933 }
934
935 /* Handle a condition or modifier. */
936
937 c = acl_checkname(name, conditions, sizeof(conditions)/sizeof(char *));
938 if (c < 0)
939 {
940 *error = string_sprintf("unknown ACL condition/modifier in \"%s\"",
941 saveline);
942 return NULL;
943 }
944
945 /* The modifiers may not be negated */
946
947 if (negated && cond_modifiers[c])
948 {
949 *error = string_sprintf("ACL error: negation is not allowed with "
950 "\"%s\"", conditions[c]);
951 return NULL;
952 }
953
954 /* ENDPASS may occur only with ACCEPT or DISCARD. */
955
956 if (c == ACLC_ENDPASS &&
957 this->verb != ACL_ACCEPT &&
958 this->verb != ACL_DISCARD)
959 {
960 *error = string_sprintf("ACL error: \"%s\" is not allowed with \"%s\"",
961 conditions[c], verbs[this->verb]);
962 return NULL;
963 }
964
965 cond = store_get(sizeof(acl_condition_block));
966 cond->next = NULL;
967 cond->type = c;
968 cond->u.negated = negated;
969
970 *condp = cond;
971 condp = &(cond->next);
972
973 /* The "set" modifier is different in that its argument is "name=value"
974 rather than just a value, and we can check the validity of the name, which
38a0a95f
PH
975 gives us a variable name to insert into the data block. The original ACL
976 variable names were acl_c0 ... acl_c9 and acl_m0 ... acl_m9. This was
977 extended to 20 of each type, but after that people successfully argued for
641cb756
PH
978 arbitrary names. In the new scheme, the names must start with acl_c or acl_m.
979 After that, we allow alphanumerics and underscores, but the first character
980 after c or m must be a digit or an underscore. This retains backwards
981 compatibility. */
059ec3d9
PH
982
983 if (c == ACLC_SET)
984 {
47ca6d6c
PH
985 uschar *endptr;
986
38a0a95f
PH
987 if (Ustrncmp(s, "acl_c", 5) != 0 &&
988 Ustrncmp(s, "acl_m", 5) != 0)
47ca6d6c 989 {
38a0a95f
PH
990 *error = string_sprintf("invalid variable name after \"set\" in ACL "
991 "modifier \"set %s\" (must start \"acl_c\" or \"acl_m\")", s);
992 return NULL;
47ca6d6c 993 }
38a0a95f
PH
994
995 endptr = s + 5;
641cb756
PH
996 if (!isdigit(*endptr) && *endptr != '_')
997 {
998 *error = string_sprintf("invalid variable name after \"set\" in ACL "
999 "modifier \"set %s\" (digit or underscore must follow acl_c or acl_m)",
1000 s);
1001 return NULL;
1002 }
1003
38a0a95f 1004 while (*endptr != 0 && *endptr != '=' && !isspace(*endptr))
47ca6d6c 1005 {
38a0a95f
PH
1006 if (!isalnum(*endptr) && *endptr != '_')
1007 {
1008 *error = string_sprintf("invalid character \"%c\" in variable name "
1009 "in ACL modifier \"set %s\"", *endptr, s);
1010 return NULL;
1011 }
1012 endptr++;
47ca6d6c 1013 }
47ca6d6c 1014
38a0a95f 1015 cond->u.varname = string_copyn(s + 4, endptr - s - 4);
47ca6d6c 1016 s = endptr;
059ec3d9
PH
1017 while (isspace(*s)) s++;
1018 }
1019
1020 /* For "set", we are now positioned for the data. For the others, only
1021 "endpass" has no data */
1022
1023 if (c != ACLC_ENDPASS)
1024 {
1025 if (*s++ != '=')
1026 {
1027 *error = string_sprintf("\"=\" missing after ACL \"%s\" %s", name,
1028 cond_modifiers[c]? US"modifier" : US"condition");
1029 return NULL;
1030 }
1031 while (isspace(*s)) s++;
1032 cond->arg = string_copy(s);
1033 }
1034 }
1035
1036return yield;
1037}
1038
1039
1040
1041/*************************************************
71fafd95
PH
1042* Set up added header line(s) *
1043*************************************************/
1044
1045/* This function is called by the add_header modifier, and also from acl_warn()
1046to implement the now-deprecated way of adding header lines using "message" on a
1047"warn" verb. The argument is treated as a sequence of header lines which are
1048added to a chain, provided there isn't an identical one already there.
1049
1050Argument: string of header lines
1051Returns: nothing
1052*/
1053
1054static void
55414b25 1055setup_header(const uschar *hstring)
71fafd95 1056{
55414b25 1057const uschar *p, *q;
71fafd95
PH
1058int hlen = Ustrlen(hstring);
1059
b1b05573
JH
1060/* Ignore any leading newlines */
1061while (*hstring == '\n') hstring++, hlen--;
71fafd95 1062
b1b05573 1063/* An empty string does nothing; ensure exactly one final newline. */
71fafd95 1064if (hlen <= 0) return;
96f5fe4c 1065if (hstring[--hlen] != '\n') /* no newline */
55414b25 1066 q = string_sprintf("%s\n", hstring);
96f5fe4c 1067else if (hstring[hlen-1] == '\n') /* double newline */
55414b25
JH
1068 {
1069 uschar * s = string_copy(hstring);
1070 while(s[--hlen] == '\n')
1071 s[hlen+1] = '\0';
1072 q = s;
1073 }
1074else
1075 q = hstring;
71fafd95
PH
1076
1077/* Loop for multiple header lines, taking care about continuations */
1078
55414b25 1079for (p = q; *p != 0; )
71fafd95 1080 {
55414b25
JH
1081 const uschar *s;
1082 uschar * hdr;
71fafd95
PH
1083 int newtype = htype_add_bot;
1084 header_line **hptr = &acl_added_headers;
1085
1086 /* Find next header line within the string */
1087
1088 for (;;)
1089 {
96f5fe4c 1090 q = Ustrchr(q, '\n'); /* we know there was a newline */
71fafd95
PH
1091 if (*(++q) != ' ' && *q != '\t') break;
1092 }
1093
1094 /* If the line starts with a colon, interpret the instruction for where to
1095 add it. This temporarily sets up a new type. */
1096
1097 if (*p == ':')
1098 {
1099 if (strncmpic(p, US":after_received:", 16) == 0)
1100 {
1101 newtype = htype_add_rec;
1102 p += 16;
1103 }
1104 else if (strncmpic(p, US":at_start_rfc:", 14) == 0)
1105 {
1106 newtype = htype_add_rfc;
1107 p += 14;
1108 }
1109 else if (strncmpic(p, US":at_start:", 10) == 0)
1110 {
1111 newtype = htype_add_top;
1112 p += 10;
1113 }
1114 else if (strncmpic(p, US":at_end:", 8) == 0)
1115 {
1116 newtype = htype_add_bot;
1117 p += 8;
1118 }
1119 while (*p == ' ' || *p == '\t') p++;
1120 }
1121
1122 /* See if this line starts with a header name, and if not, add X-ACL-Warn:
1123 to the front of it. */
1124
1125 for (s = p; s < q - 1; s++)
1126 {
1127 if (*s == ':' || !isgraph(*s)) break;
1128 }
1129
55414b25
JH
1130 hdr = string_sprintf("%s%.*s", (*s == ':')? "" : "X-ACL-Warn: ", (int) (q - p), p);
1131 hlen = Ustrlen(hdr);
71fafd95
PH
1132
1133 /* See if this line has already been added */
1134
1135 while (*hptr != NULL)
1136 {
55414b25 1137 if (Ustrncmp((*hptr)->text, hdr, hlen) == 0) break;
71fafd95
PH
1138 hptr = &((*hptr)->next);
1139 }
1140
1141 /* Add if not previously present */
1142
1143 if (*hptr == NULL)
1144 {
1145 header_line *h = store_get(sizeof(header_line));
55414b25 1146 h->text = hdr;
71fafd95
PH
1147 h->next = NULL;
1148 h->type = newtype;
1149 h->slen = hlen;
1150 *hptr = h;
1151 hptr = &(h->next);
1152 }
1153
1154 /* Advance for next header line within the string */
1155
1156 p = q;
1157 }
1158}
1159
1160
1161
e7568d51 1162/*************************************************
362145b5
JH
1163* List the added header lines *
1164*************************************************/
1165uschar *
1166fn_hdrs_added(void)
1167{
1168uschar * ret = NULL;
5f5be492
JH
1169int size = 0;
1170int ptr = 0;
362145b5
JH
1171header_line * h = acl_added_headers;
1172uschar * s;
1173uschar * cp;
362145b5
JH
1174
1175if (!h) return NULL;
1176
1177do
1178 {
1179 s = h->text;
1180 while ((cp = Ustrchr(s, '\n')) != NULL)
1181 {
1182 if (cp[1] == '\0') break;
1183
1184 /* contains embedded newline; needs doubling */
c2f669a4
JH
1185 ret = string_catn(ret, &size, &ptr, s, cp-s+1);
1186 ret = string_catn(ret, &size, &ptr, US"\n", 1);
362145b5
JH
1187 s = cp+1;
1188 }
1189 /* last bit of header */
1190
c2f669a4 1191 ret = string_catn(ret, &size, &ptr, s, cp-s+1); /* newline-sep list */
362145b5 1192 }
6d9cfc47 1193while((h = h->next));
362145b5
JH
1194
1195ret[ptr-1] = '\0'; /* overwrite last newline */
1196return ret;
1197}
1198
1199
1200/*************************************************
e7568d51
TL
1201* Set up removed header line(s) *
1202*************************************************/
1203
1204/* This function is called by the remove_header modifier. The argument is
1205treated as a sequence of header names which are added to a colon separated
1206list, provided there isn't an identical one already there.
1207
1208Argument: string of header names
1209Returns: nothing
1210*/
1211
1212static void
55414b25 1213setup_remove_header(const uschar *hnames)
e7568d51
TL
1214{
1215if (*hnames != 0)
55414b25
JH
1216 acl_removed_headers = acl_removed_headers
1217 ? string_sprintf("%s : %s", acl_removed_headers, hnames)
1218 : string_copy(hnames);
e7568d51
TL
1219}
1220
1221
71fafd95
PH
1222
1223/*************************************************
059ec3d9
PH
1224* Handle warnings *
1225*************************************************/
1226
1227/* This function is called when a WARN verb's conditions are true. It adds to
1228the message's headers, and/or writes information to the log. In each case, this
1229only happens once (per message for headers, per connection for log).
1230
71fafd95
PH
1231** NOTE: The header adding action using the "message" setting is historic, and
1232its use is now deprecated. The new add_header modifier should be used instead.
1233
059ec3d9
PH
1234Arguments:
1235 where ACL_WHERE_xxxx indicating which ACL this is
1236 user_message message for adding to headers
1237 log_message message for logging, if different
1238
1239Returns: nothing
1240*/
1241
1242static void
1243acl_warn(int where, uschar *user_message, uschar *log_message)
1244{
059ec3d9
PH
1245if (log_message != NULL && log_message != user_message)
1246 {
1247 uschar *text;
1248 string_item *logged;
1249
1250 text = string_sprintf("%s Warning: %s", host_and_ident(TRUE),
1251 string_printing(log_message));
1252
1253 /* If a sender verification has failed, and the log message is "sender verify
1254 failed", add the failure message. */
1255
1256 if (sender_verified_failed != NULL &&
1257 sender_verified_failed->message != NULL &&
1258 strcmpic(log_message, US"sender verify failed") == 0)
1259 text = string_sprintf("%s: %s", text, sender_verified_failed->message);
1260
9c7a242c
PH
1261 /* Search previously logged warnings. They are kept in malloc
1262 store so they can be freed at the start of a new message. */
059ec3d9
PH
1263
1264 for (logged = acl_warn_logged; logged != NULL; logged = logged->next)
1265 if (Ustrcmp(logged->text, text) == 0) break;
1266
1267 if (logged == NULL)
1268 {
1269 int length = Ustrlen(text) + 1;
1270 log_write(0, LOG_MAIN, "%s", text);
1271 logged = store_malloc(sizeof(string_item) + length);
1272 logged->text = (uschar *)logged + sizeof(string_item);
1273 memcpy(logged->text, text, length);
1274 logged->next = acl_warn_logged;
1275 acl_warn_logged = logged;
1276 }
1277 }
1278
1279/* If there's no user message, we are done. */
1280
1281if (user_message == NULL) return;
1282
1283/* If this isn't a message ACL, we can't do anything with a user message.
1284Log an error. */
1285
1286if (where > ACL_WHERE_NOTSMTP)
1287 {
1288 log_write(0, LOG_MAIN|LOG_PANIC, "ACL \"warn\" with \"message\" setting "
1289 "found in a non-message (%s) ACL: cannot specify header lines here: "
1290 "message ignored", acl_wherenames[where]);
1291 return;
1292 }
1293
71fafd95
PH
1294/* The code for setting up header lines is now abstracted into a separate
1295function so that it can be used for the add_header modifier as well. */
059ec3d9 1296
71fafd95 1297setup_header(user_message);
059ec3d9
PH
1298}
1299
1300
1301
1302/*************************************************
1303* Verify and check reverse DNS *
1304*************************************************/
1305
1306/* Called from acl_verify() below. We look up the host name(s) of the client IP
1307address if this has not yet been done. The host_name_lookup() function checks
1308that one of these names resolves to an address list that contains the client IP
1309address, so we don't actually have to do the check here.
1310
1311Arguments:
1312 user_msgptr pointer for user message
1313 log_msgptr pointer for log message
1314
1315Returns: OK verification condition succeeded
1316 FAIL verification failed
1317 DEFER there was a problem verifying
1318*/
1319
1320static int
1321acl_verify_reverse(uschar **user_msgptr, uschar **log_msgptr)
1322{
1323int rc;
1324
1325user_msgptr = user_msgptr; /* stop compiler warning */
1326
1327/* Previous success */
1328
1329if (sender_host_name != NULL) return OK;
1330
1331/* Previous failure */
1332
1333if (host_lookup_failed)
1334 {
1335 *log_msgptr = string_sprintf("host lookup failed%s", host_lookup_msg);
1336 return FAIL;
1337 }
1338
1339/* Need to do a lookup */
1340
1341HDEBUG(D_acl)
1342 debug_printf("looking up host name to force name/address consistency check\n");
1343
1344if ((rc = host_name_lookup()) != OK)
1345 {
1346 *log_msgptr = (rc == DEFER)?
1347 US"host lookup deferred for reverse lookup check"
1348 :
1349 string_sprintf("host lookup failed for reverse lookup check%s",
1350 host_lookup_msg);
1351 return rc; /* DEFER or FAIL */
1352 }
1353
1354host_build_sender_fullhost();
1355return OK;
1356}
1357
1358
1359
1360/*************************************************
e5a9dba6
PH
1361* Check client IP address matches CSA target *
1362*************************************************/
1363
1364/* Called from acl_verify_csa() below. This routine scans a section of a DNS
1365response for address records belonging to the CSA target hostname. The section
1366is specified by the reset argument, either RESET_ADDITIONAL or RESET_ANSWERS.
1367If one of the addresses matches the client's IP address, then the client is
1368authorized by CSA. If there are target IP addresses but none of them match
1369then the client is using an unauthorized IP address. If there are no target IP
1370addresses then the client cannot be using an authorized IP address. (This is
1371an odd configuration - why didn't the SRV record have a weight of 1 instead?)
1372
1373Arguments:
1374 dnsa the DNS answer block
1375 dnss a DNS scan block for us to use
1376 reset option specifing what portion to scan, as described above
1377 target the target hostname to use for matching RR names
1378
1379Returns: CSA_OK successfully authorized
1380 CSA_FAIL_MISMATCH addresses found but none matched
1381 CSA_FAIL_NOADDR no target addresses found
1382*/
1383
1384static int
1385acl_verify_csa_address(dns_answer *dnsa, dns_scan *dnss, int reset,
1386 uschar *target)
1387{
1388dns_record *rr;
1389dns_address *da;
1390
1391BOOL target_found = FALSE;
1392
1393for (rr = dns_next_rr(dnsa, dnss, reset);
1394 rr != NULL;
1395 rr = dns_next_rr(dnsa, dnss, RESET_NEXT))
1396 {
1397 /* Check this is an address RR for the target hostname. */
1398
1399 if (rr->type != T_A
1400 #if HAVE_IPV6
1401 && rr->type != T_AAAA
e5a9dba6
PH
1402 #endif
1403 ) continue;
1404
1405 if (strcmpic(target, rr->name) != 0) continue;
1406
1407 target_found = TRUE;
1408
1409 /* Turn the target address RR into a list of textual IP addresses and scan
1410 the list. There may be more than one if it is an A6 RR. */
1411
1412 for (da = dns_address_from_rr(dnsa, rr); da != NULL; da = da->next)
1413 {
1414 /* If the client IP address matches the target IP address, it's good! */
1415
1416 DEBUG(D_acl) debug_printf("CSA target address is %s\n", da->address);
1417
1418 if (strcmpic(sender_host_address, da->address) == 0) return CSA_OK;
1419 }
1420 }
1421
1422/* If we found some target addresses but none of them matched, the client is
1423using an unauthorized IP address, otherwise the target has no authorized IP
1424addresses. */
1425
1426if (target_found) return CSA_FAIL_MISMATCH;
1427else return CSA_FAIL_NOADDR;
1428}
1429
1430
1431
1432/*************************************************
1433* Verify Client SMTP Authorization *
1434*************************************************/
1435
1436/* Called from acl_verify() below. This routine calls dns_lookup_special()
1437to find the CSA SRV record corresponding to the domain argument, or
1438$sender_helo_name if no argument is provided. It then checks that the
1439client is authorized, and that its IP address corresponds to the SRV
1440target's address by calling acl_verify_csa_address() above. The address
1441should have been returned in the DNS response's ADDITIONAL section, but if
1442not we perform another DNS lookup to get it.
1443
1444Arguments:
1445 domain pointer to optional parameter following verify = csa
1446
1447Returns: CSA_UNKNOWN no valid CSA record found
1448 CSA_OK successfully authorized
1449 CSA_FAIL_* client is definitely not authorized
1450 CSA_DEFER_* there was a DNS problem
1451*/
1452
1453static int
55414b25 1454acl_verify_csa(const uschar *domain)
e5a9dba6
PH
1455{
1456tree_node *t;
55414b25
JH
1457const uschar *found;
1458uschar *p;
e5a9dba6
PH
1459int priority, weight, port;
1460dns_answer dnsa;
1461dns_scan dnss;
1462dns_record *rr;
1463int rc, type;
1464uschar target[256];
1465
1466/* Work out the domain we are using for the CSA lookup. The default is the
1467client's HELO domain. If the client has not said HELO, use its IP address
1468instead. If it's a local client (exim -bs), CSA isn't applicable. */
1469
1470while (isspace(*domain) && *domain != '\0') ++domain;
1471if (*domain == '\0') domain = sender_helo_name;
1472if (domain == NULL) domain = sender_host_address;
1473if (sender_host_address == NULL) return CSA_UNKNOWN;
1474
1475/* If we have an address literal, strip off the framing ready for turning it
1476into a domain. The framing consists of matched square brackets possibly
1477containing a keyword and a colon before the actual IP address. */
1478
1479if (domain[0] == '[')
1480 {
55414b25 1481 const uschar *start = Ustrchr(domain, ':');
e5a9dba6
PH
1482 if (start == NULL) start = domain;
1483 domain = string_copyn(start + 1, Ustrlen(start) - 2);
1484 }
1485
1486/* Turn domains that look like bare IP addresses into domains in the reverse
1487DNS. This code also deals with address literals and $sender_host_address. It's
1488not quite kosher to treat bare domains such as EHLO 192.0.2.57 the same as
1489address literals, but it's probably the most friendly thing to do. This is an
1490extension to CSA, so we allow it to be turned off for proper conformance. */
1491
7e66e54d 1492if (string_is_ip_address(domain, NULL) != 0)
e5a9dba6
PH
1493 {
1494 if (!dns_csa_use_reverse) return CSA_UNKNOWN;
1495 dns_build_reverse(domain, target);
1496 domain = target;
1497 }
1498
1499/* Find out if we've already done the CSA check for this domain. If we have,
1500return the same result again. Otherwise build a new cached result structure
1501for this domain. The name is filled in now, and the value is filled in when
1502we return from this function. */
1503
1504t = tree_search(csa_cache, domain);
1505if (t != NULL) return t->data.val;
1506
1507t = store_get_perm(sizeof(tree_node) + Ustrlen(domain));
1508Ustrcpy(t->name, domain);
1509(void)tree_insertnode(&csa_cache, t);
1510
1511/* Now we are ready to do the actual DNS lookup(s). */
1512
28e6ef29 1513found = domain;
e5a9dba6
PH
1514switch (dns_special_lookup(&dnsa, domain, T_CSA, &found))
1515 {
1516 /* If something bad happened (most commonly DNS_AGAIN), defer. */
1517
1518 default:
1519 return t->data.val = CSA_DEFER_SRV;
1520
1521 /* If we found nothing, the client's authorization is unknown. */
1522
1523 case DNS_NOMATCH:
1524 case DNS_NODATA:
1525 return t->data.val = CSA_UNKNOWN;
1526
1527 /* We got something! Go on to look at the reply in more detail. */
1528
1529 case DNS_SUCCEED:
1530 break;
1531 }
1532
1533/* Scan the reply for well-formed CSA SRV records. */
1534
1535for (rr = dns_next_rr(&dnsa, &dnss, RESET_ANSWERS);
1536 rr != NULL;
1537 rr = dns_next_rr(&dnsa, &dnss, RESET_NEXT))
1538 {
1539 if (rr->type != T_SRV) continue;
1540
1541 /* Extract the numerical SRV fields (p is incremented) */
1542
1543 p = rr->data;
1544 GETSHORT(priority, p);
1545 GETSHORT(weight, p);
1546 GETSHORT(port, p);
1547
1548 DEBUG(D_acl)
1549 debug_printf("CSA priority=%d weight=%d port=%d\n", priority, weight, port);
1550
1551 /* Check the CSA version number */
1552
1553 if (priority != 1) continue;
1554
1555 /* If the domain does not have a CSA SRV record of its own (i.e. the domain
1556 found by dns_special_lookup() is a parent of the one we asked for), we check
1557 the subdomain assertions in the port field. At the moment there's only one
1558 assertion: legitimate SMTP clients are all explicitly authorized with CSA
1559 SRV records of their own. */
1560
1dc92d5a 1561 if (Ustrcmp(found, domain) != 0)
e5a9dba6
PH
1562 {
1563 if (port & 1)
1564 return t->data.val = CSA_FAIL_EXPLICIT;
1565 else
1566 return t->data.val = CSA_UNKNOWN;
1567 }
1568
1569 /* This CSA SRV record refers directly to our domain, so we check the value
1570 in the weight field to work out the domain's authorization. 0 and 1 are
1571 unauthorized; 3 means the client is authorized but we can't check the IP
1572 address in order to authenticate it, so we treat it as unknown; values
1573 greater than 3 are undefined. */
1574
1575 if (weight < 2) return t->data.val = CSA_FAIL_DOMAIN;
1576
1577 if (weight > 2) continue;
1578
1579 /* Weight == 2, which means the domain is authorized. We must check that the
1580 client's IP address is listed as one of the SRV target addresses. Save the
1581 target hostname then break to scan the additional data for its addresses. */
1582
1583 (void)dn_expand(dnsa.answer, dnsa.answer + dnsa.answerlen, p,
1584 (DN_EXPAND_ARG4_TYPE)target, sizeof(target));
1585
1586 DEBUG(D_acl) debug_printf("CSA target is %s\n", target);
1587
1588 break;
1589 }
1590
1591/* If we didn't break the loop then no appropriate records were found. */
1592
1593if (rr == NULL) return t->data.val = CSA_UNKNOWN;
1594
1595/* Do not check addresses if the target is ".", in accordance with RFC 2782.
1596A target of "." indicates there are no valid addresses, so the client cannot
1597be authorized. (This is an odd configuration because weight=2 target=. is
1598equivalent to weight=1, but we check for it in order to keep load off the
1599root name servers.) Note that dn_expand() turns "." into "". */
1600
1601if (Ustrcmp(target, "") == 0) return t->data.val = CSA_FAIL_NOADDR;
1602
1603/* Scan the additional section of the CSA SRV reply for addresses belonging
1604to the target. If the name server didn't return any additional data (e.g.
1605because it does not fully support SRV records), we need to do another lookup
1606to obtain the target addresses; otherwise we have a definitive result. */
1607
1608rc = acl_verify_csa_address(&dnsa, &dnss, RESET_ADDITIONAL, target);
1609if (rc != CSA_FAIL_NOADDR) return t->data.val = rc;
1610
1611/* The DNS lookup type corresponds to the IP version used by the client. */
1612
1613#if HAVE_IPV6
1614if (Ustrchr(sender_host_address, ':') != NULL)
1615 type = T_AAAA;
1616else
1617#endif /* HAVE_IPV6 */
1618 type = T_A;
1619
1620
4e0983dc 1621lookup_dnssec_authenticated = NULL;
e5a9dba6
PH
1622switch (dns_lookup(&dnsa, target, type, NULL))
1623 {
1624 /* If something bad happened (most commonly DNS_AGAIN), defer. */
1625
1626 default:
cc00f4af 1627 return t->data.val = CSA_DEFER_ADDR;
e5a9dba6
PH
1628
1629 /* If the query succeeded, scan the addresses and return the result. */
1630
1631 case DNS_SUCCEED:
cc00f4af
JH
1632 rc = acl_verify_csa_address(&dnsa, &dnss, RESET_ANSWERS, target);
1633 if (rc != CSA_FAIL_NOADDR) return t->data.val = rc;
1634 /* else fall through */
e5a9dba6
PH
1635
1636 /* If the target has no IP addresses, the client cannot have an authorized
1637 IP address. However, if the target site uses A6 records (not AAAA records)
1638 we have to do yet another lookup in order to check them. */
1639
1640 case DNS_NOMATCH:
1641 case DNS_NODATA:
cc00f4af 1642 return t->data.val = CSA_FAIL_NOADDR;
e5a9dba6
PH
1643 }
1644}
1645
1646
1647
1648/*************************************************
059ec3d9
PH
1649* Handle verification (address & other) *
1650*************************************************/
1651
89583014 1652enum { VERIFY_REV_HOST_LKUP, VERIFY_CERT, VERIFY_HELO, VERIFY_CSA, VERIFY_HDR_SYNTAX,
770747fd
MFM
1653 VERIFY_NOT_BLIND, VERIFY_HDR_SNDR, VERIFY_SNDR, VERIFY_RCPT,
1654 VERIFY_HDR_NAMES_ASCII
89583014
JH
1655 };
1656typedef struct {
1657 uschar * name;
1658 int value;
1659 unsigned where_allowed; /* bitmap */
1660 BOOL no_options; /* Never has /option(s) following */
1661 unsigned alt_opt_sep; /* >0 Non-/ option separator (custom parser) */
1662 } verify_type_t;
1663static verify_type_t verify_type_list[] = {
7e8360e6 1664 { US"reverse_host_lookup", VERIFY_REV_HOST_LKUP, ~0, FALSE, 0 },
89583014
JH
1665 { US"certificate", VERIFY_CERT, ~0, TRUE, 0 },
1666 { US"helo", VERIFY_HELO, ~0, TRUE, 0 },
1667 { US"csa", VERIFY_CSA, ~0, FALSE, 0 },
1668 { US"header_syntax", VERIFY_HDR_SYNTAX, (1<<ACL_WHERE_DATA)|(1<<ACL_WHERE_NOTSMTP), TRUE, 0 },
1669 { US"not_blind", VERIFY_NOT_BLIND, (1<<ACL_WHERE_DATA)|(1<<ACL_WHERE_NOTSMTP), TRUE, 0 },
1670 { US"header_sender", VERIFY_HDR_SNDR, (1<<ACL_WHERE_DATA)|(1<<ACL_WHERE_NOTSMTP), FALSE, 0 },
1671 { US"sender", VERIFY_SNDR, (1<<ACL_WHERE_MAIL)|(1<<ACL_WHERE_RCPT)
1672 |(1<<ACL_WHERE_PREDATA)|(1<<ACL_WHERE_DATA)|(1<<ACL_WHERE_NOTSMTP),
1673 FALSE, 6 },
770747fd
MFM
1674 { US"recipient", VERIFY_RCPT, (1<<ACL_WHERE_RCPT), FALSE, 0 },
1675 { US"header_names_ascii", VERIFY_HDR_NAMES_ASCII, (1<<ACL_WHERE_DATA)|(1<<ACL_WHERE_NOTSMTP), TRUE, 0 }
89583014
JH
1676 };
1677
1678
1679enum { CALLOUT_DEFER_OK, CALLOUT_NOCACHE, CALLOUT_RANDOM, CALLOUT_USE_SENDER,
1680 CALLOUT_USE_POSTMASTER, CALLOUT_POSTMASTER, CALLOUT_FULLPOSTMASTER,
1681 CALLOUT_MAILFROM, CALLOUT_POSTMASTER_MAILFROM, CALLOUT_MAXWAIT, CALLOUT_CONNECT,
1682 CALLOUT_TIME
1683 };
1684typedef struct {
1685 uschar * name;
1686 int value;
1687 int flag;
1688 BOOL has_option; /* Has =option(s) following */
1689 BOOL timeval; /* Has a time value */
1690 } callout_opt_t;
1691static callout_opt_t callout_opt_list[] = {
1692 { US"defer_ok", CALLOUT_DEFER_OK, 0, FALSE, FALSE },
1693 { US"no_cache", CALLOUT_NOCACHE, vopt_callout_no_cache, FALSE, FALSE },
1694 { US"random", CALLOUT_RANDOM, vopt_callout_random, FALSE, FALSE },
1695 { US"use_sender", CALLOUT_USE_SENDER, vopt_callout_recipsender, FALSE, FALSE },
1696 { US"use_postmaster", CALLOUT_USE_POSTMASTER,vopt_callout_recippmaster, FALSE, FALSE },
1697 { US"postmaster_mailfrom",CALLOUT_POSTMASTER_MAILFROM,0, TRUE, FALSE },
1698 { US"postmaster", CALLOUT_POSTMASTER, 0, FALSE, FALSE },
1699 { US"fullpostmaster", CALLOUT_FULLPOSTMASTER,vopt_callout_fullpm, FALSE, FALSE },
1700 { US"mailfrom", CALLOUT_MAILFROM, 0, TRUE, FALSE },
1701 { US"maxwait", CALLOUT_MAXWAIT, 0, TRUE, TRUE },
1702 { US"connect", CALLOUT_CONNECT, 0, TRUE, TRUE },
1703 { NULL, CALLOUT_TIME, 0, FALSE, TRUE }
1704 };
1705
1706
1707
059ec3d9
PH
1708/* This function implements the "verify" condition. It is called when
1709encountered in any ACL, because some tests are almost always permitted. Some
1710just don't make sense, and always fail (for example, an attempt to test a host
1711lookup for a non-TCP/IP message). Others are restricted to certain ACLs.
1712
1713Arguments:
1714 where where called from
1715 addr the recipient address that the ACL is handling, or NULL
1716 arg the argument of "verify"
1717 user_msgptr pointer for user message
1718 log_msgptr pointer for log message
1719 basic_errno where to put verify errno
1720
1721Returns: OK verification condition succeeded
1722 FAIL verification failed
1723 DEFER there was a problem verifying
1724 ERROR syntax error
1725*/
1726
1727static int
55414b25 1728acl_verify(int where, address_item *addr, const uschar *arg,
059ec3d9
PH
1729 uschar **user_msgptr, uschar **log_msgptr, int *basic_errno)
1730{
1731int sep = '/';
1732int callout = -1;
1733int callout_overall = -1;
4deaf07d 1734int callout_connect = -1;
059ec3d9
PH
1735int verify_options = 0;
1736int rc;
1737BOOL verify_header_sender = FALSE;
1738BOOL defer_ok = FALSE;
1739BOOL callout_defer_ok = FALSE;
1740BOOL no_details = FALSE;
eafd343b 1741BOOL success_on_redirect = FALSE;
059ec3d9
PH
1742address_item *sender_vaddr = NULL;
1743uschar *verify_sender_address = NULL;
1744uschar *pm_mailfrom = NULL;
1745uschar *se_mailfrom = NULL;
596875b3
PH
1746
1747/* Some of the verify items have slash-separated options; some do not. Diagnose
89583014 1748an error if options are given for items that don't expect them.
596875b3
PH
1749*/
1750
1751uschar *slash = Ustrchr(arg, '/');
55414b25 1752const uschar *list = arg;
059ec3d9 1753uschar *ss = string_nextinlist(&list, &sep, big_buffer, big_buffer_size);
89583014 1754verify_type_t * vp;
059ec3d9
PH
1755
1756if (ss == NULL) goto BAD_VERIFY;
1757
1758/* Handle name/address consistency verification in a separate function. */
1759
89583014
JH
1760for (vp= verify_type_list;
1761 (char *)vp < (char *)verify_type_list + sizeof(verify_type_list);
1762 vp++
1763 )
1764 if (vp->alt_opt_sep ? strncmpic(ss, vp->name, vp->alt_opt_sep) == 0
1765 : strcmpic (ss, vp->name) == 0)
1766 break;
1767if ((char *)vp >= (char *)verify_type_list + sizeof(verify_type_list))
1768 goto BAD_VERIFY;
1769
1770if (vp->no_options && slash != NULL)
059ec3d9 1771 {
89583014
JH
1772 *log_msgptr = string_sprintf("unexpected '/' found in \"%s\" "
1773 "(this verify item has no options)", arg);
1774 return ERROR;
059ec3d9 1775 }
89583014 1776if (!(vp->where_allowed & (1<<where)))
059ec3d9 1777 {
89583014
JH
1778 *log_msgptr = string_sprintf("cannot verify %s in ACL for %s", vp->name, acl_wherenames[where]);
1779 return ERROR;
059ec3d9 1780 }
89583014 1781switch(vp->value)
596875b3 1782 {
89583014
JH
1783 case VERIFY_REV_HOST_LKUP:
1784 if (sender_host_address == NULL) return OK;
7e8360e6
JH
1785 if ((rc = acl_verify_reverse(user_msgptr, log_msgptr)) == DEFER)
1786 while ((ss = string_nextinlist(&list, &sep, big_buffer, big_buffer_size)))
1787 if (strcmpic(ss, US"defer_ok") == 0)
1788 return OK;
1789 return rc;
059ec3d9 1790
89583014
JH
1791 case VERIFY_CERT:
1792 /* TLS certificate verification is done at STARTTLS time; here we just
1793 test whether it was successful or not. (This is for optional verification; for
1794 mandatory verification, the connection doesn't last this long.) */
e5a9dba6 1795
3703d818
JH
1796 if (tls_in.certificate_verified) return OK;
1797 *user_msgptr = US"no verified certificate";
1798 return FAIL;
e5a9dba6 1799
89583014
JH
1800 case VERIFY_HELO:
1801 /* We can test the result of optional HELO verification that might have
1802 occurred earlier. If not, we can attempt the verification now. */
059ec3d9 1803
3703d818
JH
1804 if (!helo_verified && !helo_verify_failed) smtp_verify_helo();
1805 return helo_verified? OK : FAIL;
059ec3d9 1806
89583014
JH
1807 case VERIFY_CSA:
1808 /* Do Client SMTP Authorization checks in a separate function, and turn the
1809 result code into user-friendly strings. */
1c41c9cc 1810
3703d818
JH
1811 rc = acl_verify_csa(list);
1812 *log_msgptr = *user_msgptr = string_sprintf("client SMTP authorization %s",
89583014 1813 csa_reason_string[rc]);
3703d818
JH
1814 csa_status = csa_status_string[rc];
1815 DEBUG(D_acl) debug_printf("CSA result %s\n", csa_status);
1816 return csa_return_code[rc];
89583014
JH
1817
1818 case VERIFY_HDR_SYNTAX:
1819 /* Check that all relevant header lines have the correct syntax. If there is
1820 a syntax error, we return details of the error to the sender if configured to
1821 send out full details. (But a "message" setting on the ACL can override, as
1822 always). */
1823
1824 rc = verify_check_headers(log_msgptr);
3703d818
JH
1825 if (rc != OK && *log_msgptr)
1826 if (smtp_return_error_details)
1827 *user_msgptr = string_sprintf("Rejected after DATA: %s", *log_msgptr);
1828 else
1829 acl_verify_message = *log_msgptr;
89583014 1830 return rc;
059ec3d9 1831
770747fd
MFM
1832 case VERIFY_HDR_NAMES_ASCII:
1833 /* Check that all header names are true 7 bit strings
1834 See RFC 5322, 2.2. and RFC 6532, 3. */
1835
1836 rc = verify_check_header_names_ascii(log_msgptr);
1837 if (rc != OK && smtp_return_error_details && *log_msgptr != NULL)
1838 *user_msgptr = string_sprintf("Rejected after DATA: %s", *log_msgptr);
1839 return rc;
1840
89583014
JH
1841 case VERIFY_NOT_BLIND:
1842 /* Check that no recipient of this message is "blind", that is, every envelope
1843 recipient must be mentioned in either To: or Cc:. */
059ec3d9 1844
89583014
JH
1845 rc = verify_check_notblind();
1846 if (rc != OK)
1847 {
1848 *log_msgptr = string_sprintf("bcc recipient detected");
1849 if (smtp_return_error_details)
1850 *user_msgptr = string_sprintf("Rejected after DATA: %s", *log_msgptr);
1851 }
1852 return rc;
059ec3d9 1853
89583014
JH
1854 /* The remaining verification tests check recipient and sender addresses,
1855 either from the envelope or from the header. There are a number of
1856 slash-separated options that are common to all of them. */
059ec3d9 1857
89583014
JH
1858 case VERIFY_HDR_SNDR:
1859 verify_header_sender = TRUE;
1860 break;
059ec3d9 1861
89583014
JH
1862 case VERIFY_SNDR:
1863 /* In the case of a sender, this can optionally be followed by an address to use
1864 in place of the actual sender (rare special-case requirement). */
059ec3d9 1865 {
89583014
JH
1866 uschar *s = ss + 6;
1867 if (*s == 0)
1868 verify_sender_address = sender_address;
1869 else
1870 {
1871 while (isspace(*s)) s++;
1872 if (*s++ != '=') goto BAD_VERIFY;
1873 while (isspace(*s)) s++;
1874 verify_sender_address = string_copy(s);
1875 }
059ec3d9 1876 }
89583014
JH
1877 break;
1878
1879 case VERIFY_RCPT:
1880 break;
059ec3d9
PH
1881 }
1882
89583014
JH
1883
1884
596875b3
PH
1885/* Remaining items are optional; they apply to sender and recipient
1886verification, including "header sender" verification. */
059ec3d9
PH
1887
1888while ((ss = string_nextinlist(&list, &sep, big_buffer, big_buffer_size))
1889 != NULL)
1890 {
1891 if (strcmpic(ss, US"defer_ok") == 0) defer_ok = TRUE;
1892 else if (strcmpic(ss, US"no_details") == 0) no_details = TRUE;
eafd343b 1893 else if (strcmpic(ss, US"success_on_redirect") == 0) success_on_redirect = TRUE;
059ec3d9
PH
1894
1895 /* These two old options are left for backwards compatibility */
1896
1897 else if (strcmpic(ss, US"callout_defer_ok") == 0)
1898 {
1899 callout_defer_ok = TRUE;
1900 if (callout == -1) callout = CALLOUT_TIMEOUT_DEFAULT;
1901 }
1902
1903 else if (strcmpic(ss, US"check_postmaster") == 0)
1904 {
1905 pm_mailfrom = US"";
1906 if (callout == -1) callout = CALLOUT_TIMEOUT_DEFAULT;
1907 }
1908
1909 /* The callout option has a number of sub-options, comma separated */
1910
1911 else if (strncmpic(ss, US"callout", 7) == 0)
1912 {
1913 callout = CALLOUT_TIMEOUT_DEFAULT;
1914 ss += 7;
1915 if (*ss != 0)
1916 {
1917 while (isspace(*ss)) ss++;
1918 if (*ss++ == '=')
1919 {
55414b25 1920 const uschar * sublist = ss;
059ec3d9
PH
1921 int optsep = ',';
1922 uschar *opt;
1923 uschar buffer[256];
55414b25 1924 while (isspace(*sublist)) sublist++;
8e669ac1 1925
55414b25 1926 while ((opt = string_nextinlist(&sublist, &optsep, buffer, sizeof(buffer)))
059ec3d9
PH
1927 != NULL)
1928 {
89583014 1929 callout_opt_t * op;
438257ba 1930 double period = 1.0F;
059ec3d9 1931
89583014 1932 for (op= callout_opt_list; op->name; op++)
438257ba 1933 if (strncmpic(opt, op->name, Ustrlen(op->name)) == 0)
89583014 1934 break;
059ec3d9 1935
89583014
JH
1936 verify_options |= op->flag;
1937 if (op->has_option)
1938 {
438257ba 1939 opt += Ustrlen(op->name);
4deaf07d
PH
1940 while (isspace(*opt)) opt++;
1941 if (*opt++ != '=')
1942 {
1943 *log_msgptr = string_sprintf("'=' expected after "
89583014 1944 "\"%s\" in ACL verify condition \"%s\"", op->name, arg);
4deaf07d
PH
1945 return ERROR;
1946 }
1947 while (isspace(*opt)) opt++;
89583014
JH
1948 }
1949 if (op->timeval)
1950 {
1951 period = readconf_readtime(opt, 0, FALSE);
1952 if (period < 0)
4deaf07d
PH
1953 {
1954 *log_msgptr = string_sprintf("bad time value in ACL condition "
1955 "\"verify %s\"", arg);
1956 return ERROR;
1957 }
89583014
JH
1958 }
1959
1960 switch(op->value)
1961 {
1962 case CALLOUT_DEFER_OK: callout_defer_ok = TRUE; break;
1963 case CALLOUT_POSTMASTER: pm_mailfrom = US""; break;
1964 case CALLOUT_FULLPOSTMASTER: pm_mailfrom = US""; break;
1965 case CALLOUT_MAILFROM:
1966 if (!verify_header_sender)
1967 {
1968 *log_msgptr = string_sprintf("\"mailfrom\" is allowed as a "
1969 "callout option only for verify=header_sender (detected in ACL "
1970 "condition \"%s\")", arg);
1971 return ERROR;
1972 }
1973 se_mailfrom = string_copy(opt);
1974 break;
1975 case CALLOUT_POSTMASTER_MAILFROM: pm_mailfrom = string_copy(opt); break;
1976 case CALLOUT_MAXWAIT: callout_overall = period; break;
1977 case CALLOUT_CONNECT: callout_connect = period; break;
1978 case CALLOUT_TIME: callout = period; break;
1979 }
059ec3d9
PH
1980 }
1981 }
1982 else
1983 {
1984 *log_msgptr = string_sprintf("'=' expected after \"callout\" in "
1985 "ACL condition \"%s\"", arg);
1986 return ERROR;
1987 }
1988 }
1989 }
1990
1991 /* Option not recognized */
1992
1993 else
1994 {
1995 *log_msgptr = string_sprintf("unknown option \"%s\" in ACL "
1996 "condition \"verify %s\"", ss, arg);
1997 return ERROR;
1998 }
1999 }
2000
2001if ((verify_options & (vopt_callout_recipsender|vopt_callout_recippmaster)) ==
2002 (vopt_callout_recipsender|vopt_callout_recippmaster))
2003 {
2004 *log_msgptr = US"only one of use_sender and use_postmaster can be set "
2005 "for a recipient callout";
2006 return ERROR;
2007 }
2008
2009/* Handle sender-in-header verification. Default the user message to the log
2010message if giving out verification details. */
2011
2012if (verify_header_sender)
2013 {
8e669ac1 2014 int verrno;
059ec3d9 2015 rc = verify_check_header_address(user_msgptr, log_msgptr, callout,
fe5b5d0b
PH
2016 callout_overall, callout_connect, se_mailfrom, pm_mailfrom, verify_options,
2017 &verrno);
2018 if (rc != OK)
8e669ac1 2019 {
fe5b5d0b
PH
2020 *basic_errno = verrno;
2021 if (smtp_return_error_details)
2022 {
2023 if (*user_msgptr == NULL && *log_msgptr != NULL)
2024 *user_msgptr = string_sprintf("Rejected after DATA: %s", *log_msgptr);
2025 if (rc == DEFER) acl_temp_details = TRUE;
2026 }
8e669ac1 2027 }
059ec3d9
PH
2028 }
2029
2030/* Handle a sender address. The default is to verify *the* sender address, but
2031optionally a different address can be given, for special requirements. If the
2032address is empty, we are dealing with a bounce message that has no sender, so
2033we cannot do any checking. If the real sender address gets rewritten during
2034verification (e.g. DNS widening), set the flag to stop it being rewritten again
2035during message reception.
2036
2037A list of verified "sender" addresses is kept to try to avoid doing to much
2038work repetitively when there are multiple recipients in a message and they all
2039require sender verification. However, when callouts are involved, it gets too
2040complicated because different recipients may require different callout options.
2041Therefore, we always do a full sender verify when any kind of callout is
2042specified. Caching elsewhere, for instance in the DNS resolver and in the
2043callout handling, should ensure that this is not terribly inefficient. */
2044
2045else if (verify_sender_address != NULL)
2046 {
2047 if ((verify_options & (vopt_callout_recipsender|vopt_callout_recippmaster))
2048 != 0)
2049 {
2050 *log_msgptr = US"use_sender or use_postmaster cannot be used for a "
2051 "sender verify callout";
2052 return ERROR;
2053 }
2054
2055 sender_vaddr = verify_checked_sender(verify_sender_address);
2056 if (sender_vaddr != NULL && /* Previously checked */
2057 callout <= 0) /* No callout needed this time */
2058 {
2059 /* If the "routed" flag is set, it means that routing worked before, so
2060 this check can give OK (the saved return code value, if set, belongs to a
2061 callout that was done previously). If the "routed" flag is not set, routing
2062 must have failed, so we use the saved return code. */
2063
2064 if (testflag(sender_vaddr, af_verify_routed)) rc = OK; else
2065 {
2066 rc = sender_vaddr->special_action;
2067 *basic_errno = sender_vaddr->basic_errno;
2068 }
2069 HDEBUG(D_acl) debug_printf("using cached sender verify result\n");
2070 }
2071
2072 /* Do a new verification, and cache the result. The cache is used to avoid
2073 verifying the sender multiple times for multiple RCPTs when callouts are not
2074 specified (see comments above).
2075
2076 The cache is also used on failure to give details in response to the first
2077 RCPT that gets bounced for this reason. However, this can be suppressed by
2078 the no_details option, which sets the flag that says "this detail has already
2079 been sent". The cache normally contains just one address, but there may be
2080 more in esoteric circumstances. */
2081
2082 else
2083 {
2084 BOOL routed = TRUE;
2a3eea10 2085 uschar *save_address_data = deliver_address_data;
8e669ac1 2086
059ec3d9 2087 sender_vaddr = deliver_make_addr(verify_sender_address, TRUE);
8c5d388a 2088#ifdef SUPPORT_I18N
3c8b3577
JH
2089 if ((sender_vaddr->prop.utf8_msg = message_smtputf8))
2090 {
2091 sender_vaddr->prop.utf8_downcvt = message_utf8_downconvert == 1;
2092 sender_vaddr->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
2093 }
f358d5e0 2094#endif
059ec3d9
PH
2095 if (no_details) setflag(sender_vaddr, af_sverify_told);
2096 if (verify_sender_address[0] != 0)
2097 {
2098 /* If this is the real sender address, save the unrewritten version
2099 for use later in receive. Otherwise, set a flag so that rewriting the
2100 sender in verify_address() does not update sender_address. */
2101
2102 if (verify_sender_address == sender_address)
2103 sender_address_unrewritten = sender_address;
2104 else
2105 verify_options |= vopt_fake_sender;
2106
eafd343b
TK
2107 if (success_on_redirect)
2108 verify_options |= vopt_success_on_redirect;
2109
059ec3d9
PH
2110 /* The recipient, qualify, and expn options are never set in
2111 verify_options. */
2112
2113 rc = verify_address(sender_vaddr, NULL, verify_options, callout,
4deaf07d 2114 callout_overall, callout_connect, se_mailfrom, pm_mailfrom, &routed);
059ec3d9
PH
2115
2116 HDEBUG(D_acl) debug_printf("----------- end verify ------------\n");
2117
2118 if (rc == OK)
2119 {
2120 if (Ustrcmp(sender_vaddr->address, verify_sender_address) != 0)
2121 {
2122 DEBUG(D_acl) debug_printf("sender %s verified ok as %s\n",
2123 verify_sender_address, sender_vaddr->address);
2124 }
2125 else
2126 {
2127 DEBUG(D_acl) debug_printf("sender %s verified ok\n",
2128 verify_sender_address);
2129 }
2130 }
2131 else *basic_errno = sender_vaddr->basic_errno;
2132 }
2133 else rc = OK; /* Null sender */
2134
2135 /* Cache the result code */
2136
2137 if (routed) setflag(sender_vaddr, af_verify_routed);
2138 if (callout > 0) setflag(sender_vaddr, af_verify_callout);
2139 sender_vaddr->special_action = rc;
2140 sender_vaddr->next = sender_verified_list;
2141 sender_verified_list = sender_vaddr;
8e669ac1
PH
2142
2143 /* Restore the recipient address data, which might have been clobbered by
2a3eea10 2144 the sender verification. */
8e669ac1 2145
2a3eea10 2146 deliver_address_data = save_address_data;
059ec3d9 2147 }
8e669ac1 2148
2a3eea10
PH
2149 /* Put the sender address_data value into $sender_address_data */
2150
d43cbe25 2151 sender_address_data = sender_vaddr->prop.address_data;
059ec3d9
PH
2152 }
2153
2154/* A recipient address just gets a straightforward verify; again we must handle
2155the DEFER overrides. */
2156
2157else
2158 {
2159 address_item addr2;
2160
eafd343b
TK
2161 if (success_on_redirect)
2162 verify_options |= vopt_success_on_redirect;
2163
059ec3d9
PH
2164 /* We must use a copy of the address for verification, because it might
2165 get rewritten. */
2166
2167 addr2 = *addr;
2168 rc = verify_address(&addr2, NULL, verify_options|vopt_is_recipient, callout,
4deaf07d 2169 callout_overall, callout_connect, se_mailfrom, pm_mailfrom, NULL);
059ec3d9 2170 HDEBUG(D_acl) debug_printf("----------- end verify ------------\n");
8e669ac1 2171
42855d71 2172 *basic_errno = addr2.basic_errno;
059ec3d9 2173 *log_msgptr = addr2.message;
8e669ac1 2174 *user_msgptr = (addr2.user_message != NULL)?
6729cf78 2175 addr2.user_message : addr2.message;
42855d71
PH
2176
2177 /* Allow details for temporary error if the address is so flagged. */
2178 if (testflag((&addr2), af_pass_message)) acl_temp_details = TRUE;
059ec3d9
PH
2179
2180 /* Make $address_data visible */
d43cbe25 2181 deliver_address_data = addr2.prop.address_data;
059ec3d9
PH
2182 }
2183
2184/* We have a result from the relevant test. Handle defer overrides first. */
2185
2186if (rc == DEFER && (defer_ok ||
2187 (callout_defer_ok && *basic_errno == ERRNO_CALLOUTDEFER)))
2188 {
2189 HDEBUG(D_acl) debug_printf("verify defer overridden by %s\n",
2190 defer_ok? "defer_ok" : "callout_defer_ok");
2191 rc = OK;
2192 }
2193
2194/* If we've failed a sender, set up a recipient message, and point
2195sender_verified_failed to the address item that actually failed. */
2196
2197if (rc != OK && verify_sender_address != NULL)
2198 {
2199 if (rc != DEFER)
059ec3d9 2200 *log_msgptr = *user_msgptr = US"Sender verify failed";
059ec3d9 2201 else if (*basic_errno != ERRNO_CALLOUTDEFER)
059ec3d9 2202 *log_msgptr = *user_msgptr = US"Could not complete sender verify";
059ec3d9
PH
2203 else
2204 {
2205 *log_msgptr = US"Could not complete sender verify callout";
2206 *user_msgptr = smtp_return_error_details? sender_vaddr->user_message :
2207 *log_msgptr;
2208 }
2209
2210 sender_verified_failed = sender_vaddr;
2211 }
2212
2213/* Verifying an address messes up the values of $domain and $local_part,
2214so reset them before returning if this is a RCPT ACL. */
2215
2216if (addr != NULL)
2217 {
2218 deliver_domain = addr->domain;
2219 deliver_localpart = addr->local_part;
2220 }
2221return rc;
2222
2223/* Syntax errors in the verify argument come here. */
2224
2225BAD_VERIFY:
2226*log_msgptr = string_sprintf("expected \"sender[=address]\", \"recipient\", "
770747fd
MFM
2227 "\"helo\", \"header_syntax\", \"header_sender\", \"header_names_ascii\" "
2228 "or \"reverse_host_lookup\" at start of ACL condition "
059ec3d9
PH
2229 "\"verify %s\"", arg);
2230return ERROR;
2231}
2232
2233
2234
2235
2236/*************************************************
2237* Check argument for control= modifier *
2238*************************************************/
2239
2240/* Called from acl_check_condition() below
2241
2242Arguments:
2243 arg the argument string for control=
2244 pptr set to point to the terminating character
2245 where which ACL we are in
2246 log_msgptr for error messages
2247
2248Returns: CONTROL_xxx value
2249*/
2250
2251static int
55414b25 2252decode_control(const uschar *arg, const uschar **pptr, int where, uschar **log_msgptr)
059ec3d9
PH
2253{
2254int len;
2255control_def *d;
2256
2257for (d = controls_list;
2258 d < controls_list + sizeof(controls_list)/sizeof(control_def);
2259 d++)
2260 {
2261 len = Ustrlen(d->name);
2262 if (Ustrncmp(d->name, arg, len) == 0) break;
2263 }
2264
2265if (d >= controls_list + sizeof(controls_list)/sizeof(control_def) ||
2266 (arg[len] != 0 && (!d->has_option || arg[len] != '/')))
2267 {
2268 *log_msgptr = string_sprintf("syntax error in \"control=%s\"", arg);
2269 return CONTROL_ERROR;
2270 }
2271
059ec3d9
PH
2272*pptr = arg + len;
2273return d->value;
2274}
2275
2276
2277
c99ce5c9
TF
2278
2279/*************************************************
2280* Return a ratelimit error *
2281*************************************************/
2282
2283/* Called from acl_ratelimit() below
2284
2285Arguments:
2286 log_msgptr for error messages
2287 format format string
2288 ... supplementary arguments
2289 ss ratelimit option name
2290 where ACL_WHERE_xxxx indicating which ACL this is
2291
2292Returns: ERROR
2293*/
2294
2295static int
2296ratelimit_error(uschar **log_msgptr, const char *format, ...)
2297{
2298va_list ap;
2299uschar buffer[STRING_SPRINTF_BUFFER_SIZE];
2300va_start(ap, format);
2301if (!string_vformat(buffer, sizeof(buffer), format, ap))
2302 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
ef840681 2303 "string_sprintf expansion was longer than " SIZE_T_FMT, sizeof(buffer));
c99ce5c9
TF
2304va_end(ap);
2305*log_msgptr = string_sprintf(
2306 "error in arguments to \"ratelimit\" condition: %s", buffer);
2307return ERROR;
2308}
2309
2310
2311
2312
059ec3d9 2313/*************************************************
870f6ba8
TF
2314* Handle rate limiting *
2315*************************************************/
2316
2317/* Called by acl_check_condition() below to calculate the result
2318of the ACL ratelimit condition.
2319
2320Note that the return value might be slightly unexpected: if the
2321sender's rate is above the limit then the result is OK. This is
2322similar to the dnslists condition, and is so that you can write
2323ACL clauses like: defer ratelimit = 15 / 1h
2324
2325Arguments:
2326 arg the option string for ratelimit=
90fc3069 2327 where ACL_WHERE_xxxx indicating which ACL this is
870f6ba8
TF
2328 log_msgptr for error messages
2329
2330Returns: OK - Sender's rate is above limit
2331 FAIL - Sender's rate is below limit
2332 DEFER - Problem opening ratelimit database
2333 ERROR - Syntax error in options.
2334*/
2335
2336static int
55414b25 2337acl_ratelimit(const uschar *arg, int where, uschar **log_msgptr)
870f6ba8 2338{
c99ce5c9 2339double limit, period, count;
8f240103
PH
2340uschar *ss;
2341uschar *key = NULL;
c99ce5c9 2342uschar *unique = NULL;
870f6ba8 2343int sep = '/';
c99ce5c9
TF
2344BOOL leaky = FALSE, strict = FALSE, readonly = FALSE;
2345BOOL noupdate = FALSE, badacl = FALSE;
2346int mode = RATE_PER_WHAT;
870f6ba8
TF
2347int old_pool, rc;
2348tree_node **anchor, *t;
2349open_db dbblock, *dbm;
c99ce5c9 2350int dbdb_size;
870f6ba8 2351dbdata_ratelimit *dbd;
c99ce5c9 2352dbdata_ratelimit_unique *dbdb;
870f6ba8
TF
2353struct timeval tv;
2354
2355/* Parse the first two options and record their values in expansion
2356variables. These variables allow the configuration to have informative
2357error messages based on rate limits obtained from a table lookup. */
2358
c99ce5c9 2359/* First is the maximum number of messages per period / maximum burst
870f6ba8
TF
2360size, which must be greater than or equal to zero. Zero is useful for
2361rate measurement as opposed to rate limiting. */
2362
2363sender_rate_limit = string_nextinlist(&arg, &sep, NULL, 0);
2364if (sender_rate_limit == NULL)
96f5fe4c
JH
2365 return ratelimit_error(log_msgptr, "sender rate limit not set");
2366
2367limit = Ustrtod(sender_rate_limit, &ss);
2368if (tolower(*ss) == 'k') { limit *= 1024.0; ss++; }
2369else if (tolower(*ss) == 'm') { limit *= 1024.0*1024.0; ss++; }
2370else if (tolower(*ss) == 'g') { limit *= 1024.0*1024.0*1024.0; ss++; }
2371
c99ce5c9
TF
2372if (limit < 0.0 || *ss != '\0')
2373 return ratelimit_error(log_msgptr,
2374 "\"%s\" is not a positive number", sender_rate_limit);
870f6ba8 2375
c99ce5c9 2376/* Second is the rate measurement period / exponential smoothing time
870f6ba8
TF
2377constant. This must be strictly greater than zero, because zero leads to
2378run-time division errors. */
2379
2380sender_rate_period = string_nextinlist(&arg, &sep, NULL, 0);
2381if (sender_rate_period == NULL) period = -1.0;
2382else period = readconf_readtime(sender_rate_period, 0, FALSE);
2383if (period <= 0.0)
c99ce5c9
TF
2384 return ratelimit_error(log_msgptr,
2385 "\"%s\" is not a time value", sender_rate_period);
2386
2387/* By default we are counting one of something, but the per_rcpt,
2388per_byte, and count options can change this. */
2389
2390count = 1.0;
870f6ba8 2391
c99ce5c9 2392/* Parse the other options. */
870f6ba8
TF
2393
2394while ((ss = string_nextinlist(&arg, &sep, big_buffer, big_buffer_size))
2395 != NULL)
2396 {
2397 if (strcmpic(ss, US"leaky") == 0) leaky = TRUE;
2398 else if (strcmpic(ss, US"strict") == 0) strict = TRUE;
8f240103 2399 else if (strcmpic(ss, US"noupdate") == 0) noupdate = TRUE;
c99ce5c9
TF
2400 else if (strcmpic(ss, US"readonly") == 0) readonly = TRUE;
2401 else if (strcmpic(ss, US"per_cmd") == 0) RATE_SET(mode, PER_CMD);
2402 else if (strcmpic(ss, US"per_conn") == 0)
2403 {
2404 RATE_SET(mode, PER_CONN);
2405 if (where == ACL_WHERE_NOTSMTP || where == ACL_WHERE_NOTSMTP_START)
2406 badacl = TRUE;
2407 }
2408 else if (strcmpic(ss, US"per_mail") == 0)
2409 {
2410 RATE_SET(mode, PER_MAIL);
2411 if (where > ACL_WHERE_NOTSMTP) badacl = TRUE;
2412 }
2413 else if (strcmpic(ss, US"per_rcpt") == 0)
2414 {
2415 /* If we are running in the RCPT ACL, then we'll count the recipients
2416 one by one, but if we are running when we have accumulated the whole
2417 list then we'll add them all in one batch. */
2418 if (where == ACL_WHERE_RCPT)
2419 RATE_SET(mode, PER_RCPT);
2420 else if (where >= ACL_WHERE_PREDATA && where <= ACL_WHERE_NOTSMTP)
2421 RATE_SET(mode, PER_ALLRCPTS), count = (double)recipients_count;
2422 else if (where == ACL_WHERE_MAIL || where > ACL_WHERE_NOTSMTP)
2423 RATE_SET(mode, PER_RCPT), badacl = TRUE;
2424 }
2425 else if (strcmpic(ss, US"per_byte") == 0)
2426 {
2427 /* If we have not yet received the message data and there was no SIZE
2428 declaration on the MAIL comand, then it's safe to just use a value of
2429 zero and let the recorded rate decay as if nothing happened. */
2430 RATE_SET(mode, PER_MAIL);
2431 if (where > ACL_WHERE_NOTSMTP) badacl = TRUE;
2432 else count = message_size < 0 ? 0.0 : (double)message_size;
2433 }
2434 else if (strcmpic(ss, US"per_addr") == 0)
2435 {
2436 RATE_SET(mode, PER_RCPT);
438257ba 2437 if (where != ACL_WHERE_RCPT) badacl = TRUE, unique = US"*";
c99ce5c9
TF
2438 else unique = string_sprintf("%s@%s", deliver_localpart, deliver_domain);
2439 }
2440 else if (strncmpic(ss, US"count=", 6) == 0)
2441 {
2442 uschar *e;
2443 count = Ustrtod(ss+6, &e);
2444 if (count < 0.0 || *e != '\0')
2445 return ratelimit_error(log_msgptr,
2446 "\"%s\" is not a positive number", ss);
2447 }
2448 else if (strncmpic(ss, US"unique=", 7) == 0)
2449 unique = string_copy(ss + 7);
2450 else if (key == NULL)
2451 key = string_copy(ss);
2452 else
2453 key = string_sprintf("%s/%s", key, ss);
870f6ba8
TF
2454 }
2455
c99ce5c9
TF
2456/* Sanity check. When the badacl flag is set the update mode must either
2457be readonly (which is the default if it is omitted) or, for backwards
2458compatibility, a combination of noupdate and strict or leaky. */
2459
2460if (mode == RATE_PER_CLASH)
2461 return ratelimit_error(log_msgptr, "conflicting per_* options");
2462if (leaky + strict + readonly > 1)
2463 return ratelimit_error(log_msgptr, "conflicting update modes");
2464if (badacl && (leaky || strict) && !noupdate)
2465 return ratelimit_error(log_msgptr,
2466 "\"%s\" must not have /leaky or /strict option in %s ACL",
2467 ratelimit_option_string[mode], acl_wherenames[where]);
2468
2469/* Set the default values of any unset options. In readonly mode we
2470perform the rate computation without any increment so that its value
2471decays to eventually allow over-limit senders through. */
2472
2473if (noupdate) readonly = TRUE, leaky = strict = FALSE;
2474if (badacl) readonly = TRUE;
2475if (readonly) count = 0.0;
2476if (!strict && !readonly) leaky = TRUE;
2477if (mode == RATE_PER_WHAT) mode = RATE_PER_MAIL;
870f6ba8 2478
8f240103
PH
2479/* Create the lookup key. If there is no explicit key, use sender_host_address.
2480If there is no sender_host_address (e.g. -bs or acl_not_smtp) then we simply
2481omit it. The smoothing constant (sender_rate_period) and the per_xxx options
2482are added to the key because they alter the meaning of the stored data. */
2483
2484if (key == NULL)
2485 key = (sender_host_address == NULL)? US"" : sender_host_address;
870f6ba8 2486
c99ce5c9 2487key = string_sprintf("%s/%s/%s%s",
8f240103 2488 sender_rate_period,
c99ce5c9
TF
2489 ratelimit_option_string[mode],
2490 unique == NULL ? "" : "unique/",
8f240103 2491 key);
870f6ba8 2492
c99ce5c9
TF
2493HDEBUG(D_acl)
2494 debug_printf("ratelimit condition count=%.0f %.1f/%s\n", count, limit, key);
870f6ba8 2495
8f240103
PH
2496/* See if we have already computed the rate by looking in the relevant tree.
2497For per-connection rate limiting, store tree nodes and dbdata in the permanent
c99ce5c9
TF
2498pool so that they survive across resets. In readonly mode we only remember the
2499result for the rest of this command in case a later command changes it. After
2500this bit of logic the code is independent of the per_* mode. */
870f6ba8 2501
870f6ba8
TF
2502old_pool = store_pool;
2503
c99ce5c9
TF
2504if (readonly)
2505 anchor = &ratelimiters_cmd;
2506else switch(mode) {
2507case RATE_PER_CONN:
870f6ba8
TF
2508 anchor = &ratelimiters_conn;
2509 store_pool = POOL_PERM;
c99ce5c9
TF
2510 break;
2511case RATE_PER_BYTE:
2512case RATE_PER_MAIL:
2513case RATE_PER_ALLRCPTS:
870f6ba8 2514 anchor = &ratelimiters_mail;
c99ce5c9
TF
2515 break;
2516case RATE_PER_ADDR:
2517case RATE_PER_CMD:
2518case RATE_PER_RCPT:
fe0dab11 2519 anchor = &ratelimiters_cmd;
c99ce5c9
TF
2520 break;
2521default:
3399bb60 2522 anchor = NULL; /* silence an "unused" complaint */
c99ce5c9
TF
2523 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
2524 "internal ACL error: unknown ratelimit mode %d", mode);
2525 break;
2526}
870f6ba8 2527
c99ce5c9
TF
2528t = tree_search(*anchor, key);
2529if (t != NULL)
870f6ba8
TF
2530 {
2531 dbd = t->data.ptr;
2532 /* The following few lines duplicate some of the code below. */
8f240103 2533 rc = (dbd->rate < limit)? FAIL : OK;
870f6ba8
TF
2534 store_pool = old_pool;
2535 sender_rate = string_sprintf("%.1f", dbd->rate);
2536 HDEBUG(D_acl)
2537 debug_printf("ratelimit found pre-computed rate %s\n", sender_rate);
2538 return rc;
2539 }
2540
c99ce5c9
TF
2541/* We aren't using a pre-computed rate, so get a previously recorded rate
2542from the database, which will be updated and written back if required. */
870f6ba8
TF
2543
2544dbm = dbfn_open(US"ratelimit", O_RDWR, &dbblock, TRUE);
2545if (dbm == NULL)
2546 {
2547 store_pool = old_pool;
2548 sender_rate = NULL;
2549 HDEBUG(D_acl) debug_printf("ratelimit database not available\n");
2550 *log_msgptr = US"ratelimit database not available";
2551 return DEFER;
2552 }
c99ce5c9
TF
2553dbdb = dbfn_read_with_length(dbm, key, &dbdb_size);
2554dbd = NULL;
870f6ba8
TF
2555
2556gettimeofday(&tv, NULL);
2557
c99ce5c9
TF
2558if (dbdb != NULL)
2559 {
2560 /* Locate the basic ratelimit block inside the DB data. */
2561 HDEBUG(D_acl) debug_printf("ratelimit found key in database\n");
2562 dbd = &dbdb->dbd;
2563
2564 /* Forget the old Bloom filter if it is too old, so that we count each
2565 repeating event once per period. We don't simply clear and re-use the old
2566 filter because we want its size to change if the limit changes. Note that
2567 we keep the dbd pointer for copying the rate into the new data block. */
2568
2569 if(unique != NULL && tv.tv_sec > dbdb->bloom_epoch + period)
2570 {
2571 HDEBUG(D_acl) debug_printf("ratelimit discarding old Bloom filter\n");
2572 dbdb = NULL;
2573 }
2574
2575 /* Sanity check. */
2576
2577 if(unique != NULL && dbdb_size < sizeof(*dbdb))
2578 {
2579 HDEBUG(D_acl) debug_printf("ratelimit discarding undersize Bloom filter\n");
2580 dbdb = NULL;
2581 }
2582 }
2583
2584/* Allocate a new data block if the database lookup failed
2585or the Bloom filter passed its age limit. */
2586
2587if (dbdb == NULL)
2588 {
2589 if (unique == NULL)
2590 {
2591 /* No Bloom filter. This basic ratelimit block is initialized below. */
2592 HDEBUG(D_acl) debug_printf("ratelimit creating new rate data block\n");
2593 dbdb_size = sizeof(*dbd);
2594 dbdb = store_get(dbdb_size);
2595 }
2596 else
2597 {
2598 int extra;
2599 HDEBUG(D_acl) debug_printf("ratelimit creating new Bloom filter\n");
2600
2601 /* See the long comment below for an explanation of the magic number 2.
2602 The filter has a minimum size in case the rate limit is very small;
2603 this is determined by the definition of dbdata_ratelimit_unique. */
2604
2605 extra = (int)limit * 2 - sizeof(dbdb->bloom);
2606 if (extra < 0) extra = 0;
2607 dbdb_size = sizeof(*dbdb) + extra;
2608 dbdb = store_get(dbdb_size);
2609 dbdb->bloom_epoch = tv.tv_sec;
2610 dbdb->bloom_size = sizeof(dbdb->bloom) + extra;
2611 memset(dbdb->bloom, 0, dbdb->bloom_size);
2612
2613 /* Preserve any basic ratelimit data (which is our longer-term memory)
2614 by copying it from the discarded block. */
2615
2616 if (dbd != NULL)
2617 {
2618 dbdb->dbd = *dbd;
2619 dbd = &dbdb->dbd;
2620 }
2621 }
2622 }
2623
2624/* If we are counting unique events, find out if this event is new or not.
2625If the client repeats the event during the current period then it should be
2626counted. We skip this code in readonly mode for efficiency, because any
2627changes to the filter will be discarded and because count is already set to
2628zero. */
2629
2630if (unique != NULL && !readonly)
2631 {
2632 /* We identify unique events using a Bloom filter. (You can find my
2633 notes on Bloom filters at http://fanf.livejournal.com/81696.html)
2634 With the per_addr option, an "event" is a recipient address, though the
2635 user can use the unique option to define their own events. We only count
2636 an event if we have not seen it before.
2637
2638 We size the filter according to the rate limit, which (in leaky mode)
2639 is the limit on the population of the filter. We allow 16 bits of space
2640 per entry (see the construction code above) and we set (up to) 8 of them
2641 when inserting an element (see the loop below). The probability of a false
2642 positive (an event we have not seen before but which we fail to count) is
2643
2644 size = limit * 16
2645 numhash = 8
2646 allzero = exp(-numhash * pop / size)
2647 = exp(-0.5 * pop / limit)
2648 fpr = pow(1 - allzero, numhash)
2649
2650 For senders at the limit the fpr is 0.06% or 1 in 1700
2651 and for senders at half the limit it is 0.0006% or 1 in 170000
2652
2653 In strict mode the Bloom filter can fill up beyond the normal limit, in
2654 which case the false positive rate will rise. This means that the
2655 measured rate for very fast senders can bogusly drop off after a while.
2656
2657 At twice the limit, the fpr is 2.5% or 1 in 40
2658 At four times the limit, it is 31% or 1 in 3.2
2659
2660 It takes ln(pop/limit) periods for an over-limit burst of pop events to
2661 decay below the limit, and if this is more than one then the Bloom filter
2662 will be discarded before the decay gets that far. The false positive rate
2663 at this threshold is 9.3% or 1 in 10.7. */
2664
2665 BOOL seen;
2666 unsigned n, hash, hinc;
2667 uschar md5sum[16];
2668 md5 md5info;
2669
2670 /* Instead of using eight independent hash values, we combine two values
2671 using the formula h1 + n * h2. This does not harm the Bloom filter's
2672 performance, and means the amount of hash we need is independent of the
2673 number of bits we set in the filter. */
2674
2675 md5_start(&md5info);
2676 md5_end(&md5info, unique, Ustrlen(unique), md5sum);
2677 hash = md5sum[0] | md5sum[1] << 8 | md5sum[2] << 16 | md5sum[3] << 24;
2678 hinc = md5sum[4] | md5sum[5] << 8 | md5sum[6] << 16 | md5sum[7] << 24;
2679
2680 /* Scan the bits corresponding to this event. A zero bit means we have
2681 not seen it before. Ensure all bits are set to record this event. */
2682
2683 HDEBUG(D_acl) debug_printf("ratelimit checking uniqueness of %s\n", unique);
2684
2685 seen = TRUE;
2686 for (n = 0; n < 8; n++, hash += hinc)
2687 {
2688 int bit = 1 << (hash % 8);
2689 int byte = (hash / 8) % dbdb->bloom_size;
2690 if ((dbdb->bloom[byte] & bit) == 0)
2691 {
2692 dbdb->bloom[byte] |= bit;
2693 seen = FALSE;
2694 }
2695 }
2696
2697 /* If this event has occurred before, do not count it. */
2698
2699 if (seen)
2700 {
2701 HDEBUG(D_acl) debug_printf("ratelimit event found in Bloom filter\n");
2702 count = 0.0;
2703 }
2704 else
2705 HDEBUG(D_acl) debug_printf("ratelimit event added to Bloom filter\n");
2706 }
2707
2708/* If there was no previous ratelimit data block for this key, initialize
2709the new one, otherwise update the block from the database. The initial rate
2710is what would be computed by the code below for an infinite interval. */
2711
870f6ba8
TF
2712if (dbd == NULL)
2713 {
c99ce5c9
TF
2714 HDEBUG(D_acl) debug_printf("ratelimit initializing new key's rate data\n");
2715 dbd = &dbdb->dbd;
870f6ba8
TF
2716 dbd->time_stamp = tv.tv_sec;
2717 dbd->time_usec = tv.tv_usec;
c99ce5c9 2718 dbd->rate = count;
870f6ba8
TF
2719 }
2720else
2721 {
2722 /* The smoothed rate is computed using an exponentially weighted moving
2723 average adjusted for variable sampling intervals. The standard EWMA for
2724 a fixed sampling interval is: f'(t) = (1 - a) * f(t) + a * f'(t - 1)
2725 where f() is the measured value and f'() is the smoothed value.
2726
2727 Old data decays out of the smoothed value exponentially, such that data n
2728 samples old is multiplied by a^n. The exponential decay time constant p
2729 is defined such that data p samples old is multiplied by 1/e, which means
2730 that a = exp(-1/p). We can maintain the same time constant for a variable
2731 sampling interval i by using a = exp(-i/p).
2732
2733 The rate we are measuring is messages per period, suitable for directly
2734 comparing with the limit. The average rate between now and the previous
2735 message is period / interval, which we feed into the EWMA as the sample.
2736
2737 It turns out that the number of messages required for the smoothed rate
2738 to reach the limit when they are sent in a burst is equal to the limit.
2739 This can be seen by analysing the value of the smoothed rate after N
2740 messages sent at even intervals. Let k = (1 - a) * p/i
2741
2742 rate_1 = (1 - a) * p/i + a * rate_0
2743 = k + a * rate_0
2744 rate_2 = k + a * rate_1
2745 = k + a * k + a^2 * rate_0
2746 rate_3 = k + a * k + a^2 * k + a^3 * rate_0
2747 rate_N = rate_0 * a^N + k * SUM(x=0..N-1)(a^x)
2748 = rate_0 * a^N + k * (1 - a^N) / (1 - a)
2749 = rate_0 * a^N + p/i * (1 - a^N)
2750
2751 When N is large, a^N -> 0 so rate_N -> p/i as desired.
2752
2753 rate_N = p/i + (rate_0 - p/i) * a^N
2754 a^N = (rate_N - p/i) / (rate_0 - p/i)
2755 N * -i/p = log((rate_N - p/i) / (rate_0 - p/i))
2756 N = p/i * log((rate_0 - p/i) / (rate_N - p/i))
2757
2758 Numerical analysis of the above equation, setting the computed rate to
2759 increase from rate_0 = 0 to rate_N = limit, shows that for large sending
2760 rates, p/i, the number of messages N = limit. So limit serves as both the
2761 maximum rate measured in messages per period, and the maximum number of
2762 messages that can be sent in a fast burst. */
2763
2764 double this_time = (double)tv.tv_sec
2765 + (double)tv.tv_usec / 1000000.0;
2766 double prev_time = (double)dbd->time_stamp
2767 + (double)dbd->time_usec / 1000000.0;
870f6ba8
TF
2768
2769 /* We must avoid division by zero, and deal gracefully with the clock going
2770 backwards. If we blunder ahead when time is in reverse then the computed
e5d5a95f 2771 rate will be bogus. To be safe we clamp interval to a very small number. */
870f6ba8 2772
e5d5a95f
TF
2773 double interval = this_time - prev_time <= 0.0 ? 1e-9
2774 : this_time - prev_time;
2775
2776 double i_over_p = interval / period;
2777 double a = exp(-i_over_p);
870f6ba8 2778
c99ce5c9
TF
2779 /* Combine the instantaneous rate (period / interval) with the previous rate
2780 using the smoothing factor a. In order to measure sized events, multiply the
2781 instantaneous rate by the count of bytes or recipients etc. */
2782
870f6ba8
TF
2783 dbd->time_stamp = tv.tv_sec;
2784 dbd->time_usec = tv.tv_usec;
c99ce5c9
TF
2785 dbd->rate = (1 - a) * count / i_over_p + a * dbd->rate;
2786
2787 /* When events are very widely spaced the computed rate tends towards zero.
2788 Although this is accurate it turns out not to be useful for our purposes,
2789 especially when the first event after a long silence is the start of a spam
2790 run. A more useful model is that the rate for an isolated event should be the
2791 size of the event per the period size, ignoring the lack of events outside
2792 the current period and regardless of where the event falls in the period. So,
2793 if the interval was so long that the calculated rate is unhelpfully small, we
2794 re-intialize the rate. In the absence of higher-rate bursts, the condition
2795 below is true if the interval is greater than the period. */
2796
2797 if (dbd->rate < count) dbd->rate = count;
870f6ba8
TF
2798 }
2799
c99ce5c9
TF
2800/* Clients sending at the limit are considered to be over the limit.
2801This matters for edge cases such as a limit of zero, when the client
2802should be completely blocked. */
3348576f 2803
8f240103 2804rc = (dbd->rate < limit)? FAIL : OK;
870f6ba8
TF
2805
2806/* Update the state if the rate is low or if we are being strict. If we
2807are in leaky mode and the sender's rate is too high, we do not update
2808the recorded rate in order to avoid an over-aggressive sender's retry
c99ce5c9
TF
2809rate preventing them from getting any email through. If readonly is set,
2810neither leaky nor strict are set, so we do not do any updates. */
870f6ba8 2811
c99ce5c9 2812if ((rc == FAIL && leaky) || strict)
8f240103 2813 {
c99ce5c9 2814 dbfn_write(dbm, key, dbdb, dbdb_size);
8f240103
PH
2815 HDEBUG(D_acl) debug_printf("ratelimit db updated\n");
2816 }
2817else
2818 {
2819 HDEBUG(D_acl) debug_printf("ratelimit db not updated: %s\n",
c99ce5c9 2820 readonly? "readonly mode" : "over the limit, but leaky");
8f240103
PH
2821 }
2822
870f6ba8
TF
2823dbfn_close(dbm);
2824
c99ce5c9 2825/* Store the result in the tree for future reference. */
870f6ba8 2826
c99ce5c9
TF
2827t = store_get(sizeof(tree_node) + Ustrlen(key));
2828t->data.ptr = dbd;
2829Ustrcpy(t->name, key);
2830(void)tree_insertnode(anchor, t);
870f6ba8
TF
2831
2832/* We create the formatted version of the sender's rate very late in
2833order to ensure that it is done using the correct storage pool. */
2834
2835store_pool = old_pool;
2836sender_rate = string_sprintf("%.1f", dbd->rate);
2837
2838HDEBUG(D_acl)
2839 debug_printf("ratelimit computed rate %s\n", sender_rate);
2840
2841return rc;
2842}
2843
2844
2845
2846/*************************************************
b0019c78
TF
2847* The udpsend ACL modifier *
2848*************************************************/
2849
2850/* Called by acl_check_condition() below.
2851
2852Arguments:
2853 arg the option string for udpsend=
2854 log_msgptr for error messages
2855
2856Returns: OK - Completed.
2857 DEFER - Problem with DNS lookup.
2858 ERROR - Syntax error in options.
2859*/
2860
2861static int
55414b25 2862acl_udpsend(const uschar *arg, uschar **log_msgptr)
b0019c78
TF
2863{
2864int sep = 0;
2865uschar *hostname;
2866uschar *portstr;
2867uschar *portend;
2868host_item *h;
2869int portnum;
b0019c78
TF
2870int len;
2871int r, s;
b1f8e4f8 2872uschar * errstr;
b0019c78
TF
2873
2874hostname = string_nextinlist(&arg, &sep, NULL, 0);
2875portstr = string_nextinlist(&arg, &sep, NULL, 0);
2876
2877if (hostname == NULL)
2878 {
217b0e56 2879 *log_msgptr = US"missing destination host in \"udpsend\" modifier";
b0019c78
TF
2880 return ERROR;
2881 }
2882if (portstr == NULL)
2883 {
217b0e56 2884 *log_msgptr = US"missing destination port in \"udpsend\" modifier";
b0019c78
TF
2885 return ERROR;
2886 }
2887if (arg == NULL)
2888 {
217b0e56 2889 *log_msgptr = US"missing datagram payload in \"udpsend\" modifier";
b0019c78
TF
2890 return ERROR;
2891 }
2892portnum = Ustrtol(portstr, &portend, 10);
2893if (*portend != '\0')
2894 {
217b0e56 2895 *log_msgptr = US"bad destination port in \"udpsend\" modifier";
b0019c78
TF
2896 return ERROR;
2897 }
2898
2899/* Make a single-item host list. */
2900h = store_get(sizeof(host_item));
2901memset(h, 0, sizeof(host_item));
2902h->name = hostname;
2903h->port = portnum;
2904h->mx = MX_NONE;
2905
2906if (string_is_ip_address(hostname, NULL))
2907 h->address = hostname, r = HOST_FOUND;
2908else
2909 r = host_find_byname(h, NULL, 0, NULL, FALSE);
2910if (r == HOST_FIND_FAILED || r == HOST_FIND_AGAIN)
2911 {
217b0e56 2912 *log_msgptr = US"DNS lookup failed in \"udpsend\" modifier";
b0019c78
TF
2913 return DEFER;
2914 }
2915
2916HDEBUG(D_acl)
2917 debug_printf("udpsend [%s]:%d %s\n", h->address, portnum, arg);
2918
b1f8e4f8
JH
2919r = s = ip_connectedsocket(SOCK_DGRAM, h->address, portnum, portnum,
2920 1, NULL, &errstr);
b0019c78 2921if (r < 0) goto defer;
27f9999e 2922len = Ustrlen(arg);
9cb1785a 2923r = send(s, arg, len, 0);
b1f8e4f8
JH
2924if (r < 0)
2925 {
2926 errstr = US strerror(errno);
2927 close(s);
2928 goto defer;
2929 }
2930close(s);
b0019c78
TF
2931if (r < len)
2932 {
2933 *log_msgptr =
2934 string_sprintf("\"udpsend\" truncated from %d to %d octets", len, r);
2935 return DEFER;
2936 }
2937
2938HDEBUG(D_acl)
2939 debug_printf("udpsend %d bytes\n", r);
2940
2941return OK;
2942
2943defer:
b1f8e4f8 2944*log_msgptr = string_sprintf("\"udpsend\" failed: %s", errstr);
b0019c78
TF
2945return DEFER;
2946}
2947
2948
2949
2950/*************************************************
059ec3d9
PH
2951* Handle conditions/modifiers on an ACL item *
2952*************************************************/
2953
2954/* Called from acl_check() below.
2955
2956Arguments:
2957 verb ACL verb
2958 cb ACL condition block - if NULL, result is OK
2959 where where called from
2960 addr the address being checked for RCPT, or NULL
2961 level the nesting level
2962 epp pointer to pass back TRUE if "endpass" encountered
2963 (applies only to "accept" and "discard")
2964 user_msgptr user message pointer
2965 log_msgptr log message pointer
2966 basic_errno pointer to where to put verify error
2967
2968Returns: OK - all conditions are met
2969 DISCARD - an "acl" condition returned DISCARD - only allowed
2970 for "accept" or "discard" verbs
2971 FAIL - at least one condition fails
2972 FAIL_DROP - an "acl" condition returned FAIL_DROP
2973 DEFER - can't tell at the moment (typically, lookup defer,
2974 but can be temporary callout problem)
2975 ERROR - ERROR from nested ACL or expansion failure or other
2976 error
2977*/
2978
2979static int
2980acl_check_condition(int verb, acl_condition_block *cb, int where,
2981 address_item *addr, int level, BOOL *epp, uschar **user_msgptr,
2982 uschar **log_msgptr, int *basic_errno)
2983{
2984uschar *user_message = NULL;
2985uschar *log_message = NULL;
ed7f7860
PP
2986uschar *debug_tag = NULL;
2987uschar *debug_opts = NULL;
059ec3d9 2988int rc = OK;
8523533c 2989#ifdef WITH_CONTENT_SCAN
0f0c8159 2990int sep = -'/';
8523533c 2991#endif
059ec3d9
PH
2992
2993for (; cb != NULL; cb = cb->next)
2994 {
55414b25 2995 const uschar *arg;
8e669ac1 2996 int control_type;
059ec3d9
PH
2997
2998 /* The message and log_message items set up messages to be used in
2999 case of rejection. They are expanded later. */
3000
3001 if (cb->type == ACLC_MESSAGE)
3002 {
187bc588 3003 HDEBUG(D_acl) debug_printf(" message: %s\n", cb->arg);
059ec3d9
PH
3004 user_message = cb->arg;
3005 continue;
3006 }
3007
3008 if (cb->type == ACLC_LOG_MESSAGE)
3009 {
187bc588 3010 HDEBUG(D_acl) debug_printf("l_message: %s\n", cb->arg);
059ec3d9
PH
3011 log_message = cb->arg;
3012 continue;
3013 }
3014
3015 /* The endpass "condition" just sets a flag to show it occurred. This is
3016 checked at compile time to be on an "accept" or "discard" item. */
3017
3018 if (cb->type == ACLC_ENDPASS)
3019 {
3020 *epp = TRUE;
3021 continue;
3022 }
3023
3024 /* For other conditions and modifiers, the argument is expanded now for some
3025 of them, but not for all, because expansion happens down in some lower level
3026 checking functions in some cases. */
3027
3028 if (cond_expand_at_top[cb->type])
3029 {
3030 arg = expand_string(cb->arg);
3031 if (arg == NULL)
3032 {
3033 if (expand_string_forcedfail) continue;
3034 *log_msgptr = string_sprintf("failed to expand ACL string \"%s\": %s",
3035 cb->arg, expand_string_message);
3036 return search_find_defer? DEFER : ERROR;
3037 }
3038 }
3039 else arg = cb->arg;
3040
3041 /* Show condition, and expanded condition if it's different */
3042
3043 HDEBUG(D_acl)
3044 {
3045 int lhswidth = 0;
3046 debug_printf("check %s%s %n",
3047 (!cond_modifiers[cb->type] && cb->u.negated)? "!":"",
3048 conditions[cb->type], &lhswidth);
3049
3050 if (cb->type == ACLC_SET)
3051 {
38a0a95f
PH
3052 debug_printf("acl_%s ", cb->u.varname);
3053 lhswidth += 5 + Ustrlen(cb->u.varname);
059ec3d9
PH
3054 }
3055
3056 debug_printf("= %s\n", cb->arg);
3057
3058 if (arg != cb->arg)
3059 debug_printf("%.*s= %s\n", lhswidth,
3060 US" ", CS arg);
3061 }
3062
3063 /* Check that this condition makes sense at this time */
3064
3065 if ((cond_forbids[cb->type] & (1 << where)) != 0)
3066 {
3067 *log_msgptr = string_sprintf("cannot %s %s condition in %s ACL",
3068 cond_modifiers[cb->type]? "use" : "test",
3069 conditions[cb->type], acl_wherenames[where]);
3070 return ERROR;
3071 }
3072
3073 /* Run the appropriate test for each condition, or take the appropriate
3074 action for the remaining modifiers. */
3075
3076 switch(cb->type)
3077 {
71fafd95
PH
3078 case ACLC_ADD_HEADER:
3079 setup_header(arg);
3080 break;
3081
059ec3d9
PH
3082 /* A nested ACL that returns "discard" makes sense only for an "accept" or
3083 "discard" verb. */
71fafd95 3084
059ec3d9 3085 case ACLC_ACL:
f60d98e8 3086 rc = acl_check_wargs(where, addr, arg, level+1, user_msgptr, log_msgptr);
7421ecab
JH
3087 if (rc == DISCARD && verb != ACL_ACCEPT && verb != ACL_DISCARD)
3088 {
3089 *log_msgptr = string_sprintf("nested ACL returned \"discard\" for "
3090 "\"%s\" command (only allowed with \"accept\" or \"discard\")",
3091 verbs[verb]);
3092 return ERROR;
3093 }
059ec3d9
PH
3094 break;
3095
3096 case ACLC_AUTHENTICATED:
3097 rc = (sender_host_authenticated == NULL)? FAIL :
3098 match_isinlist(sender_host_authenticated, &arg, 0, NULL, NULL, MCL_STRING,
3099 TRUE, NULL);
3100 break;
3101
71fafd95 3102 #ifdef EXPERIMENTAL_BRIGHTMAIL
8523533c
TK
3103 case ACLC_BMI_OPTIN:
3104 {
3105 int old_pool = store_pool;
3106 store_pool = POOL_PERM;
3107 bmi_current_optin = string_copy(arg);
3108 store_pool = old_pool;
3109 }
3110 break;
71fafd95 3111 #endif
8523533c 3112
059ec3d9 3113 case ACLC_CONDITION:
f3766eb5
NM
3114 /* The true/false parsing here should be kept in sync with that used in
3115 expand.c when dealing with ECOND_BOOL so that we don't have too many
3116 different definitions of what can be a boolean. */
51c7471d
JH
3117 if (*arg == '-'
3118 ? Ustrspn(arg+1, "0123456789") == Ustrlen(arg+1) /* Negative number */
3119 : Ustrspn(arg, "0123456789") == Ustrlen(arg)) /* Digits, or empty */
059ec3d9
PH
3120 rc = (Uatoi(arg) == 0)? FAIL : OK;
3121 else
3122 rc = (strcmpic(arg, US"no") == 0 ||
3123 strcmpic(arg, US"false") == 0)? FAIL :
3124 (strcmpic(arg, US"yes") == 0 ||
3125 strcmpic(arg, US"true") == 0)? OK : DEFER;
3126 if (rc == DEFER)
3127 *log_msgptr = string_sprintf("invalid \"condition\" value \"%s\"", arg);
3128 break;
3129
c3611384
PH
3130 case ACLC_CONTINUE: /* Always succeeds */
3131 break;
3132
059ec3d9 3133 case ACLC_CONTROL:
c5fcb476 3134 {
55414b25
JH
3135 const uschar *p = NULL;
3136 control_type = decode_control(arg, &p, where, log_msgptr);
4840604e 3137
55414b25 3138 /* Check if this control makes sense at this time */
f7572e5a 3139
55414b25
JH
3140 if ((control_forbids[control_type] & (1 << where)) != 0)
3141 {
3142 *log_msgptr = string_sprintf("cannot use \"control=%s\" in %s ACL",
3143 controls[control_type], acl_wherenames[where]);
3144 return ERROR;
3145 }
8800895a 3146
55414b25
JH
3147 switch(control_type)
3148 {
3149 case CONTROL_AUTH_UNADVERTISED:
3150 allow_auth_unadvertised = TRUE;
3151 break;
3152
3153 #ifdef EXPERIMENTAL_BRIGHTMAIL
3154 case CONTROL_BMI_RUN:
3155 bmi_run = 1;
3156 break;
3157 #endif
3158
3159 #ifndef DISABLE_DKIM
3160 case CONTROL_DKIM_VERIFY:
3161 dkim_disable_verify = TRUE;
3162 #ifdef EXPERIMENTAL_DMARC
3163 /* Since DKIM was blocked, skip DMARC too */
3164 dmarc_disable_verify = TRUE;
3165 dmarc_enable_forensic = FALSE;
3166 #endif
3167 break;
3168 #endif
3169
3170 #ifdef EXPERIMENTAL_DMARC
3171 case CONTROL_DMARC_VERIFY:
3172 dmarc_disable_verify = TRUE;
3173 break;
3174
3175 case CONTROL_DMARC_FORENSIC:
3176 dmarc_enable_forensic = TRUE;
3177 break;
3178 #endif
3179
3180 case CONTROL_DSCP:
3181 if (*p == '/')
3182 {
3183 int fd, af, level, optname, value;
3184 /* If we are acting on stdin, the setsockopt may fail if stdin is not
3185 a socket; we can accept that, we'll just debug-log failures anyway. */
3186 fd = fileno(smtp_in);
3187 af = ip_get_address_family(fd);
3188 if (af < 0)
3189 {
3190 HDEBUG(D_acl)
3191 debug_printf("smtp input is probably not a socket [%s], not setting DSCP\n",
3192 strerror(errno));
3193 break;
3194 }
3195 if (dscp_lookup(p+1, af, &level, &optname, &value))
3196 {
3197 if (setsockopt(fd, level, optname, &value, sizeof(value)) < 0)
3198 {
3199 HDEBUG(D_acl) debug_printf("failed to set input DSCP[%s]: %s\n",
3200 p+1, strerror(errno));
3201 }
3202 else
3203 {
3204 HDEBUG(D_acl) debug_printf("set input DSCP to \"%s\"\n", p+1);
3205 }
3206 }
3207 else
3208 {
3209 *log_msgptr = string_sprintf("unrecognised DSCP value in \"control=%s\"", arg);
3210 return ERROR;
3211 }
3212 }
3213 else
3214 {
3215 *log_msgptr = string_sprintf("syntax error in \"control=%s\"", arg);
3216 return ERROR;
3217 }
3218 break;
3219
3220 case CONTROL_ERROR:
3221 return ERROR;
3222
3223 case CONTROL_CASEFUL_LOCAL_PART:
3224 deliver_localpart = addr->cc_local_part;
3225 break;
3226
3227 case CONTROL_CASELOWER_LOCAL_PART:
3228 deliver_localpart = addr->lc_local_part;
3229 break;
3230
3231 case CONTROL_ENFORCE_SYNC:
3232 smtp_enforce_sync = TRUE;
3233 break;
3234
3235 case CONTROL_NO_ENFORCE_SYNC:
3236 smtp_enforce_sync = FALSE;
3237 break;
3238
3239 #ifdef WITH_CONTENT_SCAN
3240 case CONTROL_NO_MBOX_UNSPOOL:
3241 no_mbox_unspool = TRUE;
3242 break;
3243 #endif
3244
3245 case CONTROL_NO_MULTILINE:
3246 no_multiline_responses = TRUE;
3247 break;
3248
3249 case CONTROL_NO_PIPELINING:
3250 pipelining_enable = FALSE;
3251 break;
3252
3253 case CONTROL_NO_DELAY_FLUSH:
3254 disable_delay_flush = TRUE;
3255 break;
3256
3257 case CONTROL_NO_CALLOUT_FLUSH:
3258 disable_callout_flush = TRUE;
3259 break;
3260
3261 case CONTROL_FAKEREJECT:
3262 cancel_cutthrough_connection("fakereject");
3263 case CONTROL_FAKEDEFER:
3264 fake_response = (control_type == CONTROL_FAKEDEFER) ? DEFER : FAIL;
3265 if (*p == '/')
3266 {
3267 const uschar *pp = p + 1;
3268 while (*pp != 0) pp++;
3269 fake_response_text = expand_string(string_copyn(p+1, pp-p-1));
3270 p = pp;
3271 }
3272 else
3273 {
3274 /* Explicitly reset to default string */
3275 fake_response_text = US"Your message has been rejected but is being kept for evaluation.\nIf it was a legitimate message, it may still be delivered to the target recipient(s).";
3276 }
3277 break;
ed7f7860 3278
55414b25
JH
3279 case CONTROL_FREEZE:
3280 deliver_freeze = TRUE;
3281 deliver_frozen_at = time(NULL);
3282 freeze_tell = freeze_tell_config; /* Reset to configured value */
3283 if (Ustrncmp(p, "/no_tell", 8) == 0)
3284 {
3285 p += 8;
3286 freeze_tell = NULL;
3287 }
3288 if (*p != 0)
3289 {
3290 *log_msgptr = string_sprintf("syntax error in \"control=%s\"", arg);
3291 return ERROR;
3292 }
3293 cancel_cutthrough_connection("item frozen");
3294 break;
3295
3296 case CONTROL_QUEUE_ONLY:
3297 queue_only_policy = TRUE;
3298 cancel_cutthrough_connection("queueing forced");
3299 break;
3300
3301 case CONTROL_SUBMISSION:
3302 originator_name = US"";
3303 submission_mode = TRUE;
3304 while (*p == '/')
3305 {
3306 if (Ustrncmp(p, "/sender_retain", 14) == 0)
3307 {
3308 p += 14;
3309 active_local_sender_retain = TRUE;
3310 active_local_from_check = FALSE;
3311 }
3312 else if (Ustrncmp(p, "/domain=", 8) == 0)
3313 {
3314 const uschar *pp = p + 8;
3315 while (*pp != 0 && *pp != '/') pp++;
3316 submission_domain = string_copyn(p+8, pp-p-8);
3317 p = pp;
3318 }
3319 /* The name= option must be last, because it swallows the rest of
3320 the string. */
3321 else if (Ustrncmp(p, "/name=", 6) == 0)
3322 {
3323 const uschar *pp = p + 6;
3324 while (*pp != 0) pp++;
3325 submission_name = string_copy(parse_fix_phrase(p+6, pp-p-6,
3326 big_buffer, big_buffer_size));
3327 p = pp;
3328 }
3329 else break;
3330 }
3331 if (*p != 0)
3332 {
3333 *log_msgptr = string_sprintf("syntax error in \"control=%s\"", arg);
3334 return ERROR;
3335 }
3336 break;
e4bdf652 3337
55414b25
JH
3338 case CONTROL_DEBUG:
3339 while (*p == '/')
3340 {
3341 if (Ustrncmp(p, "/tag=", 5) == 0)
3342 {
3343 const uschar *pp = p + 5;
3344 while (*pp != '\0' && *pp != '/') pp++;
3345 debug_tag = string_copyn(p+5, pp-p-5);
3346 p = pp;
3347 }
3348 else if (Ustrncmp(p, "/opts=", 6) == 0)
3349 {
3350 const uschar *pp = p + 6;
3351 while (*pp != '\0' && *pp != '/') pp++;
3352 debug_opts = string_copyn(p+6, pp-p-6);
3353 p = pp;
3354 }
3355 }
3356 debug_logging_activate(debug_tag, debug_opts);
3357 break;
3358
3359 case CONTROL_SUPPRESS_LOCAL_FIXUPS:
3360 suppress_local_fixups = TRUE;
3361 break;
3362
3363 case CONTROL_CUTTHROUGH_DELIVERY:
a2b89db1 3364#ifndef DISABLE_PRDR
55414b25 3365 if (prdr_requested)
a2b89db1
PP
3366#else
3367 if (0)
3368#endif
55414b25
JH
3369 /* Too hard to think about for now. We might in future cutthrough
3370 the case where both sides handle prdr and this-node prdr acl
3371 is "accept" */
93a6fce2 3372 *log_msgptr = string_sprintf("PRDR on %s reception\n", arg);
5032d1cf
JH
3373 else
3374 {
55414b25
JH
3375 if (deliver_freeze)
3376 *log_msgptr = US"frozen";
3377 else if (queue_only_policy)
3378 *log_msgptr = US"queue-only";
3379 else if (fake_response == FAIL)
3380 *log_msgptr = US"fakereject";
3381 else
3382 {
3383 if (rcpt_count == 1) cutthrough.delivery = TRUE;
3384 break;
3385 }
3386 *log_msgptr = string_sprintf("\"control=%s\" on %s item",
3387 arg, *log_msgptr);
5032d1cf 3388 }
55414b25 3389 return ERROR;
3c8b3577 3390
8c5d388a 3391#ifdef SUPPORT_I18N
3c8b3577
JH
3392 case CONTROL_UTF8_DOWNCONVERT:
3393 if (*p == '/')
3394 {
921dfc11
JH
3395 if (p[1] == '1')
3396 {
3397 message_utf8_downconvert = 1;
3398 addr->prop.utf8_downcvt = TRUE;
3399 addr->prop.utf8_downcvt_maybe = FALSE;
3400 p += 2;
3401 break;
3402 }
3403 if (p[1] == '0')
3404 {
3405 message_utf8_downconvert = 0;
3406 addr->prop.utf8_downcvt = FALSE;
3407 addr->prop.utf8_downcvt_maybe = FALSE;
3408 p += 2;
3409 break;
3410 }
3c8b3577 3411 if (p[1] == '-' && p[2] == '1')
921dfc11
JH
3412 {
3413 message_utf8_downconvert = -1;
3414 addr->prop.utf8_downcvt = FALSE;
3415 addr->prop.utf8_downcvt_maybe = TRUE;
3416 p += 3;
3417 break;
3418 }
3c8b3577
JH
3419 *log_msgptr = US"bad option value for control=utf8_downconvert";
3420 }
3421 else
3422 {
921dfc11
JH
3423 message_utf8_downconvert = 1;
3424 addr->prop.utf8_downcvt = TRUE;
3425 addr->prop.utf8_downcvt_maybe = FALSE;
3426 break;
3c8b3577
JH
3427 }
3428 return ERROR;
8c5d388a 3429#endif
3c8b3577 3430
9171d434 3431 }
55414b25 3432 break;
059ec3d9 3433 }
059ec3d9 3434
6a8f9482
TK
3435 #ifdef EXPERIMENTAL_DCC
3436 case ACLC_DCC:
3437 {
3438 /* Seperate the regular expression and any optional parameters. */
55414b25
JH
3439 const uschar * list = arg;
3440 uschar *ss = string_nextinlist(&list, &sep, big_buffer, big_buffer_size);
6a8f9482
TK
3441 /* Run the dcc backend. */
3442 rc = dcc_process(&ss);
3443 /* Modify return code based upon the existance of options. */
3c8b3577 3444 while ((ss = string_nextinlist(&list, &sep, big_buffer, big_buffer_size)))
6a8f9482 3445 if (strcmpic(ss, US"defer_ok") == 0 && rc == DEFER)
3c8b3577 3446 rc = FAIL; /* FAIL so that the message is passed to the next ACL */
6a8f9482
TK
3447 }
3448 break;
3449 #endif
3450
71fafd95 3451 #ifdef WITH_CONTENT_SCAN
8523533c
TK
3452 case ACLC_DECODE:
3453 rc = mime_decode(&arg);
3454 break;
71fafd95 3455 #endif
8523533c 3456
059ec3d9
PH
3457 case ACLC_DELAY:
3458 {
3459 int delay = readconf_readtime(arg, 0, FALSE);
3460 if (delay < 0)
3461 {
3462 *log_msgptr = string_sprintf("syntax error in argument for \"delay\" "
3463 "modifier: \"%s\" is not a time value", arg);
3464 return ERROR;
3465 }
3466 else
3467 {
3468 HDEBUG(D_acl) debug_printf("delay modifier requests %d-second delay\n",
3469 delay);
3470 if (host_checking)
3471 {
3472 HDEBUG(D_acl)
3473 debug_printf("delay skipped in -bh checking mode\n");
3474 }
010c2d14 3475
ae9d18bc
JH
3476 /* NOTE 1: Remember that we may be
3477 dealing with stdin/stdout here, in addition to TCP/IP connections.
3478 Also, delays may be specified for non-SMTP input, where smtp_out and
3479 smtp_in will be NULL. Whatever is done must work in all cases.
3480
3481 NOTE 2: The added feature of flushing the output before a delay must
3482 apply only to SMTP input. Hence the test for smtp_out being non-NULL.
3483 */
3484
3485 else
3486 {
3487 if (smtp_out != NULL && !disable_delay_flush)
3488 mac_smtp_fflush();
3489
861a7c51 3490#if !defined(NO_POLL_H) && defined (POLLRDHUP)
ae9d18bc
JH
3491 {
3492 struct pollfd p;
3493 nfds_t n = 0;
3494 if (smtp_out)
3495 {
3496 p.fd = fileno(smtp_out);
3497 p.events = POLLRDHUP;
3498 n = 1;
3499 }
3500 if (poll(&p, n, delay*1000) > 0)
3501 HDEBUG(D_acl) debug_printf("delay cancelled by peer close\n");
3502 }
3503#else
010c2d14
PH
3504 /* It appears to be impossible to detect that a TCP/IP connection has
3505 gone away without reading from it. This means that we cannot shorten
3506 the delay below if the client goes away, because we cannot discover
3507 that the client has closed its end of the connection. (The connection
3508 is actually in a half-closed state, waiting for the server to close its
3509 end.) It would be nice to be able to detect this state, so that the
3510 Exim process is not held up unnecessarily. However, it seems that we
3511 can't. The poll() function does not do the right thing, and in any case
3512 it is not always available.
047bdd8c 3513 */
010c2d14 3514
86b8287f 3515 while (delay > 0) delay = sleep(delay);
ae9d18bc 3516#endif
8e669ac1 3517 }
059ec3d9
PH
3518 }
3519 }
3520 break;
3521
80a47a2c
TK
3522 #ifndef DISABLE_DKIM
3523 case ACLC_DKIM_SIGNER:
9e5d6b55
TK
3524 if (dkim_cur_signer != NULL)
3525 rc = match_isinlist(dkim_cur_signer,
80a47a2c 3526 &arg,0,NULL,NULL,MCL_STRING,TRUE,NULL);
80a47a2c 3527 else
b0b9dbb1 3528 rc = FAIL;
71fafd95
PH
3529 break;
3530
80a47a2c
TK
3531 case ACLC_DKIM_STATUS:
3532 rc = match_isinlist(dkim_exim_expand_query(DKIM_VERIFY_STATUS),
3533 &arg,0,NULL,NULL,MCL_STRING,TRUE,NULL);
71fafd95
PH
3534 break;
3535 #endif
fb2274d4 3536
4840604e
TL
3537 #ifdef EXPERIMENTAL_DMARC
3538 case ACLC_DMARC_STATUS:
4a8ce2d8 3539 if (!dmarc_has_been_checked)
4840604e 3540 dmarc_process();
4a8ce2d8 3541 dmarc_has_been_checked = TRUE;
4840604e
TL
3542 /* used long way of dmarc_exim_expand_query() in case we need more
3543 * view into the process in the future. */
3544 rc = match_isinlist(dmarc_exim_expand_query(DMARC_VERIFY_STATUS),
3545 &arg,0,NULL,NULL,MCL_STRING,TRUE,NULL);
3546 break;
3547 #endif
3548
059ec3d9 3549 case ACLC_DNSLISTS:
379ba7d0 3550 rc = verify_check_dnsbl(where, &arg, log_msgptr);
059ec3d9
PH
3551 break;
3552
3553 case ACLC_DOMAINS:
3554 rc = match_isinlist(addr->domain, &arg, 0, &domainlist_anchor,
55414b25 3555 addr->domain_cache, MCL_DOMAIN, TRUE, CUSS &deliver_domain_data);
059ec3d9
PH
3556 break;
3557
3558 /* The value in tls_cipher is the full cipher name, for example,
3559 TLSv1:DES-CBC3-SHA:168, whereas the values to test for are just the
3560 cipher names such as DES-CBC3-SHA. But program defensively. We don't know
3561 what may in practice come out of the SSL library - which at the time of
3562 writing is poorly documented. */
3563
3564 case ACLC_ENCRYPTED:
817d9f57 3565 if (tls_in.cipher == NULL) rc = FAIL; else
059ec3d9
PH
3566 {
3567 uschar *endcipher = NULL;
817d9f57
JH
3568 uschar *cipher = Ustrchr(tls_in.cipher, ':');
3569 if (cipher == NULL) cipher = tls_in.cipher; else
059ec3d9
PH
3570 {
3571 endcipher = Ustrchr(++cipher, ':');
3572 if (endcipher != NULL) *endcipher = 0;
3573 }
3574 rc = match_isinlist(cipher, &arg, 0, NULL, NULL, MCL_STRING, TRUE, NULL);
3575 if (endcipher != NULL) *endcipher = ':';
3576 }
3577 break;
3578
3579 /* Use verify_check_this_host() instead of verify_check_host() so that
3580 we can pass over &host_data to catch any looked up data. Once it has been
3581 set, it retains its value so that it's still there if another ACL verb
3582 comes through here and uses the cache. However, we must put it into
3583 permanent store in case it is also expected to be used in a subsequent
3584 message in the same SMTP connection. */
3585
3586 case ACLC_HOSTS:
3587 rc = verify_check_this_host(&arg, sender_host_cache, NULL,
55414b25
JH
3588 (sender_host_address == NULL)? US"" : sender_host_address,
3589 CUSS &host_data);
4a452c43
JH
3590 if (rc == DEFER) *log_msgptr = search_error_message;
3591 if (host_data) host_data = string_copy_malloc(host_data);
059ec3d9
PH
3592 break;
3593
3594 case ACLC_LOCAL_PARTS:
3595 rc = match_isinlist(addr->cc_local_part, &arg, 0,
3596 &localpartlist_anchor, addr->localpart_cache, MCL_LOCALPART, TRUE,
55414b25 3597 CUSS &deliver_localpart_data);
059ec3d9
PH
3598 break;
3599
6ea85e9a
PH
3600 case ACLC_LOG_REJECT_TARGET:
3601 {
3602 int logbits = 0;
3603 int sep = 0;
55414b25 3604 const uschar *s = arg;
6ea85e9a 3605 uschar *ss;
4a452c43 3606 while ((ss = string_nextinlist(&s, &sep, big_buffer, big_buffer_size)))
6ea85e9a
PH
3607 {
3608 if (Ustrcmp(ss, "main") == 0) logbits |= LOG_MAIN;
3609 else if (Ustrcmp(ss, "panic") == 0) logbits |= LOG_PANIC;
3610 else if (Ustrcmp(ss, "reject") == 0) logbits |= LOG_REJECT;
3611 else
3612 {
3613 logbits |= LOG_MAIN|LOG_REJECT;
3614 log_write(0, LOG_MAIN|LOG_PANIC, "unknown log name \"%s\" in "
3615 "\"log_reject_target\" in %s ACL", ss, acl_wherenames[where]);
3616 }
3617 }
3618 log_reject_target = logbits;
3619 }
3620 break;
3621
059ec3d9
PH
3622 case ACLC_LOGWRITE:
3623 {
3624 int logbits = 0;
55414b25 3625 const uschar *s = arg;
059ec3d9
PH
3626 if (*s == ':')
3627 {
3628 s++;
3629 while (*s != ':')
3630 {
3631 if (Ustrncmp(s, "main", 4) == 0)
3632 { logbits |= LOG_MAIN; s += 4; }
3633 else if (Ustrncmp(s, "panic", 5) == 0)
3634 { logbits |= LOG_PANIC; s += 5; }
3635 else if (Ustrncmp(s, "reject", 6) == 0)
3636 { logbits |= LOG_REJECT; s += 6; }
3637 else
3638 {
3639 logbits = LOG_MAIN|LOG_PANIC;
3640 s = string_sprintf(":unknown log name in \"%s\" in "
3641 "\"logwrite\" in %s ACL", arg, acl_wherenames[where]);
3642 }
3643 if (*s == ',') s++;
3644 }
3645 s++;
3646 }
3647 while (isspace(*s)) s++;
6ea85e9a
PH
3648
3649
059ec3d9
PH
3650 if (logbits == 0) logbits = LOG_MAIN;
3651 log_write(0, logbits, "%s", string_printing(s));
3652 }
3653 break;
8e669ac1 3654
71fafd95 3655 #ifdef WITH_CONTENT_SCAN
0f0c8159 3656 case ACLC_MALWARE: /* Run the malware backend. */
8523533c 3657 {
6ea85e9a 3658 /* Separate the regular expression and any optional parameters. */
55414b25
JH
3659 const uschar * list = arg;
3660 uschar *ss = string_nextinlist(&list, &sep, big_buffer, big_buffer_size);
0f0c8159
JH
3661 uschar *opt;
3662 BOOL defer_ok = FALSE;
3663 int timeout = 0;
3664
55414b25 3665 while ((opt = string_nextinlist(&list, &sep, NULL, 0)))
0f0c8159
JH
3666 if (strcmpic(opt, US"defer_ok") == 0)
3667 defer_ok = TRUE;
3668 else if ( strncmpic(opt, US"tmo=", 4) == 0
3669 && (timeout = readconf_readtime(opt+4, '\0', FALSE)) < 0
3670 )
3671 {
3672 *log_msgptr = string_sprintf("bad timeout value in '%s'", opt);
3673 return ERROR;
3674 }
3675
3676 rc = malware(ss, timeout);
3677 if (rc == DEFER && defer_ok)
3678 rc = FAIL; /* FAIL so that the message is passed to the next ACL */
8523533c
TK
3679 }
3680 break;
3681
3682 case ACLC_MIME_REGEX:
71fafd95 3683 rc = mime_regex(&arg);
8523533c 3684 break;
71fafd95 3685 #endif
059ec3d9 3686
b0b9dbb1
JH
3687 case ACLC_QUEUE:
3688 queue_name = string_copy_malloc(arg);
3689 break;
3690
870f6ba8 3691 case ACLC_RATELIMIT:
90fc3069 3692 rc = acl_ratelimit(arg, where, log_msgptr);
870f6ba8
TF
3693 break;
3694
059ec3d9 3695 case ACLC_RECIPIENTS:
55414b25
JH
3696 rc = match_address_list((const uschar *)addr->address, TRUE, TRUE, &arg, NULL, -1, 0,
3697 CUSS &recipient_data);
059ec3d9
PH
3698 break;
3699
71fafd95
PH
3700 #ifdef WITH_CONTENT_SCAN
3701 case ACLC_REGEX:
3702 rc = regex(&arg);
8523533c 3703 break;
71fafd95 3704 #endif
8523533c 3705
e7568d51
TL
3706 case ACLC_REMOVE_HEADER:
3707 setup_remove_header(arg);
3708 break;
3709
059ec3d9
PH
3710 case ACLC_SENDER_DOMAINS:
3711 {
3712 uschar *sdomain;
3713 sdomain = Ustrrchr(sender_address, '@');
3714 sdomain = (sdomain == NULL)? US"" : sdomain + 1;