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