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