1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2012 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* Code for handling Access Control Lists (ACLs) */
13 /* Default callout timeout */
15 #define CALLOUT_TIMEOUT_DEFAULT 30
17 /* ACL verb codes - keep in step with the table of verbs that follows */
19 enum { ACL_ACCEPT, ACL_DEFER, ACL_DENY, ACL_DISCARD, ACL_DROP, ACL_REQUIRE,
24 static uschar *verbs[] =
25 { US"accept", US"defer", US"deny", US"discard", US"drop", US"require",
28 /* For each verb, the conditions for which "message" or "log_message" are used
29 are held as a bitmap. This is to avoid expanding the strings unnecessarily. For
30 "accept", the FAIL case is used only after "endpass", but that is selected in
33 static int msgcond[] = {
34 (1<<OK) | (1<<FAIL) | (1<<FAIL_DROP), /* accept */
37 (1<<OK) | (1<<FAIL) | (1<<FAIL_DROP), /* discard */
39 (1<<FAIL) | (1<<FAIL_DROP), /* require */
43 /* ACL condition and modifier codes - keep in step with the table that
44 follows, and the cond_expand_at_top and uschar cond_modifiers tables lower
50 #ifdef EXPERIMENTAL_BRIGHTMAIL
56 #ifdef EXPERIMENTAL_DCC
59 #ifdef WITH_CONTENT_SCAN
63 #ifdef WITH_OLD_DEMIME
77 ACLC_LOG_REJECT_TARGET,
79 #ifdef WITH_CONTENT_SCAN
83 #ifdef WITH_CONTENT_SCAN
88 #ifdef WITH_CONTENT_SCAN
95 #ifdef WITH_CONTENT_SCAN
98 #ifdef EXPERIMENTAL_SPF
104 /* ACL conditions/modifiers: "delay", "control", "continue", "endpass",
105 "message", "log_message", "log_reject_target", "logwrite", and "set" are
106 modifiers that look like conditions but always return TRUE. They are used for
107 their side effects. */
109 static uschar *conditions[] = {
113 #ifdef EXPERIMENTAL_BRIGHTMAIL
119 #ifdef EXPERIMENTAL_DCC
122 #ifdef WITH_CONTENT_SCAN
126 #ifdef WITH_OLD_DEMIME
140 US"log_reject_target",
142 #ifdef WITH_CONTENT_SCAN
146 #ifdef WITH_CONTENT_SCAN
151 #ifdef WITH_CONTENT_SCAN
155 US"sender_domains", US"senders", US"set",
156 #ifdef WITH_CONTENT_SCAN
159 #ifdef EXPERIMENTAL_SPF
166 /* Return values from decode_control(); keep in step with the table of names
170 CONTROL_AUTH_UNADVERTISED,
171 #ifdef EXPERIMENTAL_BRIGHTMAIL
180 CONTROL_CASEFUL_LOCAL_PART,
181 CONTROL_CASELOWER_LOCAL_PART,
182 CONTROL_CUTTHROUGH_DELIVERY,
183 CONTROL_ENFORCE_SYNC,
184 CONTROL_NO_ENFORCE_SYNC,
188 CONTROL_SUPPRESS_LOCAL_FIXUPS,
189 #ifdef WITH_CONTENT_SCAN
190 CONTROL_NO_MBOX_UNSPOOL,
194 CONTROL_NO_MULTILINE,
195 CONTROL_NO_PIPELINING,
196 CONTROL_NO_DELAY_FLUSH,
197 CONTROL_NO_CALLOUT_FLUSH
200 /* ACL control names; keep in step with the table above! This list is used for
201 turning ids into names. The actual list of recognized names is in the variable
202 control_def controls_list[] below. The fact that there are two lists is a mess
203 and should be tidied up. */
205 static uschar *controls[] = {
206 US"allow_auth_unadvertised",
207 #ifdef EXPERIMENTAL_BRIGHTMAIL
212 US"dkim_disable_verify",
216 US"caseful_local_part",
217 US"caselower_local_part",
218 US"cutthrough_delivery",
224 US"suppress_local_fixups",
225 #ifdef WITH_CONTENT_SCAN
230 US"no_multiline_responses",
236 /* Flags to indicate for which conditions/modifiers a string expansion is done
237 at the outer level. In the other cases, expansion already occurs in the
238 checking functions. */
240 static uschar cond_expand_at_top[] = {
242 TRUE, /* add_header */
243 FALSE, /* authenticated */
244 #ifdef EXPERIMENTAL_BRIGHTMAIL
245 TRUE, /* bmi_optin */
247 TRUE, /* condition */
250 #ifdef EXPERIMENTAL_DCC
253 #ifdef WITH_CONTENT_SCAN
257 #ifdef WITH_OLD_DEMIME
261 TRUE, /* dkim_signers */
262 TRUE, /* dkim_status */
266 FALSE, /* encrypted */
269 FALSE, /* local_parts */
270 TRUE, /* log_message */
271 TRUE, /* log_reject_target */
273 #ifdef WITH_CONTENT_SCAN
277 #ifdef WITH_CONTENT_SCAN
278 TRUE, /* mime_regex */
280 TRUE, /* ratelimit */
281 FALSE, /* recipients */
282 #ifdef WITH_CONTENT_SCAN
285 TRUE, /* remove_header */
286 FALSE, /* sender_domains */
289 #ifdef WITH_CONTENT_SCAN
292 #ifdef EXPERIMENTAL_SPF
294 TRUE, /* spf_guess */
299 /* Flags to identify the modifiers */
301 static uschar cond_modifiers[] = {
303 TRUE, /* add_header */
304 FALSE, /* authenticated */
305 #ifdef EXPERIMENTAL_BRIGHTMAIL
306 TRUE, /* bmi_optin */
308 FALSE, /* condition */
311 #ifdef EXPERIMENTAL_DCC
314 #ifdef WITH_CONTENT_SCAN
318 #ifdef WITH_OLD_DEMIME
322 FALSE, /* dkim_signers */
323 FALSE, /* dkim_status */
325 FALSE, /* dnslists */
327 FALSE, /* encrypted */
330 FALSE, /* local_parts */
331 TRUE, /* log_message */
332 TRUE, /* log_reject_target */
334 #ifdef WITH_CONTENT_SCAN
338 #ifdef WITH_CONTENT_SCAN
339 FALSE, /* mime_regex */
341 FALSE, /* ratelimit */
342 FALSE, /* recipients */
343 #ifdef WITH_CONTENT_SCAN
346 TRUE, /* remove_header */
347 FALSE, /* sender_domains */
350 #ifdef WITH_CONTENT_SCAN
353 #ifdef EXPERIMENTAL_SPF
355 FALSE, /* spf_guess */
360 /* Bit map vector of which conditions and modifiers are not allowed at certain
361 times. For each condition and modifier, there's a bitmap of dis-allowed times.
362 For some, it is easier to specify the negation of a small number of allowed
365 static unsigned int cond_forbids[] = {
369 ~((1<<ACL_WHERE_MAIL)|(1<<ACL_WHERE_RCPT)| /* add_header */
370 (1<<ACL_WHERE_PREDATA)|(1<<ACL_WHERE_DATA)|
371 (1<<ACL_WHERE_MIME)|(1<<ACL_WHERE_NOTSMTP)|
373 (1<<ACL_WHERE_NOTSMTP_START)),
375 (1<<ACL_WHERE_NOTSMTP)| /* authenticated */
376 (1<<ACL_WHERE_NOTSMTP_START)|
377 (1<<ACL_WHERE_CONNECT)|(1<<ACL_WHERE_HELO),
379 #ifdef EXPERIMENTAL_BRIGHTMAIL
380 (1<<ACL_WHERE_AUTH)| /* bmi_optin */
381 (1<<ACL_WHERE_CONNECT)|(1<<ACL_WHERE_HELO)|
382 (1<<ACL_WHERE_DATA)|(1<<ACL_WHERE_MIME)|
383 (1<<ACL_WHERE_ETRN)|(1<<ACL_WHERE_EXPN)|
384 (1<<ACL_WHERE_MAILAUTH)|
385 (1<<ACL_WHERE_MAIL)|(1<<ACL_WHERE_STARTTLS)|
386 (1<<ACL_WHERE_VRFY)|(1<<ACL_WHERE_PREDATA)|
387 (1<<ACL_WHERE_NOTSMTP_START),
394 /* Certain types of control are always allowed, so we let it through
395 always and check in the control processing itself. */
399 #ifdef EXPERIMENTAL_DCC
401 ~((1<<ACL_WHERE_DATA)|(1<<ACL_WHERE_NOTSMTP)), /* dcc */
404 #ifdef WITH_CONTENT_SCAN
406 ~(1<<ACL_WHERE_MIME), /* decode */
409 (1<<ACL_WHERE_NOTQUIT), /* delay */
411 #ifdef WITH_OLD_DEMIME
413 ~((1<<ACL_WHERE_DATA)|(1<<ACL_WHERE_NOTSMTP)), /* demime */
418 ~(1<<ACL_WHERE_DKIM), /* dkim_signers */
421 ~(1<<ACL_WHERE_DKIM), /* dkim_status */
424 (1<<ACL_WHERE_NOTSMTP)| /* dnslists */
425 (1<<ACL_WHERE_NOTSMTP_START),
428 ~(1<<ACL_WHERE_RCPT), /* domains */
430 (1<<ACL_WHERE_NOTSMTP)| /* encrypted */
431 (1<<ACL_WHERE_CONNECT)|
432 (1<<ACL_WHERE_NOTSMTP_START)|
437 (1<<ACL_WHERE_NOTSMTP)| /* hosts */
438 (1<<ACL_WHERE_NOTSMTP_START),
441 ~(1<<ACL_WHERE_RCPT), /* local_parts */
445 0, /* log_reject_target */
449 #ifdef WITH_CONTENT_SCAN
451 ~((1<<ACL_WHERE_DATA)|(1<<ACL_WHERE_NOTSMTP)), /* malware */
456 #ifdef WITH_CONTENT_SCAN
458 ~(1<<ACL_WHERE_MIME), /* mime_regex */
464 ~(1<<ACL_WHERE_RCPT), /* recipients */
466 #ifdef WITH_CONTENT_SCAN
468 ~((1<<ACL_WHERE_DATA)|(1<<ACL_WHERE_NOTSMTP)| /* regex */
469 (1<<ACL_WHERE_MIME)),
473 ~((1<<ACL_WHERE_MAIL)|(1<<ACL_WHERE_RCPT)| /* remove_header */
474 (1<<ACL_WHERE_PREDATA)|(1<<ACL_WHERE_DATA)|
475 (1<<ACL_WHERE_MIME)|(1<<ACL_WHERE_NOTSMTP)|
476 (1<<ACL_WHERE_NOTSMTP_START)),
478 (1<<ACL_WHERE_AUTH)|(1<<ACL_WHERE_CONNECT)| /* sender_domains */
480 (1<<ACL_WHERE_MAILAUTH)|(1<<ACL_WHERE_QUIT)|
481 (1<<ACL_WHERE_ETRN)|(1<<ACL_WHERE_EXPN)|
482 (1<<ACL_WHERE_STARTTLS)|(1<<ACL_WHERE_VRFY),
484 (1<<ACL_WHERE_AUTH)|(1<<ACL_WHERE_CONNECT)| /* senders */
486 (1<<ACL_WHERE_MAILAUTH)|(1<<ACL_WHERE_QUIT)|
487 (1<<ACL_WHERE_ETRN)|(1<<ACL_WHERE_EXPN)|
488 (1<<ACL_WHERE_STARTTLS)|(1<<ACL_WHERE_VRFY),
492 #ifdef WITH_CONTENT_SCAN
494 ~((1<<ACL_WHERE_DATA)|(1<<ACL_WHERE_NOTSMTP)), /* spam */
497 #ifdef EXPERIMENTAL_SPF
498 (1<<ACL_WHERE_AUTH)|(1<<ACL_WHERE_CONNECT)| /* spf */
500 (1<<ACL_WHERE_MAILAUTH)|
501 (1<<ACL_WHERE_ETRN)|(1<<ACL_WHERE_EXPN)|
502 (1<<ACL_WHERE_STARTTLS)|(1<<ACL_WHERE_VRFY)|
503 (1<<ACL_WHERE_NOTSMTP)|
504 (1<<ACL_WHERE_NOTSMTP_START),
506 (1<<ACL_WHERE_AUTH)|(1<<ACL_WHERE_CONNECT)| /* spf_guess */
508 (1<<ACL_WHERE_MAILAUTH)|
509 (1<<ACL_WHERE_ETRN)|(1<<ACL_WHERE_EXPN)|
510 (1<<ACL_WHERE_STARTTLS)|(1<<ACL_WHERE_VRFY)|
511 (1<<ACL_WHERE_NOTSMTP)|
512 (1<<ACL_WHERE_NOTSMTP_START),
515 /* Certain types of verify are always allowed, so we let it through
516 always and check in the verify function itself */
522 /* Bit map vector of which controls are not allowed at certain times. For
523 each control, there's a bitmap of dis-allowed times. For some, it is easier to
524 specify the negation of a small number of allowed times. */
526 static unsigned int control_forbids[] = {
528 ~((1<<ACL_WHERE_CONNECT)|(1<<ACL_WHERE_HELO)), /* allow_auth_unadvertised */
530 #ifdef EXPERIMENTAL_BRIGHTMAIL
537 (1<<ACL_WHERE_DATA)|(1<<ACL_WHERE_NOTSMTP)| /* dkim_disable_verify */
538 (1<<ACL_WHERE_NOTSMTP_START),
541 (1<<ACL_WHERE_NOTSMTP)|
542 (1<<ACL_WHERE_NOTSMTP_START)|
543 (1<<ACL_WHERE_NOTQUIT), /* dscp */
548 ~(1<<ACL_WHERE_RCPT), /* caseful_local_part */
551 ~(1<<ACL_WHERE_RCPT), /* caselower_local_part */
554 0, /* cutthrough_delivery */
556 (1<<ACL_WHERE_NOTSMTP)| /* enforce_sync */
557 (1<<ACL_WHERE_NOTSMTP_START),
559 (1<<ACL_WHERE_NOTSMTP)| /* no_enforce_sync */
560 (1<<ACL_WHERE_NOTSMTP_START),
563 ~((1<<ACL_WHERE_MAIL)|(1<<ACL_WHERE_RCPT)| /* freeze */
564 (1<<ACL_WHERE_PREDATA)|(1<<ACL_WHERE_DATA)|
565 (1<<ACL_WHERE_NOTSMTP)|(1<<ACL_WHERE_MIME)),
568 ~((1<<ACL_WHERE_MAIL)|(1<<ACL_WHERE_RCPT)| /* queue_only */
569 (1<<ACL_WHERE_PREDATA)|(1<<ACL_WHERE_DATA)|
570 (1<<ACL_WHERE_NOTSMTP)|(1<<ACL_WHERE_MIME)),
573 ~((1<<ACL_WHERE_MAIL)|(1<<ACL_WHERE_RCPT)| /* submission */
574 (1<<ACL_WHERE_PREDATA)),
577 ~((1<<ACL_WHERE_MAIL)|(1<<ACL_WHERE_RCPT)| /* suppress_local_fixups */
578 (1<<ACL_WHERE_PREDATA)|
579 (1<<ACL_WHERE_NOTSMTP_START)),
581 #ifdef WITH_CONTENT_SCAN
583 ~((1<<ACL_WHERE_MAIL)|(1<<ACL_WHERE_RCPT)| /* no_mbox_unspool */
584 (1<<ACL_WHERE_PREDATA)|(1<<ACL_WHERE_DATA)|
585 (1<<ACL_WHERE_MIME)),
589 ~((1<<ACL_WHERE_MAIL)|(1<<ACL_WHERE_RCPT)| /* fakedefer */
590 (1<<ACL_WHERE_PREDATA)|(1<<ACL_WHERE_DATA)|
591 (1<<ACL_WHERE_MIME)),
594 ~((1<<ACL_WHERE_MAIL)|(1<<ACL_WHERE_RCPT)| /* fakereject */
595 (1<<ACL_WHERE_PREDATA)|(1<<ACL_WHERE_DATA)|
596 (1<<ACL_WHERE_MIME)),
598 (1<<ACL_WHERE_NOTSMTP)| /* no_multiline */
599 (1<<ACL_WHERE_NOTSMTP_START),
601 (1<<ACL_WHERE_NOTSMTP)| /* no_pipelining */
602 (1<<ACL_WHERE_NOTSMTP_START),
604 (1<<ACL_WHERE_NOTSMTP)| /* no_delay_flush */
605 (1<<ACL_WHERE_NOTSMTP_START),
607 (1<<ACL_WHERE_NOTSMTP)| /* no_callout_flush */
608 (1<<ACL_WHERE_NOTSMTP_START)
611 /* Structure listing various control arguments, with their characteristics. */
613 typedef struct control_def {
615 int value; /* CONTROL_xxx value */
616 BOOL has_option; /* Has /option(s) following */
619 static control_def controls_list[] = {
620 { US"allow_auth_unadvertised", CONTROL_AUTH_UNADVERTISED, FALSE },
621 #ifdef EXPERIMENTAL_BRIGHTMAIL
622 { US"bmi_run", CONTROL_BMI_RUN, FALSE },
624 { US"debug", CONTROL_DEBUG, TRUE },
626 { US"dkim_disable_verify", CONTROL_DKIM_VERIFY, FALSE },
628 { US"dscp", CONTROL_DSCP, TRUE },
629 { US"caseful_local_part", CONTROL_CASEFUL_LOCAL_PART, FALSE },
630 { US"caselower_local_part", CONTROL_CASELOWER_LOCAL_PART, FALSE },
631 { US"enforce_sync", CONTROL_ENFORCE_SYNC, FALSE },
632 { US"freeze", CONTROL_FREEZE, TRUE },
633 { US"no_callout_flush", CONTROL_NO_CALLOUT_FLUSH, FALSE },
634 { US"no_delay_flush", CONTROL_NO_DELAY_FLUSH, FALSE },
635 { US"no_enforce_sync", CONTROL_NO_ENFORCE_SYNC, FALSE },
636 { US"no_multiline_responses", CONTROL_NO_MULTILINE, FALSE },
637 { US"no_pipelining", CONTROL_NO_PIPELINING, FALSE },
638 { US"queue_only", CONTROL_QUEUE_ONLY, FALSE },
639 #ifdef WITH_CONTENT_SCAN
640 { US"no_mbox_unspool", CONTROL_NO_MBOX_UNSPOOL, FALSE },
642 { US"fakedefer", CONTROL_FAKEDEFER, TRUE },
643 { US"fakereject", CONTROL_FAKEREJECT, TRUE },
644 { US"submission", CONTROL_SUBMISSION, TRUE },
645 { US"suppress_local_fixups", CONTROL_SUPPRESS_LOCAL_FIXUPS, FALSE },
646 { US"cutthrough_delivery", CONTROL_CUTTHROUGH_DELIVERY, FALSE }
649 /* Support data structures for Client SMTP Authorization. acl_verify_csa()
650 caches its result in a tree to avoid repeated DNS queries. The result is an
651 integer code which is used as an index into the following tables of
652 explanatory strings and verification return codes. */
654 static tree_node *csa_cache = NULL;
656 enum { CSA_UNKNOWN, CSA_OK, CSA_DEFER_SRV, CSA_DEFER_ADDR,
657 CSA_FAIL_EXPLICIT, CSA_FAIL_DOMAIN, CSA_FAIL_NOADDR, CSA_FAIL_MISMATCH };
659 /* The acl_verify_csa() return code is translated into an acl_verify() return
660 code using the following table. It is OK unless the client is definitely not
661 authorized. This is because CSA is supposed to be optional for sending sites,
662 so recipients should not be too strict about checking it - especially because
663 DNS problems are quite likely to occur. It's possible to use $csa_status in
664 further ACL conditions to distinguish ok, unknown, and defer if required, but
665 the aim is to make the usual configuration simple. */
667 static int csa_return_code[] = {
669 FAIL, FAIL, FAIL, FAIL
672 static uschar *csa_status_string[] = {
673 US"unknown", US"ok", US"defer", US"defer",
674 US"fail", US"fail", US"fail", US"fail"
677 static uschar *csa_reason_string[] = {
680 US"deferred (SRV lookup failed)",
681 US"deferred (target address lookup failed)",
682 US"failed (explicit authorization required)",
683 US"failed (host name not authorized)",
684 US"failed (no authorized addresses)",
685 US"failed (client address mismatch)"
688 /* Options for the ratelimit condition. Note that there are two variants of
689 the per_rcpt option, depending on the ACL that is used to measure the rate.
690 However any ACL must be able to look up per_rcpt rates in /noupdate mode,
691 so the two variants must have the same internal representation as well as
692 the same configuration string. */
695 RATE_PER_WHAT, RATE_PER_CLASH, RATE_PER_ADDR, RATE_PER_BYTE, RATE_PER_CMD,
696 RATE_PER_CONN, RATE_PER_MAIL, RATE_PER_RCPT, RATE_PER_ALLRCPTS
699 #define RATE_SET(var,new) \
700 (((var) == RATE_PER_WHAT) ? ((var) = RATE_##new) : ((var) = RATE_PER_CLASH))
702 static uschar *ratelimit_option_string[] = {
703 US"?", US"!", US"per_addr", US"per_byte", US"per_cmd",
704 US"per_conn", US"per_mail", US"per_rcpt", US"per_rcpt"
707 /* Enable recursion between acl_check_internal() and acl_check_condition() */
709 static int acl_check_wargs(int, address_item *, uschar *, int, uschar **,
713 /*************************************************
714 * Pick out name from list *
715 *************************************************/
717 /* Use a binary chop method
724 Returns: offset in list, or -1 if not found
728 acl_checkname(uschar *name, uschar **list, int end)
734 int mid = (start + end)/2;
735 int c = Ustrcmp(name, list[mid]);
736 if (c == 0) return mid;
737 if (c < 0) end = mid; else start = mid + 1;
744 /*************************************************
745 * Read and parse one ACL *
746 *************************************************/
748 /* This function is called both from readconf in order to parse the ACLs in the
749 configuration file, and also when an ACL is encountered dynamically (e.g. as
750 the result of an expansion). It is given a function to call in order to
751 retrieve the lines of the ACL. This function handles skipping comments and
752 blank lines (where relevant).
755 func function to get next line of ACL
756 error where to put an error message
758 Returns: pointer to ACL, or NULL
759 NULL can be legal (empty ACL); in this case error will be NULL
763 acl_read(uschar *(*func)(void), uschar **error)
765 acl_block *yield = NULL;
766 acl_block **lastp = &yield;
767 acl_block *this = NULL;
768 acl_condition_block *cond;
769 acl_condition_block **condp = NULL;
774 while ((s = (*func)()) != NULL)
777 BOOL negated = FALSE;
778 uschar *saveline = s;
781 /* Conditions (but not verbs) are allowed to be negated by an initial
784 while (isspace(*s)) s++;
791 /* Read the name of a verb or a condition, or the start of a new ACL, which
792 can be started by a name, or by a macro definition. */
794 s = readconf_readname(name, sizeof(name), s);
795 if (*s == ':' || (isupper(name[0]) && *s == '=')) return yield;
797 /* If a verb is unrecognized, it may be another condition or modifier that
798 continues the previous verb. */
800 v = acl_checkname(name, verbs, sizeof(verbs)/sizeof(char *));
805 *error = string_sprintf("unknown ACL verb \"%s\" in \"%s\"", name,
817 *error = string_sprintf("malformed ACL line \"%s\"", saveline);
820 this = store_get(sizeof(acl_block));
822 lastp = &(this->next);
825 this->condition = NULL;
826 condp = &(this->condition);
827 if (*s == 0) continue; /* No condition on this line */
833 s = readconf_readname(name, sizeof(name), s); /* Condition name */
836 /* Handle a condition or modifier. */
838 c = acl_checkname(name, conditions, sizeof(conditions)/sizeof(char *));
841 *error = string_sprintf("unknown ACL condition/modifier in \"%s\"",
846 /* The modifiers may not be negated */
848 if (negated && cond_modifiers[c])
850 *error = string_sprintf("ACL error: negation is not allowed with "
851 "\"%s\"", conditions[c]);
855 /* ENDPASS may occur only with ACCEPT or DISCARD. */
857 if (c == ACLC_ENDPASS &&
858 this->verb != ACL_ACCEPT &&
859 this->verb != ACL_DISCARD)
861 *error = string_sprintf("ACL error: \"%s\" is not allowed with \"%s\"",
862 conditions[c], verbs[this->verb]);
866 cond = store_get(sizeof(acl_condition_block));
869 cond->u.negated = negated;
872 condp = &(cond->next);
874 /* The "set" modifier is different in that its argument is "name=value"
875 rather than just a value, and we can check the validity of the name, which
876 gives us a variable name to insert into the data block. The original ACL
877 variable names were acl_c0 ... acl_c9 and acl_m0 ... acl_m9. This was
878 extended to 20 of each type, but after that people successfully argued for
879 arbitrary names. In the new scheme, the names must start with acl_c or acl_m.
880 After that, we allow alphanumerics and underscores, but the first character
881 after c or m must be a digit or an underscore. This retains backwards
888 if (Ustrncmp(s, "acl_c", 5) != 0 &&
889 Ustrncmp(s, "acl_m", 5) != 0)
891 *error = string_sprintf("invalid variable name after \"set\" in ACL "
892 "modifier \"set %s\" (must start \"acl_c\" or \"acl_m\")", s);
897 if (!isdigit(*endptr) && *endptr != '_')
899 *error = string_sprintf("invalid variable name after \"set\" in ACL "
900 "modifier \"set %s\" (digit or underscore must follow acl_c or acl_m)",
905 while (*endptr != 0 && *endptr != '=' && !isspace(*endptr))
907 if (!isalnum(*endptr) && *endptr != '_')
909 *error = string_sprintf("invalid character \"%c\" in variable name "
910 "in ACL modifier \"set %s\"", *endptr, s);
916 cond->u.varname = string_copyn(s + 4, endptr - s - 4);
918 while (isspace(*s)) s++;
921 /* For "set", we are now positioned for the data. For the others, only
922 "endpass" has no data */
924 if (c != ACLC_ENDPASS)
928 *error = string_sprintf("\"=\" missing after ACL \"%s\" %s", name,
929 cond_modifiers[c]? US"modifier" : US"condition");
932 while (isspace(*s)) s++;
933 cond->arg = string_copy(s);
942 /*************************************************
943 * Set up added header line(s) *
944 *************************************************/
946 /* This function is called by the add_header modifier, and also from acl_warn()
947 to implement the now-deprecated way of adding header lines using "message" on a
948 "warn" verb. The argument is treated as a sequence of header lines which are
949 added to a chain, provided there isn't an identical one already there.
951 Argument: string of header lines
956 setup_header(uschar *hstring)
959 int hlen = Ustrlen(hstring);
961 /* Ignore any leading newlines */
962 while (*hstring == '\n') hstring++, hlen--;
964 /* An empty string does nothing; ensure exactly one final newline. */
965 if (hlen <= 0) return;
966 if (hstring[--hlen] != '\n') hstring = string_sprintf("%s\n", hstring);
967 else while(hstring[--hlen] == '\n') hstring[hlen+1] = '\0';
969 /* Loop for multiple header lines, taking care about continuations */
971 for (p = q = hstring; *p != 0; )
974 int newtype = htype_add_bot;
975 header_line **hptr = &acl_added_headers;
977 /* Find next header line within the string */
981 q = Ustrchr(q, '\n');
982 if (*(++q) != ' ' && *q != '\t') break;
985 /* If the line starts with a colon, interpret the instruction for where to
986 add it. This temporarily sets up a new type. */
990 if (strncmpic(p, US":after_received:", 16) == 0)
992 newtype = htype_add_rec;
995 else if (strncmpic(p, US":at_start_rfc:", 14) == 0)
997 newtype = htype_add_rfc;
1000 else if (strncmpic(p, US":at_start:", 10) == 0)
1002 newtype = htype_add_top;
1005 else if (strncmpic(p, US":at_end:", 8) == 0)
1007 newtype = htype_add_bot;
1010 while (*p == ' ' || *p == '\t') p++;
1013 /* See if this line starts with a header name, and if not, add X-ACL-Warn:
1014 to the front of it. */
1016 for (s = p; s < q - 1; s++)
1018 if (*s == ':' || !isgraph(*s)) break;
1021 s = string_sprintf("%s%.*s", (*s == ':')? "" : "X-ACL-Warn: ", (int) (q - p), p);
1024 /* See if this line has already been added */
1026 while (*hptr != NULL)
1028 if (Ustrncmp((*hptr)->text, s, hlen) == 0) break;
1029 hptr = &((*hptr)->next);
1032 /* Add if not previously present */
1036 header_line *h = store_get(sizeof(header_line));
1045 /* Advance for next header line within the string */
1053 /*************************************************
1054 * List the added header lines *
1055 *************************************************/
1059 uschar * ret = NULL;
1060 header_line * h = acl_added_headers;
1066 if (!h) return NULL;
1071 while ((cp = Ustrchr(s, '\n')) != NULL)
1073 if (cp[1] == '\0') break;
1075 /* contains embedded newline; needs doubling */
1076 ret = string_cat(ret, &size, &ptr, s, cp-s+1);
1077 ret = string_cat(ret, &size, &ptr, US"\n", 1);
1080 /* last bit of header */
1082 ret = string_cat(ret, &size, &ptr, s, cp-s+1); /* newline-sep list */
1084 while((h = h->next));
1086 ret[ptr-1] = '\0'; /* overwrite last newline */
1091 /*************************************************
1092 * Set up removed header line(s) *
1093 *************************************************/
1095 /* This function is called by the remove_header modifier. The argument is
1096 treated as a sequence of header names which are added to a colon separated
1097 list, provided there isn't an identical one already there.
1099 Argument: string of header names
1104 setup_remove_header(uschar *hnames)
1108 if (acl_removed_headers == NULL)
1109 acl_removed_headers = hnames;
1111 acl_removed_headers = string_sprintf("%s : %s", acl_removed_headers, hnames);
1117 /*************************************************
1119 *************************************************/
1121 /* This function is called when a WARN verb's conditions are true. It adds to
1122 the message's headers, and/or writes information to the log. In each case, this
1123 only happens once (per message for headers, per connection for log).
1125 ** NOTE: The header adding action using the "message" setting is historic, and
1126 its use is now deprecated. The new add_header modifier should be used instead.
1129 where ACL_WHERE_xxxx indicating which ACL this is
1130 user_message message for adding to headers
1131 log_message message for logging, if different
1137 acl_warn(int where, uschar *user_message, uschar *log_message)
1139 if (log_message != NULL && log_message != user_message)
1142 string_item *logged;
1144 text = string_sprintf("%s Warning: %s", host_and_ident(TRUE),
1145 string_printing(log_message));
1147 /* If a sender verification has failed, and the log message is "sender verify
1148 failed", add the failure message. */
1150 if (sender_verified_failed != NULL &&
1151 sender_verified_failed->message != NULL &&
1152 strcmpic(log_message, US"sender verify failed") == 0)
1153 text = string_sprintf("%s: %s", text, sender_verified_failed->message);
1155 /* Search previously logged warnings. They are kept in malloc
1156 store so they can be freed at the start of a new message. */
1158 for (logged = acl_warn_logged; logged != NULL; logged = logged->next)
1159 if (Ustrcmp(logged->text, text) == 0) break;
1163 int length = Ustrlen(text) + 1;
1164 log_write(0, LOG_MAIN, "%s", text);
1165 logged = store_malloc(sizeof(string_item) + length);
1166 logged->text = (uschar *)logged + sizeof(string_item);
1167 memcpy(logged->text, text, length);
1168 logged->next = acl_warn_logged;
1169 acl_warn_logged = logged;
1173 /* If there's no user message, we are done. */
1175 if (user_message == NULL) return;
1177 /* If this isn't a message ACL, we can't do anything with a user message.
1180 if (where > ACL_WHERE_NOTSMTP)
1182 log_write(0, LOG_MAIN|LOG_PANIC, "ACL \"warn\" with \"message\" setting "
1183 "found in a non-message (%s) ACL: cannot specify header lines here: "
1184 "message ignored", acl_wherenames[where]);
1188 /* The code for setting up header lines is now abstracted into a separate
1189 function so that it can be used for the add_header modifier as well. */
1191 setup_header(user_message);
1196 /*************************************************
1197 * Verify and check reverse DNS *
1198 *************************************************/
1200 /* Called from acl_verify() below. We look up the host name(s) of the client IP
1201 address if this has not yet been done. The host_name_lookup() function checks
1202 that one of these names resolves to an address list that contains the client IP
1203 address, so we don't actually have to do the check here.
1206 user_msgptr pointer for user message
1207 log_msgptr pointer for log message
1209 Returns: OK verification condition succeeded
1210 FAIL verification failed
1211 DEFER there was a problem verifying
1215 acl_verify_reverse(uschar **user_msgptr, uschar **log_msgptr)
1219 user_msgptr = user_msgptr; /* stop compiler warning */
1221 /* Previous success */
1223 if (sender_host_name != NULL) return OK;
1225 /* Previous failure */
1227 if (host_lookup_failed)
1229 *log_msgptr = string_sprintf("host lookup failed%s", host_lookup_msg);
1233 /* Need to do a lookup */
1236 debug_printf("looking up host name to force name/address consistency check\n");
1238 if ((rc = host_name_lookup()) != OK)
1240 *log_msgptr = (rc == DEFER)?
1241 US"host lookup deferred for reverse lookup check"
1243 string_sprintf("host lookup failed for reverse lookup check%s",
1245 return rc; /* DEFER or FAIL */
1248 host_build_sender_fullhost();
1254 /*************************************************
1255 * Check client IP address matches CSA target *
1256 *************************************************/
1258 /* Called from acl_verify_csa() below. This routine scans a section of a DNS
1259 response for address records belonging to the CSA target hostname. The section
1260 is specified by the reset argument, either RESET_ADDITIONAL or RESET_ANSWERS.
1261 If one of the addresses matches the client's IP address, then the client is
1262 authorized by CSA. If there are target IP addresses but none of them match
1263 then the client is using an unauthorized IP address. If there are no target IP
1264 addresses then the client cannot be using an authorized IP address. (This is
1265 an odd configuration - why didn't the SRV record have a weight of 1 instead?)
1268 dnsa the DNS answer block
1269 dnss a DNS scan block for us to use
1270 reset option specifing what portion to scan, as described above
1271 target the target hostname to use for matching RR names
1273 Returns: CSA_OK successfully authorized
1274 CSA_FAIL_MISMATCH addresses found but none matched
1275 CSA_FAIL_NOADDR no target addresses found
1279 acl_verify_csa_address(dns_answer *dnsa, dns_scan *dnss, int reset,
1285 BOOL target_found = FALSE;
1287 for (rr = dns_next_rr(dnsa, dnss, reset);
1289 rr = dns_next_rr(dnsa, dnss, RESET_NEXT))
1291 /* Check this is an address RR for the target hostname. */
1295 && rr->type != T_AAAA
1302 if (strcmpic(target, rr->name) != 0) continue;
1304 target_found = TRUE;
1306 /* Turn the target address RR into a list of textual IP addresses and scan
1307 the list. There may be more than one if it is an A6 RR. */
1309 for (da = dns_address_from_rr(dnsa, rr); da != NULL; da = da->next)
1311 /* If the client IP address matches the target IP address, it's good! */
1313 DEBUG(D_acl) debug_printf("CSA target address is %s\n", da->address);
1315 if (strcmpic(sender_host_address, da->address) == 0) return CSA_OK;
1319 /* If we found some target addresses but none of them matched, the client is
1320 using an unauthorized IP address, otherwise the target has no authorized IP
1323 if (target_found) return CSA_FAIL_MISMATCH;
1324 else return CSA_FAIL_NOADDR;
1329 /*************************************************
1330 * Verify Client SMTP Authorization *
1331 *************************************************/
1333 /* Called from acl_verify() below. This routine calls dns_lookup_special()
1334 to find the CSA SRV record corresponding to the domain argument, or
1335 $sender_helo_name if no argument is provided. It then checks that the
1336 client is authorized, and that its IP address corresponds to the SRV
1337 target's address by calling acl_verify_csa_address() above. The address
1338 should have been returned in the DNS response's ADDITIONAL section, but if
1339 not we perform another DNS lookup to get it.
1342 domain pointer to optional parameter following verify = csa
1344 Returns: CSA_UNKNOWN no valid CSA record found
1345 CSA_OK successfully authorized
1346 CSA_FAIL_* client is definitely not authorized
1347 CSA_DEFER_* there was a DNS problem
1351 acl_verify_csa(uschar *domain)
1355 int priority, weight, port;
1362 /* Work out the domain we are using for the CSA lookup. The default is the
1363 client's HELO domain. If the client has not said HELO, use its IP address
1364 instead. If it's a local client (exim -bs), CSA isn't applicable. */
1366 while (isspace(*domain) && *domain != '\0') ++domain;
1367 if (*domain == '\0') domain = sender_helo_name;
1368 if (domain == NULL) domain = sender_host_address;
1369 if (sender_host_address == NULL) return CSA_UNKNOWN;
1371 /* If we have an address literal, strip off the framing ready for turning it
1372 into a domain. The framing consists of matched square brackets possibly
1373 containing a keyword and a colon before the actual IP address. */
1375 if (domain[0] == '[')
1377 uschar *start = Ustrchr(domain, ':');
1378 if (start == NULL) start = domain;
1379 domain = string_copyn(start + 1, Ustrlen(start) - 2);
1382 /* Turn domains that look like bare IP addresses into domains in the reverse
1383 DNS. This code also deals with address literals and $sender_host_address. It's
1384 not quite kosher to treat bare domains such as EHLO 192.0.2.57 the same as
1385 address literals, but it's probably the most friendly thing to do. This is an
1386 extension to CSA, so we allow it to be turned off for proper conformance. */
1388 if (string_is_ip_address(domain, NULL) != 0)
1390 if (!dns_csa_use_reverse) return CSA_UNKNOWN;
1391 dns_build_reverse(domain, target);
1395 /* Find out if we've already done the CSA check for this domain. If we have,
1396 return the same result again. Otherwise build a new cached result structure
1397 for this domain. The name is filled in now, and the value is filled in when
1398 we return from this function. */
1400 t = tree_search(csa_cache, domain);
1401 if (t != NULL) return t->data.val;
1403 t = store_get_perm(sizeof(tree_node) + Ustrlen(domain));
1404 Ustrcpy(t->name, domain);
1405 (void)tree_insertnode(&csa_cache, t);
1407 /* Now we are ready to do the actual DNS lookup(s). */
1410 switch (dns_special_lookup(&dnsa, domain, T_CSA, &found))
1412 /* If something bad happened (most commonly DNS_AGAIN), defer. */
1415 return t->data.val = CSA_DEFER_SRV;
1417 /* If we found nothing, the client's authorization is unknown. */
1421 return t->data.val = CSA_UNKNOWN;
1423 /* We got something! Go on to look at the reply in more detail. */
1429 /* Scan the reply for well-formed CSA SRV records. */
1431 for (rr = dns_next_rr(&dnsa, &dnss, RESET_ANSWERS);
1433 rr = dns_next_rr(&dnsa, &dnss, RESET_NEXT))
1435 if (rr->type != T_SRV) continue;
1437 /* Extract the numerical SRV fields (p is incremented) */
1440 GETSHORT(priority, p);
1441 GETSHORT(weight, p);
1445 debug_printf("CSA priority=%d weight=%d port=%d\n", priority, weight, port);
1447 /* Check the CSA version number */
1449 if (priority != 1) continue;
1451 /* If the domain does not have a CSA SRV record of its own (i.e. the domain
1452 found by dns_special_lookup() is a parent of the one we asked for), we check
1453 the subdomain assertions in the port field. At the moment there's only one
1454 assertion: legitimate SMTP clients are all explicitly authorized with CSA
1455 SRV records of their own. */
1457 if (found != domain)
1460 return t->data.val = CSA_FAIL_EXPLICIT;
1462 return t->data.val = CSA_UNKNOWN;
1465 /* This CSA SRV record refers directly to our domain, so we check the value
1466 in the weight field to work out the domain's authorization. 0 and 1 are
1467 unauthorized; 3 means the client is authorized but we can't check the IP
1468 address in order to authenticate it, so we treat it as unknown; values
1469 greater than 3 are undefined. */
1471 if (weight < 2) return t->data.val = CSA_FAIL_DOMAIN;
1473 if (weight > 2) continue;
1475 /* Weight == 2, which means the domain is authorized. We must check that the
1476 client's IP address is listed as one of the SRV target addresses. Save the
1477 target hostname then break to scan the additional data for its addresses. */
1479 (void)dn_expand(dnsa.answer, dnsa.answer + dnsa.answerlen, p,
1480 (DN_EXPAND_ARG4_TYPE)target, sizeof(target));
1482 DEBUG(D_acl) debug_printf("CSA target is %s\n", target);
1487 /* If we didn't break the loop then no appropriate records were found. */
1489 if (rr == NULL) return t->data.val = CSA_UNKNOWN;
1491 /* Do not check addresses if the target is ".", in accordance with RFC 2782.
1492 A target of "." indicates there are no valid addresses, so the client cannot
1493 be authorized. (This is an odd configuration because weight=2 target=. is
1494 equivalent to weight=1, but we check for it in order to keep load off the
1495 root name servers.) Note that dn_expand() turns "." into "". */
1497 if (Ustrcmp(target, "") == 0) return t->data.val = CSA_FAIL_NOADDR;
1499 /* Scan the additional section of the CSA SRV reply for addresses belonging
1500 to the target. If the name server didn't return any additional data (e.g.
1501 because it does not fully support SRV records), we need to do another lookup
1502 to obtain the target addresses; otherwise we have a definitive result. */
1504 rc = acl_verify_csa_address(&dnsa, &dnss, RESET_ADDITIONAL, target);
1505 if (rc != CSA_FAIL_NOADDR) return t->data.val = rc;
1507 /* The DNS lookup type corresponds to the IP version used by the client. */
1510 if (Ustrchr(sender_host_address, ':') != NULL)
1513 #endif /* HAVE_IPV6 */
1517 #if HAVE_IPV6 && defined(SUPPORT_A6)
1521 switch (dns_lookup(&dnsa, target, type, NULL))
1523 /* If something bad happened (most commonly DNS_AGAIN), defer. */
1526 return t->data.val = CSA_DEFER_ADDR;
1528 /* If the query succeeded, scan the addresses and return the result. */
1531 rc = acl_verify_csa_address(&dnsa, &dnss, RESET_ANSWERS, target);
1532 if (rc != CSA_FAIL_NOADDR) return t->data.val = rc;
1533 /* else fall through */
1535 /* If the target has no IP addresses, the client cannot have an authorized
1536 IP address. However, if the target site uses A6 records (not AAAA records)
1537 we have to do yet another lookup in order to check them. */
1542 #if HAVE_IPV6 && defined(SUPPORT_A6)
1543 if (type == T_AAAA) { type = T_A6; goto DNS_LOOKUP_AGAIN; }
1546 return t->data.val = CSA_FAIL_NOADDR;
1552 /*************************************************
1553 * Handle verification (address & other) *
1554 *************************************************/
1556 enum { VERIFY_REV_HOST_LKUP, VERIFY_CERT, VERIFY_HELO, VERIFY_CSA, VERIFY_HDR_SYNTAX,
1557 VERIFY_NOT_BLIND, VERIFY_HDR_SNDR, VERIFY_SNDR, VERIFY_RCPT
1562 unsigned where_allowed; /* bitmap */
1563 BOOL no_options; /* Never has /option(s) following */
1564 unsigned alt_opt_sep; /* >0 Non-/ option separator (custom parser) */
1566 static verify_type_t verify_type_list[] = {
1567 { US"reverse_host_lookup", VERIFY_REV_HOST_LKUP, ~0, TRUE, 0 },
1568 { US"certificate", VERIFY_CERT, ~0, TRUE, 0 },
1569 { US"helo", VERIFY_HELO, ~0, TRUE, 0 },
1570 { US"csa", VERIFY_CSA, ~0, FALSE, 0 },
1571 { US"header_syntax", VERIFY_HDR_SYNTAX, (1<<ACL_WHERE_DATA)|(1<<ACL_WHERE_NOTSMTP), TRUE, 0 },
1572 { US"not_blind", VERIFY_NOT_BLIND, (1<<ACL_WHERE_DATA)|(1<<ACL_WHERE_NOTSMTP), TRUE, 0 },
1573 { US"header_sender", VERIFY_HDR_SNDR, (1<<ACL_WHERE_DATA)|(1<<ACL_WHERE_NOTSMTP), FALSE, 0 },
1574 { US"sender", VERIFY_SNDR, (1<<ACL_WHERE_MAIL)|(1<<ACL_WHERE_RCPT)
1575 |(1<<ACL_WHERE_PREDATA)|(1<<ACL_WHERE_DATA)|(1<<ACL_WHERE_NOTSMTP),
1577 { US"recipient", VERIFY_RCPT, (1<<ACL_WHERE_RCPT), FALSE, 0 }
1581 enum { CALLOUT_DEFER_OK, CALLOUT_NOCACHE, CALLOUT_RANDOM, CALLOUT_USE_SENDER,
1582 CALLOUT_USE_POSTMASTER, CALLOUT_POSTMASTER, CALLOUT_FULLPOSTMASTER,
1583 CALLOUT_MAILFROM, CALLOUT_POSTMASTER_MAILFROM, CALLOUT_MAXWAIT, CALLOUT_CONNECT,
1590 BOOL has_option; /* Has =option(s) following */
1591 BOOL timeval; /* Has a time value */
1593 static callout_opt_t callout_opt_list[] = {
1594 { US"defer_ok", CALLOUT_DEFER_OK, 0, FALSE, FALSE },
1595 { US"no_cache", CALLOUT_NOCACHE, vopt_callout_no_cache, FALSE, FALSE },
1596 { US"random", CALLOUT_RANDOM, vopt_callout_random, FALSE, FALSE },
1597 { US"use_sender", CALLOUT_USE_SENDER, vopt_callout_recipsender, FALSE, FALSE },
1598 { US"use_postmaster", CALLOUT_USE_POSTMASTER,vopt_callout_recippmaster, FALSE, FALSE },
1599 { US"postmaster_mailfrom",CALLOUT_POSTMASTER_MAILFROM,0, TRUE, FALSE },
1600 { US"postmaster", CALLOUT_POSTMASTER, 0, FALSE, FALSE },
1601 { US"fullpostmaster", CALLOUT_FULLPOSTMASTER,vopt_callout_fullpm, FALSE, FALSE },
1602 { US"mailfrom", CALLOUT_MAILFROM, 0, TRUE, FALSE },
1603 { US"maxwait", CALLOUT_MAXWAIT, 0, TRUE, TRUE },
1604 { US"connect", CALLOUT_CONNECT, 0, TRUE, TRUE },
1605 { NULL, CALLOUT_TIME, 0, FALSE, TRUE }
1610 /* This function implements the "verify" condition. It is called when
1611 encountered in any ACL, because some tests are almost always permitted. Some
1612 just don't make sense, and always fail (for example, an attempt to test a host
1613 lookup for a non-TCP/IP message). Others are restricted to certain ACLs.
1616 where where called from
1617 addr the recipient address that the ACL is handling, or NULL
1618 arg the argument of "verify"
1619 user_msgptr pointer for user message
1620 log_msgptr pointer for log message
1621 basic_errno where to put verify errno
1623 Returns: OK verification condition succeeded
1624 FAIL verification failed
1625 DEFER there was a problem verifying
1630 acl_verify(int where, address_item *addr, uschar *arg,
1631 uschar **user_msgptr, uschar **log_msgptr, int *basic_errno)
1635 int callout_overall = -1;
1636 int callout_connect = -1;
1637 int verify_options = 0;
1639 BOOL verify_header_sender = FALSE;
1640 BOOL defer_ok = FALSE;
1641 BOOL callout_defer_ok = FALSE;
1642 BOOL no_details = FALSE;
1643 BOOL success_on_redirect = FALSE;
1644 address_item *sender_vaddr = NULL;
1645 uschar *verify_sender_address = NULL;
1646 uschar *pm_mailfrom = NULL;
1647 uschar *se_mailfrom = NULL;
1649 /* Some of the verify items have slash-separated options; some do not. Diagnose
1650 an error if options are given for items that don't expect them.
1653 uschar *slash = Ustrchr(arg, '/');
1655 uschar *ss = string_nextinlist(&list, &sep, big_buffer, big_buffer_size);
1658 if (ss == NULL) goto BAD_VERIFY;
1660 /* Handle name/address consistency verification in a separate function. */
1662 for (vp= verify_type_list;
1663 (char *)vp < (char *)verify_type_list + sizeof(verify_type_list);
1666 if (vp->alt_opt_sep ? strncmpic(ss, vp->name, vp->alt_opt_sep) == 0
1667 : strcmpic (ss, vp->name) == 0)
1669 if ((char *)vp >= (char *)verify_type_list + sizeof(verify_type_list))
1672 if (vp->no_options && slash != NULL)
1674 *log_msgptr = string_sprintf("unexpected '/' found in \"%s\" "
1675 "(this verify item has no options)", arg);
1678 if (!(vp->where_allowed & (1<<where)))
1680 *log_msgptr = string_sprintf("cannot verify %s in ACL for %s", vp->name, acl_wherenames[where]);
1685 case VERIFY_REV_HOST_LKUP:
1686 if (sender_host_address == NULL) return OK;
1687 return acl_verify_reverse(user_msgptr, log_msgptr);
1690 /* TLS certificate verification is done at STARTTLS time; here we just
1691 test whether it was successful or not. (This is for optional verification; for
1692 mandatory verification, the connection doesn't last this long.) */
1694 if (tls_in.certificate_verified) return OK;
1695 *user_msgptr = US"no verified certificate";
1699 /* We can test the result of optional HELO verification that might have
1700 occurred earlier. If not, we can attempt the verification now. */
1702 if (!helo_verified && !helo_verify_failed) smtp_verify_helo();
1703 return helo_verified? OK : FAIL;
1706 /* Do Client SMTP Authorization checks in a separate function, and turn the
1707 result code into user-friendly strings. */
1709 rc = acl_verify_csa(list);
1710 *log_msgptr = *user_msgptr = string_sprintf("client SMTP authorization %s",
1711 csa_reason_string[rc]);
1712 csa_status = csa_status_string[rc];
1713 DEBUG(D_acl) debug_printf("CSA result %s\n", csa_status);
1714 return csa_return_code[rc];
1716 case VERIFY_HDR_SYNTAX:
1717 /* Check that all relevant header lines have the correct syntax. If there is
1718 a syntax error, we return details of the error to the sender if configured to
1719 send out full details. (But a "message" setting on the ACL can override, as
1722 rc = verify_check_headers(log_msgptr);
1723 if (rc != OK && smtp_return_error_details && *log_msgptr != NULL)
1724 *user_msgptr = string_sprintf("Rejected after DATA: %s", *log_msgptr);
1727 case VERIFY_NOT_BLIND:
1728 /* Check that no recipient of this message is "blind", that is, every envelope
1729 recipient must be mentioned in either To: or Cc:. */
1731 rc = verify_check_notblind();
1734 *log_msgptr = string_sprintf("bcc recipient detected");
1735 if (smtp_return_error_details)
1736 *user_msgptr = string_sprintf("Rejected after DATA: %s", *log_msgptr);
1740 /* The remaining verification tests check recipient and sender addresses,
1741 either from the envelope or from the header. There are a number of
1742 slash-separated options that are common to all of them. */
1744 case VERIFY_HDR_SNDR:
1745 verify_header_sender = TRUE;
1749 /* In the case of a sender, this can optionally be followed by an address to use
1750 in place of the actual sender (rare special-case requirement). */
1754 verify_sender_address = sender_address;
1757 while (isspace(*s)) s++;
1758 if (*s++ != '=') goto BAD_VERIFY;
1759 while (isspace(*s)) s++;
1760 verify_sender_address = string_copy(s);
1771 /* Remaining items are optional; they apply to sender and recipient
1772 verification, including "header sender" verification. */
1774 while ((ss = string_nextinlist(&list, &sep, big_buffer, big_buffer_size))
1777 if (strcmpic(ss, US"defer_ok") == 0) defer_ok = TRUE;
1778 else if (strcmpic(ss, US"no_details") == 0) no_details = TRUE;
1779 else if (strcmpic(ss, US"success_on_redirect") == 0) success_on_redirect = TRUE;
1781 /* These two old options are left for backwards compatibility */
1783 else if (strcmpic(ss, US"callout_defer_ok") == 0)
1785 callout_defer_ok = TRUE;
1786 if (callout == -1) callout = CALLOUT_TIMEOUT_DEFAULT;
1789 else if (strcmpic(ss, US"check_postmaster") == 0)
1792 if (callout == -1) callout = CALLOUT_TIMEOUT_DEFAULT;
1795 /* The callout option has a number of sub-options, comma separated */
1797 else if (strncmpic(ss, US"callout", 7) == 0)
1799 callout = CALLOUT_TIMEOUT_DEFAULT;
1803 while (isspace(*ss)) ss++;
1809 while (isspace(*ss)) ss++;
1811 while ((opt = string_nextinlist(&ss, &optsep, buffer, sizeof(buffer)))
1815 double period = 1.0F;
1817 for (op= callout_opt_list; op->name; op++)
1818 if (strncmpic(opt, op->name, Ustrlen(op->name)) == 0)
1821 verify_options |= op->flag;
1824 opt += Ustrlen(op->name);
1825 while (isspace(*opt)) opt++;
1828 *log_msgptr = string_sprintf("'=' expected after "
1829 "\"%s\" in ACL verify condition \"%s\"", op->name, arg);
1832 while (isspace(*opt)) opt++;
1836 period = readconf_readtime(opt, 0, FALSE);
1839 *log_msgptr = string_sprintf("bad time value in ACL condition "
1840 "\"verify %s\"", arg);
1847 case CALLOUT_DEFER_OK: callout_defer_ok = TRUE; break;
1848 case CALLOUT_POSTMASTER: pm_mailfrom = US""; break;
1849 case CALLOUT_FULLPOSTMASTER: pm_mailfrom = US""; break;
1850 case CALLOUT_MAILFROM:
1851 if (!verify_header_sender)
1853 *log_msgptr = string_sprintf("\"mailfrom\" is allowed as a "
1854 "callout option only for verify=header_sender (detected in ACL "
1855 "condition \"%s\")", arg);
1858 se_mailfrom = string_copy(opt);
1860 case CALLOUT_POSTMASTER_MAILFROM: pm_mailfrom = string_copy(opt); break;
1861 case CALLOUT_MAXWAIT: callout_overall = period; break;
1862 case CALLOUT_CONNECT: callout_connect = period; break;
1863 case CALLOUT_TIME: callout = period; break;
1869 *log_msgptr = string_sprintf("'=' expected after \"callout\" in "
1870 "ACL condition \"%s\"", arg);
1876 /* Option not recognized */
1880 *log_msgptr = string_sprintf("unknown option \"%s\" in ACL "
1881 "condition \"verify %s\"", ss, arg);
1886 if ((verify_options & (vopt_callout_recipsender|vopt_callout_recippmaster)) ==
1887 (vopt_callout_recipsender|vopt_callout_recippmaster))
1889 *log_msgptr = US"only one of use_sender and use_postmaster can be set "
1890 "for a recipient callout";
1894 /* Handle sender-in-header verification. Default the user message to the log
1895 message if giving out verification details. */
1897 if (verify_header_sender)
1900 rc = verify_check_header_address(user_msgptr, log_msgptr, callout,
1901 callout_overall, callout_connect, se_mailfrom, pm_mailfrom, verify_options,
1905 *basic_errno = verrno;
1906 if (smtp_return_error_details)
1908 if (*user_msgptr == NULL && *log_msgptr != NULL)
1909 *user_msgptr = string_sprintf("Rejected after DATA: %s", *log_msgptr);
1910 if (rc == DEFER) acl_temp_details = TRUE;
1915 /* Handle a sender address. The default is to verify *the* sender address, but
1916 optionally a different address can be given, for special requirements. If the
1917 address is empty, we are dealing with a bounce message that has no sender, so
1918 we cannot do any checking. If the real sender address gets rewritten during
1919 verification (e.g. DNS widening), set the flag to stop it being rewritten again
1920 during message reception.
1922 A list of verified "sender" addresses is kept to try to avoid doing to much
1923 work repetitively when there are multiple recipients in a message and they all
1924 require sender verification. However, when callouts are involved, it gets too
1925 complicated because different recipients may require different callout options.
1926 Therefore, we always do a full sender verify when any kind of callout is
1927 specified. Caching elsewhere, for instance in the DNS resolver and in the
1928 callout handling, should ensure that this is not terribly inefficient. */
1930 else if (verify_sender_address != NULL)
1932 if ((verify_options & (vopt_callout_recipsender|vopt_callout_recippmaster))
1935 *log_msgptr = US"use_sender or use_postmaster cannot be used for a "
1936 "sender verify callout";
1940 sender_vaddr = verify_checked_sender(verify_sender_address);
1941 if (sender_vaddr != NULL && /* Previously checked */
1942 callout <= 0) /* No callout needed this time */
1944 /* If the "routed" flag is set, it means that routing worked before, so
1945 this check can give OK (the saved return code value, if set, belongs to a
1946 callout that was done previously). If the "routed" flag is not set, routing
1947 must have failed, so we use the saved return code. */
1949 if (testflag(sender_vaddr, af_verify_routed)) rc = OK; else
1951 rc = sender_vaddr->special_action;
1952 *basic_errno = sender_vaddr->basic_errno;
1954 HDEBUG(D_acl) debug_printf("using cached sender verify result\n");
1957 /* Do a new verification, and cache the result. The cache is used to avoid
1958 verifying the sender multiple times for multiple RCPTs when callouts are not
1959 specified (see comments above).
1961 The cache is also used on failure to give details in response to the first
1962 RCPT that gets bounced for this reason. However, this can be suppressed by
1963 the no_details option, which sets the flag that says "this detail has already
1964 been sent". The cache normally contains just one address, but there may be
1965 more in esoteric circumstances. */
1970 uschar *save_address_data = deliver_address_data;
1972 sender_vaddr = deliver_make_addr(verify_sender_address, TRUE);
1973 if (no_details) setflag(sender_vaddr, af_sverify_told);
1974 if (verify_sender_address[0] != 0)
1976 /* If this is the real sender address, save the unrewritten version
1977 for use later in receive. Otherwise, set a flag so that rewriting the
1978 sender in verify_address() does not update sender_address. */
1980 if (verify_sender_address == sender_address)
1981 sender_address_unrewritten = sender_address;
1983 verify_options |= vopt_fake_sender;
1985 if (success_on_redirect)
1986 verify_options |= vopt_success_on_redirect;
1988 /* The recipient, qualify, and expn options are never set in
1991 rc = verify_address(sender_vaddr, NULL, verify_options, callout,
1992 callout_overall, callout_connect, se_mailfrom, pm_mailfrom, &routed);
1994 HDEBUG(D_acl) debug_printf("----------- end verify ------------\n");
1998 if (Ustrcmp(sender_vaddr->address, verify_sender_address) != 0)
2000 DEBUG(D_acl) debug_printf("sender %s verified ok as %s\n",
2001 verify_sender_address, sender_vaddr->address);
2005 DEBUG(D_acl) debug_printf("sender %s verified ok\n",
2006 verify_sender_address);
2009 else *basic_errno = sender_vaddr->basic_errno;
2011 else rc = OK; /* Null sender */
2013 /* Cache the result code */
2015 if (routed) setflag(sender_vaddr, af_verify_routed);
2016 if (callout > 0) setflag(sender_vaddr, af_verify_callout);
2017 sender_vaddr->special_action = rc;
2018 sender_vaddr->next = sender_verified_list;
2019 sender_verified_list = sender_vaddr;
2021 /* Restore the recipient address data, which might have been clobbered by
2022 the sender verification. */
2024 deliver_address_data = save_address_data;
2027 /* Put the sender address_data value into $sender_address_data */
2029 sender_address_data = sender_vaddr->p.address_data;
2032 /* A recipient address just gets a straightforward verify; again we must handle
2033 the DEFER overrides. */
2039 if (success_on_redirect)
2040 verify_options |= vopt_success_on_redirect;
2042 /* We must use a copy of the address for verification, because it might
2046 rc = verify_address(&addr2, NULL, verify_options|vopt_is_recipient, callout,
2047 callout_overall, callout_connect, se_mailfrom, pm_mailfrom, NULL);
2048 HDEBUG(D_acl) debug_printf("----------- end verify ------------\n");
2050 *basic_errno = addr2.basic_errno;
2051 *log_msgptr = addr2.message;
2052 *user_msgptr = (addr2.user_message != NULL)?
2053 addr2.user_message : addr2.message;
2055 /* Allow details for temporary error if the address is so flagged. */
2056 if (testflag((&addr2), af_pass_message)) acl_temp_details = TRUE;
2058 /* Make $address_data visible */
2059 deliver_address_data = addr2.p.address_data;
2062 /* We have a result from the relevant test. Handle defer overrides first. */
2064 if (rc == DEFER && (defer_ok ||
2065 (callout_defer_ok && *basic_errno == ERRNO_CALLOUTDEFER)))
2067 HDEBUG(D_acl) debug_printf("verify defer overridden by %s\n",
2068 defer_ok? "defer_ok" : "callout_defer_ok");
2072 /* If we've failed a sender, set up a recipient message, and point
2073 sender_verified_failed to the address item that actually failed. */
2075 if (rc != OK && verify_sender_address != NULL)
2079 *log_msgptr = *user_msgptr = US"Sender verify failed";
2081 else if (*basic_errno != ERRNO_CALLOUTDEFER)
2083 *log_msgptr = *user_msgptr = US"Could not complete sender verify";
2087 *log_msgptr = US"Could not complete sender verify callout";
2088 *user_msgptr = smtp_return_error_details? sender_vaddr->user_message :
2092 sender_verified_failed = sender_vaddr;
2095 /* Verifying an address messes up the values of $domain and $local_part,
2096 so reset them before returning if this is a RCPT ACL. */
2100 deliver_domain = addr->domain;
2101 deliver_localpart = addr->local_part;
2105 /* Syntax errors in the verify argument come here. */
2108 *log_msgptr = string_sprintf("expected \"sender[=address]\", \"recipient\", "
2109 "\"helo\", \"header_syntax\", \"header_sender\" or "
2110 "\"reverse_host_lookup\" at start of ACL condition "
2111 "\"verify %s\"", arg);
2118 /*************************************************
2119 * Check argument for control= modifier *
2120 *************************************************/
2122 /* Called from acl_check_condition() below
2125 arg the argument string for control=
2126 pptr set to point to the terminating character
2127 where which ACL we are in
2128 log_msgptr for error messages
2130 Returns: CONTROL_xxx value
2134 decode_control(uschar *arg, uschar **pptr, int where, uschar **log_msgptr)
2139 for (d = controls_list;
2140 d < controls_list + sizeof(controls_list)/sizeof(control_def);
2143 len = Ustrlen(d->name);
2144 if (Ustrncmp(d->name, arg, len) == 0) break;
2147 if (d >= controls_list + sizeof(controls_list)/sizeof(control_def) ||
2148 (arg[len] != 0 && (!d->has_option || arg[len] != '/')))
2150 *log_msgptr = string_sprintf("syntax error in \"control=%s\"", arg);
2151 return CONTROL_ERROR;
2161 /*************************************************
2162 * Return a ratelimit error *
2163 *************************************************/
2165 /* Called from acl_ratelimit() below
2168 log_msgptr for error messages
2169 format format string
2170 ... supplementary arguments
2171 ss ratelimit option name
2172 where ACL_WHERE_xxxx indicating which ACL this is
2178 ratelimit_error(uschar **log_msgptr, const char *format, ...)
2181 uschar buffer[STRING_SPRINTF_BUFFER_SIZE];
2182 va_start(ap, format);
2183 if (!string_vformat(buffer, sizeof(buffer), format, ap))
2184 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
2185 "string_sprintf expansion was longer than " SIZE_T_FMT, sizeof(buffer));
2187 *log_msgptr = string_sprintf(
2188 "error in arguments to \"ratelimit\" condition: %s", buffer);
2195 /*************************************************
2196 * Handle rate limiting *
2197 *************************************************/
2199 /* Called by acl_check_condition() below to calculate the result
2200 of the ACL ratelimit condition.
2202 Note that the return value might be slightly unexpected: if the
2203 sender's rate is above the limit then the result is OK. This is
2204 similar to the dnslists condition, and is so that you can write
2205 ACL clauses like: defer ratelimit = 15 / 1h
2208 arg the option string for ratelimit=
2209 where ACL_WHERE_xxxx indicating which ACL this is
2210 log_msgptr for error messages
2212 Returns: OK - Sender's rate is above limit
2213 FAIL - Sender's rate is below limit
2214 DEFER - Problem opening ratelimit database
2215 ERROR - Syntax error in options.
2219 acl_ratelimit(uschar *arg, int where, uschar **log_msgptr)
2221 double limit, period, count;
2224 uschar *unique = NULL;
2226 BOOL leaky = FALSE, strict = FALSE, readonly = FALSE;
2227 BOOL noupdate = FALSE, badacl = FALSE;
2228 int mode = RATE_PER_WHAT;
2230 tree_node **anchor, *t;
2231 open_db dbblock, *dbm;
2233 dbdata_ratelimit *dbd;
2234 dbdata_ratelimit_unique *dbdb;
2237 /* Parse the first two options and record their values in expansion
2238 variables. These variables allow the configuration to have informative
2239 error messages based on rate limits obtained from a table lookup. */
2241 /* First is the maximum number of messages per period / maximum burst
2242 size, which must be greater than or equal to zero. Zero is useful for
2243 rate measurement as opposed to rate limiting. */
2245 sender_rate_limit = string_nextinlist(&arg, &sep, NULL, 0);
2246 if (sender_rate_limit == NULL)
2250 limit = Ustrtod(sender_rate_limit, &ss);
2251 if (tolower(*ss) == 'k') { limit *= 1024.0; ss++; }
2252 else if (tolower(*ss) == 'm') { limit *= 1024.0*1024.0; ss++; }
2253 else if (tolower(*ss) == 'g') { limit *= 1024.0*1024.0*1024.0; ss++; }
2255 if (limit < 0.0 || *ss != '\0')
2256 return ratelimit_error(log_msgptr,
2257 "\"%s\" is not a positive number", sender_rate_limit);
2259 /* Second is the rate measurement period / exponential smoothing time
2260 constant. This must be strictly greater than zero, because zero leads to
2261 run-time division errors. */
2263 sender_rate_period = string_nextinlist(&arg, &sep, NULL, 0);
2264 if (sender_rate_period == NULL) period = -1.0;
2265 else period = readconf_readtime(sender_rate_period, 0, FALSE);
2267 return ratelimit_error(log_msgptr,
2268 "\"%s\" is not a time value", sender_rate_period);
2270 /* By default we are counting one of something, but the per_rcpt,
2271 per_byte, and count options can change this. */
2275 /* Parse the other options. */
2277 while ((ss = string_nextinlist(&arg, &sep, big_buffer, big_buffer_size))
2280 if (strcmpic(ss, US"leaky") == 0) leaky = TRUE;
2281 else if (strcmpic(ss, US"strict") == 0) strict = TRUE;
2282 else if (strcmpic(ss, US"noupdate") == 0) noupdate = TRUE;
2283 else if (strcmpic(ss, US"readonly") == 0) readonly = TRUE;
2284 else if (strcmpic(ss, US"per_cmd") == 0) RATE_SET(mode, PER_CMD);
2285 else if (strcmpic(ss, US"per_conn") == 0)
2287 RATE_SET(mode, PER_CONN);
2288 if (where == ACL_WHERE_NOTSMTP || where == ACL_WHERE_NOTSMTP_START)
2291 else if (strcmpic(ss, US"per_mail") == 0)
2293 RATE_SET(mode, PER_MAIL);
2294 if (where > ACL_WHERE_NOTSMTP) badacl = TRUE;
2296 else if (strcmpic(ss, US"per_rcpt") == 0)
2298 /* If we are running in the RCPT ACL, then we'll count the recipients
2299 one by one, but if we are running when we have accumulated the whole
2300 list then we'll add them all in one batch. */
2301 if (where == ACL_WHERE_RCPT)
2302 RATE_SET(mode, PER_RCPT);
2303 else if (where >= ACL_WHERE_PREDATA && where <= ACL_WHERE_NOTSMTP)
2304 RATE_SET(mode, PER_ALLRCPTS), count = (double)recipients_count;
2305 else if (where == ACL_WHERE_MAIL || where > ACL_WHERE_NOTSMTP)
2306 RATE_SET(mode, PER_RCPT), badacl = TRUE;
2308 else if (strcmpic(ss, US"per_byte") == 0)
2310 /* If we have not yet received the message data and there was no SIZE
2311 declaration on the MAIL comand, then it's safe to just use a value of
2312 zero and let the recorded rate decay as if nothing happened. */
2313 RATE_SET(mode, PER_MAIL);
2314 if (where > ACL_WHERE_NOTSMTP) badacl = TRUE;
2315 else count = message_size < 0 ? 0.0 : (double)message_size;
2317 else if (strcmpic(ss, US"per_addr") == 0)
2319 RATE_SET(mode, PER_RCPT);
2320 if (where != ACL_WHERE_RCPT) badacl = TRUE, unique = US"*";
2321 else unique = string_sprintf("%s@%s", deliver_localpart, deliver_domain);
2323 else if (strncmpic(ss, US"count=", 6) == 0)
2326 count = Ustrtod(ss+6, &e);
2327 if (count < 0.0 || *e != '\0')
2328 return ratelimit_error(log_msgptr,
2329 "\"%s\" is not a positive number", ss);
2331 else if (strncmpic(ss, US"unique=", 7) == 0)
2332 unique = string_copy(ss + 7);
2333 else if (key == NULL)
2334 key = string_copy(ss);
2336 key = string_sprintf("%s/%s", key, ss);
2339 /* Sanity check. When the badacl flag is set the update mode must either
2340 be readonly (which is the default if it is omitted) or, for backwards
2341 compatibility, a combination of noupdate and strict or leaky. */
2343 if (mode == RATE_PER_CLASH)
2344 return ratelimit_error(log_msgptr, "conflicting per_* options");
2345 if (leaky + strict + readonly > 1)
2346 return ratelimit_error(log_msgptr, "conflicting update modes");
2347 if (badacl && (leaky || strict) && !noupdate)
2348 return ratelimit_error(log_msgptr,
2349 "\"%s\" must not have /leaky or /strict option in %s ACL",
2350 ratelimit_option_string[mode], acl_wherenames[where]);
2352 /* Set the default values of any unset options. In readonly mode we
2353 perform the rate computation without any increment so that its value
2354 decays to eventually allow over-limit senders through. */
2356 if (noupdate) readonly = TRUE, leaky = strict = FALSE;
2357 if (badacl) readonly = TRUE;
2358 if (readonly) count = 0.0;
2359 if (!strict && !readonly) leaky = TRUE;
2360 if (mode == RATE_PER_WHAT) mode = RATE_PER_MAIL;
2362 /* Create the lookup key. If there is no explicit key, use sender_host_address.
2363 If there is no sender_host_address (e.g. -bs or acl_not_smtp) then we simply
2364 omit it. The smoothing constant (sender_rate_period) and the per_xxx options
2365 are added to the key because they alter the meaning of the stored data. */
2368 key = (sender_host_address == NULL)? US"" : sender_host_address;
2370 key = string_sprintf("%s/%s/%s%s",
2372 ratelimit_option_string[mode],
2373 unique == NULL ? "" : "unique/",
2377 debug_printf("ratelimit condition count=%.0f %.1f/%s\n", count, limit, key);
2379 /* See if we have already computed the rate by looking in the relevant tree.
2380 For per-connection rate limiting, store tree nodes and dbdata in the permanent
2381 pool so that they survive across resets. In readonly mode we only remember the
2382 result for the rest of this command in case a later command changes it. After
2383 this bit of logic the code is independent of the per_* mode. */
2385 old_pool = store_pool;
2388 anchor = &ratelimiters_cmd;
2391 anchor = &ratelimiters_conn;
2392 store_pool = POOL_PERM;
2396 case RATE_PER_ALLRCPTS:
2397 anchor = &ratelimiters_mail;
2402 anchor = &ratelimiters_cmd;
2405 anchor = NULL; /* silence an "unused" complaint */
2406 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
2407 "internal ACL error: unknown ratelimit mode %d", mode);
2411 t = tree_search(*anchor, key);
2415 /* The following few lines duplicate some of the code below. */
2416 rc = (dbd->rate < limit)? FAIL : OK;
2417 store_pool = old_pool;
2418 sender_rate = string_sprintf("%.1f", dbd->rate);
2420 debug_printf("ratelimit found pre-computed rate %s\n", sender_rate);
2424 /* We aren't using a pre-computed rate, so get a previously recorded rate
2425 from the database, which will be updated and written back if required. */
2427 dbm = dbfn_open(US"ratelimit", O_RDWR, &dbblock, TRUE);
2430 store_pool = old_pool;
2432 HDEBUG(D_acl) debug_printf("ratelimit database not available\n");
2433 *log_msgptr = US"ratelimit database not available";
2436 dbdb = dbfn_read_with_length(dbm, key, &dbdb_size);
2439 gettimeofday(&tv, NULL);
2443 /* Locate the basic ratelimit block inside the DB data. */
2444 HDEBUG(D_acl) debug_printf("ratelimit found key in database\n");
2447 /* Forget the old Bloom filter if it is too old, so that we count each
2448 repeating event once per period. We don't simply clear and re-use the old
2449 filter because we want its size to change if the limit changes. Note that
2450 we keep the dbd pointer for copying the rate into the new data block. */
2452 if(unique != NULL && tv.tv_sec > dbdb->bloom_epoch + period)
2454 HDEBUG(D_acl) debug_printf("ratelimit discarding old Bloom filter\n");
2460 if(unique != NULL && dbdb_size < sizeof(*dbdb))
2462 HDEBUG(D_acl) debug_printf("ratelimit discarding undersize Bloom filter\n");
2467 /* Allocate a new data block if the database lookup failed
2468 or the Bloom filter passed its age limit. */
2474 /* No Bloom filter. This basic ratelimit block is initialized below. */
2475 HDEBUG(D_acl) debug_printf("ratelimit creating new rate data block\n");
2476 dbdb_size = sizeof(*dbd);
2477 dbdb = store_get(dbdb_size);
2482 HDEBUG(D_acl) debug_printf("ratelimit creating new Bloom filter\n");
2484 /* See the long comment below for an explanation of the magic number 2.
2485 The filter has a minimum size in case the rate limit is very small;
2486 this is determined by the definition of dbdata_ratelimit_unique. */
2488 extra = (int)limit * 2 - sizeof(dbdb->bloom);
2489 if (extra < 0) extra = 0;
2490 dbdb_size = sizeof(*dbdb) + extra;
2491 dbdb = store_get(dbdb_size);
2492 dbdb->bloom_epoch = tv.tv_sec;
2493 dbdb->bloom_size = sizeof(dbdb->bloom) + extra;
2494 memset(dbdb->bloom, 0, dbdb->bloom_size);
2496 /* Preserve any basic ratelimit data (which is our longer-term memory)
2497 by copying it from the discarded block. */
2507 /* If we are counting unique events, find out if this event is new or not.
2508 If the client repeats the event during the current period then it should be
2509 counted. We skip this code in readonly mode for efficiency, because any
2510 changes to the filter will be discarded and because count is already set to
2513 if (unique != NULL && !readonly)
2515 /* We identify unique events using a Bloom filter. (You can find my
2516 notes on Bloom filters at http://fanf.livejournal.com/81696.html)
2517 With the per_addr option, an "event" is a recipient address, though the
2518 user can use the unique option to define their own events. We only count
2519 an event if we have not seen it before.
2521 We size the filter according to the rate limit, which (in leaky mode)
2522 is the limit on the population of the filter. We allow 16 bits of space
2523 per entry (see the construction code above) and we set (up to) 8 of them
2524 when inserting an element (see the loop below). The probability of a false
2525 positive (an event we have not seen before but which we fail to count) is
2529 allzero = exp(-numhash * pop / size)
2530 = exp(-0.5 * pop / limit)
2531 fpr = pow(1 - allzero, numhash)
2533 For senders at the limit the fpr is 0.06% or 1 in 1700
2534 and for senders at half the limit it is 0.0006% or 1 in 170000
2536 In strict mode the Bloom filter can fill up beyond the normal limit, in
2537 which case the false positive rate will rise. This means that the
2538 measured rate for very fast senders can bogusly drop off after a while.
2540 At twice the limit, the fpr is 2.5% or 1 in 40
2541 At four times the limit, it is 31% or 1 in 3.2
2543 It takes ln(pop/limit) periods for an over-limit burst of pop events to
2544 decay below the limit, and if this is more than one then the Bloom filter
2545 will be discarded before the decay gets that far. The false positive rate
2546 at this threshold is 9.3% or 1 in 10.7. */
2549 unsigned n, hash, hinc;
2553 /* Instead of using eight independent hash values, we combine two values
2554 using the formula h1 + n * h2. This does not harm the Bloom filter's
2555 performance, and means the amount of hash we need is independent of the
2556 number of bits we set in the filter. */
2558 md5_start(&md5info);
2559 md5_end(&md5info, unique, Ustrlen(unique), md5sum);
2560 hash = md5sum[0] | md5sum[1] << 8 | md5sum[2] << 16 | md5sum[3] << 24;
2561 hinc = md5sum[4] | md5sum[5] << 8 | md5sum[6] << 16 | md5sum[7] << 24;
2563 /* Scan the bits corresponding to this event. A zero bit means we have
2564 not seen it before. Ensure all bits are set to record this event. */
2566 HDEBUG(D_acl) debug_printf("ratelimit checking uniqueness of %s\n", unique);
2569 for (n = 0; n < 8; n++, hash += hinc)
2571 int bit = 1 << (hash % 8);
2572 int byte = (hash / 8) % dbdb->bloom_size;
2573 if ((dbdb->bloom[byte] & bit) == 0)
2575 dbdb->bloom[byte] |= bit;
2580 /* If this event has occurred before, do not count it. */
2584 HDEBUG(D_acl) debug_printf("ratelimit event found in Bloom filter\n");
2588 HDEBUG(D_acl) debug_printf("ratelimit event added to Bloom filter\n");
2591 /* If there was no previous ratelimit data block for this key, initialize
2592 the new one, otherwise update the block from the database. The initial rate
2593 is what would be computed by the code below for an infinite interval. */
2597 HDEBUG(D_acl) debug_printf("ratelimit initializing new key's rate data\n");
2599 dbd->time_stamp = tv.tv_sec;
2600 dbd->time_usec = tv.tv_usec;
2605 /* The smoothed rate is computed using an exponentially weighted moving
2606 average adjusted for variable sampling intervals. The standard EWMA for
2607 a fixed sampling interval is: f'(t) = (1 - a) * f(t) + a * f'(t - 1)
2608 where f() is the measured value and f'() is the smoothed value.
2610 Old data decays out of the smoothed value exponentially, such that data n
2611 samples old is multiplied by a^n. The exponential decay time constant p
2612 is defined such that data p samples old is multiplied by 1/e, which means
2613 that a = exp(-1/p). We can maintain the same time constant for a variable
2614 sampling interval i by using a = exp(-i/p).
2616 The rate we are measuring is messages per period, suitable for directly
2617 comparing with the limit. The average rate between now and the previous
2618 message is period / interval, which we feed into the EWMA as the sample.
2620 It turns out that the number of messages required for the smoothed rate
2621 to reach the limit when they are sent in a burst is equal to the limit.
2622 This can be seen by analysing the value of the smoothed rate after N
2623 messages sent at even intervals. Let k = (1 - a) * p/i
2625 rate_1 = (1 - a) * p/i + a * rate_0
2627 rate_2 = k + a * rate_1
2628 = k + a * k + a^2 * rate_0
2629 rate_3 = k + a * k + a^2 * k + a^3 * rate_0
2630 rate_N = rate_0 * a^N + k * SUM(x=0..N-1)(a^x)
2631 = rate_0 * a^N + k * (1 - a^N) / (1 - a)
2632 = rate_0 * a^N + p/i * (1 - a^N)
2634 When N is large, a^N -> 0 so rate_N -> p/i as desired.
2636 rate_N = p/i + (rate_0 - p/i) * a^N
2637 a^N = (rate_N - p/i) / (rate_0 - p/i)
2638 N * -i/p = log((rate_N - p/i) / (rate_0 - p/i))
2639 N = p/i * log((rate_0 - p/i) / (rate_N - p/i))
2641 Numerical analysis of the above equation, setting the computed rate to
2642 increase from rate_0 = 0 to rate_N = limit, shows that for large sending
2643 rates, p/i, the number of messages N = limit. So limit serves as both the
2644 maximum rate measured in messages per period, and the maximum number of
2645 messages that can be sent in a fast burst. */
2647 double this_time = (double)tv.tv_sec
2648 + (double)tv.tv_usec / 1000000.0;
2649 double prev_time = (double)dbd->time_stamp
2650 + (double)dbd->time_usec / 1000000.0;
2652 /* We must avoid division by zero, and deal gracefully with the clock going
2653 backwards. If we blunder ahead when time is in reverse then the computed
2654 rate will be bogus. To be safe we clamp interval to a very small number. */
2656 double interval = this_time - prev_time <= 0.0 ? 1e-9
2657 : this_time - prev_time;
2659 double i_over_p = interval / period;
2660 double a = exp(-i_over_p);
2662 /* Combine the instantaneous rate (period / interval) with the previous rate
2663 using the smoothing factor a. In order to measure sized events, multiply the
2664 instantaneous rate by the count of bytes or recipients etc. */
2666 dbd->time_stamp = tv.tv_sec;
2667 dbd->time_usec = tv.tv_usec;
2668 dbd->rate = (1 - a) * count / i_over_p + a * dbd->rate;
2670 /* When events are very widely spaced the computed rate tends towards zero.
2671 Although this is accurate it turns out not to be useful for our purposes,
2672 especially when the first event after a long silence is the start of a spam
2673 run. A more useful model is that the rate for an isolated event should be the
2674 size of the event per the period size, ignoring the lack of events outside
2675 the current period and regardless of where the event falls in the period. So,
2676 if the interval was so long that the calculated rate is unhelpfully small, we
2677 re-intialize the rate. In the absence of higher-rate bursts, the condition
2678 below is true if the interval is greater than the period. */
2680 if (dbd->rate < count) dbd->rate = count;
2683 /* Clients sending at the limit are considered to be over the limit.
2684 This matters for edge cases such as a limit of zero, when the client
2685 should be completely blocked. */
2687 rc = (dbd->rate < limit)? FAIL : OK;
2689 /* Update the state if the rate is low or if we are being strict. If we
2690 are in leaky mode and the sender's rate is too high, we do not update
2691 the recorded rate in order to avoid an over-aggressive sender's retry
2692 rate preventing them from getting any email through. If readonly is set,
2693 neither leaky nor strict are set, so we do not do any updates. */
2695 if ((rc == FAIL && leaky) || strict)
2697 dbfn_write(dbm, key, dbdb, dbdb_size);
2698 HDEBUG(D_acl) debug_printf("ratelimit db updated\n");
2702 HDEBUG(D_acl) debug_printf("ratelimit db not updated: %s\n",
2703 readonly? "readonly mode" : "over the limit, but leaky");
2708 /* Store the result in the tree for future reference. */
2710 t = store_get(sizeof(tree_node) + Ustrlen(key));
2712 Ustrcpy(t->name, key);
2713 (void)tree_insertnode(anchor, t);
2715 /* We create the formatted version of the sender's rate very late in
2716 order to ensure that it is done using the correct storage pool. */
2718 store_pool = old_pool;
2719 sender_rate = string_sprintf("%.1f", dbd->rate);
2722 debug_printf("ratelimit computed rate %s\n", sender_rate);
2729 /*************************************************
2730 * Handle conditions/modifiers on an ACL item *
2731 *************************************************/
2733 /* Called from acl_check() below.
2737 cb ACL condition block - if NULL, result is OK
2738 where where called from
2739 addr the address being checked for RCPT, or NULL
2740 level the nesting level
2741 epp pointer to pass back TRUE if "endpass" encountered
2742 (applies only to "accept" and "discard")
2743 user_msgptr user message pointer
2744 log_msgptr log message pointer
2745 basic_errno pointer to where to put verify error
2747 Returns: OK - all conditions are met
2748 DISCARD - an "acl" condition returned DISCARD - only allowed
2749 for "accept" or "discard" verbs
2750 FAIL - at least one condition fails
2751 FAIL_DROP - an "acl" condition returned FAIL_DROP
2752 DEFER - can't tell at the moment (typically, lookup defer,
2753 but can be temporary callout problem)
2754 ERROR - ERROR from nested ACL or expansion failure or other
2759 acl_check_condition(int verb, acl_condition_block *cb, int where,
2760 address_item *addr, int level, BOOL *epp, uschar **user_msgptr,
2761 uschar **log_msgptr, int *basic_errno)
2763 uschar *user_message = NULL;
2764 uschar *log_message = NULL;
2765 uschar *debug_tag = NULL;
2766 uschar *debug_opts = NULL;
2769 #ifdef WITH_CONTENT_SCAN
2773 for (; cb != NULL; cb = cb->next)
2778 /* The message and log_message items set up messages to be used in
2779 case of rejection. They are expanded later. */
2781 if (cb->type == ACLC_MESSAGE)
2783 user_message = cb->arg;
2787 if (cb->type == ACLC_LOG_MESSAGE)
2789 log_message = cb->arg;
2793 /* The endpass "condition" just sets a flag to show it occurred. This is
2794 checked at compile time to be on an "accept" or "discard" item. */
2796 if (cb->type == ACLC_ENDPASS)
2802 /* For other conditions and modifiers, the argument is expanded now for some
2803 of them, but not for all, because expansion happens down in some lower level
2804 checking functions in some cases. */
2806 if (cond_expand_at_top[cb->type])
2808 arg = expand_string(cb->arg);
2811 if (expand_string_forcedfail) continue;
2812 *log_msgptr = string_sprintf("failed to expand ACL string \"%s\": %s",
2813 cb->arg, expand_string_message);
2814 return search_find_defer? DEFER : ERROR;
2819 /* Show condition, and expanded condition if it's different */
2824 debug_printf("check %s%s %n",
2825 (!cond_modifiers[cb->type] && cb->u.negated)? "!":"",
2826 conditions[cb->type], &lhswidth);
2828 if (cb->type == ACLC_SET)
2830 debug_printf("acl_%s ", cb->u.varname);
2831 lhswidth += 5 + Ustrlen(cb->u.varname);
2834 debug_printf("= %s\n", cb->arg);
2837 debug_printf("%.*s= %s\n", lhswidth,
2841 /* Check that this condition makes sense at this time */
2843 if ((cond_forbids[cb->type] & (1 << where)) != 0)
2845 *log_msgptr = string_sprintf("cannot %s %s condition in %s ACL",
2846 cond_modifiers[cb->type]? "use" : "test",
2847 conditions[cb->type], acl_wherenames[where]);
2851 /* Run the appropriate test for each condition, or take the appropriate
2852 action for the remaining modifiers. */
2856 case ACLC_ADD_HEADER:
2860 /* A nested ACL that returns "discard" makes sense only for an "accept" or
2864 rc = acl_check_wargs(where, addr, arg, level+1, user_msgptr, log_msgptr);
2865 if (rc == DISCARD && verb != ACL_ACCEPT && verb != ACL_DISCARD)
2867 *log_msgptr = string_sprintf("nested ACL returned \"discard\" for "
2868 "\"%s\" command (only allowed with \"accept\" or \"discard\")",
2874 case ACLC_AUTHENTICATED:
2875 rc = (sender_host_authenticated == NULL)? FAIL :
2876 match_isinlist(sender_host_authenticated, &arg, 0, NULL, NULL, MCL_STRING,
2880 #ifdef EXPERIMENTAL_BRIGHTMAIL
2881 case ACLC_BMI_OPTIN:
2883 int old_pool = store_pool;
2884 store_pool = POOL_PERM;
2885 bmi_current_optin = string_copy(arg);
2886 store_pool = old_pool;
2891 case ACLC_CONDITION:
2892 /* The true/false parsing here should be kept in sync with that used in
2893 expand.c when dealing with ECOND_BOOL so that we don't have too many
2894 different definitions of what can be a boolean. */
2895 if (Ustrspn(arg, "0123456789") == Ustrlen(arg)) /* Digits, or empty */
2896 rc = (Uatoi(arg) == 0)? FAIL : OK;
2898 rc = (strcmpic(arg, US"no") == 0 ||
2899 strcmpic(arg, US"false") == 0)? FAIL :
2900 (strcmpic(arg, US"yes") == 0 ||
2901 strcmpic(arg, US"true") == 0)? OK : DEFER;
2903 *log_msgptr = string_sprintf("invalid \"condition\" value \"%s\"", arg);
2906 case ACLC_CONTINUE: /* Always succeeds */
2910 control_type = decode_control(arg, &p, where, log_msgptr);
2912 /* Check if this control makes sense at this time */
2914 if ((control_forbids[control_type] & (1 << where)) != 0)
2916 *log_msgptr = string_sprintf("cannot use \"control=%s\" in %s ACL",
2917 controls[control_type], acl_wherenames[where]);
2921 switch(control_type)
2923 case CONTROL_AUTH_UNADVERTISED:
2924 allow_auth_unadvertised = TRUE;
2927 #ifdef EXPERIMENTAL_BRIGHTMAIL
2928 case CONTROL_BMI_RUN:
2933 #ifndef DISABLE_DKIM
2934 case CONTROL_DKIM_VERIFY:
2935 dkim_disable_verify = TRUE;
2942 int fd, af, level, optname, value;
2943 /* If we are acting on stdin, the setsockopt may fail if stdin is not
2944 a socket; we can accept that, we'll just debug-log failures anyway. */
2945 fd = fileno(smtp_in);
2946 af = ip_get_address_family(fd);
2950 debug_printf("smtp input is probably not a socket [%s], not setting DSCP\n",
2954 if (dscp_lookup(p+1, af, &level, &optname, &value))
2956 if (setsockopt(fd, level, optname, &value, sizeof(value)) < 0)
2958 HDEBUG(D_acl) debug_printf("failed to set input DSCP[%s]: %s\n",
2959 p+1, strerror(errno));
2963 HDEBUG(D_acl) debug_printf("set input DSCP to \"%s\"\n", p+1);
2968 *log_msgptr = string_sprintf("unrecognised DSCP value in \"control=%s\"", arg);
2974 *log_msgptr = string_sprintf("syntax error in \"control=%s\"", arg);
2982 case CONTROL_CASEFUL_LOCAL_PART:
2983 deliver_localpart = addr->cc_local_part;
2986 case CONTROL_CASELOWER_LOCAL_PART:
2987 deliver_localpart = addr->lc_local_part;
2990 case CONTROL_ENFORCE_SYNC:
2991 smtp_enforce_sync = TRUE;
2994 case CONTROL_NO_ENFORCE_SYNC:
2995 smtp_enforce_sync = FALSE;
2998 #ifdef WITH_CONTENT_SCAN
2999 case CONTROL_NO_MBOX_UNSPOOL:
3000 no_mbox_unspool = TRUE;
3004 case CONTROL_NO_MULTILINE:
3005 no_multiline_responses = TRUE;
3008 case CONTROL_NO_PIPELINING:
3009 pipelining_enable = FALSE;
3012 case CONTROL_NO_DELAY_FLUSH:
3013 disable_delay_flush = TRUE;
3016 case CONTROL_NO_CALLOUT_FLUSH:
3017 disable_callout_flush = TRUE;
3020 case CONTROL_FAKEDEFER:
3021 case CONTROL_FAKEREJECT:
3022 fake_response = (control_type == CONTROL_FAKEDEFER) ? DEFER : FAIL;
3026 while (*pp != 0) pp++;
3027 fake_response_text = expand_string(string_copyn(p+1, pp-p-1));
3032 /* Explicitly reset to default string */
3033 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).";
3037 case CONTROL_FREEZE:
3038 deliver_freeze = TRUE;
3039 deliver_frozen_at = time(NULL);
3040 freeze_tell = freeze_tell_config; /* Reset to configured value */
3041 if (Ustrncmp(p, "/no_tell", 8) == 0)
3048 *log_msgptr = string_sprintf("syntax error in \"control=%s\"", arg);
3053 case CONTROL_QUEUE_ONLY:
3054 queue_only_policy = TRUE;
3057 case CONTROL_SUBMISSION:
3058 originator_name = US"";
3059 submission_mode = TRUE;
3062 if (Ustrncmp(p, "/sender_retain", 14) == 0)
3065 active_local_sender_retain = TRUE;
3066 active_local_from_check = FALSE;
3068 else if (Ustrncmp(p, "/domain=", 8) == 0)
3071 while (*pp != 0 && *pp != '/') pp++;
3072 submission_domain = string_copyn(p+8, pp-p-8);
3075 /* The name= option must be last, because it swallows the rest of
3077 else if (Ustrncmp(p, "/name=", 6) == 0)
3080 while (*pp != 0) pp++;
3081 submission_name = string_copy(parse_fix_phrase(p+6, pp-p-6,
3082 big_buffer, big_buffer_size));
3089 *log_msgptr = string_sprintf("syntax error in \"control=%s\"", arg);
3097 if (Ustrncmp(p, "/tag=", 5) == 0)
3100 while (*pp != '\0' && *pp != '/') pp++;
3101 debug_tag = string_copyn(p+5, pp-p-5);
3104 else if (Ustrncmp(p, "/opts=", 6) == 0)
3107 while (*pp != '\0' && *pp != '/') pp++;
3108 debug_opts = string_copyn(p+6, pp-p-6);
3112 debug_logging_activate(debug_tag, debug_opts);
3115 case CONTROL_SUPPRESS_LOCAL_FIXUPS:
3116 suppress_local_fixups = TRUE;
3119 case CONTROL_CUTTHROUGH_DELIVERY:
3122 *log_msgptr = string_sprintf("\"control=%s\" on frozen item", arg);
3125 if (queue_only_policy)
3127 *log_msgptr = string_sprintf("\"control=%s\" on queue-only item", arg);
3130 cutthrough_delivery = TRUE;
3135 #ifdef EXPERIMENTAL_DCC
3138 /* Seperate the regular expression and any optional parameters. */
3139 uschar *ss = string_nextinlist(&arg, &sep, big_buffer, big_buffer_size);
3140 /* Run the dcc backend. */
3141 rc = dcc_process(&ss);
3142 /* Modify return code based upon the existance of options. */
3143 while ((ss = string_nextinlist(&arg, &sep, big_buffer, big_buffer_size))
3145 if (strcmpic(ss, US"defer_ok") == 0 && rc == DEFER)
3147 /* FAIL so that the message is passed to the next ACL */
3155 #ifdef WITH_CONTENT_SCAN
3157 rc = mime_decode(&arg);
3163 int delay = readconf_readtime(arg, 0, FALSE);
3166 *log_msgptr = string_sprintf("syntax error in argument for \"delay\" "
3167 "modifier: \"%s\" is not a time value", arg);
3172 HDEBUG(D_acl) debug_printf("delay modifier requests %d-second delay\n",
3177 debug_printf("delay skipped in -bh checking mode\n");
3180 /* It appears to be impossible to detect that a TCP/IP connection has
3181 gone away without reading from it. This means that we cannot shorten
3182 the delay below if the client goes away, because we cannot discover
3183 that the client has closed its end of the connection. (The connection
3184 is actually in a half-closed state, waiting for the server to close its
3185 end.) It would be nice to be able to detect this state, so that the
3186 Exim process is not held up unnecessarily. However, it seems that we
3187 can't. The poll() function does not do the right thing, and in any case
3188 it is not always available.
3190 NOTE 1: If ever this state of affairs changes, remember that we may be
3191 dealing with stdin/stdout here, in addition to TCP/IP connections.
3192 Also, delays may be specified for non-SMTP input, where smtp_out and
3193 smtp_in will be NULL. Whatever is done must work in all cases.
3195 NOTE 2: The added feature of flushing the output before a delay must
3196 apply only to SMTP input. Hence the test for smtp_out being non-NULL.
3201 if (smtp_out != NULL && !disable_delay_flush) mac_smtp_fflush();
3202 while (delay > 0) delay = sleep(delay);
3208 #ifdef WITH_OLD_DEMIME
3214 #ifndef DISABLE_DKIM
3215 case ACLC_DKIM_SIGNER:
3216 if (dkim_cur_signer != NULL)
3217 rc = match_isinlist(dkim_cur_signer,
3218 &arg,0,NULL,NULL,MCL_STRING,TRUE,NULL);
3223 case ACLC_DKIM_STATUS:
3224 rc = match_isinlist(dkim_exim_expand_query(DKIM_VERIFY_STATUS),
3225 &arg,0,NULL,NULL,MCL_STRING,TRUE,NULL);
3230 rc = verify_check_dnsbl(&arg);
3234 rc = match_isinlist(addr->domain, &arg, 0, &domainlist_anchor,
3235 addr->domain_cache, MCL_DOMAIN, TRUE, &deliver_domain_data);
3238 /* The value in tls_cipher is the full cipher name, for example,
3239 TLSv1:DES-CBC3-SHA:168, whereas the values to test for are just the
3240 cipher names such as DES-CBC3-SHA. But program defensively. We don't know
3241 what may in practice come out of the SSL library - which at the time of
3242 writing is poorly documented. */
3244 case ACLC_ENCRYPTED:
3245 if (tls_in.cipher == NULL) rc = FAIL; else
3247 uschar *endcipher = NULL;
3248 uschar *cipher = Ustrchr(tls_in.cipher, ':');
3249 if (cipher == NULL) cipher = tls_in.cipher; else
3251 endcipher = Ustrchr(++cipher, ':');
3252 if (endcipher != NULL) *endcipher = 0;
3254 rc = match_isinlist(cipher, &arg, 0, NULL, NULL, MCL_STRING, TRUE, NULL);
3255 if (endcipher != NULL) *endcipher = ':';
3259 /* Use verify_check_this_host() instead of verify_check_host() so that
3260 we can pass over &host_data to catch any looked up data. Once it has been
3261 set, it retains its value so that it's still there if another ACL verb
3262 comes through here and uses the cache. However, we must put it into
3263 permanent store in case it is also expected to be used in a subsequent
3264 message in the same SMTP connection. */
3267 rc = verify_check_this_host(&arg, sender_host_cache, NULL,
3268 (sender_host_address == NULL)? US"" : sender_host_address, &host_data);
3269 if (host_data != NULL) host_data = string_copy_malloc(host_data);
3272 case ACLC_LOCAL_PARTS:
3273 rc = match_isinlist(addr->cc_local_part, &arg, 0,
3274 &localpartlist_anchor, addr->localpart_cache, MCL_LOCALPART, TRUE,
3275 &deliver_localpart_data);
3278 case ACLC_LOG_REJECT_TARGET:
3284 while ((ss = string_nextinlist(&s, &sep, big_buffer, big_buffer_size))
3287 if (Ustrcmp(ss, "main") == 0) logbits |= LOG_MAIN;
3288 else if (Ustrcmp(ss, "panic") == 0) logbits |= LOG_PANIC;
3289 else if (Ustrcmp(ss, "reject") == 0) logbits |= LOG_REJECT;
3292 logbits |= LOG_MAIN|LOG_REJECT;
3293 log_write(0, LOG_MAIN|LOG_PANIC, "unknown log name \"%s\" in "
3294 "\"log_reject_target\" in %s ACL", ss, acl_wherenames[where]);
3297 log_reject_target = logbits;
3310 if (Ustrncmp(s, "main", 4) == 0)
3311 { logbits |= LOG_MAIN; s += 4; }
3312 else if (Ustrncmp(s, "panic", 5) == 0)
3313 { logbits |= LOG_PANIC; s += 5; }
3314 else if (Ustrncmp(s, "reject", 6) == 0)
3315 { logbits |= LOG_REJECT; s += 6; }
3318 logbits = LOG_MAIN|LOG_PANIC;
3319 s = string_sprintf(":unknown log name in \"%s\" in "
3320 "\"logwrite\" in %s ACL", arg, acl_wherenames[where]);
3326 while (isspace(*s)) s++;
3329 if (logbits == 0) logbits = LOG_MAIN;
3330 log_write(0, logbits, "%s", string_printing(s));
3334 #ifdef WITH_CONTENT_SCAN
3337 /* Separate the regular expression and any optional parameters. */
3338 uschar *ss = string_nextinlist(&arg, &sep, big_buffer, big_buffer_size);
3339 /* Run the malware backend. */
3341 /* Modify return code based upon the existance of options. */
3342 while ((ss = string_nextinlist(&arg, &sep, big_buffer, big_buffer_size))
3344 if (strcmpic(ss, US"defer_ok") == 0 && rc == DEFER)
3346 /* FAIL so that the message is passed to the next ACL */
3353 case ACLC_MIME_REGEX:
3354 rc = mime_regex(&arg);
3358 case ACLC_RATELIMIT:
3359 rc = acl_ratelimit(arg, where, log_msgptr);
3362 case ACLC_RECIPIENTS:
3363 rc = match_address_list(addr->address, TRUE, TRUE, &arg, NULL, -1, 0,
3367 #ifdef WITH_CONTENT_SCAN
3373 case ACLC_REMOVE_HEADER:
3374 setup_remove_header(arg);
3377 case ACLC_SENDER_DOMAINS:
3380 sdomain = Ustrrchr(sender_address, '@');
3381 sdomain = (sdomain == NULL)? US"" : sdomain + 1;
3382 rc = match_isinlist(sdomain, &arg, 0, &domainlist_anchor,
3383 sender_domain_cache, MCL_DOMAIN, TRUE, NULL);
3388 rc = match_address_list(sender_address, TRUE, TRUE, &arg,
3389 sender_address_cache, -1, 0, &sender_data);
3392 /* Connection variables must persist forever */
3396 int old_pool = store_pool;
3397 if (cb->u.varname[0] == 'c') store_pool = POOL_PERM;
3398 acl_var_create(cb->u.varname)->data.ptr = string_copy(arg);
3399 store_pool = old_pool;
3403 #ifdef WITH_CONTENT_SCAN
3406 /* Seperate the regular expression and any optional parameters. */
3407 uschar *ss = string_nextinlist(&arg, &sep, big_buffer, big_buffer_size);
3408 /* Run the spam backend. */
3410 /* Modify return code based upon the existance of options. */
3411 while ((ss = string_nextinlist(&arg, &sep, big_buffer, big_buffer_size))
3413 if (strcmpic(ss, US"defer_ok") == 0 && rc == DEFER)
3415 /* FAIL so that the message is passed to the next ACL */
3423 #ifdef EXPERIMENTAL_SPF
3425 rc = spf_process(&arg, sender_address, SPF_PROCESS_NORMAL);
3427 case ACLC_SPF_GUESS:
3428 rc = spf_process(&arg, sender_address, SPF_PROCESS_GUESS);
3432 /* If the verb is WARN, discard any user message from verification, because
3433 such messages are SMTP responses, not header additions. The latter come
3434 only from explicit "message" modifiers. However, put the user message into
3435 $acl_verify_message so it can be used in subsequent conditions or modifiers
3436 (until something changes it). */
3439 rc = acl_verify(where, addr, arg, user_msgptr, log_msgptr, basic_errno);
3440 acl_verify_message = *user_msgptr;
3441 if (verb == ACL_WARN) *user_msgptr = NULL;
3445 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "internal ACL error: unknown "
3446 "condition %d", cb->type);
3450 /* If a condition was negated, invert OK/FAIL. */
3452 if (!cond_modifiers[cb->type] && cb->u.negated)
3454 if (rc == OK) rc = FAIL;
3455 else if (rc == FAIL || rc == FAIL_DROP) rc = OK;
3458 if (rc != OK) break; /* Conditions loop */
3462 /* If the result is the one for which "message" and/or "log_message" are used,
3463 handle the values of these modifiers. If there isn't a log message set, we make
3464 it the same as the user message.
3466 "message" is a user message that will be included in an SMTP response. Unless
3467 it is empty, it overrides any previously set user message.
3469 "log_message" is a non-user message, and it adds to any existing non-user
3470 message that is already set.
3472 Most verbs have but a single return for which the messages are relevant, but
3473 for "discard", it's useful to have the log message both when it succeeds and
3474 when it fails. For "accept", the message is used in the OK case if there is no
3475 "endpass", but (for backwards compatibility) in the FAIL case if "endpass" is
3478 if (*epp && rc == OK) user_message = NULL;
3480 if (((1<<rc) & msgcond[verb]) != 0)
3483 uschar *old_user_msgptr = *user_msgptr;
3484 uschar *old_log_msgptr = (*log_msgptr != NULL)? *log_msgptr : old_user_msgptr;
3486 /* If the verb is "warn", messages generated by conditions (verification or
3487 nested ACLs) are always discarded. This also happens for acceptance verbs
3488 when they actually do accept. Only messages specified at this level are used.
3489 However, the value of an existing message is available in $acl_verify_message
3490 during expansions. */
3492 if (verb == ACL_WARN ||
3493 (rc == OK && (verb == ACL_ACCEPT || verb == ACL_DISCARD)))
3494 *log_msgptr = *user_msgptr = NULL;
3496 if (user_message != NULL)
3498 acl_verify_message = old_user_msgptr;
3499 expmessage = expand_string(user_message);
3500 if (expmessage == NULL)
3502 if (!expand_string_forcedfail)
3503 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand ACL message \"%s\": %s",
3504 user_message, expand_string_message);
3506 else if (expmessage[0] != 0) *user_msgptr = expmessage;
3509 if (log_message != NULL)
3511 acl_verify_message = old_log_msgptr;
3512 expmessage = expand_string(log_message);
3513 if (expmessage == NULL)
3515 if (!expand_string_forcedfail)
3516 log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand ACL message \"%s\": %s",
3517 log_message, expand_string_message);
3519 else if (expmessage[0] != 0)
3521 *log_msgptr = (*log_msgptr == NULL)? expmessage :
3522 string_sprintf("%s: %s", expmessage, *log_msgptr);
3526 /* If no log message, default it to the user message */
3528 if (*log_msgptr == NULL) *log_msgptr = *user_msgptr;
3531 acl_verify_message = NULL;
3539 /*************************************************
3540 * Get line from a literal ACL *
3541 *************************************************/
3543 /* This function is passed to acl_read() in order to extract individual lines
3544 of a literal ACL, which we access via static pointers. We can destroy the
3545 contents because this is called only once (the compiled ACL is remembered).
3547 This code is intended to treat the data in the same way as lines in the main
3548 Exim configuration file. That is:
3550 . Leading spaces are ignored.
3552 . A \ at the end of a line is a continuation - trailing spaces after the \
3553 are permitted (this is because I don't believe in making invisible things
3554 significant). Leading spaces on the continued part of a line are ignored.
3556 . Physical lines starting (significantly) with # are totally ignored, and
3557 may appear within a sequence of backslash-continued lines.
3559 . Blank lines are ignored, but will end a sequence of continuations.
3562 Returns: a pointer to the next line
3566 static uschar *acl_text; /* Current pointer in the text */
3567 static uschar *acl_text_end; /* Points one past the terminating '0' */
3575 /* This loop handles leading blank lines and comments. */
3579 while (isspace(*acl_text)) acl_text++; /* Leading spaces/empty lines */
3580 if (*acl_text == 0) return NULL; /* No more data */
3581 yield = acl_text; /* Potential data line */
3583 while (*acl_text != 0 && *acl_text != '\n') acl_text++;
3585 /* If we hit the end before a newline, we have the whole logical line. If
3586 it's a comment, there's no more data to be given. Otherwise, yield it. */
3588 if (*acl_text == 0) return (*yield == '#')? NULL : yield;
3590 /* After reaching a newline, end this loop if the physical line does not
3591 start with '#'. If it does, it's a comment, and the loop continues. */
3593 if (*yield != '#') break;
3596 /* This loop handles continuations. We know we have some real data, ending in
3597 newline. See if there is a continuation marker at the end (ignoring trailing
3598 white space). We know that *yield is not white space, so no need to test for
3599 cont > yield in the backwards scanning loop. */
3604 for (cont = acl_text - 1; isspace(*cont); cont--);
3606 /* If no continuation follows, we are done. Mark the end of the line and
3615 /* We have encountered a continuation. Skip over whitespace at the start of
3616 the next line, and indeed the whole of the next line or lines if they are
3621 while (*(++acl_text) == ' ' || *acl_text == '\t');
3622 if (*acl_text != '#') break;
3623 while (*(++acl_text) != 0 && *acl_text != '\n');
3626 /* We have the start of a continuation line. Move all the rest of the data
3627 to join onto the previous line, and then find its end. If the end is not a
3628 newline, we are done. Otherwise loop to look for another continuation. */
3630 memmove(cont, acl_text, acl_text_end - acl_text);
3631 acl_text_end -= acl_text - cont;
3633 while (*acl_text != 0 && *acl_text != '\n') acl_text++;
3634 if (*acl_text == 0) return yield;
3637 /* Control does not reach here */
3644 /*************************************************
3645 * Check access using an ACL *
3646 *************************************************/
3648 /* This function is called from address_check. It may recurse via
3649 acl_check_condition() - hence the use of a level to stop looping. The ACL is
3650 passed as a string which is expanded. A forced failure implies no access check
3651 is required. If the result is a single word, it is taken as the name of an ACL
3652 which is sought in the global ACL tree. Otherwise, it is taken as literal ACL
3653 text, complete with newlines, and parsed as such. In both cases, the ACL check
3654 is then run. This function uses an auxiliary function for acl_read() to call
3655 for reading individual lines of a literal ACL. This is acl_getline(), which
3656 appears immediately above.
3659 where where called from
3660 addr address item when called from RCPT; otherwise NULL
3661 s the input string; NULL is the same as an empty ACL => DENY
3662 level the nesting level
3663 user_msgptr where to put a user error (for SMTP response)
3664 log_msgptr where to put a logging message (not for SMTP response)
3666 Returns: OK access is granted
3667 DISCARD access is apparently granted...
3668 FAIL access is denied
3669 FAIL_DROP access is denied; drop the connection
3670 DEFER can't tell at the moment
3675 acl_check_internal(int where, address_item *addr, uschar *s, int level,
3676 uschar **user_msgptr, uschar **log_msgptr)
3679 acl_block *acl = NULL;
3680 uschar *acl_name = US"inline ACL";
3683 /* Catch configuration loops */
3687 *log_msgptr = US"ACL nested too deep: possible loop";
3693 HDEBUG(D_acl) debug_printf("ACL is NULL: implicit DENY\n");
3697 /* At top level, we expand the incoming string. At lower levels, it has already
3698 been expanded as part of condition processing. */
3702 ss = expand_string(s);
3705 if (expand_string_forcedfail) return OK;
3706 *log_msgptr = string_sprintf("failed to expand ACL string \"%s\": %s", s,
3707 expand_string_message);
3713 while (isspace(*ss))ss++;
3715 /* If we can't find a named ACL, the default is to parse it as an inline one.
3716 (Unless it begins with a slash; non-existent files give rise to an error.) */
3720 /* Handle the case of a string that does not contain any spaces. Look for a
3721 named ACL among those read from the configuration, or a previously read file.
3722 It is possible that the pointer to the ACL is NULL if the configuration
3723 contains a name with no data. If not found, and the text begins with '/',
3724 read an ACL from a file, and save it so it can be re-used. */
3726 if (Ustrchr(ss, ' ') == NULL)
3728 tree_node *t = tree_search(acl_anchor, ss);
3731 acl = (acl_block *)(t->data.ptr);
3734 HDEBUG(D_acl) debug_printf("ACL \"%s\" is empty: implicit DENY\n", ss);
3737 acl_name = string_sprintf("ACL \"%s\"", ss);
3738 HDEBUG(D_acl) debug_printf("using ACL \"%s\"\n", ss);
3741 else if (*ss == '/')
3743 struct stat statbuf;
3744 fd = Uopen(ss, O_RDONLY, 0);
3747 *log_msgptr = string_sprintf("failed to open ACL file \"%s\": %s", ss,
3752 if (fstat(fd, &statbuf) != 0)
3754 *log_msgptr = string_sprintf("failed to fstat ACL file \"%s\": %s", ss,
3759 acl_text = store_get(statbuf.st_size + 1);
3760 acl_text_end = acl_text + statbuf.st_size + 1;
3762 if (read(fd, acl_text, statbuf.st_size) != statbuf.st_size)
3764 *log_msgptr = string_sprintf("failed to read ACL file \"%s\": %s",
3765 ss, strerror(errno));
3768 acl_text[statbuf.st_size] = 0;
3771 acl_name = string_sprintf("ACL \"%s\"", ss);
3772 HDEBUG(D_acl) debug_printf("read ACL from file %s\n", ss);
3776 /* Parse an ACL that is still in text form. If it came from a file, remember it
3777 in the ACL tree, having read it into the POOL_PERM store pool so that it
3778 persists between multiple messages. */
3782 int old_pool = store_pool;
3783 if (fd >= 0) store_pool = POOL_PERM;
3784 acl = acl_read(acl_getline, log_msgptr);
3785 store_pool = old_pool;
3786 if (acl == NULL && *log_msgptr != NULL) return ERROR;
3789 tree_node *t = store_get_perm(sizeof(tree_node) + Ustrlen(ss));
3790 Ustrcpy(t->name, ss);
3792 (void)tree_insertnode(&acl_anchor, t);
3796 /* Now we have an ACL to use. It's possible it may be NULL. */
3801 int basic_errno = 0;
3802 BOOL endpass_seen = FALSE;
3804 *log_msgptr = *user_msgptr = NULL;
3805 acl_temp_details = FALSE;
3807 if ((where == ACL_WHERE_QUIT || where == ACL_WHERE_NOTQUIT) &&
3808 acl->verb != ACL_ACCEPT &&
3809 acl->verb != ACL_WARN)
3811 *log_msgptr = string_sprintf("\"%s\" is not allowed in a QUIT or not-QUIT ACL",
3816 HDEBUG(D_acl) debug_printf("processing \"%s\"\n", verbs[acl->verb]);
3818 /* Clear out any search error message from a previous check before testing
3821 search_error_message = NULL;
3822 cond = acl_check_condition(acl->verb, acl->condition, where, addr, level,
3823 &endpass_seen, user_msgptr, log_msgptr, &basic_errno);
3825 /* Handle special returns: DEFER causes a return except on a WARN verb;
3826 ERROR always causes a return. */
3831 HDEBUG(D_acl) debug_printf("%s: condition test deferred in %s\n", verbs[acl->verb], acl_name);
3832 if (basic_errno != ERRNO_CALLOUTDEFER)
3834 if (search_error_message != NULL && *search_error_message != 0)
3835 *log_msgptr = search_error_message;
3836 if (smtp_return_error_details) acl_temp_details = TRUE;
3840 acl_temp_details = TRUE;
3842 if (acl->verb != ACL_WARN) return DEFER;
3845 default: /* Paranoia */
3847 HDEBUG(D_acl) debug_printf("%s: condition test error in %s\n", verbs[acl->verb], acl_name);
3851 HDEBUG(D_acl) debug_printf("%s: condition test succeeded in %s\n",
3852 verbs[acl->verb], acl_name);
3856 HDEBUG(D_acl) debug_printf("%s: condition test failed in %s\n", verbs[acl->verb], acl_name);
3859 /* DISCARD and DROP can happen only from a nested ACL condition, and
3860 DISCARD can happen only for an "accept" or "discard" verb. */
3863 HDEBUG(D_acl) debug_printf("%s: condition test yielded \"discard\" in %s\n",
3864 verbs[acl->verb], acl_name);
3868 HDEBUG(D_acl) debug_printf("%s: condition test yielded \"drop\" in %s\n",
3869 verbs[acl->verb], acl_name);
3873 /* At this point, cond for most verbs is either OK or FAIL or (as a result of
3874 a nested ACL condition) FAIL_DROP. However, for WARN, cond may be DEFER, and
3875 for ACCEPT and DISCARD, it may be DISCARD after a nested ACL call. */
3880 if (cond == OK || cond == DISCARD) return cond;
3883 HDEBUG(D_acl) debug_printf("accept: endpass encountered - denying access\n");
3891 acl_temp_details = TRUE;
3897 if (cond == OK) return FAIL;
3901 if (cond == OK || cond == DISCARD) return DISCARD;
3904 HDEBUG(D_acl) debug_printf("discard: endpass encountered - denying access\n");
3910 if (cond == OK) return FAIL_DROP;
3914 if (cond != OK) return cond;
3919 acl_warn(where, *user_msgptr, *log_msgptr);
3920 else if (cond == DEFER && (log_extra_selector & LX_acl_warn_skipped) != 0)
3921 log_write(0, LOG_MAIN, "%s Warning: ACL \"warn\" statement skipped: "
3922 "condition test deferred%s%s", host_and_ident(TRUE),
3923 (*log_msgptr == NULL)? US"" : US": ",
3924 (*log_msgptr == NULL)? US"" : *log_msgptr);
3925 *log_msgptr = *user_msgptr = NULL; /* In case implicit DENY follows */
3929 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "internal ACL error: unknown verb %d",
3934 /* Pass to the next ACL item */
3939 /* We have reached the end of the ACL. This is an implicit DENY. */
3941 HDEBUG(D_acl) debug_printf("end of %s: implicit DENY\n", acl_name);
3948 /* Same args as acl_check_internal() above, but the string s is
3949 the name of an ACL followed optionally by up to 9 space-separated arguments.
3950 The name and args are separately expanded. Args go into $acl_arg globals. */
3952 acl_check_wargs(int where, address_item *addr, uschar *s, int level,
3953 uschar **user_msgptr, uschar **log_msgptr)
3956 uschar * tmp_arg[9]; /* must match acl_arg[] */
3957 uschar * sav_arg[9]; /* must match acl_arg[] */
3963 if (!(tmp = string_dequote(&s)) || !(name = expand_string(tmp)))
3966 for (i = 0; i < 9; i++)
3968 while (*s && isspace(*s)) s++;
3970 if (!(tmp = string_dequote(&s)) || !(tmp_arg[i] = expand_string(tmp)))
3977 sav_narg = acl_narg;
3979 for (i = 0; i < acl_narg; i++)
3981 sav_arg[i] = acl_arg[i];
3982 acl_arg[i] = tmp_arg[i];
3986 sav_arg[i] = acl_arg[i];
3987 acl_arg[i++] = NULL;
3990 ret = acl_check_internal(where, addr, name, level, user_msgptr, log_msgptr);
3992 acl_narg = sav_narg;
3993 for (i = 0; i < 9; i++) acl_arg[i] = sav_arg[i];
3997 if (expand_string_forcedfail) return ERROR;
3998 *log_msgptr = string_sprintf("failed to expand ACL string \"%s\": %s",
3999 tmp, expand_string_message);
4000 return search_find_defer?DEFER:ERROR;
4005 /*************************************************
4006 * Check access using an ACL *
4007 *************************************************/
4009 /* Alternate interface for ACL, used by expansions */
4011 acl_eval(int where, uschar *recipient, uschar *s, uschar **user_msgptr,
4012 uschar **log_msgptr)
4016 address_item *addr = NULL;
4018 *user_msgptr = *log_msgptr = NULL;
4019 sender_verified_failed = NULL;
4020 ratelimiters_cmd = NULL;
4021 log_reject_target = LOG_MAIN|LOG_REJECT;
4023 if (where == ACL_WHERE_RCPT)
4025 adb = address_defaults;
4027 addr->address = recipient;
4028 if (deliver_split_address(addr) == DEFER)
4030 *log_msgptr = US"defer in percent_hack_domains check";
4033 deliver_domain = addr->domain;
4034 deliver_localpart = addr->local_part;
4037 return acl_check_internal(where, addr, s, 0, user_msgptr, log_msgptr);
4042 /* This is the external interface for ACL checks. It sets up an address and the
4043 expansions for $domain and $local_part when called after RCPT, then calls
4044 acl_check_internal() to do the actual work.
4047 where ACL_WHERE_xxxx indicating where called from
4048 recipient RCPT address for RCPT check, else NULL
4049 s the input string; NULL is the same as an empty ACL => DENY
4050 user_msgptr where to put a user error (for SMTP response)
4051 log_msgptr where to put a logging message (not for SMTP response)
4053 Returns: OK access is granted by an ACCEPT verb
4054 DISCARD access is granted by a DISCARD verb
4055 FAIL access is denied
4056 FAIL_DROP access is denied; drop the connection
4057 DEFER can't tell at the moment
4060 int acl_where = ACL_WHERE_UNKNOWN;
4063 acl_check(int where, uschar *recipient, uschar *s, uschar **user_msgptr,
4064 uschar **log_msgptr)
4068 address_item *addr = NULL;
4070 *user_msgptr = *log_msgptr = NULL;
4071 sender_verified_failed = NULL;
4072 ratelimiters_cmd = NULL;
4073 log_reject_target = LOG_MAIN|LOG_REJECT;
4075 if (where == ACL_WHERE_RCPT)
4077 adb = address_defaults;
4079 addr->address = recipient;
4080 if (deliver_split_address(addr) == DEFER)
4082 *log_msgptr = US"defer in percent_hack_domains check";
4085 deliver_domain = addr->domain;
4086 deliver_localpart = addr->local_part;
4090 rc = acl_check_internal(where, addr, s, 0, user_msgptr, log_msgptr);
4091 acl_where = ACL_WHERE_UNKNOWN;
4093 /* Cutthrough - if requested,
4094 and WHERE_RCPT and not yet opened conn as result of recipient-verify,
4095 and rcpt acl returned accept,
4096 and first recipient (cancel on any subsequents)
4097 open one now and run it up to RCPT acceptance.
4098 A failed verify should cancel cutthrough request.
4100 Initial implementation: dual-write to spool.
4101 Assume the rxd datastream is now being copied byte-for-byte to an open cutthrough connection.
4103 Cease cutthrough copy on rxd final dot; do not send one.
4105 On a data acl, if not accept and a cutthrough conn is open, hard-close it (no SMTP niceness).
4107 On data acl accept, terminate the dataphase on an open cutthrough conn. If accepted or
4108 perm-rejected, reflect that to the original sender - and dump the spooled copy.
4109 If temp-reject, close the conn (and keep the spooled copy).
4110 If conn-failure, no action (and keep the spooled copy).
4114 case ACL_WHERE_RCPT:
4115 if( rcpt_count > 1 )
4116 cancel_cutthrough_connection("more than one recipient");
4117 else if (rc == OK && cutthrough_delivery && cutthrough_fd < 0)
4118 open_cutthrough_connection(addr);
4121 case ACL_WHERE_PREDATA:
4123 cutthrough_predata();
4125 cancel_cutthrough_connection("predata acl not ok");
4128 case ACL_WHERE_QUIT:
4129 case ACL_WHERE_NOTQUIT:
4130 cancel_cutthrough_connection("quit or notquit");
4137 deliver_domain = deliver_localpart = deliver_address_data =
4138 sender_address_data = NULL;
4140 /* A DISCARD response is permitted only for message ACLs, excluding the PREDATA
4141 ACL, which is really in the middle of an SMTP command. */
4145 if (where > ACL_WHERE_NOTSMTP || where == ACL_WHERE_PREDATA)
4147 log_write(0, LOG_MAIN|LOG_PANIC, "\"discard\" verb not allowed in %s "
4148 "ACL", acl_wherenames[where]);
4154 /* A DROP response is not permitted from MAILAUTH */
4156 if (rc == FAIL_DROP && where == ACL_WHERE_MAILAUTH)
4158 log_write(0, LOG_MAIN|LOG_PANIC, "\"drop\" verb not allowed in %s "
4159 "ACL", acl_wherenames[where]);
4163 /* Before giving a response, take a look at the length of any user message, and
4164 split it up into multiple lines if possible. */
4166 *user_msgptr = string_split_message(*user_msgptr);
4167 if (fake_response != OK)
4168 fake_response_text = string_split_message(fake_response_text);
4174 /*************************************************
4175 * Create ACL variable *
4176 *************************************************/
4178 /* Create an ACL variable or reuse an existing one. ACL variables are in a
4179 binary tree (see tree.c) with acl_var_c and acl_var_m as root nodes.
4182 name pointer to the variable's name, starting with c or m
4184 Returns the pointer to variable's tree node
4188 acl_var_create(uschar *name)
4190 tree_node *node, **root;
4191 root = (name[0] == 'c')? &acl_var_c : &acl_var_m;
4192 node = tree_search(*root, name);
4195 node = store_get(sizeof(tree_node) + Ustrlen(name));
4196 Ustrcpy(node->name, name);
4197 (void)tree_insertnode(root, node);
4199 node->data.ptr = NULL;
4205 /*************************************************
4206 * Write an ACL variable in spool format *
4207 *************************************************/
4209 /* This function is used as a callback for tree_walk when writing variables to
4210 the spool file. To retain spool file compatibility, what is written is -aclc or
4211 -aclm followed by the rest of the name and the data length, space separated,
4212 then the value itself, starting on a new line, and terminated by an additional
4213 newline. When we had only numbered ACL variables, the first line might look
4214 like this: "-aclc 5 20". Now it might be "-aclc foo 20" for the variable called
4218 name of the variable
4219 value of the variable
4220 ctx FILE pointer (as a void pointer)
4226 acl_var_write(uschar *name, uschar *value, void *ctx)
4228 FILE *f = (FILE *)ctx;
4229 fprintf(f, "-acl%c %s %d\n%s\n", name[0], name+1, Ustrlen(value), value);