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