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
94 #ifdef WITH_CONTENT_SCAN
97 #ifdef EXPERIMENTAL_SPF
103 /* ACL conditions/modifiers: "delay", "control", "continue", "endpass",
104 "message", "log_message", "log_reject_target", "logwrite", and "set" are
105 modifiers that look like conditions but always return TRUE. They are used for
106 their side effects. */
108 static uschar
*conditions
[] = {
112 #ifdef EXPERIMENTAL_BRIGHTMAIL
118 #ifdef EXPERIMENTAL_DCC
121 #ifdef WITH_CONTENT_SCAN
125 #ifdef WITH_OLD_DEMIME
139 US
"log_reject_target",
141 #ifdef WITH_CONTENT_SCAN
145 #ifdef WITH_CONTENT_SCAN
150 #ifdef WITH_CONTENT_SCAN
153 US
"sender_domains", US
"senders", US
"set",
154 #ifdef WITH_CONTENT_SCAN
157 #ifdef EXPERIMENTAL_SPF
164 /* Return values from decode_control(); keep in step with the table of names
168 CONTROL_AUTH_UNADVERTISED
,
169 #ifdef EXPERIMENTAL_BRIGHTMAIL
178 CONTROL_CASEFUL_LOCAL_PART
,
179 CONTROL_CASELOWER_LOCAL_PART
,
180 CONTROL_CUTTHROUGH_DELIVERY
,
181 CONTROL_ENFORCE_SYNC
,
182 CONTROL_NO_ENFORCE_SYNC
,
186 CONTROL_SUPPRESS_LOCAL_FIXUPS
,
187 #ifdef WITH_CONTENT_SCAN
188 CONTROL_NO_MBOX_UNSPOOL
,
192 CONTROL_NO_MULTILINE
,
193 CONTROL_NO_PIPELINING
,
194 CONTROL_NO_DELAY_FLUSH
,
195 CONTROL_NO_CALLOUT_FLUSH
198 /* ACL control names; keep in step with the table above! This list is used for
199 turning ids into names. The actual list of recognized names is in the variable
200 control_def controls_list[] below. The fact that there are two lists is a mess
201 and should be tidied up. */
203 static uschar
*controls
[] = {
204 US
"allow_auth_unadvertised",
205 #ifdef EXPERIMENTAL_BRIGHTMAIL
210 US
"dkim_disable_verify",
214 US
"caseful_local_part",
215 US
"caselower_local_part",
216 US
"cutthrough_delivery",
222 US
"suppress_local_fixups",
223 #ifdef WITH_CONTENT_SCAN
228 US
"no_multiline_responses",
234 /* Flags to indicate for which conditions/modifiers a string expansion is done
235 at the outer level. In the other cases, expansion already occurs in the
236 checking functions. */
238 static uschar cond_expand_at_top
[] = {
240 TRUE
, /* add_header */
241 FALSE
, /* authenticated */
242 #ifdef EXPERIMENTAL_BRIGHTMAIL
243 TRUE
, /* bmi_optin */
245 TRUE
, /* condition */
248 #ifdef EXPERIMENTAL_DCC
251 #ifdef WITH_CONTENT_SCAN
255 #ifdef WITH_OLD_DEMIME
259 TRUE
, /* dkim_signers */
260 TRUE
, /* dkim_status */
264 FALSE
, /* encrypted */
267 FALSE
, /* local_parts */
268 TRUE
, /* log_message */
269 TRUE
, /* log_reject_target */
271 #ifdef WITH_CONTENT_SCAN
275 #ifdef WITH_CONTENT_SCAN
276 TRUE
, /* mime_regex */
278 TRUE
, /* ratelimit */
279 FALSE
, /* recipients */
280 #ifdef WITH_CONTENT_SCAN
283 FALSE
, /* sender_domains */
286 #ifdef WITH_CONTENT_SCAN
289 #ifdef EXPERIMENTAL_SPF
291 TRUE
, /* spf_guess */
296 /* Flags to identify the modifiers */
298 static uschar cond_modifiers
[] = {
300 TRUE
, /* add_header */
301 FALSE
, /* authenticated */
302 #ifdef EXPERIMENTAL_BRIGHTMAIL
303 TRUE
, /* bmi_optin */
305 FALSE
, /* condition */
308 #ifdef EXPERIMENTAL_DCC
311 #ifdef WITH_CONTENT_SCAN
315 #ifdef WITH_OLD_DEMIME
319 FALSE
, /* dkim_signers */
320 FALSE
, /* dkim_status */
322 FALSE
, /* dnslists */
324 FALSE
, /* encrypted */
327 FALSE
, /* local_parts */
328 TRUE
, /* log_message */
329 TRUE
, /* log_reject_target */
331 #ifdef WITH_CONTENT_SCAN
335 #ifdef WITH_CONTENT_SCAN
336 FALSE
, /* mime_regex */
338 FALSE
, /* ratelimit */
339 FALSE
, /* recipients */
340 #ifdef WITH_CONTENT_SCAN
343 FALSE
, /* sender_domains */
346 #ifdef WITH_CONTENT_SCAN
349 #ifdef EXPERIMENTAL_SPF
351 FALSE
, /* spf_guess */
356 /* Bit map vector of which conditions and modifiers are not allowed at certain
357 times. For each condition and modifier, there's a bitmap of dis-allowed times.
358 For some, it is easier to specify the negation of a small number of allowed
361 static unsigned int cond_forbids
[] = {
365 ~((1<<ACL_WHERE_MAIL
)|(1<<ACL_WHERE_RCPT
)| /* add_header */
366 (1<<ACL_WHERE_PREDATA
)|(1<<ACL_WHERE_DATA
)|
367 (1<<ACL_WHERE_MIME
)|(1<<ACL_WHERE_NOTSMTP
)|
369 (1<<ACL_WHERE_NOTSMTP_START
)),
371 (1<<ACL_WHERE_NOTSMTP
)| /* authenticated */
372 (1<<ACL_WHERE_NOTSMTP_START
)|
373 (1<<ACL_WHERE_CONNECT
)|(1<<ACL_WHERE_HELO
),
375 #ifdef EXPERIMENTAL_BRIGHTMAIL
376 (1<<ACL_WHERE_AUTH
)| /* bmi_optin */
377 (1<<ACL_WHERE_CONNECT
)|(1<<ACL_WHERE_HELO
)|
378 (1<<ACL_WHERE_DATA
)|(1<<ACL_WHERE_MIME
)|
379 (1<<ACL_WHERE_ETRN
)|(1<<ACL_WHERE_EXPN
)|
380 (1<<ACL_WHERE_MAILAUTH
)|
381 (1<<ACL_WHERE_MAIL
)|(1<<ACL_WHERE_STARTTLS
)|
382 (1<<ACL_WHERE_VRFY
)|(1<<ACL_WHERE_PREDATA
)|
383 (1<<ACL_WHERE_NOTSMTP_START
),
390 /* Certain types of control are always allowed, so we let it through
391 always and check in the control processing itself. */
395 #ifdef EXPERIMENTAL_DCC
397 ~((1<<ACL_WHERE_DATA
)|(1<<ACL_WHERE_NOTSMTP
)), /* dcc */
400 #ifdef WITH_CONTENT_SCAN
402 ~(1<<ACL_WHERE_MIME
), /* decode */
405 (1<<ACL_WHERE_NOTQUIT
), /* delay */
407 #ifdef WITH_OLD_DEMIME
409 ~((1<<ACL_WHERE_DATA
)|(1<<ACL_WHERE_NOTSMTP
)), /* demime */
414 ~(1<<ACL_WHERE_DKIM
), /* dkim_signers */
417 ~(1<<ACL_WHERE_DKIM
), /* dkim_status */
420 (1<<ACL_WHERE_NOTSMTP
)| /* dnslists */
421 (1<<ACL_WHERE_NOTSMTP_START
),
424 ~(1<<ACL_WHERE_RCPT
), /* domains */
426 (1<<ACL_WHERE_NOTSMTP
)| /* encrypted */
427 (1<<ACL_WHERE_CONNECT
)|
428 (1<<ACL_WHERE_NOTSMTP_START
)|
433 (1<<ACL_WHERE_NOTSMTP
)| /* hosts */
434 (1<<ACL_WHERE_NOTSMTP_START
),
437 ~(1<<ACL_WHERE_RCPT
), /* local_parts */
441 0, /* log_reject_target */
445 #ifdef WITH_CONTENT_SCAN
447 ~((1<<ACL_WHERE_DATA
)|(1<<ACL_WHERE_NOTSMTP
)), /* malware */
452 #ifdef WITH_CONTENT_SCAN
454 ~(1<<ACL_WHERE_MIME
), /* mime_regex */
460 ~(1<<ACL_WHERE_RCPT
), /* recipients */
462 #ifdef WITH_CONTENT_SCAN
464 ~((1<<ACL_WHERE_DATA
)|(1<<ACL_WHERE_NOTSMTP
)| /* regex */
465 (1<<ACL_WHERE_MIME
)),
468 (1<<ACL_WHERE_AUTH
)|(1<<ACL_WHERE_CONNECT
)| /* sender_domains */
470 (1<<ACL_WHERE_MAILAUTH
)|(1<<ACL_WHERE_QUIT
)|
471 (1<<ACL_WHERE_ETRN
)|(1<<ACL_WHERE_EXPN
)|
472 (1<<ACL_WHERE_STARTTLS
)|(1<<ACL_WHERE_VRFY
),
474 (1<<ACL_WHERE_AUTH
)|(1<<ACL_WHERE_CONNECT
)| /* senders */
476 (1<<ACL_WHERE_MAILAUTH
)|(1<<ACL_WHERE_QUIT
)|
477 (1<<ACL_WHERE_ETRN
)|(1<<ACL_WHERE_EXPN
)|
478 (1<<ACL_WHERE_STARTTLS
)|(1<<ACL_WHERE_VRFY
),
482 #ifdef WITH_CONTENT_SCAN
484 ~((1<<ACL_WHERE_DATA
)|(1<<ACL_WHERE_NOTSMTP
)), /* spam */
487 #ifdef EXPERIMENTAL_SPF
488 (1<<ACL_WHERE_AUTH
)|(1<<ACL_WHERE_CONNECT
)| /* spf */
490 (1<<ACL_WHERE_MAILAUTH
)|
491 (1<<ACL_WHERE_ETRN
)|(1<<ACL_WHERE_EXPN
)|
492 (1<<ACL_WHERE_STARTTLS
)|(1<<ACL_WHERE_VRFY
)|
493 (1<<ACL_WHERE_NOTSMTP
)|
494 (1<<ACL_WHERE_NOTSMTP_START
),
496 (1<<ACL_WHERE_AUTH
)|(1<<ACL_WHERE_CONNECT
)| /* spf_guess */
498 (1<<ACL_WHERE_MAILAUTH
)|
499 (1<<ACL_WHERE_ETRN
)|(1<<ACL_WHERE_EXPN
)|
500 (1<<ACL_WHERE_STARTTLS
)|(1<<ACL_WHERE_VRFY
)|
501 (1<<ACL_WHERE_NOTSMTP
)|
502 (1<<ACL_WHERE_NOTSMTP_START
),
505 /* Certain types of verify are always allowed, so we let it through
506 always and check in the verify function itself */
512 /* Bit map vector of which controls are not allowed at certain times. For
513 each control, there's a bitmap of dis-allowed times. For some, it is easier to
514 specify the negation of a small number of allowed times. */
516 static unsigned int control_forbids
[] = {
518 ~((1<<ACL_WHERE_CONNECT
)|(1<<ACL_WHERE_HELO
)), /* allow_auth_unadvertised */
520 #ifdef EXPERIMENTAL_BRIGHTMAIL
527 (1<<ACL_WHERE_DATA
)|(1<<ACL_WHERE_NOTSMTP
)| /* dkim_disable_verify */
528 (1<<ACL_WHERE_NOTSMTP_START
),
531 (1<<ACL_WHERE_NOTSMTP
)|
532 (1<<ACL_WHERE_NOTSMTP_START
)|
533 (1<<ACL_WHERE_NOTQUIT
), /* dscp */
538 ~(1<<ACL_WHERE_RCPT
), /* caseful_local_part */
541 ~(1<<ACL_WHERE_RCPT
), /* caselower_local_part */
544 0, /* cutthrough_delivery */
546 (1<<ACL_WHERE_NOTSMTP
)| /* enforce_sync */
547 (1<<ACL_WHERE_NOTSMTP_START
),
549 (1<<ACL_WHERE_NOTSMTP
)| /* no_enforce_sync */
550 (1<<ACL_WHERE_NOTSMTP_START
),
553 ~((1<<ACL_WHERE_MAIL
)|(1<<ACL_WHERE_RCPT
)| /* freeze */
554 (1<<ACL_WHERE_PREDATA
)|(1<<ACL_WHERE_DATA
)|
555 (1<<ACL_WHERE_NOTSMTP
)|(1<<ACL_WHERE_MIME
)),
558 ~((1<<ACL_WHERE_MAIL
)|(1<<ACL_WHERE_RCPT
)| /* queue_only */
559 (1<<ACL_WHERE_PREDATA
)|(1<<ACL_WHERE_DATA
)|
560 (1<<ACL_WHERE_NOTSMTP
)|(1<<ACL_WHERE_MIME
)),
563 ~((1<<ACL_WHERE_MAIL
)|(1<<ACL_WHERE_RCPT
)| /* submission */
564 (1<<ACL_WHERE_PREDATA
)),
567 ~((1<<ACL_WHERE_MAIL
)|(1<<ACL_WHERE_RCPT
)| /* suppress_local_fixups */
568 (1<<ACL_WHERE_PREDATA
)|
569 (1<<ACL_WHERE_NOTSMTP_START
)),
571 #ifdef WITH_CONTENT_SCAN
573 ~((1<<ACL_WHERE_MAIL
)|(1<<ACL_WHERE_RCPT
)| /* no_mbox_unspool */
574 (1<<ACL_WHERE_PREDATA
)|(1<<ACL_WHERE_DATA
)|
575 (1<<ACL_WHERE_MIME
)),
579 ~((1<<ACL_WHERE_MAIL
)|(1<<ACL_WHERE_RCPT
)| /* fakedefer */
580 (1<<ACL_WHERE_PREDATA
)|(1<<ACL_WHERE_DATA
)|
581 (1<<ACL_WHERE_MIME
)),
584 ~((1<<ACL_WHERE_MAIL
)|(1<<ACL_WHERE_RCPT
)| /* fakereject */
585 (1<<ACL_WHERE_PREDATA
)|(1<<ACL_WHERE_DATA
)|
586 (1<<ACL_WHERE_MIME
)),
588 (1<<ACL_WHERE_NOTSMTP
)| /* no_multiline */
589 (1<<ACL_WHERE_NOTSMTP_START
),
591 (1<<ACL_WHERE_NOTSMTP
)| /* no_pipelining */
592 (1<<ACL_WHERE_NOTSMTP_START
),
594 (1<<ACL_WHERE_NOTSMTP
)| /* no_delay_flush */
595 (1<<ACL_WHERE_NOTSMTP_START
),
597 (1<<ACL_WHERE_NOTSMTP
)| /* no_callout_flush */
598 (1<<ACL_WHERE_NOTSMTP_START
)
601 /* Structure listing various control arguments, with their characteristics. */
603 typedef struct control_def
{
605 int value
; /* CONTROL_xxx value */
606 BOOL has_option
; /* Has /option(s) following */
609 static control_def controls_list
[] = {
610 { US
"allow_auth_unadvertised", CONTROL_AUTH_UNADVERTISED
, FALSE
},
611 #ifdef EXPERIMENTAL_BRIGHTMAIL
612 { US
"bmi_run", CONTROL_BMI_RUN
, FALSE
},
614 { US
"debug", CONTROL_DEBUG
, TRUE
},
616 { US
"dkim_disable_verify", CONTROL_DKIM_VERIFY
, FALSE
},
618 { US
"dscp", CONTROL_DSCP
, TRUE
},
619 { US
"caseful_local_part", CONTROL_CASEFUL_LOCAL_PART
, FALSE
},
620 { US
"caselower_local_part", CONTROL_CASELOWER_LOCAL_PART
, FALSE
},
621 { US
"enforce_sync", CONTROL_ENFORCE_SYNC
, FALSE
},
622 { US
"freeze", CONTROL_FREEZE
, TRUE
},
623 { US
"no_callout_flush", CONTROL_NO_CALLOUT_FLUSH
, FALSE
},
624 { US
"no_delay_flush", CONTROL_NO_DELAY_FLUSH
, FALSE
},
625 { US
"no_enforce_sync", CONTROL_NO_ENFORCE_SYNC
, FALSE
},
626 { US
"no_multiline_responses", CONTROL_NO_MULTILINE
, FALSE
},
627 { US
"no_pipelining", CONTROL_NO_PIPELINING
, FALSE
},
628 { US
"queue_only", CONTROL_QUEUE_ONLY
, FALSE
},
629 #ifdef WITH_CONTENT_SCAN
630 { US
"no_mbox_unspool", CONTROL_NO_MBOX_UNSPOOL
, FALSE
},
632 { US
"fakedefer", CONTROL_FAKEDEFER
, TRUE
},
633 { US
"fakereject", CONTROL_FAKEREJECT
, TRUE
},
634 { US
"submission", CONTROL_SUBMISSION
, TRUE
},
635 { US
"suppress_local_fixups", CONTROL_SUPPRESS_LOCAL_FIXUPS
, FALSE
},
636 { US
"cutthrough_delivery", CONTROL_CUTTHROUGH_DELIVERY
, FALSE
}
639 /* Support data structures for Client SMTP Authorization. acl_verify_csa()
640 caches its result in a tree to avoid repeated DNS queries. The result is an
641 integer code which is used as an index into the following tables of
642 explanatory strings and verification return codes. */
644 static tree_node
*csa_cache
= NULL
;
646 enum { CSA_UNKNOWN
, CSA_OK
, CSA_DEFER_SRV
, CSA_DEFER_ADDR
,
647 CSA_FAIL_EXPLICIT
, CSA_FAIL_DOMAIN
, CSA_FAIL_NOADDR
, CSA_FAIL_MISMATCH
};
649 /* The acl_verify_csa() return code is translated into an acl_verify() return
650 code using the following table. It is OK unless the client is definitely not
651 authorized. This is because CSA is supposed to be optional for sending sites,
652 so recipients should not be too strict about checking it - especially because
653 DNS problems are quite likely to occur. It's possible to use $csa_status in
654 further ACL conditions to distinguish ok, unknown, and defer if required, but
655 the aim is to make the usual configuration simple. */
657 static int csa_return_code
[] = {
659 FAIL
, FAIL
, FAIL
, FAIL
662 static uschar
*csa_status_string
[] = {
663 US
"unknown", US
"ok", US
"defer", US
"defer",
664 US
"fail", US
"fail", US
"fail", US
"fail"
667 static uschar
*csa_reason_string
[] = {
670 US
"deferred (SRV lookup failed)",
671 US
"deferred (target address lookup failed)",
672 US
"failed (explicit authorization required)",
673 US
"failed (host name not authorized)",
674 US
"failed (no authorized addresses)",
675 US
"failed (client address mismatch)"
678 /* Options for the ratelimit condition. Note that there are two variants of
679 the per_rcpt option, depending on the ACL that is used to measure the rate.
680 However any ACL must be able to look up per_rcpt rates in /noupdate mode,
681 so the two variants must have the same internal representation as well as
682 the same configuration string. */
685 RATE_PER_WHAT
, RATE_PER_CLASH
, RATE_PER_ADDR
, RATE_PER_BYTE
, RATE_PER_CMD
,
686 RATE_PER_CONN
, RATE_PER_MAIL
, RATE_PER_RCPT
, RATE_PER_ALLRCPTS
689 #define RATE_SET(var,new) \
690 (((var) == RATE_PER_WHAT) ? ((var) = RATE_##new) : ((var) = RATE_PER_CLASH))
692 static uschar
*ratelimit_option_string
[] = {
693 US
"?", US
"!", US
"per_addr", US
"per_byte", US
"per_cmd",
694 US
"per_conn", US
"per_mail", US
"per_rcpt", US
"per_rcpt"
697 /* Enable recursion between acl_check_internal() and acl_check_condition() */
699 static int acl_check_internal(int, address_item
*, uschar
*, int, uschar
**,
703 /*************************************************
704 * Pick out name from list *
705 *************************************************/
707 /* Use a binary chop method
714 Returns: offset in list, or -1 if not found
718 acl_checkname(uschar
*name
, uschar
**list
, int end
)
724 int mid
= (start
+ end
)/2;
725 int c
= Ustrcmp(name
, list
[mid
]);
726 if (c
== 0) return mid
;
727 if (c
< 0) end
= mid
; else start
= mid
+ 1;
734 /*************************************************
735 * Read and parse one ACL *
736 *************************************************/
738 /* This function is called both from readconf in order to parse the ACLs in the
739 configuration file, and also when an ACL is encountered dynamically (e.g. as
740 the result of an expansion). It is given a function to call in order to
741 retrieve the lines of the ACL. This function handles skipping comments and
742 blank lines (where relevant).
745 func function to get next line of ACL
746 error where to put an error message
748 Returns: pointer to ACL, or NULL
749 NULL can be legal (empty ACL); in this case error will be NULL
753 acl_read(uschar
*(*func
)(void), uschar
**error
)
755 acl_block
*yield
= NULL
;
756 acl_block
**lastp
= &yield
;
757 acl_block
*this = NULL
;
758 acl_condition_block
*cond
;
759 acl_condition_block
**condp
= NULL
;
764 while ((s
= (*func
)()) != NULL
)
767 BOOL negated
= FALSE
;
768 uschar
*saveline
= s
;
771 /* Conditions (but not verbs) are allowed to be negated by an initial
774 while (isspace(*s
)) s
++;
781 /* Read the name of a verb or a condition, or the start of a new ACL, which
782 can be started by a name, or by a macro definition. */
784 s
= readconf_readname(name
, sizeof(name
), s
);
785 if (*s
== ':' || (isupper(name
[0]) && *s
== '=')) return yield
;
787 /* If a verb is unrecognized, it may be another condition or modifier that
788 continues the previous verb. */
790 v
= acl_checkname(name
, verbs
, sizeof(verbs
)/sizeof(char *));
795 *error
= string_sprintf("unknown ACL verb \"%s\" in \"%s\"", name
,
807 *error
= string_sprintf("malformed ACL line \"%s\"", saveline
);
810 this = store_get(sizeof(acl_block
));
812 lastp
= &(this->next
);
815 this->condition
= NULL
;
816 condp
= &(this->condition
);
817 if (*s
== 0) continue; /* No condition on this line */
823 s
= readconf_readname(name
, sizeof(name
), s
); /* Condition name */
826 /* Handle a condition or modifier. */
828 c
= acl_checkname(name
, conditions
, sizeof(conditions
)/sizeof(char *));
831 *error
= string_sprintf("unknown ACL condition/modifier in \"%s\"",
836 /* The modifiers may not be negated */
838 if (negated
&& cond_modifiers
[c
])
840 *error
= string_sprintf("ACL error: negation is not allowed with "
841 "\"%s\"", conditions
[c
]);
845 /* ENDPASS may occur only with ACCEPT or DISCARD. */
847 if (c
== ACLC_ENDPASS
&&
848 this->verb
!= ACL_ACCEPT
&&
849 this->verb
!= ACL_DISCARD
)
851 *error
= string_sprintf("ACL error: \"%s\" is not allowed with \"%s\"",
852 conditions
[c
], verbs
[this->verb
]);
856 cond
= store_get(sizeof(acl_condition_block
));
859 cond
->u
.negated
= negated
;
862 condp
= &(cond
->next
);
864 /* The "set" modifier is different in that its argument is "name=value"
865 rather than just a value, and we can check the validity of the name, which
866 gives us a variable name to insert into the data block. The original ACL
867 variable names were acl_c0 ... acl_c9 and acl_m0 ... acl_m9. This was
868 extended to 20 of each type, but after that people successfully argued for
869 arbitrary names. In the new scheme, the names must start with acl_c or acl_m.
870 After that, we allow alphanumerics and underscores, but the first character
871 after c or m must be a digit or an underscore. This retains backwards
878 if (Ustrncmp(s
, "acl_c", 5) != 0 &&
879 Ustrncmp(s
, "acl_m", 5) != 0)
881 *error
= string_sprintf("invalid variable name after \"set\" in ACL "
882 "modifier \"set %s\" (must start \"acl_c\" or \"acl_m\")", s
);
887 if (!isdigit(*endptr
) && *endptr
!= '_')
889 *error
= string_sprintf("invalid variable name after \"set\" in ACL "
890 "modifier \"set %s\" (digit or underscore must follow acl_c or acl_m)",
895 while (*endptr
!= 0 && *endptr
!= '=' && !isspace(*endptr
))
897 if (!isalnum(*endptr
) && *endptr
!= '_')
899 *error
= string_sprintf("invalid character \"%c\" in variable name "
900 "in ACL modifier \"set %s\"", *endptr
, s
);
906 cond
->u
.varname
= string_copyn(s
+ 4, endptr
- s
- 4);
908 while (isspace(*s
)) s
++;
911 /* For "set", we are now positioned for the data. For the others, only
912 "endpass" has no data */
914 if (c
!= ACLC_ENDPASS
)
918 *error
= string_sprintf("\"=\" missing after ACL \"%s\" %s", name
,
919 cond_modifiers
[c
]? US
"modifier" : US
"condition");
922 while (isspace(*s
)) s
++;
923 cond
->arg
= string_copy(s
);
932 /*************************************************
933 * Set up added header line(s) *
934 *************************************************/
936 /* This function is called by the add_header modifier, and also from acl_warn()
937 to implement the now-deprecated way of adding header lines using "message" on a
938 "warn" verb. The argument is treated as a sequence of header lines which are
939 added to a chain, provided there isn't an identical one already there.
941 Argument: string of header lines
946 setup_header(uschar
*hstring
)
949 int hlen
= Ustrlen(hstring
);
951 /* An empty string does nothing; otherwise add a final newline if necessary. */
953 if (hlen
<= 0) return;
954 if (hstring
[hlen
-1] != '\n') hstring
= string_sprintf("%s\n", hstring
);
956 /* Loop for multiple header lines, taking care about continuations */
958 for (p
= q
= hstring
; *p
!= 0; )
961 int newtype
= htype_add_bot
;
962 header_line
**hptr
= &acl_added_headers
;
964 /* Find next header line within the string */
968 q
= Ustrchr(q
, '\n');
969 if (*(++q
) != ' ' && *q
!= '\t') break;
972 /* If the line starts with a colon, interpret the instruction for where to
973 add it. This temporarily sets up a new type. */
977 if (strncmpic(p
, US
":after_received:", 16) == 0)
979 newtype
= htype_add_rec
;
982 else if (strncmpic(p
, US
":at_start_rfc:", 14) == 0)
984 newtype
= htype_add_rfc
;
987 else if (strncmpic(p
, US
":at_start:", 10) == 0)
989 newtype
= htype_add_top
;
992 else if (strncmpic(p
, US
":at_end:", 8) == 0)
994 newtype
= htype_add_bot
;
997 while (*p
== ' ' || *p
== '\t') p
++;
1000 /* See if this line starts with a header name, and if not, add X-ACL-Warn:
1001 to the front of it. */
1003 for (s
= p
; s
< q
- 1; s
++)
1005 if (*s
== ':' || !isgraph(*s
)) break;
1008 s
= string_sprintf("%s%.*s", (*s
== ':')? "" : "X-ACL-Warn: ", (int) (q
- p
), p
);
1011 /* See if this line has already been added */
1013 while (*hptr
!= NULL
)
1015 if (Ustrncmp((*hptr
)->text
, s
, hlen
) == 0) break;
1016 hptr
= &((*hptr
)->next
);
1019 /* Add if not previously present */
1023 header_line
*h
= store_get(sizeof(header_line
));
1032 /* Advance for next header line within the string */
1041 /*************************************************
1043 *************************************************/
1045 /* This function is called when a WARN verb's conditions are true. It adds to
1046 the message's headers, and/or writes information to the log. In each case, this
1047 only happens once (per message for headers, per connection for log).
1049 ** NOTE: The header adding action using the "message" setting is historic, and
1050 its use is now deprecated. The new add_header modifier should be used instead.
1053 where ACL_WHERE_xxxx indicating which ACL this is
1054 user_message message for adding to headers
1055 log_message message for logging, if different
1061 acl_warn(int where
, uschar
*user_message
, uschar
*log_message
)
1063 if (log_message
!= NULL
&& log_message
!= user_message
)
1066 string_item
*logged
;
1068 text
= string_sprintf("%s Warning: %s", host_and_ident(TRUE
),
1069 string_printing(log_message
));
1071 /* If a sender verification has failed, and the log message is "sender verify
1072 failed", add the failure message. */
1074 if (sender_verified_failed
!= NULL
&&
1075 sender_verified_failed
->message
!= NULL
&&
1076 strcmpic(log_message
, US
"sender verify failed") == 0)
1077 text
= string_sprintf("%s: %s", text
, sender_verified_failed
->message
);
1079 /* Search previously logged warnings. They are kept in malloc
1080 store so they can be freed at the start of a new message. */
1082 for (logged
= acl_warn_logged
; logged
!= NULL
; logged
= logged
->next
)
1083 if (Ustrcmp(logged
->text
, text
) == 0) break;
1087 int length
= Ustrlen(text
) + 1;
1088 log_write(0, LOG_MAIN
, "%s", text
);
1089 logged
= store_malloc(sizeof(string_item
) + length
);
1090 logged
->text
= (uschar
*)logged
+ sizeof(string_item
);
1091 memcpy(logged
->text
, text
, length
);
1092 logged
->next
= acl_warn_logged
;
1093 acl_warn_logged
= logged
;
1097 /* If there's no user message, we are done. */
1099 if (user_message
== NULL
) return;
1101 /* If this isn't a message ACL, we can't do anything with a user message.
1104 if (where
> ACL_WHERE_NOTSMTP
)
1106 log_write(0, LOG_MAIN
|LOG_PANIC
, "ACL \"warn\" with \"message\" setting "
1107 "found in a non-message (%s) ACL: cannot specify header lines here: "
1108 "message ignored", acl_wherenames
[where
]);
1112 /* The code for setting up header lines is now abstracted into a separate
1113 function so that it can be used for the add_header modifier as well. */
1115 setup_header(user_message
);
1120 /*************************************************
1121 * Verify and check reverse DNS *
1122 *************************************************/
1124 /* Called from acl_verify() below. We look up the host name(s) of the client IP
1125 address if this has not yet been done. The host_name_lookup() function checks
1126 that one of these names resolves to an address list that contains the client IP
1127 address, so we don't actually have to do the check here.
1130 user_msgptr pointer for user message
1131 log_msgptr pointer for log message
1133 Returns: OK verification condition succeeded
1134 FAIL verification failed
1135 DEFER there was a problem verifying
1139 acl_verify_reverse(uschar
**user_msgptr
, uschar
**log_msgptr
)
1143 user_msgptr
= user_msgptr
; /* stop compiler warning */
1145 /* Previous success */
1147 if (sender_host_name
!= NULL
) return OK
;
1149 /* Previous failure */
1151 if (host_lookup_failed
)
1153 *log_msgptr
= string_sprintf("host lookup failed%s", host_lookup_msg
);
1157 /* Need to do a lookup */
1160 debug_printf("looking up host name to force name/address consistency check\n");
1162 if ((rc
= host_name_lookup()) != OK
)
1164 *log_msgptr
= (rc
== DEFER
)?
1165 US
"host lookup deferred for reverse lookup check"
1167 string_sprintf("host lookup failed for reverse lookup check%s",
1169 return rc
; /* DEFER or FAIL */
1172 host_build_sender_fullhost();
1178 /*************************************************
1179 * Check client IP address matches CSA target *
1180 *************************************************/
1182 /* Called from acl_verify_csa() below. This routine scans a section of a DNS
1183 response for address records belonging to the CSA target hostname. The section
1184 is specified by the reset argument, either RESET_ADDITIONAL or RESET_ANSWERS.
1185 If one of the addresses matches the client's IP address, then the client is
1186 authorized by CSA. If there are target IP addresses but none of them match
1187 then the client is using an unauthorized IP address. If there are no target IP
1188 addresses then the client cannot be using an authorized IP address. (This is
1189 an odd configuration - why didn't the SRV record have a weight of 1 instead?)
1192 dnsa the DNS answer block
1193 dnss a DNS scan block for us to use
1194 reset option specifing what portion to scan, as described above
1195 target the target hostname to use for matching RR names
1197 Returns: CSA_OK successfully authorized
1198 CSA_FAIL_MISMATCH addresses found but none matched
1199 CSA_FAIL_NOADDR no target addresses found
1203 acl_verify_csa_address(dns_answer
*dnsa
, dns_scan
*dnss
, int reset
,
1209 BOOL target_found
= FALSE
;
1211 for (rr
= dns_next_rr(dnsa
, dnss
, reset
);
1213 rr
= dns_next_rr(dnsa
, dnss
, RESET_NEXT
))
1215 /* Check this is an address RR for the target hostname. */
1219 && rr
->type
!= T_AAAA
1226 if (strcmpic(target
, rr
->name
) != 0) continue;
1228 target_found
= TRUE
;
1230 /* Turn the target address RR into a list of textual IP addresses and scan
1231 the list. There may be more than one if it is an A6 RR. */
1233 for (da
= dns_address_from_rr(dnsa
, rr
); da
!= NULL
; da
= da
->next
)
1235 /* If the client IP address matches the target IP address, it's good! */
1237 DEBUG(D_acl
) debug_printf("CSA target address is %s\n", da
->address
);
1239 if (strcmpic(sender_host_address
, da
->address
) == 0) return CSA_OK
;
1243 /* If we found some target addresses but none of them matched, the client is
1244 using an unauthorized IP address, otherwise the target has no authorized IP
1247 if (target_found
) return CSA_FAIL_MISMATCH
;
1248 else return CSA_FAIL_NOADDR
;
1253 /*************************************************
1254 * Verify Client SMTP Authorization *
1255 *************************************************/
1257 /* Called from acl_verify() below. This routine calls dns_lookup_special()
1258 to find the CSA SRV record corresponding to the domain argument, or
1259 $sender_helo_name if no argument is provided. It then checks that the
1260 client is authorized, and that its IP address corresponds to the SRV
1261 target's address by calling acl_verify_csa_address() above. The address
1262 should have been returned in the DNS response's ADDITIONAL section, but if
1263 not we perform another DNS lookup to get it.
1266 domain pointer to optional parameter following verify = csa
1268 Returns: CSA_UNKNOWN no valid CSA record found
1269 CSA_OK successfully authorized
1270 CSA_FAIL_* client is definitely not authorized
1271 CSA_DEFER_* there was a DNS problem
1275 acl_verify_csa(uschar
*domain
)
1279 int priority
, weight
, port
;
1286 /* Work out the domain we are using for the CSA lookup. The default is the
1287 client's HELO domain. If the client has not said HELO, use its IP address
1288 instead. If it's a local client (exim -bs), CSA isn't applicable. */
1290 while (isspace(*domain
) && *domain
!= '\0') ++domain
;
1291 if (*domain
== '\0') domain
= sender_helo_name
;
1292 if (domain
== NULL
) domain
= sender_host_address
;
1293 if (sender_host_address
== NULL
) return CSA_UNKNOWN
;
1295 /* If we have an address literal, strip off the framing ready for turning it
1296 into a domain. The framing consists of matched square brackets possibly
1297 containing a keyword and a colon before the actual IP address. */
1299 if (domain
[0] == '[')
1301 uschar
*start
= Ustrchr(domain
, ':');
1302 if (start
== NULL
) start
= domain
;
1303 domain
= string_copyn(start
+ 1, Ustrlen(start
) - 2);
1306 /* Turn domains that look like bare IP addresses into domains in the reverse
1307 DNS. This code also deals with address literals and $sender_host_address. It's
1308 not quite kosher to treat bare domains such as EHLO 192.0.2.57 the same as
1309 address literals, but it's probably the most friendly thing to do. This is an
1310 extension to CSA, so we allow it to be turned off for proper conformance. */
1312 if (string_is_ip_address(domain
, NULL
) != 0)
1314 if (!dns_csa_use_reverse
) return CSA_UNKNOWN
;
1315 dns_build_reverse(domain
, target
);
1319 /* Find out if we've already done the CSA check for this domain. If we have,
1320 return the same result again. Otherwise build a new cached result structure
1321 for this domain. The name is filled in now, and the value is filled in when
1322 we return from this function. */
1324 t
= tree_search(csa_cache
, domain
);
1325 if (t
!= NULL
) return t
->data
.val
;
1327 t
= store_get_perm(sizeof(tree_node
) + Ustrlen(domain
));
1328 Ustrcpy(t
->name
, domain
);
1329 (void)tree_insertnode(&csa_cache
, t
);
1331 /* Now we are ready to do the actual DNS lookup(s). */
1334 switch (dns_special_lookup(&dnsa
, domain
, T_CSA
, &found
))
1336 /* If something bad happened (most commonly DNS_AGAIN), defer. */
1339 return t
->data
.val
= CSA_DEFER_SRV
;
1341 /* If we found nothing, the client's authorization is unknown. */
1345 return t
->data
.val
= CSA_UNKNOWN
;
1347 /* We got something! Go on to look at the reply in more detail. */
1353 /* Scan the reply for well-formed CSA SRV records. */
1355 for (rr
= dns_next_rr(&dnsa
, &dnss
, RESET_ANSWERS
);
1357 rr
= dns_next_rr(&dnsa
, &dnss
, RESET_NEXT
))
1359 if (rr
->type
!= T_SRV
) continue;
1361 /* Extract the numerical SRV fields (p is incremented) */
1364 GETSHORT(priority
, p
);
1365 GETSHORT(weight
, p
);
1369 debug_printf("CSA priority=%d weight=%d port=%d\n", priority
, weight
, port
);
1371 /* Check the CSA version number */
1373 if (priority
!= 1) continue;
1375 /* If the domain does not have a CSA SRV record of its own (i.e. the domain
1376 found by dns_special_lookup() is a parent of the one we asked for), we check
1377 the subdomain assertions in the port field. At the moment there's only one
1378 assertion: legitimate SMTP clients are all explicitly authorized with CSA
1379 SRV records of their own. */
1381 if (found
!= domain
)
1384 return t
->data
.val
= CSA_FAIL_EXPLICIT
;
1386 return t
->data
.val
= CSA_UNKNOWN
;
1389 /* This CSA SRV record refers directly to our domain, so we check the value
1390 in the weight field to work out the domain's authorization. 0 and 1 are
1391 unauthorized; 3 means the client is authorized but we can't check the IP
1392 address in order to authenticate it, so we treat it as unknown; values
1393 greater than 3 are undefined. */
1395 if (weight
< 2) return t
->data
.val
= CSA_FAIL_DOMAIN
;
1397 if (weight
> 2) continue;
1399 /* Weight == 2, which means the domain is authorized. We must check that the
1400 client's IP address is listed as one of the SRV target addresses. Save the
1401 target hostname then break to scan the additional data for its addresses. */
1403 (void)dn_expand(dnsa
.answer
, dnsa
.answer
+ dnsa
.answerlen
, p
,
1404 (DN_EXPAND_ARG4_TYPE
)target
, sizeof(target
));
1406 DEBUG(D_acl
) debug_printf("CSA target is %s\n", target
);
1411 /* If we didn't break the loop then no appropriate records were found. */
1413 if (rr
== NULL
) return t
->data
.val
= CSA_UNKNOWN
;
1415 /* Do not check addresses if the target is ".", in accordance with RFC 2782.
1416 A target of "." indicates there are no valid addresses, so the client cannot
1417 be authorized. (This is an odd configuration because weight=2 target=. is
1418 equivalent to weight=1, but we check for it in order to keep load off the
1419 root name servers.) Note that dn_expand() turns "." into "". */
1421 if (Ustrcmp(target
, "") == 0) return t
->data
.val
= CSA_FAIL_NOADDR
;
1423 /* Scan the additional section of the CSA SRV reply for addresses belonging
1424 to the target. If the name server didn't return any additional data (e.g.
1425 because it does not fully support SRV records), we need to do another lookup
1426 to obtain the target addresses; otherwise we have a definitive result. */
1428 rc
= acl_verify_csa_address(&dnsa
, &dnss
, RESET_ADDITIONAL
, target
);
1429 if (rc
!= CSA_FAIL_NOADDR
) return t
->data
.val
= rc
;
1431 /* The DNS lookup type corresponds to the IP version used by the client. */
1434 if (Ustrchr(sender_host_address
, ':') != NULL
)
1437 #endif /* HAVE_IPV6 */
1441 #if HAVE_IPV6 && defined(SUPPORT_A6)
1445 switch (dns_lookup(&dnsa
, target
, type
, NULL
))
1447 /* If something bad happened (most commonly DNS_AGAIN), defer. */
1450 return t
->data
.val
= CSA_DEFER_ADDR
;
1452 /* If the query succeeded, scan the addresses and return the result. */
1455 rc
= acl_verify_csa_address(&dnsa
, &dnss
, RESET_ANSWERS
, target
);
1456 if (rc
!= CSA_FAIL_NOADDR
) return t
->data
.val
= rc
;
1457 /* else fall through */
1459 /* If the target has no IP addresses, the client cannot have an authorized
1460 IP address. However, if the target site uses A6 records (not AAAA records)
1461 we have to do yet another lookup in order to check them. */
1466 #if HAVE_IPV6 && defined(SUPPORT_A6)
1467 if (type
== T_AAAA
) { type
= T_A6
; goto DNS_LOOKUP_AGAIN
; }
1470 return t
->data
.val
= CSA_FAIL_NOADDR
;
1476 /*************************************************
1477 * Handle verification (address & other) *
1478 *************************************************/
1480 enum { VERIFY_REV_HOST_LKUP
, VERIFY_CERT
, VERIFY_HELO
, VERIFY_CSA
, VERIFY_HDR_SYNTAX
,
1481 VERIFY_NOT_BLIND
, VERIFY_HDR_SNDR
, VERIFY_SNDR
, VERIFY_RCPT
1486 unsigned where_allowed
; /* bitmap */
1487 BOOL no_options
; /* Never has /option(s) following */
1488 unsigned alt_opt_sep
; /* >0 Non-/ option separator (custom parser) */
1490 static verify_type_t verify_type_list
[] = {
1491 { US
"reverse_host_lookup", VERIFY_REV_HOST_LKUP
, ~0, TRUE
, 0 },
1492 { US
"certificate", VERIFY_CERT
, ~0, TRUE
, 0 },
1493 { US
"helo", VERIFY_HELO
, ~0, TRUE
, 0 },
1494 { US
"csa", VERIFY_CSA
, ~0, FALSE
, 0 },
1495 { US
"header_syntax", VERIFY_HDR_SYNTAX
, (1<<ACL_WHERE_DATA
)|(1<<ACL_WHERE_NOTSMTP
), TRUE
, 0 },
1496 { US
"not_blind", VERIFY_NOT_BLIND
, (1<<ACL_WHERE_DATA
)|(1<<ACL_WHERE_NOTSMTP
), TRUE
, 0 },
1497 { US
"header_sender", VERIFY_HDR_SNDR
, (1<<ACL_WHERE_DATA
)|(1<<ACL_WHERE_NOTSMTP
), FALSE
, 0 },
1498 { US
"sender", VERIFY_SNDR
, (1<<ACL_WHERE_MAIL
)|(1<<ACL_WHERE_RCPT
)
1499 |(1<<ACL_WHERE_PREDATA
)|(1<<ACL_WHERE_DATA
)|(1<<ACL_WHERE_NOTSMTP
),
1501 { US
"recipient", VERIFY_RCPT
, (1<<ACL_WHERE_RCPT
), FALSE
, 0 }
1505 enum { CALLOUT_DEFER_OK
, CALLOUT_NOCACHE
, CALLOUT_RANDOM
, CALLOUT_USE_SENDER
,
1506 CALLOUT_USE_POSTMASTER
, CALLOUT_POSTMASTER
, CALLOUT_FULLPOSTMASTER
,
1507 CALLOUT_MAILFROM
, CALLOUT_POSTMASTER_MAILFROM
, CALLOUT_MAXWAIT
, CALLOUT_CONNECT
,
1514 BOOL has_option
; /* Has =option(s) following */
1515 BOOL timeval
; /* Has a time value */
1517 static callout_opt_t callout_opt_list
[] = {
1518 { US
"defer_ok", CALLOUT_DEFER_OK
, 0, FALSE
, FALSE
},
1519 { US
"no_cache", CALLOUT_NOCACHE
, vopt_callout_no_cache
, FALSE
, FALSE
},
1520 { US
"random", CALLOUT_RANDOM
, vopt_callout_random
, FALSE
, FALSE
},
1521 { US
"use_sender", CALLOUT_USE_SENDER
, vopt_callout_recipsender
, FALSE
, FALSE
},
1522 { US
"use_postmaster", CALLOUT_USE_POSTMASTER
,vopt_callout_recippmaster
, FALSE
, FALSE
},
1523 { US
"postmaster_mailfrom",CALLOUT_POSTMASTER_MAILFROM
,0, TRUE
, FALSE
},
1524 { US
"postmaster", CALLOUT_POSTMASTER
, 0, FALSE
, FALSE
},
1525 { US
"fullpostmaster", CALLOUT_FULLPOSTMASTER
,vopt_callout_fullpm
, FALSE
, FALSE
},
1526 { US
"mailfrom", CALLOUT_MAILFROM
, 0, TRUE
, FALSE
},
1527 { US
"maxwait", CALLOUT_MAXWAIT
, 0, TRUE
, TRUE
},
1528 { US
"connect", CALLOUT_CONNECT
, 0, TRUE
, TRUE
},
1529 { NULL
, CALLOUT_TIME
, 0, FALSE
, TRUE
}
1534 /* This function implements the "verify" condition. It is called when
1535 encountered in any ACL, because some tests are almost always permitted. Some
1536 just don't make sense, and always fail (for example, an attempt to test a host
1537 lookup for a non-TCP/IP message). Others are restricted to certain ACLs.
1540 where where called from
1541 addr the recipient address that the ACL is handling, or NULL
1542 arg the argument of "verify"
1543 user_msgptr pointer for user message
1544 log_msgptr pointer for log message
1545 basic_errno where to put verify errno
1547 Returns: OK verification condition succeeded
1548 FAIL verification failed
1549 DEFER there was a problem verifying
1554 acl_verify(int where
, address_item
*addr
, uschar
*arg
,
1555 uschar
**user_msgptr
, uschar
**log_msgptr
, int *basic_errno
)
1559 int callout_overall
= -1;
1560 int callout_connect
= -1;
1561 int verify_options
= 0;
1563 BOOL verify_header_sender
= FALSE
;
1564 BOOL defer_ok
= FALSE
;
1565 BOOL callout_defer_ok
= FALSE
;
1566 BOOL no_details
= FALSE
;
1567 BOOL success_on_redirect
= FALSE
;
1568 address_item
*sender_vaddr
= NULL
;
1569 uschar
*verify_sender_address
= NULL
;
1570 uschar
*pm_mailfrom
= NULL
;
1571 uschar
*se_mailfrom
= NULL
;
1573 /* Some of the verify items have slash-separated options; some do not. Diagnose
1574 an error if options are given for items that don't expect them.
1577 uschar
*slash
= Ustrchr(arg
, '/');
1579 uschar
*ss
= string_nextinlist(&list
, &sep
, big_buffer
, big_buffer_size
);
1582 if (ss
== NULL
) goto BAD_VERIFY
;
1584 /* Handle name/address consistency verification in a separate function. */
1586 for (vp
= verify_type_list
;
1587 (char *)vp
< (char *)verify_type_list
+ sizeof(verify_type_list
);
1590 if (vp
->alt_opt_sep
? strncmpic(ss
, vp
->name
, vp
->alt_opt_sep
) == 0
1591 : strcmpic (ss
, vp
->name
) == 0)
1593 if ((char *)vp
>= (char *)verify_type_list
+ sizeof(verify_type_list
))
1596 if (vp
->no_options
&& slash
!= NULL
)
1598 *log_msgptr
= string_sprintf("unexpected '/' found in \"%s\" "
1599 "(this verify item has no options)", arg
);
1602 if (!(vp
->where_allowed
& (1<<where
)))
1604 *log_msgptr
= string_sprintf("cannot verify %s in ACL for %s", vp
->name
, acl_wherenames
[where
]);
1609 case VERIFY_REV_HOST_LKUP
:
1610 if (sender_host_address
== NULL
) return OK
;
1611 return acl_verify_reverse(user_msgptr
, log_msgptr
);
1614 /* TLS certificate verification is done at STARTTLS time; here we just
1615 test whether it was successful or not. (This is for optional verification; for
1616 mandatory verification, the connection doesn't last this long.) */
1618 if (tls_in
.certificate_verified
) return OK
;
1619 *user_msgptr
= US
"no verified certificate";
1623 /* We can test the result of optional HELO verification that might have
1624 occurred earlier. If not, we can attempt the verification now. */
1626 if (!helo_verified
&& !helo_verify_failed
) smtp_verify_helo();
1627 return helo_verified
? OK
: FAIL
;
1630 /* Do Client SMTP Authorization checks in a separate function, and turn the
1631 result code into user-friendly strings. */
1633 rc
= acl_verify_csa(list
);
1634 *log_msgptr
= *user_msgptr
= string_sprintf("client SMTP authorization %s",
1635 csa_reason_string
[rc
]);
1636 csa_status
= csa_status_string
[rc
];
1637 DEBUG(D_acl
) debug_printf("CSA result %s\n", csa_status
);
1638 return csa_return_code
[rc
];
1640 case VERIFY_HDR_SYNTAX
:
1641 /* Check that all relevant header lines have the correct syntax. If there is
1642 a syntax error, we return details of the error to the sender if configured to
1643 send out full details. (But a "message" setting on the ACL can override, as
1646 rc
= verify_check_headers(log_msgptr
);
1647 if (rc
!= OK
&& smtp_return_error_details
&& *log_msgptr
!= NULL
)
1648 *user_msgptr
= string_sprintf("Rejected after DATA: %s", *log_msgptr
);
1651 case VERIFY_NOT_BLIND
:
1652 /* Check that no recipient of this message is "blind", that is, every envelope
1653 recipient must be mentioned in either To: or Cc:. */
1655 rc
= verify_check_notblind();
1658 *log_msgptr
= string_sprintf("bcc recipient detected");
1659 if (smtp_return_error_details
)
1660 *user_msgptr
= string_sprintf("Rejected after DATA: %s", *log_msgptr
);
1664 /* The remaining verification tests check recipient and sender addresses,
1665 either from the envelope or from the header. There are a number of
1666 slash-separated options that are common to all of them. */
1668 case VERIFY_HDR_SNDR
:
1669 verify_header_sender
= TRUE
;
1673 /* In the case of a sender, this can optionally be followed by an address to use
1674 in place of the actual sender (rare special-case requirement). */
1678 verify_sender_address
= sender_address
;
1681 while (isspace(*s
)) s
++;
1682 if (*s
++ != '=') goto BAD_VERIFY
;
1683 while (isspace(*s
)) s
++;
1684 verify_sender_address
= string_copy(s
);
1695 /* Remaining items are optional; they apply to sender and recipient
1696 verification, including "header sender" verification. */
1698 while ((ss
= string_nextinlist(&list
, &sep
, big_buffer
, big_buffer_size
))
1701 if (strcmpic(ss
, US
"defer_ok") == 0) defer_ok
= TRUE
;
1702 else if (strcmpic(ss
, US
"no_details") == 0) no_details
= TRUE
;
1703 else if (strcmpic(ss
, US
"success_on_redirect") == 0) success_on_redirect
= TRUE
;
1705 /* These two old options are left for backwards compatibility */
1707 else if (strcmpic(ss
, US
"callout_defer_ok") == 0)
1709 callout_defer_ok
= TRUE
;
1710 if (callout
== -1) callout
= CALLOUT_TIMEOUT_DEFAULT
;
1713 else if (strcmpic(ss
, US
"check_postmaster") == 0)
1716 if (callout
== -1) callout
= CALLOUT_TIMEOUT_DEFAULT
;
1719 /* The callout option has a number of sub-options, comma separated */
1721 else if (strncmpic(ss
, US
"callout", 7) == 0)
1723 callout
= CALLOUT_TIMEOUT_DEFAULT
;
1727 while (isspace(*ss
)) ss
++;
1733 while (isspace(*ss
)) ss
++;
1735 while ((opt
= string_nextinlist(&ss
, &optsep
, buffer
, sizeof(buffer
)))
1739 double period
= 1.0F
;
1741 for (op
= callout_opt_list
; op
->name
; op
++)
1742 if (strncmpic(opt
, op
->name
, Ustrlen(op
->name
)) == 0)
1745 verify_options
|= op
->flag
;
1748 opt
+= Ustrlen(op
->name
);
1749 while (isspace(*opt
)) opt
++;
1752 *log_msgptr
= string_sprintf("'=' expected after "
1753 "\"%s\" in ACL verify condition \"%s\"", op
->name
, arg
);
1756 while (isspace(*opt
)) opt
++;
1760 period
= readconf_readtime(opt
, 0, FALSE
);
1763 *log_msgptr
= string_sprintf("bad time value in ACL condition "
1764 "\"verify %s\"", arg
);
1771 case CALLOUT_DEFER_OK
: callout_defer_ok
= TRUE
; break;
1772 case CALLOUT_POSTMASTER
: pm_mailfrom
= US
""; break;
1773 case CALLOUT_FULLPOSTMASTER
: pm_mailfrom
= US
""; break;
1774 case CALLOUT_MAILFROM
:
1775 if (!verify_header_sender
)
1777 *log_msgptr
= string_sprintf("\"mailfrom\" is allowed as a "
1778 "callout option only for verify=header_sender (detected in ACL "
1779 "condition \"%s\")", arg
);
1782 se_mailfrom
= string_copy(opt
);
1784 case CALLOUT_POSTMASTER_MAILFROM
: pm_mailfrom
= string_copy(opt
); break;
1785 case CALLOUT_MAXWAIT
: callout_overall
= period
; break;
1786 case CALLOUT_CONNECT
: callout_connect
= period
; break;
1787 case CALLOUT_TIME
: callout
= period
; break;
1793 *log_msgptr
= string_sprintf("'=' expected after \"callout\" in "
1794 "ACL condition \"%s\"", arg
);
1800 /* Option not recognized */
1804 *log_msgptr
= string_sprintf("unknown option \"%s\" in ACL "
1805 "condition \"verify %s\"", ss
, arg
);
1810 if ((verify_options
& (vopt_callout_recipsender
|vopt_callout_recippmaster
)) ==
1811 (vopt_callout_recipsender
|vopt_callout_recippmaster
))
1813 *log_msgptr
= US
"only one of use_sender and use_postmaster can be set "
1814 "for a recipient callout";
1818 /* Handle sender-in-header verification. Default the user message to the log
1819 message if giving out verification details. */
1821 if (verify_header_sender
)
1824 rc
= verify_check_header_address(user_msgptr
, log_msgptr
, callout
,
1825 callout_overall
, callout_connect
, se_mailfrom
, pm_mailfrom
, verify_options
,
1829 *basic_errno
= verrno
;
1830 if (smtp_return_error_details
)
1832 if (*user_msgptr
== NULL
&& *log_msgptr
!= NULL
)
1833 *user_msgptr
= string_sprintf("Rejected after DATA: %s", *log_msgptr
);
1834 if (rc
== DEFER
) acl_temp_details
= TRUE
;
1839 /* Handle a sender address. The default is to verify *the* sender address, but
1840 optionally a different address can be given, for special requirements. If the
1841 address is empty, we are dealing with a bounce message that has no sender, so
1842 we cannot do any checking. If the real sender address gets rewritten during
1843 verification (e.g. DNS widening), set the flag to stop it being rewritten again
1844 during message reception.
1846 A list of verified "sender" addresses is kept to try to avoid doing to much
1847 work repetitively when there are multiple recipients in a message and they all
1848 require sender verification. However, when callouts are involved, it gets too
1849 complicated because different recipients may require different callout options.
1850 Therefore, we always do a full sender verify when any kind of callout is
1851 specified. Caching elsewhere, for instance in the DNS resolver and in the
1852 callout handling, should ensure that this is not terribly inefficient. */
1854 else if (verify_sender_address
!= NULL
)
1856 if ((verify_options
& (vopt_callout_recipsender
|vopt_callout_recippmaster
))
1859 *log_msgptr
= US
"use_sender or use_postmaster cannot be used for a "
1860 "sender verify callout";
1864 sender_vaddr
= verify_checked_sender(verify_sender_address
);
1865 if (sender_vaddr
!= NULL
&& /* Previously checked */
1866 callout
<= 0) /* No callout needed this time */
1868 /* If the "routed" flag is set, it means that routing worked before, so
1869 this check can give OK (the saved return code value, if set, belongs to a
1870 callout that was done previously). If the "routed" flag is not set, routing
1871 must have failed, so we use the saved return code. */
1873 if (testflag(sender_vaddr
, af_verify_routed
)) rc
= OK
; else
1875 rc
= sender_vaddr
->special_action
;
1876 *basic_errno
= sender_vaddr
->basic_errno
;
1878 HDEBUG(D_acl
) debug_printf("using cached sender verify result\n");
1881 /* Do a new verification, and cache the result. The cache is used to avoid
1882 verifying the sender multiple times for multiple RCPTs when callouts are not
1883 specified (see comments above).
1885 The cache is also used on failure to give details in response to the first
1886 RCPT that gets bounced for this reason. However, this can be suppressed by
1887 the no_details option, which sets the flag that says "this detail has already
1888 been sent". The cache normally contains just one address, but there may be
1889 more in esoteric circumstances. */
1894 uschar
*save_address_data
= deliver_address_data
;
1896 sender_vaddr
= deliver_make_addr(verify_sender_address
, TRUE
);
1897 if (no_details
) setflag(sender_vaddr
, af_sverify_told
);
1898 if (verify_sender_address
[0] != 0)
1900 /* If this is the real sender address, save the unrewritten version
1901 for use later in receive. Otherwise, set a flag so that rewriting the
1902 sender in verify_address() does not update sender_address. */
1904 if (verify_sender_address
== sender_address
)
1905 sender_address_unrewritten
= sender_address
;
1907 verify_options
|= vopt_fake_sender
;
1909 if (success_on_redirect
)
1910 verify_options
|= vopt_success_on_redirect
;
1912 /* The recipient, qualify, and expn options are never set in
1915 rc
= verify_address(sender_vaddr
, NULL
, verify_options
, callout
,
1916 callout_overall
, callout_connect
, se_mailfrom
, pm_mailfrom
, &routed
);
1918 HDEBUG(D_acl
) debug_printf("----------- end verify ------------\n");
1922 if (Ustrcmp(sender_vaddr
->address
, verify_sender_address
) != 0)
1924 DEBUG(D_acl
) debug_printf("sender %s verified ok as %s\n",
1925 verify_sender_address
, sender_vaddr
->address
);
1929 DEBUG(D_acl
) debug_printf("sender %s verified ok\n",
1930 verify_sender_address
);
1933 else *basic_errno
= sender_vaddr
->basic_errno
;
1935 else rc
= OK
; /* Null sender */
1937 /* Cache the result code */
1939 if (routed
) setflag(sender_vaddr
, af_verify_routed
);
1940 if (callout
> 0) setflag(sender_vaddr
, af_verify_callout
);
1941 sender_vaddr
->special_action
= rc
;
1942 sender_vaddr
->next
= sender_verified_list
;
1943 sender_verified_list
= sender_vaddr
;
1945 /* Restore the recipient address data, which might have been clobbered by
1946 the sender verification. */
1948 deliver_address_data
= save_address_data
;
1951 /* Put the sender address_data value into $sender_address_data */
1953 sender_address_data
= sender_vaddr
->p
.address_data
;
1956 /* A recipient address just gets a straightforward verify; again we must handle
1957 the DEFER overrides. */
1963 if (success_on_redirect
)
1964 verify_options
|= vopt_success_on_redirect
;
1966 /* We must use a copy of the address for verification, because it might
1970 rc
= verify_address(&addr2
, NULL
, verify_options
|vopt_is_recipient
, callout
,
1971 callout_overall
, callout_connect
, se_mailfrom
, pm_mailfrom
, NULL
);
1972 HDEBUG(D_acl
) debug_printf("----------- end verify ------------\n");
1974 *basic_errno
= addr2
.basic_errno
;
1975 *log_msgptr
= addr2
.message
;
1976 *user_msgptr
= (addr2
.user_message
!= NULL
)?
1977 addr2
.user_message
: addr2
.message
;
1979 /* Allow details for temporary error if the address is so flagged. */
1980 if (testflag((&addr2
), af_pass_message
)) acl_temp_details
= TRUE
;
1982 /* Make $address_data visible */
1983 deliver_address_data
= addr2
.p
.address_data
;
1986 /* We have a result from the relevant test. Handle defer overrides first. */
1988 if (rc
== DEFER
&& (defer_ok
||
1989 (callout_defer_ok
&& *basic_errno
== ERRNO_CALLOUTDEFER
)))
1991 HDEBUG(D_acl
) debug_printf("verify defer overridden by %s\n",
1992 defer_ok
? "defer_ok" : "callout_defer_ok");
1996 /* If we've failed a sender, set up a recipient message, and point
1997 sender_verified_failed to the address item that actually failed. */
1999 if (rc
!= OK
&& verify_sender_address
!= NULL
)
2003 *log_msgptr
= *user_msgptr
= US
"Sender verify failed";
2005 else if (*basic_errno
!= ERRNO_CALLOUTDEFER
)
2007 *log_msgptr
= *user_msgptr
= US
"Could not complete sender verify";
2011 *log_msgptr
= US
"Could not complete sender verify callout";
2012 *user_msgptr
= smtp_return_error_details
? sender_vaddr
->user_message
:
2016 sender_verified_failed
= sender_vaddr
;
2019 /* Verifying an address messes up the values of $domain and $local_part,
2020 so reset them before returning if this is a RCPT ACL. */
2024 deliver_domain
= addr
->domain
;
2025 deliver_localpart
= addr
->local_part
;
2029 /* Syntax errors in the verify argument come here. */
2032 *log_msgptr
= string_sprintf("expected \"sender[=address]\", \"recipient\", "
2033 "\"helo\", \"header_syntax\", \"header_sender\" or "
2034 "\"reverse_host_lookup\" at start of ACL condition "
2035 "\"verify %s\"", arg
);
2042 /*************************************************
2043 * Check argument for control= modifier *
2044 *************************************************/
2046 /* Called from acl_check_condition() below
2049 arg the argument string for control=
2050 pptr set to point to the terminating character
2051 where which ACL we are in
2052 log_msgptr for error messages
2054 Returns: CONTROL_xxx value
2058 decode_control(uschar
*arg
, uschar
**pptr
, int where
, uschar
**log_msgptr
)
2063 for (d
= controls_list
;
2064 d
< controls_list
+ sizeof(controls_list
)/sizeof(control_def
);
2067 len
= Ustrlen(d
->name
);
2068 if (Ustrncmp(d
->name
, arg
, len
) == 0) break;
2071 if (d
>= controls_list
+ sizeof(controls_list
)/sizeof(control_def
) ||
2072 (arg
[len
] != 0 && (!d
->has_option
|| arg
[len
] != '/')))
2074 *log_msgptr
= string_sprintf("syntax error in \"control=%s\"", arg
);
2075 return CONTROL_ERROR
;
2085 /*************************************************
2086 * Return a ratelimit error *
2087 *************************************************/
2089 /* Called from acl_ratelimit() below
2092 log_msgptr for error messages
2093 format format string
2094 ... supplementary arguments
2095 ss ratelimit option name
2096 where ACL_WHERE_xxxx indicating which ACL this is
2102 ratelimit_error(uschar
**log_msgptr
, const char *format
, ...)
2105 uschar buffer
[STRING_SPRINTF_BUFFER_SIZE
];
2106 va_start(ap
, format
);
2107 if (!string_vformat(buffer
, sizeof(buffer
), format
, ap
))
2108 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
,
2109 "string_sprintf expansion was longer than " SIZE_T_FMT
, sizeof(buffer
));
2111 *log_msgptr
= string_sprintf(
2112 "error in arguments to \"ratelimit\" condition: %s", buffer
);
2119 /*************************************************
2120 * Handle rate limiting *
2121 *************************************************/
2123 /* Called by acl_check_condition() below to calculate the result
2124 of the ACL ratelimit condition.
2126 Note that the return value might be slightly unexpected: if the
2127 sender's rate is above the limit then the result is OK. This is
2128 similar to the dnslists condition, and is so that you can write
2129 ACL clauses like: defer ratelimit = 15 / 1h
2132 arg the option string for ratelimit=
2133 where ACL_WHERE_xxxx indicating which ACL this is
2134 log_msgptr for error messages
2136 Returns: OK - Sender's rate is above limit
2137 FAIL - Sender's rate is below limit
2138 DEFER - Problem opening ratelimit database
2139 ERROR - Syntax error in options.
2143 acl_ratelimit(uschar
*arg
, int where
, uschar
**log_msgptr
)
2145 double limit
, period
, count
;
2148 uschar
*unique
= NULL
;
2150 BOOL leaky
= FALSE
, strict
= FALSE
, readonly
= FALSE
;
2151 BOOL noupdate
= FALSE
, badacl
= FALSE
;
2152 int mode
= RATE_PER_WHAT
;
2154 tree_node
**anchor
, *t
;
2155 open_db dbblock
, *dbm
;
2157 dbdata_ratelimit
*dbd
;
2158 dbdata_ratelimit_unique
*dbdb
;
2161 /* Parse the first two options and record their values in expansion
2162 variables. These variables allow the configuration to have informative
2163 error messages based on rate limits obtained from a table lookup. */
2165 /* First is the maximum number of messages per period / maximum burst
2166 size, which must be greater than or equal to zero. Zero is useful for
2167 rate measurement as opposed to rate limiting. */
2169 sender_rate_limit
= string_nextinlist(&arg
, &sep
, NULL
, 0);
2170 if (sender_rate_limit
== NULL
)
2174 limit
= Ustrtod(sender_rate_limit
, &ss
);
2175 if (tolower(*ss
) == 'k') { limit
*= 1024.0; ss
++; }
2176 else if (tolower(*ss
) == 'm') { limit
*= 1024.0*1024.0; ss
++; }
2177 else if (tolower(*ss
) == 'g') { limit
*= 1024.0*1024.0*1024.0; ss
++; }
2179 if (limit
< 0.0 || *ss
!= '\0')
2180 return ratelimit_error(log_msgptr
,
2181 "\"%s\" is not a positive number", sender_rate_limit
);
2183 /* Second is the rate measurement period / exponential smoothing time
2184 constant. This must be strictly greater than zero, because zero leads to
2185 run-time division errors. */
2187 sender_rate_period
= string_nextinlist(&arg
, &sep
, NULL
, 0);
2188 if (sender_rate_period
== NULL
) period
= -1.0;
2189 else period
= readconf_readtime(sender_rate_period
, 0, FALSE
);
2191 return ratelimit_error(log_msgptr
,
2192 "\"%s\" is not a time value", sender_rate_period
);
2194 /* By default we are counting one of something, but the per_rcpt,
2195 per_byte, and count options can change this. */
2199 /* Parse the other options. */
2201 while ((ss
= string_nextinlist(&arg
, &sep
, big_buffer
, big_buffer_size
))
2204 if (strcmpic(ss
, US
"leaky") == 0) leaky
= TRUE
;
2205 else if (strcmpic(ss
, US
"strict") == 0) strict
= TRUE
;
2206 else if (strcmpic(ss
, US
"noupdate") == 0) noupdate
= TRUE
;
2207 else if (strcmpic(ss
, US
"readonly") == 0) readonly
= TRUE
;
2208 else if (strcmpic(ss
, US
"per_cmd") == 0) RATE_SET(mode
, PER_CMD
);
2209 else if (strcmpic(ss
, US
"per_conn") == 0)
2211 RATE_SET(mode
, PER_CONN
);
2212 if (where
== ACL_WHERE_NOTSMTP
|| where
== ACL_WHERE_NOTSMTP_START
)
2215 else if (strcmpic(ss
, US
"per_mail") == 0)
2217 RATE_SET(mode
, PER_MAIL
);
2218 if (where
> ACL_WHERE_NOTSMTP
) badacl
= TRUE
;
2220 else if (strcmpic(ss
, US
"per_rcpt") == 0)
2222 /* If we are running in the RCPT ACL, then we'll count the recipients
2223 one by one, but if we are running when we have accumulated the whole
2224 list then we'll add them all in one batch. */
2225 if (where
== ACL_WHERE_RCPT
)
2226 RATE_SET(mode
, PER_RCPT
);
2227 else if (where
>= ACL_WHERE_PREDATA
&& where
<= ACL_WHERE_NOTSMTP
)
2228 RATE_SET(mode
, PER_ALLRCPTS
), count
= (double)recipients_count
;
2229 else if (where
== ACL_WHERE_MAIL
|| where
> ACL_WHERE_NOTSMTP
)
2230 RATE_SET(mode
, PER_RCPT
), badacl
= TRUE
;
2232 else if (strcmpic(ss
, US
"per_byte") == 0)
2234 /* If we have not yet received the message data and there was no SIZE
2235 declaration on the MAIL comand, then it's safe to just use a value of
2236 zero and let the recorded rate decay as if nothing happened. */
2237 RATE_SET(mode
, PER_MAIL
);
2238 if (where
> ACL_WHERE_NOTSMTP
) badacl
= TRUE
;
2239 else count
= message_size
< 0 ? 0.0 : (double)message_size
;
2241 else if (strcmpic(ss
, US
"per_addr") == 0)
2243 RATE_SET(mode
, PER_RCPT
);
2244 if (where
!= ACL_WHERE_RCPT
) badacl
= TRUE
, unique
= US
"*";
2245 else unique
= string_sprintf("%s@%s", deliver_localpart
, deliver_domain
);
2247 else if (strncmpic(ss
, US
"count=", 6) == 0)
2250 count
= Ustrtod(ss
+6, &e
);
2251 if (count
< 0.0 || *e
!= '\0')
2252 return ratelimit_error(log_msgptr
,
2253 "\"%s\" is not a positive number", ss
);
2255 else if (strncmpic(ss
, US
"unique=", 7) == 0)
2256 unique
= string_copy(ss
+ 7);
2257 else if (key
== NULL
)
2258 key
= string_copy(ss
);
2260 key
= string_sprintf("%s/%s", key
, ss
);
2263 /* Sanity check. When the badacl flag is set the update mode must either
2264 be readonly (which is the default if it is omitted) or, for backwards
2265 compatibility, a combination of noupdate and strict or leaky. */
2267 if (mode
== RATE_PER_CLASH
)
2268 return ratelimit_error(log_msgptr
, "conflicting per_* options");
2269 if (leaky
+ strict
+ readonly
> 1)
2270 return ratelimit_error(log_msgptr
, "conflicting update modes");
2271 if (badacl
&& (leaky
|| strict
) && !noupdate
)
2272 return ratelimit_error(log_msgptr
,
2273 "\"%s\" must not have /leaky or /strict option in %s ACL",
2274 ratelimit_option_string
[mode
], acl_wherenames
[where
]);
2276 /* Set the default values of any unset options. In readonly mode we
2277 perform the rate computation without any increment so that its value
2278 decays to eventually allow over-limit senders through. */
2280 if (noupdate
) readonly
= TRUE
, leaky
= strict
= FALSE
;
2281 if (badacl
) readonly
= TRUE
;
2282 if (readonly
) count
= 0.0;
2283 if (!strict
&& !readonly
) leaky
= TRUE
;
2284 if (mode
== RATE_PER_WHAT
) mode
= RATE_PER_MAIL
;
2286 /* Create the lookup key. If there is no explicit key, use sender_host_address.
2287 If there is no sender_host_address (e.g. -bs or acl_not_smtp) then we simply
2288 omit it. The smoothing constant (sender_rate_period) and the per_xxx options
2289 are added to the key because they alter the meaning of the stored data. */
2292 key
= (sender_host_address
== NULL
)? US
"" : sender_host_address
;
2294 key
= string_sprintf("%s/%s/%s%s",
2296 ratelimit_option_string
[mode
],
2297 unique
== NULL
? "" : "unique/",
2301 debug_printf("ratelimit condition count=%.0f %.1f/%s\n", count
, limit
, key
);
2303 /* See if we have already computed the rate by looking in the relevant tree.
2304 For per-connection rate limiting, store tree nodes and dbdata in the permanent
2305 pool so that they survive across resets. In readonly mode we only remember the
2306 result for the rest of this command in case a later command changes it. After
2307 this bit of logic the code is independent of the per_* mode. */
2309 old_pool
= store_pool
;
2312 anchor
= &ratelimiters_cmd
;
2315 anchor
= &ratelimiters_conn
;
2316 store_pool
= POOL_PERM
;
2320 case RATE_PER_ALLRCPTS
:
2321 anchor
= &ratelimiters_mail
;
2326 anchor
= &ratelimiters_cmd
;
2329 anchor
= NULL
; /* silence an "unused" complaint */
2330 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
,
2331 "internal ACL error: unknown ratelimit mode %d", mode
);
2335 t
= tree_search(*anchor
, key
);
2339 /* The following few lines duplicate some of the code below. */
2340 rc
= (dbd
->rate
< limit
)? FAIL
: OK
;
2341 store_pool
= old_pool
;
2342 sender_rate
= string_sprintf("%.1f", dbd
->rate
);
2344 debug_printf("ratelimit found pre-computed rate %s\n", sender_rate
);
2348 /* We aren't using a pre-computed rate, so get a previously recorded rate
2349 from the database, which will be updated and written back if required. */
2351 dbm
= dbfn_open(US
"ratelimit", O_RDWR
, &dbblock
, TRUE
);
2354 store_pool
= old_pool
;
2356 HDEBUG(D_acl
) debug_printf("ratelimit database not available\n");
2357 *log_msgptr
= US
"ratelimit database not available";
2360 dbdb
= dbfn_read_with_length(dbm
, key
, &dbdb_size
);
2363 gettimeofday(&tv
, NULL
);
2367 /* Locate the basic ratelimit block inside the DB data. */
2368 HDEBUG(D_acl
) debug_printf("ratelimit found key in database\n");
2371 /* Forget the old Bloom filter if it is too old, so that we count each
2372 repeating event once per period. We don't simply clear and re-use the old
2373 filter because we want its size to change if the limit changes. Note that
2374 we keep the dbd pointer for copying the rate into the new data block. */
2376 if(unique
!= NULL
&& tv
.tv_sec
> dbdb
->bloom_epoch
+ period
)
2378 HDEBUG(D_acl
) debug_printf("ratelimit discarding old Bloom filter\n");
2384 if(unique
!= NULL
&& dbdb_size
< sizeof(*dbdb
))
2386 HDEBUG(D_acl
) debug_printf("ratelimit discarding undersize Bloom filter\n");
2391 /* Allocate a new data block if the database lookup failed
2392 or the Bloom filter passed its age limit. */
2398 /* No Bloom filter. This basic ratelimit block is initialized below. */
2399 HDEBUG(D_acl
) debug_printf("ratelimit creating new rate data block\n");
2400 dbdb_size
= sizeof(*dbd
);
2401 dbdb
= store_get(dbdb_size
);
2406 HDEBUG(D_acl
) debug_printf("ratelimit creating new Bloom filter\n");
2408 /* See the long comment below for an explanation of the magic number 2.
2409 The filter has a minimum size in case the rate limit is very small;
2410 this is determined by the definition of dbdata_ratelimit_unique. */
2412 extra
= (int)limit
* 2 - sizeof(dbdb
->bloom
);
2413 if (extra
< 0) extra
= 0;
2414 dbdb_size
= sizeof(*dbdb
) + extra
;
2415 dbdb
= store_get(dbdb_size
);
2416 dbdb
->bloom_epoch
= tv
.tv_sec
;
2417 dbdb
->bloom_size
= sizeof(dbdb
->bloom
) + extra
;
2418 memset(dbdb
->bloom
, 0, dbdb
->bloom_size
);
2420 /* Preserve any basic ratelimit data (which is our longer-term memory)
2421 by copying it from the discarded block. */
2431 /* If we are counting unique events, find out if this event is new or not.
2432 If the client repeats the event during the current period then it should be
2433 counted. We skip this code in readonly mode for efficiency, because any
2434 changes to the filter will be discarded and because count is already set to
2437 if (unique
!= NULL
&& !readonly
)
2439 /* We identify unique events using a Bloom filter. (You can find my
2440 notes on Bloom filters at http://fanf.livejournal.com/81696.html)
2441 With the per_addr option, an "event" is a recipient address, though the
2442 user can use the unique option to define their own events. We only count
2443 an event if we have not seen it before.
2445 We size the filter according to the rate limit, which (in leaky mode)
2446 is the limit on the population of the filter. We allow 16 bits of space
2447 per entry (see the construction code above) and we set (up to) 8 of them
2448 when inserting an element (see the loop below). The probability of a false
2449 positive (an event we have not seen before but which we fail to count) is
2453 allzero = exp(-numhash * pop / size)
2454 = exp(-0.5 * pop / limit)
2455 fpr = pow(1 - allzero, numhash)
2457 For senders at the limit the fpr is 0.06% or 1 in 1700
2458 and for senders at half the limit it is 0.0006% or 1 in 170000
2460 In strict mode the Bloom filter can fill up beyond the normal limit, in
2461 which case the false positive rate will rise. This means that the
2462 measured rate for very fast senders can bogusly drop off after a while.
2464 At twice the limit, the fpr is 2.5% or 1 in 40
2465 At four times the limit, it is 31% or 1 in 3.2
2467 It takes ln(pop/limit) periods for an over-limit burst of pop events to
2468 decay below the limit, and if this is more than one then the Bloom filter
2469 will be discarded before the decay gets that far. The false positive rate
2470 at this threshold is 9.3% or 1 in 10.7. */
2473 unsigned n
, hash
, hinc
;
2477 /* Instead of using eight independent hash values, we combine two values
2478 using the formula h1 + n * h2. This does not harm the Bloom filter's
2479 performance, and means the amount of hash we need is independent of the
2480 number of bits we set in the filter. */
2482 md5_start(&md5info
);
2483 md5_end(&md5info
, unique
, Ustrlen(unique
), md5sum
);
2484 hash
= md5sum
[0] | md5sum
[1] << 8 | md5sum
[2] << 16 | md5sum
[3] << 24;
2485 hinc
= md5sum
[4] | md5sum
[5] << 8 | md5sum
[6] << 16 | md5sum
[7] << 24;
2487 /* Scan the bits corresponding to this event. A zero bit means we have
2488 not seen it before. Ensure all bits are set to record this event. */
2490 HDEBUG(D_acl
) debug_printf("ratelimit checking uniqueness of %s\n", unique
);
2493 for (n
= 0; n
< 8; n
++, hash
+= hinc
)
2495 int bit
= 1 << (hash
% 8);
2496 int byte
= (hash
/ 8) % dbdb
->bloom_size
;
2497 if ((dbdb
->bloom
[byte
] & bit
) == 0)
2499 dbdb
->bloom
[byte
] |= bit
;
2504 /* If this event has occurred before, do not count it. */
2508 HDEBUG(D_acl
) debug_printf("ratelimit event found in Bloom filter\n");
2512 HDEBUG(D_acl
) debug_printf("ratelimit event added to Bloom filter\n");
2515 /* If there was no previous ratelimit data block for this key, initialize
2516 the new one, otherwise update the block from the database. The initial rate
2517 is what would be computed by the code below for an infinite interval. */
2521 HDEBUG(D_acl
) debug_printf("ratelimit initializing new key's rate data\n");
2523 dbd
->time_stamp
= tv
.tv_sec
;
2524 dbd
->time_usec
= tv
.tv_usec
;
2529 /* The smoothed rate is computed using an exponentially weighted moving
2530 average adjusted for variable sampling intervals. The standard EWMA for
2531 a fixed sampling interval is: f'(t) = (1 - a) * f(t) + a * f'(t - 1)
2532 where f() is the measured value and f'() is the smoothed value.
2534 Old data decays out of the smoothed value exponentially, such that data n
2535 samples old is multiplied by a^n. The exponential decay time constant p
2536 is defined such that data p samples old is multiplied by 1/e, which means
2537 that a = exp(-1/p). We can maintain the same time constant for a variable
2538 sampling interval i by using a = exp(-i/p).
2540 The rate we are measuring is messages per period, suitable for directly
2541 comparing with the limit. The average rate between now and the previous
2542 message is period / interval, which we feed into the EWMA as the sample.
2544 It turns out that the number of messages required for the smoothed rate
2545 to reach the limit when they are sent in a burst is equal to the limit.
2546 This can be seen by analysing the value of the smoothed rate after N
2547 messages sent at even intervals. Let k = (1 - a) * p/i
2549 rate_1 = (1 - a) * p/i + a * rate_0
2551 rate_2 = k + a * rate_1
2552 = k + a * k + a^2 * rate_0
2553 rate_3 = k + a * k + a^2 * k + a^3 * rate_0
2554 rate_N = rate_0 * a^N + k * SUM(x=0..N-1)(a^x)
2555 = rate_0 * a^N + k * (1 - a^N) / (1 - a)
2556 = rate_0 * a^N + p/i * (1 - a^N)
2558 When N is large, a^N -> 0 so rate_N -> p/i as desired.
2560 rate_N = p/i + (rate_0 - p/i) * a^N
2561 a^N = (rate_N - p/i) / (rate_0 - p/i)
2562 N * -i/p = log((rate_N - p/i) / (rate_0 - p/i))
2563 N = p/i * log((rate_0 - p/i) / (rate_N - p/i))
2565 Numerical analysis of the above equation, setting the computed rate to
2566 increase from rate_0 = 0 to rate_N = limit, shows that for large sending
2567 rates, p/i, the number of messages N = limit. So limit serves as both the
2568 maximum rate measured in messages per period, and the maximum number of
2569 messages that can be sent in a fast burst. */
2571 double this_time
= (double)tv
.tv_sec
2572 + (double)tv
.tv_usec
/ 1000000.0;
2573 double prev_time
= (double)dbd
->time_stamp
2574 + (double)dbd
->time_usec
/ 1000000.0;
2576 /* We must avoid division by zero, and deal gracefully with the clock going
2577 backwards. If we blunder ahead when time is in reverse then the computed
2578 rate will be bogus. To be safe we clamp interval to a very small number. */
2580 double interval
= this_time
- prev_time
<= 0.0 ? 1e-9
2581 : this_time
- prev_time
;
2583 double i_over_p
= interval
/ period
;
2584 double a
= exp(-i_over_p
);
2586 /* Combine the instantaneous rate (period / interval) with the previous rate
2587 using the smoothing factor a. In order to measure sized events, multiply the
2588 instantaneous rate by the count of bytes or recipients etc. */
2590 dbd
->time_stamp
= tv
.tv_sec
;
2591 dbd
->time_usec
= tv
.tv_usec
;
2592 dbd
->rate
= (1 - a
) * count
/ i_over_p
+ a
* dbd
->rate
;
2594 /* When events are very widely spaced the computed rate tends towards zero.
2595 Although this is accurate it turns out not to be useful for our purposes,
2596 especially when the first event after a long silence is the start of a spam
2597 run. A more useful model is that the rate for an isolated event should be the
2598 size of the event per the period size, ignoring the lack of events outside
2599 the current period and regardless of where the event falls in the period. So,
2600 if the interval was so long that the calculated rate is unhelpfully small, we
2601 re-intialize the rate. In the absence of higher-rate bursts, the condition
2602 below is true if the interval is greater than the period. */
2604 if (dbd
->rate
< count
) dbd
->rate
= count
;
2607 /* Clients sending at the limit are considered to be over the limit.
2608 This matters for edge cases such as a limit of zero, when the client
2609 should be completely blocked. */
2611 rc
= (dbd
->rate
< limit
)? FAIL
: OK
;
2613 /* Update the state if the rate is low or if we are being strict. If we
2614 are in leaky mode and the sender's rate is too high, we do not update
2615 the recorded rate in order to avoid an over-aggressive sender's retry
2616 rate preventing them from getting any email through. If readonly is set,
2617 neither leaky nor strict are set, so we do not do any updates. */
2619 if ((rc
== FAIL
&& leaky
) || strict
)
2621 dbfn_write(dbm
, key
, dbdb
, dbdb_size
);
2622 HDEBUG(D_acl
) debug_printf("ratelimit db updated\n");
2626 HDEBUG(D_acl
) debug_printf("ratelimit db not updated: %s\n",
2627 readonly
? "readonly mode" : "over the limit, but leaky");
2632 /* Store the result in the tree for future reference. */
2634 t
= store_get(sizeof(tree_node
) + Ustrlen(key
));
2636 Ustrcpy(t
->name
, key
);
2637 (void)tree_insertnode(anchor
, t
);
2639 /* We create the formatted version of the sender's rate very late in
2640 order to ensure that it is done using the correct storage pool. */
2642 store_pool
= old_pool
;
2643 sender_rate
= string_sprintf("%.1f", dbd
->rate
);
2646 debug_printf("ratelimit computed rate %s\n", sender_rate
);
2653 /*************************************************
2654 * Handle conditions/modifiers on an ACL item *
2655 *************************************************/
2657 /* Called from acl_check() below.
2661 cb ACL condition block - if NULL, result is OK
2662 where where called from
2663 addr the address being checked for RCPT, or NULL
2664 level the nesting level
2665 epp pointer to pass back TRUE if "endpass" encountered
2666 (applies only to "accept" and "discard")
2667 user_msgptr user message pointer
2668 log_msgptr log message pointer
2669 basic_errno pointer to where to put verify error
2671 Returns: OK - all conditions are met
2672 DISCARD - an "acl" condition returned DISCARD - only allowed
2673 for "accept" or "discard" verbs
2674 FAIL - at least one condition fails
2675 FAIL_DROP - an "acl" condition returned FAIL_DROP
2676 DEFER - can't tell at the moment (typically, lookup defer,
2677 but can be temporary callout problem)
2678 ERROR - ERROR from nested ACL or expansion failure or other
2683 acl_check_condition(int verb
, acl_condition_block
*cb
, int where
,
2684 address_item
*addr
, int level
, BOOL
*epp
, uschar
**user_msgptr
,
2685 uschar
**log_msgptr
, int *basic_errno
)
2687 uschar
*user_message
= NULL
;
2688 uschar
*log_message
= NULL
;
2689 uschar
*debug_tag
= NULL
;
2690 uschar
*debug_opts
= NULL
;
2693 #ifdef WITH_CONTENT_SCAN
2697 for (; cb
!= NULL
; cb
= cb
->next
)
2702 /* The message and log_message items set up messages to be used in
2703 case of rejection. They are expanded later. */
2705 if (cb
->type
== ACLC_MESSAGE
)
2707 user_message
= cb
->arg
;
2711 if (cb
->type
== ACLC_LOG_MESSAGE
)
2713 log_message
= cb
->arg
;
2717 /* The endpass "condition" just sets a flag to show it occurred. This is
2718 checked at compile time to be on an "accept" or "discard" item. */
2720 if (cb
->type
== ACLC_ENDPASS
)
2726 /* For other conditions and modifiers, the argument is expanded now for some
2727 of them, but not for all, because expansion happens down in some lower level
2728 checking functions in some cases. */
2730 if (cond_expand_at_top
[cb
->type
])
2732 arg
= expand_string(cb
->arg
);
2735 if (expand_string_forcedfail
) continue;
2736 *log_msgptr
= string_sprintf("failed to expand ACL string \"%s\": %s",
2737 cb
->arg
, expand_string_message
);
2738 return search_find_defer
? DEFER
: ERROR
;
2743 /* Show condition, and expanded condition if it's different */
2748 debug_printf("check %s%s %n",
2749 (!cond_modifiers
[cb
->type
] && cb
->u
.negated
)? "!":"",
2750 conditions
[cb
->type
], &lhswidth
);
2752 if (cb
->type
== ACLC_SET
)
2754 debug_printf("acl_%s ", cb
->u
.varname
);
2755 lhswidth
+= 5 + Ustrlen(cb
->u
.varname
);
2758 debug_printf("= %s\n", cb
->arg
);
2761 debug_printf("%.*s= %s\n", lhswidth
,
2765 /* Check that this condition makes sense at this time */
2767 if ((cond_forbids
[cb
->type
] & (1 << where
)) != 0)
2769 *log_msgptr
= string_sprintf("cannot %s %s condition in %s ACL",
2770 cond_modifiers
[cb
->type
]? "use" : "test",
2771 conditions
[cb
->type
], acl_wherenames
[where
]);
2775 /* Run the appropriate test for each condition, or take the appropriate
2776 action for the remaining modifiers. */
2780 case ACLC_ADD_HEADER
:
2784 /* A nested ACL that returns "discard" makes sense only for an "accept" or
2788 rc
= acl_check_internal(where
, addr
, arg
, level
+1, user_msgptr
, log_msgptr
);
2789 if (rc
== DISCARD
&& verb
!= ACL_ACCEPT
&& verb
!= ACL_DISCARD
)
2791 *log_msgptr
= string_sprintf("nested ACL returned \"discard\" for "
2792 "\"%s\" command (only allowed with \"accept\" or \"discard\")",
2798 case ACLC_AUTHENTICATED
:
2799 rc
= (sender_host_authenticated
== NULL
)? FAIL
:
2800 match_isinlist(sender_host_authenticated
, &arg
, 0, NULL
, NULL
, MCL_STRING
,
2804 #ifdef EXPERIMENTAL_BRIGHTMAIL
2805 case ACLC_BMI_OPTIN
:
2807 int old_pool
= store_pool
;
2808 store_pool
= POOL_PERM
;
2809 bmi_current_optin
= string_copy(arg
);
2810 store_pool
= old_pool
;
2815 case ACLC_CONDITION
:
2816 /* The true/false parsing here should be kept in sync with that used in
2817 expand.c when dealing with ECOND_BOOL so that we don't have too many
2818 different definitions of what can be a boolean. */
2819 if (Ustrspn(arg
, "0123456789") == Ustrlen(arg
)) /* Digits, or empty */
2820 rc
= (Uatoi(arg
) == 0)? FAIL
: OK
;
2822 rc
= (strcmpic(arg
, US
"no") == 0 ||
2823 strcmpic(arg
, US
"false") == 0)? FAIL
:
2824 (strcmpic(arg
, US
"yes") == 0 ||
2825 strcmpic(arg
, US
"true") == 0)? OK
: DEFER
;
2827 *log_msgptr
= string_sprintf("invalid \"condition\" value \"%s\"", arg
);
2830 case ACLC_CONTINUE
: /* Always succeeds */
2834 control_type
= decode_control(arg
, &p
, where
, log_msgptr
);
2836 /* Check if this control makes sense at this time */
2838 if ((control_forbids
[control_type
] & (1 << where
)) != 0)
2840 *log_msgptr
= string_sprintf("cannot use \"control=%s\" in %s ACL",
2841 controls
[control_type
], acl_wherenames
[where
]);
2845 switch(control_type
)
2847 case CONTROL_AUTH_UNADVERTISED
:
2848 allow_auth_unadvertised
= TRUE
;
2851 #ifdef EXPERIMENTAL_BRIGHTMAIL
2852 case CONTROL_BMI_RUN
:
2857 #ifndef DISABLE_DKIM
2858 case CONTROL_DKIM_VERIFY
:
2859 dkim_disable_verify
= TRUE
;
2866 int fd
, af
, level
, optname
, value
;
2867 /* If we are acting on stdin, the setsockopt may fail if stdin is not
2868 a socket; we can accept that, we'll just debug-log failures anyway. */
2869 fd
= fileno(smtp_in
);
2870 af
= ip_get_address_family(fd
);
2874 debug_printf("smtp input is probably not a socket [%s], not setting DSCP\n",
2878 if (dscp_lookup(p
+1, af
, &level
, &optname
, &value
))
2880 if (setsockopt(fd
, level
, optname
, &value
, sizeof(value
)) < 0)
2882 HDEBUG(D_acl
) debug_printf("failed to set input DSCP[%s]: %s\n",
2883 p
+1, strerror(errno
));
2887 HDEBUG(D_acl
) debug_printf("set input DSCP to \"%s\"\n", p
+1);
2892 *log_msgptr
= string_sprintf("unrecognised DSCP value in \"control=%s\"", arg
);
2898 *log_msgptr
= string_sprintf("syntax error in \"control=%s\"", arg
);
2906 case CONTROL_CASEFUL_LOCAL_PART
:
2907 deliver_localpart
= addr
->cc_local_part
;
2910 case CONTROL_CASELOWER_LOCAL_PART
:
2911 deliver_localpart
= addr
->lc_local_part
;
2914 case CONTROL_ENFORCE_SYNC
:
2915 smtp_enforce_sync
= TRUE
;
2918 case CONTROL_NO_ENFORCE_SYNC
:
2919 smtp_enforce_sync
= FALSE
;
2922 #ifdef WITH_CONTENT_SCAN
2923 case CONTROL_NO_MBOX_UNSPOOL
:
2924 no_mbox_unspool
= TRUE
;
2928 case CONTROL_NO_MULTILINE
:
2929 no_multiline_responses
= TRUE
;
2932 case CONTROL_NO_PIPELINING
:
2933 pipelining_enable
= FALSE
;
2936 case CONTROL_NO_DELAY_FLUSH
:
2937 disable_delay_flush
= TRUE
;
2940 case CONTROL_NO_CALLOUT_FLUSH
:
2941 disable_callout_flush
= TRUE
;
2944 case CONTROL_FAKEDEFER
:
2945 case CONTROL_FAKEREJECT
:
2946 fake_response
= (control_type
== CONTROL_FAKEDEFER
) ? DEFER
: FAIL
;
2950 while (*pp
!= 0) pp
++;
2951 fake_response_text
= expand_string(string_copyn(p
+1, pp
-p
-1));
2956 /* Explicitly reset to default string */
2957 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).";
2961 case CONTROL_FREEZE
:
2962 deliver_freeze
= TRUE
;
2963 deliver_frozen_at
= time(NULL
);
2964 freeze_tell
= freeze_tell_config
; /* Reset to configured value */
2965 if (Ustrncmp(p
, "/no_tell", 8) == 0)
2972 *log_msgptr
= string_sprintf("syntax error in \"control=%s\"", arg
);
2977 case CONTROL_QUEUE_ONLY
:
2978 queue_only_policy
= TRUE
;
2981 case CONTROL_SUBMISSION
:
2982 originator_name
= US
"";
2983 submission_mode
= TRUE
;
2986 if (Ustrncmp(p
, "/sender_retain", 14) == 0)
2989 active_local_sender_retain
= TRUE
;
2990 active_local_from_check
= FALSE
;
2992 else if (Ustrncmp(p
, "/domain=", 8) == 0)
2995 while (*pp
!= 0 && *pp
!= '/') pp
++;
2996 submission_domain
= string_copyn(p
+8, pp
-p
-8);
2999 /* The name= option must be last, because it swallows the rest of
3001 else if (Ustrncmp(p
, "/name=", 6) == 0)
3004 while (*pp
!= 0) pp
++;
3005 submission_name
= string_copy(parse_fix_phrase(p
+6, pp
-p
-6,
3006 big_buffer
, big_buffer_size
));
3013 *log_msgptr
= string_sprintf("syntax error in \"control=%s\"", arg
);
3021 if (Ustrncmp(p
, "/tag=", 5) == 0)
3024 while (*pp
!= '\0' && *pp
!= '/') pp
++;
3025 debug_tag
= string_copyn(p
+5, pp
-p
-5);
3028 else if (Ustrncmp(p
, "/opts=", 6) == 0)
3031 while (*pp
!= '\0' && *pp
!= '/') pp
++;
3032 debug_opts
= string_copyn(p
+6, pp
-p
-6);
3036 debug_logging_activate(debug_tag
, debug_opts
);
3039 case CONTROL_SUPPRESS_LOCAL_FIXUPS
:
3040 suppress_local_fixups
= TRUE
;
3043 case CONTROL_CUTTHROUGH_DELIVERY
:
3046 *log_msgptr
= string_sprintf("\"control=%s\" on frozen item", arg
);
3049 if (queue_only_policy
)
3051 *log_msgptr
= string_sprintf("\"control=%s\" on queue-only item", arg
);
3054 cutthrough_delivery
= TRUE
;
3059 #ifdef EXPERIMENTAL_DCC
3062 /* Seperate the regular expression and any optional parameters. */
3063 uschar
*ss
= string_nextinlist(&arg
, &sep
, big_buffer
, big_buffer_size
);
3064 /* Run the dcc backend. */
3065 rc
= dcc_process(&ss
);
3066 /* Modify return code based upon the existance of options. */
3067 while ((ss
= string_nextinlist(&arg
, &sep
, big_buffer
, big_buffer_size
))
3069 if (strcmpic(ss
, US
"defer_ok") == 0 && rc
== DEFER
)
3071 /* FAIL so that the message is passed to the next ACL */
3079 #ifdef WITH_CONTENT_SCAN
3081 rc
= mime_decode(&arg
);
3087 int delay
= readconf_readtime(arg
, 0, FALSE
);
3090 *log_msgptr
= string_sprintf("syntax error in argument for \"delay\" "
3091 "modifier: \"%s\" is not a time value", arg
);
3096 HDEBUG(D_acl
) debug_printf("delay modifier requests %d-second delay\n",
3101 debug_printf("delay skipped in -bh checking mode\n");
3104 /* It appears to be impossible to detect that a TCP/IP connection has
3105 gone away without reading from it. This means that we cannot shorten
3106 the delay below if the client goes away, because we cannot discover
3107 that the client has closed its end of the connection. (The connection
3108 is actually in a half-closed state, waiting for the server to close its
3109 end.) It would be nice to be able to detect this state, so that the
3110 Exim process is not held up unnecessarily. However, it seems that we
3111 can't. The poll() function does not do the right thing, and in any case
3112 it is not always available.
3114 NOTE 1: If ever this state of affairs changes, remember that we may be
3115 dealing with stdin/stdout here, in addition to TCP/IP connections.
3116 Also, delays may be specified for non-SMTP input, where smtp_out and
3117 smtp_in will be NULL. Whatever is done must work in all cases.
3119 NOTE 2: The added feature of flushing the output before a delay must
3120 apply only to SMTP input. Hence the test for smtp_out being non-NULL.
3125 if (smtp_out
!= NULL
&& !disable_delay_flush
) mac_smtp_fflush();
3126 while (delay
> 0) delay
= sleep(delay
);
3132 #ifdef WITH_OLD_DEMIME
3138 #ifndef DISABLE_DKIM
3139 case ACLC_DKIM_SIGNER
:
3140 if (dkim_cur_signer
!= NULL
)
3141 rc
= match_isinlist(dkim_cur_signer
,
3142 &arg
,0,NULL
,NULL
,MCL_STRING
,TRUE
,NULL
);
3147 case ACLC_DKIM_STATUS
:
3148 rc
= match_isinlist(dkim_exim_expand_query(DKIM_VERIFY_STATUS
),
3149 &arg
,0,NULL
,NULL
,MCL_STRING
,TRUE
,NULL
);
3154 rc
= verify_check_dnsbl(&arg
);
3158 rc
= match_isinlist(addr
->domain
, &arg
, 0, &domainlist_anchor
,
3159 addr
->domain_cache
, MCL_DOMAIN
, TRUE
, &deliver_domain_data
);
3162 /* The value in tls_cipher is the full cipher name, for example,
3163 TLSv1:DES-CBC3-SHA:168, whereas the values to test for are just the
3164 cipher names such as DES-CBC3-SHA. But program defensively. We don't know
3165 what may in practice come out of the SSL library - which at the time of
3166 writing is poorly documented. */
3168 case ACLC_ENCRYPTED
:
3169 if (tls_in
.cipher
== NULL
) rc
= FAIL
; else
3171 uschar
*endcipher
= NULL
;
3172 uschar
*cipher
= Ustrchr(tls_in
.cipher
, ':');
3173 if (cipher
== NULL
) cipher
= tls_in
.cipher
; else
3175 endcipher
= Ustrchr(++cipher
, ':');
3176 if (endcipher
!= NULL
) *endcipher
= 0;
3178 rc
= match_isinlist(cipher
, &arg
, 0, NULL
, NULL
, MCL_STRING
, TRUE
, NULL
);
3179 if (endcipher
!= NULL
) *endcipher
= ':';
3183 /* Use verify_check_this_host() instead of verify_check_host() so that
3184 we can pass over &host_data to catch any looked up data. Once it has been
3185 set, it retains its value so that it's still there if another ACL verb
3186 comes through here and uses the cache. However, we must put it into
3187 permanent store in case it is also expected to be used in a subsequent
3188 message in the same SMTP connection. */
3191 rc
= verify_check_this_host(&arg
, sender_host_cache
, NULL
,
3192 (sender_host_address
== NULL
)? US
"" : sender_host_address
, &host_data
);
3193 if (host_data
!= NULL
) host_data
= string_copy_malloc(host_data
);
3196 case ACLC_LOCAL_PARTS
:
3197 rc
= match_isinlist(addr
->cc_local_part
, &arg
, 0,
3198 &localpartlist_anchor
, addr
->localpart_cache
, MCL_LOCALPART
, TRUE
,
3199 &deliver_localpart_data
);
3202 case ACLC_LOG_REJECT_TARGET
:
3208 while ((ss
= string_nextinlist(&s
, &sep
, big_buffer
, big_buffer_size
))
3211 if (Ustrcmp(ss
, "main") == 0) logbits
|= LOG_MAIN
;
3212 else if (Ustrcmp(ss
, "panic") == 0) logbits
|= LOG_PANIC
;
3213 else if (Ustrcmp(ss
, "reject") == 0) logbits
|= LOG_REJECT
;
3216 logbits
|= LOG_MAIN
|LOG_REJECT
;
3217 log_write(0, LOG_MAIN
|LOG_PANIC
, "unknown log name \"%s\" in "
3218 "\"log_reject_target\" in %s ACL", ss
, acl_wherenames
[where
]);
3221 log_reject_target
= logbits
;
3234 if (Ustrncmp(s
, "main", 4) == 0)
3235 { logbits
|= LOG_MAIN
; s
+= 4; }
3236 else if (Ustrncmp(s
, "panic", 5) == 0)
3237 { logbits
|= LOG_PANIC
; s
+= 5; }
3238 else if (Ustrncmp(s
, "reject", 6) == 0)
3239 { logbits
|= LOG_REJECT
; s
+= 6; }
3242 logbits
= LOG_MAIN
|LOG_PANIC
;
3243 s
= string_sprintf(":unknown log name in \"%s\" in "
3244 "\"logwrite\" in %s ACL", arg
, acl_wherenames
[where
]);
3250 while (isspace(*s
)) s
++;
3253 if (logbits
== 0) logbits
= LOG_MAIN
;
3254 log_write(0, logbits
, "%s", string_printing(s
));
3258 #ifdef WITH_CONTENT_SCAN
3261 /* Separate the regular expression and any optional parameters. */
3262 uschar
*ss
= string_nextinlist(&arg
, &sep
, big_buffer
, big_buffer_size
);
3263 /* Run the malware backend. */
3265 /* Modify return code based upon the existance of options. */
3266 while ((ss
= string_nextinlist(&arg
, &sep
, big_buffer
, big_buffer_size
))
3268 if (strcmpic(ss
, US
"defer_ok") == 0 && rc
== DEFER
)
3270 /* FAIL so that the message is passed to the next ACL */
3277 case ACLC_MIME_REGEX
:
3278 rc
= mime_regex(&arg
);
3282 case ACLC_RATELIMIT
:
3283 rc
= acl_ratelimit(arg
, where
, log_msgptr
);
3286 case ACLC_RECIPIENTS
:
3287 rc
= match_address_list(addr
->address
, TRUE
, TRUE
, &arg
, NULL
, -1, 0,
3291 #ifdef WITH_CONTENT_SCAN
3297 case ACLC_SENDER_DOMAINS
:
3300 sdomain
= Ustrrchr(sender_address
, '@');
3301 sdomain
= (sdomain
== NULL
)? US
"" : sdomain
+ 1;
3302 rc
= match_isinlist(sdomain
, &arg
, 0, &domainlist_anchor
,
3303 sender_domain_cache
, MCL_DOMAIN
, TRUE
, NULL
);
3308 rc
= match_address_list(sender_address
, TRUE
, TRUE
, &arg
,
3309 sender_address_cache
, -1, 0, &sender_data
);
3312 /* Connection variables must persist forever */
3316 int old_pool
= store_pool
;
3317 if (cb
->u
.varname
[0] == 'c') store_pool
= POOL_PERM
;
3318 acl_var_create(cb
->u
.varname
)->data
.ptr
= string_copy(arg
);
3319 store_pool
= old_pool
;
3323 #ifdef WITH_CONTENT_SCAN
3326 /* Seperate the regular expression and any optional parameters. */
3327 uschar
*ss
= string_nextinlist(&arg
, &sep
, big_buffer
, big_buffer_size
);
3328 /* Run the spam backend. */
3330 /* Modify return code based upon the existance of options. */
3331 while ((ss
= string_nextinlist(&arg
, &sep
, big_buffer
, big_buffer_size
))
3333 if (strcmpic(ss
, US
"defer_ok") == 0 && rc
== DEFER
)
3335 /* FAIL so that the message is passed to the next ACL */
3343 #ifdef EXPERIMENTAL_SPF
3345 rc
= spf_process(&arg
, sender_address
, SPF_PROCESS_NORMAL
);
3347 case ACLC_SPF_GUESS
:
3348 rc
= spf_process(&arg
, sender_address
, SPF_PROCESS_GUESS
);
3352 /* If the verb is WARN, discard any user message from verification, because
3353 such messages are SMTP responses, not header additions. The latter come
3354 only from explicit "message" modifiers. However, put the user message into
3355 $acl_verify_message so it can be used in subsequent conditions or modifiers
3356 (until something changes it). */
3359 rc
= acl_verify(where
, addr
, arg
, user_msgptr
, log_msgptr
, basic_errno
);
3360 acl_verify_message
= *user_msgptr
;
3361 if (verb
== ACL_WARN
) *user_msgptr
= NULL
;
3365 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "internal ACL error: unknown "
3366 "condition %d", cb
->type
);
3370 /* If a condition was negated, invert OK/FAIL. */
3372 if (!cond_modifiers
[cb
->type
] && cb
->u
.negated
)
3374 if (rc
== OK
) rc
= FAIL
;
3375 else if (rc
== FAIL
|| rc
== FAIL_DROP
) rc
= OK
;
3378 if (rc
!= OK
) break; /* Conditions loop */
3382 /* If the result is the one for which "message" and/or "log_message" are used,
3383 handle the values of these modifiers. If there isn't a log message set, we make
3384 it the same as the user message.
3386 "message" is a user message that will be included in an SMTP response. Unless
3387 it is empty, it overrides any previously set user message.
3389 "log_message" is a non-user message, and it adds to any existing non-user
3390 message that is already set.
3392 Most verbs have but a single return for which the messages are relevant, but
3393 for "discard", it's useful to have the log message both when it succeeds and
3394 when it fails. For "accept", the message is used in the OK case if there is no
3395 "endpass", but (for backwards compatibility) in the FAIL case if "endpass" is
3398 if (*epp
&& rc
== OK
) user_message
= NULL
;
3400 if (((1<<rc
) & msgcond
[verb
]) != 0)
3403 uschar
*old_user_msgptr
= *user_msgptr
;
3404 uschar
*old_log_msgptr
= (*log_msgptr
!= NULL
)? *log_msgptr
: old_user_msgptr
;
3406 /* If the verb is "warn", messages generated by conditions (verification or
3407 nested ACLs) are always discarded. This also happens for acceptance verbs
3408 when they actually do accept. Only messages specified at this level are used.
3409 However, the value of an existing message is available in $acl_verify_message
3410 during expansions. */
3412 if (verb
== ACL_WARN
||
3413 (rc
== OK
&& (verb
== ACL_ACCEPT
|| verb
== ACL_DISCARD
)))
3414 *log_msgptr
= *user_msgptr
= NULL
;
3416 if (user_message
!= NULL
)
3418 acl_verify_message
= old_user_msgptr
;
3419 expmessage
= expand_string(user_message
);
3420 if (expmessage
== NULL
)
3422 if (!expand_string_forcedfail
)
3423 log_write(0, LOG_MAIN
|LOG_PANIC
, "failed to expand ACL message \"%s\": %s",
3424 user_message
, expand_string_message
);
3426 else if (expmessage
[0] != 0) *user_msgptr
= expmessage
;
3429 if (log_message
!= NULL
)
3431 acl_verify_message
= old_log_msgptr
;
3432 expmessage
= expand_string(log_message
);
3433 if (expmessage
== NULL
)
3435 if (!expand_string_forcedfail
)
3436 log_write(0, LOG_MAIN
|LOG_PANIC
, "failed to expand ACL message \"%s\": %s",
3437 log_message
, expand_string_message
);
3439 else if (expmessage
[0] != 0)
3441 *log_msgptr
= (*log_msgptr
== NULL
)? expmessage
:
3442 string_sprintf("%s: %s", expmessage
, *log_msgptr
);
3446 /* If no log message, default it to the user message */
3448 if (*log_msgptr
== NULL
) *log_msgptr
= *user_msgptr
;
3451 acl_verify_message
= NULL
;
3459 /*************************************************
3460 * Get line from a literal ACL *
3461 *************************************************/
3463 /* This function is passed to acl_read() in order to extract individual lines
3464 of a literal ACL, which we access via static pointers. We can destroy the
3465 contents because this is called only once (the compiled ACL is remembered).
3467 This code is intended to treat the data in the same way as lines in the main
3468 Exim configuration file. That is:
3470 . Leading spaces are ignored.
3472 . A \ at the end of a line is a continuation - trailing spaces after the \
3473 are permitted (this is because I don't believe in making invisible things
3474 significant). Leading spaces on the continued part of a line are ignored.
3476 . Physical lines starting (significantly) with # are totally ignored, and
3477 may appear within a sequence of backslash-continued lines.
3479 . Blank lines are ignored, but will end a sequence of continuations.
3482 Returns: a pointer to the next line
3486 static uschar
*acl_text
; /* Current pointer in the text */
3487 static uschar
*acl_text_end
; /* Points one past the terminating '0' */
3495 /* This loop handles leading blank lines and comments. */
3499 while (isspace(*acl_text
)) acl_text
++; /* Leading spaces/empty lines */
3500 if (*acl_text
== 0) return NULL
; /* No more data */
3501 yield
= acl_text
; /* Potential data line */
3503 while (*acl_text
!= 0 && *acl_text
!= '\n') acl_text
++;
3505 /* If we hit the end before a newline, we have the whole logical line. If
3506 it's a comment, there's no more data to be given. Otherwise, yield it. */
3508 if (*acl_text
== 0) return (*yield
== '#')? NULL
: yield
;
3510 /* After reaching a newline, end this loop if the physical line does not
3511 start with '#'. If it does, it's a comment, and the loop continues. */
3513 if (*yield
!= '#') break;
3516 /* This loop handles continuations. We know we have some real data, ending in
3517 newline. See if there is a continuation marker at the end (ignoring trailing
3518 white space). We know that *yield is not white space, so no need to test for
3519 cont > yield in the backwards scanning loop. */
3524 for (cont
= acl_text
- 1; isspace(*cont
); cont
--);
3526 /* If no continuation follows, we are done. Mark the end of the line and
3535 /* We have encountered a continuation. Skip over whitespace at the start of
3536 the next line, and indeed the whole of the next line or lines if they are
3541 while (*(++acl_text
) == ' ' || *acl_text
== '\t');
3542 if (*acl_text
!= '#') break;
3543 while (*(++acl_text
) != 0 && *acl_text
!= '\n');
3546 /* We have the start of a continuation line. Move all the rest of the data
3547 to join onto the previous line, and then find its end. If the end is not a
3548 newline, we are done. Otherwise loop to look for another continuation. */
3550 memmove(cont
, acl_text
, acl_text_end
- acl_text
);
3551 acl_text_end
-= acl_text
- cont
;
3553 while (*acl_text
!= 0 && *acl_text
!= '\n') acl_text
++;
3554 if (*acl_text
== 0) return yield
;
3557 /* Control does not reach here */
3564 /*************************************************
3565 * Check access using an ACL *
3566 *************************************************/
3568 /* This function is called from address_check. It may recurse via
3569 acl_check_condition() - hence the use of a level to stop looping. The ACL is
3570 passed as a string which is expanded. A forced failure implies no access check
3571 is required. If the result is a single word, it is taken as the name of an ACL
3572 which is sought in the global ACL tree. Otherwise, it is taken as literal ACL
3573 text, complete with newlines, and parsed as such. In both cases, the ACL check
3574 is then run. This function uses an auxiliary function for acl_read() to call
3575 for reading individual lines of a literal ACL. This is acl_getline(), which
3576 appears immediately above.
3579 where where called from
3580 addr address item when called from RCPT; otherwise NULL
3581 s the input string; NULL is the same as an empty ACL => DENY
3582 level the nesting level
3583 user_msgptr where to put a user error (for SMTP response)
3584 log_msgptr where to put a logging message (not for SMTP response)
3586 Returns: OK access is granted
3587 DISCARD access is apparently granted...
3588 FAIL access is denied
3589 FAIL_DROP access is denied; drop the connection
3590 DEFER can't tell at the moment
3595 acl_check_internal(int where
, address_item
*addr
, uschar
*s
, int level
,
3596 uschar
**user_msgptr
, uschar
**log_msgptr
)
3599 acl_block
*acl
= NULL
;
3600 uschar
*acl_name
= US
"inline ACL";
3603 /* Catch configuration loops */
3607 *log_msgptr
= US
"ACL nested too deep: possible loop";
3613 HDEBUG(D_acl
) debug_printf("ACL is NULL: implicit DENY\n");
3617 /* At top level, we expand the incoming string. At lower levels, it has already
3618 been expanded as part of condition processing. */
3622 ss
= expand_string(s
);
3625 if (expand_string_forcedfail
) return OK
;
3626 *log_msgptr
= string_sprintf("failed to expand ACL string \"%s\": %s", s
,
3627 expand_string_message
);
3633 while (isspace(*ss
))ss
++;
3635 /* If we can't find a named ACL, the default is to parse it as an inline one.
3636 (Unless it begins with a slash; non-existent files give rise to an error.) */
3640 /* Handle the case of a string that does not contain any spaces. Look for a
3641 named ACL among those read from the configuration, or a previously read file.
3642 It is possible that the pointer to the ACL is NULL if the configuration
3643 contains a name with no data. If not found, and the text begins with '/',
3644 read an ACL from a file, and save it so it can be re-used. */
3646 if (Ustrchr(ss
, ' ') == NULL
)
3648 tree_node
*t
= tree_search(acl_anchor
, ss
);
3651 acl
= (acl_block
*)(t
->data
.ptr
);
3654 HDEBUG(D_acl
) debug_printf("ACL \"%s\" is empty: implicit DENY\n", ss
);
3657 acl_name
= string_sprintf("ACL \"%s\"", ss
);
3658 HDEBUG(D_acl
) debug_printf("using ACL \"%s\"\n", ss
);
3661 else if (*ss
== '/')
3663 struct stat statbuf
;
3664 fd
= Uopen(ss
, O_RDONLY
, 0);
3667 *log_msgptr
= string_sprintf("failed to open ACL file \"%s\": %s", ss
,
3672 if (fstat(fd
, &statbuf
) != 0)
3674 *log_msgptr
= string_sprintf("failed to fstat ACL file \"%s\": %s", ss
,
3679 acl_text
= store_get(statbuf
.st_size
+ 1);
3680 acl_text_end
= acl_text
+ statbuf
.st_size
+ 1;
3682 if (read(fd
, acl_text
, statbuf
.st_size
) != statbuf
.st_size
)
3684 *log_msgptr
= string_sprintf("failed to read ACL file \"%s\": %s",
3685 ss
, strerror(errno
));
3688 acl_text
[statbuf
.st_size
] = 0;
3691 acl_name
= string_sprintf("ACL \"%s\"", ss
);
3692 HDEBUG(D_acl
) debug_printf("read ACL from file %s\n", ss
);
3696 /* Parse an ACL that is still in text form. If it came from a file, remember it
3697 in the ACL tree, having read it into the POOL_PERM store pool so that it
3698 persists between multiple messages. */
3702 int old_pool
= store_pool
;
3703 if (fd
>= 0) store_pool
= POOL_PERM
;
3704 acl
= acl_read(acl_getline
, log_msgptr
);
3705 store_pool
= old_pool
;
3706 if (acl
== NULL
&& *log_msgptr
!= NULL
) return ERROR
;
3709 tree_node
*t
= store_get_perm(sizeof(tree_node
) + Ustrlen(ss
));
3710 Ustrcpy(t
->name
, ss
);
3712 (void)tree_insertnode(&acl_anchor
, t
);
3716 /* Now we have an ACL to use. It's possible it may be NULL. */
3721 int basic_errno
= 0;
3722 BOOL endpass_seen
= FALSE
;
3724 *log_msgptr
= *user_msgptr
= NULL
;
3725 acl_temp_details
= FALSE
;
3727 if ((where
== ACL_WHERE_QUIT
|| where
== ACL_WHERE_NOTQUIT
) &&
3728 acl
->verb
!= ACL_ACCEPT
&&
3729 acl
->verb
!= ACL_WARN
)
3731 *log_msgptr
= string_sprintf("\"%s\" is not allowed in a QUIT or not-QUIT ACL",
3736 HDEBUG(D_acl
) debug_printf("processing \"%s\"\n", verbs
[acl
->verb
]);
3738 /* Clear out any search error message from a previous check before testing
3741 search_error_message
= NULL
;
3742 cond
= acl_check_condition(acl
->verb
, acl
->condition
, where
, addr
, level
,
3743 &endpass_seen
, user_msgptr
, log_msgptr
, &basic_errno
);
3745 /* Handle special returns: DEFER causes a return except on a WARN verb;
3746 ERROR always causes a return. */
3751 HDEBUG(D_acl
) debug_printf("%s: condition test deferred in %s\n", verbs
[acl
->verb
], acl_name
);
3752 if (basic_errno
!= ERRNO_CALLOUTDEFER
)
3754 if (search_error_message
!= NULL
&& *search_error_message
!= 0)
3755 *log_msgptr
= search_error_message
;
3756 if (smtp_return_error_details
) acl_temp_details
= TRUE
;
3760 acl_temp_details
= TRUE
;
3762 if (acl
->verb
!= ACL_WARN
) return DEFER
;
3765 default: /* Paranoia */
3767 HDEBUG(D_acl
) debug_printf("%s: condition test error in %s\n", verbs
[acl
->verb
], acl_name
);
3771 HDEBUG(D_acl
) debug_printf("%s: condition test succeeded in %s\n",
3772 verbs
[acl
->verb
], acl_name
);
3776 HDEBUG(D_acl
) debug_printf("%s: condition test failed in %s\n", verbs
[acl
->verb
], acl_name
);
3779 /* DISCARD and DROP can happen only from a nested ACL condition, and
3780 DISCARD can happen only for an "accept" or "discard" verb. */
3783 HDEBUG(D_acl
) debug_printf("%s: condition test yielded \"discard\" in %s\n",
3784 verbs
[acl
->verb
], acl_name
);
3788 HDEBUG(D_acl
) debug_printf("%s: condition test yielded \"drop\" in %s\n",
3789 verbs
[acl
->verb
], acl_name
);
3793 /* At this point, cond for most verbs is either OK or FAIL or (as a result of
3794 a nested ACL condition) FAIL_DROP. However, for WARN, cond may be DEFER, and
3795 for ACCEPT and DISCARD, it may be DISCARD after a nested ACL call. */
3800 if (cond
== OK
|| cond
== DISCARD
) return cond
;
3803 HDEBUG(D_acl
) debug_printf("accept: endpass encountered - denying access\n");
3811 acl_temp_details
= TRUE
;
3817 if (cond
== OK
) return FAIL
;
3821 if (cond
== OK
|| cond
== DISCARD
) return DISCARD
;
3824 HDEBUG(D_acl
) debug_printf("discard: endpass encountered - denying access\n");
3830 if (cond
== OK
) return FAIL_DROP
;
3834 if (cond
!= OK
) return cond
;
3839 acl_warn(where
, *user_msgptr
, *log_msgptr
);
3840 else if (cond
== DEFER
&& (log_extra_selector
& LX_acl_warn_skipped
) != 0)
3841 log_write(0, LOG_MAIN
, "%s Warning: ACL \"warn\" statement skipped: "
3842 "condition test deferred%s%s", host_and_ident(TRUE
),
3843 (*log_msgptr
== NULL
)? US
"" : US
": ",
3844 (*log_msgptr
== NULL
)? US
"" : *log_msgptr
);
3845 *log_msgptr
= *user_msgptr
= NULL
; /* In case implicit DENY follows */
3849 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "internal ACL error: unknown verb %d",
3854 /* Pass to the next ACL item */
3859 /* We have reached the end of the ACL. This is an implicit DENY. */
3861 HDEBUG(D_acl
) debug_printf("end of %s: implicit DENY\n", acl_name
);
3866 /*************************************************
3867 * Check access using an ACL *
3868 *************************************************/
3870 /* This is the external interface for ACL checks. It sets up an address and the
3871 expansions for $domain and $local_part when called after RCPT, then calls
3872 acl_check_internal() to do the actual work.
3875 where ACL_WHERE_xxxx indicating where called from
3876 recipient RCPT address for RCPT check, else NULL
3877 s the input string; NULL is the same as an empty ACL => DENY
3878 user_msgptr where to put a user error (for SMTP response)
3879 log_msgptr where to put a logging message (not for SMTP response)
3881 Returns: OK access is granted by an ACCEPT verb
3882 DISCARD access is granted by a DISCARD verb
3883 FAIL access is denied
3884 FAIL_DROP access is denied; drop the connection
3885 DEFER can't tell at the moment
3890 acl_check(int where
, uschar
*recipient
, uschar
*s
, uschar
**user_msgptr
,
3891 uschar
**log_msgptr
)
3895 address_item
*addr
= NULL
;
3897 *user_msgptr
= *log_msgptr
= NULL
;
3898 sender_verified_failed
= NULL
;
3899 ratelimiters_cmd
= NULL
;
3900 log_reject_target
= LOG_MAIN
|LOG_REJECT
;
3902 if (where
== ACL_WHERE_RCPT
)
3904 adb
= address_defaults
;
3906 addr
->address
= recipient
;
3907 if (deliver_split_address(addr
) == DEFER
)
3909 *log_msgptr
= US
"defer in percent_hack_domains check";
3912 deliver_domain
= addr
->domain
;
3913 deliver_localpart
= addr
->local_part
;
3916 rc
= acl_check_internal(where
, addr
, s
, 0, user_msgptr
, log_msgptr
);
3918 /* Cutthrough - if requested,
3919 and WHERE_RCPT and not yet opened conn as result of recipient-verify,
3920 and rcpt acl returned accept,
3921 and first recipient (cancel on any subsequents)
3922 open one now and run it up to RCPT acceptance.
3923 A failed verify should cancel cutthrough request.
3925 Initial implementation: dual-write to spool.
3926 Assume the rxd datastream is now being copied byte-for-byte to an open cutthrough connection.
3928 Cease cutthrough copy on rxd final dot; do not send one.
3930 On a data acl, if not accept and a cutthrough conn is open, hard-close it (no SMTP niceness).
3932 On data acl accept, terminate the dataphase on an open cutthrough conn. If accepted or
3933 perm-rejected, reflect that to the original sender - and dump the spooled copy.
3934 If temp-reject, close the conn (and keep the spooled copy).
3935 If conn-failure, no action (and keep the spooled copy).
3939 case ACL_WHERE_RCPT
:
3940 if( rcpt_count
> 1 )
3941 cancel_cutthrough_connection("more than one recipient");
3942 else if (rc
== OK
&& cutthrough_delivery
&& cutthrough_fd
< 0)
3943 open_cutthrough_connection(addr
);
3946 case ACL_WHERE_PREDATA
:
3948 cutthrough_predata();
3950 cancel_cutthrough_connection("predata acl not ok");
3953 case ACL_WHERE_QUIT
:
3954 case ACL_WHERE_NOTQUIT
:
3955 cancel_cutthrough_connection("quit or notquit");
3962 deliver_domain
= deliver_localpart
= deliver_address_data
=
3963 sender_address_data
= NULL
;
3965 /* A DISCARD response is permitted only for message ACLs, excluding the PREDATA
3966 ACL, which is really in the middle of an SMTP command. */
3970 if (where
> ACL_WHERE_NOTSMTP
|| where
== ACL_WHERE_PREDATA
)
3972 log_write(0, LOG_MAIN
|LOG_PANIC
, "\"discard\" verb not allowed in %s "
3973 "ACL", acl_wherenames
[where
]);
3979 /* A DROP response is not permitted from MAILAUTH */
3981 if (rc
== FAIL_DROP
&& where
== ACL_WHERE_MAILAUTH
)
3983 log_write(0, LOG_MAIN
|LOG_PANIC
, "\"drop\" verb not allowed in %s "
3984 "ACL", acl_wherenames
[where
]);
3988 /* Before giving a response, take a look at the length of any user message, and
3989 split it up into multiple lines if possible. */
3991 *user_msgptr
= string_split_message(*user_msgptr
);
3992 if (fake_response
!= OK
)
3993 fake_response_text
= string_split_message(fake_response_text
);
4000 /*************************************************
4001 * Create ACL variable *
4002 *************************************************/
4004 /* Create an ACL variable or reuse an existing one. ACL variables are in a
4005 binary tree (see tree.c) with acl_var_c and acl_var_m as root nodes.
4008 name pointer to the variable's name, starting with c or m
4010 Returns the pointer to variable's tree node
4014 acl_var_create(uschar
*name
)
4016 tree_node
*node
, **root
;
4017 root
= (name
[0] == 'c')? &acl_var_c
: &acl_var_m
;
4018 node
= tree_search(*root
, name
);
4021 node
= store_get(sizeof(tree_node
) + Ustrlen(name
));
4022 Ustrcpy(node
->name
, name
);
4023 (void)tree_insertnode(root
, node
);
4025 node
->data
.ptr
= NULL
;
4031 /*************************************************
4032 * Write an ACL variable in spool format *
4033 *************************************************/
4035 /* This function is used as a callback for tree_walk when writing variables to
4036 the spool file. To retain spool file compatibility, what is written is -aclc or
4037 -aclm followed by the rest of the name and the data length, space separated,
4038 then the value itself, starting on a new line, and terminated by an additional
4039 newline. When we had only numbered ACL variables, the first line might look
4040 like this: "-aclc 5 20". Now it might be "-aclc foo 20" for the variable called
4044 name of the variable
4045 value of the variable
4046 ctx FILE pointer (as a void pointer)
4052 acl_var_write(uschar
*name
, uschar
*value
, void *ctx
)
4054 FILE *f
= (FILE *)ctx
;
4055 fprintf(f
, "-acl%c %s %d\n%s\n", name
[0], name
+1, Ustrlen(value
), value
);
projects / exim.git / blob