1 /* $Cambridge: exim/src/src/acl.c,v 1.61 2006/06/27 15:07:18 ph10 Exp $ */
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
7 /* Copyright (c) University of Cambridge 1995 - 2006 */
8 /* See the file NOTICE for conditions of use and distribution. */
10 /* Code for handling Access Control Lists (ACLs) */
15 /* Default callout timeout */
17 #define CALLOUT_TIMEOUT_DEFAULT 30
19 /* ACL verb codes - keep in step with the table of verbs that follows */
21 enum { ACL_ACCEPT
, ACL_DEFER
, ACL_DENY
, ACL_DISCARD
, ACL_DROP
, ACL_REQUIRE
,
26 static uschar
*verbs
[] =
27 { US
"accept", US
"defer", US
"deny", US
"discard", US
"drop", US
"require",
30 /* For each verb, the condition for which "message" is used */
32 static int msgcond
[] = { FAIL
, OK
, OK
, FAIL
, OK
, FAIL
, OK
};
34 /* ACL condition and modifier codes - keep in step with the table that
35 follows, and the cond_expand_at_top and uschar cond_modifiers tables lower
41 #ifdef EXPERIMENTAL_BRIGHTMAIL
46 #ifdef WITH_CONTENT_SCAN
50 #ifdef WITH_OLD_DEMIME
53 #ifdef EXPERIMENTAL_DOMAINKEYS
54 ACLC_DK_DOMAIN_SOURCE
,
56 ACLC_DK_SENDER_DOMAINS
,
57 ACLC_DK_SENDER_LOCAL_PARTS
,
69 #ifdef WITH_CONTENT_SCAN
73 #ifdef WITH_CONTENT_SCAN
78 #ifdef WITH_CONTENT_SCAN
84 #ifdef WITH_CONTENT_SCAN
87 #ifdef EXPERIMENTAL_SPF
92 /* ACL conditions/modifiers: "delay", "control", "endpass", "message",
93 "log_message", "logwrite", and "set" are modifiers that look like conditions
94 but always return TRUE. They are used for their side effects. */
96 static uschar
*conditions
[] = {
100 #ifdef EXPERIMENTAL_BRIGHTMAIL
105 #ifdef WITH_CONTENT_SCAN
109 #ifdef WITH_OLD_DEMIME
112 #ifdef EXPERIMENTAL_DOMAINKEYS
113 US
"dk_domain_source",
115 US
"dk_sender_domains",
116 US
"dk_sender_local_parts",
120 US
"dnslists", US
"domains", US
"encrypted",
121 US
"endpass", US
"hosts", US
"local_parts", US
"log_message", US
"logwrite",
122 #ifdef WITH_CONTENT_SCAN
126 #ifdef WITH_CONTENT_SCAN
131 #ifdef WITH_CONTENT_SCAN
134 US
"sender_domains", US
"senders", US
"set",
135 #ifdef WITH_CONTENT_SCAN
138 #ifdef EXPERIMENTAL_SPF
144 /* Return values from decode_control(); keep in step with the table of names
148 CONTROL_AUTH_UNADVERTISED
,
149 #ifdef EXPERIMENTAL_BRIGHTMAIL
152 #ifdef EXPERIMENTAL_DOMAINKEYS
156 CONTROL_CASEFUL_LOCAL_PART
,
157 CONTROL_CASELOWER_LOCAL_PART
,
158 CONTROL_ENFORCE_SYNC
,
159 CONTROL_NO_ENFORCE_SYNC
,
163 CONTROL_SUPPRESS_LOCAL_FIXUPS
,
164 #ifdef WITH_CONTENT_SCAN
165 CONTROL_NO_MBOX_UNSPOOL
,
172 /* ACL control names; keep in step with the table above! This list is used for
173 turning ids into names. The actual list of recognized names is in the variable
174 control_def controls_list[] below. The fact that there are two lists is a mess
175 and should be tidied up. */
177 static uschar
*controls
[] = {
178 US
"allow_auth_unadvertised",
179 #ifdef EXPERIMENTAL_BRIGHTMAIL
182 #ifdef EXPERIMENTAL_DOMAINKEYS
186 US
"caseful_local_part",
187 US
"caselower_local_part",
193 US
"suppress_local_fixups",
194 #ifdef WITH_CONTENT_SCAN
200 /* Flags to indicate for which conditions /modifiers a string expansion is done
201 at the outer level. In the other cases, expansion already occurs in the
202 checking functions. */
204 static uschar cond_expand_at_top
[] = {
206 TRUE
, /* add_header */
207 FALSE
, /* authenticated */
208 #ifdef EXPERIMENTAL_BRIGHTMAIL
209 TRUE
, /* bmi_optin */
211 TRUE
, /* condition */
213 #ifdef WITH_CONTENT_SCAN
217 #ifdef WITH_OLD_DEMIME
220 #ifdef EXPERIMENTAL_DOMAINKEYS
221 TRUE
, /* dk_domain_source */
222 TRUE
, /* dk_policy */
223 TRUE
, /* dk_sender_domains */
224 TRUE
, /* dk_sender_local_parts */
225 TRUE
, /* dk_senders */
226 TRUE
, /* dk_status */
230 FALSE
, /* encrypted */
233 FALSE
, /* local_parts */
234 TRUE
, /* log_message */
236 #ifdef WITH_CONTENT_SCAN
240 #ifdef WITH_CONTENT_SCAN
241 TRUE
, /* mime_regex */
243 TRUE
, /* ratelimit */
244 FALSE
, /* recipients */
245 #ifdef WITH_CONTENT_SCAN
248 FALSE
, /* sender_domains */
251 #ifdef WITH_CONTENT_SCAN
254 #ifdef EXPERIMENTAL_SPF
260 /* Flags to identify the modifiers */
262 static uschar cond_modifiers
[] = {
264 TRUE
, /* add_header */
265 FALSE
, /* authenticated */
266 #ifdef EXPERIMENTAL_BRIGHTMAIL
267 TRUE
, /* bmi_optin */
269 FALSE
, /* condition */
271 #ifdef WITH_CONTENT_SCAN
275 #ifdef WITH_OLD_DEMIME
278 #ifdef EXPERIMENTAL_DOMAINKEYS
279 FALSE
, /* dk_domain_source */
280 FALSE
, /* dk_policy */
281 FALSE
, /* dk_sender_domains */
282 FALSE
, /* dk_sender_local_parts */
283 FALSE
, /* dk_senders */
284 FALSE
, /* dk_status */
286 FALSE
, /* dnslists */
288 FALSE
, /* encrypted */
291 FALSE
, /* local_parts */
292 TRUE
, /* log_message */
294 #ifdef WITH_CONTENT_SCAN
298 #ifdef WITH_CONTENT_SCAN
299 FALSE
, /* mime_regex */
301 FALSE
, /* ratelimit */
302 FALSE
, /* recipients */
303 #ifdef WITH_CONTENT_SCAN
306 FALSE
, /* sender_domains */
309 #ifdef WITH_CONTENT_SCAN
312 #ifdef EXPERIMENTAL_SPF
318 /* Bit map vector of which conditions are not allowed at certain times. For
319 each condition, there's a bitmap of dis-allowed times. For some, it is easier
320 to specify the negation of a small number of allowed times. */
322 static unsigned int cond_forbids
[] = {
326 ~((1<<ACL_WHERE_MAIL
)|(1<<ACL_WHERE_RCPT
)| /* add_header */
327 (1<<ACL_WHERE_PREDATA
)|(1<<ACL_WHERE_DATA
)|
328 (1<<ACL_WHERE_MIME
)|(1<<ACL_WHERE_NOTSMTP
)),
330 (1<<ACL_WHERE_NOTSMTP
)|(1<<ACL_WHERE_CONNECT
)| /* authenticated */
333 #ifdef EXPERIMENTAL_BRIGHTMAIL
334 (1<<ACL_WHERE_AUTH
)| /* bmi_optin */
335 (1<<ACL_WHERE_CONNECT
)|(1<<ACL_WHERE_HELO
)|
336 (1<<ACL_WHERE_DATA
)|(1<<ACL_WHERE_MIME
)|
337 (1<<ACL_WHERE_ETRN
)|(1<<ACL_WHERE_EXPN
)|
338 (1<<ACL_WHERE_MAILAUTH
)|
339 (1<<ACL_WHERE_MAIL
)|(1<<ACL_WHERE_STARTTLS
)|
340 (1<<ACL_WHERE_VRFY
)|(1<<ACL_WHERE_PREDATA
),
345 /* Certain types of control are always allowed, so we let it through
346 always and check in the control processing itself. */
350 #ifdef WITH_CONTENT_SCAN
352 ~(1<<ACL_WHERE_MIME
), /* decode */
357 #ifdef WITH_OLD_DEMIME
359 ~((1<<ACL_WHERE_DATA
)|(1<<ACL_WHERE_NOTSMTP
)), /* demime */
362 #ifdef EXPERIMENTAL_DOMAINKEYS
363 (1<<ACL_WHERE_AUTH
)| /* dk_domain_source */
364 (1<<ACL_WHERE_CONNECT
)|(1<<ACL_WHERE_HELO
)|
365 (1<<ACL_WHERE_RCPT
)|(1<<ACL_WHERE_PREDATA
)|
366 (1<<ACL_WHERE_ETRN
)|(1<<ACL_WHERE_EXPN
)|
367 (1<<ACL_WHERE_MAILAUTH
)|(1<<ACL_WHERE_QUIT
)|
368 (1<<ACL_WHERE_MAIL
)|(1<<ACL_WHERE_STARTTLS
)|
371 (1<<ACL_WHERE_AUTH
)| /* dk_policy */
372 (1<<ACL_WHERE_CONNECT
)|(1<<ACL_WHERE_HELO
)|
373 (1<<ACL_WHERE_RCPT
)|(1<<ACL_WHERE_PREDATA
)|
374 (1<<ACL_WHERE_ETRN
)|(1<<ACL_WHERE_EXPN
)|
375 (1<<ACL_WHERE_MAILAUTH
)|(1<<ACL_WHERE_QUIT
)|
376 (1<<ACL_WHERE_MAIL
)|(1<<ACL_WHERE_STARTTLS
)|
379 (1<<ACL_WHERE_AUTH
)| /* dk_sender_domains */
380 (1<<ACL_WHERE_CONNECT
)|(1<<ACL_WHERE_HELO
)|
381 (1<<ACL_WHERE_RCPT
)|(1<<ACL_WHERE_PREDATA
)|
382 (1<<ACL_WHERE_ETRN
)|(1<<ACL_WHERE_EXPN
)|
383 (1<<ACL_WHERE_MAILAUTH
)|(1<<ACL_WHERE_QUIT
)|
384 (1<<ACL_WHERE_MAIL
)|(1<<ACL_WHERE_STARTTLS
)|
387 (1<<ACL_WHERE_AUTH
)| /* dk_sender_local_parts */
388 (1<<ACL_WHERE_CONNECT
)|(1<<ACL_WHERE_HELO
)|
389 (1<<ACL_WHERE_RCPT
)|(1<<ACL_WHERE_PREDATA
)|
390 (1<<ACL_WHERE_ETRN
)|(1<<ACL_WHERE_EXPN
)|
391 (1<<ACL_WHERE_MAILAUTH
)|(1<<ACL_WHERE_QUIT
)|
392 (1<<ACL_WHERE_MAIL
)|(1<<ACL_WHERE_STARTTLS
)|
395 (1<<ACL_WHERE_AUTH
)| /* dk_senders */
396 (1<<ACL_WHERE_CONNECT
)|(1<<ACL_WHERE_HELO
)|
397 (1<<ACL_WHERE_RCPT
)|(1<<ACL_WHERE_PREDATA
)|
398 (1<<ACL_WHERE_ETRN
)|(1<<ACL_WHERE_EXPN
)|
399 (1<<ACL_WHERE_MAILAUTH
)|(1<<ACL_WHERE_QUIT
)|
400 (1<<ACL_WHERE_MAIL
)|(1<<ACL_WHERE_STARTTLS
)|
403 (1<<ACL_WHERE_AUTH
)| /* dk_status */
404 (1<<ACL_WHERE_CONNECT
)|(1<<ACL_WHERE_HELO
)|
405 (1<<ACL_WHERE_RCPT
)|(1<<ACL_WHERE_PREDATA
)|
406 (1<<ACL_WHERE_ETRN
)|(1<<ACL_WHERE_EXPN
)|
407 (1<<ACL_WHERE_MAILAUTH
)|(1<<ACL_WHERE_QUIT
)|
408 (1<<ACL_WHERE_MAIL
)|(1<<ACL_WHERE_STARTTLS
)|
412 (1<<ACL_WHERE_NOTSMTP
), /* dnslists */
415 ~(1<<ACL_WHERE_RCPT
), /* domains */
417 (1<<ACL_WHERE_NOTSMTP
)|(1<<ACL_WHERE_CONNECT
)| /* encrypted */
422 (1<<ACL_WHERE_NOTSMTP
), /* hosts */
425 ~(1<<ACL_WHERE_RCPT
), /* local_parts */
431 #ifdef WITH_CONTENT_SCAN
433 ~((1<<ACL_WHERE_DATA
)|(1<<ACL_WHERE_NOTSMTP
)), /* malware */
438 #ifdef WITH_CONTENT_SCAN
440 ~(1<<ACL_WHERE_MIME
), /* mime_regex */
446 ~(1<<ACL_WHERE_RCPT
), /* recipients */
448 #ifdef WITH_CONTENT_SCAN
450 ~((1<<ACL_WHERE_DATA
)|(1<<ACL_WHERE_NOTSMTP
)| /* regex */
451 (1<<ACL_WHERE_MIME
)),
454 (1<<ACL_WHERE_AUTH
)|(1<<ACL_WHERE_CONNECT
)| /* sender_domains */
456 (1<<ACL_WHERE_MAILAUTH
)|(1<<ACL_WHERE_QUIT
)|
457 (1<<ACL_WHERE_ETRN
)|(1<<ACL_WHERE_EXPN
)|
458 (1<<ACL_WHERE_STARTTLS
)|(1<<ACL_WHERE_VRFY
),
460 (1<<ACL_WHERE_AUTH
)|(1<<ACL_WHERE_CONNECT
)| /* senders */
462 (1<<ACL_WHERE_MAILAUTH
)|(1<<ACL_WHERE_QUIT
)|
463 (1<<ACL_WHERE_ETRN
)|(1<<ACL_WHERE_EXPN
)|
464 (1<<ACL_WHERE_STARTTLS
)|(1<<ACL_WHERE_VRFY
),
468 #ifdef WITH_CONTENT_SCAN
470 ~((1<<ACL_WHERE_DATA
)|(1<<ACL_WHERE_NOTSMTP
)), /* spam */
473 #ifdef EXPERIMENTAL_SPF
474 (1<<ACL_WHERE_AUTH
)|(1<<ACL_WHERE_CONNECT
)| /* spf */
476 (1<<ACL_WHERE_MAILAUTH
)|
477 (1<<ACL_WHERE_ETRN
)|(1<<ACL_WHERE_EXPN
)|
478 (1<<ACL_WHERE_STARTTLS
)|(1<<ACL_WHERE_VRFY
),
481 /* Certain types of verify are always allowed, so we let it through
482 always and check in the verify function itself */
488 /* Bit map vector of which controls are not allowed at certain times. For
489 each control, there's a bitmap of dis-allowed times. For some, it is easier to
490 specify the negation of a small number of allowed times. */
492 static unsigned int control_forbids
[] = {
494 ~((1<<ACL_WHERE_CONNECT
)|(1<<ACL_WHERE_HELO
)), /* allow_auth_unadvertised */
496 #ifdef EXPERIMENTAL_BRIGHTMAIL
500 #ifdef EXPERIMENTAL_DOMAINKEYS
501 (1<<ACL_WHERE_DATA
)|(1<<ACL_WHERE_NOTSMTP
), /* dk_verify */
507 ~(1<<ACL_WHERE_RCPT
), /* caseful_local_part */
510 ~(1<<ACL_WHERE_RCPT
), /* caselower_local_part */
512 (1<<ACL_WHERE_NOTSMTP
), /* enforce_sync */
514 (1<<ACL_WHERE_NOTSMTP
), /* no_enforce_sync */
517 ~((1<<ACL_WHERE_MAIL
)|(1<<ACL_WHERE_RCPT
)| /* freeze */
518 (1<<ACL_WHERE_PREDATA
)|(1<<ACL_WHERE_DATA
)|
519 (1<<ACL_WHERE_NOTSMTP
)|(1<<ACL_WHERE_MIME
)),
522 ~((1<<ACL_WHERE_MAIL
)|(1<<ACL_WHERE_RCPT
)| /* queue_only */
523 (1<<ACL_WHERE_PREDATA
)|(1<<ACL_WHERE_DATA
)|
524 (1<<ACL_WHERE_NOTSMTP
)|(1<<ACL_WHERE_MIME
)),
527 ~((1<<ACL_WHERE_MAIL
)|(1<<ACL_WHERE_RCPT
)| /* submission */
528 (1<<ACL_WHERE_PREDATA
)),
531 ~((1<<ACL_WHERE_MAIL
)|(1<<ACL_WHERE_RCPT
)| /* suppress_local_fixups */
532 (1<<ACL_WHERE_NOTSMTP
)|(1<<ACL_WHERE_PREDATA
)),
534 #ifdef WITH_CONTENT_SCAN
536 ~((1<<ACL_WHERE_MAIL
)|(1<<ACL_WHERE_RCPT
)| /* no_mbox_unspool */
537 (1<<ACL_WHERE_PREDATA
)|(1<<ACL_WHERE_DATA
)|
538 (1<<ACL_WHERE_MIME
)),
542 ~((1<<ACL_WHERE_MAIL
)|(1<<ACL_WHERE_RCPT
)| /* fakedefer */
543 (1<<ACL_WHERE_PREDATA
)|(1<<ACL_WHERE_DATA
)|
544 (1<<ACL_WHERE_MIME
)),
547 ~((1<<ACL_WHERE_MAIL
)|(1<<ACL_WHERE_RCPT
)| /* fakereject */
548 (1<<ACL_WHERE_PREDATA
)|(1<<ACL_WHERE_DATA
)|
549 (1<<ACL_WHERE_MIME
)),
551 (1<<ACL_WHERE_NOTSMTP
) /* no_multiline */
554 /* Structure listing various control arguments, with their characteristics. */
556 typedef struct control_def
{
558 int value
; /* CONTROL_xxx value */
559 BOOL has_option
; /* Has /option(s) following */
562 static control_def controls_list
[] = {
563 { US
"allow_auth_unadvertised", CONTROL_AUTH_UNADVERTISED
, FALSE
},
564 #ifdef EXPERIMENTAL_BRIGHTMAIL
565 { US
"bmi_run", CONTROL_BMI_RUN
, FALSE
},
567 #ifdef EXPERIMENTAL_DOMAINKEYS
568 { US
"dk_verify", CONTROL_DK_VERIFY
, FALSE
},
570 { US
"caseful_local_part", CONTROL_CASEFUL_LOCAL_PART
, FALSE
},
571 { US
"caselower_local_part", CONTROL_CASELOWER_LOCAL_PART
, FALSE
},
572 { US
"enforce_sync", CONTROL_ENFORCE_SYNC
, FALSE
},
573 { US
"freeze", CONTROL_FREEZE
, TRUE
},
574 { US
"no_enforce_sync", CONTROL_NO_ENFORCE_SYNC
, FALSE
},
575 { US
"no_multiline_responses", CONTROL_NO_MULTILINE
, FALSE
},
576 { US
"queue_only", CONTROL_QUEUE_ONLY
, FALSE
},
577 #ifdef WITH_CONTENT_SCAN
578 { US
"no_mbox_unspool", CONTROL_NO_MBOX_UNSPOOL
, FALSE
},
580 { US
"fakedefer", CONTROL_FAKEDEFER
, TRUE
},
581 { US
"fakereject", CONTROL_FAKEREJECT
, TRUE
},
582 { US
"submission", CONTROL_SUBMISSION
, TRUE
},
583 { US
"suppress_local_fixups", CONTROL_SUPPRESS_LOCAL_FIXUPS
, FALSE
}
586 /* Support data structures for Client SMTP Authorization. acl_verify_csa()
587 caches its result in a tree to avoid repeated DNS queries. The result is an
588 integer code which is used as an index into the following tables of
589 explanatory strings and verification return codes. */
591 static tree_node
*csa_cache
= NULL
;
593 enum { CSA_UNKNOWN
, CSA_OK
, CSA_DEFER_SRV
, CSA_DEFER_ADDR
,
594 CSA_FAIL_EXPLICIT
, CSA_FAIL_DOMAIN
, CSA_FAIL_NOADDR
, CSA_FAIL_MISMATCH
};
596 /* The acl_verify_csa() return code is translated into an acl_verify() return
597 code using the following table. It is OK unless the client is definitely not
598 authorized. This is because CSA is supposed to be optional for sending sites,
599 so recipients should not be too strict about checking it - especially because
600 DNS problems are quite likely to occur. It's possible to use $csa_status in
601 further ACL conditions to distinguish ok, unknown, and defer if required, but
602 the aim is to make the usual configuration simple. */
604 static int csa_return_code
[] = {
606 FAIL
, FAIL
, FAIL
, FAIL
609 static uschar
*csa_status_string
[] = {
610 US
"unknown", US
"ok", US
"defer", US
"defer",
611 US
"fail", US
"fail", US
"fail", US
"fail"
614 static uschar
*csa_reason_string
[] = {
617 US
"deferred (SRV lookup failed)",
618 US
"deferred (target address lookup failed)",
619 US
"failed (explicit authorization required)",
620 US
"failed (host name not authorized)",
621 US
"failed (no authorized addresses)",
622 US
"failed (client address mismatch)"
625 /* Enable recursion between acl_check_internal() and acl_check_condition() */
627 static int acl_check_internal(int, address_item
*, uschar
*, int, uschar
**,
631 /*************************************************
632 * Pick out name from list *
633 *************************************************/
635 /* Use a binary chop method
642 Returns: offset in list, or -1 if not found
646 acl_checkname(uschar
*name
, uschar
**list
, int end
)
652 int mid
= (start
+ end
)/2;
653 int c
= Ustrcmp(name
, list
[mid
]);
654 if (c
== 0) return mid
;
655 if (c
< 0) end
= mid
; else start
= mid
+ 1;
662 /*************************************************
663 * Read and parse one ACL *
664 *************************************************/
666 /* This function is called both from readconf in order to parse the ACLs in the
667 configuration file, and also when an ACL is encountered dynamically (e.g. as
668 the result of an expansion). It is given a function to call in order to
669 retrieve the lines of the ACL. This function handles skipping comments and
670 blank lines (where relevant).
673 func function to get next line of ACL
674 error where to put an error message
676 Returns: pointer to ACL, or NULL
677 NULL can be legal (empty ACL); in this case error will be NULL
681 acl_read(uschar
*(*func
)(void), uschar
**error
)
683 acl_block
*yield
= NULL
;
684 acl_block
**lastp
= &yield
;
685 acl_block
*this = NULL
;
686 acl_condition_block
*cond
;
687 acl_condition_block
**condp
= NULL
;
692 while ((s
= (*func
)()) != NULL
)
695 BOOL negated
= FALSE
;
696 uschar
*saveline
= s
;
699 /* Conditions (but not verbs) are allowed to be negated by an initial
702 while (isspace(*s
)) s
++;
709 /* Read the name of a verb or a condition, or the start of a new ACL, which
710 can be started by a name, or by a macro definition. */
712 s
= readconf_readname(name
, sizeof(name
), s
);
713 if (*s
== ':' || (isupper(name
[0]) && *s
== '=')) return yield
;
715 /* If a verb is unrecognized, it may be another condition or modifier that
716 continues the previous verb. */
718 v
= acl_checkname(name
, verbs
, sizeof(verbs
)/sizeof(char *));
723 *error
= string_sprintf("unknown ACL verb \"%s\" in \"%s\"", name
,
735 *error
= string_sprintf("malformed ACL line \"%s\"", saveline
);
738 this = store_get(sizeof(acl_block
));
740 lastp
= &(this->next
);
743 this->condition
= NULL
;
744 condp
= &(this->condition
);
745 if (*s
== 0) continue; /* No condition on this line */
751 s
= readconf_readname(name
, sizeof(name
), s
); /* Condition name */
754 /* Handle a condition or modifier. */
756 c
= acl_checkname(name
, conditions
, sizeof(conditions
)/sizeof(char *));
759 *error
= string_sprintf("unknown ACL condition/modifier in \"%s\"",
764 /* The modifiers may not be negated */
766 if (negated
&& cond_modifiers
[c
])
768 *error
= string_sprintf("ACL error: negation is not allowed with "
769 "\"%s\"", conditions
[c
]);
773 /* ENDPASS may occur only with ACCEPT or DISCARD. */
775 if (c
== ACLC_ENDPASS
&&
776 this->verb
!= ACL_ACCEPT
&&
777 this->verb
!= ACL_DISCARD
)
779 *error
= string_sprintf("ACL error: \"%s\" is not allowed with \"%s\"",
780 conditions
[c
], verbs
[this->verb
]);
784 cond
= store_get(sizeof(acl_condition_block
));
787 cond
->u
.negated
= negated
;
790 condp
= &(cond
->next
);
792 /* The "set" modifier is different in that its argument is "name=value"
793 rather than just a value, and we can check the validity of the name, which
794 gives us a variable number to insert into the data block. */
801 if (Ustrncmp(s
, "acl_", 4) != 0) goto BAD_ACL_VAR
;
807 else if (s
[4] == 'm')
812 else goto BAD_ACL_VAR
;
814 n
= Ustrtoul(s
+ 5, &endptr
, 10);
815 if ((*endptr
!= 0 && *endptr
!= '=' && !isspace(*endptr
)) || n
>= max
)
818 *error
= string_sprintf("syntax error or unrecognized name after "
819 "\"set\" in ACL modifier \"set %s\"", s
);
823 cond
->u
.varnumber
= n
+ offset
;
825 while (isspace(*s
)) s
++;
828 /* For "set", we are now positioned for the data. For the others, only
829 "endpass" has no data */
831 if (c
!= ACLC_ENDPASS
)
835 *error
= string_sprintf("\"=\" missing after ACL \"%s\" %s", name
,
836 cond_modifiers
[c
]? US
"modifier" : US
"condition");
839 while (isspace(*s
)) s
++;
840 cond
->arg
= string_copy(s
);
849 /*************************************************
850 * Set up added header line(s) *
851 *************************************************/
853 /* This function is called by the add_header modifier, and also from acl_warn()
854 to implement the now-deprecated way of adding header lines using "message" on a
855 "warn" verb. The argument is treated as a sequence of header lines which are
856 added to a chain, provided there isn't an identical one already there.
858 Argument: string of header lines
863 setup_header(uschar
*hstring
)
866 int hlen
= Ustrlen(hstring
);
868 /* An empty string does nothing; otherwise add a final newline if necessary. */
870 if (hlen
<= 0) return;
871 if (hstring
[hlen
-1] != '\n') hstring
= string_sprintf("%s\n", hstring
);
873 /* Loop for multiple header lines, taking care about continuations */
875 for (p
= q
= hstring
; *p
!= 0; )
878 int newtype
= htype_add_bot
;
879 header_line
**hptr
= &acl_added_headers
;
881 /* Find next header line within the string */
885 q
= Ustrchr(q
, '\n');
886 if (*(++q
) != ' ' && *q
!= '\t') break;
889 /* If the line starts with a colon, interpret the instruction for where to
890 add it. This temporarily sets up a new type. */
894 if (strncmpic(p
, US
":after_received:", 16) == 0)
896 newtype
= htype_add_rec
;
899 else if (strncmpic(p
, US
":at_start_rfc:", 14) == 0)
901 newtype
= htype_add_rfc
;
904 else if (strncmpic(p
, US
":at_start:", 10) == 0)
906 newtype
= htype_add_top
;
909 else if (strncmpic(p
, US
":at_end:", 8) == 0)
911 newtype
= htype_add_bot
;
914 while (*p
== ' ' || *p
== '\t') p
++;
917 /* See if this line starts with a header name, and if not, add X-ACL-Warn:
918 to the front of it. */
920 for (s
= p
; s
< q
- 1; s
++)
922 if (*s
== ':' || !isgraph(*s
)) break;
925 s
= string_sprintf("%s%.*s", (*s
== ':')? "" : "X-ACL-Warn: ", q
- p
, p
);
928 /* See if this line has already been added */
930 while (*hptr
!= NULL
)
932 if (Ustrncmp((*hptr
)->text
, s
, hlen
) == 0) break;
933 hptr
= &((*hptr
)->next
);
936 /* Add if not previously present */
940 header_line
*h
= store_get(sizeof(header_line
));
949 /* Advance for next header line within the string */
958 /*************************************************
960 *************************************************/
962 /* This function is called when a WARN verb's conditions are true. It adds to
963 the message's headers, and/or writes information to the log. In each case, this
964 only happens once (per message for headers, per connection for log).
966 ** NOTE: The header adding action using the "message" setting is historic, and
967 its use is now deprecated. The new add_header modifier should be used instead.
970 where ACL_WHERE_xxxx indicating which ACL this is
971 user_message message for adding to headers
972 log_message message for logging, if different
978 acl_warn(int where
, uschar
*user_message
, uschar
*log_message
)
980 if (log_message
!= NULL
&& log_message
!= user_message
)
985 text
= string_sprintf("%s Warning: %s", host_and_ident(TRUE
),
986 string_printing(log_message
));
988 /* If a sender verification has failed, and the log message is "sender verify
989 failed", add the failure message. */
991 if (sender_verified_failed
!= NULL
&&
992 sender_verified_failed
->message
!= NULL
&&
993 strcmpic(log_message
, US
"sender verify failed") == 0)
994 text
= string_sprintf("%s: %s", text
, sender_verified_failed
->message
);
996 /* Search previously logged warnings. They are kept in malloc
997 store so they can be freed at the start of a new message. */
999 for (logged
= acl_warn_logged
; logged
!= NULL
; logged
= logged
->next
)
1000 if (Ustrcmp(logged
->text
, text
) == 0) break;
1004 int length
= Ustrlen(text
) + 1;
1005 log_write(0, LOG_MAIN
, "%s", text
);
1006 logged
= store_malloc(sizeof(string_item
) + length
);
1007 logged
->text
= (uschar
*)logged
+ sizeof(string_item
);
1008 memcpy(logged
->text
, text
, length
);
1009 logged
->next
= acl_warn_logged
;
1010 acl_warn_logged
= logged
;
1014 /* If there's no user message, we are done. */
1016 if (user_message
== NULL
) return;
1018 /* If this isn't a message ACL, we can't do anything with a user message.
1021 if (where
> ACL_WHERE_NOTSMTP
)
1023 log_write(0, LOG_MAIN
|LOG_PANIC
, "ACL \"warn\" with \"message\" setting "
1024 "found in a non-message (%s) ACL: cannot specify header lines here: "
1025 "message ignored", acl_wherenames
[where
]);
1029 /* The code for setting up header lines is now abstracted into a separate
1030 function so that it can be used for the add_header modifier as well. */
1032 setup_header(user_message
);
1037 /*************************************************
1038 * Verify and check reverse DNS *
1039 *************************************************/
1041 /* Called from acl_verify() below. We look up the host name(s) of the client IP
1042 address if this has not yet been done. The host_name_lookup() function checks
1043 that one of these names resolves to an address list that contains the client IP
1044 address, so we don't actually have to do the check here.
1047 user_msgptr pointer for user message
1048 log_msgptr pointer for log message
1050 Returns: OK verification condition succeeded
1051 FAIL verification failed
1052 DEFER there was a problem verifying
1056 acl_verify_reverse(uschar
**user_msgptr
, uschar
**log_msgptr
)
1060 user_msgptr
= user_msgptr
; /* stop compiler warning */
1062 /* Previous success */
1064 if (sender_host_name
!= NULL
) return OK
;
1066 /* Previous failure */
1068 if (host_lookup_failed
)
1070 *log_msgptr
= string_sprintf("host lookup failed%s", host_lookup_msg
);
1074 /* Need to do a lookup */
1077 debug_printf("looking up host name to force name/address consistency check\n");
1079 if ((rc
= host_name_lookup()) != OK
)
1081 *log_msgptr
= (rc
== DEFER
)?
1082 US
"host lookup deferred for reverse lookup check"
1084 string_sprintf("host lookup failed for reverse lookup check%s",
1086 return rc
; /* DEFER or FAIL */
1089 host_build_sender_fullhost();
1095 /*************************************************
1096 * Check client IP address matches CSA target *
1097 *************************************************/
1099 /* Called from acl_verify_csa() below. This routine scans a section of a DNS
1100 response for address records belonging to the CSA target hostname. The section
1101 is specified by the reset argument, either RESET_ADDITIONAL or RESET_ANSWERS.
1102 If one of the addresses matches the client's IP address, then the client is
1103 authorized by CSA. If there are target IP addresses but none of them match
1104 then the client is using an unauthorized IP address. If there are no target IP
1105 addresses then the client cannot be using an authorized IP address. (This is
1106 an odd configuration - why didn't the SRV record have a weight of 1 instead?)
1109 dnsa the DNS answer block
1110 dnss a DNS scan block for us to use
1111 reset option specifing what portion to scan, as described above
1112 target the target hostname to use for matching RR names
1114 Returns: CSA_OK successfully authorized
1115 CSA_FAIL_MISMATCH addresses found but none matched
1116 CSA_FAIL_NOADDR no target addresses found
1120 acl_verify_csa_address(dns_answer
*dnsa
, dns_scan
*dnss
, int reset
,
1126 BOOL target_found
= FALSE
;
1128 for (rr
= dns_next_rr(dnsa
, dnss
, reset
);
1130 rr
= dns_next_rr(dnsa
, dnss
, RESET_NEXT
))
1132 /* Check this is an address RR for the target hostname. */
1136 && rr
->type
!= T_AAAA
1143 if (strcmpic(target
, rr
->name
) != 0) continue;
1145 target_found
= TRUE
;
1147 /* Turn the target address RR into a list of textual IP addresses and scan
1148 the list. There may be more than one if it is an A6 RR. */
1150 for (da
= dns_address_from_rr(dnsa
, rr
); da
!= NULL
; da
= da
->next
)
1152 /* If the client IP address matches the target IP address, it's good! */
1154 DEBUG(D_acl
) debug_printf("CSA target address is %s\n", da
->address
);
1156 if (strcmpic(sender_host_address
, da
->address
) == 0) return CSA_OK
;
1160 /* If we found some target addresses but none of them matched, the client is
1161 using an unauthorized IP address, otherwise the target has no authorized IP
1164 if (target_found
) return CSA_FAIL_MISMATCH
;
1165 else return CSA_FAIL_NOADDR
;
1170 /*************************************************
1171 * Verify Client SMTP Authorization *
1172 *************************************************/
1174 /* Called from acl_verify() below. This routine calls dns_lookup_special()
1175 to find the CSA SRV record corresponding to the domain argument, or
1176 $sender_helo_name if no argument is provided. It then checks that the
1177 client is authorized, and that its IP address corresponds to the SRV
1178 target's address by calling acl_verify_csa_address() above. The address
1179 should have been returned in the DNS response's ADDITIONAL section, but if
1180 not we perform another DNS lookup to get it.
1183 domain pointer to optional parameter following verify = csa
1185 Returns: CSA_UNKNOWN no valid CSA record found
1186 CSA_OK successfully authorized
1187 CSA_FAIL_* client is definitely not authorized
1188 CSA_DEFER_* there was a DNS problem
1192 acl_verify_csa(uschar
*domain
)
1196 int priority
, weight
, port
;
1203 /* Work out the domain we are using for the CSA lookup. The default is the
1204 client's HELO domain. If the client has not said HELO, use its IP address
1205 instead. If it's a local client (exim -bs), CSA isn't applicable. */
1207 while (isspace(*domain
) && *domain
!= '\0') ++domain
;
1208 if (*domain
== '\0') domain
= sender_helo_name
;
1209 if (domain
== NULL
) domain
= sender_host_address
;
1210 if (sender_host_address
== NULL
) return CSA_UNKNOWN
;
1212 /* If we have an address literal, strip off the framing ready for turning it
1213 into a domain. The framing consists of matched square brackets possibly
1214 containing a keyword and a colon before the actual IP address. */
1216 if (domain
[0] == '[')
1218 uschar
*start
= Ustrchr(domain
, ':');
1219 if (start
== NULL
) start
= domain
;
1220 domain
= string_copyn(start
+ 1, Ustrlen(start
) - 2);
1223 /* Turn domains that look like bare IP addresses into domains in the reverse
1224 DNS. This code also deals with address literals and $sender_host_address. It's
1225 not quite kosher to treat bare domains such as EHLO 192.0.2.57 the same as
1226 address literals, but it's probably the most friendly thing to do. This is an
1227 extension to CSA, so we allow it to be turned off for proper conformance. */
1229 if (string_is_ip_address(domain
, NULL
) != 0)
1231 if (!dns_csa_use_reverse
) return CSA_UNKNOWN
;
1232 dns_build_reverse(domain
, target
);
1236 /* Find out if we've already done the CSA check for this domain. If we have,
1237 return the same result again. Otherwise build a new cached result structure
1238 for this domain. The name is filled in now, and the value is filled in when
1239 we return from this function. */
1241 t
= tree_search(csa_cache
, domain
);
1242 if (t
!= NULL
) return t
->data
.val
;
1244 t
= store_get_perm(sizeof(tree_node
) + Ustrlen(domain
));
1245 Ustrcpy(t
->name
, domain
);
1246 (void)tree_insertnode(&csa_cache
, t
);
1248 /* Now we are ready to do the actual DNS lookup(s). */
1251 switch (dns_special_lookup(&dnsa
, domain
, T_CSA
, &found
))
1253 /* If something bad happened (most commonly DNS_AGAIN), defer. */
1256 return t
->data
.val
= CSA_DEFER_SRV
;
1258 /* If we found nothing, the client's authorization is unknown. */
1262 return t
->data
.val
= CSA_UNKNOWN
;
1264 /* We got something! Go on to look at the reply in more detail. */
1270 /* Scan the reply for well-formed CSA SRV records. */
1272 for (rr
= dns_next_rr(&dnsa
, &dnss
, RESET_ANSWERS
);
1274 rr
= dns_next_rr(&dnsa
, &dnss
, RESET_NEXT
))
1276 if (rr
->type
!= T_SRV
) continue;
1278 /* Extract the numerical SRV fields (p is incremented) */
1281 GETSHORT(priority
, p
);
1282 GETSHORT(weight
, p
);
1286 debug_printf("CSA priority=%d weight=%d port=%d\n", priority
, weight
, port
);
1288 /* Check the CSA version number */
1290 if (priority
!= 1) continue;
1292 /* If the domain does not have a CSA SRV record of its own (i.e. the domain
1293 found by dns_special_lookup() is a parent of the one we asked for), we check
1294 the subdomain assertions in the port field. At the moment there's only one
1295 assertion: legitimate SMTP clients are all explicitly authorized with CSA
1296 SRV records of their own. */
1298 if (found
!= domain
)
1301 return t
->data
.val
= CSA_FAIL_EXPLICIT
;
1303 return t
->data
.val
= CSA_UNKNOWN
;
1306 /* This CSA SRV record refers directly to our domain, so we check the value
1307 in the weight field to work out the domain's authorization. 0 and 1 are
1308 unauthorized; 3 means the client is authorized but we can't check the IP
1309 address in order to authenticate it, so we treat it as unknown; values
1310 greater than 3 are undefined. */
1312 if (weight
< 2) return t
->data
.val
= CSA_FAIL_DOMAIN
;
1314 if (weight
> 2) continue;
1316 /* Weight == 2, which means the domain is authorized. We must check that the
1317 client's IP address is listed as one of the SRV target addresses. Save the
1318 target hostname then break to scan the additional data for its addresses. */
1320 (void)dn_expand(dnsa
.answer
, dnsa
.answer
+ dnsa
.answerlen
, p
,
1321 (DN_EXPAND_ARG4_TYPE
)target
, sizeof(target
));
1323 DEBUG(D_acl
) debug_printf("CSA target is %s\n", target
);
1328 /* If we didn't break the loop then no appropriate records were found. */
1330 if (rr
== NULL
) return t
->data
.val
= CSA_UNKNOWN
;
1332 /* Do not check addresses if the target is ".", in accordance with RFC 2782.
1333 A target of "." indicates there are no valid addresses, so the client cannot
1334 be authorized. (This is an odd configuration because weight=2 target=. is
1335 equivalent to weight=1, but we check for it in order to keep load off the
1336 root name servers.) Note that dn_expand() turns "." into "". */
1338 if (Ustrcmp(target
, "") == 0) return t
->data
.val
= CSA_FAIL_NOADDR
;
1340 /* Scan the additional section of the CSA SRV reply for addresses belonging
1341 to the target. If the name server didn't return any additional data (e.g.
1342 because it does not fully support SRV records), we need to do another lookup
1343 to obtain the target addresses; otherwise we have a definitive result. */
1345 rc
= acl_verify_csa_address(&dnsa
, &dnss
, RESET_ADDITIONAL
, target
);
1346 if (rc
!= CSA_FAIL_NOADDR
) return t
->data
.val
= rc
;
1348 /* The DNS lookup type corresponds to the IP version used by the client. */
1351 if (Ustrchr(sender_host_address
, ':') != NULL
)
1354 #endif /* HAVE_IPV6 */
1358 #if HAVE_IPV6 && defined(SUPPORT_A6)
1362 switch (dns_lookup(&dnsa
, target
, type
, NULL
))
1364 /* If something bad happened (most commonly DNS_AGAIN), defer. */
1367 return t
->data
.val
= CSA_DEFER_ADDR
;
1369 /* If the query succeeded, scan the addresses and return the result. */
1372 rc
= acl_verify_csa_address(&dnsa
, &dnss
, RESET_ANSWERS
, target
);
1373 if (rc
!= CSA_FAIL_NOADDR
) return t
->data
.val
= rc
;
1374 /* else fall through */
1376 /* If the target has no IP addresses, the client cannot have an authorized
1377 IP address. However, if the target site uses A6 records (not AAAA records)
1378 we have to do yet another lookup in order to check them. */
1383 #if HAVE_IPV6 && defined(SUPPORT_A6)
1384 if (type
== T_AAAA
) { type
= T_A6
; goto DNS_LOOKUP_AGAIN
; }
1387 return t
->data
.val
= CSA_FAIL_NOADDR
;
1393 /*************************************************
1394 * Handle verification (address & other) *
1395 *************************************************/
1397 /* This function implements the "verify" condition. It is called when
1398 encountered in any ACL, because some tests are almost always permitted. Some
1399 just don't make sense, and always fail (for example, an attempt to test a host
1400 lookup for a non-TCP/IP message). Others are restricted to certain ACLs.
1403 where where called from
1404 addr the recipient address that the ACL is handling, or NULL
1405 arg the argument of "verify"
1406 user_msgptr pointer for user message
1407 log_msgptr pointer for log message
1408 basic_errno where to put verify errno
1410 Returns: OK verification condition succeeded
1411 FAIL verification failed
1412 DEFER there was a problem verifying
1417 acl_verify(int where
, address_item
*addr
, uschar
*arg
,
1418 uschar
**user_msgptr
, uschar
**log_msgptr
, int *basic_errno
)
1422 int callout_overall
= -1;
1423 int callout_connect
= -1;
1424 int verify_options
= 0;
1426 BOOL verify_header_sender
= FALSE
;
1427 BOOL defer_ok
= FALSE
;
1428 BOOL callout_defer_ok
= FALSE
;
1429 BOOL no_details
= FALSE
;
1430 BOOL success_on_redirect
= FALSE
;
1431 address_item
*sender_vaddr
= NULL
;
1432 uschar
*verify_sender_address
= NULL
;
1433 uschar
*pm_mailfrom
= NULL
;
1434 uschar
*se_mailfrom
= NULL
;
1436 /* Some of the verify items have slash-separated options; some do not. Diagnose
1437 an error if options are given for items that don't expect them. This code has
1438 now got very message. Refactoring to use a table would be a good idea one day.
1441 uschar
*slash
= Ustrchr(arg
, '/');
1443 uschar
*ss
= string_nextinlist(&list
, &sep
, big_buffer
, big_buffer_size
);
1445 if (ss
== NULL
) goto BAD_VERIFY
;
1447 /* Handle name/address consistency verification in a separate function. */
1449 if (strcmpic(ss
, US
"reverse_host_lookup") == 0)
1451 if (slash
!= NULL
) goto NO_OPTIONS
;
1452 if (sender_host_address
== NULL
) return OK
;
1453 return acl_verify_reverse(user_msgptr
, log_msgptr
);
1456 /* TLS certificate verification is done at STARTTLS time; here we just
1457 test whether it was successful or not. (This is for optional verification; for
1458 mandatory verification, the connection doesn't last this long.) */
1460 if (strcmpic(ss
, US
"certificate") == 0)
1462 if (slash
!= NULL
) goto NO_OPTIONS
;
1463 if (tls_certificate_verified
) return OK
;
1464 *user_msgptr
= US
"no verified certificate";
1468 /* We can test the result of optional HELO verification that might have
1469 occurred earlier. If not, we can attempt the verification now. */
1471 if (strcmpic(ss
, US
"helo") == 0)
1473 if (slash
!= NULL
) goto NO_OPTIONS
;
1474 if (!helo_verified
&& !helo_verify_failed
) smtp_verify_helo();
1475 return helo_verified
? OK
: FAIL
;
1478 /* Do Client SMTP Authorization checks in a separate function, and turn the
1479 result code into user-friendly strings. */
1481 if (strcmpic(ss
, US
"csa") == 0)
1483 rc
= acl_verify_csa(list
);
1484 *log_msgptr
= *user_msgptr
= string_sprintf("client SMTP authorization %s",
1485 csa_reason_string
[rc
]);
1486 csa_status
= csa_status_string
[rc
];
1487 DEBUG(D_acl
) debug_printf("CSA result %s\n", csa_status
);
1488 return csa_return_code
[rc
];
1491 /* Check that all relevant header lines have the correct syntax. If there is
1492 a syntax error, we return details of the error to the sender if configured to
1493 send out full details. (But a "message" setting on the ACL can override, as
1496 if (strcmpic(ss
, US
"header_syntax") == 0)
1498 if (slash
!= NULL
) goto NO_OPTIONS
;
1499 if (where
!= ACL_WHERE_DATA
&& where
!= ACL_WHERE_NOTSMTP
) goto WRONG_ACL
;
1500 rc
= verify_check_headers(log_msgptr
);
1501 if (rc
!= OK
&& smtp_return_error_details
&& *log_msgptr
!= NULL
)
1502 *user_msgptr
= string_sprintf("Rejected after DATA: %s", *log_msgptr
);
1506 /* Check that no recipient of this message is "blind", that is, every envelope
1507 recipient must be mentioned in either To: or Cc:. */
1509 if (strcmpic(ss
, US
"not_blind") == 0)
1511 if (slash
!= NULL
) goto NO_OPTIONS
;
1512 if (where
!= ACL_WHERE_DATA
&& where
!= ACL_WHERE_NOTSMTP
) goto WRONG_ACL
;
1513 rc
= verify_check_notblind();
1516 *log_msgptr
= string_sprintf("bcc recipient detected");
1517 if (smtp_return_error_details
)
1518 *user_msgptr
= string_sprintf("Rejected after DATA: %s", *log_msgptr
);
1523 /* The remaining verification tests check recipient and sender addresses,
1524 either from the envelope or from the header. There are a number of
1525 slash-separated options that are common to all of them. */
1528 /* Check that there is at least one verifiable sender address in the relevant
1529 header lines. This can be followed by callout and defer options, just like
1530 sender and recipient. */
1532 if (strcmpic(ss
, US
"header_sender") == 0)
1534 if (where
!= ACL_WHERE_DATA
&& where
!= ACL_WHERE_NOTSMTP
) goto WRONG_ACL
;
1535 verify_header_sender
= TRUE
;
1538 /* Otherwise, first item in verify argument must be "sender" or "recipient".
1539 In the case of a sender, this can optionally be followed by an address to use
1540 in place of the actual sender (rare special-case requirement). */
1542 else if (strncmpic(ss
, US
"sender", 6) == 0)
1545 if (where
> ACL_WHERE_NOTSMTP
)
1547 *log_msgptr
= string_sprintf("cannot verify sender in ACL for %s "
1548 "(only possible for MAIL, RCPT, PREDATA, or DATA)",
1549 acl_wherenames
[where
]);
1553 verify_sender_address
= sender_address
;
1556 while (isspace(*s
)) s
++;
1557 if (*s
++ != '=') goto BAD_VERIFY
;
1558 while (isspace(*s
)) s
++;
1559 verify_sender_address
= string_copy(s
);
1564 if (strcmpic(ss
, US
"recipient") != 0) goto BAD_VERIFY
;
1567 *log_msgptr
= string_sprintf("cannot verify recipient in ACL for %s "
1568 "(only possible for RCPT)", acl_wherenames
[where
]);
1573 /* Remaining items are optional; they apply to sender and recipient
1574 verification, including "header sender" verification. */
1576 while ((ss
= string_nextinlist(&list
, &sep
, big_buffer
, big_buffer_size
))
1579 if (strcmpic(ss
, US
"defer_ok") == 0) defer_ok
= TRUE
;
1580 else if (strcmpic(ss
, US
"no_details") == 0) no_details
= TRUE
;
1581 else if (strcmpic(ss
, US
"success_on_redirect") == 0) success_on_redirect
= TRUE
;
1583 /* These two old options are left for backwards compatibility */
1585 else if (strcmpic(ss
, US
"callout_defer_ok") == 0)
1587 callout_defer_ok
= TRUE
;
1588 if (callout
== -1) callout
= CALLOUT_TIMEOUT_DEFAULT
;
1591 else if (strcmpic(ss
, US
"check_postmaster") == 0)
1594 if (callout
== -1) callout
= CALLOUT_TIMEOUT_DEFAULT
;
1597 /* The callout option has a number of sub-options, comma separated */
1599 else if (strncmpic(ss
, US
"callout", 7) == 0)
1601 callout
= CALLOUT_TIMEOUT_DEFAULT
;
1605 while (isspace(*ss
)) ss
++;
1611 while (isspace(*ss
)) ss
++;
1613 /* This callout option handling code has become a mess as new options
1614 have been added in an ad hoc manner. It should be tidied up into some
1615 kind of table-driven thing. */
1617 while ((opt
= string_nextinlist(&ss
, &optsep
, buffer
, sizeof(buffer
)))
1620 if (strcmpic(opt
, US
"defer_ok") == 0) callout_defer_ok
= TRUE
;
1621 else if (strcmpic(opt
, US
"no_cache") == 0)
1622 verify_options
|= vopt_callout_no_cache
;
1623 else if (strcmpic(opt
, US
"random") == 0)
1624 verify_options
|= vopt_callout_random
;
1625 else if (strcmpic(opt
, US
"use_sender") == 0)
1626 verify_options
|= vopt_callout_recipsender
;
1627 else if (strcmpic(opt
, US
"use_postmaster") == 0)
1628 verify_options
|= vopt_callout_recippmaster
;
1629 else if (strcmpic(opt
, US
"postmaster") == 0) pm_mailfrom
= US
"";
1630 else if (strcmpic(opt
, US
"fullpostmaster") == 0)
1633 verify_options
|= vopt_callout_fullpm
;
1636 else if (strncmpic(opt
, US
"mailfrom", 8) == 0)
1638 if (!verify_header_sender
)
1640 *log_msgptr
= string_sprintf("\"mailfrom\" is allowed as a "
1641 "callout option only for verify=header_sender (detected in ACL "
1642 "condition \"%s\")", arg
);
1646 while (isspace(*opt
)) opt
++;
1649 *log_msgptr
= string_sprintf("'=' expected after "
1650 "\"mailfrom\" in ACL condition \"%s\"", arg
);
1653 while (isspace(*opt
)) opt
++;
1654 se_mailfrom
= string_copy(opt
);
1657 else if (strncmpic(opt
, US
"postmaster_mailfrom", 19) == 0)
1660 while (isspace(*opt
)) opt
++;
1663 *log_msgptr
= string_sprintf("'=' expected after "
1664 "\"postmaster_mailfrom\" in ACL condition \"%s\"", arg
);
1667 while (isspace(*opt
)) opt
++;
1668 pm_mailfrom
= string_copy(opt
);
1671 else if (strncmpic(opt
, US
"maxwait", 7) == 0)
1674 while (isspace(*opt
)) opt
++;
1677 *log_msgptr
= string_sprintf("'=' expected after \"maxwait\" in "
1678 "ACL condition \"%s\"", arg
);
1681 while (isspace(*opt
)) opt
++;
1682 callout_overall
= readconf_readtime(opt
, 0, FALSE
);
1683 if (callout_overall
< 0)
1685 *log_msgptr
= string_sprintf("bad time value in ACL condition "
1686 "\"verify %s\"", arg
);
1690 else if (strncmpic(opt
, US
"connect", 7) == 0)
1693 while (isspace(*opt
)) opt
++;
1696 *log_msgptr
= string_sprintf("'=' expected after "
1697 "\"callout_overaall\" in ACL condition \"%s\"", arg
);
1700 while (isspace(*opt
)) opt
++;
1701 callout_connect
= readconf_readtime(opt
, 0, FALSE
);
1702 if (callout_connect
< 0)
1704 *log_msgptr
= string_sprintf("bad time value in ACL condition "
1705 "\"verify %s\"", arg
);
1709 else /* Plain time is callout connect/command timeout */
1711 callout
= readconf_readtime(opt
, 0, FALSE
);
1714 *log_msgptr
= string_sprintf("bad time value in ACL condition "
1715 "\"verify %s\"", arg
);
1723 *log_msgptr
= string_sprintf("'=' expected after \"callout\" in "
1724 "ACL condition \"%s\"", arg
);
1730 /* Option not recognized */
1734 *log_msgptr
= string_sprintf("unknown option \"%s\" in ACL "
1735 "condition \"verify %s\"", ss
, arg
);
1740 if ((verify_options
& (vopt_callout_recipsender
|vopt_callout_recippmaster
)) ==
1741 (vopt_callout_recipsender
|vopt_callout_recippmaster
))
1743 *log_msgptr
= US
"only one of use_sender and use_postmaster can be set "
1744 "for a recipient callout";
1748 /* Handle sender-in-header verification. Default the user message to the log
1749 message if giving out verification details. */
1751 if (verify_header_sender
)
1754 rc
= verify_check_header_address(user_msgptr
, log_msgptr
, callout
,
1755 callout_overall
, callout_connect
, se_mailfrom
, pm_mailfrom
, verify_options
,
1759 *basic_errno
= verrno
;
1760 if (smtp_return_error_details
)
1762 if (*user_msgptr
== NULL
&& *log_msgptr
!= NULL
)
1763 *user_msgptr
= string_sprintf("Rejected after DATA: %s", *log_msgptr
);
1764 if (rc
== DEFER
) acl_temp_details
= TRUE
;
1769 /* Handle a sender address. The default is to verify *the* sender address, but
1770 optionally a different address can be given, for special requirements. If the
1771 address is empty, we are dealing with a bounce message that has no sender, so
1772 we cannot do any checking. If the real sender address gets rewritten during
1773 verification (e.g. DNS widening), set the flag to stop it being rewritten again
1774 during message reception.
1776 A list of verified "sender" addresses is kept to try to avoid doing to much
1777 work repetitively when there are multiple recipients in a message and they all
1778 require sender verification. However, when callouts are involved, it gets too
1779 complicated because different recipients may require different callout options.
1780 Therefore, we always do a full sender verify when any kind of callout is
1781 specified. Caching elsewhere, for instance in the DNS resolver and in the
1782 callout handling, should ensure that this is not terribly inefficient. */
1784 else if (verify_sender_address
!= NULL
)
1786 if ((verify_options
& (vopt_callout_recipsender
|vopt_callout_recippmaster
))
1789 *log_msgptr
= US
"use_sender or use_postmaster cannot be used for a "
1790 "sender verify callout";
1794 sender_vaddr
= verify_checked_sender(verify_sender_address
);
1795 if (sender_vaddr
!= NULL
&& /* Previously checked */
1796 callout
<= 0) /* No callout needed this time */
1798 /* If the "routed" flag is set, it means that routing worked before, so
1799 this check can give OK (the saved return code value, if set, belongs to a
1800 callout that was done previously). If the "routed" flag is not set, routing
1801 must have failed, so we use the saved return code. */
1803 if (testflag(sender_vaddr
, af_verify_routed
)) rc
= OK
; else
1805 rc
= sender_vaddr
->special_action
;
1806 *basic_errno
= sender_vaddr
->basic_errno
;
1808 HDEBUG(D_acl
) debug_printf("using cached sender verify result\n");
1811 /* Do a new verification, and cache the result. The cache is used to avoid
1812 verifying the sender multiple times for multiple RCPTs when callouts are not
1813 specified (see comments above).
1815 The cache is also used on failure to give details in response to the first
1816 RCPT that gets bounced for this reason. However, this can be suppressed by
1817 the no_details option, which sets the flag that says "this detail has already
1818 been sent". The cache normally contains just one address, but there may be
1819 more in esoteric circumstances. */
1824 uschar
*save_address_data
= deliver_address_data
;
1826 sender_vaddr
= deliver_make_addr(verify_sender_address
, TRUE
);
1827 if (no_details
) setflag(sender_vaddr
, af_sverify_told
);
1828 if (verify_sender_address
[0] != 0)
1830 /* If this is the real sender address, save the unrewritten version
1831 for use later in receive. Otherwise, set a flag so that rewriting the
1832 sender in verify_address() does not update sender_address. */
1834 if (verify_sender_address
== sender_address
)
1835 sender_address_unrewritten
= sender_address
;
1837 verify_options
|= vopt_fake_sender
;
1839 if (success_on_redirect
)
1840 verify_options
|= vopt_success_on_redirect
;
1842 /* The recipient, qualify, and expn options are never set in
1845 rc
= verify_address(sender_vaddr
, NULL
, verify_options
, callout
,
1846 callout_overall
, callout_connect
, se_mailfrom
, pm_mailfrom
, &routed
);
1848 HDEBUG(D_acl
) debug_printf("----------- end verify ------------\n");
1852 if (Ustrcmp(sender_vaddr
->address
, verify_sender_address
) != 0)
1854 DEBUG(D_acl
) debug_printf("sender %s verified ok as %s\n",
1855 verify_sender_address
, sender_vaddr
->address
);
1859 DEBUG(D_acl
) debug_printf("sender %s verified ok\n",
1860 verify_sender_address
);
1863 else *basic_errno
= sender_vaddr
->basic_errno
;
1865 else rc
= OK
; /* Null sender */
1867 /* Cache the result code */
1869 if (routed
) setflag(sender_vaddr
, af_verify_routed
);
1870 if (callout
> 0) setflag(sender_vaddr
, af_verify_callout
);
1871 sender_vaddr
->special_action
= rc
;
1872 sender_vaddr
->next
= sender_verified_list
;
1873 sender_verified_list
= sender_vaddr
;
1875 /* Restore the recipient address data, which might have been clobbered by
1876 the sender verification. */
1878 deliver_address_data
= save_address_data
;
1881 /* Put the sender address_data value into $sender_address_data */
1883 sender_address_data
= sender_vaddr
->p
.address_data
;
1886 /* A recipient address just gets a straightforward verify; again we must handle
1887 the DEFER overrides. */
1893 if (success_on_redirect
)
1894 verify_options
|= vopt_success_on_redirect
;
1896 /* We must use a copy of the address for verification, because it might
1900 rc
= verify_address(&addr2
, NULL
, verify_options
|vopt_is_recipient
, callout
,
1901 callout_overall
, callout_connect
, se_mailfrom
, pm_mailfrom
, NULL
);
1902 HDEBUG(D_acl
) debug_printf("----------- end verify ------------\n");
1904 *log_msgptr
= addr2
.message
;
1905 *user_msgptr
= (addr2
.user_message
!= NULL
)?
1906 addr2
.user_message
: addr2
.message
;
1907 *basic_errno
= addr2
.basic_errno
;
1909 /* Make $address_data visible */
1910 deliver_address_data
= addr2
.p
.address_data
;
1913 /* We have a result from the relevant test. Handle defer overrides first. */
1915 if (rc
== DEFER
&& (defer_ok
||
1916 (callout_defer_ok
&& *basic_errno
== ERRNO_CALLOUTDEFER
)))
1918 HDEBUG(D_acl
) debug_printf("verify defer overridden by %s\n",
1919 defer_ok
? "defer_ok" : "callout_defer_ok");
1923 /* If we've failed a sender, set up a recipient message, and point
1924 sender_verified_failed to the address item that actually failed. */
1926 if (rc
!= OK
&& verify_sender_address
!= NULL
)
1930 *log_msgptr
= *user_msgptr
= US
"Sender verify failed";
1932 else if (*basic_errno
!= ERRNO_CALLOUTDEFER
)
1934 *log_msgptr
= *user_msgptr
= US
"Could not complete sender verify";
1938 *log_msgptr
= US
"Could not complete sender verify callout";
1939 *user_msgptr
= smtp_return_error_details
? sender_vaddr
->user_message
:
1943 sender_verified_failed
= sender_vaddr
;
1946 /* Verifying an address messes up the values of $domain and $local_part,
1947 so reset them before returning if this is a RCPT ACL. */
1951 deliver_domain
= addr
->domain
;
1952 deliver_localpart
= addr
->local_part
;
1956 /* Syntax errors in the verify argument come here. */
1959 *log_msgptr
= string_sprintf("expected \"sender[=address]\", \"recipient\", "
1960 "\"helo\", \"header_syntax\", \"header_sender\" or "
1961 "\"reverse_host_lookup\" at start of ACL condition "
1962 "\"verify %s\"", arg
);
1965 /* Options supplied when not allowed come here */
1968 *log_msgptr
= string_sprintf("unexpected '/' found in \"%s\" "
1969 "(this verify item has no options)", arg
);
1972 /* Calls in the wrong ACL come here */
1975 *log_msgptr
= string_sprintf("cannot check header contents in ACL for %s "
1976 "(only possible in ACL for DATA)", acl_wherenames
[where
]);
1983 /*************************************************
1984 * Check argument for control= modifier *
1985 *************************************************/
1987 /* Called from acl_check_condition() below
1990 arg the argument string for control=
1991 pptr set to point to the terminating character
1992 where which ACL we are in
1993 log_msgptr for error messages
1995 Returns: CONTROL_xxx value
1999 decode_control(uschar
*arg
, uschar
**pptr
, int where
, uschar
**log_msgptr
)
2004 for (d
= controls_list
;
2005 d
< controls_list
+ sizeof(controls_list
)/sizeof(control_def
);
2008 len
= Ustrlen(d
->name
);
2009 if (Ustrncmp(d
->name
, arg
, len
) == 0) break;
2012 if (d
>= controls_list
+ sizeof(controls_list
)/sizeof(control_def
) ||
2013 (arg
[len
] != 0 && (!d
->has_option
|| arg
[len
] != '/')))
2015 *log_msgptr
= string_sprintf("syntax error in \"control=%s\"", arg
);
2016 return CONTROL_ERROR
;
2025 /*************************************************
2026 * Handle rate limiting *
2027 *************************************************/
2029 /* Called by acl_check_condition() below to calculate the result
2030 of the ACL ratelimit condition.
2032 Note that the return value might be slightly unexpected: if the
2033 sender's rate is above the limit then the result is OK. This is
2034 similar to the dnslists condition, and is so that you can write
2035 ACL clauses like: defer ratelimit = 15 / 1h
2038 arg the option string for ratelimit=
2039 where ACL_WHERE_xxxx indicating which ACL this is
2040 log_msgptr for error messages
2042 Returns: OK - Sender's rate is above limit
2043 FAIL - Sender's rate is below limit
2044 DEFER - Problem opening ratelimit database
2045 ERROR - Syntax error in options.
2049 acl_ratelimit(uschar
*arg
, int where
, uschar
**log_msgptr
)
2051 double limit
, period
;
2054 BOOL have_key
= FALSE
, leaky
= FALSE
, strict
= FALSE
;
2055 BOOL per_byte
= FALSE
, per_cmd
= FALSE
, per_conn
= FALSE
, per_mail
= FALSE
;
2057 tree_node
**anchor
, *t
;
2058 open_db dbblock
, *dbm
;
2059 dbdata_ratelimit
*dbd
;
2062 /* Parse the first two options and record their values in expansion
2063 variables. These variables allow the configuration to have informative
2064 error messages based on rate limits obtained from a table lookup. */
2066 /* First is the maximum number of messages per period and maximum burst
2067 size, which must be greater than or equal to zero. Zero is useful for
2068 rate measurement as opposed to rate limiting. */
2070 sender_rate_limit
= string_nextinlist(&arg
, &sep
, NULL
, 0);
2071 if (sender_rate_limit
== NULL
)
2075 limit
= Ustrtod(sender_rate_limit
, &ss
);
2076 if (tolower(*ss
) == 'k') { limit
*= 1024.0; ss
++; }
2077 else if (tolower(*ss
) == 'm') { limit
*= 1024.0*1024.0; ss
++; }
2078 else if (tolower(*ss
) == 'g') { limit
*= 1024.0*1024.0*1024.0; ss
++; }
2080 if (limit
< 0.0 || *ss
!= 0)
2082 *log_msgptr
= string_sprintf("syntax error in argument for "
2083 "\"ratelimit\" condition: \"%s\" is not a positive number",
2088 /* We use the rest of the argument list following the limit as the
2089 lookup key, because it doesn't make sense to use the same stored data
2090 if the period or options are different. */
2094 /* Second is the rate measurement period and exponential smoothing time
2095 constant. This must be strictly greater than zero, because zero leads to
2096 run-time division errors. */
2098 sender_rate_period
= string_nextinlist(&arg
, &sep
, NULL
, 0);
2099 if (sender_rate_period
== NULL
) period
= -1.0;
2100 else period
= readconf_readtime(sender_rate_period
, 0, FALSE
);
2103 *log_msgptr
= string_sprintf("syntax error in argument for "
2104 "\"ratelimit\" condition: \"%s\" is not a time value",
2105 sender_rate_period
);
2109 /* Parse the other options. Should we check if the per_* options are being
2110 used in ACLs where they don't make sense, e.g. per_mail in the connect ACL? */
2112 while ((ss
= string_nextinlist(&arg
, &sep
, big_buffer
, big_buffer_size
))
2115 if (strcmpic(ss
, US
"leaky") == 0) leaky
= TRUE
;
2116 else if (strcmpic(ss
, US
"strict") == 0) strict
= TRUE
;
2117 else if (strcmpic(ss
, US
"per_byte") == 0) per_byte
= TRUE
;
2118 else if (strcmpic(ss
, US
"per_cmd") == 0) per_cmd
= TRUE
;
2119 else if (strcmpic(ss
, US
"per_conn") == 0) per_conn
= TRUE
;
2120 else if (strcmpic(ss
, US
"per_mail") == 0) per_mail
= TRUE
;
2121 else if (strcmpic(ss
, US
"per_rcpt") == 0) per_cmd
= TRUE
; /* alias */
2122 else have_key
= TRUE
;
2124 if (leaky
+ strict
> 1 || per_byte
+ per_cmd
+ per_conn
+ per_mail
> 1)
2126 *log_msgptr
= US
"conflicting options for \"ratelimit\" condition";
2130 /* Default option values */
2131 if (!strict
) leaky
= TRUE
;
2132 if (!per_byte
&& !per_cmd
&& !per_conn
) per_mail
= TRUE
;
2134 /* If there is no explicit key, use the sender_host_address. If there is no
2135 sender_host_address (e.g. -bs or acl_not_smtp) then we simply omit it. */
2137 if (!have_key
&& sender_host_address
!= NULL
)
2138 key
= string_sprintf("%s / %s", key
, sender_host_address
);
2140 HDEBUG(D_acl
) debug_printf("ratelimit condition limit=%.0f period=%.0f key=%s\n",
2141 limit
, period
, key
);
2143 /* See if we have already computed the rate by looking in the relevant tree. For
2144 per-connection rate limiting, store tree nodes and dbdata in the permanent pool
2145 so that they survive across resets. */
2148 old_pool
= store_pool
;
2152 anchor
= &ratelimiters_conn
;
2153 store_pool
= POOL_PERM
;
2155 else if (per_mail
|| per_byte
)
2156 anchor
= &ratelimiters_mail
;
2158 anchor
= &ratelimiters_cmd
;
2160 if (anchor
!= NULL
&& (t
= tree_search(*anchor
, key
)) != NULL
)
2163 /* The following few lines duplicate some of the code below. */
2164 if (dbd
->rate
< limit
) rc
= FAIL
;
2166 store_pool
= old_pool
;
2167 sender_rate
= string_sprintf("%.1f", dbd
->rate
);
2169 debug_printf("ratelimit found pre-computed rate %s\n", sender_rate
);
2173 /* We aren't using a pre-computed rate, so get a previously recorded
2174 rate from the database, update it, and write it back. If there's no
2175 previous rate for this key, create one. */
2177 dbm
= dbfn_open(US
"ratelimit", O_RDWR
, &dbblock
, TRUE
);
2180 store_pool
= old_pool
;
2182 HDEBUG(D_acl
) debug_printf("ratelimit database not available\n");
2183 *log_msgptr
= US
"ratelimit database not available";
2186 dbd
= dbfn_read(dbm
, key
);
2188 gettimeofday(&tv
, NULL
);
2192 HDEBUG(D_acl
) debug_printf("ratelimit initializing new key's data\n");
2193 dbd
= store_get(sizeof(dbdata_ratelimit
));
2194 dbd
->time_stamp
= tv
.tv_sec
;
2195 dbd
->time_usec
= tv
.tv_usec
;
2200 /* The smoothed rate is computed using an exponentially weighted moving
2201 average adjusted for variable sampling intervals. The standard EWMA for
2202 a fixed sampling interval is: f'(t) = (1 - a) * f(t) + a * f'(t - 1)
2203 where f() is the measured value and f'() is the smoothed value.
2205 Old data decays out of the smoothed value exponentially, such that data n
2206 samples old is multiplied by a^n. The exponential decay time constant p
2207 is defined such that data p samples old is multiplied by 1/e, which means
2208 that a = exp(-1/p). We can maintain the same time constant for a variable
2209 sampling interval i by using a = exp(-i/p).
2211 The rate we are measuring is messages per period, suitable for directly
2212 comparing with the limit. The average rate between now and the previous
2213 message is period / interval, which we feed into the EWMA as the sample.
2215 It turns out that the number of messages required for the smoothed rate
2216 to reach the limit when they are sent in a burst is equal to the limit.
2217 This can be seen by analysing the value of the smoothed rate after N
2218 messages sent at even intervals. Let k = (1 - a) * p/i
2220 rate_1 = (1 - a) * p/i + a * rate_0
2222 rate_2 = k + a * rate_1
2223 = k + a * k + a^2 * rate_0
2224 rate_3 = k + a * k + a^2 * k + a^3 * rate_0
2225 rate_N = rate_0 * a^N + k * SUM(x=0..N-1)(a^x)
2226 = rate_0 * a^N + k * (1 - a^N) / (1 - a)
2227 = rate_0 * a^N + p/i * (1 - a^N)
2229 When N is large, a^N -> 0 so rate_N -> p/i as desired.
2231 rate_N = p/i + (rate_0 - p/i) * a^N
2232 a^N = (rate_N - p/i) / (rate_0 - p/i)
2233 N * -i/p = log((rate_N - p/i) / (rate_0 - p/i))
2234 N = p/i * log((rate_0 - p/i) / (rate_N - p/i))
2236 Numerical analysis of the above equation, setting the computed rate to
2237 increase from rate_0 = 0 to rate_N = limit, shows that for large sending
2238 rates, p/i, the number of messages N = limit. So limit serves as both the
2239 maximum rate measured in messages per period, and the maximum number of
2240 messages that can be sent in a fast burst. */
2242 double this_time
= (double)tv
.tv_sec
2243 + (double)tv
.tv_usec
/ 1000000.0;
2244 double prev_time
= (double)dbd
->time_stamp
2245 + (double)dbd
->time_usec
/ 1000000.0;
2247 /* We must avoid division by zero, and deal gracefully with the clock going
2248 backwards. If we blunder ahead when time is in reverse then the computed
2249 rate will be bogus. To be safe we clamp interval to a very small number. */
2251 double interval
= this_time
- prev_time
<= 0.0 ? 1e-9
2252 : this_time
- prev_time
;
2254 double i_over_p
= interval
/ period
;
2255 double a
= exp(-i_over_p
);
2257 dbd
->time_stamp
= tv
.tv_sec
;
2258 dbd
->time_usec
= tv
.tv_usec
;
2260 /* If we are measuring the rate in bytes per period, multiply the
2261 measured rate by the message size. If we don't know the message size
2262 then it's safe to just use a value of zero and let the recorded rate
2263 decay as if nothing happened. */
2266 dbd
->rate
= (message_size
< 0 ? 0.0 : (double)message_size
)
2267 * (1 - a
) / i_over_p
+ a
* dbd
->rate
;
2268 else if (per_cmd
&& where
== ACL_WHERE_NOTSMTP
)
2269 dbd
->rate
= (double)recipients_count
2270 * (1 - a
) / i_over_p
+ a
* dbd
->rate
;
2272 dbd
->rate
= (1 - a
) / i_over_p
+ a
* dbd
->rate
;
2275 /* Clients sending at the limit are considered to be over the limit. This
2276 matters for edge cases such the first message sent by a client (which gets
2277 the initial rate of 0.0) when the rate limit is zero (i.e. the client should
2278 be completely blocked). */
2280 if (dbd
->rate
< limit
) rc
= FAIL
;
2283 /* Update the state if the rate is low or if we are being strict. If we
2284 are in leaky mode and the sender's rate is too high, we do not update
2285 the recorded rate in order to avoid an over-aggressive sender's retry
2286 rate preventing them from getting any email through. */
2288 if (rc
== FAIL
|| !leaky
)
2289 dbfn_write(dbm
, key
, dbd
, sizeof(dbdata_ratelimit
));
2292 /* Store the result in the tree for future reference, if necessary. */
2296 t
= store_get(sizeof(tree_node
) + Ustrlen(key
));
2298 Ustrcpy(t
->name
, key
);
2299 (void)tree_insertnode(anchor
, t
);
2302 /* We create the formatted version of the sender's rate very late in
2303 order to ensure that it is done using the correct storage pool. */
2305 store_pool
= old_pool
;
2306 sender_rate
= string_sprintf("%.1f", dbd
->rate
);
2309 debug_printf("ratelimit computed rate %s\n", sender_rate
);
2316 /*************************************************
2317 * Handle conditions/modifiers on an ACL item *
2318 *************************************************/
2320 /* Called from acl_check() below.
2324 cb ACL condition block - if NULL, result is OK
2325 where where called from
2326 addr the address being checked for RCPT, or NULL
2327 level the nesting level
2328 epp pointer to pass back TRUE if "endpass" encountered
2329 (applies only to "accept" and "discard")
2330 user_msgptr user message pointer
2331 log_msgptr log message pointer
2332 basic_errno pointer to where to put verify error
2334 Returns: OK - all conditions are met
2335 DISCARD - an "acl" condition returned DISCARD - only allowed
2336 for "accept" or "discard" verbs
2337 FAIL - at least one condition fails
2338 FAIL_DROP - an "acl" condition returned FAIL_DROP
2339 DEFER - can't tell at the moment (typically, lookup defer,
2340 but can be temporary callout problem)
2341 ERROR - ERROR from nested ACL or expansion failure or other
2346 acl_check_condition(int verb
, acl_condition_block
*cb
, int where
,
2347 address_item
*addr
, int level
, BOOL
*epp
, uschar
**user_msgptr
,
2348 uschar
**log_msgptr
, int *basic_errno
)
2350 uschar
*user_message
= NULL
;
2351 uschar
*log_message
= NULL
;
2354 #ifdef WITH_CONTENT_SCAN
2358 for (; cb
!= NULL
; cb
= cb
->next
)
2363 /* The message and log_message items set up messages to be used in
2364 case of rejection. They are expanded later. */
2366 if (cb
->type
== ACLC_MESSAGE
)
2368 user_message
= cb
->arg
;
2372 if (cb
->type
== ACLC_LOG_MESSAGE
)
2374 log_message
= cb
->arg
;
2378 /* The endpass "condition" just sets a flag to show it occurred. This is
2379 checked at compile time to be on an "accept" or "discard" item. */
2381 if (cb
->type
== ACLC_ENDPASS
)
2387 /* For other conditions and modifiers, the argument is expanded now for some
2388 of them, but not for all, because expansion happens down in some lower level
2389 checking functions in some cases. */
2391 if (cond_expand_at_top
[cb
->type
])
2393 arg
= expand_string(cb
->arg
);
2396 if (expand_string_forcedfail
) continue;
2397 *log_msgptr
= string_sprintf("failed to expand ACL string \"%s\": %s",
2398 cb
->arg
, expand_string_message
);
2399 return search_find_defer
? DEFER
: ERROR
;
2404 /* Show condition, and expanded condition if it's different */
2409 debug_printf("check %s%s %n",
2410 (!cond_modifiers
[cb
->type
] && cb
->u
.negated
)? "!":"",
2411 conditions
[cb
->type
], &lhswidth
);
2413 if (cb
->type
== ACLC_SET
)
2415 int n
= cb
->u
.varnumber
;
2416 int t
= (n
< ACL_CVARS
)? 'c' : 'm';
2417 if (n
>= ACL_CVARS
) n
-= ACL_CVARS
;
2418 debug_printf("acl_%c%d ", t
, n
);
2422 debug_printf("= %s\n", cb
->arg
);
2425 debug_printf("%.*s= %s\n", lhswidth
,
2429 /* Check that this condition makes sense at this time */
2431 if ((cond_forbids
[cb
->type
] & (1 << where
)) != 0)
2433 *log_msgptr
= string_sprintf("cannot %s %s condition in %s ACL",
2434 cond_modifiers
[cb
->type
]? "use" : "test",
2435 conditions
[cb
->type
], acl_wherenames
[where
]);
2439 /* Run the appropriate test for each condition, or take the appropriate
2440 action for the remaining modifiers. */
2444 case ACLC_ADD_HEADER
:
2448 /* A nested ACL that returns "discard" makes sense only for an "accept" or
2452 rc
= acl_check_internal(where
, addr
, arg
, level
+1, user_msgptr
, log_msgptr
);
2453 if (rc
== DISCARD
&& verb
!= ACL_ACCEPT
&& verb
!= ACL_DISCARD
)
2455 *log_msgptr
= string_sprintf("nested ACL returned \"discard\" for "
2456 "\"%s\" command (only allowed with \"accept\" or \"discard\")",
2462 case ACLC_AUTHENTICATED
:
2463 rc
= (sender_host_authenticated
== NULL
)? FAIL
:
2464 match_isinlist(sender_host_authenticated
, &arg
, 0, NULL
, NULL
, MCL_STRING
,
2468 #ifdef EXPERIMENTAL_BRIGHTMAIL
2469 case ACLC_BMI_OPTIN
:
2471 int old_pool
= store_pool
;
2472 store_pool
= POOL_PERM
;
2473 bmi_current_optin
= string_copy(arg
);
2474 store_pool
= old_pool
;
2479 case ACLC_CONDITION
:
2480 if (Ustrspn(arg
, "0123456789") == Ustrlen(arg
)) /* Digits, or empty */
2481 rc
= (Uatoi(arg
) == 0)? FAIL
: OK
;
2483 rc
= (strcmpic(arg
, US
"no") == 0 ||
2484 strcmpic(arg
, US
"false") == 0)? FAIL
:
2485 (strcmpic(arg
, US
"yes") == 0 ||
2486 strcmpic(arg
, US
"true") == 0)? OK
: DEFER
;
2488 *log_msgptr
= string_sprintf("invalid \"condition\" value \"%s\"", arg
);
2492 control_type
= decode_control(arg
, &p
, where
, log_msgptr
);
2494 /* Check if this control makes sense at this time */
2496 if ((control_forbids
[control_type
] & (1 << where
)) != 0)
2498 *log_msgptr
= string_sprintf("cannot use \"control=%s\" in %s ACL",
2499 controls
[control_type
], acl_wherenames
[where
]);
2503 switch(control_type
)
2505 case CONTROL_AUTH_UNADVERTISED
:
2506 allow_auth_unadvertised
= TRUE
;
2509 #ifdef EXPERIMENTAL_BRIGHTMAIL
2510 case CONTROL_BMI_RUN
:
2515 #ifdef EXPERIMENTAL_DOMAINKEYS
2516 case CONTROL_DK_VERIFY
:
2524 case CONTROL_CASEFUL_LOCAL_PART
:
2525 deliver_localpart
= addr
->cc_local_part
;
2528 case CONTROL_CASELOWER_LOCAL_PART
:
2529 deliver_localpart
= addr
->lc_local_part
;
2532 case CONTROL_ENFORCE_SYNC
:
2533 smtp_enforce_sync
= TRUE
;
2536 case CONTROL_NO_ENFORCE_SYNC
:
2537 smtp_enforce_sync
= FALSE
;
2540 #ifdef WITH_CONTENT_SCAN
2541 case CONTROL_NO_MBOX_UNSPOOL
:
2542 no_mbox_unspool
= TRUE
;
2546 case CONTROL_NO_MULTILINE
:
2547 no_multiline_responses
= TRUE
;
2550 case CONTROL_FAKEDEFER
:
2551 case CONTROL_FAKEREJECT
:
2552 fake_response
= (control_type
== CONTROL_FAKEDEFER
) ? DEFER
: FAIL
;
2556 while (*pp
!= 0) pp
++;
2557 fake_response_text
= expand_string(string_copyn(p
+1, pp
-p
-1));
2562 /* Explicitly reset to default string */
2563 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).";
2567 case CONTROL_FREEZE
:
2568 deliver_freeze
= TRUE
;
2569 deliver_frozen_at
= time(NULL
);
2570 freeze_tell
= freeze_tell_config
; /* Reset to configured value */
2571 if (Ustrncmp(p
, "/no_tell", 8) == 0)
2578 *log_msgptr
= string_sprintf("syntax error in \"control=%s\"", arg
);
2583 case CONTROL_QUEUE_ONLY
:
2584 queue_only_policy
= TRUE
;
2587 case CONTROL_SUBMISSION
:
2588 originator_name
= US
"";
2589 submission_mode
= TRUE
;
2592 if (Ustrncmp(p
, "/sender_retain", 14) == 0)
2595 active_local_sender_retain
= TRUE
;
2596 active_local_from_check
= FALSE
;
2598 else if (Ustrncmp(p
, "/domain=", 8) == 0)
2601 while (*pp
!= 0 && *pp
!= '/') pp
++;
2602 submission_domain
= string_copyn(p
+8, pp
-p
-8);
2605 /* The name= option must be last, because it swallows the rest of
2607 else if (Ustrncmp(p
, "/name=", 6) == 0)
2610 while (*pp
!= 0) pp
++;
2611 submission_name
= string_copy(parse_fix_phrase(p
+6, pp
-p
-6,
2612 big_buffer
, big_buffer_size
));
2619 *log_msgptr
= string_sprintf("syntax error in \"control=%s\"", arg
);
2624 case CONTROL_SUPPRESS_LOCAL_FIXUPS
:
2625 suppress_local_fixups
= TRUE
;
2630 #ifdef WITH_CONTENT_SCAN
2632 rc
= mime_decode(&arg
);
2638 int delay
= readconf_readtime(arg
, 0, FALSE
);
2641 *log_msgptr
= string_sprintf("syntax error in argument for \"delay\" "
2642 "modifier: \"%s\" is not a time value", arg
);
2647 HDEBUG(D_acl
) debug_printf("delay modifier requests %d-second delay\n",
2652 debug_printf("delay skipped in -bh checking mode\n");
2655 /* It appears to be impossible to detect that a TCP/IP connection has
2656 gone away without reading from it. This means that we cannot shorten
2657 the delay below if the client goes away, because we cannot discover
2658 that the client has closed its end of the connection. (The connection
2659 is actually in a half-closed state, waiting for the server to close its
2660 end.) It would be nice to be able to detect this state, so that the
2661 Exim process is not held up unnecessarily. However, it seems that we
2662 can't. The poll() function does not do the right thing, and in any case
2663 it is not always available.
2665 NOTE: If ever this state of affairs changes, remember that we may be
2666 dealing with stdin/stdout here, in addition to TCP/IP connections.
2667 Whatever is done must work in both cases. To detected the stdin/stdout
2668 case, check for smtp_in or smtp_out being NULL. */
2672 while (delay
> 0) delay
= sleep(delay
);
2678 #ifdef WITH_OLD_DEMIME
2684 #ifdef EXPERIMENTAL_DOMAINKEYS
2685 case ACLC_DK_DOMAIN_SOURCE
:
2686 if (dk_verify_block
== NULL
) { rc
= FAIL
; break; };
2687 /* check header source of domain against given string */
2688 switch (dk_verify_block
->address_source
) {
2689 case DK_EXIM_ADDRESS_FROM_FROM
:
2690 rc
= match_isinlist(US
"from", &arg
, 0, NULL
,
2691 NULL
, MCL_STRING
, TRUE
, NULL
);
2693 case DK_EXIM_ADDRESS_FROM_SENDER
:
2694 rc
= match_isinlist(US
"sender", &arg
, 0, NULL
,
2695 NULL
, MCL_STRING
, TRUE
, NULL
);
2697 case DK_EXIM_ADDRESS_NONE
:
2698 rc
= match_isinlist(US
"none", &arg
, 0, NULL
,
2699 NULL
, MCL_STRING
, TRUE
, NULL
);
2704 case ACLC_DK_POLICY
:
2705 if (dk_verify_block
== NULL
) { rc
= FAIL
; break; };
2706 /* check policy against given string, default FAIL */
2708 if (dk_verify_block
->signsall
)
2709 rc
= match_isinlist(US
"signsall", &arg
, 0, NULL
,
2710 NULL
, MCL_STRING
, TRUE
, NULL
);
2711 if (dk_verify_block
->testing
)
2712 rc
= match_isinlist(US
"testing", &arg
, 0, NULL
,
2713 NULL
, MCL_STRING
, TRUE
, NULL
);
2716 case ACLC_DK_SENDER_DOMAINS
:
2717 if (dk_verify_block
== NULL
) { rc
= FAIL
; break; };
2718 if (dk_verify_block
->domain
!= NULL
)
2719 rc
= match_isinlist(dk_verify_block
->domain
, &arg
, 0, &domainlist_anchor
,
2720 NULL
, MCL_DOMAIN
, TRUE
, NULL
);
2724 case ACLC_DK_SENDER_LOCAL_PARTS
:
2725 if (dk_verify_block
== NULL
) { rc
= FAIL
; break; };
2726 if (dk_verify_block
->local_part
!= NULL
)
2727 rc
= match_isinlist(dk_verify_block
->local_part
, &arg
, 0, &localpartlist_anchor
,
2728 NULL
, MCL_LOCALPART
, TRUE
, NULL
);
2732 case ACLC_DK_SENDERS
:
2733 if (dk_verify_block
== NULL
) { rc
= FAIL
; break; };
2734 if (dk_verify_block
->address
!= NULL
)
2735 rc
= match_address_list(dk_verify_block
->address
, TRUE
, TRUE
, &arg
, NULL
, -1, 0, NULL
);
2739 case ACLC_DK_STATUS
:
2740 if (dk_verify_block
== NULL
) { rc
= FAIL
; break; };
2741 if (dk_verify_block
->result
> 0) {
2742 switch(dk_verify_block
->result
) {
2743 case DK_EXIM_RESULT_BAD_FORMAT
:
2744 rc
= match_isinlist(US
"bad format", &arg
, 0, NULL
,
2745 NULL
, MCL_STRING
, TRUE
, NULL
);
2747 case DK_EXIM_RESULT_NO_KEY
:
2748 rc
= match_isinlist(US
"no key", &arg
, 0, NULL
,
2749 NULL
, MCL_STRING
, TRUE
, NULL
);
2751 case DK_EXIM_RESULT_NO_SIGNATURE
:
2752 rc
= match_isinlist(US
"no signature", &arg
, 0, NULL
,
2753 NULL
, MCL_STRING
, TRUE
, NULL
);
2755 case DK_EXIM_RESULT_REVOKED
:
2756 rc
= match_isinlist(US
"revoked", &arg
, 0, NULL
,
2757 NULL
, MCL_STRING
, TRUE
, NULL
);
2759 case DK_EXIM_RESULT_NON_PARTICIPANT
:
2760 rc
= match_isinlist(US
"non-participant", &arg
, 0, NULL
,
2761 NULL
, MCL_STRING
, TRUE
, NULL
);
2763 case DK_EXIM_RESULT_GOOD
:
2764 rc
= match_isinlist(US
"good", &arg
, 0, NULL
,
2765 NULL
, MCL_STRING
, TRUE
, NULL
);
2767 case DK_EXIM_RESULT_BAD
:
2768 rc
= match_isinlist(US
"bad", &arg
, 0, NULL
,
2769 NULL
, MCL_STRING
, TRUE
, NULL
);
2777 rc
= verify_check_dnsbl(&arg
);
2781 rc
= match_isinlist(addr
->domain
, &arg
, 0, &domainlist_anchor
,
2782 addr
->domain_cache
, MCL_DOMAIN
, TRUE
, &deliver_domain_data
);
2785 /* The value in tls_cipher is the full cipher name, for example,
2786 TLSv1:DES-CBC3-SHA:168, whereas the values to test for are just the
2787 cipher names such as DES-CBC3-SHA. But program defensively. We don't know
2788 what may in practice come out of the SSL library - which at the time of
2789 writing is poorly documented. */
2791 case ACLC_ENCRYPTED
:
2792 if (tls_cipher
== NULL
) rc
= FAIL
; else
2794 uschar
*endcipher
= NULL
;
2795 uschar
*cipher
= Ustrchr(tls_cipher
, ':');
2796 if (cipher
== NULL
) cipher
= tls_cipher
; else
2798 endcipher
= Ustrchr(++cipher
, ':');
2799 if (endcipher
!= NULL
) *endcipher
= 0;
2801 rc
= match_isinlist(cipher
, &arg
, 0, NULL
, NULL
, MCL_STRING
, TRUE
, NULL
);
2802 if (endcipher
!= NULL
) *endcipher
= ':';
2806 /* Use verify_check_this_host() instead of verify_check_host() so that
2807 we can pass over &host_data to catch any looked up data. Once it has been
2808 set, it retains its value so that it's still there if another ACL verb
2809 comes through here and uses the cache. However, we must put it into
2810 permanent store in case it is also expected to be used in a subsequent
2811 message in the same SMTP connection. */
2814 rc
= verify_check_this_host(&arg
, sender_host_cache
, NULL
,
2815 (sender_host_address
== NULL
)? US
"" : sender_host_address
, &host_data
);
2816 if (host_data
!= NULL
) host_data
= string_copy_malloc(host_data
);
2819 case ACLC_LOCAL_PARTS
:
2820 rc
= match_isinlist(addr
->cc_local_part
, &arg
, 0,
2821 &localpartlist_anchor
, addr
->localpart_cache
, MCL_LOCALPART
, TRUE
,
2822 &deliver_localpart_data
);
2834 if (Ustrncmp(s
, "main", 4) == 0)
2835 { logbits
|= LOG_MAIN
; s
+= 4; }
2836 else if (Ustrncmp(s
, "panic", 5) == 0)
2837 { logbits
|= LOG_PANIC
; s
+= 5; }
2838 else if (Ustrncmp(s
, "reject", 6) == 0)
2839 { logbits
|= LOG_REJECT
; s
+= 6; }
2842 logbits
= LOG_MAIN
|LOG_PANIC
;
2843 s
= string_sprintf(":unknown log name in \"%s\" in "
2844 "\"logwrite\" in %s ACL", arg
, acl_wherenames
[where
]);
2850 while (isspace(*s
)) s
++;
2851 if (logbits
== 0) logbits
= LOG_MAIN
;
2852 log_write(0, logbits
, "%s", string_printing(s
));
2856 #ifdef WITH_CONTENT_SCAN
2859 /* Seperate the regular expression and any optional parameters. */
2860 uschar
*ss
= string_nextinlist(&arg
, &sep
, big_buffer
, big_buffer_size
);
2861 /* Run the malware backend. */
2863 /* Modify return code based upon the existance of options. */
2864 while ((ss
= string_nextinlist(&arg
, &sep
, big_buffer
, big_buffer_size
))
2866 if (strcmpic(ss
, US
"defer_ok") == 0 && rc
== DEFER
)
2868 /* FAIL so that the message is passed to the next ACL */
2875 case ACLC_MIME_REGEX
:
2876 rc
= mime_regex(&arg
);
2880 case ACLC_RATELIMIT
:
2881 rc
= acl_ratelimit(arg
, where
, log_msgptr
);
2884 case ACLC_RECIPIENTS
:
2885 rc
= match_address_list(addr
->address
, TRUE
, TRUE
, &arg
, NULL
, -1, 0,
2889 #ifdef WITH_CONTENT_SCAN
2895 case ACLC_SENDER_DOMAINS
:
2898 sdomain
= Ustrrchr(sender_address
, '@');
2899 sdomain
= (sdomain
== NULL
)? US
"" : sdomain
+ 1;
2900 rc
= match_isinlist(sdomain
, &arg
, 0, &domainlist_anchor
,
2901 sender_domain_cache
, MCL_DOMAIN
, TRUE
, NULL
);
2906 rc
= match_address_list(sender_address
, TRUE
, TRUE
, &arg
,
2907 sender_address_cache
, -1, 0, &sender_data
);
2910 /* Connection variables must persist forever */
2914 int old_pool
= store_pool
;
2915 if (cb
->u
.varnumber
< ACL_CVARS
) store_pool
= POOL_PERM
;
2916 acl_var
[cb
->u
.varnumber
] = string_copy(arg
);
2917 store_pool
= old_pool
;
2921 #ifdef WITH_CONTENT_SCAN
2924 /* Seperate the regular expression and any optional parameters. */
2925 uschar
*ss
= string_nextinlist(&arg
, &sep
, big_buffer
, big_buffer_size
);
2926 /* Run the spam backend. */
2928 /* Modify return code based upon the existance of options. */
2929 while ((ss
= string_nextinlist(&arg
, &sep
, big_buffer
, big_buffer_size
))
2931 if (strcmpic(ss
, US
"defer_ok") == 0 && rc
== DEFER
)
2933 /* FAIL so that the message is passed to the next ACL */
2941 #ifdef EXPERIMENTAL_SPF
2943 rc
= spf_process(&arg
, sender_address
);
2947 /* If the verb is WARN, discard any user message from verification, because
2948 such messages are SMTP responses, not header additions. The latter come
2949 only from explicit "message" modifiers. However, put the user message into
2950 $acl_verify_message so it can be used in subsequent conditions or modifiers
2951 (until something changes it). */
2954 rc
= acl_verify(where
, addr
, arg
, user_msgptr
, log_msgptr
, basic_errno
);
2955 acl_verify_message
= *user_msgptr
;
2956 if (verb
== ACL_WARN
) *user_msgptr
= NULL
;
2960 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "internal ACL error: unknown "
2961 "condition %d", cb
->type
);
2965 /* If a condition was negated, invert OK/FAIL. */
2967 if (!cond_modifiers
[cb
->type
] && cb
->u
.negated
)
2969 if (rc
== OK
) rc
= FAIL
;
2970 else if (rc
== FAIL
|| rc
== FAIL_DROP
) rc
= OK
;
2973 if (rc
!= OK
) break; /* Conditions loop */
2977 /* If the result is the one for which "message" and/or "log_message" are used,
2978 handle the values of these options. Most verbs have but a single return for
2979 which the messages are relevant, but for "discard", it's useful to have the log
2980 message both when it succeeds and when it fails. Also, for an "accept" that
2981 appears in a QUIT ACL, we want to handle the user message. Since only "accept"
2982 and "warn" are permitted in that ACL, we don't need to test the verb.
2984 These modifiers act in different ways:
2986 "message" is a user message that will be included in an SMTP response. Unless
2987 it is empty, it overrides any previously set user message.
2989 "log_message" is a non-user message, and it adds to any existing non-user
2990 message that is already set.
2992 If there isn't a log message set, we make it the same as the user message. */
2994 if (((rc
== FAIL_DROP
)? FAIL
: rc
) == msgcond
[verb
] ||
2995 (verb
== ACL_DISCARD
&& rc
== OK
) ||
2996 (where
== ACL_WHERE_QUIT
))
3000 /* If the verb is "warn", messages generated by conditions (verification or
3001 nested ACLs) are discarded. Only messages specified at this level are used.
3002 However, the value of an existing message is available in $acl_verify_message
3003 during expansions. */
3005 uschar
*old_user_msgptr
= *user_msgptr
;
3006 uschar
*old_log_msgptr
= (*log_msgptr
!= NULL
)? *log_msgptr
: old_user_msgptr
;
3008 if (verb
== ACL_WARN
) *log_msgptr
= *user_msgptr
= NULL
;
3010 if (user_message
!= NULL
)
3012 acl_verify_message
= old_user_msgptr
;
3013 expmessage
= expand_string(user_message
);
3014 if (expmessage
== NULL
)
3016 if (!expand_string_forcedfail
)
3017 log_write(0, LOG_MAIN
|LOG_PANIC
, "failed to expand ACL message \"%s\": %s",
3018 user_message
, expand_string_message
);
3020 else if (expmessage
[0] != 0) *user_msgptr
= expmessage
;
3023 if (log_message
!= NULL
)
3025 acl_verify_message
= old_log_msgptr
;
3026 expmessage
= expand_string(log_message
);
3027 if (expmessage
== NULL
)
3029 if (!expand_string_forcedfail
)
3030 log_write(0, LOG_MAIN
|LOG_PANIC
, "failed to expand ACL message \"%s\": %s",
3031 log_message
, expand_string_message
);
3033 else if (expmessage
[0] != 0)
3035 *log_msgptr
= (*log_msgptr
== NULL
)? expmessage
:
3036 string_sprintf("%s: %s", expmessage
, *log_msgptr
);
3040 /* If no log message, default it to the user message */
3042 if (*log_msgptr
== NULL
) *log_msgptr
= *user_msgptr
;
3045 acl_verify_message
= NULL
;
3053 /*************************************************
3054 * Get line from a literal ACL *
3055 *************************************************/
3057 /* This function is passed to acl_read() in order to extract individual lines
3058 of a literal ACL, which we access via static pointers. We can destroy the
3059 contents because this is called only once (the compiled ACL is remembered).
3061 This code is intended to treat the data in the same way as lines in the main
3062 Exim configuration file. That is:
3064 . Leading spaces are ignored.
3066 . A \ at the end of a line is a continuation - trailing spaces after the \
3067 are permitted (this is because I don't believe in making invisible things
3068 significant). Leading spaces on the continued part of a line are ignored.
3070 . Physical lines starting (significantly) with # are totally ignored, and
3071 may appear within a sequence of backslash-continued lines.
3073 . Blank lines are ignored, but will end a sequence of continuations.
3076 Returns: a pointer to the next line
3080 static uschar
*acl_text
; /* Current pointer in the text */
3081 static uschar
*acl_text_end
; /* Points one past the terminating '0' */
3089 /* This loop handles leading blank lines and comments. */
3093 while (isspace(*acl_text
)) acl_text
++; /* Leading spaces/empty lines */
3094 if (*acl_text
== 0) return NULL
; /* No more data */
3095 yield
= acl_text
; /* Potential data line */
3097 while (*acl_text
!= 0 && *acl_text
!= '\n') acl_text
++;
3099 /* If we hit the end before a newline, we have the whole logical line. If
3100 it's a comment, there's no more data to be given. Otherwise, yield it. */
3102 if (*acl_text
== 0) return (*yield
== '#')? NULL
: yield
;
3104 /* After reaching a newline, end this loop if the physical line does not
3105 start with '#'. If it does, it's a comment, and the loop continues. */
3107 if (*yield
!= '#') break;
3110 /* This loop handles continuations. We know we have some real data, ending in
3111 newline. See if there is a continuation marker at the end (ignoring trailing
3112 white space). We know that *yield is not white space, so no need to test for
3113 cont > yield in the backwards scanning loop. */
3118 for (cont
= acl_text
- 1; isspace(*cont
); cont
--);
3120 /* If no continuation follows, we are done. Mark the end of the line and
3129 /* We have encountered a continuation. Skip over whitespace at the start of
3130 the next line, and indeed the whole of the next line or lines if they are
3135 while (*(++acl_text
) == ' ' || *acl_text
== '\t');
3136 if (*acl_text
!= '#') break;
3137 while (*(++acl_text
) != 0 && *acl_text
!= '\n');
3140 /* We have the start of a continuation line. Move all the rest of the data
3141 to join onto the previous line, and then find its end. If the end is not a
3142 newline, we are done. Otherwise loop to look for another continuation. */
3144 memmove(cont
, acl_text
, acl_text_end
- acl_text
);
3145 acl_text_end
-= acl_text
- cont
;
3147 while (*acl_text
!= 0 && *acl_text
!= '\n') acl_text
++;
3148 if (*acl_text
== 0) return yield
;
3151 /* Control does not reach here */
3158 /*************************************************
3159 * Check access using an ACL *
3160 *************************************************/
3162 /* This function is called from address_check. It may recurse via
3163 acl_check_condition() - hence the use of a level to stop looping. The ACL is
3164 passed as a string which is expanded. A forced failure implies no access check
3165 is required. If the result is a single word, it is taken as the name of an ACL
3166 which is sought in the global ACL tree. Otherwise, it is taken as literal ACL
3167 text, complete with newlines, and parsed as such. In both cases, the ACL check
3168 is then run. This function uses an auxiliary function for acl_read() to call
3169 for reading individual lines of a literal ACL. This is acl_getline(), which
3170 appears immediately above.
3173 where where called from
3174 addr address item when called from RCPT; otherwise NULL
3175 s the input string; NULL is the same as an empty ACL => DENY
3176 level the nesting level
3177 user_msgptr where to put a user error (for SMTP response)
3178 log_msgptr where to put a logging message (not for SMTP response)
3180 Returns: OK access is granted
3181 DISCARD access is apparently granted...
3182 FAIL access is denied
3183 FAIL_DROP access is denied; drop the connection
3184 DEFER can't tell at the moment
3189 acl_check_internal(int where
, address_item
*addr
, uschar
*s
, int level
,
3190 uschar
**user_msgptr
, uschar
**log_msgptr
)
3193 acl_block
*acl
= NULL
;
3194 uschar
*acl_name
= US
"inline ACL";
3197 /* Catch configuration loops */
3201 *log_msgptr
= US
"ACL nested too deep: possible loop";
3207 HDEBUG(D_acl
) debug_printf("ACL is NULL: implicit DENY\n");
3211 /* At top level, we expand the incoming string. At lower levels, it has already
3212 been expanded as part of condition processing. */
3216 ss
= expand_string(s
);
3219 if (expand_string_forcedfail
) return OK
;
3220 *log_msgptr
= string_sprintf("failed to expand ACL string \"%s\": %s", s
,
3221 expand_string_message
);
3227 while (isspace(*ss
))ss
++;
3229 /* If we can't find a named ACL, the default is to parse it as an inline one.
3230 (Unless it begins with a slash; non-existent files give rise to an error.) */
3234 /* Handle the case of a string that does not contain any spaces. Look for a
3235 named ACL among those read from the configuration, or a previously read file.
3236 It is possible that the pointer to the ACL is NULL if the configuration
3237 contains a name with no data. If not found, and the text begins with '/',
3238 read an ACL from a file, and save it so it can be re-used. */
3240 if (Ustrchr(ss
, ' ') == NULL
)
3242 tree_node
*t
= tree_search(acl_anchor
, ss
);
3245 acl
= (acl_block
*)(t
->data
.ptr
);
3248 HDEBUG(D_acl
) debug_printf("ACL \"%s\" is empty: implicit DENY\n", ss
);
3251 acl_name
= string_sprintf("ACL \"%s\"", ss
);
3252 HDEBUG(D_acl
) debug_printf("using ACL \"%s\"\n", ss
);
3255 else if (*ss
== '/')
3257 struct stat statbuf
;
3258 fd
= Uopen(ss
, O_RDONLY
, 0);
3261 *log_msgptr
= string_sprintf("failed to open ACL file \"%s\": %s", ss
,
3266 if (fstat(fd
, &statbuf
) != 0)
3268 *log_msgptr
= string_sprintf("failed to fstat ACL file \"%s\": %s", ss
,
3273 acl_text
= store_get(statbuf
.st_size
+ 1);
3274 acl_text_end
= acl_text
+ statbuf
.st_size
+ 1;
3276 if (read(fd
, acl_text
, statbuf
.st_size
) != statbuf
.st_size
)
3278 *log_msgptr
= string_sprintf("failed to read ACL file \"%s\": %s",
3279 ss
, strerror(errno
));
3282 acl_text
[statbuf
.st_size
] = 0;
3285 acl_name
= string_sprintf("ACL \"%s\"", ss
);
3286 HDEBUG(D_acl
) debug_printf("read ACL from file %s\n", ss
);
3290 /* Parse an ACL that is still in text form. If it came from a file, remember it
3291 in the ACL tree, having read it into the POOL_PERM store pool so that it
3292 persists between multiple messages. */
3296 int old_pool
= store_pool
;
3297 if (fd
>= 0) store_pool
= POOL_PERM
;
3298 acl
= acl_read(acl_getline
, log_msgptr
);
3299 store_pool
= old_pool
;
3300 if (acl
== NULL
&& *log_msgptr
!= NULL
) return ERROR
;
3303 tree_node
*t
= store_get_perm(sizeof(tree_node
) + Ustrlen(ss
));
3304 Ustrcpy(t
->name
, ss
);
3306 (void)tree_insertnode(&acl_anchor
, t
);
3310 /* Now we have an ACL to use. It's possible it may be NULL. */
3315 int basic_errno
= 0;
3316 BOOL endpass_seen
= FALSE
;
3318 *log_msgptr
= *user_msgptr
= NULL
;
3319 acl_temp_details
= FALSE
;
3321 if (where
== ACL_WHERE_QUIT
&&
3322 acl
->verb
!= ACL_ACCEPT
&&
3323 acl
->verb
!= ACL_WARN
)
3325 *log_msgptr
= string_sprintf("\"%s\" is not allowed in a QUIT ACL",
3330 HDEBUG(D_acl
) debug_printf("processing \"%s\"\n", verbs
[acl
->verb
]);
3332 /* Clear out any search error message from a previous check before testing
3335 search_error_message
= NULL
;
3336 cond
= acl_check_condition(acl
->verb
, acl
->condition
, where
, addr
, level
,
3337 &endpass_seen
, user_msgptr
, log_msgptr
, &basic_errno
);
3339 /* Handle special returns: DEFER causes a return except on a WARN verb;
3340 ERROR always causes a return. */
3345 HDEBUG(D_acl
) debug_printf("%s: condition test deferred\n", verbs
[acl
->verb
]);
3346 if (basic_errno
!= ERRNO_CALLOUTDEFER
)
3348 if (search_error_message
!= NULL
&& *search_error_message
!= 0)
3349 *log_msgptr
= search_error_message
;
3350 if (smtp_return_error_details
) acl_temp_details
= TRUE
;
3354 acl_temp_details
= TRUE
;
3356 if (acl
->verb
!= ACL_WARN
) return DEFER
;
3359 default: /* Paranoia */
3361 HDEBUG(D_acl
) debug_printf("%s: condition test error\n", verbs
[acl
->verb
]);
3365 HDEBUG(D_acl
) debug_printf("%s: condition test succeeded\n",
3370 HDEBUG(D_acl
) debug_printf("%s: condition test failed\n", verbs
[acl
->verb
]);
3373 /* DISCARD and DROP can happen only from a nested ACL condition, and
3374 DISCARD can happen only for an "accept" or "discard" verb. */
3377 HDEBUG(D_acl
) debug_printf("%s: condition test yielded \"discard\"\n",
3382 HDEBUG(D_acl
) debug_printf("%s: condition test yielded \"drop\"\n",
3387 /* At this point, cond for most verbs is either OK or FAIL or (as a result of
3388 a nested ACL condition) FAIL_DROP. However, for WARN, cond may be DEFER, and
3389 for ACCEPT and DISCARD, it may be DISCARD after a nested ACL call. */
3394 if (cond
== OK
|| cond
== DISCARD
) return cond
;
3397 HDEBUG(D_acl
) debug_printf("accept: endpass encountered - denying access\n");
3405 acl_temp_details
= TRUE
;
3411 if (cond
== OK
) return FAIL
;
3415 if (cond
== OK
|| cond
== DISCARD
) return DISCARD
;
3418 HDEBUG(D_acl
) debug_printf("discard: endpass encountered - denying access\n");
3424 if (cond
== OK
) return FAIL_DROP
;
3428 if (cond
!= OK
) return cond
;
3433 acl_warn(where
, *user_msgptr
, *log_msgptr
);
3434 else if (cond
== DEFER
&& (log_extra_selector
& LX_acl_warn_skipped
) != 0)
3435 log_write(0, LOG_MAIN
, "%s Warning: ACL \"warn\" statement skipped: "
3436 "condition test deferred%s%s", host_and_ident(TRUE
),
3437 (*log_msgptr
== NULL
)? US
"" : US
": ",
3438 (*log_msgptr
== NULL
)? US
"" : *log_msgptr
);
3439 *log_msgptr
= *user_msgptr
= NULL
; /* In case implicit DENY follows */
3443 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "internal ACL error: unknown verb %d",
3448 /* Pass to the next ACL item */
3453 /* We have reached the end of the ACL. This is an implicit DENY. */
3455 HDEBUG(D_acl
) debug_printf("end of %s: implicit DENY\n", acl_name
);
3460 /*************************************************
3461 * Check access using an ACL *
3462 *************************************************/
3464 /* This is the external interface for ACL checks. It sets up an address and the
3465 expansions for $domain and $local_part when called after RCPT, then calls
3466 acl_check_internal() to do the actual work.
3469 where ACL_WHERE_xxxx indicating where called from
3470 recipient RCPT address for RCPT check, else NULL
3471 s the input string; NULL is the same as an empty ACL => DENY
3472 user_msgptr where to put a user error (for SMTP response)
3473 log_msgptr where to put a logging message (not for SMTP response)
3475 Returns: OK access is granted by an ACCEPT verb
3476 DISCARD access is granted by a DISCARD verb
3477 FAIL access is denied
3478 FAIL_DROP access is denied; drop the connection
3479 DEFER can't tell at the moment
3484 acl_check(int where
, uschar
*recipient
, uschar
*s
, uschar
**user_msgptr
,
3485 uschar
**log_msgptr
)
3489 address_item
*addr
= NULL
;
3491 *user_msgptr
= *log_msgptr
= NULL
;
3492 sender_verified_failed
= NULL
;
3493 ratelimiters_cmd
= NULL
;
3495 if (where
== ACL_WHERE_RCPT
)
3497 adb
= address_defaults
;
3499 addr
->address
= recipient
;
3500 if (deliver_split_address(addr
) == DEFER
)
3502 *log_msgptr
= US
"defer in percent_hack_domains check";
3505 deliver_domain
= addr
->domain
;
3506 deliver_localpart
= addr
->local_part
;
3509 rc
= acl_check_internal(where
, addr
, s
, 0, user_msgptr
, log_msgptr
);
3511 deliver_domain
= deliver_localpart
= deliver_address_data
=
3512 sender_address_data
= NULL
;
3514 /* A DISCARD response is permitted only for message ACLs, excluding the PREDATA
3515 ACL, which is really in the middle of an SMTP command. */
3519 if (where
> ACL_WHERE_NOTSMTP
|| where
== ACL_WHERE_PREDATA
)
3521 log_write(0, LOG_MAIN
|LOG_PANIC
, "\"discard\" verb not allowed in %s "
3522 "ACL", acl_wherenames
[where
]);
3528 /* A DROP response is not permitted from MAILAUTH */
3530 if (rc
== FAIL_DROP
&& where
== ACL_WHERE_MAILAUTH
)
3532 log_write(0, LOG_MAIN
|LOG_PANIC
, "\"drop\" verb not allowed in %s "
3533 "ACL", acl_wherenames
[where
]);
3537 /* Before giving an error response, take a look at the length of any user
3538 message, and split it up into multiple lines if possible. */
3540 if (rc
!= OK
&& *user_msgptr
!= NULL
&& Ustrlen(*user_msgptr
) > 75)
3542 uschar
*s
= *user_msgptr
= string_copy(*user_msgptr
);
3548 while (i
< 75 && *ss
!= 0 && *ss
!= '\n') ss
++, i
++;
3549 if (*ss
== 0) break;
3556 while (--t
> s
+ 35)
3560 if (t
[-1] == ':') { tt
= t
; break; }
3561 if (tt
== NULL
) tt
= t
;
3565 if (tt
== NULL
) /* Can't split behind - try ahead */
3570 if (*t
== ' ' || *t
== '\n')
3576 if (tt
== NULL
) break; /* Can't find anywhere to split */
projects / exim.git / blob