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 /* An empty string does nothing; otherwise add a final newline if necessary. */
963 if (hlen
<= 0) return;
964 if (hstring
[hlen
-1] != '\n') hstring
= string_sprintf("%s\n", hstring
);
966 /* Loop for multiple header lines, taking care about continuations */
968 for (p
= q
= hstring
; *p
!= 0; )
971 int newtype
= htype_add_bot
;
972 header_line
**hptr
= &acl_added_headers
;
974 /* Find next header line within the string */
978 q
= Ustrchr(q
, '\n');
979 if (*(++q
) != ' ' && *q
!= '\t') break;
982 /* If the line starts with a colon, interpret the instruction for where to
983 add it. This temporarily sets up a new type. */
987 if (strncmpic(p
, US
":after_received:", 16) == 0)
989 newtype
= htype_add_rec
;
992 else if (strncmpic(p
, US
":at_start_rfc:", 14) == 0)
994 newtype
= htype_add_rfc
;
997 else if (strncmpic(p
, US
":at_start:", 10) == 0)
999 newtype
= htype_add_top
;
1002 else if (strncmpic(p
, US
":at_end:", 8) == 0)
1004 newtype
= htype_add_bot
;
1007 while (*p
== ' ' || *p
== '\t') p
++;
1010 /* See if this line starts with a header name, and if not, add X-ACL-Warn:
1011 to the front of it. */
1013 for (s
= p
; s
< q
- 1; s
++)
1015 if (*s
== ':' || !isgraph(*s
)) break;
1018 s
= string_sprintf("%s%.*s", (*s
== ':')? "" : "X-ACL-Warn: ", (int) (q
- p
), p
);
1021 /* See if this line has already been added */
1023 while (*hptr
!= NULL
)
1025 if (Ustrncmp((*hptr
)->text
, s
, hlen
) == 0) break;
1026 hptr
= &((*hptr
)->next
);
1029 /* Add if not previously present */
1033 header_line
*h
= store_get(sizeof(header_line
));
1042 /* Advance for next header line within the string */
1050 /*************************************************
1051 * Set up removed header line(s) *
1052 *************************************************/
1054 /* This function is called by the remove_header modifier. The argument is
1055 treated as a sequence of header names which are added to a colon separated
1056 list, provided there isn't an identical one already there.
1058 Argument: string of header names
1063 setup_remove_header(uschar
*hnames
)
1067 if (acl_removed_headers
== NULL
)
1068 acl_removed_headers
= hnames
;
1070 acl_removed_headers
= string_sprintf("%s : %s", acl_removed_headers
, hnames
);
1076 /*************************************************
1078 *************************************************/
1080 /* This function is called when a WARN verb's conditions are true. It adds to
1081 the message's headers, and/or writes information to the log. In each case, this
1082 only happens once (per message for headers, per connection for log).
1084 ** NOTE: The header adding action using the "message" setting is historic, and
1085 its use is now deprecated. The new add_header modifier should be used instead.
1088 where ACL_WHERE_xxxx indicating which ACL this is
1089 user_message message for adding to headers
1090 log_message message for logging, if different
1096 acl_warn(int where
, uschar
*user_message
, uschar
*log_message
)
1098 if (log_message
!= NULL
&& log_message
!= user_message
)
1101 string_item
*logged
;
1103 text
= string_sprintf("%s Warning: %s", host_and_ident(TRUE
),
1104 string_printing(log_message
));
1106 /* If a sender verification has failed, and the log message is "sender verify
1107 failed", add the failure message. */
1109 if (sender_verified_failed
!= NULL
&&
1110 sender_verified_failed
->message
!= NULL
&&
1111 strcmpic(log_message
, US
"sender verify failed") == 0)
1112 text
= string_sprintf("%s: %s", text
, sender_verified_failed
->message
);
1114 /* Search previously logged warnings. They are kept in malloc
1115 store so they can be freed at the start of a new message. */
1117 for (logged
= acl_warn_logged
; logged
!= NULL
; logged
= logged
->next
)
1118 if (Ustrcmp(logged
->text
, text
) == 0) break;
1122 int length
= Ustrlen(text
) + 1;
1123 log_write(0, LOG_MAIN
, "%s", text
);
1124 logged
= store_malloc(sizeof(string_item
) + length
);
1125 logged
->text
= (uschar
*)logged
+ sizeof(string_item
);
1126 memcpy(logged
->text
, text
, length
);
1127 logged
->next
= acl_warn_logged
;
1128 acl_warn_logged
= logged
;
1132 /* If there's no user message, we are done. */
1134 if (user_message
== NULL
) return;
1136 /* If this isn't a message ACL, we can't do anything with a user message.
1139 if (where
> ACL_WHERE_NOTSMTP
)
1141 log_write(0, LOG_MAIN
|LOG_PANIC
, "ACL \"warn\" with \"message\" setting "
1142 "found in a non-message (%s) ACL: cannot specify header lines here: "
1143 "message ignored", acl_wherenames
[where
]);
1147 /* The code for setting up header lines is now abstracted into a separate
1148 function so that it can be used for the add_header modifier as well. */
1150 setup_header(user_message
);
1155 /*************************************************
1156 * Verify and check reverse DNS *
1157 *************************************************/
1159 /* Called from acl_verify() below. We look up the host name(s) of the client IP
1160 address if this has not yet been done. The host_name_lookup() function checks
1161 that one of these names resolves to an address list that contains the client IP
1162 address, so we don't actually have to do the check here.
1165 user_msgptr pointer for user message
1166 log_msgptr pointer for log message
1168 Returns: OK verification condition succeeded
1169 FAIL verification failed
1170 DEFER there was a problem verifying
1174 acl_verify_reverse(uschar
**user_msgptr
, uschar
**log_msgptr
)
1178 user_msgptr
= user_msgptr
; /* stop compiler warning */
1180 /* Previous success */
1182 if (sender_host_name
!= NULL
) return OK
;
1184 /* Previous failure */
1186 if (host_lookup_failed
)
1188 *log_msgptr
= string_sprintf("host lookup failed%s", host_lookup_msg
);
1192 /* Need to do a lookup */
1195 debug_printf("looking up host name to force name/address consistency check\n");
1197 if ((rc
= host_name_lookup()) != OK
)
1199 *log_msgptr
= (rc
== DEFER
)?
1200 US
"host lookup deferred for reverse lookup check"
1202 string_sprintf("host lookup failed for reverse lookup check%s",
1204 return rc
; /* DEFER or FAIL */
1207 host_build_sender_fullhost();
1213 /*************************************************
1214 * Check client IP address matches CSA target *
1215 *************************************************/
1217 /* Called from acl_verify_csa() below. This routine scans a section of a DNS
1218 response for address records belonging to the CSA target hostname. The section
1219 is specified by the reset argument, either RESET_ADDITIONAL or RESET_ANSWERS.
1220 If one of the addresses matches the client's IP address, then the client is
1221 authorized by CSA. If there are target IP addresses but none of them match
1222 then the client is using an unauthorized IP address. If there are no target IP
1223 addresses then the client cannot be using an authorized IP address. (This is
1224 an odd configuration - why didn't the SRV record have a weight of 1 instead?)
1227 dnsa the DNS answer block
1228 dnss a DNS scan block for us to use
1229 reset option specifing what portion to scan, as described above
1230 target the target hostname to use for matching RR names
1232 Returns: CSA_OK successfully authorized
1233 CSA_FAIL_MISMATCH addresses found but none matched
1234 CSA_FAIL_NOADDR no target addresses found
1238 acl_verify_csa_address(dns_answer
*dnsa
, dns_scan
*dnss
, int reset
,
1244 BOOL target_found
= FALSE
;
1246 for (rr
= dns_next_rr(dnsa
, dnss
, reset
);
1248 rr
= dns_next_rr(dnsa
, dnss
, RESET_NEXT
))
1250 /* Check this is an address RR for the target hostname. */
1254 && rr
->type
!= T_AAAA
1261 if (strcmpic(target
, rr
->name
) != 0) continue;
1263 target_found
= TRUE
;
1265 /* Turn the target address RR into a list of textual IP addresses and scan
1266 the list. There may be more than one if it is an A6 RR. */
1268 for (da
= dns_address_from_rr(dnsa
, rr
); da
!= NULL
; da
= da
->next
)
1270 /* If the client IP address matches the target IP address, it's good! */
1272 DEBUG(D_acl
) debug_printf("CSA target address is %s\n", da
->address
);
1274 if (strcmpic(sender_host_address
, da
->address
) == 0) return CSA_OK
;
1278 /* If we found some target addresses but none of them matched, the client is
1279 using an unauthorized IP address, otherwise the target has no authorized IP
1282 if (target_found
) return CSA_FAIL_MISMATCH
;
1283 else return CSA_FAIL_NOADDR
;
1288 /*************************************************
1289 * Verify Client SMTP Authorization *
1290 *************************************************/
1292 /* Called from acl_verify() below. This routine calls dns_lookup_special()
1293 to find the CSA SRV record corresponding to the domain argument, or
1294 $sender_helo_name if no argument is provided. It then checks that the
1295 client is authorized, and that its IP address corresponds to the SRV
1296 target's address by calling acl_verify_csa_address() above. The address
1297 should have been returned in the DNS response's ADDITIONAL section, but if
1298 not we perform another DNS lookup to get it.
1301 domain pointer to optional parameter following verify = csa
1303 Returns: CSA_UNKNOWN no valid CSA record found
1304 CSA_OK successfully authorized
1305 CSA_FAIL_* client is definitely not authorized
1306 CSA_DEFER_* there was a DNS problem
1310 acl_verify_csa(uschar
*domain
)
1314 int priority
, weight
, port
;
1321 /* Work out the domain we are using for the CSA lookup. The default is the
1322 client's HELO domain. If the client has not said HELO, use its IP address
1323 instead. If it's a local client (exim -bs), CSA isn't applicable. */
1325 while (isspace(*domain
) && *domain
!= '\0') ++domain
;
1326 if (*domain
== '\0') domain
= sender_helo_name
;
1327 if (domain
== NULL
) domain
= sender_host_address
;
1328 if (sender_host_address
== NULL
) return CSA_UNKNOWN
;
1330 /* If we have an address literal, strip off the framing ready for turning it
1331 into a domain. The framing consists of matched square brackets possibly
1332 containing a keyword and a colon before the actual IP address. */
1334 if (domain
[0] == '[')
1336 uschar
*start
= Ustrchr(domain
, ':');
1337 if (start
== NULL
) start
= domain
;
1338 domain
= string_copyn(start
+ 1, Ustrlen(start
) - 2);
1341 /* Turn domains that look like bare IP addresses into domains in the reverse
1342 DNS. This code also deals with address literals and $sender_host_address. It's
1343 not quite kosher to treat bare domains such as EHLO 192.0.2.57 the same as
1344 address literals, but it's probably the most friendly thing to do. This is an
1345 extension to CSA, so we allow it to be turned off for proper conformance. */
1347 if (string_is_ip_address(domain
, NULL
) != 0)
1349 if (!dns_csa_use_reverse
) return CSA_UNKNOWN
;
1350 dns_build_reverse(domain
, target
);
1354 /* Find out if we've already done the CSA check for this domain. If we have,
1355 return the same result again. Otherwise build a new cached result structure
1356 for this domain. The name is filled in now, and the value is filled in when
1357 we return from this function. */
1359 t
= tree_search(csa_cache
, domain
);
1360 if (t
!= NULL
) return t
->data
.val
;
1362 t
= store_get_perm(sizeof(tree_node
) + Ustrlen(domain
));
1363 Ustrcpy(t
->name
, domain
);
1364 (void)tree_insertnode(&csa_cache
, t
);
1366 /* Now we are ready to do the actual DNS lookup(s). */
1369 switch (dns_special_lookup(&dnsa
, domain
, T_CSA
, &found
))
1371 /* If something bad happened (most commonly DNS_AGAIN), defer. */
1374 return t
->data
.val
= CSA_DEFER_SRV
;
1376 /* If we found nothing, the client's authorization is unknown. */
1380 return t
->data
.val
= CSA_UNKNOWN
;
1382 /* We got something! Go on to look at the reply in more detail. */
1388 /* Scan the reply for well-formed CSA SRV records. */
1390 for (rr
= dns_next_rr(&dnsa
, &dnss
, RESET_ANSWERS
);
1392 rr
= dns_next_rr(&dnsa
, &dnss
, RESET_NEXT
))
1394 if (rr
->type
!= T_SRV
) continue;
1396 /* Extract the numerical SRV fields (p is incremented) */
1399 GETSHORT(priority
, p
);
1400 GETSHORT(weight
, p
);
1404 debug_printf("CSA priority=%d weight=%d port=%d\n", priority
, weight
, port
);
1406 /* Check the CSA version number */
1408 if (priority
!= 1) continue;
1410 /* If the domain does not have a CSA SRV record of its own (i.e. the domain
1411 found by dns_special_lookup() is a parent of the one we asked for), we check
1412 the subdomain assertions in the port field. At the moment there's only one
1413 assertion: legitimate SMTP clients are all explicitly authorized with CSA
1414 SRV records of their own. */
1416 if (found
!= domain
)
1419 return t
->data
.val
= CSA_FAIL_EXPLICIT
;
1421 return t
->data
.val
= CSA_UNKNOWN
;
1424 /* This CSA SRV record refers directly to our domain, so we check the value
1425 in the weight field to work out the domain's authorization. 0 and 1 are
1426 unauthorized; 3 means the client is authorized but we can't check the IP
1427 address in order to authenticate it, so we treat it as unknown; values
1428 greater than 3 are undefined. */
1430 if (weight
< 2) return t
->data
.val
= CSA_FAIL_DOMAIN
;
1432 if (weight
> 2) continue;
1434 /* Weight == 2, which means the domain is authorized. We must check that the
1435 client's IP address is listed as one of the SRV target addresses. Save the
1436 target hostname then break to scan the additional data for its addresses. */
1438 (void)dn_expand(dnsa
.answer
, dnsa
.answer
+ dnsa
.answerlen
, p
,
1439 (DN_EXPAND_ARG4_TYPE
)target
, sizeof(target
));
1441 DEBUG(D_acl
) debug_printf("CSA target is %s\n", target
);
1446 /* If we didn't break the loop then no appropriate records were found. */
1448 if (rr
== NULL
) return t
->data
.val
= CSA_UNKNOWN
;
1450 /* Do not check addresses if the target is ".", in accordance with RFC 2782.
1451 A target of "." indicates there are no valid addresses, so the client cannot
1452 be authorized. (This is an odd configuration because weight=2 target=. is
1453 equivalent to weight=1, but we check for it in order to keep load off the
1454 root name servers.) Note that dn_expand() turns "." into "". */
1456 if (Ustrcmp(target
, "") == 0) return t
->data
.val
= CSA_FAIL_NOADDR
;
1458 /* Scan the additional section of the CSA SRV reply for addresses belonging
1459 to the target. If the name server didn't return any additional data (e.g.
1460 because it does not fully support SRV records), we need to do another lookup
1461 to obtain the target addresses; otherwise we have a definitive result. */
1463 rc
= acl_verify_csa_address(&dnsa
, &dnss
, RESET_ADDITIONAL
, target
);
1464 if (rc
!= CSA_FAIL_NOADDR
) return t
->data
.val
= rc
;
1466 /* The DNS lookup type corresponds to the IP version used by the client. */
1469 if (Ustrchr(sender_host_address
, ':') != NULL
)
1472 #endif /* HAVE_IPV6 */
1476 #if HAVE_IPV6 && defined(SUPPORT_A6)
1480 switch (dns_lookup(&dnsa
, target
, type
, NULL
))
1482 /* If something bad happened (most commonly DNS_AGAIN), defer. */
1485 return t
->data
.val
= CSA_DEFER_ADDR
;
1487 /* If the query succeeded, scan the addresses and return the result. */
1490 rc
= acl_verify_csa_address(&dnsa
, &dnss
, RESET_ANSWERS
, target
);
1491 if (rc
!= CSA_FAIL_NOADDR
) return t
->data
.val
= rc
;
1492 /* else fall through */
1494 /* If the target has no IP addresses, the client cannot have an authorized
1495 IP address. However, if the target site uses A6 records (not AAAA records)
1496 we have to do yet another lookup in order to check them. */
1501 #if HAVE_IPV6 && defined(SUPPORT_A6)
1502 if (type
== T_AAAA
) { type
= T_A6
; goto DNS_LOOKUP_AGAIN
; }
1505 return t
->data
.val
= CSA_FAIL_NOADDR
;
1511 /*************************************************
1512 * Handle verification (address & other) *
1513 *************************************************/
1515 enum { VERIFY_REV_HOST_LKUP
, VERIFY_CERT
, VERIFY_HELO
, VERIFY_CSA
, VERIFY_HDR_SYNTAX
,
1516 VERIFY_NOT_BLIND
, VERIFY_HDR_SNDR
, VERIFY_SNDR
, VERIFY_RCPT
1521 unsigned where_allowed
; /* bitmap */
1522 BOOL no_options
; /* Never has /option(s) following */
1523 unsigned alt_opt_sep
; /* >0 Non-/ option separator (custom parser) */
1525 static verify_type_t verify_type_list
[] = {
1526 { US
"reverse_host_lookup", VERIFY_REV_HOST_LKUP
, ~0, TRUE
, 0 },
1527 { US
"certificate", VERIFY_CERT
, ~0, TRUE
, 0 },
1528 { US
"helo", VERIFY_HELO
, ~0, TRUE
, 0 },
1529 { US
"csa", VERIFY_CSA
, ~0, FALSE
, 0 },
1530 { US
"header_syntax", VERIFY_HDR_SYNTAX
, (1<<ACL_WHERE_DATA
)|(1<<ACL_WHERE_NOTSMTP
), TRUE
, 0 },
1531 { US
"not_blind", VERIFY_NOT_BLIND
, (1<<ACL_WHERE_DATA
)|(1<<ACL_WHERE_NOTSMTP
), TRUE
, 0 },
1532 { US
"header_sender", VERIFY_HDR_SNDR
, (1<<ACL_WHERE_DATA
)|(1<<ACL_WHERE_NOTSMTP
), FALSE
, 0 },
1533 { US
"sender", VERIFY_SNDR
, (1<<ACL_WHERE_MAIL
)|(1<<ACL_WHERE_RCPT
)
1534 |(1<<ACL_WHERE_PREDATA
)|(1<<ACL_WHERE_DATA
)|(1<<ACL_WHERE_NOTSMTP
),
1536 { US
"recipient", VERIFY_RCPT
, (1<<ACL_WHERE_RCPT
), FALSE
, 0 }
1540 enum { CALLOUT_DEFER_OK
, CALLOUT_NOCACHE
, CALLOUT_RANDOM
, CALLOUT_USE_SENDER
,
1541 CALLOUT_USE_POSTMASTER
, CALLOUT_POSTMASTER
, CALLOUT_FULLPOSTMASTER
,
1542 CALLOUT_MAILFROM
, CALLOUT_POSTMASTER_MAILFROM
, CALLOUT_MAXWAIT
, CALLOUT_CONNECT
,
1549 BOOL has_option
; /* Has =option(s) following */
1550 BOOL timeval
; /* Has a time value */
1552 static callout_opt_t callout_opt_list
[] = {
1553 { US
"defer_ok", CALLOUT_DEFER_OK
, 0, FALSE
, FALSE
},
1554 { US
"no_cache", CALLOUT_NOCACHE
, vopt_callout_no_cache
, FALSE
, FALSE
},
1555 { US
"random", CALLOUT_RANDOM
, vopt_callout_random
, FALSE
, FALSE
},
1556 { US
"use_sender", CALLOUT_USE_SENDER
, vopt_callout_recipsender
, FALSE
, FALSE
},
1557 { US
"use_postmaster", CALLOUT_USE_POSTMASTER
,vopt_callout_recippmaster
, FALSE
, FALSE
},
1558 { US
"postmaster_mailfrom",CALLOUT_POSTMASTER_MAILFROM
,0, TRUE
, FALSE
},
1559 { US
"postmaster", CALLOUT_POSTMASTER
, 0, FALSE
, FALSE
},
1560 { US
"fullpostmaster", CALLOUT_FULLPOSTMASTER
,vopt_callout_fullpm
, FALSE
, FALSE
},
1561 { US
"mailfrom", CALLOUT_MAILFROM
, 0, TRUE
, FALSE
},
1562 { US
"maxwait", CALLOUT_MAXWAIT
, 0, TRUE
, TRUE
},
1563 { US
"connect", CALLOUT_CONNECT
, 0, TRUE
, TRUE
},
1564 { NULL
, CALLOUT_TIME
, 0, FALSE
, TRUE
}
1569 /* This function implements the "verify" condition. It is called when
1570 encountered in any ACL, because some tests are almost always permitted. Some
1571 just don't make sense, and always fail (for example, an attempt to test a host
1572 lookup for a non-TCP/IP message). Others are restricted to certain ACLs.
1575 where where called from
1576 addr the recipient address that the ACL is handling, or NULL
1577 arg the argument of "verify"
1578 user_msgptr pointer for user message
1579 log_msgptr pointer for log message
1580 basic_errno where to put verify errno
1582 Returns: OK verification condition succeeded
1583 FAIL verification failed
1584 DEFER there was a problem verifying
1589 acl_verify(int where
, address_item
*addr
, uschar
*arg
,
1590 uschar
**user_msgptr
, uschar
**log_msgptr
, int *basic_errno
)
1594 int callout_overall
= -1;
1595 int callout_connect
= -1;
1596 int verify_options
= 0;
1598 BOOL verify_header_sender
= FALSE
;
1599 BOOL defer_ok
= FALSE
;
1600 BOOL callout_defer_ok
= FALSE
;
1601 BOOL no_details
= FALSE
;
1602 BOOL success_on_redirect
= FALSE
;
1603 address_item
*sender_vaddr
= NULL
;
1604 uschar
*verify_sender_address
= NULL
;
1605 uschar
*pm_mailfrom
= NULL
;
1606 uschar
*se_mailfrom
= NULL
;
1608 /* Some of the verify items have slash-separated options; some do not. Diagnose
1609 an error if options are given for items that don't expect them.
1612 uschar
*slash
= Ustrchr(arg
, '/');
1614 uschar
*ss
= string_nextinlist(&list
, &sep
, big_buffer
, big_buffer_size
);
1617 if (ss
== NULL
) goto BAD_VERIFY
;
1619 /* Handle name/address consistency verification in a separate function. */
1621 for (vp
= verify_type_list
;
1622 (char *)vp
< (char *)verify_type_list
+ sizeof(verify_type_list
);
1625 if (vp
->alt_opt_sep
? strncmpic(ss
, vp
->name
, vp
->alt_opt_sep
) == 0
1626 : strcmpic (ss
, vp
->name
) == 0)
1628 if ((char *)vp
>= (char *)verify_type_list
+ sizeof(verify_type_list
))
1631 if (vp
->no_options
&& slash
!= NULL
)
1633 *log_msgptr
= string_sprintf("unexpected '/' found in \"%s\" "
1634 "(this verify item has no options)", arg
);
1637 if (!(vp
->where_allowed
& (1<<where
)))
1639 *log_msgptr
= string_sprintf("cannot verify %s in ACL for %s", vp
->name
, acl_wherenames
[where
]);
1644 case VERIFY_REV_HOST_LKUP
:
1645 if (sender_host_address
== NULL
) return OK
;
1646 return acl_verify_reverse(user_msgptr
, log_msgptr
);
1649 /* TLS certificate verification is done at STARTTLS time; here we just
1650 test whether it was successful or not. (This is for optional verification; for
1651 mandatory verification, the connection doesn't last this long.) */
1653 if (tls_in
.certificate_verified
) return OK
;
1654 *user_msgptr
= US
"no verified certificate";
1658 /* We can test the result of optional HELO verification that might have
1659 occurred earlier. If not, we can attempt the verification now. */
1661 if (!helo_verified
&& !helo_verify_failed
) smtp_verify_helo();
1662 return helo_verified
? OK
: FAIL
;
1665 /* Do Client SMTP Authorization checks in a separate function, and turn the
1666 result code into user-friendly strings. */
1668 rc
= acl_verify_csa(list
);
1669 *log_msgptr
= *user_msgptr
= string_sprintf("client SMTP authorization %s",
1670 csa_reason_string
[rc
]);
1671 csa_status
= csa_status_string
[rc
];
1672 DEBUG(D_acl
) debug_printf("CSA result %s\n", csa_status
);
1673 return csa_return_code
[rc
];
1675 case VERIFY_HDR_SYNTAX
:
1676 /* Check that all relevant header lines have the correct syntax. If there is
1677 a syntax error, we return details of the error to the sender if configured to
1678 send out full details. (But a "message" setting on the ACL can override, as
1681 rc
= verify_check_headers(log_msgptr
);
1682 if (rc
!= OK
&& smtp_return_error_details
&& *log_msgptr
!= NULL
)
1683 *user_msgptr
= string_sprintf("Rejected after DATA: %s", *log_msgptr
);
1686 case VERIFY_NOT_BLIND
:
1687 /* Check that no recipient of this message is "blind", that is, every envelope
1688 recipient must be mentioned in either To: or Cc:. */
1690 rc
= verify_check_notblind();
1693 *log_msgptr
= string_sprintf("bcc recipient detected");
1694 if (smtp_return_error_details
)
1695 *user_msgptr
= string_sprintf("Rejected after DATA: %s", *log_msgptr
);
1699 /* The remaining verification tests check recipient and sender addresses,
1700 either from the envelope or from the header. There are a number of
1701 slash-separated options that are common to all of them. */
1703 case VERIFY_HDR_SNDR
:
1704 verify_header_sender
= TRUE
;
1708 /* In the case of a sender, this can optionally be followed by an address to use
1709 in place of the actual sender (rare special-case requirement). */
1713 verify_sender_address
= sender_address
;
1716 while (isspace(*s
)) s
++;
1717 if (*s
++ != '=') goto BAD_VERIFY
;
1718 while (isspace(*s
)) s
++;
1719 verify_sender_address
= string_copy(s
);
1730 /* Remaining items are optional; they apply to sender and recipient
1731 verification, including "header sender" verification. */
1733 while ((ss
= string_nextinlist(&list
, &sep
, big_buffer
, big_buffer_size
))
1736 if (strcmpic(ss
, US
"defer_ok") == 0) defer_ok
= TRUE
;
1737 else if (strcmpic(ss
, US
"no_details") == 0) no_details
= TRUE
;
1738 else if (strcmpic(ss
, US
"success_on_redirect") == 0) success_on_redirect
= TRUE
;
1740 /* These two old options are left for backwards compatibility */
1742 else if (strcmpic(ss
, US
"callout_defer_ok") == 0)
1744 callout_defer_ok
= TRUE
;
1745 if (callout
== -1) callout
= CALLOUT_TIMEOUT_DEFAULT
;
1748 else if (strcmpic(ss
, US
"check_postmaster") == 0)
1751 if (callout
== -1) callout
= CALLOUT_TIMEOUT_DEFAULT
;
1754 /* The callout option has a number of sub-options, comma separated */
1756 else if (strncmpic(ss
, US
"callout", 7) == 0)
1758 callout
= CALLOUT_TIMEOUT_DEFAULT
;
1762 while (isspace(*ss
)) ss
++;
1768 while (isspace(*ss
)) ss
++;
1770 while ((opt
= string_nextinlist(&ss
, &optsep
, buffer
, sizeof(buffer
)))
1774 double period
= 1.0F
;
1776 for (op
= callout_opt_list
; op
->name
; op
++)
1777 if (strncmpic(opt
, op
->name
, Ustrlen(op
->name
)) == 0)
1780 verify_options
|= op
->flag
;
1783 opt
+= Ustrlen(op
->name
);
1784 while (isspace(*opt
)) opt
++;
1787 *log_msgptr
= string_sprintf("'=' expected after "
1788 "\"%s\" in ACL verify condition \"%s\"", op
->name
, arg
);
1791 while (isspace(*opt
)) opt
++;
1795 period
= readconf_readtime(opt
, 0, FALSE
);
1798 *log_msgptr
= string_sprintf("bad time value in ACL condition "
1799 "\"verify %s\"", arg
);
1806 case CALLOUT_DEFER_OK
: callout_defer_ok
= TRUE
; break;
1807 case CALLOUT_POSTMASTER
: pm_mailfrom
= US
""; break;
1808 case CALLOUT_FULLPOSTMASTER
: pm_mailfrom
= US
""; break;
1809 case CALLOUT_MAILFROM
:
1810 if (!verify_header_sender
)
1812 *log_msgptr
= string_sprintf("\"mailfrom\" is allowed as a "
1813 "callout option only for verify=header_sender (detected in ACL "
1814 "condition \"%s\")", arg
);
1817 se_mailfrom
= string_copy(opt
);
1819 case CALLOUT_POSTMASTER_MAILFROM
: pm_mailfrom
= string_copy(opt
); break;
1820 case CALLOUT_MAXWAIT
: callout_overall
= period
; break;
1821 case CALLOUT_CONNECT
: callout_connect
= period
; break;
1822 case CALLOUT_TIME
: callout
= period
; break;
1828 *log_msgptr
= string_sprintf("'=' expected after \"callout\" in "
1829 "ACL condition \"%s\"", arg
);
1835 /* Option not recognized */
1839 *log_msgptr
= string_sprintf("unknown option \"%s\" in ACL "
1840 "condition \"verify %s\"", ss
, arg
);
1845 if ((verify_options
& (vopt_callout_recipsender
|vopt_callout_recippmaster
)) ==
1846 (vopt_callout_recipsender
|vopt_callout_recippmaster
))
1848 *log_msgptr
= US
"only one of use_sender and use_postmaster can be set "
1849 "for a recipient callout";
1853 /* Handle sender-in-header verification. Default the user message to the log
1854 message if giving out verification details. */
1856 if (verify_header_sender
)
1859 rc
= verify_check_header_address(user_msgptr
, log_msgptr
, callout
,
1860 callout_overall
, callout_connect
, se_mailfrom
, pm_mailfrom
, verify_options
,
1864 *basic_errno
= verrno
;
1865 if (smtp_return_error_details
)
1867 if (*user_msgptr
== NULL
&& *log_msgptr
!= NULL
)
1868 *user_msgptr
= string_sprintf("Rejected after DATA: %s", *log_msgptr
);
1869 if (rc
== DEFER
) acl_temp_details
= TRUE
;
1874 /* Handle a sender address. The default is to verify *the* sender address, but
1875 optionally a different address can be given, for special requirements. If the
1876 address is empty, we are dealing with a bounce message that has no sender, so
1877 we cannot do any checking. If the real sender address gets rewritten during
1878 verification (e.g. DNS widening), set the flag to stop it being rewritten again
1879 during message reception.
1881 A list of verified "sender" addresses is kept to try to avoid doing to much
1882 work repetitively when there are multiple recipients in a message and they all
1883 require sender verification. However, when callouts are involved, it gets too
1884 complicated because different recipients may require different callout options.
1885 Therefore, we always do a full sender verify when any kind of callout is
1886 specified. Caching elsewhere, for instance in the DNS resolver and in the
1887 callout handling, should ensure that this is not terribly inefficient. */
1889 else if (verify_sender_address
!= NULL
)
1891 if ((verify_options
& (vopt_callout_recipsender
|vopt_callout_recippmaster
))
1894 *log_msgptr
= US
"use_sender or use_postmaster cannot be used for a "
1895 "sender verify callout";
1899 sender_vaddr
= verify_checked_sender(verify_sender_address
);
1900 if (sender_vaddr
!= NULL
&& /* Previously checked */
1901 callout
<= 0) /* No callout needed this time */
1903 /* If the "routed" flag is set, it means that routing worked before, so
1904 this check can give OK (the saved return code value, if set, belongs to a
1905 callout that was done previously). If the "routed" flag is not set, routing
1906 must have failed, so we use the saved return code. */
1908 if (testflag(sender_vaddr
, af_verify_routed
)) rc
= OK
; else
1910 rc
= sender_vaddr
->special_action
;
1911 *basic_errno
= sender_vaddr
->basic_errno
;
1913 HDEBUG(D_acl
) debug_printf("using cached sender verify result\n");
1916 /* Do a new verification, and cache the result. The cache is used to avoid
1917 verifying the sender multiple times for multiple RCPTs when callouts are not
1918 specified (see comments above).
1920 The cache is also used on failure to give details in response to the first
1921 RCPT that gets bounced for this reason. However, this can be suppressed by
1922 the no_details option, which sets the flag that says "this detail has already
1923 been sent". The cache normally contains just one address, but there may be
1924 more in esoteric circumstances. */
1929 uschar
*save_address_data
= deliver_address_data
;
1931 sender_vaddr
= deliver_make_addr(verify_sender_address
, TRUE
);
1932 if (no_details
) setflag(sender_vaddr
, af_sverify_told
);
1933 if (verify_sender_address
[0] != 0)
1935 /* If this is the real sender address, save the unrewritten version
1936 for use later in receive. Otherwise, set a flag so that rewriting the
1937 sender in verify_address() does not update sender_address. */
1939 if (verify_sender_address
== sender_address
)
1940 sender_address_unrewritten
= sender_address
;
1942 verify_options
|= vopt_fake_sender
;
1944 if (success_on_redirect
)
1945 verify_options
|= vopt_success_on_redirect
;
1947 /* The recipient, qualify, and expn options are never set in
1950 rc
= verify_address(sender_vaddr
, NULL
, verify_options
, callout
,
1951 callout_overall
, callout_connect
, se_mailfrom
, pm_mailfrom
, &routed
);
1953 HDEBUG(D_acl
) debug_printf("----------- end verify ------------\n");
1957 if (Ustrcmp(sender_vaddr
->address
, verify_sender_address
) != 0)
1959 DEBUG(D_acl
) debug_printf("sender %s verified ok as %s\n",
1960 verify_sender_address
, sender_vaddr
->address
);
1964 DEBUG(D_acl
) debug_printf("sender %s verified ok\n",
1965 verify_sender_address
);
1968 else *basic_errno
= sender_vaddr
->basic_errno
;
1970 else rc
= OK
; /* Null sender */
1972 /* Cache the result code */
1974 if (routed
) setflag(sender_vaddr
, af_verify_routed
);
1975 if (callout
> 0) setflag(sender_vaddr
, af_verify_callout
);
1976 sender_vaddr
->special_action
= rc
;
1977 sender_vaddr
->next
= sender_verified_list
;
1978 sender_verified_list
= sender_vaddr
;
1980 /* Restore the recipient address data, which might have been clobbered by
1981 the sender verification. */
1983 deliver_address_data
= save_address_data
;
1986 /* Put the sender address_data value into $sender_address_data */
1988 sender_address_data
= sender_vaddr
->p
.address_data
;
1991 /* A recipient address just gets a straightforward verify; again we must handle
1992 the DEFER overrides. */
1998 if (success_on_redirect
)
1999 verify_options
|= vopt_success_on_redirect
;
2001 /* We must use a copy of the address for verification, because it might
2005 rc
= verify_address(&addr2
, NULL
, verify_options
|vopt_is_recipient
, callout
,
2006 callout_overall
, callout_connect
, se_mailfrom
, pm_mailfrom
, NULL
);
2007 HDEBUG(D_acl
) debug_printf("----------- end verify ------------\n");
2009 *basic_errno
= addr2
.basic_errno
;
2010 *log_msgptr
= addr2
.message
;
2011 *user_msgptr
= (addr2
.user_message
!= NULL
)?
2012 addr2
.user_message
: addr2
.message
;
2014 /* Allow details for temporary error if the address is so flagged. */
2015 if (testflag((&addr2
), af_pass_message
)) acl_temp_details
= TRUE
;
2017 /* Make $address_data visible */
2018 deliver_address_data
= addr2
.p
.address_data
;
2021 /* We have a result from the relevant test. Handle defer overrides first. */
2023 if (rc
== DEFER
&& (defer_ok
||
2024 (callout_defer_ok
&& *basic_errno
== ERRNO_CALLOUTDEFER
)))
2026 HDEBUG(D_acl
) debug_printf("verify defer overridden by %s\n",
2027 defer_ok
? "defer_ok" : "callout_defer_ok");
2031 /* If we've failed a sender, set up a recipient message, and point
2032 sender_verified_failed to the address item that actually failed. */
2034 if (rc
!= OK
&& verify_sender_address
!= NULL
)
2038 *log_msgptr
= *user_msgptr
= US
"Sender verify failed";
2040 else if (*basic_errno
!= ERRNO_CALLOUTDEFER
)
2042 *log_msgptr
= *user_msgptr
= US
"Could not complete sender verify";
2046 *log_msgptr
= US
"Could not complete sender verify callout";
2047 *user_msgptr
= smtp_return_error_details
? sender_vaddr
->user_message
:
2051 sender_verified_failed
= sender_vaddr
;
2054 /* Verifying an address messes up the values of $domain and $local_part,
2055 so reset them before returning if this is a RCPT ACL. */
2059 deliver_domain
= addr
->domain
;
2060 deliver_localpart
= addr
->local_part
;
2064 /* Syntax errors in the verify argument come here. */
2067 *log_msgptr
= string_sprintf("expected \"sender[=address]\", \"recipient\", "
2068 "\"helo\", \"header_syntax\", \"header_sender\" or "
2069 "\"reverse_host_lookup\" at start of ACL condition "
2070 "\"verify %s\"", arg
);
2077 /*************************************************
2078 * Check argument for control= modifier *
2079 *************************************************/
2081 /* Called from acl_check_condition() below
2084 arg the argument string for control=
2085 pptr set to point to the terminating character
2086 where which ACL we are in
2087 log_msgptr for error messages
2089 Returns: CONTROL_xxx value
2093 decode_control(uschar
*arg
, uschar
**pptr
, int where
, uschar
**log_msgptr
)
2098 for (d
= controls_list
;
2099 d
< controls_list
+ sizeof(controls_list
)/sizeof(control_def
);
2102 len
= Ustrlen(d
->name
);
2103 if (Ustrncmp(d
->name
, arg
, len
) == 0) break;
2106 if (d
>= controls_list
+ sizeof(controls_list
)/sizeof(control_def
) ||
2107 (arg
[len
] != 0 && (!d
->has_option
|| arg
[len
] != '/')))
2109 *log_msgptr
= string_sprintf("syntax error in \"control=%s\"", arg
);
2110 return CONTROL_ERROR
;
2120 /*************************************************
2121 * Return a ratelimit error *
2122 *************************************************/
2124 /* Called from acl_ratelimit() below
2127 log_msgptr for error messages
2128 format format string
2129 ... supplementary arguments
2130 ss ratelimit option name
2131 where ACL_WHERE_xxxx indicating which ACL this is
2137 ratelimit_error(uschar
**log_msgptr
, const char *format
, ...)
2140 uschar buffer
[STRING_SPRINTF_BUFFER_SIZE
];
2141 va_start(ap
, format
);
2142 if (!string_vformat(buffer
, sizeof(buffer
), format
, ap
))
2143 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
,
2144 "string_sprintf expansion was longer than " SIZE_T_FMT
, sizeof(buffer
));
2146 *log_msgptr
= string_sprintf(
2147 "error in arguments to \"ratelimit\" condition: %s", buffer
);
2154 /*************************************************
2155 * Handle rate limiting *
2156 *************************************************/
2158 /* Called by acl_check_condition() below to calculate the result
2159 of the ACL ratelimit condition.
2161 Note that the return value might be slightly unexpected: if the
2162 sender's rate is above the limit then the result is OK. This is
2163 similar to the dnslists condition, and is so that you can write
2164 ACL clauses like: defer ratelimit = 15 / 1h
2167 arg the option string for ratelimit=
2168 where ACL_WHERE_xxxx indicating which ACL this is
2169 log_msgptr for error messages
2171 Returns: OK - Sender's rate is above limit
2172 FAIL - Sender's rate is below limit
2173 DEFER - Problem opening ratelimit database
2174 ERROR - Syntax error in options.
2178 acl_ratelimit(uschar
*arg
, int where
, uschar
**log_msgptr
)
2180 double limit
, period
, count
;
2183 uschar
*unique
= NULL
;
2185 BOOL leaky
= FALSE
, strict
= FALSE
, readonly
= FALSE
;
2186 BOOL noupdate
= FALSE
, badacl
= FALSE
;
2187 int mode
= RATE_PER_WHAT
;
2189 tree_node
**anchor
, *t
;
2190 open_db dbblock
, *dbm
;
2192 dbdata_ratelimit
*dbd
;
2193 dbdata_ratelimit_unique
*dbdb
;
2196 /* Parse the first two options and record their values in expansion
2197 variables. These variables allow the configuration to have informative
2198 error messages based on rate limits obtained from a table lookup. */
2200 /* First is the maximum number of messages per period / maximum burst
2201 size, which must be greater than or equal to zero. Zero is useful for
2202 rate measurement as opposed to rate limiting. */
2204 sender_rate_limit
= string_nextinlist(&arg
, &sep
, NULL
, 0);
2205 if (sender_rate_limit
== NULL
)
2209 limit
= Ustrtod(sender_rate_limit
, &ss
);
2210 if (tolower(*ss
) == 'k') { limit
*= 1024.0; ss
++; }
2211 else if (tolower(*ss
) == 'm') { limit
*= 1024.0*1024.0; ss
++; }
2212 else if (tolower(*ss
) == 'g') { limit
*= 1024.0*1024.0*1024.0; ss
++; }
2214 if (limit
< 0.0 || *ss
!= '\0')
2215 return ratelimit_error(log_msgptr
,
2216 "\"%s\" is not a positive number", sender_rate_limit
);
2218 /* Second is the rate measurement period / exponential smoothing time
2219 constant. This must be strictly greater than zero, because zero leads to
2220 run-time division errors. */
2222 sender_rate_period
= string_nextinlist(&arg
, &sep
, NULL
, 0);
2223 if (sender_rate_period
== NULL
) period
= -1.0;
2224 else period
= readconf_readtime(sender_rate_period
, 0, FALSE
);
2226 return ratelimit_error(log_msgptr
,
2227 "\"%s\" is not a time value", sender_rate_period
);
2229 /* By default we are counting one of something, but the per_rcpt,
2230 per_byte, and count options can change this. */
2234 /* Parse the other options. */
2236 while ((ss
= string_nextinlist(&arg
, &sep
, big_buffer
, big_buffer_size
))
2239 if (strcmpic(ss
, US
"leaky") == 0) leaky
= TRUE
;
2240 else if (strcmpic(ss
, US
"strict") == 0) strict
= TRUE
;
2241 else if (strcmpic(ss
, US
"noupdate") == 0) noupdate
= TRUE
;
2242 else if (strcmpic(ss
, US
"readonly") == 0) readonly
= TRUE
;
2243 else if (strcmpic(ss
, US
"per_cmd") == 0) RATE_SET(mode
, PER_CMD
);
2244 else if (strcmpic(ss
, US
"per_conn") == 0)
2246 RATE_SET(mode
, PER_CONN
);
2247 if (where
== ACL_WHERE_NOTSMTP
|| where
== ACL_WHERE_NOTSMTP_START
)
2250 else if (strcmpic(ss
, US
"per_mail") == 0)
2252 RATE_SET(mode
, PER_MAIL
);
2253 if (where
> ACL_WHERE_NOTSMTP
) badacl
= TRUE
;
2255 else if (strcmpic(ss
, US
"per_rcpt") == 0)
2257 /* If we are running in the RCPT ACL, then we'll count the recipients
2258 one by one, but if we are running when we have accumulated the whole
2259 list then we'll add them all in one batch. */
2260 if (where
== ACL_WHERE_RCPT
)
2261 RATE_SET(mode
, PER_RCPT
);
2262 else if (where
>= ACL_WHERE_PREDATA
&& where
<= ACL_WHERE_NOTSMTP
)
2263 RATE_SET(mode
, PER_ALLRCPTS
), count
= (double)recipients_count
;
2264 else if (where
== ACL_WHERE_MAIL
|| where
> ACL_WHERE_NOTSMTP
)
2265 RATE_SET(mode
, PER_RCPT
), badacl
= TRUE
;
2267 else if (strcmpic(ss
, US
"per_byte") == 0)
2269 /* If we have not yet received the message data and there was no SIZE
2270 declaration on the MAIL comand, then it's safe to just use a value of
2271 zero and let the recorded rate decay as if nothing happened. */
2272 RATE_SET(mode
, PER_MAIL
);
2273 if (where
> ACL_WHERE_NOTSMTP
) badacl
= TRUE
;
2274 else count
= message_size
< 0 ? 0.0 : (double)message_size
;
2276 else if (strcmpic(ss
, US
"per_addr") == 0)
2278 RATE_SET(mode
, PER_RCPT
);
2279 if (where
!= ACL_WHERE_RCPT
) badacl
= TRUE
, unique
= US
"*";
2280 else unique
= string_sprintf("%s@%s", deliver_localpart
, deliver_domain
);
2282 else if (strncmpic(ss
, US
"count=", 6) == 0)
2285 count
= Ustrtod(ss
+6, &e
);
2286 if (count
< 0.0 || *e
!= '\0')
2287 return ratelimit_error(log_msgptr
,
2288 "\"%s\" is not a positive number", ss
);
2290 else if (strncmpic(ss
, US
"unique=", 7) == 0)
2291 unique
= string_copy(ss
+ 7);
2292 else if (key
== NULL
)
2293 key
= string_copy(ss
);
2295 key
= string_sprintf("%s/%s", key
, ss
);
2298 /* Sanity check. When the badacl flag is set the update mode must either
2299 be readonly (which is the default if it is omitted) or, for backwards
2300 compatibility, a combination of noupdate and strict or leaky. */
2302 if (mode
== RATE_PER_CLASH
)
2303 return ratelimit_error(log_msgptr
, "conflicting per_* options");
2304 if (leaky
+ strict
+ readonly
> 1)
2305 return ratelimit_error(log_msgptr
, "conflicting update modes");
2306 if (badacl
&& (leaky
|| strict
) && !noupdate
)
2307 return ratelimit_error(log_msgptr
,
2308 "\"%s\" must not have /leaky or /strict option in %s ACL",
2309 ratelimit_option_string
[mode
], acl_wherenames
[where
]);
2311 /* Set the default values of any unset options. In readonly mode we
2312 perform the rate computation without any increment so that its value
2313 decays to eventually allow over-limit senders through. */
2315 if (noupdate
) readonly
= TRUE
, leaky
= strict
= FALSE
;
2316 if (badacl
) readonly
= TRUE
;
2317 if (readonly
) count
= 0.0;
2318 if (!strict
&& !readonly
) leaky
= TRUE
;
2319 if (mode
== RATE_PER_WHAT
) mode
= RATE_PER_MAIL
;
2321 /* Create the lookup key. If there is no explicit key, use sender_host_address.
2322 If there is no sender_host_address (e.g. -bs or acl_not_smtp) then we simply
2323 omit it. The smoothing constant (sender_rate_period) and the per_xxx options
2324 are added to the key because they alter the meaning of the stored data. */
2327 key
= (sender_host_address
== NULL
)? US
"" : sender_host_address
;
2329 key
= string_sprintf("%s/%s/%s%s",
2331 ratelimit_option_string
[mode
],
2332 unique
== NULL
? "" : "unique/",
2336 debug_printf("ratelimit condition count=%.0f %.1f/%s\n", count
, limit
, key
);
2338 /* See if we have already computed the rate by looking in the relevant tree.
2339 For per-connection rate limiting, store tree nodes and dbdata in the permanent
2340 pool so that they survive across resets. In readonly mode we only remember the
2341 result for the rest of this command in case a later command changes it. After
2342 this bit of logic the code is independent of the per_* mode. */
2344 old_pool
= store_pool
;
2347 anchor
= &ratelimiters_cmd
;
2350 anchor
= &ratelimiters_conn
;
2351 store_pool
= POOL_PERM
;
2355 case RATE_PER_ALLRCPTS
:
2356 anchor
= &ratelimiters_mail
;
2361 anchor
= &ratelimiters_cmd
;
2364 anchor
= NULL
; /* silence an "unused" complaint */
2365 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
,
2366 "internal ACL error: unknown ratelimit mode %d", mode
);
2370 t
= tree_search(*anchor
, key
);
2374 /* The following few lines duplicate some of the code below. */
2375 rc
= (dbd
->rate
< limit
)? FAIL
: OK
;
2376 store_pool
= old_pool
;
2377 sender_rate
= string_sprintf("%.1f", dbd
->rate
);
2379 debug_printf("ratelimit found pre-computed rate %s\n", sender_rate
);
2383 /* We aren't using a pre-computed rate, so get a previously recorded rate
2384 from the database, which will be updated and written back if required. */
2386 dbm
= dbfn_open(US
"ratelimit", O_RDWR
, &dbblock
, TRUE
);
2389 store_pool
= old_pool
;
2391 HDEBUG(D_acl
) debug_printf("ratelimit database not available\n");
2392 *log_msgptr
= US
"ratelimit database not available";
2395 dbdb
= dbfn_read_with_length(dbm
, key
, &dbdb_size
);
2398 gettimeofday(&tv
, NULL
);
2402 /* Locate the basic ratelimit block inside the DB data. */
2403 HDEBUG(D_acl
) debug_printf("ratelimit found key in database\n");
2406 /* Forget the old Bloom filter if it is too old, so that we count each
2407 repeating event once per period. We don't simply clear and re-use the old
2408 filter because we want its size to change if the limit changes. Note that
2409 we keep the dbd pointer for copying the rate into the new data block. */
2411 if(unique
!= NULL
&& tv
.tv_sec
> dbdb
->bloom_epoch
+ period
)
2413 HDEBUG(D_acl
) debug_printf("ratelimit discarding old Bloom filter\n");
2419 if(unique
!= NULL
&& dbdb_size
< sizeof(*dbdb
))
2421 HDEBUG(D_acl
) debug_printf("ratelimit discarding undersize Bloom filter\n");
2426 /* Allocate a new data block if the database lookup failed
2427 or the Bloom filter passed its age limit. */
2433 /* No Bloom filter. This basic ratelimit block is initialized below. */
2434 HDEBUG(D_acl
) debug_printf("ratelimit creating new rate data block\n");
2435 dbdb_size
= sizeof(*dbd
);
2436 dbdb
= store_get(dbdb_size
);
2441 HDEBUG(D_acl
) debug_printf("ratelimit creating new Bloom filter\n");
2443 /* See the long comment below for an explanation of the magic number 2.
2444 The filter has a minimum size in case the rate limit is very small;
2445 this is determined by the definition of dbdata_ratelimit_unique. */
2447 extra
= (int)limit
* 2 - sizeof(dbdb
->bloom
);
2448 if (extra
< 0) extra
= 0;
2449 dbdb_size
= sizeof(*dbdb
) + extra
;
2450 dbdb
= store_get(dbdb_size
);
2451 dbdb
->bloom_epoch
= tv
.tv_sec
;
2452 dbdb
->bloom_size
= sizeof(dbdb
->bloom
) + extra
;
2453 memset(dbdb
->bloom
, 0, dbdb
->bloom_size
);
2455 /* Preserve any basic ratelimit data (which is our longer-term memory)
2456 by copying it from the discarded block. */
2466 /* If we are counting unique events, find out if this event is new or not.
2467 If the client repeats the event during the current period then it should be
2468 counted. We skip this code in readonly mode for efficiency, because any
2469 changes to the filter will be discarded and because count is already set to
2472 if (unique
!= NULL
&& !readonly
)
2474 /* We identify unique events using a Bloom filter. (You can find my
2475 notes on Bloom filters at http://fanf.livejournal.com/81696.html)
2476 With the per_addr option, an "event" is a recipient address, though the
2477 user can use the unique option to define their own events. We only count
2478 an event if we have not seen it before.
2480 We size the filter according to the rate limit, which (in leaky mode)
2481 is the limit on the population of the filter. We allow 16 bits of space
2482 per entry (see the construction code above) and we set (up to) 8 of them
2483 when inserting an element (see the loop below). The probability of a false
2484 positive (an event we have not seen before but which we fail to count) is
2488 allzero = exp(-numhash * pop / size)
2489 = exp(-0.5 * pop / limit)
2490 fpr = pow(1 - allzero, numhash)
2492 For senders at the limit the fpr is 0.06% or 1 in 1700
2493 and for senders at half the limit it is 0.0006% or 1 in 170000
2495 In strict mode the Bloom filter can fill up beyond the normal limit, in
2496 which case the false positive rate will rise. This means that the
2497 measured rate for very fast senders can bogusly drop off after a while.
2499 At twice the limit, the fpr is 2.5% or 1 in 40
2500 At four times the limit, it is 31% or 1 in 3.2
2502 It takes ln(pop/limit) periods for an over-limit burst of pop events to
2503 decay below the limit, and if this is more than one then the Bloom filter
2504 will be discarded before the decay gets that far. The false positive rate
2505 at this threshold is 9.3% or 1 in 10.7. */
2508 unsigned n
, hash
, hinc
;
2512 /* Instead of using eight independent hash values, we combine two values
2513 using the formula h1 + n * h2. This does not harm the Bloom filter's
2514 performance, and means the amount of hash we need is independent of the
2515 number of bits we set in the filter. */
2517 md5_start(&md5info
);
2518 md5_end(&md5info
, unique
, Ustrlen(unique
), md5sum
);
2519 hash
= md5sum
[0] | md5sum
[1] << 8 | md5sum
[2] << 16 | md5sum
[3] << 24;
2520 hinc
= md5sum
[4] | md5sum
[5] << 8 | md5sum
[6] << 16 | md5sum
[7] << 24;
2522 /* Scan the bits corresponding to this event. A zero bit means we have
2523 not seen it before. Ensure all bits are set to record this event. */
2525 HDEBUG(D_acl
) debug_printf("ratelimit checking uniqueness of %s\n", unique
);
2528 for (n
= 0; n
< 8; n
++, hash
+= hinc
)
2530 int bit
= 1 << (hash
% 8);
2531 int byte
= (hash
/ 8) % dbdb
->bloom_size
;
2532 if ((dbdb
->bloom
[byte
] & bit
) == 0)
2534 dbdb
->bloom
[byte
] |= bit
;
2539 /* If this event has occurred before, do not count it. */
2543 HDEBUG(D_acl
) debug_printf("ratelimit event found in Bloom filter\n");
2547 HDEBUG(D_acl
) debug_printf("ratelimit event added to Bloom filter\n");
2550 /* If there was no previous ratelimit data block for this key, initialize
2551 the new one, otherwise update the block from the database. The initial rate
2552 is what would be computed by the code below for an infinite interval. */
2556 HDEBUG(D_acl
) debug_printf("ratelimit initializing new key's rate data\n");
2558 dbd
->time_stamp
= tv
.tv_sec
;
2559 dbd
->time_usec
= tv
.tv_usec
;
2564 /* The smoothed rate is computed using an exponentially weighted moving
2565 average adjusted for variable sampling intervals. The standard EWMA for
2566 a fixed sampling interval is: f'(t) = (1 - a) * f(t) + a * f'(t - 1)
2567 where f() is the measured value and f'() is the smoothed value.
2569 Old data decays out of the smoothed value exponentially, such that data n
2570 samples old is multiplied by a^n. The exponential decay time constant p
2571 is defined such that data p samples old is multiplied by 1/e, which means
2572 that a = exp(-1/p). We can maintain the same time constant for a variable
2573 sampling interval i by using a = exp(-i/p).
2575 The rate we are measuring is messages per period, suitable for directly
2576 comparing with the limit. The average rate between now and the previous
2577 message is period / interval, which we feed into the EWMA as the sample.
2579 It turns out that the number of messages required for the smoothed rate
2580 to reach the limit when they are sent in a burst is equal to the limit.
2581 This can be seen by analysing the value of the smoothed rate after N
2582 messages sent at even intervals. Let k = (1 - a) * p/i
2584 rate_1 = (1 - a) * p/i + a * rate_0
2586 rate_2 = k + a * rate_1
2587 = k + a * k + a^2 * rate_0
2588 rate_3 = k + a * k + a^2 * k + a^3 * rate_0
2589 rate_N = rate_0 * a^N + k * SUM(x=0..N-1)(a^x)
2590 = rate_0 * a^N + k * (1 - a^N) / (1 - a)
2591 = rate_0 * a^N + p/i * (1 - a^N)
2593 When N is large, a^N -> 0 so rate_N -> p/i as desired.
2595 rate_N = p/i + (rate_0 - p/i) * a^N
2596 a^N = (rate_N - p/i) / (rate_0 - p/i)
2597 N * -i/p = log((rate_N - p/i) / (rate_0 - p/i))
2598 N = p/i * log((rate_0 - p/i) / (rate_N - p/i))
2600 Numerical analysis of the above equation, setting the computed rate to
2601 increase from rate_0 = 0 to rate_N = limit, shows that for large sending
2602 rates, p/i, the number of messages N = limit. So limit serves as both the
2603 maximum rate measured in messages per period, and the maximum number of
2604 messages that can be sent in a fast burst. */
2606 double this_time
= (double)tv
.tv_sec
2607 + (double)tv
.tv_usec
/ 1000000.0;
2608 double prev_time
= (double)dbd
->time_stamp
2609 + (double)dbd
->time_usec
/ 1000000.0;
2611 /* We must avoid division by zero, and deal gracefully with the clock going
2612 backwards. If we blunder ahead when time is in reverse then the computed
2613 rate will be bogus. To be safe we clamp interval to a very small number. */
2615 double interval
= this_time
- prev_time
<= 0.0 ? 1e-9
2616 : this_time
- prev_time
;
2618 double i_over_p
= interval
/ period
;
2619 double a
= exp(-i_over_p
);
2621 /* Combine the instantaneous rate (period / interval) with the previous rate
2622 using the smoothing factor a. In order to measure sized events, multiply the
2623 instantaneous rate by the count of bytes or recipients etc. */
2625 dbd
->time_stamp
= tv
.tv_sec
;
2626 dbd
->time_usec
= tv
.tv_usec
;
2627 dbd
->rate
= (1 - a
) * count
/ i_over_p
+ a
* dbd
->rate
;
2629 /* When events are very widely spaced the computed rate tends towards zero.
2630 Although this is accurate it turns out not to be useful for our purposes,
2631 especially when the first event after a long silence is the start of a spam
2632 run. A more useful model is that the rate for an isolated event should be the
2633 size of the event per the period size, ignoring the lack of events outside
2634 the current period and regardless of where the event falls in the period. So,
2635 if the interval was so long that the calculated rate is unhelpfully small, we
2636 re-intialize the rate. In the absence of higher-rate bursts, the condition
2637 below is true if the interval is greater than the period. */
2639 if (dbd
->rate
< count
) dbd
->rate
= count
;
2642 /* Clients sending at the limit are considered to be over the limit.
2643 This matters for edge cases such as a limit of zero, when the client
2644 should be completely blocked. */
2646 rc
= (dbd
->rate
< limit
)? FAIL
: OK
;
2648 /* Update the state if the rate is low or if we are being strict. If we
2649 are in leaky mode and the sender's rate is too high, we do not update
2650 the recorded rate in order to avoid an over-aggressive sender's retry
2651 rate preventing them from getting any email through. If readonly is set,
2652 neither leaky nor strict are set, so we do not do any updates. */
2654 if ((rc
== FAIL
&& leaky
) || strict
)
2656 dbfn_write(dbm
, key
, dbdb
, dbdb_size
);
2657 HDEBUG(D_acl
) debug_printf("ratelimit db updated\n");
2661 HDEBUG(D_acl
) debug_printf("ratelimit db not updated: %s\n",
2662 readonly
? "readonly mode" : "over the limit, but leaky");
2667 /* Store the result in the tree for future reference. */
2669 t
= store_get(sizeof(tree_node
) + Ustrlen(key
));
2671 Ustrcpy(t
->name
, key
);
2672 (void)tree_insertnode(anchor
, t
);
2674 /* We create the formatted version of the sender's rate very late in
2675 order to ensure that it is done using the correct storage pool. */
2677 store_pool
= old_pool
;
2678 sender_rate
= string_sprintf("%.1f", dbd
->rate
);
2681 debug_printf("ratelimit computed rate %s\n", sender_rate
);
2688 /*************************************************
2689 * Handle conditions/modifiers on an ACL item *
2690 *************************************************/
2692 /* Called from acl_check() below.
2696 cb ACL condition block - if NULL, result is OK
2697 where where called from
2698 addr the address being checked for RCPT, or NULL
2699 level the nesting level
2700 epp pointer to pass back TRUE if "endpass" encountered
2701 (applies only to "accept" and "discard")
2702 user_msgptr user message pointer
2703 log_msgptr log message pointer
2704 basic_errno pointer to where to put verify error
2706 Returns: OK - all conditions are met
2707 DISCARD - an "acl" condition returned DISCARD - only allowed
2708 for "accept" or "discard" verbs
2709 FAIL - at least one condition fails
2710 FAIL_DROP - an "acl" condition returned FAIL_DROP
2711 DEFER - can't tell at the moment (typically, lookup defer,
2712 but can be temporary callout problem)
2713 ERROR - ERROR from nested ACL or expansion failure or other
2718 acl_check_condition(int verb
, acl_condition_block
*cb
, int where
,
2719 address_item
*addr
, int level
, BOOL
*epp
, uschar
**user_msgptr
,
2720 uschar
**log_msgptr
, int *basic_errno
)
2722 uschar
*user_message
= NULL
;
2723 uschar
*log_message
= NULL
;
2724 uschar
*debug_tag
= NULL
;
2725 uschar
*debug_opts
= NULL
;
2728 #ifdef WITH_CONTENT_SCAN
2732 for (; cb
!= NULL
; cb
= cb
->next
)
2737 /* The message and log_message items set up messages to be used in
2738 case of rejection. They are expanded later. */
2740 if (cb
->type
== ACLC_MESSAGE
)
2742 user_message
= cb
->arg
;
2746 if (cb
->type
== ACLC_LOG_MESSAGE
)
2748 log_message
= cb
->arg
;
2752 /* The endpass "condition" just sets a flag to show it occurred. This is
2753 checked at compile time to be on an "accept" or "discard" item. */
2755 if (cb
->type
== ACLC_ENDPASS
)
2761 /* For other conditions and modifiers, the argument is expanded now for some
2762 of them, but not for all, because expansion happens down in some lower level
2763 checking functions in some cases. */
2765 if (cond_expand_at_top
[cb
->type
])
2767 arg
= expand_string(cb
->arg
);
2770 if (expand_string_forcedfail
) continue;
2771 *log_msgptr
= string_sprintf("failed to expand ACL string \"%s\": %s",
2772 cb
->arg
, expand_string_message
);
2773 return search_find_defer
? DEFER
: ERROR
;
2778 /* Show condition, and expanded condition if it's different */
2783 debug_printf("check %s%s %n",
2784 (!cond_modifiers
[cb
->type
] && cb
->u
.negated
)? "!":"",
2785 conditions
[cb
->type
], &lhswidth
);
2787 if (cb
->type
== ACLC_SET
)
2789 debug_printf("acl_%s ", cb
->u
.varname
);
2790 lhswidth
+= 5 + Ustrlen(cb
->u
.varname
);
2793 debug_printf("= %s\n", cb
->arg
);
2796 debug_printf("%.*s= %s\n", lhswidth
,
2800 /* Check that this condition makes sense at this time */
2802 if ((cond_forbids
[cb
->type
] & (1 << where
)) != 0)
2804 *log_msgptr
= string_sprintf("cannot %s %s condition in %s ACL",
2805 cond_modifiers
[cb
->type
]? "use" : "test",
2806 conditions
[cb
->type
], acl_wherenames
[where
]);
2810 /* Run the appropriate test for each condition, or take the appropriate
2811 action for the remaining modifiers. */
2815 case ACLC_ADD_HEADER
:
2819 /* A nested ACL that returns "discard" makes sense only for an "accept" or
2823 rc
= acl_check_wargs(where
, addr
, arg
, level
+1, user_msgptr
, log_msgptr
);
2824 if (rc
== DISCARD
&& verb
!= ACL_ACCEPT
&& verb
!= ACL_DISCARD
)
2826 *log_msgptr
= string_sprintf("nested ACL returned \"discard\" for "
2827 "\"%s\" command (only allowed with \"accept\" or \"discard\")",
2833 case ACLC_AUTHENTICATED
:
2834 rc
= (sender_host_authenticated
== NULL
)? FAIL
:
2835 match_isinlist(sender_host_authenticated
, &arg
, 0, NULL
, NULL
, MCL_STRING
,
2839 #ifdef EXPERIMENTAL_BRIGHTMAIL
2840 case ACLC_BMI_OPTIN
:
2842 int old_pool
= store_pool
;
2843 store_pool
= POOL_PERM
;
2844 bmi_current_optin
= string_copy(arg
);
2845 store_pool
= old_pool
;
2850 case ACLC_CONDITION
:
2851 /* The true/false parsing here should be kept in sync with that used in
2852 expand.c when dealing with ECOND_BOOL so that we don't have too many
2853 different definitions of what can be a boolean. */
2854 if (Ustrspn(arg
, "0123456789") == Ustrlen(arg
)) /* Digits, or empty */
2855 rc
= (Uatoi(arg
) == 0)? FAIL
: OK
;
2857 rc
= (strcmpic(arg
, US
"no") == 0 ||
2858 strcmpic(arg
, US
"false") == 0)? FAIL
:
2859 (strcmpic(arg
, US
"yes") == 0 ||
2860 strcmpic(arg
, US
"true") == 0)? OK
: DEFER
;
2862 *log_msgptr
= string_sprintf("invalid \"condition\" value \"%s\"", arg
);
2865 case ACLC_CONTINUE
: /* Always succeeds */
2869 control_type
= decode_control(arg
, &p
, where
, log_msgptr
);
2871 /* Check if this control makes sense at this time */
2873 if ((control_forbids
[control_type
] & (1 << where
)) != 0)
2875 *log_msgptr
= string_sprintf("cannot use \"control=%s\" in %s ACL",
2876 controls
[control_type
], acl_wherenames
[where
]);
2880 switch(control_type
)
2882 case CONTROL_AUTH_UNADVERTISED
:
2883 allow_auth_unadvertised
= TRUE
;
2886 #ifdef EXPERIMENTAL_BRIGHTMAIL
2887 case CONTROL_BMI_RUN
:
2892 #ifndef DISABLE_DKIM
2893 case CONTROL_DKIM_VERIFY
:
2894 dkim_disable_verify
= TRUE
;
2901 int fd
, af
, level
, optname
, value
;
2902 /* If we are acting on stdin, the setsockopt may fail if stdin is not
2903 a socket; we can accept that, we'll just debug-log failures anyway. */
2904 fd
= fileno(smtp_in
);
2905 af
= ip_get_address_family(fd
);
2909 debug_printf("smtp input is probably not a socket [%s], not setting DSCP\n",
2913 if (dscp_lookup(p
+1, af
, &level
, &optname
, &value
))
2915 if (setsockopt(fd
, level
, optname
, &value
, sizeof(value
)) < 0)
2917 HDEBUG(D_acl
) debug_printf("failed to set input DSCP[%s]: %s\n",
2918 p
+1, strerror(errno
));
2922 HDEBUG(D_acl
) debug_printf("set input DSCP to \"%s\"\n", p
+1);
2927 *log_msgptr
= string_sprintf("unrecognised DSCP value in \"control=%s\"", arg
);
2933 *log_msgptr
= string_sprintf("syntax error in \"control=%s\"", arg
);
2941 case CONTROL_CASEFUL_LOCAL_PART
:
2942 deliver_localpart
= addr
->cc_local_part
;
2945 case CONTROL_CASELOWER_LOCAL_PART
:
2946 deliver_localpart
= addr
->lc_local_part
;
2949 case CONTROL_ENFORCE_SYNC
:
2950 smtp_enforce_sync
= TRUE
;
2953 case CONTROL_NO_ENFORCE_SYNC
:
2954 smtp_enforce_sync
= FALSE
;
2957 #ifdef WITH_CONTENT_SCAN
2958 case CONTROL_NO_MBOX_UNSPOOL
:
2959 no_mbox_unspool
= TRUE
;
2963 case CONTROL_NO_MULTILINE
:
2964 no_multiline_responses
= TRUE
;
2967 case CONTROL_NO_PIPELINING
:
2968 pipelining_enable
= FALSE
;
2971 case CONTROL_NO_DELAY_FLUSH
:
2972 disable_delay_flush
= TRUE
;
2975 case CONTROL_NO_CALLOUT_FLUSH
:
2976 disable_callout_flush
= TRUE
;
2979 case CONTROL_FAKEDEFER
:
2980 case CONTROL_FAKEREJECT
:
2981 fake_response
= (control_type
== CONTROL_FAKEDEFER
) ? DEFER
: FAIL
;
2985 while (*pp
!= 0) pp
++;
2986 fake_response_text
= expand_string(string_copyn(p
+1, pp
-p
-1));
2991 /* Explicitly reset to default string */
2992 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).";
2996 case CONTROL_FREEZE
:
2997 deliver_freeze
= TRUE
;
2998 deliver_frozen_at
= time(NULL
);
2999 freeze_tell
= freeze_tell_config
; /* Reset to configured value */
3000 if (Ustrncmp(p
, "/no_tell", 8) == 0)
3007 *log_msgptr
= string_sprintf("syntax error in \"control=%s\"", arg
);
3012 case CONTROL_QUEUE_ONLY
:
3013 queue_only_policy
= TRUE
;
3016 case CONTROL_SUBMISSION
:
3017 originator_name
= US
"";
3018 submission_mode
= TRUE
;
3021 if (Ustrncmp(p
, "/sender_retain", 14) == 0)
3024 active_local_sender_retain
= TRUE
;
3025 active_local_from_check
= FALSE
;
3027 else if (Ustrncmp(p
, "/domain=", 8) == 0)
3030 while (*pp
!= 0 && *pp
!= '/') pp
++;
3031 submission_domain
= string_copyn(p
+8, pp
-p
-8);
3034 /* The name= option must be last, because it swallows the rest of
3036 else if (Ustrncmp(p
, "/name=", 6) == 0)
3039 while (*pp
!= 0) pp
++;
3040 submission_name
= string_copy(parse_fix_phrase(p
+6, pp
-p
-6,
3041 big_buffer
, big_buffer_size
));
3048 *log_msgptr
= string_sprintf("syntax error in \"control=%s\"", arg
);
3056 if (Ustrncmp(p
, "/tag=", 5) == 0)
3059 while (*pp
!= '\0' && *pp
!= '/') pp
++;
3060 debug_tag
= string_copyn(p
+5, pp
-p
-5);
3063 else if (Ustrncmp(p
, "/opts=", 6) == 0)
3066 while (*pp
!= '\0' && *pp
!= '/') pp
++;
3067 debug_opts
= string_copyn(p
+6, pp
-p
-6);
3071 debug_logging_activate(debug_tag
, debug_opts
);
3074 case CONTROL_SUPPRESS_LOCAL_FIXUPS
:
3075 suppress_local_fixups
= TRUE
;
3078 case CONTROL_CUTTHROUGH_DELIVERY
:
3081 *log_msgptr
= string_sprintf("\"control=%s\" on frozen item", arg
);
3084 if (queue_only_policy
)
3086 *log_msgptr
= string_sprintf("\"control=%s\" on queue-only item", arg
);
3089 cutthrough_delivery
= TRUE
;
3094 #ifdef EXPERIMENTAL_DCC
3097 /* Seperate the regular expression and any optional parameters. */
3098 uschar
*ss
= string_nextinlist(&arg
, &sep
, big_buffer
, big_buffer_size
);
3099 /* Run the dcc backend. */
3100 rc
= dcc_process(&ss
);
3101 /* Modify return code based upon the existance of options. */
3102 while ((ss
= string_nextinlist(&arg
, &sep
, big_buffer
, big_buffer_size
))
3104 if (strcmpic(ss
, US
"defer_ok") == 0 && rc
== DEFER
)
3106 /* FAIL so that the message is passed to the next ACL */
3114 #ifdef WITH_CONTENT_SCAN
3116 rc
= mime_decode(&arg
);
3122 int delay
= readconf_readtime(arg
, 0, FALSE
);
3125 *log_msgptr
= string_sprintf("syntax error in argument for \"delay\" "
3126 "modifier: \"%s\" is not a time value", arg
);
3131 HDEBUG(D_acl
) debug_printf("delay modifier requests %d-second delay\n",
3136 debug_printf("delay skipped in -bh checking mode\n");
3139 /* It appears to be impossible to detect that a TCP/IP connection has
3140 gone away without reading from it. This means that we cannot shorten
3141 the delay below if the client goes away, because we cannot discover
3142 that the client has closed its end of the connection. (The connection
3143 is actually in a half-closed state, waiting for the server to close its
3144 end.) It would be nice to be able to detect this state, so that the
3145 Exim process is not held up unnecessarily. However, it seems that we
3146 can't. The poll() function does not do the right thing, and in any case
3147 it is not always available.
3149 NOTE 1: If ever this state of affairs changes, remember that we may be
3150 dealing with stdin/stdout here, in addition to TCP/IP connections.
3151 Also, delays may be specified for non-SMTP input, where smtp_out and
3152 smtp_in will be NULL. Whatever is done must work in all cases.
3154 NOTE 2: The added feature of flushing the output before a delay must
3155 apply only to SMTP input. Hence the test for smtp_out being non-NULL.
3160 if (smtp_out
!= NULL
&& !disable_delay_flush
) mac_smtp_fflush();
3161 while (delay
> 0) delay
= sleep(delay
);
3167 #ifdef WITH_OLD_DEMIME
3173 #ifndef DISABLE_DKIM
3174 case ACLC_DKIM_SIGNER
:
3175 if (dkim_cur_signer
!= NULL
)
3176 rc
= match_isinlist(dkim_cur_signer
,
3177 &arg
,0,NULL
,NULL
,MCL_STRING
,TRUE
,NULL
);
3182 case ACLC_DKIM_STATUS
:
3183 rc
= match_isinlist(dkim_exim_expand_query(DKIM_VERIFY_STATUS
),
3184 &arg
,0,NULL
,NULL
,MCL_STRING
,TRUE
,NULL
);
3189 rc
= verify_check_dnsbl(&arg
);
3193 rc
= match_isinlist(addr
->domain
, &arg
, 0, &domainlist_anchor
,
3194 addr
->domain_cache
, MCL_DOMAIN
, TRUE
, &deliver_domain_data
);
3197 /* The value in tls_cipher is the full cipher name, for example,
3198 TLSv1:DES-CBC3-SHA:168, whereas the values to test for are just the
3199 cipher names such as DES-CBC3-SHA. But program defensively. We don't know
3200 what may in practice come out of the SSL library - which at the time of
3201 writing is poorly documented. */
3203 case ACLC_ENCRYPTED
:
3204 if (tls_in
.cipher
== NULL
) rc
= FAIL
; else
3206 uschar
*endcipher
= NULL
;
3207 uschar
*cipher
= Ustrchr(tls_in
.cipher
, ':');
3208 if (cipher
== NULL
) cipher
= tls_in
.cipher
; else
3210 endcipher
= Ustrchr(++cipher
, ':');
3211 if (endcipher
!= NULL
) *endcipher
= 0;
3213 rc
= match_isinlist(cipher
, &arg
, 0, NULL
, NULL
, MCL_STRING
, TRUE
, NULL
);
3214 if (endcipher
!= NULL
) *endcipher
= ':';
3218 /* Use verify_check_this_host() instead of verify_check_host() so that
3219 we can pass over &host_data to catch any looked up data. Once it has been
3220 set, it retains its value so that it's still there if another ACL verb
3221 comes through here and uses the cache. However, we must put it into
3222 permanent store in case it is also expected to be used in a subsequent
3223 message in the same SMTP connection. */
3226 rc
= verify_check_this_host(&arg
, sender_host_cache
, NULL
,
3227 (sender_host_address
== NULL
)? US
"" : sender_host_address
, &host_data
);
3228 if (host_data
!= NULL
) host_data
= string_copy_malloc(host_data
);
3231 case ACLC_LOCAL_PARTS
:
3232 rc
= match_isinlist(addr
->cc_local_part
, &arg
, 0,
3233 &localpartlist_anchor
, addr
->localpart_cache
, MCL_LOCALPART
, TRUE
,
3234 &deliver_localpart_data
);
3237 case ACLC_LOG_REJECT_TARGET
:
3243 while ((ss
= string_nextinlist(&s
, &sep
, big_buffer
, big_buffer_size
))
3246 if (Ustrcmp(ss
, "main") == 0) logbits
|= LOG_MAIN
;
3247 else if (Ustrcmp(ss
, "panic") == 0) logbits
|= LOG_PANIC
;
3248 else if (Ustrcmp(ss
, "reject") == 0) logbits
|= LOG_REJECT
;
3251 logbits
|= LOG_MAIN
|LOG_REJECT
;
3252 log_write(0, LOG_MAIN
|LOG_PANIC
, "unknown log name \"%s\" in "
3253 "\"log_reject_target\" in %s ACL", ss
, acl_wherenames
[where
]);
3256 log_reject_target
= logbits
;
3269 if (Ustrncmp(s
, "main", 4) == 0)
3270 { logbits
|= LOG_MAIN
; s
+= 4; }
3271 else if (Ustrncmp(s
, "panic", 5) == 0)
3272 { logbits
|= LOG_PANIC
; s
+= 5; }
3273 else if (Ustrncmp(s
, "reject", 6) == 0)
3274 { logbits
|= LOG_REJECT
; s
+= 6; }
3277 logbits
= LOG_MAIN
|LOG_PANIC
;
3278 s
= string_sprintf(":unknown log name in \"%s\" in "
3279 "\"logwrite\" in %s ACL", arg
, acl_wherenames
[where
]);
3285 while (isspace(*s
)) s
++;
3288 if (logbits
== 0) logbits
= LOG_MAIN
;
3289 log_write(0, logbits
, "%s", string_printing(s
));
3293 #ifdef WITH_CONTENT_SCAN
3296 /* Separate the regular expression and any optional parameters. */
3297 uschar
*ss
= string_nextinlist(&arg
, &sep
, big_buffer
, big_buffer_size
);
3298 /* Run the malware backend. */
3300 /* Modify return code based upon the existance of options. */
3301 while ((ss
= string_nextinlist(&arg
, &sep
, big_buffer
, big_buffer_size
))
3303 if (strcmpic(ss
, US
"defer_ok") == 0 && rc
== DEFER
)
3305 /* FAIL so that the message is passed to the next ACL */
3312 case ACLC_MIME_REGEX
:
3313 rc
= mime_regex(&arg
);
3317 case ACLC_RATELIMIT
:
3318 rc
= acl_ratelimit(arg
, where
, log_msgptr
);
3321 case ACLC_RECIPIENTS
:
3322 rc
= match_address_list(addr
->address
, TRUE
, TRUE
, &arg
, NULL
, -1, 0,
3326 #ifdef WITH_CONTENT_SCAN
3332 case ACLC_REMOVE_HEADER
:
3333 setup_remove_header(arg
);
3336 case ACLC_SENDER_DOMAINS
:
3339 sdomain
= Ustrrchr(sender_address
, '@');
3340 sdomain
= (sdomain
== NULL
)? US
"" : sdomain
+ 1;
3341 rc
= match_isinlist(sdomain
, &arg
, 0, &domainlist_anchor
,
3342 sender_domain_cache
, MCL_DOMAIN
, TRUE
, NULL
);
3347 rc
= match_address_list(sender_address
, TRUE
, TRUE
, &arg
,
3348 sender_address_cache
, -1, 0, &sender_data
);
3351 /* Connection variables must persist forever */
3355 int old_pool
= store_pool
;
3356 if (cb
->u
.varname
[0] == 'c') store_pool
= POOL_PERM
;
3357 acl_var_create(cb
->u
.varname
)->data
.ptr
= string_copy(arg
);
3358 store_pool
= old_pool
;
3362 #ifdef WITH_CONTENT_SCAN
3365 /* Seperate the regular expression and any optional parameters. */
3366 uschar
*ss
= string_nextinlist(&arg
, &sep
, big_buffer
, big_buffer_size
);
3367 /* Run the spam backend. */
3369 /* Modify return code based upon the existance of options. */
3370 while ((ss
= string_nextinlist(&arg
, &sep
, big_buffer
, big_buffer_size
))
3372 if (strcmpic(ss
, US
"defer_ok") == 0 && rc
== DEFER
)
3374 /* FAIL so that the message is passed to the next ACL */
3382 #ifdef EXPERIMENTAL_SPF
3384 rc
= spf_process(&arg
, sender_address
, SPF_PROCESS_NORMAL
);
3386 case ACLC_SPF_GUESS
:
3387 rc
= spf_process(&arg
, sender_address
, SPF_PROCESS_GUESS
);
3391 /* If the verb is WARN, discard any user message from verification, because
3392 such messages are SMTP responses, not header additions. The latter come
3393 only from explicit "message" modifiers. However, put the user message into
3394 $acl_verify_message so it can be used in subsequent conditions or modifiers
3395 (until something changes it). */
3398 rc
= acl_verify(where
, addr
, arg
, user_msgptr
, log_msgptr
, basic_errno
);
3399 acl_verify_message
= *user_msgptr
;
3400 if (verb
== ACL_WARN
) *user_msgptr
= NULL
;
3404 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "internal ACL error: unknown "
3405 "condition %d", cb
->type
);
3409 /* If a condition was negated, invert OK/FAIL. */
3411 if (!cond_modifiers
[cb
->type
] && cb
->u
.negated
)
3413 if (rc
== OK
) rc
= FAIL
;
3414 else if (rc
== FAIL
|| rc
== FAIL_DROP
) rc
= OK
;
3417 if (rc
!= OK
) break; /* Conditions loop */
3421 /* If the result is the one for which "message" and/or "log_message" are used,
3422 handle the values of these modifiers. If there isn't a log message set, we make
3423 it the same as the user message.
3425 "message" is a user message that will be included in an SMTP response. Unless
3426 it is empty, it overrides any previously set user message.
3428 "log_message" is a non-user message, and it adds to any existing non-user
3429 message that is already set.
3431 Most verbs have but a single return for which the messages are relevant, but
3432 for "discard", it's useful to have the log message both when it succeeds and
3433 when it fails. For "accept", the message is used in the OK case if there is no
3434 "endpass", but (for backwards compatibility) in the FAIL case if "endpass" is
3437 if (*epp
&& rc
== OK
) user_message
= NULL
;
3439 if (((1<<rc
) & msgcond
[verb
]) != 0)
3442 uschar
*old_user_msgptr
= *user_msgptr
;
3443 uschar
*old_log_msgptr
= (*log_msgptr
!= NULL
)? *log_msgptr
: old_user_msgptr
;
3445 /* If the verb is "warn", messages generated by conditions (verification or
3446 nested ACLs) are always discarded. This also happens for acceptance verbs
3447 when they actually do accept. Only messages specified at this level are used.
3448 However, the value of an existing message is available in $acl_verify_message
3449 during expansions. */
3451 if (verb
== ACL_WARN
||
3452 (rc
== OK
&& (verb
== ACL_ACCEPT
|| verb
== ACL_DISCARD
)))
3453 *log_msgptr
= *user_msgptr
= NULL
;
3455 if (user_message
!= NULL
)
3457 acl_verify_message
= old_user_msgptr
;
3458 expmessage
= expand_string(user_message
);
3459 if (expmessage
== NULL
)
3461 if (!expand_string_forcedfail
)
3462 log_write(0, LOG_MAIN
|LOG_PANIC
, "failed to expand ACL message \"%s\": %s",
3463 user_message
, expand_string_message
);
3465 else if (expmessage
[0] != 0) *user_msgptr
= expmessage
;
3468 if (log_message
!= NULL
)
3470 acl_verify_message
= old_log_msgptr
;
3471 expmessage
= expand_string(log_message
);
3472 if (expmessage
== NULL
)
3474 if (!expand_string_forcedfail
)
3475 log_write(0, LOG_MAIN
|LOG_PANIC
, "failed to expand ACL message \"%s\": %s",
3476 log_message
, expand_string_message
);
3478 else if (expmessage
[0] != 0)
3480 *log_msgptr
= (*log_msgptr
== NULL
)? expmessage
:
3481 string_sprintf("%s: %s", expmessage
, *log_msgptr
);
3485 /* If no log message, default it to the user message */
3487 if (*log_msgptr
== NULL
) *log_msgptr
= *user_msgptr
;
3490 acl_verify_message
= NULL
;
3498 /*************************************************
3499 * Get line from a literal ACL *
3500 *************************************************/
3502 /* This function is passed to acl_read() in order to extract individual lines
3503 of a literal ACL, which we access via static pointers. We can destroy the
3504 contents because this is called only once (the compiled ACL is remembered).
3506 This code is intended to treat the data in the same way as lines in the main
3507 Exim configuration file. That is:
3509 . Leading spaces are ignored.
3511 . A \ at the end of a line is a continuation - trailing spaces after the \
3512 are permitted (this is because I don't believe in making invisible things
3513 significant). Leading spaces on the continued part of a line are ignored.
3515 . Physical lines starting (significantly) with # are totally ignored, and
3516 may appear within a sequence of backslash-continued lines.
3518 . Blank lines are ignored, but will end a sequence of continuations.
3521 Returns: a pointer to the next line
3525 static uschar
*acl_text
; /* Current pointer in the text */
3526 static uschar
*acl_text_end
; /* Points one past the terminating '0' */
3534 /* This loop handles leading blank lines and comments. */
3538 while (isspace(*acl_text
)) acl_text
++; /* Leading spaces/empty lines */
3539 if (*acl_text
== 0) return NULL
; /* No more data */
3540 yield
= acl_text
; /* Potential data line */
3542 while (*acl_text
!= 0 && *acl_text
!= '\n') acl_text
++;
3544 /* If we hit the end before a newline, we have the whole logical line. If
3545 it's a comment, there's no more data to be given. Otherwise, yield it. */
3547 if (*acl_text
== 0) return (*yield
== '#')? NULL
: yield
;
3549 /* After reaching a newline, end this loop if the physical line does not
3550 start with '#'. If it does, it's a comment, and the loop continues. */
3552 if (*yield
!= '#') break;
3555 /* This loop handles continuations. We know we have some real data, ending in
3556 newline. See if there is a continuation marker at the end (ignoring trailing
3557 white space). We know that *yield is not white space, so no need to test for
3558 cont > yield in the backwards scanning loop. */
3563 for (cont
= acl_text
- 1; isspace(*cont
); cont
--);
3565 /* If no continuation follows, we are done. Mark the end of the line and
3574 /* We have encountered a continuation. Skip over whitespace at the start of
3575 the next line, and indeed the whole of the next line or lines if they are
3580 while (*(++acl_text
) == ' ' || *acl_text
== '\t');
3581 if (*acl_text
!= '#') break;
3582 while (*(++acl_text
) != 0 && *acl_text
!= '\n');
3585 /* We have the start of a continuation line. Move all the rest of the data
3586 to join onto the previous line, and then find its end. If the end is not a
3587 newline, we are done. Otherwise loop to look for another continuation. */
3589 memmove(cont
, acl_text
, acl_text_end
- acl_text
);
3590 acl_text_end
-= acl_text
- cont
;
3592 while (*acl_text
!= 0 && *acl_text
!= '\n') acl_text
++;
3593 if (*acl_text
== 0) return yield
;
3596 /* Control does not reach here */
3603 /*************************************************
3604 * Check access using an ACL *
3605 *************************************************/
3607 /* This function is called from address_check. It may recurse via
3608 acl_check_condition() - hence the use of a level to stop looping. The ACL is
3609 passed as a string which is expanded. A forced failure implies no access check
3610 is required. If the result is a single word, it is taken as the name of an ACL
3611 which is sought in the global ACL tree. Otherwise, it is taken as literal ACL
3612 text, complete with newlines, and parsed as such. In both cases, the ACL check
3613 is then run. This function uses an auxiliary function for acl_read() to call
3614 for reading individual lines of a literal ACL. This is acl_getline(), which
3615 appears immediately above.
3618 where where called from
3619 addr address item when called from RCPT; otherwise NULL
3620 s the input string; NULL is the same as an empty ACL => DENY
3621 level the nesting level
3622 user_msgptr where to put a user error (for SMTP response)
3623 log_msgptr where to put a logging message (not for SMTP response)
3625 Returns: OK access is granted
3626 DISCARD access is apparently granted...
3627 FAIL access is denied
3628 FAIL_DROP access is denied; drop the connection
3629 DEFER can't tell at the moment
3634 acl_check_internal(int where
, address_item
*addr
, uschar
*s
, int level
,
3635 uschar
**user_msgptr
, uschar
**log_msgptr
)
3638 acl_block
*acl
= NULL
;
3639 uschar
*acl_name
= US
"inline ACL";
3642 /* Catch configuration loops */
3646 *log_msgptr
= US
"ACL nested too deep: possible loop";
3652 HDEBUG(D_acl
) debug_printf("ACL is NULL: implicit DENY\n");
3656 /* At top level, we expand the incoming string. At lower levels, it has already
3657 been expanded as part of condition processing. */
3661 ss
= expand_string(s
);
3664 if (expand_string_forcedfail
) return OK
;
3665 *log_msgptr
= string_sprintf("failed to expand ACL string \"%s\": %s", s
,
3666 expand_string_message
);
3672 while (isspace(*ss
))ss
++;
3674 /* If we can't find a named ACL, the default is to parse it as an inline one.
3675 (Unless it begins with a slash; non-existent files give rise to an error.) */
3679 /* Handle the case of a string that does not contain any spaces. Look for a
3680 named ACL among those read from the configuration, or a previously read file.
3681 It is possible that the pointer to the ACL is NULL if the configuration
3682 contains a name with no data. If not found, and the text begins with '/',
3683 read an ACL from a file, and save it so it can be re-used. */
3685 if (Ustrchr(ss
, ' ') == NULL
)
3687 tree_node
*t
= tree_search(acl_anchor
, ss
);
3690 acl
= (acl_block
*)(t
->data
.ptr
);
3693 HDEBUG(D_acl
) debug_printf("ACL \"%s\" is empty: implicit DENY\n", ss
);
3696 acl_name
= string_sprintf("ACL \"%s\"", ss
);
3697 HDEBUG(D_acl
) debug_printf("using ACL \"%s\"\n", ss
);
3700 else if (*ss
== '/')
3702 struct stat statbuf
;
3703 fd
= Uopen(ss
, O_RDONLY
, 0);
3706 *log_msgptr
= string_sprintf("failed to open ACL file \"%s\": %s", ss
,
3711 if (fstat(fd
, &statbuf
) != 0)
3713 *log_msgptr
= string_sprintf("failed to fstat ACL file \"%s\": %s", ss
,
3718 acl_text
= store_get(statbuf
.st_size
+ 1);
3719 acl_text_end
= acl_text
+ statbuf
.st_size
+ 1;
3721 if (read(fd
, acl_text
, statbuf
.st_size
) != statbuf
.st_size
)
3723 *log_msgptr
= string_sprintf("failed to read ACL file \"%s\": %s",
3724 ss
, strerror(errno
));
3727 acl_text
[statbuf
.st_size
] = 0;
3730 acl_name
= string_sprintf("ACL \"%s\"", ss
);
3731 HDEBUG(D_acl
) debug_printf("read ACL from file %s\n", ss
);
3735 /* Parse an ACL that is still in text form. If it came from a file, remember it
3736 in the ACL tree, having read it into the POOL_PERM store pool so that it
3737 persists between multiple messages. */
3741 int old_pool
= store_pool
;
3742 if (fd
>= 0) store_pool
= POOL_PERM
;
3743 acl
= acl_read(acl_getline
, log_msgptr
);
3744 store_pool
= old_pool
;
3745 if (acl
== NULL
&& *log_msgptr
!= NULL
) return ERROR
;
3748 tree_node
*t
= store_get_perm(sizeof(tree_node
) + Ustrlen(ss
));
3749 Ustrcpy(t
->name
, ss
);
3751 (void)tree_insertnode(&acl_anchor
, t
);
3755 /* Now we have an ACL to use. It's possible it may be NULL. */
3760 int basic_errno
= 0;
3761 BOOL endpass_seen
= FALSE
;
3763 *log_msgptr
= *user_msgptr
= NULL
;
3764 acl_temp_details
= FALSE
;
3766 if ((where
== ACL_WHERE_QUIT
|| where
== ACL_WHERE_NOTQUIT
) &&
3767 acl
->verb
!= ACL_ACCEPT
&&
3768 acl
->verb
!= ACL_WARN
)
3770 *log_msgptr
= string_sprintf("\"%s\" is not allowed in a QUIT or not-QUIT ACL",
3775 HDEBUG(D_acl
) debug_printf("processing \"%s\"\n", verbs
[acl
->verb
]);
3777 /* Clear out any search error message from a previous check before testing
3780 search_error_message
= NULL
;
3781 cond
= acl_check_condition(acl
->verb
, acl
->condition
, where
, addr
, level
,
3782 &endpass_seen
, user_msgptr
, log_msgptr
, &basic_errno
);
3784 /* Handle special returns: DEFER causes a return except on a WARN verb;
3785 ERROR always causes a return. */
3790 HDEBUG(D_acl
) debug_printf("%s: condition test deferred in %s\n", verbs
[acl
->verb
], acl_name
);
3791 if (basic_errno
!= ERRNO_CALLOUTDEFER
)
3793 if (search_error_message
!= NULL
&& *search_error_message
!= 0)
3794 *log_msgptr
= search_error_message
;
3795 if (smtp_return_error_details
) acl_temp_details
= TRUE
;
3799 acl_temp_details
= TRUE
;
3801 if (acl
->verb
!= ACL_WARN
) return DEFER
;
3804 default: /* Paranoia */
3806 HDEBUG(D_acl
) debug_printf("%s: condition test error in %s\n", verbs
[acl
->verb
], acl_name
);
3810 HDEBUG(D_acl
) debug_printf("%s: condition test succeeded in %s\n",
3811 verbs
[acl
->verb
], acl_name
);
3815 HDEBUG(D_acl
) debug_printf("%s: condition test failed in %s\n", verbs
[acl
->verb
], acl_name
);
3818 /* DISCARD and DROP can happen only from a nested ACL condition, and
3819 DISCARD can happen only for an "accept" or "discard" verb. */
3822 HDEBUG(D_acl
) debug_printf("%s: condition test yielded \"discard\" in %s\n",
3823 verbs
[acl
->verb
], acl_name
);
3827 HDEBUG(D_acl
) debug_printf("%s: condition test yielded \"drop\" in %s\n",
3828 verbs
[acl
->verb
], acl_name
);
3832 /* At this point, cond for most verbs is either OK or FAIL or (as a result of
3833 a nested ACL condition) FAIL_DROP. However, for WARN, cond may be DEFER, and
3834 for ACCEPT and DISCARD, it may be DISCARD after a nested ACL call. */
3839 if (cond
== OK
|| cond
== DISCARD
) return cond
;
3842 HDEBUG(D_acl
) debug_printf("accept: endpass encountered - denying access\n");
3850 acl_temp_details
= TRUE
;
3856 if (cond
== OK
) return FAIL
;
3860 if (cond
== OK
|| cond
== DISCARD
) return DISCARD
;
3863 HDEBUG(D_acl
) debug_printf("discard: endpass encountered - denying access\n");
3869 if (cond
== OK
) return FAIL_DROP
;
3873 if (cond
!= OK
) return cond
;
3878 acl_warn(where
, *user_msgptr
, *log_msgptr
);
3879 else if (cond
== DEFER
&& (log_extra_selector
& LX_acl_warn_skipped
) != 0)
3880 log_write(0, LOG_MAIN
, "%s Warning: ACL \"warn\" statement skipped: "
3881 "condition test deferred%s%s", host_and_ident(TRUE
),
3882 (*log_msgptr
== NULL
)? US
"" : US
": ",
3883 (*log_msgptr
== NULL
)? US
"" : *log_msgptr
);
3884 *log_msgptr
= *user_msgptr
= NULL
; /* In case implicit DENY follows */
3888 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "internal ACL error: unknown verb %d",
3893 /* Pass to the next ACL item */
3898 /* We have reached the end of the ACL. This is an implicit DENY. */
3900 HDEBUG(D_acl
) debug_printf("end of %s: implicit DENY\n", acl_name
);
3907 /* Same args as acl_check_internal() above, but the string s is
3908 the name of an ACL followed optionally by up to 9 space-separated arguments.
3909 The name and args are separately expanded. Args go into $acl_arg globals. */
3911 acl_check_wargs(int where
, address_item
*addr
, uschar
*s
, int level
,
3912 uschar
**user_msgptr
, uschar
**log_msgptr
)
3915 uschar
* tmp_arg
[9]; /* must match acl_arg[] */
3919 if (!(tmp
= string_dequote(&s
)) || !(name
= expand_string(tmp
)))
3922 for (i
= 0; i
< 9; i
++)
3924 while (*s
&& isspace(*s
)) s
++;
3926 if (!(tmp
= string_dequote(&s
)) || !(tmp_arg
[i
] = expand_string(tmp
)))
3933 for (i
= 0; i
< acl_narg
; i
++) acl_arg
[i
] = tmp_arg
[i
];
3934 while (i
< 9) acl_arg
[i
++] = NULL
;
3936 return acl_check_internal(where
, addr
, name
, level
, user_msgptr
, log_msgptr
);
3939 if (expand_string_forcedfail
) return ERROR
;
3940 *log_msgptr
= string_sprintf("failed to expand ACL string \"%s\": %s",
3941 tmp
, expand_string_message
);
3942 return search_find_defer
?DEFER
:ERROR
;
3947 /*************************************************
3948 * Check access using an ACL *
3949 *************************************************/
3951 /* This is the external interface for ACL checks. It sets up an address and the
3952 expansions for $domain and $local_part when called after RCPT, then calls
3953 acl_check_internal() to do the actual work.
3956 where ACL_WHERE_xxxx indicating where called from
3957 recipient RCPT address for RCPT check, else NULL
3958 s the input string; NULL is the same as an empty ACL => DENY
3959 user_msgptr where to put a user error (for SMTP response)
3960 log_msgptr where to put a logging message (not for SMTP response)
3962 Returns: OK access is granted by an ACCEPT verb
3963 DISCARD access is granted by a DISCARD verb
3964 FAIL access is denied
3965 FAIL_DROP access is denied; drop the connection
3966 DEFER can't tell at the moment
3971 acl_check(int where
, uschar
*recipient
, uschar
*s
, uschar
**user_msgptr
,
3972 uschar
**log_msgptr
)
3976 address_item
*addr
= NULL
;
3978 *user_msgptr
= *log_msgptr
= NULL
;
3979 sender_verified_failed
= NULL
;
3980 ratelimiters_cmd
= NULL
;
3981 log_reject_target
= LOG_MAIN
|LOG_REJECT
;
3983 if (where
== ACL_WHERE_RCPT
)
3985 adb
= address_defaults
;
3987 addr
->address
= recipient
;
3988 if (deliver_split_address(addr
) == DEFER
)
3990 *log_msgptr
= US
"defer in percent_hack_domains check";
3993 deliver_domain
= addr
->domain
;
3994 deliver_localpart
= addr
->local_part
;
3997 rc
= acl_check_internal(where
, addr
, s
, 0, user_msgptr
, log_msgptr
);
3999 /* Cutthrough - if requested,
4000 and WHERE_RCPT and not yet opened conn as result of recipient-verify,
4001 and rcpt acl returned accept,
4002 and first recipient (cancel on any subsequents)
4003 open one now and run it up to RCPT acceptance.
4004 A failed verify should cancel cutthrough request.
4006 Initial implementation: dual-write to spool.
4007 Assume the rxd datastream is now being copied byte-for-byte to an open cutthrough connection.
4009 Cease cutthrough copy on rxd final dot; do not send one.
4011 On a data acl, if not accept and a cutthrough conn is open, hard-close it (no SMTP niceness).
4013 On data acl accept, terminate the dataphase on an open cutthrough conn. If accepted or
4014 perm-rejected, reflect that to the original sender - and dump the spooled copy.
4015 If temp-reject, close the conn (and keep the spooled copy).
4016 If conn-failure, no action (and keep the spooled copy).
4020 case ACL_WHERE_RCPT
:
4021 if( rcpt_count
> 1 )
4022 cancel_cutthrough_connection("more than one recipient");
4023 else if (rc
== OK
&& cutthrough_delivery
&& cutthrough_fd
< 0)
4024 open_cutthrough_connection(addr
);
4027 case ACL_WHERE_PREDATA
:
4029 cutthrough_predata();
4031 cancel_cutthrough_connection("predata acl not ok");
4034 case ACL_WHERE_QUIT
:
4035 case ACL_WHERE_NOTQUIT
:
4036 cancel_cutthrough_connection("quit or notquit");
4043 deliver_domain
= deliver_localpart
= deliver_address_data
=
4044 sender_address_data
= NULL
;
4046 /* A DISCARD response is permitted only for message ACLs, excluding the PREDATA
4047 ACL, which is really in the middle of an SMTP command. */
4051 if (where
> ACL_WHERE_NOTSMTP
|| where
== ACL_WHERE_PREDATA
)
4053 log_write(0, LOG_MAIN
|LOG_PANIC
, "\"discard\" verb not allowed in %s "
4054 "ACL", acl_wherenames
[where
]);
4060 /* A DROP response is not permitted from MAILAUTH */
4062 if (rc
== FAIL_DROP
&& where
== ACL_WHERE_MAILAUTH
)
4064 log_write(0, LOG_MAIN
|LOG_PANIC
, "\"drop\" verb not allowed in %s "
4065 "ACL", acl_wherenames
[where
]);
4069 /* Before giving a response, take a look at the length of any user message, and
4070 split it up into multiple lines if possible. */
4072 *user_msgptr
= string_split_message(*user_msgptr
);
4073 if (fake_response
!= OK
)
4074 fake_response_text
= string_split_message(fake_response_text
);
4081 /*************************************************
4082 * Create ACL variable *
4083 *************************************************/
4085 /* Create an ACL variable or reuse an existing one. ACL variables are in a
4086 binary tree (see tree.c) with acl_var_c and acl_var_m as root nodes.
4089 name pointer to the variable's name, starting with c or m
4091 Returns the pointer to variable's tree node
4095 acl_var_create(uschar
*name
)
4097 tree_node
*node
, **root
;
4098 root
= (name
[0] == 'c')? &acl_var_c
: &acl_var_m
;
4099 node
= tree_search(*root
, name
);
4102 node
= store_get(sizeof(tree_node
) + Ustrlen(name
));
4103 Ustrcpy(node
->name
, name
);
4104 (void)tree_insertnode(root
, node
);
4106 node
->data
.ptr
= NULL
;
4112 /*************************************************
4113 * Write an ACL variable in spool format *
4114 *************************************************/
4116 /* This function is used as a callback for tree_walk when writing variables to
4117 the spool file. To retain spool file compatibility, what is written is -aclc or
4118 -aclm followed by the rest of the name and the data length, space separated,
4119 then the value itself, starting on a new line, and terminated by an additional
4120 newline. When we had only numbered ACL variables, the first line might look
4121 like this: "-aclc 5 20". Now it might be "-aclc foo 20" for the variable called
4125 name of the variable
4126 value of the variable
4127 ctx FILE pointer (as a void pointer)
4133 acl_var_write(uschar
*name
, uschar
*value
, void *ctx
)
4135 FILE *f
= (FILE *)ctx
;
4136 fprintf(f
, "-acl%c %s %d\n%s\n", name
[0], name
+1, Ustrlen(value
), value
);
projects / exim.git / blob