src/src/acl.c

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