src/src/expand.c

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) The Exim Maintainers 2020 - 2024 */
   6 /* Copyright (c) University of Cambridge 1995 - 2018 */
   7 /* See the file NOTICE for conditions of use and distribution. */
   8 /* SPDX-License-Identifier: GPL-2.0-or-later */
   9
  10
  11 /* Functions for handling string expansion. */
  12
  13
  14 #include "exim.h"
  15
  16 #ifdef MACRO_PREDEF
  17 # include "macro_predef.h"
  18 #endif
  19
  20 typedef unsigned esi_flags;
  21 #define ESI_NOFLAGS             0
  22 #define ESI_BRACE_ENDS          BIT(0)  /* expansion should stop at } */
  23 #define ESI_HONOR_DOLLAR        BIT(1)  /* $ is meaningfull */
  24 #define ESI_SKIPPING            BIT(2)  /* value will not be needed */
  25 #define ESI_EXISTS_ONLY         BIT(3)  /* actual value not needed */
  26
  27 #ifdef STAND_ALONE
  28 # ifndef SUPPORT_CRYPTEQ
  29 #  define SUPPORT_CRYPTEQ
  30 # endif
  31 #endif  /*!STAND_ALONE*/
  32
  33 #ifdef LOOKUP_LDAP
  34 # include "lookups/ldap.h"
  35 #endif
  36
  37 #ifdef SUPPORT_CRYPTEQ
  38 # ifdef CRYPT_H
  39 #  include <crypt.h>
  40 # endif
  41 # ifndef HAVE_CRYPT16
  42 extern char* crypt16(char*, char*);
  43 # endif
  44 #endif
  45
  46 /* The handling of crypt16() is a mess. I will record below the analysis of the
  47 mess that was sent to me. We decided, however, to make changing this very low
  48 priority, because in practice people are moving away from the crypt()
  49 algorithms nowadays, so it doesn't seem worth it.
  50
  51 <quote>
  52 There is an algorithm named "crypt16" in Ultrix and Tru64.  It crypts
  53 the first 8 characters of the password using a 20-round version of crypt
  54 (standard crypt does 25 rounds).  It then crypts the next 8 characters,
  55 or an empty block if the password is less than 9 characters, using a
  56 20-round version of crypt and the same salt as was used for the first
  57 block.  Characters after the first 16 are ignored.  It always generates
  58 a 16-byte hash, which is expressed together with the salt as a string
  59 of 24 base 64 digits.  Here are some links to peruse:
  60
  61         http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
  62         http://seclists.org/bugtraq/1999/Mar/0076.html
  63
  64 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
  65 and OSF/1.  This is the same as the standard crypt if given a password
  66 of 8 characters or less.  If given more, it first does the same as crypt
  67 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
  68 using as salt the first two base 64 digits from the first hash block.
  69 If the password is more than 16 characters then it crypts the 17th to 24th
  70 characters using as salt the first two base 64 digits from the second hash
  71 block.  And so on: I've seen references to it cutting off the password at
  72 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks).  Some links:
  73
  74         http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
  75         http://seclists.org/bugtraq/1999/Mar/0109.html
  76         http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
  77              TET1_html/sec.c222.html#no_id_208
  78
  79 Exim has something it calls "crypt16".  It will either use a native
  80 crypt16 or its own implementation.  A native crypt16 will presumably
  81 be the one that I called "crypt16" above.  The internal "crypt16"
  82 function, however, is a two-block-maximum implementation of what I called
  83 "bigcrypt".  The documentation matches the internal code.
  84
  85 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
  86 that crypt16 and bigcrypt were different things.
  87
  88 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
  89 to whatever it is using under that name.  This unfortunately sets a
  90 precedent for using "{crypt16}" to identify two incompatible algorithms
  91 whose output can't be distinguished.  With "{crypt16}" thus rendered
  92 ambiguous, I suggest you deprecate it and invent two new identifiers
  93 for the two algorithms.
  94
  95 Both crypt16 and bigcrypt are very poor algorithms, btw.  Hashing parts
  96 of the password separately means they can be cracked separately, so
  97 the double-length hash only doubles the cracking effort instead of
  98 squaring it.  I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
  99 bcrypt ({CRYPT}$2a$).
 100 </quote>
 101 */
 102
 103
 104
 105 /*************************************************
 106 *            Local statics and tables            *
 107 *************************************************/
 108
 109 /* Table of item names, and corresponding switch numbers. The names must be in
 110 alphabetical order. */
 111
 112 static uschar *item_table[] = {
 113   US"acl",
 114   US"authresults",
 115   US"certextract",
 116   US"dlfunc",
 117   US"env",
 118   US"extract",
 119   US"filter",
 120   US"hash",
 121   US"hmac",
 122   US"if",
 123 #ifdef SUPPORT_I18N
 124   US"imapfolder",
 125 #endif
 126   US"length",
 127   US"listextract",
 128   US"listquote",
 129   US"lookup",
 130   US"map",
 131   US"nhash",
 132   US"perl",
 133   US"prvs",
 134   US"prvscheck",
 135   US"readfile",
 136   US"readsocket",
 137   US"reduce",
 138   US"run",
 139   US"sg",
 140   US"sort",
 141 #ifdef SUPPORT_SRS
 142   US"srs_encode",
 143 #endif
 144   US"substr",
 145   US"tr" };
 146
 147 enum {
 148   EITEM_ACL,
 149   EITEM_AUTHRESULTS,
 150   EITEM_CERTEXTRACT,
 151   EITEM_DLFUNC,
 152   EITEM_ENV,
 153   EITEM_EXTRACT,
 154   EITEM_FILTER,
 155   EITEM_HASH,
 156   EITEM_HMAC,
 157   EITEM_IF,
 158 #ifdef SUPPORT_I18N
 159   EITEM_IMAPFOLDER,
 160 #endif
 161   EITEM_LENGTH,
 162   EITEM_LISTEXTRACT,
 163   EITEM_LISTQUOTE,
 164   EITEM_LOOKUP,
 165   EITEM_MAP,
 166   EITEM_NHASH,
 167   EITEM_PERL,
 168   EITEM_PRVS,
 169   EITEM_PRVSCHECK,
 170   EITEM_READFILE,
 171   EITEM_READSOCK,
 172   EITEM_REDUCE,
 173   EITEM_RUN,
 174   EITEM_SG,
 175   EITEM_SORT,
 176 #ifdef SUPPORT_SRS
 177   EITEM_SRS_ENCODE,
 178 #endif
 179   EITEM_SUBSTR,
 180   EITEM_TR };
 181
 182 /* Tables of operator names, and corresponding switch numbers. The names must be
 183 in alphabetical order. There are two tables, because underscore is used in some
 184 cases to introduce arguments, whereas for other it is part of the name. This is
 185 an historical mis-design. */
 186
 187 static uschar * op_table_underscore[] = {
 188   US"from_utf8",
 189   US"local_part",
 190   US"quote_local_part",
 191   US"reverse_ip",
 192   US"time_eval",
 193   US"time_interval"
 194 #ifdef SUPPORT_I18N
 195  ,US"utf8_domain_from_alabel",
 196   US"utf8_domain_to_alabel",
 197   US"utf8_localpart_from_alabel",
 198   US"utf8_localpart_to_alabel"
 199 #endif
 200   };
 201
 202 enum {
 203   EOP_FROM_UTF8,
 204   EOP_LOCAL_PART,
 205   EOP_QUOTE_LOCAL_PART,
 206   EOP_REVERSE_IP,
 207   EOP_TIME_EVAL,
 208   EOP_TIME_INTERVAL
 209 #ifdef SUPPORT_I18N
 210  ,EOP_UTF8_DOMAIN_FROM_ALABEL,
 211   EOP_UTF8_DOMAIN_TO_ALABEL,
 212   EOP_UTF8_LOCALPART_FROM_ALABEL,
 213   EOP_UTF8_LOCALPART_TO_ALABEL
 214 #endif
 215   };
 216
 217 static uschar *op_table_main[] = {
 218   US"address",
 219   US"addresses",
 220   US"base32",
 221   US"base32d",
 222   US"base62",
 223   US"base62d",
 224   US"base64",
 225   US"base64d",
 226   US"domain",
 227   US"escape",
 228   US"escape8bit",
 229   US"eval",
 230   US"eval10",
 231   US"expand",
 232   US"h",
 233   US"hash",
 234   US"headerwrap",
 235   US"hex2b64",
 236   US"hexquote",
 237   US"ipv6denorm",
 238   US"ipv6norm",
 239   US"l",
 240   US"lc",
 241   US"length",
 242   US"listcount",
 243   US"listnamed",
 244   US"mask",
 245   US"md5",
 246   US"nh",
 247   US"nhash",
 248   US"quote",
 249   US"randint",
 250   US"rfc2047",
 251   US"rfc2047d",
 252   US"rxquote",
 253   US"s",
 254   US"sha1",
 255   US"sha2",
 256   US"sha256",
 257   US"sha3",
 258   US"stat",
 259   US"str2b64",
 260   US"strlen",
 261   US"substr",
 262   US"uc",
 263   US"utf8clean",
 264   US"xtextd",
 265   };
 266
 267 enum {
 268   EOP_ADDRESS =  nelem(op_table_underscore),
 269   EOP_ADDRESSES,
 270   EOP_BASE32,
 271   EOP_BASE32D,
 272   EOP_BASE62,
 273   EOP_BASE62D,
 274   EOP_BASE64,
 275   EOP_BASE64D,
 276   EOP_DOMAIN,
 277   EOP_ESCAPE,
 278   EOP_ESCAPE8BIT,
 279   EOP_EVAL,
 280   EOP_EVAL10,
 281   EOP_EXPAND,
 282   EOP_H,
 283   EOP_HASH,
 284   EOP_HEADERWRAP,
 285   EOP_HEX2B64,
 286   EOP_HEXQUOTE,
 287   EOP_IPV6DENORM,
 288   EOP_IPV6NORM,
 289   EOP_L,
 290   EOP_LC,
 291   EOP_LENGTH,
 292   EOP_LISTCOUNT,
 293   EOP_LISTNAMED,
 294   EOP_MASK,
 295   EOP_MD5,
 296   EOP_NH,
 297   EOP_NHASH,
 298   EOP_QUOTE,
 299   EOP_RANDINT,
 300   EOP_RFC2047,
 301   EOP_RFC2047D,
 302   EOP_RXQUOTE,
 303   EOP_S,
 304   EOP_SHA1,
 305   EOP_SHA2,
 306   EOP_SHA256,
 307   EOP_SHA3,
 308   EOP_STAT,
 309   EOP_STR2B64,
 310   EOP_STRLEN,
 311   EOP_SUBSTR,
 312   EOP_UC,
 313   EOP_UTF8CLEAN,
 314   EOP_XTEXTD,
 315   };
 316
 317
 318 /* Table of condition names, and corresponding switch numbers. The names must
 319 be in alphabetical order. */
 320
 321 static uschar *cond_table[] = {
 322   US"<",
 323   US"<=",
 324   US"=",
 325   US"==",     /* Backward compatibility */
 326   US">",
 327   US">=",
 328   US"acl",
 329   US"and",
 330   US"bool",
 331   US"bool_lax",
 332   US"crypteq",
 333   US"def",
 334   US"eq",
 335   US"eqi",
 336   US"exists",
 337   US"first_delivery",
 338   US"forall",
 339   US"forall_json",
 340   US"forall_jsons",
 341   US"forany",
 342   US"forany_json",
 343   US"forany_jsons",
 344   US"ge",
 345   US"gei",
 346   US"gt",
 347   US"gti",
 348 #ifdef SUPPORT_SRS
 349   US"inbound_srs",
 350 #endif
 351   US"inlist",
 352   US"inlisti",
 353   US"isip",
 354   US"isip4",
 355   US"isip6",
 356   US"ldapauth",
 357   US"le",
 358   US"lei",
 359   US"lt",
 360   US"lti",
 361   US"match",
 362   US"match_address",
 363   US"match_domain",
 364   US"match_ip",
 365   US"match_local_part",
 366   US"or",
 367   US"pam",
 368   US"pwcheck",
 369   US"queue_running",
 370   US"radius",
 371   US"saslauthd"
 372 };
 373
 374 enum {
 375   ECOND_NUM_L,
 376   ECOND_NUM_LE,
 377   ECOND_NUM_E,
 378   ECOND_NUM_EE,
 379   ECOND_NUM_G,
 380   ECOND_NUM_GE,
 381   ECOND_ACL,
 382   ECOND_AND,
 383   ECOND_BOOL,
 384   ECOND_BOOL_LAX,
 385   ECOND_CRYPTEQ,
 386   ECOND_DEF,
 387   ECOND_STR_EQ,
 388   ECOND_STR_EQI,
 389   ECOND_EXISTS,
 390   ECOND_FIRST_DELIVERY,
 391   ECOND_FORALL,
 392   ECOND_FORALL_JSON,
 393   ECOND_FORALL_JSONS,
 394   ECOND_FORANY,
 395   ECOND_FORANY_JSON,
 396   ECOND_FORANY_JSONS,
 397   ECOND_STR_GE,
 398   ECOND_STR_GEI,
 399   ECOND_STR_GT,
 400   ECOND_STR_GTI,
 401 #ifdef SUPPORT_SRS
 402   ECOND_INBOUND_SRS,
 403 #endif
 404   ECOND_INLIST,
 405   ECOND_INLISTI,
 406   ECOND_ISIP,
 407   ECOND_ISIP4,
 408   ECOND_ISIP6,
 409   ECOND_LDAPAUTH,
 410   ECOND_STR_LE,
 411   ECOND_STR_LEI,
 412   ECOND_STR_LT,
 413   ECOND_STR_LTI,
 414   ECOND_MATCH,
 415   ECOND_MATCH_ADDRESS,
 416   ECOND_MATCH_DOMAIN,
 417   ECOND_MATCH_IP,
 418   ECOND_MATCH_LOCAL_PART,
 419   ECOND_OR,
 420   ECOND_PAM,
 421   ECOND_PWCHECK,
 422   ECOND_QUEUE_RUNNING,
 423   ECOND_RADIUS,
 424   ECOND_SASLAUTHD
 425 };
 426
 427
 428 /* Types of table entry */
 429
 430 enum vtypes {
 431   vtype_int,            /* value is address of int */
 432   vtype_filter_int,     /* ditto, but recognized only when filtering */
 433   vtype_ino,            /* value is address of ino_t (not always an int) */
 434   vtype_uid,            /* value is address of uid_t (not always an int) */
 435   vtype_gid,            /* value is address of gid_t (not always an int) */
 436   vtype_bool,           /* value is address of bool */
 437   vtype_stringptr,      /* value is address of pointer to string */
 438   vtype_msgbody,        /* as stringptr, but read when first required */
 439   vtype_msgbody_end,    /* ditto, the end of the message */
 440   vtype_msgheaders,     /* the message's headers, processed */
 441   vtype_msgheaders_raw, /* the message's headers, unprocessed */
 442   vtype_localpart,      /* extract local part from string */
 443   vtype_domain,         /* extract domain from string */
 444   vtype_string_func,    /* value is string returned by given function */
 445   vtype_todbsdin,       /* value not used; generate BSD inbox tod */
 446   vtype_tode,           /* value not used; generate tod in epoch format */
 447   vtype_todel,          /* value not used; generate tod in epoch/usec format */
 448   vtype_todf,           /* value not used; generate full tod */
 449   vtype_todl,           /* value not used; generate log tod */
 450   vtype_todlf,          /* value not used; generate log file datestamp tod */
 451   vtype_todzone,        /* value not used; generate time zone only */
 452   vtype_todzulu,        /* value not used; generate zulu tod */
 453   vtype_reply,          /* value not used; get reply from headers */
 454   vtype_pid,            /* value not used; result is pid */
 455   vtype_host_lookup,    /* value not used; get host name */
 456   vtype_load_avg,       /* value not used; result is int from os_getloadavg */
 457   vtype_pspace,         /* partition space; value is T/F for spool/log */
 458   vtype_pinodes,        /* partition inodes; value is T/F for spool/log */
 459   vtype_cert            /* SSL certificate */
 460 #ifndef DISABLE_DKIM
 461   ,vtype_dkim           /* Lookup of value in DKIM signature */
 462 #endif
 463 };
 464
 465 /* Type for main variable table */
 466
 467 typedef struct {
 468   const char *name;
 469   enum vtypes type;
 470   void       *value;
 471 } var_entry;
 472
 473 /* Type for entries pointing to address/length pairs. Not currently
 474 in use. */
 475
 476 typedef struct {
 477   uschar **address;
 478   int  *length;
 479 } alblock;
 480
 481 typedef uschar * stringptr_fn_t(void);
 482 static uschar * fn_recipients(void);
 483 static uschar * fn_recipients_list(void);
 484 static uschar * fn_queue_size(void);
 485
 486 /* This table must be kept in alphabetical order. */
 487
 488 static var_entry var_table[] = {
 489   /* WARNING: Do not invent variables whose names start acl_c or acl_m because
 490      they will be confused with user-creatable ACL variables. */
 491   { "acl_arg1",            vtype_stringptr,   &acl_arg[0] },
 492   { "acl_arg2",            vtype_stringptr,   &acl_arg[1] },
 493   { "acl_arg3",            vtype_stringptr,   &acl_arg[2] },
 494   { "acl_arg4",            vtype_stringptr,   &acl_arg[3] },
 495   { "acl_arg5",            vtype_stringptr,   &acl_arg[4] },
 496   { "acl_arg6",            vtype_stringptr,   &acl_arg[5] },
 497   { "acl_arg7",            vtype_stringptr,   &acl_arg[6] },
 498   { "acl_arg8",            vtype_stringptr,   &acl_arg[7] },
 499   { "acl_arg9",            vtype_stringptr,   &acl_arg[8] },
 500   { "acl_narg",            vtype_int,         &acl_narg },
 501   { "acl_verify_message",  vtype_stringptr,   &acl_verify_message },
 502   { "address_data",        vtype_stringptr,   &deliver_address_data },
 503   { "address_file",        vtype_stringptr,   &address_file },
 504   { "address_pipe",        vtype_stringptr,   &address_pipe },
 505 #ifdef EXPERIMENTAL_ARC
 506   { "arc_domains",         vtype_string_func, (void *) &fn_arc_domains },
 507   { "arc_oldest_pass",     vtype_int,         &arc_oldest_pass },
 508   { "arc_state",           vtype_stringptr,   &arc_state },
 509   { "arc_state_reason",    vtype_stringptr,   &arc_state_reason },
 510 #endif
 511   { "authenticated_fail_id",vtype_stringptr,  &authenticated_fail_id },
 512   { "authenticated_id",    vtype_stringptr,   &authenticated_id },
 513   { "authenticated_sender",vtype_stringptr,   &authenticated_sender },
 514   { "authentication_failed",vtype_int,        &authentication_failed },
 515 #ifdef WITH_CONTENT_SCAN
 516   { "av_failed",           vtype_int,         &av_failed },
 517 #endif
 518 #ifdef EXPERIMENTAL_BRIGHTMAIL
 519   { "bmi_alt_location",    vtype_stringptr,   &bmi_alt_location },
 520   { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
 521   { "bmi_base64_verdict",  vtype_stringptr,   &bmi_base64_verdict },
 522   { "bmi_deliver",         vtype_int,         &bmi_deliver },
 523 #endif
 524   { "body_linecount",      vtype_int,         &body_linecount },
 525   { "body_zerocount",      vtype_int,         &body_zerocount },
 526   { "bounce_recipient",    vtype_stringptr,   &bounce_recipient },
 527   { "bounce_return_size_limit", vtype_int,    &bounce_return_size_limit },
 528   { "caller_gid",          vtype_gid,         &real_gid },
 529   { "caller_uid",          vtype_uid,         &real_uid },
 530   { "callout_address",     vtype_stringptr,   &callout_address },
 531   { "compile_date",        vtype_stringptr,   &version_date },
 532   { "compile_number",      vtype_stringptr,   &version_cnumber },
 533   { "config_dir",          vtype_stringptr,   &config_main_directory },
 534   { "config_file",         vtype_stringptr,   &config_main_filename },
 535   { "connection_id",       vtype_stringptr,   &connection_id },
 536   { "csa_status",          vtype_stringptr,   &csa_status },
 537 #ifdef EXPERIMENTAL_DCC
 538   { "dcc_header",          vtype_stringptr,   &dcc_header },
 539   { "dcc_result",          vtype_stringptr,   &dcc_result },
 540 #endif
 541 #ifndef DISABLE_DKIM
 542   { "dkim_algo",           vtype_dkim,        (void *)DKIM_ALGO },
 543   { "dkim_bodylength",     vtype_dkim,        (void *)DKIM_BODYLENGTH },
 544   { "dkim_canon_body",     vtype_dkim,        (void *)DKIM_CANON_BODY },
 545   { "dkim_canon_headers",  vtype_dkim,        (void *)DKIM_CANON_HEADERS },
 546   { "dkim_copiedheaders",  vtype_dkim,        (void *)DKIM_COPIEDHEADERS },
 547   { "dkim_created",        vtype_dkim,        (void *)DKIM_CREATED },
 548   { "dkim_cur_signer",     vtype_stringptr,   &dkim_cur_signer },
 549   { "dkim_domain",         vtype_stringptr,   &dkim_signing_domain },
 550   { "dkim_expires",        vtype_dkim,        (void *)DKIM_EXPIRES },
 551   { "dkim_headernames",    vtype_dkim,        (void *)DKIM_HEADERNAMES },
 552   { "dkim_identity",       vtype_dkim,        (void *)DKIM_IDENTITY },
 553   { "dkim_key_granularity",vtype_dkim,        (void *)DKIM_KEY_GRANULARITY },
 554   { "dkim_key_length",     vtype_int,         &dkim_key_length },
 555   { "dkim_key_nosubdomains",vtype_dkim,       (void *)DKIM_NOSUBDOMAINS },
 556   { "dkim_key_notes",      vtype_dkim,        (void *)DKIM_KEY_NOTES },
 557   { "dkim_key_srvtype",    vtype_dkim,        (void *)DKIM_KEY_SRVTYPE },
 558   { "dkim_key_testing",    vtype_dkim,        (void *)DKIM_KEY_TESTING },
 559   { "dkim_selector",       vtype_stringptr,   &dkim_signing_selector },
 560   { "dkim_signers",        vtype_stringptr,   &dkim_signers },
 561   { "dkim_verify_reason",  vtype_stringptr,   &dkim_verify_reason },
 562   { "dkim_verify_status",  vtype_stringptr,   &dkim_verify_status },
 563 #endif
 564 #ifdef SUPPORT_DMARC
 565   { "dmarc_domain_policy", vtype_stringptr,   &dmarc_domain_policy },
 566   { "dmarc_status",        vtype_stringptr,   &dmarc_status },
 567   { "dmarc_status_text",   vtype_stringptr,   &dmarc_status_text },
 568   { "dmarc_used_domain",   vtype_stringptr,   &dmarc_used_domain },
 569 #endif
 570   { "dnslist_domain",      vtype_stringptr,   &dnslist_domain },
 571   { "dnslist_matched",     vtype_stringptr,   &dnslist_matched },
 572   { "dnslist_text",        vtype_stringptr,   &dnslist_text },
 573   { "dnslist_value",       vtype_stringptr,   &dnslist_value },
 574   { "domain",              vtype_stringptr,   &deliver_domain },
 575   { "domain_data",         vtype_stringptr,   &deliver_domain_data },
 576 #ifndef DISABLE_EVENT
 577   { "event_data",          vtype_stringptr,   &event_data },
 578
 579   /*XXX want to use generic vars for as many of these as possible*/
 580   { "event_defer_errno",   vtype_int,         &event_defer_errno },
 581
 582   { "event_name",          vtype_stringptr,   &event_name },
 583 #endif
 584   { "exim_gid",            vtype_gid,         &exim_gid },
 585   { "exim_path",           vtype_stringptr,   &exim_path },
 586   { "exim_uid",            vtype_uid,         &exim_uid },
 587   { "exim_version",        vtype_stringptr,   &version_string },
 588   { "headers_added",       vtype_string_func, (void *) &fn_hdrs_added },
 589   { "home",                vtype_stringptr,   &deliver_home },
 590   { "host",                vtype_stringptr,   &deliver_host },
 591   { "host_address",        vtype_stringptr,   &deliver_host_address },
 592   { "host_data",           vtype_stringptr,   &host_data },
 593   { "host_lookup_deferred",vtype_int,         &host_lookup_deferred },
 594   { "host_lookup_failed",  vtype_int,         &host_lookup_failed },
 595   { "host_port",           vtype_int,         &deliver_host_port },
 596   { "initial_cwd",         vtype_stringptr,   &initial_cwd },
 597   { "inode",               vtype_ino,         &deliver_inode },
 598   { "interface_address",   vtype_stringptr,   &interface_address },
 599   { "interface_port",      vtype_int,         &interface_port },
 600   { "item",                vtype_stringptr,   &iterate_item },
 601 #ifdef LOOKUP_LDAP
 602   { "ldap_dn",             vtype_stringptr,   &eldap_dn },
 603 #endif
 604   { "load_average",        vtype_load_avg,    NULL },
 605   { "local_part",          vtype_stringptr,   &deliver_localpart },
 606   { "local_part_data",     vtype_stringptr,   &deliver_localpart_data },
 607   { "local_part_prefix",   vtype_stringptr,   &deliver_localpart_prefix },
 608   { "local_part_prefix_v", vtype_stringptr,   &deliver_localpart_prefix_v },
 609   { "local_part_suffix",   vtype_stringptr,   &deliver_localpart_suffix },
 610   { "local_part_suffix_v", vtype_stringptr,   &deliver_localpart_suffix_v },
 611 #ifdef HAVE_LOCAL_SCAN
 612   { "local_scan_data",     vtype_stringptr,   &local_scan_data },
 613 #endif
 614   { "local_user_gid",      vtype_gid,         &local_user_gid },
 615   { "local_user_uid",      vtype_uid,         &local_user_uid },
 616   { "localhost_number",    vtype_int,         &host_number },
 617   { "log_inodes",          vtype_pinodes,     (void *)FALSE },
 618   { "log_space",           vtype_pspace,      (void *)FALSE },
 619   { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
 620   { "mailstore_basename",  vtype_stringptr,   &mailstore_basename },
 621 #ifdef WITH_CONTENT_SCAN
 622   { "malware_name",        vtype_stringptr,   &malware_name },
 623 #endif
 624   { "max_received_linelength", vtype_int,     &max_received_linelength },
 625   { "message_age",         vtype_int,         &message_age },
 626   { "message_body",        vtype_msgbody,     &message_body },
 627   { "message_body_end",    vtype_msgbody_end, &message_body_end },
 628   { "message_body_size",   vtype_int,         &message_body_size },
 629   { "message_exim_id",     vtype_stringptr,   &message_id },
 630   { "message_headers",     vtype_msgheaders,  NULL },
 631   { "message_headers_raw", vtype_msgheaders_raw, NULL },
 632   { "message_id",          vtype_stringptr,   &message_id },
 633   { "message_linecount",   vtype_int,         &message_linecount },
 634   { "message_size",        vtype_int,         &message_size },
 635 #ifdef SUPPORT_I18N
 636   { "message_smtputf8",    vtype_bool,        &message_smtputf8 },
 637 #endif
 638 #ifdef WITH_CONTENT_SCAN
 639   { "mime_anomaly_level",  vtype_int,         &mime_anomaly_level },
 640   { "mime_anomaly_text",   vtype_stringptr,   &mime_anomaly_text },
 641   { "mime_boundary",       vtype_stringptr,   &mime_boundary },
 642   { "mime_charset",        vtype_stringptr,   &mime_charset },
 643   { "mime_content_description", vtype_stringptr, &mime_content_description },
 644   { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
 645   { "mime_content_id",     vtype_stringptr,   &mime_content_id },
 646   { "mime_content_size",   vtype_int,         &mime_content_size },
 647   { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
 648   { "mime_content_type",   vtype_stringptr,   &mime_content_type },
 649   { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
 650   { "mime_filename",       vtype_stringptr,   &mime_filename },
 651   { "mime_is_coverletter", vtype_int,         &mime_is_coverletter },
 652   { "mime_is_multipart",   vtype_int,         &mime_is_multipart },
 653   { "mime_is_rfc822",      vtype_int,         &mime_is_rfc822 },
 654   { "mime_part_count",     vtype_int,         &mime_part_count },
 655 #endif
 656   { "n0",                  vtype_filter_int,  &filter_n[0] },
 657   { "n1",                  vtype_filter_int,  &filter_n[1] },
 658   { "n2",                  vtype_filter_int,  &filter_n[2] },
 659   { "n3",                  vtype_filter_int,  &filter_n[3] },
 660   { "n4",                  vtype_filter_int,  &filter_n[4] },
 661   { "n5",                  vtype_filter_int,  &filter_n[5] },
 662   { "n6",                  vtype_filter_int,  &filter_n[6] },
 663   { "n7",                  vtype_filter_int,  &filter_n[7] },
 664   { "n8",                  vtype_filter_int,  &filter_n[8] },
 665   { "n9",                  vtype_filter_int,  &filter_n[9] },
 666   { "original_domain",     vtype_stringptr,   &deliver_domain_orig },
 667   { "original_local_part", vtype_stringptr,   &deliver_localpart_orig },
 668   { "originator_gid",      vtype_gid,         &originator_gid },
 669   { "originator_uid",      vtype_uid,         &originator_uid },
 670   { "parent_domain",       vtype_stringptr,   &deliver_domain_parent },
 671   { "parent_local_part",   vtype_stringptr,   &deliver_localpart_parent },
 672   { "pid",                 vtype_pid,         NULL },
 673 #ifndef DISABLE_PRDR
 674   { "prdr_requested",      vtype_bool,        &prdr_requested },
 675 #endif
 676   { "primary_hostname",    vtype_stringptr,   &primary_hostname },
 677 #if defined(SUPPORT_PROXY) || defined(SUPPORT_SOCKS)
 678   { "proxy_external_address",vtype_stringptr, &proxy_external_address },
 679   { "proxy_external_port", vtype_int,         &proxy_external_port },
 680   { "proxy_local_address", vtype_stringptr,   &proxy_local_address },
 681   { "proxy_local_port",    vtype_int,         &proxy_local_port },
 682   { "proxy_session",       vtype_bool,        &proxy_session },
 683 #endif
 684   { "prvscheck_address",   vtype_stringptr,   &prvscheck_address },
 685   { "prvscheck_keynum",    vtype_stringptr,   &prvscheck_keynum },
 686   { "prvscheck_result",    vtype_stringptr,   &prvscheck_result },
 687   { "qualify_domain",      vtype_stringptr,   &qualify_domain_sender },
 688   { "qualify_recipient",   vtype_stringptr,   &qualify_domain_recipient },
 689   { "queue_name",          vtype_stringptr,   &queue_name },
 690   { "queue_size",          vtype_string_func, (void *) &fn_queue_size },
 691   { "rcpt_count",          vtype_int,         &rcpt_count },
 692   { "rcpt_defer_count",    vtype_int,         &rcpt_defer_count },
 693   { "rcpt_fail_count",     vtype_int,         &rcpt_fail_count },
 694   { "received_count",      vtype_int,         &received_count },
 695   { "received_for",        vtype_stringptr,   &received_for },
 696   { "received_ip_address", vtype_stringptr,   &interface_address },
 697   { "received_port",       vtype_int,         &interface_port },
 698   { "received_protocol",   vtype_stringptr,   &received_protocol },
 699   { "received_time",       vtype_int,         &received_time.tv_sec },
 700   { "recipient_data",      vtype_stringptr,   &recipient_data },
 701   { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
 702   { "recipients",          vtype_string_func, (void *) &fn_recipients },
 703   { "recipients_count",    vtype_int,         &recipients_count },
 704   { "recipients_list",     vtype_string_func, (void *) &fn_recipients_list },
 705   { "regex_cachesize",     vtype_int,         &regex_cachesize },/* undocumented; devel observability */
 706 #ifdef WITH_CONTENT_SCAN
 707   { "regex_match_string",  vtype_stringptr,   &regex_match_string },
 708 #endif
 709   { "reply_address",       vtype_reply,       NULL },
 710   { "return_path",         vtype_stringptr,   &return_path },
 711   { "return_size_limit",   vtype_int,         &bounce_return_size_limit },
 712   { "router_name",         vtype_stringptr,   &router_name },
 713   { "runrc",               vtype_int,         &runrc },
 714   { "self_hostname",       vtype_stringptr,   &self_hostname },
 715   { "sender_address",      vtype_stringptr,   &sender_address },
 716   { "sender_address_data", vtype_stringptr,   &sender_address_data },
 717   { "sender_address_domain", vtype_domain,    &sender_address },
 718   { "sender_address_local_part", vtype_localpart, &sender_address },
 719   { "sender_data",         vtype_stringptr,   &sender_data },
 720   { "sender_fullhost",     vtype_stringptr,   &sender_fullhost },
 721   { "sender_helo_dnssec",  vtype_bool,        &sender_helo_dnssec },
 722   { "sender_helo_name",    vtype_stringptr,   &sender_helo_name },
 723   { "sender_helo_verified",vtype_string_func, (void *) &sender_helo_verified_boolstr },
 724   { "sender_host_address", vtype_stringptr,   &sender_host_address },
 725   { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
 726   { "sender_host_dnssec",  vtype_bool,        &sender_host_dnssec },
 727   { "sender_host_name",    vtype_host_lookup, NULL },
 728   { "sender_host_port",    vtype_int,         &sender_host_port },
 729   { "sender_ident",        vtype_stringptr,   &sender_ident },
 730   { "sender_rate",         vtype_stringptr,   &sender_rate },
 731   { "sender_rate_limit",   vtype_stringptr,   &sender_rate_limit },
 732   { "sender_rate_period",  vtype_stringptr,   &sender_rate_period },
 733   { "sender_rcvhost",      vtype_stringptr,   &sender_rcvhost },
 734   { "sender_verify_failure",vtype_stringptr,  &sender_verify_failure },
 735   { "sending_ip_address",  vtype_stringptr,   &sending_ip_address },
 736   { "sending_port",        vtype_int,         &sending_port },
 737   { "smtp_active_hostname", vtype_stringptr,  &smtp_active_hostname },
 738   { "smtp_command",        vtype_stringptr,   &smtp_cmd_buffer },
 739   { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
 740   { "smtp_command_history", vtype_string_func, (void *) &smtp_cmd_hist },
 741   { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
 742   { "smtp_notquit_reason", vtype_stringptr,   &smtp_notquit_reason },
 743   { "sn0",                 vtype_filter_int,  &filter_sn[0] },
 744   { "sn1",                 vtype_filter_int,  &filter_sn[1] },
 745   { "sn2",                 vtype_filter_int,  &filter_sn[2] },
 746   { "sn3",                 vtype_filter_int,  &filter_sn[3] },
 747   { "sn4",                 vtype_filter_int,  &filter_sn[4] },
 748   { "sn5",                 vtype_filter_int,  &filter_sn[5] },
 749   { "sn6",                 vtype_filter_int,  &filter_sn[6] },
 750   { "sn7",                 vtype_filter_int,  &filter_sn[7] },
 751   { "sn8",                 vtype_filter_int,  &filter_sn[8] },
 752   { "sn9",                 vtype_filter_int,  &filter_sn[9] },
 753 #ifdef WITH_CONTENT_SCAN
 754   { "spam_action",         vtype_stringptr,   &spam_action },
 755   { "spam_bar",            vtype_stringptr,   &spam_bar },
 756   { "spam_report",         vtype_stringptr,   &spam_report },
 757   { "spam_score",          vtype_stringptr,   &spam_score },
 758   { "spam_score_int",      vtype_stringptr,   &spam_score_int },
 759 #endif
 760 #ifdef SUPPORT_SPF
 761   { "spf_guess",           vtype_stringptr,   &spf_guess },
 762   { "spf_header_comment",  vtype_stringptr,   &spf_header_comment },
 763   { "spf_received",        vtype_stringptr,   &spf_received },
 764   { "spf_result",          vtype_stringptr,   &spf_result },
 765   { "spf_result_guessed",  vtype_bool,        &spf_result_guessed },
 766   { "spf_smtp_comment",    vtype_stringptr,   &spf_smtp_comment },
 767 #endif
 768   { "spool_directory",     vtype_stringptr,   &spool_directory },
 769   { "spool_inodes",        vtype_pinodes,     (void *)TRUE },
 770   { "spool_space",         vtype_pspace,      (void *)TRUE },
 771 #ifdef SUPPORT_SRS
 772   { "srs_recipient",       vtype_stringptr,   &srs_recipient },
 773 #endif
 774   { "thisaddress",         vtype_stringptr,   &filter_thisaddress },
 775
 776   /* The non-(in,out) variables are now deprecated */
 777   { "tls_bits",            vtype_int,         &tls_in.bits },
 778   { "tls_certificate_verified", vtype_int,    &tls_in.certificate_verified },
 779   { "tls_cipher",          vtype_stringptr,   &tls_in.cipher },
 780
 781   { "tls_in_bits",         vtype_int,         &tls_in.bits },
 782   { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
 783   { "tls_in_cipher",       vtype_stringptr,   &tls_in.cipher },
 784   { "tls_in_cipher_std",   vtype_stringptr,   &tls_in.cipher_stdname },
 785   { "tls_in_ocsp",         vtype_int,         &tls_in.ocsp },
 786   { "tls_in_ourcert",      vtype_cert,        &tls_in.ourcert },
 787   { "tls_in_peercert",     vtype_cert,        &tls_in.peercert },
 788   { "tls_in_peerdn",       vtype_stringptr,   &tls_in.peerdn },
 789 #ifndef DISABLE_TLS_RESUME
 790   { "tls_in_resumption",   vtype_int,         &tls_in.resumption },
 791 #endif
 792 #ifndef DISABLE_TLS
 793   { "tls_in_sni",          vtype_stringptr,   &tls_in.sni },
 794 #endif
 795   { "tls_in_ver",          vtype_stringptr,   &tls_in.ver },
 796   { "tls_out_bits",        vtype_int,         &tls_out.bits },
 797   { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
 798   { "tls_out_cipher",      vtype_stringptr,   &tls_out.cipher },
 799   { "tls_out_cipher_std",  vtype_stringptr,   &tls_out.cipher_stdname },
 800 #ifdef SUPPORT_DANE
 801   { "tls_out_dane",        vtype_bool,        &tls_out.dane_verified },
 802 #endif
 803   { "tls_out_ocsp",        vtype_int,         &tls_out.ocsp },
 804   { "tls_out_ourcert",     vtype_cert,        &tls_out.ourcert },
 805   { "tls_out_peercert",    vtype_cert,        &tls_out.peercert },
 806   { "tls_out_peerdn",      vtype_stringptr,   &tls_out.peerdn },
 807 #ifndef DISABLE_TLS_RESUME
 808   { "tls_out_resumption",  vtype_int,         &tls_out.resumption },
 809 #endif
 810 #ifndef DISABLE_TLS
 811   { "tls_out_sni",         vtype_stringptr,   &tls_out.sni },
 812 #endif
 813 #ifdef SUPPORT_DANE
 814   { "tls_out_tlsa_usage",  vtype_int,         &tls_out.tlsa_usage },
 815 #endif
 816   { "tls_out_ver",         vtype_stringptr,   &tls_out.ver },
 817
 818   { "tls_peerdn",          vtype_stringptr,   &tls_in.peerdn }, /* mind the alphabetical order! */
 819 #ifndef DISABLE_TLS
 820   { "tls_sni",             vtype_stringptr,   &tls_in.sni },    /* mind the alphabetical order! */
 821 #endif
 822
 823   { "tod_bsdinbox",        vtype_todbsdin,    NULL },
 824   { "tod_epoch",           vtype_tode,        NULL },
 825   { "tod_epoch_l",         vtype_todel,       NULL },
 826   { "tod_full",            vtype_todf,        NULL },
 827   { "tod_log",             vtype_todl,        NULL },
 828   { "tod_logfile",         vtype_todlf,       NULL },
 829   { "tod_zone",            vtype_todzone,     NULL },
 830   { "tod_zulu",            vtype_todzulu,     NULL },
 831   { "transport_name",      vtype_stringptr,   &transport_name },
 832   { "value",               vtype_stringptr,   &lookup_value },
 833   { "verify_mode",         vtype_stringptr,   &verify_mode },
 834   { "version_number",      vtype_stringptr,   &version_string },
 835   { "warn_message_delay",  vtype_stringptr,   &warnmsg_delay },
 836   { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
 837   { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
 838   { "warnmsg_delay",       vtype_stringptr,   &warnmsg_delay },
 839   { "warnmsg_recipient",   vtype_stringptr,   &warnmsg_recipients },
 840   { "warnmsg_recipients",  vtype_stringptr,   &warnmsg_recipients }
 841 };
 842
 843 #ifdef MACRO_PREDEF
 844
 845 /* dummies */
 846 uschar * fn_arc_domains(void) {return NULL;}
 847 uschar * fn_hdrs_added(void) {return NULL;}
 848 uschar * fn_queue_size(void) {return NULL;}
 849 uschar * fn_recipients(void) {return NULL;}
 850 uschar * fn_recipients_list(void) {return NULL;}
 851 uschar * sender_helo_verified_boolstr(void) {return NULL;}
 852 uschar * smtp_cmd_hist(void) {return NULL;}
 853
 854
 855
 856 static void
 857 expansion_items(void)
 858 {
 859 uschar buf[64];
 860 for (int i = 0; i < nelem(item_table); i++)
 861   {
 862   spf(buf, sizeof(buf), CUS"_EXP_ITEM_%T", item_table[i]);
 863   builtin_macro_create(buf);
 864   }
 865 }
 866 static void
 867 expansion_operators(void)
 868 {
 869 uschar buf[64];
 870 for (int i = 0; i < nelem(op_table_underscore); i++)
 871   {
 872   spf(buf, sizeof(buf), CUS"_EXP_OP_%T", op_table_underscore[i]);
 873   builtin_macro_create(buf);
 874   }
 875 for (int i = 0; i < nelem(op_table_main); i++)
 876   {
 877   spf(buf, sizeof(buf), CUS"_EXP_OP_%T", op_table_main[i]);
 878   builtin_macro_create(buf);
 879   }
 880 }
 881 static void
 882 expansion_conditions(void)
 883 {
 884 uschar buf[64];
 885 for (int i = 0; i < nelem(cond_table); i++)
 886   {
 887   spf(buf, sizeof(buf), CUS"_EXP_COND_%T", cond_table[i]);
 888   builtin_macro_create(buf);
 889   }
 890 }
 891 static void
 892 expansion_variables(void)
 893 {
 894 uschar buf[64];
 895 for (int i = 0; i < nelem(var_table); i++)
 896   {
 897   spf(buf, sizeof(buf), CUS"_EXP_VAR_%T", var_table[i].name);
 898   builtin_macro_create(buf);
 899   }
 900 }
 901
 902 void
 903 expansions(void)
 904 {
 905 expansion_items();
 906 expansion_operators();
 907 expansion_conditions();
 908 expansion_variables();
 909 }
 910
 911 #else   /*!MACRO_PREDEF*/
 912
 913 static uschar var_buffer[256];
 914 static BOOL malformed_header;
 915
 916 /* For textual hashes */
 917
 918 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
 919                                "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
 920                                "0123456789";
 921
 922 enum { HMAC_MD5, HMAC_SHA1 };
 923
 924 /* For numeric hashes */
 925
 926 static unsigned int prime[] = {
 927   2,   3,   5,   7,  11,  13,  17,  19,  23,  29,
 928  31,  37,  41,  43,  47,  53,  59,  61,  67,  71,
 929  73,  79,  83,  89,  97, 101, 103, 107, 109, 113};
 930
 931 /* For printing modes in symbolic form */
 932
 933 static uschar *mtable_normal[] =
 934   { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
 935
 936 static uschar *mtable_setid[] =
 937   { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
 938
 939 static uschar *mtable_sticky[] =
 940   { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
 941
 942 /* flags for find_header() */
 943 #define FH_EXISTS_ONLY  BIT(0)
 944 #define FH_WANT_RAW     BIT(1)
 945 #define FH_WANT_LIST    BIT(2)
 946
 947 /* Recursively called function */
 948 static uschar *expand_string_internal(const uschar *, esi_flags, const uschar **, BOOL *, BOOL *);
 949 static int_eximarith_t expanded_string_integer(const uschar *, BOOL);
 950
 951
 952 /*************************************************
 953 *           Tables for UTF-8 support             *
 954 *************************************************/
 955
 956 /* Table of the number of extra characters, indexed by the first character
 957 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
 958 0x3d. */
 959
 960 static uschar utf8_table1[] = {
 961   1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
 962   1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
 963   2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
 964   3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
 965
 966 /* These are the masks for the data bits in the first byte of a character,
 967 indexed by the number of additional bytes. */
 968
 969 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
 970
 971 /* Get the next UTF-8 character, advancing the pointer. */
 972
 973 #define GETUTF8INC(c, ptr) \
 974   c = *ptr++; \
 975   if ((c & 0xc0) == 0xc0) \
 976     { \
 977     int a = utf8_table1[c & 0x3f];  /* Number of additional bytes */ \
 978     int s = 6*a; \
 979     c = (c & utf8_table2[a]) << s; \
 980     while (a-- > 0) \
 981       { \
 982       s -= 6; \
 983       c |= (*ptr++ & 0x3f) << s; \
 984       } \
 985     }
 986
 987
 988
 989 static uschar * base32_chars = US"abcdefghijklmnopqrstuvwxyz234567";
 990
 991 /*************************************************
 992 *           Binary chop search on a table        *
 993 *************************************************/
 994
 995 /* This is used for matching expansion items and operators.
 996
 997 Arguments:
 998   name        the name that is being sought
 999   table       the table to search
1000   table_size  the number of items in the table
1001
1002 Returns:      the offset in the table, or -1
1003 */
1004
1005 static int
1006 chop_match(uschar *name, uschar **table, int table_size)
1007 {
1008 uschar **bot = table;
1009 uschar **top = table + table_size;
1010
1011 while (top > bot)
1012   {
1013   uschar **mid = bot + (top - bot)/2;
1014   int c = Ustrcmp(name, *mid);
1015   if (c == 0) return mid - table;
1016   if (c > 0) bot = mid + 1; else top = mid;
1017   }
1018
1019 return -1;
1020 }
1021
1022
1023
1024 /*************************************************
1025 *          Check a condition string              *
1026 *************************************************/
1027
1028 /* This function is called to expand a string, and test the result for a "true"
1029 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
1030 forced fail or lookup defer.
1031
1032 We used to release all store used, but this is not not safe due
1033 to ${dlfunc } and ${acl }.  In any case expand_string_internal()
1034 is reasonably careful to release what it can.
1035
1036 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
1037
1038 Arguments:
1039   condition     the condition string
1040   m1            text to be incorporated in panic error
1041   m2            ditto
1042
1043 Returns:        TRUE if condition is met, FALSE if not
1044 */
1045
1046 BOOL
1047 expand_check_condition(const uschar * condition,
1048   const uschar * m1, const uschar * m2)
1049 {
1050 const uschar * ss = expand_cstring(condition);
1051 if (!ss)
1052   {
1053   if (!f.expand_string_forcedfail && !f.search_find_defer)
1054     log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
1055       "for %s %s: %s", condition, m1, m2, expand_string_message);
1056   return FALSE;
1057   }
1058 return *ss && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
1059   strcmpic(ss, US"false") != 0;
1060 }
1061
1062
1063
1064
1065 /*************************************************
1066 *        Pseudo-random number generation         *
1067 *************************************************/
1068
1069 /* Pseudo-random number generation.  The result is not "expected" to be
1070 cryptographically strong but not so weak that someone will shoot themselves
1071 in the foot using it as a nonce in some email header scheme or whatever
1072 weirdness they'll twist this into.  The result should ideally handle fork().
1073
1074 However, if we're stuck unable to provide this, then we'll fall back to
1075 appallingly bad randomness.
1076
1077 If DISABLE_TLS is not defined then this will not be used except as an emergency
1078 fallback.
1079
1080 Arguments:
1081   max       range maximum
1082 Returns     a random number in range [0, max-1]
1083 */
1084
1085 #ifndef DISABLE_TLS
1086 # define vaguely_random_number vaguely_random_number_fallback
1087 #endif
1088 int
1089 vaguely_random_number(int max)
1090 {
1091 #ifndef DISABLE_TLS
1092 # undef vaguely_random_number
1093 #endif
1094 static pid_t pid = 0;
1095 pid_t p2;
1096
1097 if ((p2 = getpid()) != pid)
1098   {
1099   if (pid != 0)
1100     {
1101
1102 #ifdef HAVE_ARC4RANDOM
1103     /* cryptographically strong randomness, common on *BSD platforms, not
1104     so much elsewhere.  Alas. */
1105 # ifndef NOT_HAVE_ARC4RANDOM_STIR
1106     arc4random_stir();
1107 # endif
1108 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1109 # ifdef HAVE_SRANDOMDEV
1110     /* uses random(4) for seeding */
1111     srandomdev();
1112 # else
1113     {
1114     struct timeval tv;
1115     gettimeofday(&tv, NULL);
1116     srandom(tv.tv_sec | tv.tv_usec | getpid());
1117     }
1118 # endif
1119 #else
1120     /* Poor randomness and no seeding here */
1121 #endif
1122
1123     }
1124   pid = p2;
1125   }
1126
1127 #ifdef HAVE_ARC4RANDOM
1128 return arc4random() % max;
1129 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1130 return random() % max;
1131 #else
1132 /* This one returns a 16-bit number, definitely not crypto-strong */
1133 return random_number(max);
1134 #endif
1135 }
1136
1137
1138
1139
1140 /*************************************************
1141 *             Pick out a name from a string      *
1142 *************************************************/
1143
1144 /* If the name is too long, it is silently truncated.
1145
1146 Arguments:
1147   name      points to a buffer into which to put the name
1148   max       is the length of the buffer
1149   s         points to the first alphabetic character of the name
1150   extras    chars other than alphanumerics to permit
1151
1152 Returns:    pointer to the first character after the name
1153
1154 Note: The test for *s != 0 in the while loop is necessary because
1155 Ustrchr() yields non-NULL if the character is zero (which is not something
1156 I expected). */
1157
1158 static const uschar *
1159 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1160 {
1161 int ptr = 0;
1162 while (*s && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1163   {
1164   if (ptr < max-1) name[ptr++] = *s;
1165   s++;
1166   }
1167 name[ptr] = 0;
1168 return s;
1169 }
1170
1171
1172
1173 /*************************************************
1174 *     Pick out the rest of a header name         *
1175 *************************************************/
1176
1177 /* A variable name starting $header_ (or just $h_ for those who like
1178 abbreviations) might not be the complete header name because headers can
1179 contain any printing characters in their names, except ':'. This function is
1180 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1181 on the end, if the name was terminated by white space.
1182
1183 Arguments:
1184   name      points to a buffer in which the name read so far exists
1185   max       is the length of the buffer
1186   s         points to the first character after the name so far, i.e. the
1187             first non-alphameric character after $header_xxxxx
1188
1189 Returns:    a pointer to the first character after the header name
1190 */
1191
1192 static const uschar *
1193 read_header_name(uschar *name, int max, const uschar *s)
1194 {
1195 int prelen = Ustrchr(name, '_') - name + 1;
1196 int ptr = Ustrlen(name) - prelen;
1197 if (ptr > 0) memmove(name, name+prelen, ptr);
1198 while (mac_isgraph(*s) && *s != ':')
1199   {
1200   if (ptr < max-1) name[ptr++] = *s;
1201   s++;
1202   }
1203 if (*s == ':') s++;
1204 name[ptr++] = ':';
1205 name[ptr] = 0;
1206 return s;
1207 }
1208
1209
1210
1211 /*************************************************
1212 *           Pick out a number from a string      *
1213 *************************************************/
1214
1215 /* Arguments:
1216   n     points to an integer into which to put the number
1217   s     points to the first digit of the number
1218
1219 Returns:  a pointer to the character after the last digit
1220 */
1221 /*XXX consider expanding to int_eximarith_t.  But the test for
1222 "overbig numbers" in 0002 still needs to overflow it. */
1223
1224 static uschar *
1225 read_number(int *n, uschar *s)
1226 {
1227 *n = 0;
1228 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1229 return s;
1230 }
1231
1232 static const uschar *
1233 read_cnumber(int *n, const uschar *s)
1234 {
1235 *n = 0;
1236 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1237 return s;
1238 }
1239
1240
1241
1242 /*************************************************
1243 *        Extract keyed subfield from a string    *
1244 *************************************************/
1245
1246 /* The yield is in dynamic store; NULL means that the key was not found.
1247
1248 Arguments:
1249   key       points to the name of the key
1250   s         points to the string from which to extract the subfield
1251
1252 Returns:    NULL if the subfield was not found, or
1253             a pointer to the subfield's data
1254 */
1255
1256 uschar *
1257 expand_getkeyed(const uschar * key, const uschar * s)
1258 {
1259 int length = Ustrlen(key);
1260 Uskip_whitespace(&s);
1261
1262 /* Loop to search for the key */
1263
1264 while (*s)
1265   {
1266   int dkeylength;
1267   uschar * data;
1268   const uschar * dkey = s;
1269
1270   while (*s && *s != '=' && !isspace(*s)) s++;
1271   dkeylength = s - dkey;
1272   if (Uskip_whitespace(&s) == '=')
1273     while (isspace(*++s)) ;
1274
1275   data = string_dequote(&s);
1276   if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1277     return data;
1278
1279   Uskip_whitespace(&s);
1280   }
1281
1282 return NULL;
1283 }
1284
1285
1286
1287 static var_entry *
1288 find_var_ent(uschar * name)
1289 {
1290 int first = 0;
1291 int last = nelem(var_table);
1292
1293 while (last > first)
1294   {
1295   int middle = (first + last)/2;
1296   int c = Ustrcmp(name, var_table[middle].name);
1297
1298   if (c > 0) { first = middle + 1; continue; }
1299   if (c < 0) { last = middle; continue; }
1300   return &var_table[middle];
1301   }
1302 return NULL;
1303 }
1304
1305 /*************************************************
1306 *   Extract numbered subfield from string        *
1307 *************************************************/
1308
1309 /* Extracts a numbered field from a string that is divided by tokens - for
1310 example a line from /etc/passwd is divided by colon characters.  First field is
1311 numbered one.  Negative arguments count from the right. Zero returns the whole
1312 string. Returns NULL if there are insufficient tokens in the string
1313
1314 ***WARNING***
1315 Modifies final argument - this is a dynamically generated string, so that's OK.
1316
1317 Arguments:
1318   field       number of field to be extracted,
1319                 first field = 1, whole string = 0, last field = -1
1320   separators  characters that are used to break string into tokens
1321   s           points to the string from which to extract the subfield
1322
1323 Returns:      NULL if the field was not found,
1324               a pointer to the field's data inside s (modified to add 0)
1325 */
1326
1327 static uschar *
1328 expand_gettokened (int field, uschar *separators, uschar *s)
1329 {
1330 int sep = 1;
1331 int count;
1332 uschar *ss = s;
1333 uschar *fieldtext = NULL;
1334
1335 if (field == 0) return s;
1336
1337 /* Break the line up into fields in place; for field > 0 we stop when we have
1338 done the number of fields we want. For field < 0 we continue till the end of
1339 the string, counting the number of fields. */
1340
1341 count = (field > 0)? field : INT_MAX;
1342
1343 while (count-- > 0)
1344   {
1345   size_t len;
1346
1347   /* Previous field was the last one in the string. For a positive field
1348   number, this means there are not enough fields. For a negative field number,
1349   check that there are enough, and scan back to find the one that is wanted. */
1350
1351   if (sep == 0)
1352     {
1353     if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1354     if ((-field) == (INT_MAX - count - 1)) return s;
1355     while (field++ < 0)
1356       {
1357       ss--;
1358       while (ss[-1] != 0) ss--;
1359       }
1360     fieldtext = ss;
1361     break;
1362     }
1363
1364   /* Previous field was not last in the string; save its start and put a
1365   zero at its end. */
1366
1367   fieldtext = ss;
1368   len = Ustrcspn(ss, separators);
1369   sep = ss[len];
1370   ss[len] = 0;
1371   ss += len + 1;
1372   }
1373
1374 return fieldtext;
1375 }
1376
1377
1378 static uschar *
1379 expand_getlistele(int field, const uschar * list)
1380 {
1381 const uschar * tlist = list;
1382 int sep = 0;
1383 /* Tainted mem for the throwaway element copies */
1384 uschar * dummy = store_get(2, GET_TAINTED);
1385
1386 if (field < 0)
1387   {
1388   for (field++; string_nextinlist(&tlist, &sep, dummy, 1); ) field++;
1389   sep = 0;
1390   }
1391 if (field == 0) return NULL;
1392 while (--field > 0 && (string_nextinlist(&list, &sep, dummy, 1))) ;
1393 return string_nextinlist(&list, &sep, NULL, 0);
1394 }
1395
1396
1397 /* Certificate fields, by name.  Worry about by-OID later */
1398 /* Names are chosen to not have common prefixes */
1399
1400 #ifndef DISABLE_TLS
1401 typedef struct
1402 {
1403 uschar * name;
1404 int      namelen;
1405 uschar * (*getfn)(void * cert, uschar * mod);
1406 } certfield;
1407 static certfield certfields[] =
1408 {                       /* linear search; no special order */
1409   { US"version",         7,  &tls_cert_version },
1410   { US"serial_number",   13, &tls_cert_serial_number },
1411   { US"subject",         7,  &tls_cert_subject },
1412   { US"notbefore",       9,  &tls_cert_not_before },
1413   { US"notafter",        8,  &tls_cert_not_after },
1414   { US"issuer",          6,  &tls_cert_issuer },
1415   { US"signature",       9,  &tls_cert_signature },
1416   { US"sig_algorithm",   13, &tls_cert_signature_algorithm },
1417   { US"subj_altname",    12, &tls_cert_subject_altname },
1418   { US"ocsp_uri",        8,  &tls_cert_ocsp_uri },
1419   { US"crl_uri",         7,  &tls_cert_crl_uri },
1420 };
1421
1422 static uschar *
1423 expand_getcertele(uschar * field, uschar * certvar)
1424 {
1425 var_entry * vp;
1426
1427 if (!(vp = find_var_ent(certvar)))
1428   {
1429   expand_string_message =
1430     string_sprintf("no variable named \"%s\"", certvar);
1431   return NULL;          /* Unknown variable name */
1432   }
1433 /* NB this stops us passing certs around in variable.  Might
1434 want to do that in future */
1435 if (vp->type != vtype_cert)
1436   {
1437   expand_string_message =
1438     string_sprintf("\"%s\" is not a certificate", certvar);
1439   return NULL;          /* Unknown variable name */
1440   }
1441 if (!*(void **)vp->value)
1442   return NULL;
1443
1444 if (*field >= '0' && *field <= '9')
1445   return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1446
1447 for (certfield * cp = certfields;
1448      cp < certfields + nelem(certfields);
1449      cp++)
1450   if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1451     {
1452     uschar * modifier = *(field += cp->namelen) == ','
1453       ? ++field : NULL;
1454     return (*cp->getfn)( *(void **)vp->value, modifier );
1455     }
1456
1457 expand_string_message =
1458   string_sprintf("bad field selector \"%s\" for certextract", field);
1459 return NULL;
1460 }
1461 #endif  /*DISABLE_TLS*/
1462
1463 /*************************************************
1464 *        Extract a substring from a string       *
1465 *************************************************/
1466
1467 /* Perform the ${substr or ${length expansion operations.
1468
1469 Arguments:
1470   subject     the input string
1471   value1      the offset from the start of the input string to the start of
1472                 the output string; if negative, count from the right.
1473   value2      the length of the output string, or negative (-1) for unset
1474                 if value1 is positive, unset means "all after"
1475                 if value1 is negative, unset means "all before"
1476   len         set to the length of the returned string
1477
1478 Returns:      pointer to the output string, or NULL if there is an error
1479 */
1480
1481 static uschar *
1482 extract_substr(uschar *subject, int value1, int value2, int *len)
1483 {
1484 int sublen = Ustrlen(subject);
1485
1486 if (value1 < 0)    /* count from right */
1487   {
1488   value1 += sublen;
1489
1490   /* If the position is before the start, skip to the start, and adjust the
1491   length. If the length ends up negative, the substring is null because nothing
1492   can precede. This falls out naturally when the length is unset, meaning "all
1493   to the left". */
1494
1495   if (value1 < 0)
1496     {
1497     value2 += value1;
1498     if (value2 < 0) value2 = 0;
1499     value1 = 0;
1500     }
1501
1502   /* Otherwise an unset length => characters before value1 */
1503
1504   else if (value2 < 0)
1505     {
1506     value2 = value1;
1507     value1 = 0;
1508     }
1509   }
1510
1511 /* For a non-negative offset, if the starting position is past the end of the
1512 string, the result will be the null string. Otherwise, an unset length means
1513 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1514
1515 else
1516   {
1517   if (value1 > sublen)
1518     {
1519     value1 = sublen;
1520     value2 = 0;
1521     }
1522   else if (value2 < 0) value2 = sublen;
1523   }
1524
1525 /* Cut the length down to the maximum possible for the offset value, and get
1526 the required characters. */
1527
1528 if (value1 + value2 > sublen) value2 = sublen - value1;
1529 *len = value2;
1530 return subject + value1;
1531 }
1532
1533
1534
1535
1536 /*************************************************
1537 *            Old-style hash of a string          *
1538 *************************************************/
1539
1540 /* Perform the ${hash expansion operation.
1541
1542 Arguments:
1543   subject     the input string (an expanded substring)
1544   value1      the length of the output string; if greater or equal to the
1545                 length of the input string, the input string is returned
1546   value2      the number of hash characters to use, or 26 if negative
1547   len         set to the length of the returned string
1548
1549 Returns:      pointer to the output string, or NULL if there is an error
1550 */
1551
1552 static uschar *
1553 compute_hash(uschar *subject, int value1, int value2, int *len)
1554 {
1555 int sublen = Ustrlen(subject);
1556
1557 if (value2 < 0) value2 = 26;
1558 else if (value2 > Ustrlen(hashcodes))
1559   {
1560   expand_string_message =
1561     string_sprintf("hash count \"%d\" too big", value2);
1562   return NULL;
1563   }
1564
1565 /* Calculate the hash text. We know it is shorter than the original string, so
1566 can safely place it in subject[] (we know that subject is always itself an
1567 expanded substring). */
1568
1569 if (value1 < sublen)
1570   {
1571   int c;
1572   int i = 0;
1573   int j = value1;
1574   while ((c = (subject[j])) != 0)
1575     {
1576     int shift = (c + j++) & 7;
1577     subject[i] ^= (c << shift) | (c >> (8-shift));
1578     if (++i >= value1) i = 0;
1579     }
1580   for (i = 0; i < value1; i++)
1581     subject[i] = hashcodes[(subject[i]) % value2];
1582   }
1583 else value1 = sublen;
1584
1585 *len = value1;
1586 return subject;
1587 }
1588
1589
1590
1591
1592 /*************************************************
1593 *             Numeric hash of a string           *
1594 *************************************************/
1595
1596 /* Perform the ${nhash expansion operation. The first characters of the
1597 string are treated as most important, and get the highest prime numbers.
1598
1599 Arguments:
1600   subject     the input string
1601   value1      the maximum value of the first part of the result
1602   value2      the maximum value of the second part of the result,
1603                 or negative to produce only a one-part result
1604   len         set to the length of the returned string
1605
1606 Returns:  pointer to the output string, or NULL if there is an error.
1607 */
1608
1609 static uschar *
1610 compute_nhash (uschar *subject, int value1, int value2, int *len)
1611 {
1612 uschar *s = subject;
1613 int i = 0;
1614 unsigned long int total = 0; /* no overflow */
1615
1616 while (*s != 0)
1617   {
1618   if (i == 0) i = nelem(prime) - 1;
1619   total += prime[i--] * (unsigned int)(*s++);
1620   }
1621
1622 /* If value2 is unset, just compute one number */
1623
1624 if (value2 < 0)
1625   s = string_sprintf("%lu", total % value1);
1626
1627 /* Otherwise do a div/mod hash */
1628
1629 else
1630   {
1631   total = total % (value1 * value2);
1632   s = string_sprintf("%lu/%lu", total/value2, total % value2);
1633   }
1634
1635 *len = Ustrlen(s);
1636 return s;
1637 }
1638
1639
1640
1641
1642
1643 /*************************************************
1644 *     Find the value of a header or headers      *
1645 *************************************************/
1646
1647 /* Multiple instances of the same header get concatenated, and this function
1648 can also return a concatenation of all the header lines. When concatenating
1649 specific headers that contain lists of addresses, a comma is inserted between
1650 them. Otherwise we use a straight concatenation. Because some messages can have
1651 pathologically large number of lines, there is a limit on the length that is
1652 returned.
1653
1654 Arguments:
1655   name          the name of the header, without the leading $header_ or $h_,
1656                 or NULL if a concatenation of all headers is required
1657   newsize       return the size of memory block that was obtained; may be NULL
1658                 if exists_only is TRUE
1659   flags         FH_EXISTS_ONLY
1660                   set if called from a def: test; don't need to build a string;
1661                   just return a string that is not "" and not "0" if the header
1662                   exists
1663                 FH_WANT_RAW
1664                   set if called for $rh_ or $rheader_ items; no processing,
1665                   other than concatenating, will be done on the header. Also used
1666                   for $message_headers_raw.
1667                 FH_WANT_LIST
1668                   Double colon chars in the content, and replace newline with
1669                   colon between each element when concatenating; returning a
1670                   colon-sep list (elements might contain newlines)
1671   charset       name of charset to translate MIME words to; used only if
1672                 want_raw is false; if NULL, no translation is done (this is
1673                 used for $bh_ and $bheader_)
1674
1675 Returns:        NULL if the header does not exist, else a pointer to a new
1676                 store block
1677 */
1678
1679 static uschar *
1680 find_header(uschar * name, int * newsize, unsigned flags, const uschar * charset)
1681 {
1682 BOOL found = !name;
1683 int len = name ? Ustrlen(name) : 0;
1684 BOOL comma = FALSE;
1685 gstring * g = NULL;
1686 uschar * rawhdr;
1687
1688 for (header_line * h = header_list; h; h = h->next)
1689   if (h->type != htype_old && h->text)  /* NULL => Received: placeholder */
1690     if (!name || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1691       {
1692       uschar * s, * t;
1693       size_t inc;
1694
1695       if (flags & FH_EXISTS_ONLY)
1696         return US"1";  /* don't need actual string */
1697
1698       found = TRUE;
1699       s = h->text + len;                /* text to insert */
1700       if (!(flags & FH_WANT_RAW))       /* unless wanted raw, */
1701         Uskip_whitespace(&s);           /* remove leading white space */
1702       t = h->text + h->slen;            /* end-point */
1703
1704       /* Unless wanted raw, remove trailing whitespace, including the
1705       newline. */
1706
1707       if (flags & FH_WANT_LIST)
1708         while (t > s && t[-1] == '\n') t--;
1709       else if (!(flags & FH_WANT_RAW))
1710         {
1711         while (t > s && isspace(t[-1])) t--;
1712
1713         /* Set comma if handling a single header and it's one of those
1714         that contains an address list, except when asked for raw headers. Only
1715         need to do this once. */
1716
1717         if (name && !comma && Ustrchr("BCFRST", h->type)) comma = TRUE;
1718         }
1719
1720       /* Trim the header roughly if we're approaching limits */
1721       inc = t - s;
1722       if (gstring_length(g) + inc > header_insert_maxlen)
1723         inc = header_insert_maxlen - gstring_length(g);
1724
1725       /* For raw just copy the data; for a list, add the data as a colon-sep
1726       list-element; for comma-list add as an unchecked comma,newline sep
1727       list-elemment; for other nonraw add as an unchecked newline-sep list (we
1728       stripped trailing WS above including the newline). We ignore the potential
1729       expansion due to colon-doubling, just leaving the loop if the limit is met
1730       or exceeded. */
1731
1732       if (flags & FH_WANT_LIST)
1733         g = string_append_listele_n(g, ':', s, (unsigned)inc);
1734       else if (flags & FH_WANT_RAW)
1735         g = string_catn(g, s, (unsigned)inc);
1736       else if (inc > 0)
1737         g = string_append2_listele_n(g, comma ? US",\n" : US"\n",
1738           s, (unsigned)inc);
1739
1740       if (gstring_length(g) >= header_insert_maxlen) break;
1741       }
1742
1743 if (!found) return NULL;        /* No header found */
1744 if (!g) return US"";
1745
1746 /* That's all we do for raw header expansion. */
1747
1748 *newsize = g->size;
1749 rawhdr = string_from_gstring(g);
1750 if (flags & FH_WANT_RAW)
1751   return rawhdr;
1752
1753 /* Otherwise do RFC 2047 decoding, translating the charset if requested.
1754 The rfc2047_decode2() function can return an error with decoded data if the
1755 charset translation fails. If decoding fails, it returns NULL. */
1756
1757 else
1758   {
1759   uschar * error, * decoded = rfc2047_decode2(rawhdr,
1760     check_rfc2047_length, charset, '?', NULL, newsize, &error);
1761   if (error)
1762     DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1763       "    input was: %s\n", error, rawhdr);
1764   return decoded ? decoded : rawhdr;
1765   }
1766 }
1767
1768
1769
1770
1771 /* Append a "local" element to an Authentication-Results: header
1772 if this was a non-smtp message.
1773 */
1774
1775 static gstring *
1776 authres_local(gstring * g, const uschar * sysname)
1777 {
1778 if (!f.authentication_local)
1779   return g;
1780 g = string_append(g, 3, US";\n\tlocal=pass (non-smtp, ", sysname, US")");
1781 if (authenticated_id) g = string_append(g, 2, " u=", authenticated_id);
1782 return g;
1783 }
1784
1785
1786 /* Append an "iprev" element to an Authentication-Results: header
1787 if we have attempted to get the calling host's name.
1788 */
1789
1790 static gstring *
1791 authres_iprev(gstring * g)
1792 {
1793 if (sender_host_name)
1794   g = string_append(g, 3, US";\n\tiprev=pass (", sender_host_name, US")");
1795 else if (host_lookup_deferred)
1796   g = string_cat(g, US";\n\tiprev=temperror");
1797 else if (host_lookup_failed)
1798   g = string_cat(g, US";\n\tiprev=fail");
1799 else
1800   return g;
1801
1802 if (sender_host_address)
1803   g = string_append(g, 2, US" smtp.remote-ip=", sender_host_address);
1804 return g;
1805 }
1806
1807
1808
1809 /*************************************************
1810 *               Return list of recipients        *
1811 *************************************************/
1812 /* A recipients list is available only during system message filtering,
1813 during ACL processing after DATA, and while expanding pipe commands
1814 generated from a system filter, but not elsewhere.  Note that this does
1815 not check for commas in the elements, and uses comma-space as seperator -
1816 so cannot be used as an exim list as-is. */
1817
1818 static uschar *
1819 fn_recipients(void)
1820 {
1821 gstring * g = NULL;
1822
1823 if (!f.enable_dollar_recipients) return NULL;
1824
1825 for (int i = 0; i < recipients_count; i++)
1826   {
1827   const uschar * s = recipients_list[i].address;
1828   g = string_append2_listele_n(g, US", ", s, Ustrlen(s));
1829   }
1830 gstring_release_unused(g);
1831 return string_from_gstring(g);
1832 }
1833
1834 /* Similar, but as a properly-quoted exim list */
1835
1836
1837 static uschar *
1838 fn_recipients_list(void)
1839 {
1840 gstring * g = NULL;
1841
1842 if (!f.enable_dollar_recipients) return NULL;
1843
1844 for (int i = 0; i < recipients_count; i++)
1845   g = string_append_listele(g, ':', recipients_list[i].address);
1846 gstring_release_unused(g);
1847 return string_from_gstring(g);
1848 }
1849
1850
1851 /*************************************************
1852 *               Return size of queue             *
1853 *************************************************/
1854 /* Ask the daemon for the queue size */
1855
1856 static uschar *
1857 fn_queue_size(void)
1858 {
1859 struct sockaddr_un sa_un = {.sun_family = AF_UNIX};
1860 uschar buf[16];
1861 int fd;
1862 ssize_t len;
1863 const uschar * where;
1864 uschar * sname;
1865
1866 if ((fd = socket(AF_UNIX, SOCK_DGRAM, 0)) < 0)
1867   {
1868   DEBUG(D_expand) debug_printf(" socket: %s\n", strerror(errno));
1869   return NULL;
1870   }
1871
1872 len = daemon_client_sockname(&sa_un, &sname);
1873
1874 if (bind(fd, (const struct sockaddr *)&sa_un, (socklen_t)len) < 0)
1875   { where = US"bind"; goto bad; }
1876
1877 #ifdef notdef
1878 debug_printf("local addr '%s%s'\n",
1879   *sa_un.sun_path ? "" : "@",
1880   sa_un.sun_path + (*sa_un.sun_path ? 0 : 1));
1881 #endif
1882
1883 len = daemon_notifier_sockname(&sa_un);
1884 if (connect(fd, (const struct sockaddr *)&sa_un, len) < 0)
1885   { where = US"connect"; goto bad2; }
1886
1887 buf[0] = NOTIFY_QUEUE_SIZE_REQ;
1888 if (send(fd, buf, 1, 0) < 0) { where = US"send"; goto bad; }
1889
1890 if (poll_one_fd(fd, POLLIN, 2 * 1000) != 1)
1891   {
1892   DEBUG(D_expand) debug_printf("no daemon response; using local evaluation\n");
1893   len = snprintf(CS buf, sizeof(buf), "%u", queue_count_cached());
1894   }
1895 else if ((len = recv(fd, buf, sizeof(buf), 0)) < 0)
1896   { where = US"recv"; goto bad2; }
1897
1898 close(fd);
1899 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1900 Uunlink(sname);
1901 #endif
1902 return string_copyn(buf, len);
1903
1904 bad2:
1905 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1906   Uunlink(sname);
1907 #endif
1908 bad:
1909   close(fd);
1910   DEBUG(D_expand) debug_printf(" %s: %s\n", where, strerror(errno));
1911   return NULL;
1912 }
1913
1914
1915 /*************************************************
1916 *               Find value of a variable         *
1917 *************************************************/
1918
1919 /* The table of variables is kept in alphabetic order, so we can search it
1920 using a binary chop. The "choplen" variable is nothing to do with the binary
1921 chop.
1922
1923 Arguments:
1924   name          the name of the variable being sought
1925   flags
1926     exists_only  TRUE if this is a def: test; passed on to find_header()
1927     skipping     TRUE => skip any processing evaluation; this is not the same as
1928                   exists_only because def: may test for values that are first
1929                   evaluated here
1930   newsize       pointer to an int which is initially zero; if the answer is in
1931                 a new memory buffer, *newsize is set to its size
1932
1933 Returns:        NULL if the variable does not exist, or
1934                 a pointer to the variable's contents, or
1935                 something non-NULL if exists_only is TRUE
1936 */
1937
1938 static const uschar *
1939 find_variable(uschar * name, esi_flags flags, int * newsize)
1940 {
1941 var_entry * vp;
1942 uschar *s, *domain;
1943 uschar **ss;
1944 void * val;
1945
1946 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1947 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1948 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1949 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1950 (this gave backwards compatibility at the changeover). There may be built-in
1951 variables whose names start acl_ but they should never start in this way. This
1952 slightly messy specification is a consequence of the history, needless to say.
1953
1954 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1955 set, in which case give an error. */
1956
1957 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1958      !isalpha(name[5]))
1959   {
1960   tree_node * node =
1961     tree_search(name[4] == 'c' ? acl_var_c : acl_var_m, name + 4);
1962   return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1963   }
1964 else if (Ustrncmp(name, "r_", 2) == 0)
1965   {
1966   tree_node * node = tree_search(router_var, name + 2);
1967   return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1968   }
1969
1970 /* Handle $auth<n>, $regex<n> variables. */
1971
1972 if (Ustrncmp(name, "auth", 4) == 0)
1973   {
1974   uschar *endptr;
1975   int n = Ustrtoul(name + 4, &endptr, 10);
1976   if (!*endptr && n != 0 && n <= AUTH_VARS)
1977     return auth_vars[n-1] ? auth_vars[n-1] : US"";
1978   }
1979 #ifdef WITH_CONTENT_SCAN
1980 else if (Ustrncmp(name, "regex", 5) == 0)
1981   {
1982   uschar *endptr;
1983   int n = Ustrtoul(name + 5, &endptr, 10);
1984   if (!*endptr && n != 0 && n <= REGEX_VARS)
1985     return regex_vars[n-1] ? regex_vars[n-1] : US"";
1986   }
1987 #endif
1988
1989 /* For all other variables, search the table */
1990
1991 if (!(vp = find_var_ent(name)))
1992   return NULL;          /* Unknown variable name */
1993
1994 /* Found an existing variable. If in skipping state, the value isn't needed,
1995 and we want to avoid processing (such as looking up the host name). */
1996
1997 if (flags & ESI_SKIPPING)
1998   return US"";
1999
2000 val = vp->value;
2001 switch (vp->type)
2002   {
2003   case vtype_filter_int:
2004     if (!f.filter_running) return NULL;
2005     /* Fall through */
2006     /* VVVVVVVVVVVV */
2007   case vtype_int:
2008     sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
2009     return var_buffer;
2010
2011   case vtype_ino:
2012     sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
2013     return var_buffer;
2014
2015   case vtype_gid:
2016     sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
2017     return var_buffer;
2018
2019   case vtype_uid:
2020     sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
2021     return var_buffer;
2022
2023   case vtype_bool:
2024     sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
2025     return var_buffer;
2026
2027   case vtype_stringptr:                      /* Pointer to string */
2028     return (s = *((uschar **)(val))) ? s : US"";
2029
2030   case vtype_pid:
2031     sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
2032     return var_buffer;
2033
2034   case vtype_load_avg:
2035     sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
2036     return var_buffer;
2037
2038   case vtype_host_lookup:                    /* Lookup if not done so */
2039     if (  !sender_host_name && sender_host_address
2040        && !host_lookup_failed && host_name_lookup() == OK)
2041       host_build_sender_fullhost();
2042     return sender_host_name ? sender_host_name : US"";
2043
2044   case vtype_localpart:                      /* Get local part from address */
2045     if (!(s = *((uschar **)(val)))) return US"";
2046     if (!(domain = Ustrrchr(s, '@'))) return s;
2047     if (domain - s > sizeof(var_buffer) - 1)
2048       log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
2049           " in string expansion", sizeof(var_buffer));
2050     return string_copyn(s, domain - s);
2051
2052   case vtype_domain:                         /* Get domain from address */
2053     if (!(s = *((uschar **)(val)))) return US"";
2054     domain = Ustrrchr(s, '@');
2055     return domain ? domain + 1 : US"";
2056
2057   case vtype_msgheaders:
2058     return find_header(NULL, newsize,
2059             flags & ESI_EXISTS_ONLY ? FH_EXISTS_ONLY : 0, NULL);
2060
2061   case vtype_msgheaders_raw:
2062     return find_header(NULL, newsize,
2063             flags & ESI_EXISTS_ONLY ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2064             NULL);
2065
2066   case vtype_msgbody:                        /* Pointer to msgbody string */
2067   case vtype_msgbody_end:                    /* Ditto, the end of the msg */
2068     ss = (uschar **)(val);
2069     if (!*ss && deliver_datafile >= 0)  /* Read body when needed */
2070       {
2071       uschar * body;
2072       off_t start_offset_o = spool_data_start_offset(message_id);
2073       off_t start_offset = start_offset_o;
2074       int len = message_body_visible;
2075
2076       if (len > message_size) len = message_size;
2077       *ss = body = store_get(len+1, GET_TAINTED);
2078       body[0] = 0;
2079       if (vp->type == vtype_msgbody_end)
2080         {
2081         struct stat statbuf;
2082         if (fstat(deliver_datafile, &statbuf) == 0)
2083           {
2084           start_offset = statbuf.st_size - len;
2085           if (start_offset < start_offset_o)
2086             start_offset = start_offset_o;
2087           }
2088         }
2089       if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)
2090         log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",
2091           strerror(errno));
2092       if ((len = read(deliver_datafile, body, len)) > 0)
2093         {
2094         body[len] = 0;
2095         if (message_body_newlines)   /* Separate loops for efficiency */
2096           while (len > 0)
2097             { if (body[--len] == 0) body[len] = ' '; }
2098         else
2099           while (len > 0)
2100             { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
2101         }
2102       }
2103     return *ss ? *ss : US"";
2104
2105   case vtype_todbsdin:                       /* BSD inbox time of day */
2106     return tod_stamp(tod_bsdin);
2107
2108   case vtype_tode:                           /* Unix epoch time of day */
2109     return tod_stamp(tod_epoch);
2110
2111   case vtype_todel:                          /* Unix epoch/usec time of day */
2112     return tod_stamp(tod_epoch_l);
2113
2114   case vtype_todf:                           /* Full time of day */
2115     return tod_stamp(tod_full);
2116
2117   case vtype_todl:                           /* Log format time of day */
2118     return tod_stamp(tod_log_bare);            /* (without timezone) */
2119
2120   case vtype_todzone:                        /* Time zone offset only */
2121     return tod_stamp(tod_zone);
2122
2123   case vtype_todzulu:                        /* Zulu time */
2124     return tod_stamp(tod_zulu);
2125
2126   case vtype_todlf:                          /* Log file datestamp tod */
2127     return tod_stamp(tod_log_datestamp_daily);
2128
2129   case vtype_reply:                          /* Get reply address */
2130     s = find_header(US"reply-to:", newsize,
2131             flags & ESI_EXISTS_ONLY ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2132             headers_charset);
2133     if (s) Uskip_whitespace(&s);
2134     if (!s || !*s)
2135       {
2136       *newsize = 0;                            /* For the *s==0 case */
2137       s = find_header(US"from:", newsize,
2138             flags & ESI_EXISTS_ONLY ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2139             headers_charset);
2140       }
2141     if (s)
2142       {
2143       uschar *t;
2144       Uskip_whitespace(&s);
2145       for (t = s; *t; t++) if (*t == '\n') *t = ' ';
2146       while (t > s && isspace(t[-1])) t--;
2147       *t = 0;
2148       }
2149     return s ? s : US"";
2150
2151   case vtype_string_func:
2152     {
2153     stringptr_fn_t * fn = (stringptr_fn_t *) val;
2154     uschar * s = fn();
2155     return s ? s : US"";
2156     }
2157
2158   case vtype_pspace:
2159     {
2160     int inodes;
2161     sprintf(CS var_buffer, PR_EXIM_ARITH,
2162       receive_statvfs(val == (void *)TRUE, &inodes));
2163     }
2164   return var_buffer;
2165
2166   case vtype_pinodes:
2167     {
2168     int inodes;
2169     (void) receive_statvfs(val == (void *)TRUE, &inodes);
2170     sprintf(CS var_buffer, "%d", inodes);
2171     }
2172   return var_buffer;
2173
2174   case vtype_cert:
2175     return *(void **)val ? US"<cert>" : US"";
2176
2177 #ifndef DISABLE_DKIM
2178   case vtype_dkim:
2179     return dkim_exim_expand_query((int)(long)val);
2180 #endif
2181
2182   }
2183
2184 return NULL;  /* Unknown variable. Silences static checkers. */
2185 }
2186
2187
2188
2189
2190 void
2191 modify_variable(uschar *name, void * value)
2192 {
2193 var_entry * vp;
2194 if ((vp = find_var_ent(name))) vp->value = value;
2195 return;          /* Unknown variable name, fail silently */
2196 }
2197
2198
2199
2200
2201
2202
2203 /*************************************************
2204 *           Read and expand substrings           *
2205 *************************************************/
2206
2207 /* This function is called to read and expand argument substrings for various
2208 expansion items. Some have a minimum requirement that is less than the maximum;
2209 in these cases, the first non-present one is set to NULL.
2210
2211 Arguments:
2212   sub        points to vector of pointers to set
2213   n          maximum number of substrings
2214   m          minimum required
2215   sptr       points to current string pointer
2216   flags
2217    skipping   the skipping flag
2218   check_end  if TRUE, check for final '}'
2219   name       name of item, for error message
2220   resetok    if not NULL, pointer to flag - write FALSE if unsafe to reset
2221              the store
2222   textonly_p if not NULL, pointer to bitmask of which subs were text-only
2223              (did not change when expended)
2224
2225 Returns:     -1 OK; string pointer updated, but in "skipping" mode
2226              0 OK; string pointer updated
2227              1 curly bracketing error (too few arguments)
2228              2 too many arguments (only if check_end is set); message set
2229              3 other error (expansion failure)
2230 */
2231
2232 static int
2233 read_subs(uschar ** sub, int n, int m, const uschar ** sptr, esi_flags flags,
2234   BOOL check_end, uschar * name, BOOL * resetok, unsigned * textonly_p)
2235 {
2236 const uschar * s = *sptr;
2237 unsigned textonly_l = 0;
2238
2239 Uskip_whitespace(&s);
2240 for (int i = 0; i < n; i++)
2241   {
2242   BOOL textonly;
2243   if (*s != '{')
2244     {
2245     if (i < m)
2246       {
2247       expand_string_message = string_sprintf("Not enough arguments for '%s' "
2248         "(min is %d)", name, m);
2249       return 1;
2250       }
2251     sub[i] = NULL;
2252     break;
2253     }
2254   if (!(sub[i] = expand_string_internal(s+1,
2255           ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags & ESI_SKIPPING, &s, resetok,
2256           textonly_p ? &textonly : NULL)))
2257     return 3;
2258   if (*s++ != '}') return 1;
2259   if (textonly_p && textonly) textonly_l |= BIT(i);
2260   Uskip_whitespace(&s);
2261   }                                             /*{*/
2262 if (check_end && *s++ != '}')
2263   {
2264   if (s[-1] == '{')
2265     {
2266     expand_string_message = string_sprintf("Too many arguments for '%s' "
2267       "(max is %d)", name, n);
2268     return 2;
2269     }
2270   expand_string_message = string_sprintf("missing '}' after '%s'", name);
2271   return 1;
2272   }
2273
2274 if (textonly_p) *textonly_p = textonly_l;
2275 *sptr = s;
2276 return flags & ESI_SKIPPING ? -1 : 0;
2277 }
2278
2279
2280
2281
2282 /*************************************************
2283 *     Elaborate message for bad variable         *
2284 *************************************************/
2285
2286 /* For the "unknown variable" message, take a look at the variable's name, and
2287 give additional information about possible ACL variables. The extra information
2288 is added on to expand_string_message.
2289
2290 Argument:   the name of the variable
2291 Returns:    nothing
2292 */
2293
2294 static void
2295 check_variable_error_message(uschar *name)
2296 {
2297 if (Ustrncmp(name, "acl_", 4) == 0)
2298   expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2299     (name[4] == 'c' || name[4] == 'm')?
2300       (isalpha(name[5])?
2301         US"6th character of a user-defined ACL variable must be a digit or underscore" :
2302         US"strict_acl_vars is set"    /* Syntax is OK, it has to be this */
2303       ) :
2304       US"user-defined ACL variables must start acl_c or acl_m");
2305 }
2306
2307
2308
2309 /*
2310 Load args from sub array to globals, and call acl_check().
2311 Sub array will be corrupted on return.
2312
2313 Returns:       OK         access is granted by an ACCEPT verb
2314                DISCARD    access is (apparently) granted by a DISCARD verb
2315                FAIL       access is denied
2316                FAIL_DROP  access is denied; drop the connection
2317                DEFER      can't tell at the moment
2318                ERROR      disaster
2319 */
2320 static int
2321 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2322 {
2323 int i;
2324 int sav_narg = acl_narg;
2325 int ret;
2326 uschar * dummy_logmsg;
2327 extern int acl_where;
2328
2329 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2330 for (i = 0; i < nsub && sub[i+1]; i++)
2331   {
2332   uschar * tmp = acl_arg[i];
2333   acl_arg[i] = sub[i+1];        /* place callers args in the globals */
2334   sub[i+1] = tmp;               /* stash the old args using our caller's storage */
2335   }
2336 acl_narg = i;
2337 while (i < nsub)
2338   {
2339   sub[i+1] = acl_arg[i];
2340   acl_arg[i++] = NULL;
2341   }
2342
2343 DEBUG(D_expand)
2344   debug_printf_indent("expanding: acl: %s  arg: %s%s\n",
2345     sub[0],
2346     acl_narg>0 ? acl_arg[0] : US"<none>",
2347     acl_narg>1 ? " +more"   : "");
2348
2349 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2350
2351 for (i = 0; i < nsub; i++)
2352   acl_arg[i] = sub[i+1];        /* restore old args */
2353 acl_narg = sav_narg;
2354
2355 return ret;
2356 }
2357
2358
2359
2360
2361 /* Return pointer to dewrapped string, with enclosing specified chars removed.
2362 The given string is modified on return.  Leading whitespace is skipped while
2363 looking for the opening wrap character, then the rest is scanned for the trailing
2364 (non-escaped) wrap character.  A backslash in the string will act as an escape.
2365
2366 A nul is written over the trailing wrap, and a pointer to the char after the
2367 leading wrap is returned.
2368
2369 Arguments:
2370   s     String for de-wrapping
2371   wrap  Two-char string, the first being the opener, second the closer wrapping
2372         character
2373 Return:
2374   Pointer to de-wrapped string, or NULL on error (with expand_string_message set).
2375 */
2376
2377 static uschar *
2378 dewrap(uschar * s, const uschar * wrap)
2379 {
2380 uschar * p = s;
2381 unsigned depth = 0;
2382 BOOL quotesmode = wrap[0] == wrap[1];
2383
2384 if (Uskip_whitespace(&p) == *wrap)
2385   {
2386   s = ++p;
2387   wrap++;
2388   while (*p)
2389     {
2390     if (*p == '\\') p++;
2391     else if (!quotesmode && *p == wrap[-1]) depth++;
2392     else if (*p == *wrap)
2393       if (depth == 0)
2394         {
2395         *p = '\0';
2396         return s;
2397         }
2398       else
2399         depth--;
2400     p++;
2401     }
2402   }
2403 expand_string_message = string_sprintf("missing '%c'", *wrap);
2404 return NULL;
2405 }
2406
2407
2408 /* Pull off the leading array or object element, returning
2409 a copy in an allocated string.  Update the list pointer.
2410
2411 The element may itself be an abject or array.
2412 Return NULL when the list is empty.
2413 */
2414
2415 static uschar *
2416 json_nextinlist(const uschar ** list)
2417 {
2418 unsigned array_depth = 0, object_depth = 0;
2419 BOOL quoted = FALSE;
2420 const uschar * s = *list, * item;
2421
2422 skip_whitespace(&s);
2423
2424 for (item = s;
2425      *s && (*s != ',' || array_depth != 0 || object_depth != 0 || quoted);
2426      s++)
2427   if (!quoted) switch (*s)
2428     {
2429     case '[': array_depth++; break;
2430     case ']': array_depth--; break;
2431     case '{': object_depth++; break;
2432     case '}': object_depth--; break;
2433     case '"': quoted = TRUE;
2434     }
2435   else switch(*s)
2436     {
2437     case '\\': s++; break;              /* backslash protects one char */
2438     case '"':  quoted = FALSE; break;
2439     }
2440 *list = *s ? s+1 : s;
2441 if (item == s) return NULL;
2442 item = string_copyn(item, s - item);
2443 DEBUG(D_expand) debug_printf_indent("  json ele: '%s'\n", item);
2444 return US item;
2445 }
2446
2447
2448
2449 /************************************************/
2450 /*  Return offset in ops table, or -1 if not found.
2451 Repoint to just after the operator in the string.
2452
2453 Argument:
2454  ss     string representation of operator
2455  opname split-out operator name
2456 */
2457
2458 static int
2459 identify_operator(const uschar ** ss, uschar ** opname)
2460 {
2461 const uschar * s = *ss;
2462 uschar name[256];
2463
2464 /* Numeric comparisons are symbolic */
2465
2466 if (*s == '=' || *s == '>' || *s == '<')
2467   {
2468   int p = 0;
2469   name[p++] = *s++;
2470   if (*s == '=')
2471     {
2472     name[p++] = '=';
2473     s++;
2474     }
2475   name[p] = 0;
2476   }
2477
2478 /* All other conditions are named */
2479
2480 else
2481   s = read_name(name, sizeof(name), s, US"_");
2482 *ss = s;
2483
2484 /* If we haven't read a name, it means some non-alpha character is first. */
2485
2486 if (!name[0])
2487   {
2488   expand_string_message = string_sprintf("condition name expected, "
2489     "but found \"%.16s\"", s);
2490   return -1;
2491   }
2492 DEBUG(D_expand) debug_printf_indent("cond: %s\n", name);
2493 if (opname)
2494   *opname = string_copy(name);
2495
2496 return chop_match(name, cond_table, nelem(cond_table));
2497 }
2498
2499
2500 /*************************************************
2501 *    Handle MD5 or SHA-1 computation for HMAC    *
2502 *************************************************/
2503
2504 /* These are some wrapping functions that enable the HMAC code to be a bit
2505 cleaner. A good compiler will spot the tail recursion.
2506
2507 Arguments:
2508   type         HMAC_MD5 or HMAC_SHA1
2509   remaining    are as for the cryptographic hash functions
2510
2511 Returns:       nothing
2512 */
2513
2514 static void
2515 chash_start(int type, void * base)
2516 {
2517 if (type == HMAC_MD5)
2518   md5_start((md5 *)base);
2519 else
2520   sha1_start((hctx *)base);
2521 }
2522
2523 static void
2524 chash_mid(int type, void * base, const uschar * string)
2525 {
2526 if (type == HMAC_MD5)
2527   md5_mid((md5 *)base, string);
2528 else
2529   sha1_mid((hctx *)base, string);
2530 }
2531
2532 static void
2533 chash_end(int type, void * base, const uschar * string, int length,
2534   uschar * digest)
2535 {
2536 if (type == HMAC_MD5)
2537   md5_end((md5 *)base, string, length, digest);
2538 else
2539   sha1_end((hctx *)base, string, length, digest);
2540 }
2541
2542
2543
2544
2545 #ifdef SUPPORT_SRS
2546 /* Do an hmac_md5.  The result is _not_ nul-terminated, and is sized as
2547 the smaller of a full hmac_md5 result (16 bytes) or the supplied output buffer.
2548
2549 Arguments:
2550         key     encoding key, nul-terminated
2551         src     data to be hashed, nul-terminated
2552         buf     output buffer
2553         len     size of output buffer
2554 */
2555
2556 static void
2557 hmac_md5(const uschar * key, const uschar * src, uschar * buf, unsigned len)
2558 {
2559 md5 md5_base;
2560 const uschar * keyptr;
2561 uschar * p;
2562 unsigned int keylen;
2563
2564 #define MD5_HASHLEN      16
2565 #define MD5_HASHBLOCKLEN 64
2566
2567 uschar keyhash[MD5_HASHLEN];
2568 uschar innerhash[MD5_HASHLEN];
2569 uschar finalhash[MD5_HASHLEN];
2570 uschar innerkey[MD5_HASHBLOCKLEN];
2571 uschar outerkey[MD5_HASHBLOCKLEN];
2572
2573 keyptr = key;
2574 keylen = Ustrlen(keyptr);
2575
2576 /* If the key is longer than the hash block length, then hash the key
2577 first */
2578
2579 if (keylen > MD5_HASHBLOCKLEN)
2580   {
2581   chash_start(HMAC_MD5, &md5_base);
2582   chash_end(HMAC_MD5, &md5_base, keyptr, keylen, keyhash);
2583   keyptr = keyhash;
2584   keylen = MD5_HASHLEN;
2585   }
2586
2587 /* Now make the inner and outer key values */
2588
2589 memset(innerkey, 0x36, MD5_HASHBLOCKLEN);
2590 memset(outerkey, 0x5c, MD5_HASHBLOCKLEN);
2591
2592 for (int i = 0; i < keylen; i++)
2593   {
2594   innerkey[i] ^= keyptr[i];
2595   outerkey[i] ^= keyptr[i];
2596   }
2597
2598 /* Now do the hashes */
2599
2600 chash_start(HMAC_MD5, &md5_base);
2601 chash_mid(HMAC_MD5, &md5_base, innerkey);
2602 chash_end(HMAC_MD5, &md5_base, src, Ustrlen(src), innerhash);
2603
2604 chash_start(HMAC_MD5, &md5_base);
2605 chash_mid(HMAC_MD5, &md5_base, outerkey);
2606 chash_end(HMAC_MD5, &md5_base, innerhash, MD5_HASHLEN, finalhash);
2607
2608 /* Encode the final hash as a hex string, limited by output buffer size */
2609
2610 p = buf;
2611 for (int i = 0, j = len; i < MD5_HASHLEN; i++)
2612   {
2613   if (j-- <= 0) break;
2614   *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
2615   if (j-- <= 0) break;
2616   *p++ = hex_digits[finalhash[i] & 0x0f];
2617   }
2618 return;
2619 }
2620 #endif /*SUPPORT_SRS*/
2621
2622
2623 /*************************************************
2624 *        Read and evaluate a condition           *
2625 *************************************************/
2626
2627 /*
2628 Arguments:
2629   s        points to the start of the condition text
2630   resetok  points to a BOOL which is written false if it is unsafe to
2631            free memory. Certain condition types (acl) may have side-effect
2632            allocation which must be preserved.
2633   yield    points to a BOOL to hold the result of the condition test;
2634            if NULL, we are just reading through a condition that is
2635            part of an "or" combination to check syntax, or in a state
2636            where the answer isn't required
2637
2638 Returns:   a pointer to the first character after the condition, or
2639            NULL after an error
2640 */
2641
2642 static const uschar *
2643 eval_condition(const uschar * s, BOOL * resetok, BOOL * yield)
2644 {
2645 BOOL testfor = TRUE, tempcond, combined_cond;
2646 BOOL * subcondptr;
2647 BOOL sub2_honour_dollar = TRUE, is_forany, is_json, is_jsons;
2648 int rc, cond_type;
2649 int_eximarith_t num[2];
2650 struct stat statbuf;
2651 uschar * opname;
2652 uschar name[256];
2653 const uschar * sub[10], * next;
2654 unsigned sub_textonly = 0;
2655
2656 expand_level++;
2657 for (;;)
2658   if (Uskip_whitespace(&s) == '!') { testfor = !testfor; s++; } else break;
2659
2660 switch(cond_type = identify_operator(&s, &opname))
2661   {
2662   /* def: tests for a non-empty variable, or for the existence of a header. If
2663   yield == NULL we are in a skipping state, and don't care about the answer. */
2664
2665   case ECOND_DEF:
2666     {
2667     const uschar * t;
2668
2669     if (*s != ':')
2670       {
2671       expand_string_message = US"\":\" expected after \"def\"";
2672       goto failout;
2673       }
2674
2675     s = read_name(name, sizeof(name), s+1, US"_");
2676
2677     /* Test for a header's existence. If the name contains a closing brace
2678     character, this may be a user error where the terminating colon has been
2679     omitted. Set a flag to adjust a subsequent error message in this case. */
2680
2681     if (  ( *(t = name) == 'h'
2682           || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
2683           )
2684        && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
2685        )
2686       {
2687       s = read_header_name(name, sizeof(name), s);
2688       /* {-for-text-editors */
2689       if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2690       if (yield) *yield =
2691         (find_header(name, NULL, FH_EXISTS_ONLY, NULL) != NULL) == testfor;
2692       }
2693
2694     /* Test for a variable's having a non-empty value. A non-existent variable
2695     causes an expansion failure. */
2696
2697     else
2698       {
2699       if (!(t = find_variable(name,
2700         yield ? ESI_EXISTS_ONLY : ESI_EXISTS_ONLY | ESI_SKIPPING, NULL)))
2701         {
2702         expand_string_message = name[0]
2703           ? string_sprintf("unknown variable \"%s\" after \"def:\"", name)
2704           : US"variable name omitted after \"def:\"";
2705         check_variable_error_message(name);
2706         goto failout;
2707         }
2708       if (yield) *yield = (t[0] != 0) == testfor;
2709       }
2710
2711     next = s; goto out;
2712     }
2713
2714
2715   /* first_delivery tests for first delivery attempt */
2716
2717   case ECOND_FIRST_DELIVERY:
2718   if (yield) *yield = f.deliver_firsttime == testfor;
2719   next = s; goto out;
2720
2721
2722   /* queue_running tests for any process started by a queue runner */
2723
2724   case ECOND_QUEUE_RUNNING:
2725   if (yield) *yield = (queue_run_pid != (pid_t)0) == testfor;
2726   next = s; goto out;
2727
2728
2729   /* exists:  tests for file existence
2730        isip:  tests for any IP address
2731       isip4:  tests for an IPv4 address
2732       isip6:  tests for an IPv6 address
2733         pam:  does PAM authentication
2734      radius:  does RADIUS authentication
2735    ldapauth:  does LDAP authentication
2736     pwcheck:  does Cyrus SASL pwcheck authentication
2737   */
2738
2739   case ECOND_EXISTS:
2740   case ECOND_ISIP:
2741   case ECOND_ISIP4:
2742   case ECOND_ISIP6:
2743   case ECOND_PAM:
2744   case ECOND_RADIUS:
2745   case ECOND_LDAPAUTH:
2746   case ECOND_PWCHECK:
2747
2748   if (Uskip_whitespace(&s) != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2749
2750    {
2751     BOOL textonly;
2752     sub[0] = expand_string_internal(s+1,
2753       ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yield ? ESI_NOFLAGS : ESI_SKIPPING),
2754       &s, resetok, &textonly);
2755     if (!sub[0]) goto failout;
2756     if (textonly) sub_textonly |= BIT(0);
2757    }
2758   /* {-for-text-editors */
2759   if (*s++ != '}') goto COND_FAILED_CURLY_END;
2760
2761   if (!yield) { next = s; goto out; }  /* No need to run the test if skipping */
2762
2763   switch(cond_type)
2764     {
2765     case ECOND_EXISTS:
2766     if ((expand_forbid & RDO_EXISTS) != 0)
2767       {
2768       expand_string_message = US"File existence tests are not permitted";
2769       goto failout;
2770       }
2771     *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2772     break;
2773
2774     case ECOND_ISIP:
2775     case ECOND_ISIP4:
2776     case ECOND_ISIP6:
2777     {
2778       const uschar *errp;
2779       const uschar **errpp;
2780       DEBUG(D_expand) errpp = &errp; else errpp = 0;
2781       if (0 == (rc = string_is_ip_addressX(sub[0], NULL, errpp)))
2782         DEBUG(D_expand) debug_printf("failed: %s\n", errp);
2783
2784       *yield = ( cond_type == ECOND_ISIP  ? rc != 0 :
2785                  cond_type == ECOND_ISIP4 ? rc == 4 : rc == 6) == testfor;
2786     }
2787
2788     break;
2789
2790     /* Various authentication tests - all optionally compiled */
2791
2792     case ECOND_PAM:
2793     #ifdef SUPPORT_PAM
2794     rc = auth_call_pam(sub[0], &expand_string_message);
2795     goto END_AUTH;
2796     #else
2797     goto COND_FAILED_NOT_COMPILED;
2798     #endif  /* SUPPORT_PAM */
2799
2800     case ECOND_RADIUS:
2801     #ifdef RADIUS_CONFIG_FILE
2802     rc = auth_call_radius(sub[0], &expand_string_message);
2803     goto END_AUTH;
2804     #else
2805     goto COND_FAILED_NOT_COMPILED;
2806     #endif  /* RADIUS_CONFIG_FILE */
2807
2808     case ECOND_LDAPAUTH:
2809     #ifdef LOOKUP_LDAP
2810       {
2811       /* Just to keep the interface the same */
2812       BOOL do_cache;
2813       int old_pool = store_pool;
2814       store_pool = POOL_SEARCH;
2815       rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2816         &expand_string_message, &do_cache);
2817       store_pool = old_pool;
2818       }
2819     goto END_AUTH;
2820     #else
2821     goto COND_FAILED_NOT_COMPILED;
2822     #endif  /* LOOKUP_LDAP */
2823
2824     case ECOND_PWCHECK:
2825     #ifdef CYRUS_PWCHECK_SOCKET
2826     rc = auth_call_pwcheck(sub[0], &expand_string_message);
2827     goto END_AUTH;
2828     #else
2829     goto COND_FAILED_NOT_COMPILED;
2830     #endif  /* CYRUS_PWCHECK_SOCKET */
2831
2832     #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2833         defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2834     END_AUTH:
2835     if (rc == ERROR || rc == DEFER) goto failout;
2836     *yield = (rc == OK) == testfor;
2837     #endif
2838     }
2839   next = s; goto out;
2840
2841
2842   /* call ACL (in a conditional context).  Accept true, deny false.
2843   Defer is a forced-fail.  Anything set by message= goes to $value.
2844   Up to ten parameters are used; we use the braces round the name+args
2845   like the saslauthd condition does, to permit a variable number of args.
2846   See also the expansion-item version EITEM_ACL and the traditional
2847   acl modifier ACLC_ACL.
2848   Since the ACL may allocate new global variables, tell our caller to not
2849   reclaim memory.
2850   */
2851
2852   case ECOND_ACL:
2853     /* ${if acl {{name}{arg1}{arg2}...}  {yes}{no}} */
2854     {
2855     uschar *sub[10];
2856     uschar *user_msg;
2857     BOOL cond = FALSE;
2858
2859     Uskip_whitespace(&s);
2860     if (*s++ != '{') goto COND_FAILED_CURLY_START;      /*}*/
2861
2862     switch(read_subs(sub, nelem(sub), 1, &s,
2863         yield ? ESI_NOFLAGS : ESI_SKIPPING, TRUE, name, resetok, NULL))
2864       {
2865       case 1: expand_string_message = US"too few arguments or bracketing "
2866         "error for acl";
2867       case 2:
2868       case 3: goto failout;
2869       }
2870
2871     if (yield)
2872       {
2873       int rc;
2874       *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2875       switch(rc = eval_acl(sub, nelem(sub), &user_msg))
2876         {
2877         case OK:
2878           cond = TRUE;
2879         case FAIL:
2880           lookup_value = NULL;
2881           if (user_msg)
2882             lookup_value = string_copy(user_msg);
2883           *yield = cond == testfor;
2884           break;
2885
2886         case DEFER:
2887           f.expand_string_forcedfail = TRUE;
2888           /*FALLTHROUGH*/
2889         default:
2890           expand_string_message = string_sprintf("%s from acl \"%s\"",
2891             rc_names[rc], sub[0]);
2892           goto failout;
2893         }
2894       }
2895     next = s; goto out;
2896     }
2897
2898
2899   /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2900
2901      ${if saslauthd {{username}{password}{service}{realm}}  {yes}{no}}
2902
2903   However, the last two are optional. That is why the whole set is enclosed
2904   in their own set of braces. */
2905
2906   case ECOND_SASLAUTHD:
2907 #ifndef CYRUS_SASLAUTHD_SOCKET
2908     goto COND_FAILED_NOT_COMPILED;
2909 #else
2910     {
2911     uschar *sub[4];
2912     Uskip_whitespace(&s);
2913     if (*s++ != '{') goto COND_FAILED_CURLY_START;      /* }-for-text-editors */
2914     switch(read_subs(sub, nelem(sub), 2, &s,
2915         yield ? ESI_NOFLAGS : ESI_SKIPPING, TRUE, name, resetok, NULL))
2916       {
2917       case 1: expand_string_message = US"too few arguments or bracketing "
2918         "error for saslauthd";
2919       case 2:
2920       case 3: goto failout;
2921       }
2922     if (!sub[2]) sub[3] = NULL;  /* realm if no service */
2923     if (yield)
2924       {
2925       int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2926         &expand_string_message);
2927       if (rc == ERROR || rc == DEFER) goto failout;
2928       *yield = (rc == OK) == testfor;
2929       }
2930     next = s; goto out;
2931     }
2932 #endif /* CYRUS_SASLAUTHD_SOCKET */
2933
2934
2935   /* symbolic operators for numeric and string comparison, and a number of
2936   other operators, all requiring two arguments.
2937
2938   crypteq:           encrypts plaintext and compares against an encrypted text,
2939                        using crypt(), crypt16(), MD5 or SHA-1
2940   inlist/inlisti:    checks if first argument is in the list of the second
2941   match:             does a regular expression match and sets up the numerical
2942                        variables if it succeeds
2943   match_address:     matches in an address list
2944   match_domain:      matches in a domain list
2945   match_ip:          matches a host list that is restricted to IP addresses
2946   match_local_part:  matches in a local part list
2947   */
2948
2949   case ECOND_MATCH_ADDRESS:
2950   case ECOND_MATCH_DOMAIN:
2951   case ECOND_MATCH_IP:
2952   case ECOND_MATCH_LOCAL_PART:
2953 #ifndef EXPAND_LISTMATCH_RHS
2954     sub2_honour_dollar = FALSE;
2955 #endif
2956     /* FALLTHROUGH */
2957
2958   case ECOND_CRYPTEQ:
2959   case ECOND_INLIST:
2960   case ECOND_INLISTI:
2961   case ECOND_MATCH:
2962
2963   case ECOND_NUM_L:     /* Numerical comparisons */
2964   case ECOND_NUM_LE:
2965   case ECOND_NUM_E:
2966   case ECOND_NUM_EE:
2967   case ECOND_NUM_G:
2968   case ECOND_NUM_GE:
2969
2970   case ECOND_STR_LT:    /* String comparisons */
2971   case ECOND_STR_LTI:
2972   case ECOND_STR_LE:
2973   case ECOND_STR_LEI:
2974   case ECOND_STR_EQ:
2975   case ECOND_STR_EQI:
2976   case ECOND_STR_GT:
2977   case ECOND_STR_GTI:
2978   case ECOND_STR_GE:
2979   case ECOND_STR_GEI:
2980
2981   for (int i = 0; i < 2; i++)
2982     {
2983     BOOL textonly;
2984     /* Sometimes, we don't expand substrings; too many insecure configurations
2985     created using match_address{}{} and friends, where the second param
2986     includes information from untrustworthy sources. */
2987     /*XXX is this moot given taint-tracking? */
2988
2989     esi_flags flags = ESI_BRACE_ENDS;
2990
2991     if (!(i > 0 && !sub2_honour_dollar)) flags |= ESI_HONOR_DOLLAR;
2992     if (!yield) flags |= ESI_SKIPPING;
2993
2994     if (Uskip_whitespace(&s) != '{')
2995       {
2996       if (i == 0) goto COND_FAILED_CURLY_START;
2997       expand_string_message = string_sprintf("missing 2nd string in {} "
2998         "after \"%s\"", opname);
2999       goto failout;
3000       }
3001     if (!(sub[i] = expand_string_internal(s+1, flags, &s, resetok, &textonly)))
3002       goto failout;
3003     if (textonly) sub_textonly |= BIT(i);
3004     DEBUG(D_expand) if (i == 1 && !sub2_honour_dollar && Ustrchr(sub[1], '$'))
3005       debug_printf_indent("WARNING: the second arg is NOT expanded,"
3006                         " for security reasons\n");
3007     if (*s++ != '}') goto COND_FAILED_CURLY_END;
3008
3009     /* Convert to numerical if required; we know that the names of all the
3010     conditions that compare numbers do not start with a letter. This just saves
3011     checking for them individually. */
3012
3013     if (!isalpha(opname[0]) && yield)
3014       if (sub[i][0] == 0)
3015         {
3016         num[i] = 0;
3017         DEBUG(D_expand)
3018           debug_printf_indent("empty string cast to zero for numerical comparison\n");
3019         }
3020       else
3021         {
3022         num[i] = expanded_string_integer(sub[i], FALSE);
3023         if (expand_string_message) goto failout;
3024         }
3025     }
3026
3027   /* Result not required */
3028
3029   if (!yield) { next = s; goto out; }
3030
3031   /* Do an appropriate comparison */
3032
3033   switch(cond_type)
3034     {
3035     case ECOND_NUM_E:
3036     case ECOND_NUM_EE:
3037       tempcond = (num[0] == num[1]); break;
3038
3039     case ECOND_NUM_G:
3040       tempcond = (num[0] > num[1]); break;
3041
3042     case ECOND_NUM_GE:
3043       tempcond = (num[0] >= num[1]); break;
3044
3045     case ECOND_NUM_L:
3046       tempcond = (num[0] < num[1]); break;
3047
3048     case ECOND_NUM_LE:
3049       tempcond = (num[0] <= num[1]); break;
3050
3051     case ECOND_STR_LT:
3052       tempcond = (Ustrcmp(sub[0], sub[1]) < 0); break;
3053
3054     case ECOND_STR_LTI:
3055       tempcond = (strcmpic(sub[0], sub[1]) < 0); break;
3056
3057     case ECOND_STR_LE:
3058       tempcond = (Ustrcmp(sub[0], sub[1]) <= 0); break;
3059
3060     case ECOND_STR_LEI:
3061       tempcond = (strcmpic(sub[0], sub[1]) <= 0); break;
3062
3063     case ECOND_STR_EQ:
3064       tempcond = (Ustrcmp(sub[0], sub[1]) == 0); break;
3065
3066     case ECOND_STR_EQI:
3067       tempcond = (strcmpic(sub[0], sub[1]) == 0); break;
3068
3069     case ECOND_STR_GT:
3070       tempcond = (Ustrcmp(sub[0], sub[1]) > 0); break;
3071
3072     case ECOND_STR_GTI:
3073       tempcond = (strcmpic(sub[0], sub[1]) > 0); break;
3074
3075     case ECOND_STR_GE:
3076       tempcond = (Ustrcmp(sub[0], sub[1]) >= 0); break;
3077
3078     case ECOND_STR_GEI:
3079       tempcond = (strcmpic(sub[0], sub[1]) >= 0); break;
3080
3081     case ECOND_MATCH:   /* Regular expression match */
3082       {
3083       const pcre2_code * re = regex_compile(sub[1],
3084                   sub_textonly & BIT(1) ? MCS_CACHEABLE : MCS_NOFLAGS,
3085                   &expand_string_message, pcre_gen_cmp_ctx);
3086       if (!re)
3087         goto failout;
3088
3089       tempcond = regex_match_and_setup(re, sub[0], 0, -1);
3090       break;
3091       }
3092
3093     case ECOND_MATCH_ADDRESS:  /* Match in an address list */
3094       rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0,
3095                               CUSS &lookup_value);
3096       goto MATCHED_SOMETHING;
3097
3098     case ECOND_MATCH_DOMAIN:   /* Match in a domain list */
3099       rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
3100         MCL_DOMAIN + MCL_NOEXPAND, TRUE, CUSS &lookup_value);
3101       goto MATCHED_SOMETHING;
3102
3103     case ECOND_MATCH_IP:       /* Match IP address in a host list */
3104       if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
3105         {
3106         expand_string_message = string_sprintf("\"%s\" is not an IP address",
3107           sub[0]);
3108         goto failout;
3109         }
3110       else
3111         {
3112         unsigned int *nullcache = NULL;
3113         check_host_block cb;
3114
3115         cb.host_name = US"";
3116         cb.host_address = sub[0];
3117
3118         /* If the host address starts off ::ffff: it is an IPv6 address in
3119         IPv4-compatible mode. Find the IPv4 part for checking against IPv4
3120         addresses. */
3121
3122         cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
3123           cb.host_address + 7 : cb.host_address;
3124
3125         rc = match_check_list(
3126                &sub[1],                   /* the list */
3127                0,                         /* separator character */
3128                &hostlist_anchor,          /* anchor pointer */
3129                &nullcache,                /* cache pointer */
3130                check_host,                /* function for testing */
3131                &cb,                       /* argument for function */
3132                MCL_HOST,                  /* type of check */
3133                sub[0],                    /* text for debugging */
3134                CUSS &lookup_value);       /* where to pass back data */
3135         }
3136       goto MATCHED_SOMETHING;
3137
3138     case ECOND_MATCH_LOCAL_PART:
3139       rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
3140         MCL_LOCALPART + MCL_NOEXPAND, TRUE, CUSS &lookup_value);
3141       /* Fall through */
3142       /* VVVVVVVVVVVV */
3143       MATCHED_SOMETHING:
3144       switch(rc)
3145         {
3146         case OK:   tempcond = TRUE;  break;
3147         case FAIL: tempcond = FALSE; break;
3148
3149         case DEFER:
3150           expand_string_message = string_sprintf("unable to complete match "
3151             "against \"%s\": %s", sub[1], search_error_message);
3152           goto failout;
3153         }
3154
3155       break;
3156
3157     /* Various "encrypted" comparisons. If the second string starts with
3158     "{" then an encryption type is given. Default to crypt() or crypt16()
3159     (build-time choice). */
3160     /* }-for-text-editors */
3161
3162     case ECOND_CRYPTEQ:
3163     #ifndef SUPPORT_CRYPTEQ
3164       goto COND_FAILED_NOT_COMPILED;
3165     #else
3166       if (strncmpic(sub[1], US"{md5}", 5) == 0)
3167         {
3168         int sublen = Ustrlen(sub[1]+5);
3169         md5 base;
3170         uschar digest[16];
3171
3172         md5_start(&base);
3173         md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
3174
3175         /* If the length that we are comparing against is 24, the MD5 digest
3176         is expressed as a base64 string. This is the way LDAP does it. However,
3177         some other software uses a straightforward hex representation. We assume
3178         this if the length is 32. Other lengths fail. */
3179
3180         if (sublen == 24)
3181           {
3182           uschar *coded = b64encode(CUS digest, 16);
3183           DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
3184             "  subject=%s\n  crypted=%s\n", coded, sub[1]+5);
3185           tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
3186           }
3187         else if (sublen == 32)
3188           {
3189           uschar coded[36];
3190           for (int i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
3191           coded[32] = 0;
3192           DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
3193             "  subject=%s\n  crypted=%s\n", coded, sub[1]+5);
3194           tempcond = (strcmpic(coded, sub[1]+5) == 0);
3195           }
3196         else
3197           {
3198           DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
3199             "fail\n  crypted=%s\n", sub[1]+5);
3200           tempcond = FALSE;
3201           }
3202         }
3203
3204       else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
3205         {
3206         int sublen = Ustrlen(sub[1]+6);
3207         hctx h;
3208         uschar digest[20];
3209
3210         sha1_start(&h);
3211         sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
3212
3213         /* If the length that we are comparing against is 28, assume the SHA1
3214         digest is expressed as a base64 string. If the length is 40, assume a
3215         straightforward hex representation. Other lengths fail. */
3216
3217         if (sublen == 28)
3218           {
3219           uschar *coded = b64encode(CUS digest, 20);
3220           DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
3221             "  subject=%s\n  crypted=%s\n", coded, sub[1]+6);
3222           tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
3223           }
3224         else if (sublen == 40)
3225           {
3226           uschar coded[44];
3227           for (int i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
3228           coded[40] = 0;
3229           DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
3230             "  subject=%s\n  crypted=%s\n", coded, sub[1]+6);
3231           tempcond = (strcmpic(coded, sub[1]+6) == 0);
3232           }
3233         else
3234           {
3235           DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
3236             "fail\n  crypted=%s\n", sub[1]+6);
3237           tempcond = FALSE;
3238           }
3239         }
3240
3241       else   /* {crypt} or {crypt16} and non-{ at start */
3242              /* }-for-text-editors */
3243         {
3244         int which = 0;
3245         uschar *coded;
3246
3247         if (strncmpic(sub[1], US"{crypt}", 7) == 0)
3248           {
3249           sub[1] += 7;
3250           which = 1;
3251           }
3252         else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
3253           {
3254           sub[1] += 9;
3255           which = 2;
3256           }
3257         else if (sub[1][0] == '{')              /* }-for-text-editors */
3258           {
3259           expand_string_message = string_sprintf("unknown encryption mechanism "
3260             "in \"%s\"", sub[1]);
3261           goto failout;
3262           }
3263
3264         switch(which)
3265           {
3266           case 0:  coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
3267           case 1:  coded = US crypt(CS sub[0], CS sub[1]); break;
3268           default: coded = US crypt16(CS sub[0], CS sub[1]); break;
3269           }
3270
3271         #define STR(s) # s
3272         #define XSTR(s) STR(s)
3273         DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
3274           "  subject=%s\n  crypted=%s\n",
3275           which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
3276           coded, sub[1]);
3277         #undef STR
3278         #undef XSTR
3279
3280         /* If the encrypted string contains fewer than two characters (for the
3281         salt), force failure. Otherwise we get false positives: with an empty
3282         string the yield of crypt() is an empty string! */
3283
3284         if (coded)
3285           tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
3286         else if (errno == EINVAL)
3287           tempcond = FALSE;
3288         else
3289           {
3290           expand_string_message = string_sprintf("crypt error: %s\n",
3291             US strerror(errno));
3292           goto failout;
3293           }
3294         }
3295       break;
3296     #endif  /* SUPPORT_CRYPTEQ */
3297
3298     case ECOND_INLIST:
3299     case ECOND_INLISTI:
3300       {
3301       const uschar * list = sub[1];
3302       int sep = 0;
3303       uschar *save_iterate_item = iterate_item;
3304       int (*compare)(const uschar *, const uschar *);
3305
3306       DEBUG(D_expand) debug_printf_indent("condition: %s  item: %s\n", opname, sub[0]);
3307
3308       tempcond = FALSE;
3309       compare = cond_type == ECOND_INLISTI
3310         ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
3311
3312       while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
3313         {
3314         DEBUG(D_expand) debug_printf_indent(" compare %s\n", iterate_item);
3315         if (compare(sub[0], iterate_item) == 0)
3316           {
3317           tempcond = TRUE;
3318           lookup_value = iterate_item;
3319           break;
3320           }
3321         }
3322       iterate_item = save_iterate_item;
3323       }
3324
3325     }   /* Switch for comparison conditions */
3326
3327   *yield = tempcond == testfor;
3328   next = s; goto out;    /* End of comparison conditions */
3329
3330
3331   /* and/or: computes logical and/or of several conditions */
3332
3333   case ECOND_AND:
3334   case ECOND_OR:
3335   subcondptr = (yield == NULL) ? NULL : &tempcond;
3336   combined_cond = (cond_type == ECOND_AND);
3337
3338   Uskip_whitespace(&s);
3339   if (*s++ != '{') goto COND_FAILED_CURLY_START;        /* }-for-text-editors */
3340
3341   for (;;)
3342     {
3343     /* {-for-text-editors */
3344     if (Uskip_whitespace(&s) == '}') break;
3345     if (*s != '{')                                      /* }-for-text-editors */
3346       {
3347       expand_string_message = string_sprintf("each subcondition "
3348         "inside an \"%s{...}\" condition must be in its own {}", opname);
3349       goto failout;
3350       }
3351
3352     if (!(s = eval_condition(s+1, resetok, subcondptr)))
3353       {
3354       expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
3355         expand_string_message, opname);
3356       goto failout;
3357       }
3358     Uskip_whitespace(&s);
3359
3360     /* {-for-text-editors */
3361     if (*s++ != '}')
3362       {
3363       /* {-for-text-editors */
3364       expand_string_message = string_sprintf("missing } at end of condition "
3365         "inside \"%s\" group", opname);
3366       goto failout;
3367       }
3368
3369     if (yield)
3370       if (cond_type == ECOND_AND)
3371         {
3372         combined_cond &= tempcond;
3373         if (!combined_cond) subcondptr = NULL;  /* once false, don't */
3374         }                                       /* evaluate any more */
3375       else
3376         {
3377         combined_cond |= tempcond;
3378         if (combined_cond) subcondptr = NULL;   /* once true, don't */
3379         }                                       /* evaluate any more */
3380     }
3381
3382   if (yield) *yield = (combined_cond == testfor);
3383   next = ++s; goto out;
3384
3385
3386   /* forall/forany: iterates a condition with different values */
3387
3388   case ECOND_FORALL:      is_forany = FALSE;  is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3389   case ECOND_FORANY:      is_forany = TRUE;   is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3390   case ECOND_FORALL_JSON: is_forany = FALSE;  is_json = TRUE;  is_jsons = FALSE; goto FORMANY;
3391   case ECOND_FORANY_JSON: is_forany = TRUE;   is_json = TRUE;  is_jsons = FALSE; goto FORMANY;
3392   case ECOND_FORALL_JSONS: is_forany = FALSE; is_json = TRUE;  is_jsons = TRUE;  goto FORMANY;
3393   case ECOND_FORANY_JSONS: is_forany = TRUE;  is_json = TRUE;  is_jsons = TRUE;  goto FORMANY;
3394
3395   FORMANY:
3396     {
3397     const uschar * list;
3398     int sep = 0;
3399     uschar *save_iterate_item = iterate_item;
3400
3401     DEBUG(D_expand) debug_printf_indent("condition: %s\n", opname);
3402
3403     Uskip_whitespace(&s);
3404     if (*s++ != '{') goto COND_FAILED_CURLY_START;      /* }-for-text-editors */
3405     if (!(sub[0] = expand_string_internal(s,
3406       ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yield ? ESI_NOFLAGS : ESI_SKIPPING),
3407       &s, resetok, NULL)))
3408       goto failout;
3409     /* {-for-text-editors */
3410     if (*s++ != '}') goto COND_FAILED_CURLY_END;
3411
3412     Uskip_whitespace(&s);
3413     if (*s++ != '{') goto COND_FAILED_CURLY_START;      /* }-for-text-editors */
3414
3415     sub[1] = s;
3416
3417     /* Call eval_condition once, with result discarded (as if scanning a
3418     "false" part). This allows us to find the end of the condition, because if
3419     the list it empty, we won't actually evaluate the condition for real. */
3420
3421     if (!(s = eval_condition(sub[1], resetok, NULL)))
3422       {
3423       expand_string_message = string_sprintf("%s inside \"%s\" condition",
3424         expand_string_message, opname);
3425       goto failout;
3426       }
3427     Uskip_whitespace(&s);
3428
3429     /* {-for-text-editors */
3430     if (*s++ != '}')
3431       {
3432       /* {-for-text-editors */
3433       expand_string_message = string_sprintf("missing } at end of condition "
3434         "inside \"%s\"", opname);
3435       goto failout;
3436       }
3437
3438     if (yield) *yield = !testfor;
3439     list = sub[0];
3440     if (is_json) list = dewrap(string_copy(list), US"[]");
3441     while ((iterate_item = is_json
3442       ? json_nextinlist(&list) : string_nextinlist(&list, &sep, NULL, 0)))
3443       {
3444       if (is_jsons)
3445         if (!(iterate_item = dewrap(iterate_item, US"\"\"")))
3446           {
3447           expand_string_message =
3448             string_sprintf("%s wrapping string result for extract jsons",
3449               expand_string_message);
3450           iterate_item = save_iterate_item;
3451           goto failout;
3452           }
3453
3454       DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", opname, iterate_item);
3455       if (!eval_condition(sub[1], resetok, &tempcond))
3456         {
3457         expand_string_message = string_sprintf("%s inside \"%s\" condition",
3458           expand_string_message, opname);
3459         iterate_item = save_iterate_item;
3460         goto failout;
3461         }
3462       DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", opname,
3463         tempcond? "true":"false");
3464
3465       if (yield) *yield = (tempcond == testfor);
3466       if (tempcond == is_forany) break;
3467       }
3468
3469     iterate_item = save_iterate_item;
3470     next = s; goto out;
3471     }
3472
3473
3474   /* The bool{} expansion condition maps a string to boolean.
3475   The values supported should match those supported by the ACL condition
3476   (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
3477   of true/false.  Note that Router "condition" rules have a different
3478   interpretation, where general data can be used and only a few values
3479   map to FALSE.
3480   Note that readconf.c boolean matching, for boolean configuration options,
3481   only matches true/yes/false/no.
3482   The bool_lax{} condition matches the Router logic, which is much more
3483   liberal. */
3484   case ECOND_BOOL:
3485   case ECOND_BOOL_LAX:
3486     {
3487     uschar *sub_arg[1];
3488     uschar *t, *t2;
3489     uschar *ourname;
3490     size_t len;
3491     BOOL boolvalue = FALSE;
3492
3493     if (Uskip_whitespace(&s) != '{') goto COND_FAILED_CURLY_START;      /* }-for-text-editors */
3494     ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
3495     switch(read_subs(sub_arg, 1, 1, &s,
3496             yield ? ESI_NOFLAGS : ESI_SKIPPING, FALSE, ourname, resetok, NULL))
3497       {
3498       case 1: expand_string_message = string_sprintf(
3499                   "too few arguments or bracketing error for %s",
3500                   ourname);
3501       /*FALLTHROUGH*/
3502       case 2:
3503       case 3: goto failout;
3504       }
3505     t = sub_arg[0];
3506     Uskip_whitespace(&t);
3507     if ((len = Ustrlen(t)))
3508       {
3509       /* trailing whitespace: seems like a good idea to ignore it too */
3510       t2 = t + len - 1;
3511       while (isspace(*t2)) t2--;
3512       if (t2 != (t + len))
3513         {
3514         *++t2 = '\0';
3515         len = t2 - t;
3516         }
3517       }
3518     DEBUG(D_expand)
3519       debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>");
3520     /* logic for the lax case from expand_check_condition(), which also does
3521     expands, and the logic is both short and stable enough that there should
3522     be no maintenance burden from replicating it. */
3523     if (len == 0)
3524       boolvalue = FALSE;
3525     else if (*t == '-'
3526              ? Ustrspn(t+1, "0123456789") == len-1
3527              : Ustrspn(t,   "0123456789") == len)
3528       {
3529       boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3530       /* expand_check_condition only does a literal string "0" check */
3531       if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3532         boolvalue = TRUE;
3533       }
3534     else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3535       boolvalue = TRUE;
3536     else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3537       boolvalue = FALSE;
3538     else if (cond_type == ECOND_BOOL_LAX)
3539       boolvalue = TRUE;
3540     else
3541       {
3542       expand_string_message = string_sprintf("unrecognised boolean "
3543        "value \"%s\"", t);
3544       goto failout;
3545       }
3546     DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname,
3547         boolvalue? "true":"false");
3548     if (yield) *yield = (boolvalue == testfor);
3549     next = s; goto out;
3550     }
3551
3552 #ifdef SUPPORT_SRS
3553   case ECOND_INBOUND_SRS:
3554     /* ${if inbound_srs {local_part}{secret}  {yes}{no}} */
3555     {
3556     uschar * sub[2];
3557     const pcre2_code * re;
3558     pcre2_match_data * md;
3559     PCRE2_SIZE * ovec;
3560     int quoting = 0;
3561     uschar cksum[4];
3562     BOOL boolvalue = FALSE;
3563
3564     switch(read_subs(sub, 2, 2, CUSS &s,
3565             yield ? ESI_NOFLAGS : ESI_SKIPPING, FALSE, name, resetok, NULL))
3566       {
3567       case 1: expand_string_message = US"too few arguments or bracketing "
3568         "error for inbound_srs";
3569       case 2:
3570       case 3: goto failout;
3571       }
3572
3573     /* Match the given local_part against the SRS-encoded pattern */
3574
3575     re = regex_must_compile(US"^(?i)SRS0=([^=]+)=([A-Z2-7]{2})=([^=]*)=(.*)$",
3576                             MCS_CASELESS | MCS_CACHEABLE, FALSE);
3577     md = pcre2_match_data_create(4+1, pcre_gen_ctx);
3578     if (pcre2_match(re, sub[0], PCRE2_ZERO_TERMINATED, 0, PCRE_EOPT,
3579                     md, pcre_gen_mtc_ctx) < 0)
3580       {
3581       DEBUG(D_expand) debug_printf("no match for SRS'd local-part pattern\n");
3582       goto srs_result;
3583       }
3584     ovec = pcre2_get_ovector_pointer(md);
3585
3586     if (sub[0][0] == '"')
3587       quoting = 1;
3588     else for (uschar * s = sub[0]; *s; s++)
3589       if (!isalnum(*s) && Ustrchr(".!#$%&'*+-/=?^_`{|}~", *s) == NULL)
3590         { quoting = 1; break; }
3591     if (quoting)
3592       DEBUG(D_expand) debug_printf_indent("auto-quoting local part\n");
3593
3594     /* Record the (quoted, if needed) decoded recipient as $srs_recipient */
3595
3596     srs_recipient = string_sprintf("%.*s%.*S%.*s@%.*S",         /* lowercased */
3597                       quoting, "\"",
3598                       (int) (ovec[9]-ovec[8]), sub[0] + ovec[8],  /* substr 4 */
3599                       quoting, "\"",
3600                       (int) (ovec[7]-ovec[6]), sub[0] + ovec[6]); /* substr 3 */
3601
3602     /* If a zero-length secret was given, we're done.  Otherwise carry on
3603     and validate the given SRS local_part againt our secret. */
3604
3605     if (*sub[1])
3606       {
3607       /* check the timestamp */
3608         {
3609         struct timeval now;
3610         uschar * ss = sub[0] + ovec[4]; /* substring 2, the timestamp */
3611         long d;
3612         int n;
3613
3614         gettimeofday(&now, NULL);
3615         now.tv_sec /= 86400;                    /* days since epoch */
3616
3617         /* Decode substring 2 from base32 to a number */
3618
3619         for (d = 0, n = ovec[5]-ovec[4]; n; n--)
3620           {
3621           uschar * t = Ustrchr(base32_chars, *ss++);
3622           d = d * 32 + (t - base32_chars);
3623           }
3624
3625         if (((now.tv_sec - d) & 0x3ff) > 10)    /* days since SRS generated */
3626           {
3627           DEBUG(D_expand) debug_printf("SRS too old\n");
3628           goto srs_result;
3629           }
3630         }
3631
3632       /* check length of substring 1, the offered checksum */
3633
3634       if (ovec[3]-ovec[2] != 4)
3635         {
3636         DEBUG(D_expand) debug_printf("SRS checksum wrong size\n");
3637         goto srs_result;
3638         }
3639
3640       /* Hash the address with our secret, and compare that computed checksum
3641       with the one extracted from the arg */
3642
3643       hmac_md5(sub[1], srs_recipient, cksum, sizeof(cksum));
3644       if (Ustrncmp(cksum, sub[0] + ovec[2], 4) != 0)
3645         {
3646         DEBUG(D_expand) debug_printf("SRS checksum mismatch\n");
3647         goto srs_result;
3648         }
3649       }
3650     boolvalue = TRUE;
3651
3652 srs_result:
3653     /* pcre2_match_data_free(md);       gen ctx needs no free */
3654     if (yield) *yield = (boolvalue == testfor);
3655     next = s; goto out;
3656     }
3657 #endif /*SUPPORT_SRS*/
3658
3659   /* Unknown condition */
3660
3661   default:
3662     if (!expand_string_message || !*expand_string_message)
3663       expand_string_message = string_sprintf("unknown condition \"%s\"", opname);
3664     goto failout;
3665   }   /* End switch on condition type */
3666
3667 /* Missing braces at start and end of data */
3668
3669 COND_FAILED_CURLY_START:
3670 expand_string_message = string_sprintf("missing { after \"%s\"", opname);
3671 goto failout;
3672
3673 COND_FAILED_CURLY_END:
3674 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3675   opname);
3676 goto failout;
3677
3678 /* A condition requires code that is not compiled */
3679
3680 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3681     !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3682     !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3683 COND_FAILED_NOT_COMPILED:
3684 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3685   opname);
3686 goto failout;
3687 #endif
3688
3689 failout:
3690   next = NULL;
3691 out:
3692   expand_level--;
3693   return next;
3694 }
3695
3696
3697
3698
3699 /*************************************************
3700 *          Save numerical variables              *
3701 *************************************************/
3702
3703 /* This function is called from items such as "if" that want to preserve and
3704 restore the numbered variables.
3705
3706 Arguments:
3707   save_expand_string    points to an array of pointers to set
3708   save_expand_nlength   points to an array of ints for the lengths
3709
3710 Returns:                the value of expand max to save
3711 */
3712
3713 static int
3714 save_expand_strings(const uschar **save_expand_nstring, int *save_expand_nlength)
3715 {
3716 for (int i = 0; i <= expand_nmax; i++)
3717   {
3718   save_expand_nstring[i] = expand_nstring[i];
3719   save_expand_nlength[i] = expand_nlength[i];
3720   }
3721 return expand_nmax;
3722 }
3723
3724
3725
3726 /*************************************************
3727 *           Restore numerical variables          *
3728 *************************************************/
3729
3730 /* This function restored saved values of numerical strings.
3731
3732 Arguments:
3733   save_expand_nmax      the number of strings to restore
3734   save_expand_string    points to an array of pointers
3735   save_expand_nlength   points to an array of ints
3736
3737 Returns:                nothing
3738 */
3739
3740 static void
3741 restore_expand_strings(int save_expand_nmax, const uschar **save_expand_nstring,
3742   int *save_expand_nlength)
3743 {
3744 expand_nmax = save_expand_nmax;
3745 for (int i = 0; i <= expand_nmax; i++)
3746   {
3747   expand_nstring[i] = save_expand_nstring[i];
3748   expand_nlength[i] = save_expand_nlength[i];
3749   }
3750 }
3751
3752
3753
3754
3755
3756 /*************************************************
3757 *            Handle yes/no substrings            *
3758 *************************************************/
3759
3760 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3761 alternative substrings that depend on whether or not the condition was true,
3762 or the lookup or extraction succeeded. The substrings always have to be
3763 expanded, to check their syntax, but "skipping" is set when the result is not
3764 needed - this avoids unnecessary nested lookups.
3765
3766 Arguments:
3767   flags
3768    skipping       TRUE if we were skipping when this item was reached
3769   yes            TRUE if the first string is to be used, else use the second
3770   save_lookup    a value to put back into lookup_value before the 2nd expansion
3771   sptr           points to the input string pointer
3772   yieldptr       points to the output growable-string pointer
3773   type           "lookup", "if", "extract", "run", "env", "listextract" or
3774                  "certextract" for error message
3775   resetok        if not NULL, pointer to flag - write FALSE if unsafe to reset
3776                 the store.
3777
3778 Returns:         0 OK; lookup_value has been reset to save_lookup
3779                  1 expansion failed
3780                  2 expansion failed because of bracketing error
3781 */
3782
3783 static int
3784 process_yesno(esi_flags flags, BOOL yes, uschar *save_lookup, const uschar **sptr,
3785   gstring ** yieldptr, uschar *type, BOOL *resetok)
3786 {
3787 int rc = 0;
3788 const uschar *s = *sptr;    /* Local value */
3789 uschar *sub1, *sub2;
3790 const uschar * errwhere;
3791
3792 flags &= ESI_SKIPPING;          /* Ignore all buf the skipping flag */
3793
3794 /* If there are no following strings, we substitute the contents of $value for
3795 lookups and for extractions in the success case. For the ${if item, the string
3796 "true" is substituted. In the fail case, nothing is substituted for all three
3797 items. */
3798
3799 if (skip_whitespace(&s) == '}')
3800   {
3801   if (type[0] == 'i')
3802     {
3803     if (yes && !(flags & ESI_SKIPPING))
3804       *yieldptr = string_catn(*yieldptr, US"true", 4);
3805     }
3806   else
3807     {
3808     if (yes && lookup_value && !(flags & ESI_SKIPPING))
3809       *yieldptr = string_cat(*yieldptr, lookup_value);
3810     lookup_value = save_lookup;
3811     }
3812   s++;
3813   goto RETURN;
3814   }
3815
3816 /* The first following string must be braced. */
3817
3818 if (*s++ != '{')
3819   {
3820   errwhere = US"'yes' part did not start with '{'";             /*}}*/
3821   goto FAILED_CURLY;
3822   }
3823
3824 /* Expand the first substring. Forced failures are noticed only if we actually
3825 want this string. Set skipping in the call in the fail case (this will always
3826 be the case if we were already skipping). */
3827
3828 sub1 = expand_string_internal(s,
3829   ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yes ? ESI_NOFLAGS : ESI_SKIPPING),
3830   &s, resetok, NULL);
3831 if (sub1 == NULL && (yes || !f.expand_string_forcedfail)) goto FAILED;
3832 f.expand_string_forcedfail = FALSE;
3833                                                                 /*{{*/
3834 if (*s++ != '}')
3835   {
3836   errwhere = US"'yes' part did not end with '}'";
3837   goto FAILED_CURLY;
3838   }
3839
3840 /* If we want the first string, add it to the output */
3841
3842 if (yes)
3843   *yieldptr = string_cat(*yieldptr, sub1);
3844
3845 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3846 $value to what it was at the start of the item, so that it has this value
3847 during the second string expansion. For the call from "if" or "run" to this
3848 function, save_lookup is set to lookup_value, so that this statement does
3849 nothing. */
3850
3851 lookup_value = save_lookup;
3852
3853 /* There now follows either another substring, or "fail", or nothing. This
3854 time, forced failures are noticed only if we want the second string. We must
3855 set skipping in the nested call if we don't want this string, or if we were
3856 already skipping. */
3857
3858 if (skip_whitespace(&s) == '{')                                 /*}*/
3859   {
3860   esi_flags s_flags = ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags;
3861   if (yes) s_flags |= ESI_SKIPPING;
3862   sub2 = expand_string_internal(s+1, s_flags, &s, resetok, NULL);
3863   if (!sub2 && (!yes || !f.expand_string_forcedfail)) goto FAILED;
3864   f.expand_string_forcedfail = FALSE;                           /*{*/
3865   if (*s++ != '}')
3866     {
3867     errwhere = US"'no' part did not start with '{'";            /*}*/
3868     goto FAILED_CURLY;
3869     }
3870
3871   /* If we want the second string, add it to the output */
3872
3873   if (!yes)
3874     *yieldptr = string_cat(*yieldptr, sub2);
3875   }
3876                                                                 /*{{*/
3877 /* If there is no second string, but the word "fail" is present when the use of
3878 the second string is wanted, set a flag indicating it was a forced failure
3879 rather than a syntactic error. Swallow the terminating } in case this is nested
3880 inside another lookup or if or extract. */
3881
3882 else if (*s != '}')
3883   {
3884   uschar name[256];
3885   /* deconst cast ok here as source is s anyway */
3886   s = US read_name(name, sizeof(name), s, US"_");
3887   if (Ustrcmp(name, "fail") == 0)
3888     {
3889     if (!yes && !(flags & ESI_SKIPPING))
3890       {
3891       Uskip_whitespace(&s);                                     /*{{*/
3892       if (*s++ != '}')
3893         {
3894         errwhere = US"did not close with '}' after forcedfail";
3895         goto FAILED_CURLY;
3896         }
3897       expand_string_message =
3898         string_sprintf("\"%s\" failed and \"fail\" requested", type);
3899       f.expand_string_forcedfail = TRUE;
3900       goto FAILED;
3901       }
3902     }
3903   else
3904     {
3905     expand_string_message =
3906       string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3907     goto FAILED;
3908     }
3909   }
3910
3911 /* All we have to do now is to check on the final closing brace. */
3912
3913 skip_whitespace(&s);                                            /*{{*/
3914 if (*s++ != '}')
3915   {
3916   errwhere = US"did not close with '}'";
3917   goto FAILED_CURLY;
3918   }
3919
3920
3921 RETURN:
3922 /* Update the input pointer value before returning */
3923 *sptr = s;
3924 return rc;
3925
3926 FAILED_CURLY:
3927   /* Get here if there is a bracketing failure */
3928   expand_string_message = string_sprintf(
3929     "curly-bracket problem in conditional yes/no parsing: %s\n"
3930     " remaining string is '%s'", errwhere, --s);
3931   rc = 2;
3932   goto RETURN;
3933
3934 FAILED:
3935   /* Get here for other failures */
3936   rc = 1;
3937   goto RETURN;
3938 }
3939
3940
3941
3942
3943 /********************************************************
3944 * prvs: Get last three digits of days since Jan 1, 1970 *
3945 ********************************************************/
3946
3947 /* This is needed to implement the "prvs" BATV reverse
3948    path signing scheme
3949
3950 Argument: integer "days" offset to add or substract to
3951           or from the current number of days.
3952
3953 Returns:  pointer to string containing the last three
3954           digits of the number of days since Jan 1, 1970,
3955           modified by the offset argument, NULL if there
3956           was an error in the conversion.
3957
3958 */
3959
3960 static uschar *
3961 prvs_daystamp(int day_offset)
3962 {
3963 uschar * days = store_get(32, GET_UNTAINTED);      /* Need at least 24 for cases */
3964 (void)string_format(days, 32, TIME_T_FMT,          /* where TIME_T_FMT is %lld */
3965   (time(NULL) + day_offset*86400)/86400);
3966 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3967 }
3968
3969
3970
3971 /********************************************************
3972 *   prvs: perform HMAC-SHA1 computation of prvs bits    *
3973 ********************************************************/
3974
3975 /* This is needed to implement the "prvs" BATV reverse
3976    path signing scheme
3977
3978 Arguments:
3979   address RFC2821 Address to use
3980       key The key to use (must be less than 64 characters
3981           in size)
3982   key_num Single-digit key number to use. Defaults to
3983           '0' when NULL.
3984
3985 Returns:  pointer to string containing the first three
3986           bytes of the final hash in hex format, NULL if
3987           there was an error in the process.
3988 */
3989
3990 static uschar *
3991 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3992 {
3993 gstring * hash_source;
3994 uschar * p;
3995 hctx h;
3996 uschar innerhash[20];
3997 uschar finalhash[20];
3998 uschar innerkey[64];
3999 uschar outerkey[64];
4000 uschar *finalhash_hex;
4001
4002 if (!key_num)
4003   key_num = US"0";
4004
4005 if (Ustrlen(key) > 64)
4006   return NULL;
4007
4008 hash_source = string_catn(NULL, key_num, 1);
4009 hash_source = string_catn(hash_source, daystamp, 3);
4010 hash_source = string_cat(hash_source, address);
4011
4012 DEBUG(D_expand)
4013   debug_printf_indent("prvs: hash source is '%Y'\n", hash_source);
4014
4015 memset(innerkey, 0x36, 64);
4016 memset(outerkey, 0x5c, 64);
4017
4018 for (int i = 0; i < Ustrlen(key); i++)
4019   {
4020   innerkey[i] ^= key[i];
4021   outerkey[i] ^= key[i];
4022   }
4023
4024 chash_start(HMAC_SHA1, &h);
4025 chash_mid(HMAC_SHA1, &h, innerkey);
4026 chash_end(HMAC_SHA1, &h, hash_source->s, hash_source->ptr, innerhash);
4027
4028 chash_start(HMAC_SHA1, &h);
4029 chash_mid(HMAC_SHA1, &h, outerkey);
4030 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
4031
4032 /* Hashing is deemed sufficient to de-taint any input data */
4033
4034 p = finalhash_hex = store_get(40, GET_UNTAINTED);
4035 for (int i = 0; i < 3; i++)
4036   {
4037   *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
4038   *p++ = hex_digits[finalhash[i] & 0x0f];
4039   }
4040 *p = '\0';
4041
4042 return finalhash_hex;
4043 }
4044
4045
4046
4047
4048 /*************************************************
4049 *        Join a file onto the output string      *
4050 *************************************************/
4051
4052 /* This is used for readfile/readsock and after a run expansion.
4053 It joins the contents of a file onto the output string, globally replacing
4054 newlines with a given string (optionally).
4055
4056 Arguments:
4057   f            the FILE
4058   yield        pointer to the expandable string struct
4059   eol          newline replacement string, or NULL
4060
4061 Returns:       new pointer for expandable string, terminated if non-null
4062 */
4063
4064 gstring *
4065 cat_file(FILE * f, gstring * yield, uschar * eol)
4066 {
4067 uschar buffer[1024];
4068
4069 while (Ufgets(buffer, sizeof(buffer), f))
4070   {
4071   int len = Ustrlen(buffer);
4072   if (eol && buffer[len-1] == '\n') len--;
4073   yield = string_catn(yield, buffer, len);
4074   if (eol && buffer[len])
4075     yield = string_cat(yield, eol);
4076   }
4077 return yield;
4078 }
4079
4080
4081 #ifndef DISABLE_TLS
4082 gstring *
4083 cat_file_tls(void * tls_ctx, gstring * yield, uschar * eol)
4084 {
4085 int rc;
4086 uschar buffer[1024];
4087
4088 /*XXX could we read direct into a pre-grown string? */
4089
4090 while ((rc = tls_read(tls_ctx, buffer, sizeof(buffer))) > 0)
4091   for (uschar * s = buffer; rc--; s++)
4092     yield = eol && *s == '\n'
4093       ? string_cat(yield, eol) : string_catn(yield, s, 1);
4094
4095 /* We assume that all errors, and any returns of zero bytes,
4096 are actually EOF. */
4097
4098 return yield;
4099 }
4100 #endif
4101
4102
4103 /*************************************************
4104 *          Evaluate numeric expression           *
4105 *************************************************/
4106
4107 /* This is a set of mutually recursive functions that evaluate an arithmetic
4108 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
4109 these functions that is called from elsewhere is eval_expr, whose interface is:
4110
4111 Arguments:
4112   sptr        pointer to the pointer to the string - gets updated
4113   decimal     TRUE if numbers are to be assumed decimal
4114   error       pointer to where to put an error message - must be NULL on input
4115   endket      TRUE if ')' must terminate - FALSE for external call
4116
4117 Returns:      on success: the value of the expression, with *error still NULL
4118               on failure: an undefined value, with *error = a message
4119 */
4120
4121 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
4122
4123
4124 static int_eximarith_t
4125 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
4126 {
4127 uschar *s = *sptr;
4128 int_eximarith_t x = eval_op_or(&s, decimal, error);
4129
4130 if (!*error)
4131   if (endket)
4132     if (*s != ')')
4133       *error = US"expecting closing parenthesis";
4134     else
4135       while (isspace(*++s)) ;
4136   else if (*s)
4137     *error = US"expecting operator";
4138 *sptr = s;
4139 return x;
4140 }
4141
4142
4143 static int_eximarith_t
4144 eval_number(uschar **sptr, BOOL decimal, uschar **error)
4145 {
4146 int c;
4147 int_eximarith_t n;
4148 uschar *s = *sptr;
4149
4150 if (isdigit((c = Uskip_whitespace(&s))))
4151   {
4152   int count;
4153   (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
4154   s += count;
4155   switch (tolower(*s))
4156     {
4157     default: break;
4158     case 'k': n *= 1024; s++; break;
4159     case 'm': n *= 1024*1024; s++; break;
4160     case 'g': n *= 1024*1024*1024; s++; break;
4161     }
4162   Uskip_whitespace(&s);
4163   }
4164 else if (c == '(')
4165   {
4166   s++;
4167   n = eval_expr(&s, decimal, error, 1);
4168   }
4169 else
4170   {
4171   *error = US"expecting number or opening parenthesis";
4172   n = 0;
4173   }
4174 *sptr = s;
4175 return n;
4176 }
4177
4178
4179 static int_eximarith_t
4180 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
4181 {
4182 uschar *s = *sptr;
4183 int_eximarith_t x;
4184 Uskip_whitespace(&s);
4185 if (*s == '+' || *s == '-' || *s == '~')
4186   {
4187   int op = *s++;
4188   x = eval_op_unary(&s, decimal, error);
4189   if (op == '-') x = -x;
4190     else if (op == '~') x = ~x;
4191   }
4192 else
4193   x = eval_number(&s, decimal, error);
4194
4195 *sptr = s;
4196 return x;
4197 }
4198
4199
4200 static int_eximarith_t
4201 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
4202 {
4203 uschar *s = *sptr;
4204 int_eximarith_t x = eval_op_unary(&s, decimal, error);
4205 if (!*error)
4206   {
4207   while (*s == '*' || *s == '/' || *s == '%')
4208     {
4209     int op = *s++;
4210     int_eximarith_t y = eval_op_unary(&s, decimal, error);
4211     if (*error) break;
4212     /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
4213      * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
4214      * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64].  In fact, -N*-M where
4215      * -N*M is INT_MIN will yield INT_MIN.
4216      * Since we don't support floating point, this is somewhat simpler.
4217      * Ideally, we'd return an error, but since we overflow for all other
4218      * arithmetic, consistency suggests otherwise, but what's the correct value
4219      * to use?  There is none.
4220      * The C standard guarantees overflow for unsigned arithmetic but signed
4221      * overflow invokes undefined behaviour; in practice, this is overflow
4222      * except for converting INT_MIN to INT_MAX+1.  We also can't guarantee
4223      * that long/longlong larger than int are available, or we could just work
4224      * with larger types.  We should consider whether to guarantee 32bit eval
4225      * and 64-bit working variables, with errors returned.  For now ...
4226      * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
4227      * can just let the other invalid results occur otherwise, as they have
4228      * until now.  For this one case, we can coerce.
4229      */
4230     if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
4231       {
4232       DEBUG(D_expand)
4233         debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
4234             EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
4235       x = EXIM_ARITH_MAX;
4236       continue;
4237       }
4238     if (op == '*')
4239       x *= y;
4240     else
4241       {
4242       if (y == 0)
4243         {
4244         *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
4245         x = 0;
4246         break;
4247         }
4248       if (op == '/')
4249         x /= y;
4250       else
4251         x %= y;
4252       }
4253     }
4254   }
4255 *sptr = s;
4256 return x;
4257 }
4258
4259
4260 static int_eximarith_t
4261 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
4262 {
4263 uschar *s = *sptr;
4264 int_eximarith_t x = eval_op_mult(&s, decimal, error);
4265 if (!*error)
4266   {
4267   while (*s == '+' || *s == '-')
4268     {
4269     int op = *s++;
4270     int_eximarith_t y = eval_op_mult(&s, decimal, error);
4271     if (*error) break;
4272     if (  (x >=   EXIM_ARITH_MAX/2  && x >=   EXIM_ARITH_MAX/2)
4273        || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
4274       {                 /* over-conservative check */
4275       *error = op == '+'
4276         ? US"overflow in sum" : US"overflow in difference";
4277       break;
4278       }
4279     if (op == '+') x += y; else x -= y;
4280     }
4281   }
4282 *sptr = s;
4283 return x;
4284 }
4285
4286
4287 static int_eximarith_t
4288 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
4289 {
4290 uschar *s = *sptr;
4291 int_eximarith_t x = eval_op_sum(&s, decimal, error);
4292 if (!*error)
4293   {
4294   while ((*s == '<' || *s == '>') && s[1] == s[0])
4295     {
4296     int_eximarith_t y;
4297     int op = *s++;
4298     s++;
4299     y = eval_op_sum(&s, decimal, error);
4300     if (*error) break;
4301     if (op == '<') x <<= y; else x >>= y;
4302     }
4303   }
4304 *sptr = s;
4305 return x;
4306 }
4307
4308
4309 static int_eximarith_t
4310 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
4311 {
4312 uschar *s = *sptr;
4313 int_eximarith_t x = eval_op_shift(&s, decimal, error);
4314 if (!*error)
4315   {
4316   while (*s == '&')
4317     {
4318     int_eximarith_t y;
4319     s++;
4320     y = eval_op_shift(&s, decimal, error);
4321     if (*error) break;
4322     x &= y;
4323     }
4324   }
4325 *sptr = s;
4326 return x;
4327 }
4328
4329
4330 static int_eximarith_t
4331 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
4332 {
4333 uschar *s = *sptr;
4334 int_eximarith_t x = eval_op_and(&s, decimal, error);
4335 if (!*error)
4336   {
4337   while (*s == '^')
4338     {
4339     int_eximarith_t y;
4340     s++;
4341     y = eval_op_and(&s, decimal, error);
4342     if (*error) break;
4343     x ^= y;
4344     }
4345   }
4346 *sptr = s;
4347 return x;
4348 }
4349
4350
4351 static int_eximarith_t
4352 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
4353 {
4354 uschar *s = *sptr;
4355 int_eximarith_t x = eval_op_xor(&s, decimal, error);
4356 if (!*error)
4357   {
4358   while (*s == '|')
4359     {
4360     int_eximarith_t y;
4361     s++;
4362     y = eval_op_xor(&s, decimal, error);
4363     if (*error) break;
4364     x |= y;
4365     }
4366   }
4367 *sptr = s;
4368 return x;
4369 }
4370
4371
4372
4373 /************************************************/
4374 /* Comparison operation for sort expansion.  We need to avoid
4375 re-expanding the fields being compared, so need a custom routine.
4376
4377 Arguments:
4378  cond_type              Comparison operator code
4379  leftarg, rightarg      Arguments for comparison
4380
4381 Return true iff (leftarg compare rightarg)
4382 */
4383
4384 static BOOL
4385 sortsbefore(int cond_type, BOOL alpha_cond,
4386   const uschar * leftarg, const uschar * rightarg)
4387 {
4388 int_eximarith_t l_num, r_num;
4389
4390 if (!alpha_cond)
4391   {
4392   l_num = expanded_string_integer(leftarg, FALSE);
4393   if (expand_string_message) return FALSE;
4394   r_num = expanded_string_integer(rightarg, FALSE);
4395   if (expand_string_message) return FALSE;
4396
4397   switch (cond_type)
4398     {
4399     case ECOND_NUM_G:   return l_num >  r_num;
4400     case ECOND_NUM_GE:  return l_num >= r_num;
4401     case ECOND_NUM_L:   return l_num <  r_num;
4402     case ECOND_NUM_LE:  return l_num <= r_num;
4403     default: break;
4404     }
4405   }
4406 else
4407   switch (cond_type)
4408     {
4409     case ECOND_STR_LT:  return Ustrcmp (leftarg, rightarg) <  0;
4410     case ECOND_STR_LTI: return strcmpic(leftarg, rightarg) <  0;
4411     case ECOND_STR_LE:  return Ustrcmp (leftarg, rightarg) <= 0;
4412     case ECOND_STR_LEI: return strcmpic(leftarg, rightarg) <= 0;
4413     case ECOND_STR_GT:  return Ustrcmp (leftarg, rightarg) >  0;
4414     case ECOND_STR_GTI: return strcmpic(leftarg, rightarg) >  0;
4415     case ECOND_STR_GE:  return Ustrcmp (leftarg, rightarg) >= 0;
4416     case ECOND_STR_GEI: return strcmpic(leftarg, rightarg) >= 0;
4417     default: break;
4418     }
4419 return FALSE;   /* should not happen */
4420 }
4421
4422
4423 /* Expand a named list.  Return false on failure. */
4424 static gstring *
4425 expand_listnamed(gstring * yield, const uschar * name, const uschar * listtype)
4426 {
4427 tree_node *t = NULL;
4428 const uschar * list;
4429 int sep = 0;
4430 uschar * item;
4431 BOOL needsep = FALSE;
4432 #define LISTNAMED_BUF_SIZE 256
4433 uschar b[LISTNAMED_BUF_SIZE];
4434 uschar * buffer = b;
4435
4436 if (*name == '+') name++;
4437 if (!listtype)          /* no-argument version */
4438   {
4439   if (  !(t = tree_search(addresslist_anchor, name))
4440      && !(t = tree_search(domainlist_anchor,  name))
4441      && !(t = tree_search(hostlist_anchor,    name)))
4442     t = tree_search(localpartlist_anchor, name);
4443   }
4444 else switch(*listtype)  /* specific list-type version */
4445   {
4446   case 'a': t = tree_search(addresslist_anchor,   name); break;
4447   case 'd': t = tree_search(domainlist_anchor,    name); break;
4448   case 'h': t = tree_search(hostlist_anchor,      name); break;
4449   case 'l': t = tree_search(localpartlist_anchor, name); break;
4450   default:
4451     expand_string_message = US"bad suffix on \"list\" operator";
4452     return yield;
4453   }
4454
4455 if(!t)
4456   {
4457   expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
4458     name, !listtype?""
4459       : *listtype=='a'?"address "
4460       : *listtype=='d'?"domain "
4461       : *listtype=='h'?"host "
4462       : *listtype=='l'?"localpart "
4463       : 0);
4464   return yield;
4465   }
4466
4467 list = ((namedlist_block *)(t->data.ptr))->string;
4468
4469 /* The list could be quite long so we (re)use a buffer for each element
4470 rather than getting each in new memory */
4471
4472 if (is_tainted(list)) buffer = store_get(LISTNAMED_BUF_SIZE, GET_TAINTED);
4473 while ((item = string_nextinlist(&list, &sep, buffer, LISTNAMED_BUF_SIZE)))
4474   {
4475   uschar * buf = US" : ";
4476   if (needsep)
4477     yield = string_catn(yield, buf, 3);
4478   else
4479     needsep = TRUE;
4480
4481   if (*item == '+')     /* list item is itself a named list */
4482     {
4483     yield = expand_listnamed(yield, item, listtype);
4484     if (expand_string_message)
4485       return yield;
4486     }
4487
4488   else if (sep != ':')  /* item from non-colon-sep list, re-quote for colon list-separator */
4489     {
4490     char tok[3];
4491     tok[0] = sep; tok[1] = ':'; tok[2] = 0;
4492
4493     for(char * cp; cp = strpbrk(CCS item, tok); item = US cp)
4494       {
4495       yield = string_catn(yield, item, cp - CS item);
4496       if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
4497         yield = string_catn(yield, US"::", 2);
4498       else              /* sep in item; should already be doubled; emit once */
4499         {
4500         yield = string_catn(yield, US tok, 1);
4501         if (*cp == sep) cp++;
4502         }
4503       }
4504     yield = string_cat(yield, item);
4505     }
4506   else
4507     yield = string_cat(yield, item);
4508   }
4509 return yield;
4510 }
4511
4512
4513
4514 /************************************************/
4515 static void
4516 debug_expansion_interim(const uschar * what, const uschar * value, int nchar,
4517   esi_flags flags)
4518 {
4519 debug_printf_indent("%V", "K");
4520
4521 for (int fill = 11 - Ustrlen(what); fill > 0; fill--)
4522   debug_printf("%V", "-");
4523
4524 debug_printf("%s: %.*W\n", what, nchar, value);
4525 if (is_tainted(value))
4526   debug_printf_indent("%V          %V(tainted)\n",
4527     flags & ESI_SKIPPING ? "|" : " ", "\\__");
4528 }
4529
4530
4531 /*************************************************
4532 *                 Expand string                  *
4533 *************************************************/
4534
4535 /* Returns either an unchanged string, or the expanded string in stacking pool
4536 store. Interpreted sequences are:
4537
4538    \...                    normal escaping rules
4539    $name                   substitutes the variable
4540    ${name}                 ditto
4541    ${op:string}            operates on the expanded string value
4542    ${item{arg1}{arg2}...}  expands the args and then does the business
4543                              some literal args are not enclosed in {}
4544
4545 There are now far too many operators and item types to make it worth listing
4546 them here in detail any more.
4547
4548 We use an internal routine recursively to handle embedded substrings. The
4549 external function follows. The yield is NULL if the expansion failed, and there
4550 are two cases: if something collapsed syntactically, or if "fail" was given
4551 as the action on a lookup failure. These can be distinguished by looking at the
4552 variable expand_string_forcedfail, which is TRUE in the latter case.
4553
4554 The skipping flag is set true when expanding a substring that isn't actually
4555 going to be used (after "if" or "lookup") and it prevents lookups from
4556 happening lower down.
4557
4558 Store usage: At start, a store block of the length of the input plus 64
4559 is obtained. This is expanded as necessary by string_cat(), which might have to
4560 get a new block, or might be able to expand the original. At the end of the
4561 function we can release any store above that portion of the yield block that
4562 was actually used. In many cases this will be optimal.
4563
4564 However: if the first item in the expansion is a variable name or header name,
4565 we reset the store before processing it; if the result is in fresh store, we
4566 use that without copying. This is helpful for expanding strings like
4567 $message_headers which can get very long.
4568
4569 There's a problem if a ${dlfunc item has side-effects that cause allocation,
4570 since resetting the store at the end of the expansion will free store that was
4571 allocated by the plugin code as well as the slop after the expanded string. So
4572 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
4573 and, given the acl condition, ${if }. This is an unfortunate consequence of
4574 string expansion becoming too powerful.
4575
4576 Arguments:
4577   string         the string to be expanded
4578   flags
4579    brace_ends     expansion is to stop at }
4580    honour_dollar  TRUE if $ is to be expanded,
4581                   FALSE if it's just another character
4582    skipping       TRUE for recursive calls when the value isn't actually going
4583                   to be used (to allow for optimisation)
4584   left           if not NULL, a pointer to the first character after the
4585                  expansion is placed here (typically used with brace_ends)
4586   resetok_p      if not NULL, pointer to flag - write FALSE if unsafe to reset
4587                  the store.
4588   textonly_p     if not NULL, pointer to flag - write bool for only-met-text
4589
4590 Returns:         NULL if expansion fails:
4591                    expand_string_forcedfail is set TRUE if failure was forced
4592                    expand_string_message contains a textual error message
4593                  a pointer to the expanded string on success
4594 */
4595
4596 static uschar *
4597 expand_string_internal(const uschar * string, esi_flags flags, const uschar ** left,
4598   BOOL *resetok_p, BOOL * textonly_p)
4599 {
4600 rmark reset_point = store_mark();
4601 gstring * yield = string_get(Ustrlen(string) + 64);
4602 int item_type;
4603 const uschar * s = string;
4604 const uschar * save_expand_nstring[EXPAND_MAXN+1];
4605 int save_expand_nlength[EXPAND_MAXN+1];
4606 BOOL resetok = TRUE, first = TRUE, textonly = TRUE;
4607
4608 expand_level++;
4609 f.expand_string_forcedfail = FALSE;
4610 expand_string_message = US"";
4611
4612 if (is_tainted(string))
4613   {
4614   expand_string_message =
4615     string_sprintf("attempt to expand tainted string '%s'", s);
4616   log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4617   goto EXPAND_FAILED;
4618   }
4619
4620 while (*s)
4621   {
4622   uschar name[256];
4623
4624   DEBUG(D_expand)
4625     {
4626     debug_printf_indent("%V%V%s: %W\n",
4627       first ? "/" : "K",
4628       flags & ESI_SKIPPING ? "---" : "",
4629       flags & ESI_SKIPPING ? "scanning" : "considering", s);
4630     first = FALSE;
4631     }
4632
4633   /* \ escapes the next character, which must exist, or else
4634   the expansion fails. There's a special escape, \N, which causes
4635   copying of the subject verbatim up to the next \N. Otherwise,
4636   the escapes are the standard set. */
4637
4638   if (*s == '\\')
4639     {
4640     if (s[1] == 0)
4641       {
4642       expand_string_message = US"\\ at end of string";
4643       goto EXPAND_FAILED;
4644       }
4645
4646     if (s[1] == 'N')
4647       {
4648       const uschar * t = s + 2;
4649       for (s = t; *s ; s++) if (*s == '\\' && s[1] == 'N') break;
4650
4651       DEBUG(D_expand)
4652         debug_expansion_interim(US"protected", t, (int)(s - t), flags);
4653       if (!(flags & ESI_SKIPPING))
4654         yield = string_catn(yield, t, s - t);
4655       if (*s) s += 2;
4656       }
4657     else
4658       {
4659       uschar ch[1];
4660       DEBUG(D_expand)
4661         debug_printf_indent("%Vbackslashed: '\\%c'\n", "K", s[1]);
4662       ch[0] = string_interpret_escape(&s);
4663       if (!(flags & ESI_SKIPPING))
4664         yield = string_catn(yield, ch, 1);
4665       s++;
4666       }
4667     continue;
4668     }
4669
4670                                                                         /*{{*/
4671   /* Anything other than $ is just copied verbatim, unless we are
4672   looking for a terminating } character. */
4673
4674   if (flags & ESI_BRACE_ENDS && *s == '}') break;
4675
4676   if (*s != '$' || !(flags & ESI_HONOR_DOLLAR))
4677     {
4678     int i = 1;                                                          /*{*/
4679     for (const uschar * t = s+1;
4680         *t && *t != '$' && *t != '}' && *t != '\\'; t++) i++;
4681
4682     DEBUG(D_expand) debug_expansion_interim(US"text", s, i, flags);
4683
4684     if (!(flags & ESI_SKIPPING))
4685       yield = string_catn(yield, s, i);
4686     s += i;
4687     continue;
4688     }
4689   textonly = FALSE;
4690
4691   /* No { after the $ - must be a plain name or a number for string
4692   match variable. There has to be a fudge for variables that are the
4693   names of header fields preceded by "$header_" because header field
4694   names can contain any printing characters except space and colon.
4695   For those that don't like typing this much, "$h_" is a synonym for
4696   "$header_". A non-existent header yields a NULL value; nothing is
4697   inserted. */  /*}*/
4698
4699   if (isalpha(*++s))
4700     {
4701     const uschar * value;
4702     int newsize = 0, len;
4703     gstring * g = NULL;
4704     uschar * t;
4705
4706     s = read_name(name, sizeof(name), s, US"_");
4707
4708     /* If this is the first thing to be expanded, release the pre-allocated
4709     buffer. */
4710
4711     if (!(flags & ESI_SKIPPING))
4712       if (!yield)
4713         g = store_get(sizeof(gstring), GET_UNTAINTED);
4714       else if (yield->ptr == 0)
4715         {
4716         if (resetok) reset_point = store_reset(reset_point);
4717         yield = NULL;
4718         reset_point = store_mark();
4719         g = store_get(sizeof(gstring), GET_UNTAINTED);  /* alloc _before_ calling find_variable() */
4720         }
4721
4722     /* Header */
4723
4724     if (  ( *(t = name) == 'h'
4725           || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
4726           )
4727        && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
4728        )
4729       {
4730       unsigned flags = *name == 'r' ? FH_WANT_RAW
4731                       : *name == 'l' ? FH_WANT_RAW|FH_WANT_LIST
4732                       : 0;
4733       const uschar * charset = *name == 'b' ? NULL : headers_charset;
4734
4735       s = read_header_name(name, sizeof(name), s);
4736       value = find_header(name, &newsize, flags, charset);
4737
4738       /* If we didn't find the header, and the header contains a closing brace
4739       character, this may be a user error where the terminating colon
4740       has been omitted. Set a flag to adjust the error message in this case.
4741       But there is no error here - nothing gets inserted. */
4742
4743       if (!value)
4744         {                                                               /*{*/
4745         if (Ustrchr(name, '}')) malformed_header = TRUE;
4746         continue;
4747         }
4748       }
4749
4750     /* Variable */
4751
4752     else if (!(value = find_variable(name, flags, &newsize)))
4753       {
4754       expand_string_message =
4755         string_sprintf("unknown variable name \"%s\"", name);
4756         check_variable_error_message(name);
4757       goto EXPAND_FAILED;
4758       }
4759
4760     /* If the data is known to be in a new buffer, newsize will be set to the
4761     size of that buffer. If this is the first thing in an expansion string,
4762     yield will be NULL; just point it at the new store instead of copying. Many
4763     expansion strings contain just one reference, so this is a useful
4764     optimization, especially for humungous headers.  We need to use a gstring
4765     structure that is not allocated after that new-buffer, else a later store
4766     reset in the middle of the buffer will make it inaccessible. */
4767
4768     len = Ustrlen(value);
4769     DEBUG(D_expand) debug_expansion_interim(US"value", value, len, flags);
4770     if (!(flags & ESI_SKIPPING))
4771       if (!yield && newsize != 0)
4772         {
4773         yield = g;
4774         yield->size = newsize;
4775         yield->ptr = len;
4776         yield->s = US value; /* known to be in new store i.e. a copy, so deconst safe */
4777         }
4778       else
4779         yield = string_catn(yield, value, len);
4780
4781     continue;
4782     }
4783
4784   if (isdigit(*s))              /* A $<n> variable */
4785     {
4786     int n;
4787     s = read_cnumber(&n, s);
4788     if (n >= 0 && n <= expand_nmax)
4789       {
4790       DEBUG(D_expand) debug_expansion_interim(US"value", expand_nstring[n], expand_nlength[n], flags);
4791       if (!(flags & ESI_SKIPPING))
4792         yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4793       }
4794     continue;
4795     }
4796
4797   /* Otherwise, if there's no '{' after $ it's an error. */             /*}*/
4798
4799   if (*s != '{')                                                        /*}*/
4800     {
4801     expand_string_message = US"$ not followed by letter, digit, or {";  /*}*/
4802     goto EXPAND_FAILED;
4803     }
4804
4805   /* After { there can be various things, but they all start with
4806   an initial word, except for a number for a string match variable. */  /*}*/
4807
4808   if (isdigit(*++s))
4809     {
4810     int n;
4811     s = read_cnumber(&n, s);                                            /*{{*/
4812     if (*s++ != '}')
4813       {
4814       expand_string_message = US"} expected after number";
4815       goto EXPAND_FAILED;
4816       }
4817     if (n >= 0 && n <= expand_nmax)
4818       {
4819       DEBUG(D_expand) debug_expansion_interim(US"value", expand_nstring[n], expand_nlength[n], flags);
4820       if (!(flags & ESI_SKIPPING))
4821         yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4822       }
4823     continue;
4824     }
4825
4826   if (!isalpha(*s))
4827     {
4828     expand_string_message = US"letter or digit expected after ${";      /*}*/
4829     goto EXPAND_FAILED;
4830     }
4831
4832   /* Allow "-" in names to cater for substrings with negative
4833   arguments. Since we are checking for known names after { this is
4834   OK. */                                                                /*}*/
4835
4836   s = read_name(name, sizeof(name), s, US"_-");
4837   item_type = chop_match(name, item_table, nelem(item_table));
4838
4839   /* Switch on item type.  All nondefault choices should "continue* when
4840   skipping, but "break" otherwise so we get debug output for the item
4841   expansion. */
4842   {
4843   int expansion_start = gstring_length(yield);
4844   switch(item_type)
4845     {
4846     /* Call an ACL from an expansion.  We feed data in via $acl_arg1 - $acl_arg9.
4847     If the ACL returns accept or reject we return content set by "message ="
4848     There is currently no limit on recursion; this would have us call
4849     acl_check_internal() directly and get a current level from somewhere.
4850     See also the acl expansion condition ECOND_ACL and the traditional
4851     acl modifier ACLC_ACL.
4852     Assume that the function has side-effects on the store that must be preserved.
4853     */
4854
4855     case EITEM_ACL:
4856       /* ${acl {name} {arg1}{arg2}...} */
4857       {
4858       uschar * sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4859       uschar * user_msg;
4860       int rc;
4861
4862       switch(read_subs(sub, nelem(sub), 1, &s, flags, TRUE, name, &resetok, NULL))
4863         {
4864         case -1: continue;              /* skipping */
4865         case 1: goto EXPAND_FAILED_CURLY;
4866         case 2:
4867         case 3: goto EXPAND_FAILED;
4868         }
4869
4870       resetok = FALSE;
4871       switch(rc = eval_acl(sub, nelem(sub), &user_msg))
4872         {
4873         case OK:
4874         case FAIL:
4875           DEBUG(D_expand)
4876             debug_printf_indent("acl expansion yield: %s\n", user_msg);
4877           if (user_msg)
4878             yield = string_cat(yield, user_msg);
4879           break;
4880
4881         case DEFER:
4882           f.expand_string_forcedfail = TRUE;
4883           /*FALLTHROUGH*/
4884         default:
4885           expand_string_message = string_sprintf("%s from acl \"%s\"",
4886             rc_names[rc], sub[0]);
4887           goto EXPAND_FAILED;
4888         }
4889       break;
4890       }
4891
4892     case EITEM_AUTHRESULTS:
4893       /* ${authresults {mysystemname}} */
4894       {
4895       uschar * sub_arg[1];
4896
4897       switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, flags, TRUE, name, &resetok, NULL))
4898         {
4899         case -1: continue;      /* If skipping, we don't actually do anything */
4900         case 1: goto EXPAND_FAILED_CURLY;
4901         case 2:
4902         case 3: goto EXPAND_FAILED;
4903         }
4904
4905       yield = string_append(yield, 3,
4906                         US"Authentication-Results: ", sub_arg[0], US"; none");
4907       yield->ptr -= 6;                  /* ignore tha ": none" for now */
4908
4909       yield = authres_local(yield, sub_arg[0]);
4910       yield = authres_iprev(yield);
4911       yield = authres_smtpauth(yield);
4912 #ifdef SUPPORT_SPF
4913       yield = authres_spf(yield);
4914 #endif
4915 #ifndef DISABLE_DKIM
4916       yield = authres_dkim(yield);
4917 #endif
4918 #ifdef SUPPORT_DMARC
4919       yield = authres_dmarc(yield);
4920 #endif
4921 #ifdef EXPERIMENTAL_ARC
4922       yield = authres_arc(yield);
4923 #endif
4924       break;
4925       }
4926
4927     /* Handle conditionals - preserve the values of the numerical expansion
4928     variables in case they get changed by a regular expression match in the
4929     condition. If not, they retain their external settings. At the end
4930     of this "if" section, they get restored to their previous values. */
4931
4932     case EITEM_IF:
4933       {
4934       BOOL cond = FALSE;
4935       const uschar *next_s;
4936       int save_expand_nmax =
4937         save_expand_strings(save_expand_nstring, save_expand_nlength);
4938       uschar * save_lookup_value = lookup_value;
4939
4940       Uskip_whitespace(&s);
4941       if (!(next_s = eval_condition(s, &resetok, flags & ESI_SKIPPING ? NULL : &cond)))
4942         goto EXPAND_FAILED;  /* message already set */
4943
4944       DEBUG(D_expand)
4945         {
4946         debug_expansion_interim(US"condition", s, (int)(next_s - s), flags);
4947         debug_expansion_interim(US"result",
4948           cond ? US"true" : US"false", cond ? 4 : 5, flags);
4949         }
4950
4951       s = next_s;
4952
4953       /* The handling of "yes" and "no" result strings is now in a separate
4954       function that is also used by ${lookup} and ${extract} and ${run}. */
4955
4956       switch(process_yesno(
4957                flags,                   /* were previously skipping */
4958                cond,                    /* success/failure indicator */
4959                lookup_value,                    /* value to reset for string2 */
4960                &s,                      /* input pointer */
4961                &yield,                  /* output pointer */
4962                US"if",                  /* condition type */
4963                &resetok))
4964         {
4965         case 1: goto EXPAND_FAILED;          /* when all is well, the */
4966         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
4967         }
4968
4969       /* Restore external setting of expansion variables for continuation
4970       at this level. */
4971
4972       lookup_value = save_lookup_value;
4973       restore_expand_strings(save_expand_nmax, save_expand_nstring,
4974         save_expand_nlength);
4975       break;
4976       }
4977
4978 #ifdef SUPPORT_I18N
4979     case EITEM_IMAPFOLDER:
4980       {                         /* ${imapfolder {name}{sep}{specials}} */
4981       uschar *sub_arg[3];
4982       uschar *encoded;
4983
4984       switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, flags, TRUE, name, &resetok, NULL))
4985         {
4986         case 1: goto EXPAND_FAILED_CURLY;
4987         case 2:
4988         case 3: goto EXPAND_FAILED;
4989         }
4990
4991       if (!sub_arg[1])                  /* One argument */
4992         {
4993         sub_arg[1] = US"/";             /* default separator */
4994         sub_arg[2] = NULL;
4995         }
4996       else if (Ustrlen(sub_arg[1]) != 1)
4997         {
4998         expand_string_message =
4999           string_sprintf(
5000                 "IMAP folder separator must be one character, found \"%s\"",
5001                 sub_arg[1]);
5002         goto EXPAND_FAILED;
5003         }
5004
5005       if (flags & ESI_SKIPPING) continue;
5006
5007       if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
5008                           sub_arg[1][0], sub_arg[2], &expand_string_message)))
5009         goto EXPAND_FAILED;
5010       yield = string_cat(yield, encoded);
5011       break;
5012       }
5013 #endif
5014
5015     /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
5016     expanding an internal string that isn't actually going to be used. All we
5017     need to do is check the syntax, so don't do a lookup at all. Preserve the
5018     values of the numerical expansion variables in case they get changed by a
5019     partial lookup. If not, they retain their external settings. At the end
5020     of this "lookup" section, they get restored to their previous values. */
5021
5022     case EITEM_LOOKUP:
5023       {
5024       int stype, partial, affixlen, starflags;
5025       int expand_setup = 0;
5026       int nameptr = 0;
5027       uschar * key, * filename;
5028       const uschar * affix, * opts;
5029       uschar * save_lookup_value = lookup_value;
5030       int save_expand_nmax =
5031         save_expand_strings(save_expand_nstring, save_expand_nlength);
5032
5033       if (expand_forbid & RDO_LOOKUP)
5034         {
5035         expand_string_message = US"lookup expansions are not permitted";
5036         goto EXPAND_FAILED;
5037         }
5038
5039       /* Get the key we are to look up for single-key+file style lookups.
5040       Otherwise set the key NULL pro-tem. */
5041
5042       if (Uskip_whitespace(&s) == '{')                                  /*}*/
5043         {
5044         key = expand_string_internal(s+1,
5045                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
5046         if (!key) goto EXPAND_FAILED;                   /*{{*/
5047         if (*s++ != '}')
5048           {
5049           expand_string_message = US"missing '}' after lookup key";
5050           goto EXPAND_FAILED_CURLY;
5051           }
5052         Uskip_whitespace(&s);
5053         }
5054       else key = NULL;
5055
5056       /* Find out the type of database */
5057
5058       if (!isalpha(*s))
5059         {
5060         expand_string_message = US"missing lookup type";
5061         goto EXPAND_FAILED;
5062         }
5063
5064       /* The type is a string that may contain special characters of various
5065       kinds. Allow everything except space or { to appear; the actual content
5066       is checked by search_findtype_partial. */         /*}*/
5067
5068       while (*s && *s != '{' && !isspace(*s))           /*}*/
5069         {
5070         if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
5071         s++;
5072         }
5073       name[nameptr] = '\0';
5074       Uskip_whitespace(&s);
5075
5076       /* Now check for the individual search type and any partial or default
5077       options. Only those types that are actually in the binary are valid. */
5078
5079       if ((stype = search_findtype_partial(name, &partial, &affix, &affixlen,
5080           &starflags, &opts)) < 0)
5081         {
5082         expand_string_message = search_error_message;
5083         goto EXPAND_FAILED;
5084         }
5085
5086       /* Check that a key was provided for those lookup types that need it,
5087       and was not supplied for those that use the query style. */
5088
5089       if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
5090         {
5091         if (!key)
5092           {
5093           expand_string_message = string_sprintf("missing {key} for single-"
5094             "key \"%s\" lookup", name);
5095           goto EXPAND_FAILED;
5096           }
5097         }
5098       else if (key)
5099         {
5100         expand_string_message = string_sprintf("a single key was given for "
5101           "lookup type \"%s\", which is not a single-key lookup type", name);
5102         goto EXPAND_FAILED;
5103         }
5104
5105       /* Get the next string in brackets and expand it. It is the file name for
5106       single-key+file lookups, and the whole query otherwise. In the case of
5107       queries that also require a file name (e.g. sqlite), the file name comes
5108       first. */
5109
5110       if (*s != '{')
5111         {
5112         expand_string_message = US"missing '{' for lookup file-or-query arg";
5113         goto EXPAND_FAILED_CURLY;                                               /*}}*/
5114         }
5115       if (!(filename = expand_string_internal(s+1,
5116                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
5117         goto EXPAND_FAILED;
5118                                                                                 /*{{*/
5119       if (*s++ != '}')
5120         {
5121         expand_string_message = US"missing '}' closing lookup file-or-query arg";
5122         goto EXPAND_FAILED_CURLY;
5123         }
5124       Uskip_whitespace(&s);
5125
5126       /* If this isn't a single-key+file lookup, re-arrange the variables
5127       to be appropriate for the search_ functions. For query-style lookups,
5128       there is just a "key", and no file name. For the special query-style +
5129       file types, the query (i.e. "key") starts with a file name. */
5130
5131       if (!key)
5132         key = search_args(stype, name, filename, &filename, opts);
5133
5134       /* If skipping, don't do the next bit - just lookup_value == NULL, as if
5135       the entry was not found. Note that there is no search_close() function.
5136       Files are left open in case of re-use. At suitable places in higher logic,
5137       search_tidyup() is called to tidy all open files. This can save opening
5138       the same file several times. However, files may also get closed when
5139       others are opened, if too many are open at once. The rule is that a
5140       handle should not be used after a second search_open().
5141
5142       Request that a partial search sets up $1 and maybe $2 by passing
5143       expand_setup containing zero. If its value changes, reset expand_nmax,
5144       since new variables will have been set. Note that at the end of this
5145       "lookup" section, the old numeric variables are restored. */
5146
5147       if (flags & ESI_SKIPPING)
5148         lookup_value = NULL;
5149       else
5150         {
5151         void * handle = search_open(filename, stype, 0, NULL, NULL);
5152         if (!handle)
5153           {
5154           expand_string_message = search_error_message;
5155           goto EXPAND_FAILED;
5156           }
5157         lookup_value = search_find(handle, filename, key, partial, affix,
5158           affixlen, starflags, &expand_setup, opts);
5159         if (f.search_find_defer)
5160           {
5161           expand_string_message =
5162             string_sprintf("lookup of \"%s\" gave DEFER: %s",
5163               string_printing2(key, SP_TAB), search_error_message);
5164           goto EXPAND_FAILED;
5165           }
5166         if (expand_setup > 0) expand_nmax = expand_setup;
5167         }
5168
5169       /* The handling of "yes" and "no" result strings is now in a separate
5170       function that is also used by ${if} and ${extract}. */
5171
5172       switch(process_yesno(
5173                flags,                   /* were previously skipping */
5174                lookup_value != NULL,    /* success/failure indicator */
5175                save_lookup_value,       /* value to reset for string2 */
5176                &s,                      /* input pointer */
5177                &yield,                  /* output pointer */
5178                US"lookup",              /* condition type */
5179                &resetok))
5180         {
5181         case 1: goto EXPAND_FAILED;          /* when all is well, the */
5182         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
5183         }
5184
5185       /* Restore external setting of expansion variables for carrying on
5186       at this level, and continue. */
5187
5188       restore_expand_strings(save_expand_nmax, save_expand_nstring,
5189         save_expand_nlength);
5190
5191       if (flags & ESI_SKIPPING) continue;
5192       break;
5193       }
5194
5195     /* If Perl support is configured, handle calling embedded perl subroutines,
5196     unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
5197     or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
5198     arguments (defined below). */
5199
5200 #define EXIM_PERL_MAX_ARGS 8
5201
5202     case EITEM_PERL:
5203 #ifndef EXIM_PERL
5204       expand_string_message = US"\"${perl\" encountered, but this facility "    /*}*/
5205         "is not included in this binary";
5206       goto EXPAND_FAILED;
5207
5208 #else   /* EXIM_PERL */
5209       {
5210       uschar * sub_arg[EXIM_PERL_MAX_ARGS + 2];
5211       gstring * new_yield;
5212
5213       if (expand_forbid & RDO_PERL)
5214         {
5215         expand_string_message = US"Perl calls are not permitted";
5216         goto EXPAND_FAILED;
5217         }
5218
5219       switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, flags, TRUE,
5220            name, &resetok, NULL))
5221         {
5222         case -1: continue;      /* If skipping, we don't actually do anything */
5223         case 1: goto EXPAND_FAILED_CURLY;
5224         case 2:
5225         case 3: goto EXPAND_FAILED;
5226         }
5227
5228       /* Start the interpreter if necessary */
5229
5230       if (!opt_perl_started)
5231         {
5232         uschar * initerror;
5233         if (!opt_perl_startup)
5234           {
5235           expand_string_message = US"A setting of perl_startup is needed when "
5236             "using the Perl interpreter";
5237           goto EXPAND_FAILED;
5238           }
5239         DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
5240         if ((initerror = init_perl(opt_perl_startup)))
5241           {
5242           expand_string_message =
5243             string_sprintf("error in perl_startup code: %s\n", initerror);
5244           goto EXPAND_FAILED;
5245           }
5246         opt_perl_started = TRUE;
5247         }
5248
5249       /* Call the function */
5250
5251       sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
5252       new_yield = call_perl_cat(yield, &expand_string_message,
5253         sub_arg[0], sub_arg + 1);
5254
5255       /* NULL yield indicates failure; if the message pointer has been set to
5256       NULL, the yield was undef, indicating a forced failure. Otherwise the
5257       message will indicate some kind of Perl error. */
5258
5259       if (!new_yield)
5260         {
5261         if (!expand_string_message)
5262           {
5263           expand_string_message =
5264             string_sprintf("Perl subroutine \"%s\" returned undef to force "
5265               "failure", sub_arg[0]);
5266           f.expand_string_forcedfail = TRUE;
5267           }
5268         goto EXPAND_FAILED;
5269         }
5270
5271       /* Yield succeeded. Ensure forcedfail is unset, just in case it got
5272       set during a callback from Perl. */
5273
5274       f.expand_string_forcedfail = FALSE;
5275       yield = new_yield;
5276       break;
5277       }
5278 #endif /* EXIM_PERL */
5279
5280     /* Transform email address to "prvs" scheme to use
5281        as BATV-signed return path */
5282
5283     case EITEM_PRVS:
5284       {
5285       uschar * sub_arg[3], * p, * domain;
5286
5287       switch(read_subs(sub_arg, 3, 2, &s, flags, TRUE, name, &resetok, NULL))
5288         {
5289         case -1: continue;      /* If skipping, we don't actually do anything */
5290         case 1: goto EXPAND_FAILED_CURLY;
5291         case 2:
5292         case 3: goto EXPAND_FAILED;
5293         }
5294
5295       /* sub_arg[0] is the address */
5296       if (  !(domain = Ustrrchr(sub_arg[0],'@'))
5297          || domain == sub_arg[0] || Ustrlen(domain) == 1)
5298         {
5299         expand_string_message = US"prvs first argument must be a qualified email address";
5300         goto EXPAND_FAILED;
5301         }
5302
5303       /* Calculate the hash. The third argument must be a single-digit
5304       key number, or unset. */
5305
5306       if (  sub_arg[2]
5307          && (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
5308         {
5309         expand_string_message = US"prvs third argument must be a single digit";
5310         goto EXPAND_FAILED;
5311         }
5312
5313       p = prvs_hmac_sha1(sub_arg[0], sub_arg[1], sub_arg[2], prvs_daystamp(7));
5314       if (!p)
5315         {
5316         expand_string_message = US"prvs hmac-sha1 conversion failed";
5317         goto EXPAND_FAILED;
5318         }
5319
5320       /* Now separate the domain from the local part */
5321       *domain++ = '\0';
5322
5323       yield = string_catn(yield, US"prvs=", 5);
5324       yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);
5325       yield = string_catn(yield, prvs_daystamp(7), 3);
5326       yield = string_catn(yield, p, 6);
5327       yield = string_catn(yield, US"=", 1);
5328       yield = string_cat (yield, sub_arg[0]);
5329       yield = string_catn(yield, US"@", 1);
5330       yield = string_cat (yield, domain);
5331
5332       break;
5333       }
5334
5335     /* Check a prvs-encoded address for validity */
5336
5337     case EITEM_PRVSCHECK:
5338       {
5339       uschar * sub_arg[3], * p;
5340       gstring * g;
5341       const pcre2_code * re;
5342
5343       /* Reset expansion variables */
5344       prvscheck_result = NULL;
5345       prvscheck_address = NULL;
5346       prvscheck_keynum = NULL;
5347
5348       switch(read_subs(sub_arg, 1, 1, &s, flags, FALSE, name, &resetok, NULL))
5349         {
5350         case 1: goto EXPAND_FAILED_CURLY;
5351         case 2:
5352         case 3: goto EXPAND_FAILED;
5353         }
5354
5355       re = regex_must_compile(
5356         US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
5357         MCS_CASELESS | MCS_CACHEABLE, FALSE);
5358
5359       if (regex_match_and_setup(re,sub_arg[0],0,-1))
5360         {
5361         uschar * local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
5362         uschar * key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
5363         uschar * daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
5364         uschar * hash = string_copyn(expand_nstring[3],expand_nlength[3]);
5365         uschar * domain = string_copyn(expand_nstring[5],expand_nlength[5]);
5366
5367         DEBUG(D_expand)
5368           {
5369           debug_printf_indent("prvscheck localpart: %s\n", local_part);
5370           debug_printf_indent("prvscheck key number: %s\n", key_num);
5371           debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
5372           debug_printf_indent("prvscheck hash: %s\n", hash);
5373           debug_printf_indent("prvscheck domain: %s\n", domain);
5374           }
5375
5376         /* Set up expansion variables */
5377         g = string_cat (NULL, local_part);
5378         g = string_catn(g, US"@", 1);
5379         g = string_cat (g, domain);
5380         prvscheck_address = string_from_gstring(g);
5381         prvscheck_keynum = string_copy(key_num);
5382
5383         /* Now expand the second argument */
5384         switch(read_subs(sub_arg, 1, 1, &s, flags, FALSE, name, &resetok, NULL))
5385           {
5386           case 1: goto EXPAND_FAILED_CURLY;
5387           case 2:
5388           case 3: goto EXPAND_FAILED;
5389           }
5390
5391         /* Now we have the key and can check the address. */
5392
5393         p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
5394           daystamp);
5395         if (!p)
5396           {
5397           expand_string_message = US"hmac-sha1 conversion failed";
5398           goto EXPAND_FAILED;
5399           }
5400
5401         DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
5402         DEBUG(D_expand) debug_printf_indent("prvscheck:      own hash is %s\n", p);
5403
5404         if (Ustrcmp(p,hash) == 0)
5405           {
5406           /* Success, valid BATV address. Now check the expiry date. */
5407           uschar *now = prvs_daystamp(0);
5408           unsigned int inow = 0,iexpire = 1;
5409
5410           (void)sscanf(CS now,"%u",&inow);
5411           (void)sscanf(CS daystamp,"%u",&iexpire);
5412
5413           /* When "iexpire" is < 7, a "flip" has occurred.
5414              Adjust "inow" accordingly. */
5415           if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
5416
5417           if (iexpire >= inow)
5418             {
5419             prvscheck_result = US"1";
5420             DEBUG(D_expand) debug_printf_indent("prvscheck: success, $prvscheck_result set to 1\n");
5421             }
5422           else
5423             {
5424             prvscheck_result = NULL;
5425             DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $prvscheck_result unset\n");
5426             }
5427           }
5428         else
5429           {
5430           prvscheck_result = NULL;
5431           DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $prvscheck_result unset\n");
5432           }
5433
5434         /* Now expand the final argument. We leave this till now so that
5435         it can include $prvscheck_result. */
5436
5437         switch(read_subs(sub_arg, 1, 0, &s, flags, TRUE, name, &resetok, NULL))
5438           {
5439           case 1: goto EXPAND_FAILED_CURLY;
5440           case 2:
5441           case 3: goto EXPAND_FAILED;
5442           }
5443
5444         yield = string_cat(yield,
5445           !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
5446
5447         /* Reset the "internal" variables afterwards, because they are in
5448         dynamic store that will be reclaimed if the expansion succeeded. */
5449
5450         prvscheck_address = NULL;
5451         prvscheck_keynum = NULL;
5452         }
5453       else
5454         /* Does not look like a prvs encoded address, return the empty string.
5455            We need to make sure all subs are expanded first, so as to skip over
5456            the entire item. */
5457
5458         switch(read_subs(sub_arg, 2, 1, &s, flags, TRUE, name, &resetok, NULL))
5459           {
5460           case 1: goto EXPAND_FAILED_CURLY;
5461           case 2:
5462           case 3: goto EXPAND_FAILED;
5463           }
5464
5465       if (flags & ESI_SKIPPING) continue;
5466       break;
5467       }
5468
5469     /* Handle "readfile" to insert an entire file */
5470
5471     case EITEM_READFILE:
5472       {
5473       FILE * f;
5474       uschar * sub_arg[2];
5475
5476       if ((expand_forbid & RDO_READFILE) != 0)
5477         {
5478         expand_string_message = US"file insertions are not permitted";
5479         goto EXPAND_FAILED;
5480         }
5481
5482       switch(read_subs(sub_arg, 2, 1, &s, flags, TRUE, name, &resetok, NULL))
5483         {
5484         case -1: continue;      /* If skipping, we don't actually do anything */
5485         case 1: goto EXPAND_FAILED_CURLY;
5486         case 2:
5487         case 3: goto EXPAND_FAILED;
5488         }
5489
5490       /* Open the file and read it */
5491
5492       if (!(f = Ufopen(sub_arg[0], "rb")))
5493         {
5494         expand_string_message = string_open_failed("%s", sub_arg[0]);
5495         goto EXPAND_FAILED;
5496         }
5497
5498       yield = cat_file(f, yield, sub_arg[1]);
5499       (void)fclose(f);
5500       break;
5501       }
5502
5503     /* Handle "readsocket" to insert data from a socket, either
5504     Inet or Unix domain */
5505
5506     case EITEM_READSOCK:
5507       {
5508       uschar * arg;
5509       uschar * sub_arg[4];
5510
5511       if (expand_forbid & RDO_READSOCK)
5512         {
5513         expand_string_message = US"socket insertions are not permitted";
5514         goto EXPAND_FAILED;
5515         }
5516
5517       /* Read up to 4 arguments, but don't do the end of item check afterwards,
5518       because there may be a string for expansion on failure. */
5519
5520       switch(read_subs(sub_arg, 4, 2, &s, flags, FALSE, name, &resetok, NULL))
5521         {
5522         case 1: goto EXPAND_FAILED_CURLY;
5523         case 2:                             /* Won't occur: no end check */
5524         case 3: goto EXPAND_FAILED;
5525         }
5526
5527       /* If skipping, we don't actually do anything. Otherwise, arrange to
5528       connect to either an IP or a Unix socket. */
5529
5530       if (!(flags & ESI_SKIPPING))
5531         {
5532         int stype = search_findtype(US"readsock", 8);
5533         gstring * g = NULL;
5534         void * handle;
5535         int expand_setup = -1;
5536         uschar * s;
5537
5538         /* If the reqstr is empty, flag that and set a dummy */
5539
5540         if (!sub_arg[1][0])
5541           {
5542           g = string_append_listele(g, ',', US"send=no");
5543           sub_arg[1] = US"DUMMY";
5544           }
5545
5546         /* Re-marshall the options */
5547
5548         if (sub_arg[2])
5549           {
5550           const uschar * list = sub_arg[2];
5551           uschar * item;
5552           int sep = 0;
5553
5554           /* First option has no tag and is timeout */
5555           if ((item = string_nextinlist(&list, &sep, NULL, 0)))
5556             g = string_append_listele(g, ',',
5557                   string_sprintf("timeout=%s", item));
5558
5559           /* The rest of the options from the expansion */
5560           while ((item = string_nextinlist(&list, &sep, NULL, 0)))
5561             g = string_append_listele(g, ',', item);
5562
5563           /* possibly plus an EOL string.  Process with escapes, to protect
5564           from list-processing.  The only current user of eol= in search
5565           options is the readsock expansion. */
5566
5567           if (sub_arg[3] && *sub_arg[3])
5568             g = string_append_listele(g, ',',
5569                   string_sprintf("eol=%s",
5570                     string_printing2(sub_arg[3], SP_TAB|SP_SPACE)));
5571           }
5572
5573         /* Gat a (possibly cached) handle for the connection */
5574
5575         if (!(handle = search_open(sub_arg[0], stype, 0, NULL, NULL)))
5576           {
5577           if (*expand_string_message) goto EXPAND_FAILED;
5578           expand_string_message = search_error_message;
5579           search_error_message = NULL;
5580           goto SOCK_FAIL;
5581           }
5582
5583         /* Get (possibly cached) results for the lookup */
5584         /* sspec: sub_arg[0]  req: sub_arg[1]  opts: g */
5585
5586         if ((s = search_find(handle, sub_arg[0], sub_arg[1], -1, NULL, 0, 0,
5587                                     &expand_setup, string_from_gstring(g))))
5588           yield = string_cat(yield, s);
5589         else if (f.search_find_defer)
5590           {
5591           expand_string_message = search_error_message;
5592           search_error_message = NULL;
5593           goto SOCK_FAIL;
5594           }
5595         else
5596           {     /* should not happen, at present */
5597           expand_string_message = search_error_message;
5598           search_error_message = NULL;
5599           goto SOCK_FAIL;
5600           }
5601         }
5602
5603       /* The whole thing has worked (or we were skipping). If there is a
5604       failure string following, we need to skip it. */
5605
5606       if (*s == '{')                                                    /*}*/
5607         {
5608         if (!expand_string_internal(s+1,
5609           ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL))
5610           goto EXPAND_FAILED;                                           /*{*/
5611         if (*s++ != '}')
5612           {                                                             /*{*/
5613           expand_string_message = US"missing '}' closing failstring for readsocket";
5614           goto EXPAND_FAILED_CURLY;
5615           }
5616         Uskip_whitespace(&s);
5617         }
5618
5619     READSOCK_DONE:                                                      /*{*/
5620       if (*s++ != '}')
5621         {                                                               /*{*/
5622         expand_string_message = US"missing '}' closing readsocket";
5623         goto EXPAND_FAILED_CURLY;
5624         }
5625       if (flags & ESI_SKIPPING) continue;
5626       break;
5627
5628       /* Come here on failure to create socket, connect socket, write to the
5629       socket, or timeout on reading. If another substring follows, expand and
5630       use it. Otherwise, those conditions give expand errors. */
5631
5632     SOCK_FAIL:
5633       if (*s != '{') goto EXPAND_FAILED;                                /*}*/
5634       DEBUG(D_any) debug_printf("%s\n", expand_string_message);
5635       if (!(arg = expand_string_internal(s+1,
5636                     ESI_BRACE_ENDS | ESI_HONOR_DOLLAR, &s, &resetok, NULL)))
5637         goto EXPAND_FAILED;
5638       yield = string_cat(yield, arg);                                   /*{*/
5639       if (*s++ != '}')
5640         {                                                               /*{*/
5641         expand_string_message = US"missing '}' closing failstring for readsocket";
5642         goto EXPAND_FAILED_CURLY;
5643         }
5644       Uskip_whitespace(&s);
5645       goto READSOCK_DONE;
5646       }
5647
5648     /* Handle "run" to execute a program. */
5649
5650     case EITEM_RUN:
5651       {
5652       FILE * f;
5653       const uschar * arg, ** argv;
5654       unsigned late_expand = TSUC_EXPAND_ARGS | TSUC_ALLOW_TAINTED_ARGS | TSUC_ALLOW_RECIPIENTS;
5655
5656       if (expand_forbid & RDO_RUN)
5657         {
5658         expand_string_message = US"running a command is not permitted";
5659         goto EXPAND_FAILED;
5660         }
5661
5662       /* Handle options to the "run" */
5663
5664       while (*s == ',')
5665         if (Ustrncmp(++s, "preexpand", 9) == 0)
5666           { late_expand = 0; s += 9; }
5667         else
5668           {
5669           const uschar * t = s;
5670           while (isalpha(*++t)) ;
5671           expand_string_message = string_sprintf("bad option '%.*s' for run",
5672                                                   (int)(t-s), s);
5673           goto EXPAND_FAILED;
5674           }
5675       Uskip_whitespace(&s);
5676
5677       if (*s != '{')                                    /*}*/
5678         {
5679         expand_string_message = US"missing '{' for command arg of run";
5680         goto EXPAND_FAILED_CURLY;                       /*"}*/
5681         }
5682       s++;
5683
5684       if (late_expand)          /* this is the default case */
5685         {
5686         int n;
5687         const uschar * t;
5688         /* Locate the end of the args */
5689         (void) expand_string_internal(s,
5690           ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &t, NULL, NULL);
5691         n = t - s;
5692         arg = flags & ESI_SKIPPING ? NULL : string_copyn(s, n);
5693         s += n;
5694         }
5695       else
5696         {
5697         DEBUG(D_expand)
5698           debug_printf_indent("args string for ${run} expand before split\n");
5699         if (!(arg = expand_string_internal(s,
5700                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
5701           goto EXPAND_FAILED;
5702         Uskip_whitespace(&s);
5703         }
5704                                                         /*{*/
5705       if (*s++ != '}')
5706         {                                               /*{*/
5707         expand_string_message = US"missing '}' closing command arg of run";
5708         goto EXPAND_FAILED_CURLY;
5709         }
5710
5711       if (flags & ESI_SKIPPING)   /* Just pretend it worked when we're skipping */
5712         {
5713         runrc = 0;
5714         lookup_value = NULL;
5715         }
5716       else
5717         {
5718         int fd_in, fd_out;
5719         pid_t pid;
5720
5721         if (!transport_set_up_command(&argv,    /* anchor for arg list */
5722             arg,                                /* raw command */
5723             late_expand,                /* expand args if not already done */
5724             0,                          /* not relevant when... */
5725             NULL,                       /* no transporting address */
5726             US"${run} expansion",       /* for error messages */
5727             &expand_string_message))    /* where to put error message */
5728           goto EXPAND_FAILED;
5729
5730         /* Create the child process, making it a group leader. */
5731
5732         if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE,
5733                               US"expand-run")) < 0)
5734           {
5735           expand_string_message =
5736             string_sprintf("couldn't create child process: %s", strerror(errno));
5737           goto EXPAND_FAILED;
5738           }
5739
5740         /* Nothing is written to the standard input. */
5741
5742         (void)close(fd_in);
5743
5744         /* Read the pipe to get the command's output into $value (which is kept
5745         in lookup_value). Read during execution, so that if the output exceeds
5746         the OS pipe buffer limit, we don't block forever. Remember to not release
5747         memory just allocated for $value. */
5748
5749         resetok = FALSE;
5750         f = fdopen(fd_out, "rb");
5751         sigalrm_seen = FALSE;
5752         ALARM(60);
5753         lookup_value = string_from_gstring(cat_file(f, NULL, NULL));
5754         ALARM_CLR(0);
5755         (void)fclose(f);
5756
5757         /* Wait for the process to finish, applying the timeout, and inspect its
5758         return code for serious disasters. Simple non-zero returns are passed on.
5759         */
5760
5761         if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)
5762           {
5763           if (sigalrm_seen || runrc == -256)
5764             {
5765             expand_string_message = US"command timed out";
5766             killpg(pid, SIGKILL);       /* Kill the whole process group */
5767             }
5768
5769           else if (runrc == -257)
5770             expand_string_message = string_sprintf("wait() failed: %s",
5771               strerror(errno));
5772
5773           else
5774             expand_string_message = string_sprintf("command killed by signal %d",
5775               -runrc);
5776
5777           goto EXPAND_FAILED;
5778           }
5779         }
5780
5781       /* Process the yes/no strings; $value may be useful in both cases */
5782
5783       switch(process_yesno(
5784                flags,                   /* were previously skipping */
5785                runrc == 0,              /* success/failure indicator */
5786                lookup_value,            /* value to reset for string2 */
5787                &s,                      /* input pointer */
5788                &yield,                  /* output pointer */
5789                US"run",                 /* condition type */
5790                &resetok))
5791         {
5792         case 1: goto EXPAND_FAILED;          /* when all is well, the */
5793         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
5794         }
5795
5796       if (flags & ESI_SKIPPING) continue;
5797       break;
5798       }
5799
5800     /* Handle character translation for "tr" */
5801
5802     case EITEM_TR:
5803       {
5804       int oldptr = gstring_length(yield);
5805       int o2m;
5806       uschar * sub[3];
5807
5808       switch(read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, NULL))
5809         {
5810         case -1: continue;      /* skipping */
5811         case 1: goto EXPAND_FAILED_CURLY;
5812         case 2:
5813         case 3: goto EXPAND_FAILED;
5814         }
5815
5816       if (  (yield = string_cat(yield, sub[0]))
5817          && (o2m = Ustrlen(sub[2]) - 1) >= 0)
5818           for (; oldptr < yield->ptr; oldptr++)
5819         {
5820         uschar * m = Ustrrchr(sub[1], yield->s[oldptr]);
5821         if (m)
5822           {
5823           int o = m - sub[1];
5824           yield->s[oldptr] = sub[2][o < o2m ? o : o2m];
5825           }
5826         }
5827
5828       break;
5829       }
5830
5831     /* Handle "hash", "length", "nhash", and "substr" when they are given with
5832     expanded arguments. */
5833
5834     case EITEM_HASH:
5835     case EITEM_LENGTH:
5836     case EITEM_NHASH:
5837     case EITEM_SUBSTR:
5838       {
5839       int len;
5840       uschar *ret;
5841       int val[2] = { 0, -1 };
5842       uschar * sub[3];
5843
5844       /* "length" takes only 2 arguments whereas the others take 2 or 3.
5845       Ensure that sub[2] is set in the ${length } case. */
5846
5847       sub[2] = NULL;
5848       switch(read_subs(sub, item_type == EITEM_LENGTH ? 2:3, 2, &s, flags,
5849              TRUE, name, &resetok, NULL))
5850         {
5851         case -1: continue;      /* skipping */
5852         case 1: goto EXPAND_FAILED_CURLY;
5853         case 2:
5854         case 3: goto EXPAND_FAILED;
5855         }
5856
5857       /* Juggle the arguments if there are only two of them: always move the
5858       string to the last position and make ${length{n}{str}} equivalent to
5859       ${substr{0}{n}{str}}. See the defaults for val[] above. */
5860
5861       if (!sub[2])
5862         {
5863         sub[2] = sub[1];
5864         sub[1] = NULL;
5865         if (item_type == EITEM_LENGTH)
5866           {
5867           sub[1] = sub[0];
5868           sub[0] = NULL;
5869           }
5870         }
5871
5872       for (int i = 0; i < 2; i++) if (sub[i])
5873         {
5874         val[i] = (int)Ustrtol(sub[i], &ret, 10);
5875         if (*ret != 0 || (i != 0 && val[i] < 0))
5876           {
5877           expand_string_message = string_sprintf("\"%s\" is not a%s number "
5878             "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5879           goto EXPAND_FAILED;
5880           }
5881         }
5882
5883       ret =
5884         item_type == EITEM_HASH
5885         ?  compute_hash(sub[2], val[0], val[1], &len)
5886         : item_type == EITEM_NHASH
5887         ? compute_nhash(sub[2], val[0], val[1], &len)
5888         : extract_substr(sub[2], val[0], val[1], &len);
5889       if (!ret)
5890         goto EXPAND_FAILED;
5891       yield = string_catn(yield, ret, len);
5892       break;
5893       }
5894
5895     /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5896     This code originally contributed by Steve Haslam. It currently supports
5897     the use of MD5 and SHA-1 hashes.
5898
5899     We need some workspace that is large enough to handle all the supported
5900     hash types. Use macros to set the sizes rather than be too elaborate. */
5901
5902     #define MAX_HASHLEN      20
5903     #define MAX_HASHBLOCKLEN 64
5904
5905     case EITEM_HMAC:
5906       {
5907       uschar * sub[3];
5908       md5 md5_base;
5909       hctx sha1_ctx;
5910       void * use_base;
5911       int type;
5912       int hashlen;      /* Number of octets for the hash algorithm's output */
5913       int hashblocklen; /* Number of octets the hash algorithm processes */
5914       uschar * keyptr, * p;
5915       unsigned int keylen;
5916
5917       uschar keyhash[MAX_HASHLEN];
5918       uschar innerhash[MAX_HASHLEN];
5919       uschar finalhash[MAX_HASHLEN];
5920       uschar finalhash_hex[2*MAX_HASHLEN];
5921       uschar innerkey[MAX_HASHBLOCKLEN];
5922       uschar outerkey[MAX_HASHBLOCKLEN];
5923
5924       switch (read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, NULL))
5925         {
5926         case -1: continue;      /* skipping */
5927         case 1: goto EXPAND_FAILED_CURLY;
5928         case 2:
5929         case 3: goto EXPAND_FAILED;
5930         }
5931
5932       if (Ustrcmp(sub[0], "md5") == 0)
5933         {
5934         type = HMAC_MD5;
5935         use_base = &md5_base;
5936         hashlen = 16;
5937         hashblocklen = 64;
5938         }
5939       else if (Ustrcmp(sub[0], "sha1") == 0)
5940         {
5941         type = HMAC_SHA1;
5942         use_base = &sha1_ctx;
5943         hashlen = 20;
5944         hashblocklen = 64;
5945         }
5946       else
5947         {
5948         expand_string_message =
5949           string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5950         goto EXPAND_FAILED;
5951         }
5952
5953       keyptr = sub[1];
5954       keylen = Ustrlen(keyptr);
5955
5956       /* If the key is longer than the hash block length, then hash the key
5957       first */
5958
5959       if (keylen > hashblocklen)
5960         {
5961         chash_start(type, use_base);
5962         chash_end(type, use_base, keyptr, keylen, keyhash);
5963         keyptr = keyhash;
5964         keylen = hashlen;
5965         }
5966
5967       /* Now make the inner and outer key values */
5968
5969       memset(innerkey, 0x36, hashblocklen);
5970       memset(outerkey, 0x5c, hashblocklen);
5971
5972       for (int i = 0; i < keylen; i++)
5973         {
5974         innerkey[i] ^= keyptr[i];
5975         outerkey[i] ^= keyptr[i];
5976         }
5977
5978       /* Now do the hashes */
5979
5980       chash_start(type, use_base);
5981       chash_mid(type, use_base, innerkey);
5982       chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5983
5984       chash_start(type, use_base);
5985       chash_mid(type, use_base, outerkey);
5986       chash_end(type, use_base, innerhash, hashlen, finalhash);
5987
5988       /* Encode the final hash as a hex string */
5989
5990       p = finalhash_hex;
5991       for (int i = 0; i < hashlen; i++)
5992         {
5993         *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5994         *p++ = hex_digits[finalhash[i] & 0x0f];
5995         }
5996
5997       DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
5998         sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);
5999
6000       yield = string_catn(yield, finalhash_hex, hashlen*2);
6001       break;
6002       }
6003
6004     /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
6005     We have to save the numerical variables and restore them afterwards. */
6006
6007     case EITEM_SG:
6008       {
6009       const pcre2_code * re;
6010       int moffset, moffsetextra, slen;
6011       pcre2_match_data * md;
6012       int emptyopt;
6013       uschar * subject, * sub[3];
6014       int save_expand_nmax =
6015         save_expand_strings(save_expand_nstring, save_expand_nlength);
6016       unsigned sub_textonly = 0;
6017
6018       switch(read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, &sub_textonly))
6019         {
6020         case -1: continue;      /* skipping */
6021         case 1: goto EXPAND_FAILED_CURLY;
6022         case 2:
6023         case 3: goto EXPAND_FAILED;
6024         }
6025
6026       /* Compile the regular expression */
6027
6028       re = regex_compile(sub[1],
6029               sub_textonly & BIT(1) ? MCS_CACHEABLE : MCS_NOFLAGS,
6030               &expand_string_message, pcre_gen_cmp_ctx);
6031       if (!re)
6032         goto EXPAND_FAILED;
6033
6034       md = pcre2_match_data_create(EXPAND_MAXN + 1, pcre_gen_ctx);
6035
6036       /* Now run a loop to do the substitutions as often as necessary. It ends
6037       when there are no more matches. Take care over matches of the null string;
6038       do the same thing as Perl does. */
6039
6040       subject = sub[0];
6041       slen = Ustrlen(sub[0]);
6042       moffset = moffsetextra = 0;
6043       emptyopt = 0;
6044
6045       for (;;)
6046         {
6047         PCRE2_SIZE * ovec = pcre2_get_ovector_pointer(md);
6048         int n = pcre2_match(re, (PCRE2_SPTR)subject, slen, moffset + moffsetextra,
6049           PCRE_EOPT | emptyopt, md, pcre_gen_mtc_ctx);
6050         uschar * insert;
6051
6052         /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
6053         is not necessarily the end. We want to repeat the match from one
6054         character further along, but leaving the basic offset the same (for
6055         copying below). We can't be at the end of the string - that was checked
6056         before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
6057         finished; copy the remaining string and end the loop. */
6058
6059         if (n < 0)
6060           {
6061           if (emptyopt != 0)
6062             {
6063             moffsetextra = 1;
6064             emptyopt = 0;
6065             continue;
6066             }
6067           yield = string_catn(yield, subject+moffset, slen-moffset);
6068           break;
6069           }
6070
6071         /* Match - set up for expanding the replacement. */
6072         DEBUG(D_expand) debug_printf_indent("%s: match\n", name);
6073
6074         if (n == 0) n = EXPAND_MAXN + 1;
6075         expand_nmax = 0;
6076         for (int nn = 0; nn < n*2; nn += 2)
6077           {
6078           expand_nstring[expand_nmax] = subject + ovec[nn];
6079           expand_nlength[expand_nmax++] = ovec[nn+1] - ovec[nn];
6080           }
6081         expand_nmax--;
6082
6083         /* Copy the characters before the match, plus the expanded insertion. */
6084
6085         yield = string_catn(yield, subject + moffset, ovec[0] - moffset);
6086
6087         if (!(insert = expand_string(sub[2])))
6088           goto EXPAND_FAILED;
6089         yield = string_cat(yield, insert);
6090
6091         moffset = ovec[1];
6092         moffsetextra = 0;
6093         emptyopt = 0;
6094
6095         /* If we have matched an empty string, first check to see if we are at
6096         the end of the subject. If so, the loop is over. Otherwise, mimic
6097         what Perl's /g options does. This turns out to be rather cunning. First
6098         we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
6099         string at the same point. If this fails (picked up above) we advance to
6100         the next character. */
6101
6102         if (ovec[0] == ovec[1])
6103           {
6104           if (ovec[0] == slen) break;
6105           emptyopt = PCRE2_NOTEMPTY | PCRE2_ANCHORED;
6106           }
6107         }
6108
6109       /* All done - restore numerical variables. */
6110
6111       /* pcre2_match_data_free(md);     gen ctx needs no free */
6112       restore_expand_strings(save_expand_nmax, save_expand_nstring,
6113         save_expand_nlength);
6114       break;
6115       }
6116
6117     /* Handle keyed and numbered substring extraction. If the first argument
6118     consists entirely of digits, then a numerical extraction is assumed. */
6119
6120     case EITEM_EXTRACT:
6121       {
6122       int field_number = 1;
6123       BOOL field_number_set = FALSE;
6124       uschar * save_lookup_value = lookup_value, * sub[3];
6125       int save_expand_nmax =
6126         save_expand_strings(save_expand_nstring, save_expand_nlength);
6127
6128       /* On reflection the original behaviour of extract-json for a string
6129       result, leaving it quoted, was a mistake.  But it was already published,
6130       hence the addition of jsons.  In a future major version, make json
6131       work like josons, and withdraw jsons. */
6132
6133       enum {extract_basic, extract_json, extract_jsons} fmt = extract_basic;
6134
6135       /* Check for a format-variant specifier */
6136
6137       if (Uskip_whitespace(&s) != '{')                                  /*}*/
6138         if (Ustrncmp(s, "json", 4) == 0)
6139           if (*(s += 4) == 's')
6140             {fmt = extract_jsons; s++;}
6141           else
6142             fmt = extract_json;
6143
6144       /* While skipping we cannot rely on the data for expansions being
6145       available (eg. $item) hence cannot decide on numeric vs. keyed.
6146       Read a maximum of 5 arguments (including the yes/no) */
6147
6148       if (flags & ESI_SKIPPING)
6149         {
6150         for (int j = 5; j > 0 && *s == '{'; j--)                        /*'}'*/
6151           {
6152           if (!expand_string_internal(s+1,
6153                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL))
6154             goto EXPAND_FAILED;                                 /*'{'*/
6155           if (*s++ != '}')
6156             {
6157             expand_string_message = US"missing '{' for arg of extract";
6158             goto EXPAND_FAILED_CURLY;
6159             }
6160           Uskip_whitespace(&s);
6161           }
6162         if (  Ustrncmp(s, "fail", 4) == 0                               /*'{'*/
6163            && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
6164            )
6165           {
6166           s += 4;
6167           Uskip_whitespace(&s);
6168           }                                                             /*'{'*/
6169         if (*s != '}')
6170           {
6171           expand_string_message = US"missing '}' closing extract";
6172           goto EXPAND_FAILED_CURLY;
6173           }
6174         }
6175
6176       else for (int i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
6177         {
6178         if (Uskip_whitespace(&s) == '{')                                /*'}'*/
6179           {
6180           if (!(sub[i] = expand_string_internal(s+1,
6181                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
6182             goto EXPAND_FAILED;                                         /*'{'*/
6183           if (*s++ != '}')
6184             {
6185             expand_string_message = string_sprintf(
6186               "missing '}' closing arg %d of extract", i+1);
6187             goto EXPAND_FAILED_CURLY;
6188             }
6189
6190           /* After removal of leading and trailing white space, the first
6191           argument must not be empty; if it consists entirely of digits
6192           (optionally preceded by a minus sign), this is a numerical
6193           extraction, and we expect 3 arguments (normal) or 2 (json). */
6194
6195           if (i == 0)
6196             {
6197             int len;
6198             int x = 0;
6199             uschar * p = sub[0];
6200
6201             Uskip_whitespace(&p);
6202             sub[0] = p;
6203
6204             len = Ustrlen(p);
6205             while (len > 0 && isspace(p[len-1])) len--;
6206             p[len] = 0;
6207
6208             if (!*p)
6209               {
6210               expand_string_message = US"first argument of \"extract\" must "
6211                 "not be empty";
6212               goto EXPAND_FAILED;
6213               }
6214
6215             if (*p == '-')
6216               {
6217               field_number = -1;
6218               p++;
6219               }
6220             while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
6221             if (!*p)
6222               {
6223               field_number *= x;
6224               if (fmt == extract_basic) j = 3;               /* Need 3 args */
6225               field_number_set = TRUE;
6226               }
6227             }
6228           }
6229         else
6230           {
6231           expand_string_message = string_sprintf(
6232             "missing '{' for arg %d of extract", i+1);
6233           goto EXPAND_FAILED_CURLY;
6234           }
6235         }
6236
6237       /* Extract either the numbered or the keyed substring into $value. If
6238       skipping, just pretend the extraction failed. */
6239
6240       if (flags & ESI_SKIPPING)
6241         lookup_value = NULL;
6242       else switch (fmt)
6243         {
6244         case extract_basic:
6245           lookup_value = field_number_set
6246             ? expand_gettokened(field_number, sub[1], sub[2])
6247             : expand_getkeyed(sub[0], sub[1]);
6248           break;
6249
6250         case extract_json:
6251         case extract_jsons:
6252           {
6253           uschar * s, * item;
6254           const uschar * list;
6255
6256           /* Array: Bracket-enclosed and comma-separated.
6257           Object: Brace-enclosed, comma-sep list of name:value pairs */
6258
6259           if (!(s = dewrap(sub[1], field_number_set ? US"[]" : US"{}")))
6260             {
6261             expand_string_message =
6262               string_sprintf("%s wrapping %s for extract json",
6263                 expand_string_message,
6264                 field_number_set ? "array" : "object");
6265             goto EXPAND_FAILED_CURLY;
6266             }
6267
6268           list = s;
6269           if (field_number_set)
6270             {
6271             if (field_number <= 0)
6272               {
6273               expand_string_message = US"first argument of \"extract\" must "
6274                 "be greater than zero";
6275               goto EXPAND_FAILED;
6276               }
6277             while (field_number > 0 && (item = json_nextinlist(&list)))
6278               field_number--;
6279             if ((lookup_value = s = item))
6280               {
6281               while (*s) s++;
6282               while (--s >= lookup_value && isspace(*s)) *s = '\0';
6283               }
6284             }
6285           else
6286             {
6287             lookup_value = NULL;
6288             while ((item = json_nextinlist(&list)))
6289               {
6290               /* Item is:  string name-sep value.  string is quoted.
6291               Dequote the string and compare with the search key. */
6292
6293               if (!(item = dewrap(item, US"\"\"")))
6294                 {
6295                 expand_string_message =
6296                   string_sprintf("%s wrapping string key for extract json",
6297                     expand_string_message);
6298                 goto EXPAND_FAILED_CURLY;
6299                 }
6300               if (Ustrcmp(item, sub[0]) == 0)   /*XXX should be a UTF8-compare */
6301                 {
6302                 s = item + Ustrlen(item) + 1;
6303                 if (Uskip_whitespace(&s) != ':')
6304                   {
6305                   expand_string_message =
6306                     US"missing object value-separator for extract json";
6307                   goto EXPAND_FAILED_CURLY;
6308                   }
6309                 s++;
6310                 Uskip_whitespace(&s);
6311                 lookup_value = s;
6312                 break;
6313                 }
6314               }
6315             }
6316           }
6317
6318           if (  fmt == extract_jsons
6319              && lookup_value
6320              && !(lookup_value = dewrap(lookup_value, US"\"\"")))
6321             {
6322             expand_string_message =
6323               string_sprintf("%s wrapping string result for extract jsons",
6324                 expand_string_message);
6325             goto EXPAND_FAILED_CURLY;
6326             }
6327           break;        /* json/s */
6328         }
6329
6330       /* If no string follows, $value gets substituted; otherwise there can
6331       be yes/no strings, as for lookup or if. */
6332
6333       switch(process_yesno(
6334                flags,                   /* were previously skipping */
6335                lookup_value != NULL,    /* success/failure indicator */
6336                save_lookup_value,       /* value to reset for string2 */
6337                &s,                      /* input pointer */
6338                &yield,                  /* output pointer */
6339                US"extract",             /* condition type */
6340                &resetok))
6341         {
6342         case 1: goto EXPAND_FAILED;          /* when all is well, the */
6343         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
6344         }
6345
6346       /* All done - restore numerical variables. */
6347
6348       restore_expand_strings(save_expand_nmax, save_expand_nstring,
6349         save_expand_nlength);
6350
6351       if (flags & ESI_SKIPPING) continue;
6352       break;
6353       }
6354
6355     /* return the Nth item from a list */
6356
6357     case EITEM_LISTEXTRACT:
6358       {
6359       int field_number = 1;
6360       uschar * save_lookup_value = lookup_value, * sub[2];
6361       int save_expand_nmax =
6362         save_expand_strings(save_expand_nstring, save_expand_nlength);
6363
6364       /* Read the field & list arguments */
6365       /*XXX Could we use read_subs here (and get better efficiency for skipping)? */
6366
6367       for (int i = 0; i < 2; i++)
6368         {
6369         if (Uskip_whitespace(&s) != '{')                                /*}*/
6370           {
6371           expand_string_message = string_sprintf(
6372             "missing '{' for arg %d of listextract", i+1);              /*}*/
6373           goto EXPAND_FAILED_CURLY;
6374           }
6375
6376         sub[i] = expand_string_internal(s+1,
6377               ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6378         if (!sub[i])     goto EXPAND_FAILED;                            /*{{*/
6379         if (*s++ != '}')
6380           {
6381           expand_string_message = string_sprintf(
6382             "missing '}' closing arg %d of listextract", i+1);
6383           goto EXPAND_FAILED_CURLY;
6384           }
6385
6386         /* After removal of leading and trailing white space, the first
6387         argument must be numeric and nonempty. */
6388
6389         if (i == 0)
6390           {
6391           int len;
6392           int x = 0;
6393           uschar *p = sub[0];
6394
6395           Uskip_whitespace(&p);
6396           sub[0] = p;
6397
6398           len = Ustrlen(p);
6399           while (len > 0 && isspace(p[len-1])) len--;
6400           p[len] = 0;
6401
6402           if (!*p && !(flags & ESI_SKIPPING))
6403             {
6404             expand_string_message = US"first argument of \"listextract\" must "
6405               "not be empty";
6406             goto EXPAND_FAILED;
6407             }
6408
6409           if (*p == '-')
6410             {
6411             field_number = -1;
6412             p++;
6413             }
6414           while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
6415           if (*p)
6416             {
6417             expand_string_message = US"first argument of \"listextract\" must "
6418               "be numeric";
6419             goto EXPAND_FAILED;
6420             }
6421           field_number *= x;
6422           }
6423         }
6424
6425       /* Extract the numbered element into $value. If
6426       skipping, just pretend the extraction failed. */
6427
6428       lookup_value = flags & ESI_SKIPPING ? NULL : expand_getlistele(field_number, sub[1]);
6429
6430       /* If no string follows, $value gets substituted; otherwise there can
6431       be yes/no strings, as for lookup or if. */
6432
6433       switch(process_yesno(
6434                flags,                           /* were previously skipping */
6435                lookup_value != NULL,            /* success/failure indicator */
6436                save_lookup_value,               /* value to reset for string2 */
6437                &s,                              /* input pointer */
6438                &yield,                          /* output pointer */
6439                US"listextract",                 /* condition type */
6440                &resetok))
6441         {
6442         case 1: goto EXPAND_FAILED;          /* when all is well, the */
6443         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
6444         }
6445
6446       /* All done - restore numerical variables. */
6447
6448       restore_expand_strings(save_expand_nmax, save_expand_nstring,
6449         save_expand_nlength);
6450
6451       if (flags & ESI_SKIPPING) continue;
6452       break;
6453       }
6454
6455     case EITEM_LISTQUOTE:
6456       {
6457       uschar * sub[2];
6458       switch(read_subs(sub, 2, 2, &s, flags, TRUE, name, &resetok, NULL))
6459         {
6460         case -1: continue;      /* skipping */
6461         case 1: goto EXPAND_FAILED_CURLY;
6462         case 2:
6463         case 3: goto EXPAND_FAILED;
6464         }
6465       if (*sub[1]) for (uschar sep = *sub[0], c; c = *sub[1]; sub[1]++)
6466         {
6467         if (c == sep) yield = string_catn(yield, sub[1], 1);
6468         yield = string_catn(yield, sub[1], 1);
6469         }
6470       else yield = string_catn(yield, US" ", 1);
6471       break;
6472       }
6473
6474 #ifndef DISABLE_TLS
6475     case EITEM_CERTEXTRACT:
6476       {
6477       uschar * save_lookup_value = lookup_value, * sub[2];
6478       int save_expand_nmax =
6479         save_expand_strings(save_expand_nstring, save_expand_nlength);
6480
6481       /* Read the field argument */
6482       if (Uskip_whitespace(&s) != '{')                                  /*}*/
6483         {
6484         expand_string_message = US"missing '{' for field arg of certextract";
6485         goto EXPAND_FAILED_CURLY;                                       /*}*/
6486         }
6487       sub[0] = expand_string_internal(s+1,
6488                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6489       if (!sub[0])     goto EXPAND_FAILED;                              /*{{*/
6490       if (*s++ != '}')
6491         {
6492         expand_string_message = US"missing '}' closing field arg of certextract";
6493         goto EXPAND_FAILED_CURLY;
6494         }
6495       /* strip spaces fore & aft */
6496       {
6497       int len;
6498       uschar *p = sub[0];
6499
6500       Uskip_whitespace(&p);
6501       sub[0] = p;
6502
6503       len = Ustrlen(p);
6504       while (len > 0 && isspace(p[len-1])) len--;
6505       p[len] = 0;
6506       }
6507
6508       /* inspect the cert argument */
6509       if (Uskip_whitespace(&s) != '{')                                  /*}*/
6510         {
6511         expand_string_message = US"missing '{' for cert variable arg of certextract";
6512         goto EXPAND_FAILED_CURLY;                                       /*}*/
6513         }
6514       if (*++s != '$')
6515         {
6516         expand_string_message = US"second argument of \"certextract\" must "
6517           "be a certificate variable";
6518         goto EXPAND_FAILED;
6519         }
6520       sub[1] = expand_string_internal(s+1,
6521                 ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s, &resetok, NULL);
6522       if (!sub[1])     goto EXPAND_FAILED;                              /*{{*/
6523       if (*s++ != '}')
6524         {
6525         expand_string_message = US"missing '}' closing cert variable arg of certextract";
6526         goto EXPAND_FAILED_CURLY;
6527         }
6528
6529       if (flags & ESI_SKIPPING)
6530         lookup_value = NULL;
6531       else
6532         {
6533         lookup_value = expand_getcertele(sub[0], sub[1]);
6534         if (*expand_string_message) goto EXPAND_FAILED;
6535         }
6536       switch(process_yesno(
6537                flags,                           /* were previously skipping */
6538                lookup_value != NULL,            /* success/failure indicator */
6539                save_lookup_value,               /* value to reset for string2 */
6540                &s,                              /* input pointer */
6541                &yield,                          /* output pointer */
6542                US"certextract",                 /* condition type */
6543                &resetok))
6544         {
6545         case 1: goto EXPAND_FAILED;          /* when all is well, the */
6546         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
6547         }
6548
6549       restore_expand_strings(save_expand_nmax, save_expand_nstring,
6550         save_expand_nlength);
6551       if (flags & ESI_SKIPPING) continue;
6552       break;
6553       }
6554 #endif  /*DISABLE_TLS*/
6555
6556     /* Handle list operations */
6557
6558     case EITEM_FILTER:
6559     case EITEM_MAP:
6560     case EITEM_REDUCE:
6561       {
6562       int sep = 0, save_ptr = gstring_length(yield);
6563       uschar outsep[2] = { '\0', '\0' };
6564       const uschar *list, *expr, *temp;
6565       uschar * save_iterate_item = iterate_item;
6566       uschar * save_lookup_value = lookup_value;
6567
6568       Uskip_whitespace(&s);
6569       if (*s++ != '{')                                                  /*}*/
6570         {
6571         expand_string_message =
6572           string_sprintf("missing '{' for first arg of %s", name);
6573         goto EXPAND_FAILED_CURLY;                                       /*}*/
6574         }
6575
6576       DEBUG(D_expand) debug_printf_indent("%s: evaluate input list list\n", name);
6577       if (!(list = expand_string_internal(s,
6578               ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
6579         goto EXPAND_FAILED;                                             /*{{*/
6580       if (*s++ != '}')
6581         {
6582         expand_string_message =
6583           string_sprintf("missing '}' closing first arg of %s", name);
6584         goto EXPAND_FAILED_CURLY;
6585         }
6586
6587       if (item_type == EITEM_REDUCE)
6588         {
6589         uschar * t;
6590         Uskip_whitespace(&s);
6591         if (*s++ != '{')                                                /*}*/
6592           {
6593           expand_string_message = US"missing '{' for second arg of reduce";
6594           goto EXPAND_FAILED_CURLY;                                     /*}*/
6595           }
6596         DEBUG(D_expand) debug_printf_indent("reduce: initial result list\n");
6597         t = expand_string_internal(s,
6598               ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6599         if (!t) goto EXPAND_FAILED;
6600         lookup_value = t;                                               /*{{*/
6601         if (*s++ != '}')
6602           {
6603           expand_string_message = US"missing '}' closing second arg of reduce";
6604           goto EXPAND_FAILED_CURLY;
6605           }
6606         }
6607
6608       Uskip_whitespace(&s);
6609       if (*s++ != '{')                                                  /*}*/
6610         {
6611         expand_string_message =
6612           string_sprintf("missing '{' for last arg of %s", name);       /*}*/
6613         goto EXPAND_FAILED_CURLY;
6614         }
6615
6616       expr = s;
6617
6618       /* For EITEM_FILTER, call eval_condition once, with result discarded (as
6619       if scanning a "false" part). This allows us to find the end of the
6620       condition, because if the list is empty, we won't actually evaluate the
6621       condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
6622       the normal internal expansion function. */
6623
6624       DEBUG(D_expand) debug_printf_indent("%s: find end of conditionn\n", name);
6625       if (item_type != EITEM_FILTER)
6626         temp = expand_string_internal(s,
6627           ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL);
6628       else
6629         if ((temp = eval_condition(expr, &resetok, NULL))) s = temp;
6630
6631       if (!temp)
6632         {
6633         expand_string_message = string_sprintf("%s inside \"%s\" item",
6634           expand_string_message, name);
6635         goto EXPAND_FAILED;
6636         }
6637
6638       Uskip_whitespace(&s);                                             /*{{{*/
6639       if (*s++ != '}')
6640         {
6641         expand_string_message = string_sprintf("missing } at end of condition "
6642           "or expression inside \"%s\"; could be an unquoted } in the content",
6643           name);
6644         goto EXPAND_FAILED;
6645         }
6646
6647       Uskip_whitespace(&s);                                             /*{{*/
6648       if (*s++ != '}')
6649         {
6650         expand_string_message = string_sprintf("missing } at end of \"%s\"",
6651           name);
6652         goto EXPAND_FAILED;
6653         }
6654
6655       /* If we are skipping, we can now just move on to the next item. When
6656       processing for real, we perform the iteration. */
6657
6658       if (flags & ESI_SKIPPING) continue;
6659       while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
6660         {
6661         *outsep = (uschar)sep;      /* Separator as a string */
6662
6663         DEBUG(D_expand) debug_printf_indent("%s: $item = '%s'  $value = '%s'\n",
6664                           name, iterate_item, lookup_value);
6665
6666         if (item_type == EITEM_FILTER)
6667           {
6668           BOOL condresult;
6669           /* the condition could modify $value, as a side-effect */
6670           uschar * save_value = lookup_value;
6671
6672           if (!eval_condition(expr, &resetok, &condresult))
6673             {
6674             iterate_item = save_iterate_item;
6675             lookup_value = save_lookup_value;
6676             expand_string_message = string_sprintf("%s inside \"%s\" condition",
6677               expand_string_message, name);
6678             goto EXPAND_FAILED;
6679             }
6680           lookup_value = save_value;
6681           DEBUG(D_expand) debug_printf_indent("%s: condition is %s\n", name,
6682             condresult? "true":"false");
6683           if (condresult)
6684             temp = iterate_item;    /* TRUE => include this item */
6685           else
6686             continue;               /* FALSE => skip this item */
6687           }
6688
6689         else                    /* EITEM_MAP and EITEM_REDUCE */
6690           {
6691           /* the expansion could modify $value, as a side-effect */
6692           uschar * t = expand_string_internal(expr,
6693             ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, NULL, &resetok, NULL);
6694           if (!(temp = t))
6695             {
6696             iterate_item = save_iterate_item;
6697             expand_string_message = string_sprintf("%s inside \"%s\" item",
6698               expand_string_message, name);
6699             goto EXPAND_FAILED;
6700             }
6701           if (item_type == EITEM_REDUCE)
6702             {
6703             lookup_value = t;         /* Update the value of $value */
6704             continue;                 /* and continue the iteration */
6705             }
6706           }
6707
6708         /* We reach here for FILTER if the condition is true, always for MAP,
6709         and never for REDUCE. The value in "temp" is to be added to the output
6710         list that is being created, ensuring that any occurrences of the
6711         separator character are doubled. Unless we are dealing with the first
6712         item of the output list, add in a space if the new item begins with the
6713         separator character, or is an empty string. */
6714
6715 /*XXX is there not a standard support function for this, appending to a list? */
6716 /* yes, string_append_listele(), but it depends on lack of text before the list */
6717
6718         if (  yield && yield->ptr != save_ptr
6719            && (temp[0] == *outsep || temp[0] == 0))
6720           yield = string_catn(yield, US" ", 1);
6721
6722         /* Add the string in "temp" to the output list that we are building,
6723         This is done in chunks by searching for the separator character. */
6724
6725         for (;;)
6726           {
6727           size_t seglen = Ustrcspn(temp, outsep);
6728
6729           yield = string_catn(yield, temp, seglen + 1);
6730
6731           /* If we got to the end of the string we output one character
6732           too many; backup and end the loop. Otherwise arrange to double the
6733           separator. */
6734
6735           if (!temp[seglen]) { yield->ptr--; break; }
6736           yield = string_catn(yield, outsep, 1);
6737           temp += seglen + 1;
6738           }
6739
6740         /* Output a separator after the string: we will remove the redundant
6741         final one at the end. */
6742
6743         yield = string_catn(yield, outsep, 1);
6744         }   /* End of iteration over the list loop */
6745
6746       /* REDUCE has generated no output above: output the final value of
6747       $value. */
6748
6749       if (item_type == EITEM_REDUCE)
6750         {
6751         yield = string_cat(yield, lookup_value);
6752         lookup_value = save_lookup_value;  /* Restore $value */
6753         }
6754
6755       /* FILTER and MAP generate lists: if they have generated anything, remove
6756       the redundant final separator. Even though an empty item at the end of a
6757       list does not count, this is tidier. */
6758
6759       else if (yield && yield->ptr != save_ptr) yield->ptr--;
6760
6761       /* Restore preserved $item */
6762
6763       iterate_item = save_iterate_item;
6764       if (flags & ESI_SKIPPING) continue;
6765       break;
6766       }
6767
6768     case EITEM_SORT:
6769       {
6770       int sep = 0, cond_type;
6771       const uschar * srclist, * cmp, * xtract;
6772       uschar * opname, * srcitem;
6773       const uschar * dstlist = NULL, * dstkeylist = NULL;
6774       uschar * tmp, * save_iterate_item = iterate_item;
6775
6776       Uskip_whitespace(&s);
6777       if (*s++ != '{')                                                  /*}*/
6778         {
6779         expand_string_message = US"missing '{' for list arg of sort";
6780         goto EXPAND_FAILED_CURLY;                                       /*}*/
6781         }
6782
6783       srclist = expand_string_internal(s,
6784               ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6785       if (!srclist) goto EXPAND_FAILED;                                 /*{{*/
6786       if (*s++ != '}')
6787         {
6788         expand_string_message = US"missing '}' closing list arg of sort";
6789         goto EXPAND_FAILED_CURLY;
6790         }
6791
6792       Uskip_whitespace(&s);
6793       if (*s++ != '{')                                                  /*}*/
6794         {
6795         expand_string_message = US"missing '{' for comparator arg of sort";
6796         goto EXPAND_FAILED_CURLY;                                       /*}*/
6797         }
6798
6799       cmp = expand_string_internal(s,
6800               ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s, &resetok, NULL);
6801       if (!cmp) goto EXPAND_FAILED;                                     /*{{*/
6802       if (*s++ != '}')
6803         {
6804         expand_string_message = US"missing '}' closing comparator arg of sort";
6805         goto EXPAND_FAILED_CURLY;
6806         }
6807
6808       if ((cond_type = identify_operator(&cmp, &opname)) == -1)
6809         {
6810         if (!expand_string_message)
6811           expand_string_message = string_sprintf("unknown condition \"%s\"", s);
6812         goto EXPAND_FAILED;
6813         }
6814       switch(cond_type)
6815         {
6816         case ECOND_NUM_L: case ECOND_NUM_LE:
6817         case ECOND_NUM_G: case ECOND_NUM_GE:
6818         case ECOND_STR_GE: case ECOND_STR_GEI: case ECOND_STR_GT: case ECOND_STR_GTI:
6819         case ECOND_STR_LE: case ECOND_STR_LEI: case ECOND_STR_LT: case ECOND_STR_LTI:
6820           break;
6821
6822         default:
6823           expand_string_message = US"comparator not handled for sort";
6824           goto EXPAND_FAILED;
6825         }
6826
6827       Uskip_whitespace(&s);
6828       if (*s++ != '{')                                                  /*}*/
6829         {
6830         expand_string_message = US"missing '{' for extractor arg of sort";
6831         goto EXPAND_FAILED_CURLY;                                       /*}*/
6832         }
6833
6834       xtract = s;
6835       if (!(tmp = expand_string_internal(s,
6836         ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL)))
6837         goto EXPAND_FAILED;
6838       xtract = string_copyn(xtract, s - xtract);
6839                                                                         /*{{*/
6840       if (*s++ != '}')
6841         {
6842         expand_string_message = US"missing '}' closing extractor arg of sort";
6843         goto EXPAND_FAILED_CURLY;
6844         }
6845                                                                         /*{{*/
6846       if (*s++ != '}')
6847         {
6848         expand_string_message = US"missing } at end of \"sort\"";
6849         goto EXPAND_FAILED;
6850         }
6851
6852       if (flags & ESI_SKIPPING) continue;
6853
6854       while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
6855         {
6856         uschar * srcfield, * dstitem;
6857         gstring * newlist = NULL, * newkeylist = NULL;
6858
6859         DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);
6860
6861         /* extract field for comparisons */
6862         iterate_item = srcitem;
6863         if (  !(srcfield = expand_string_internal(xtract,
6864                                   ESI_HONOR_DOLLAR, NULL, &resetok, NULL))
6865            || !*srcfield)
6866           {
6867           expand_string_message = string_sprintf(
6868               "field-extract in sort: \"%s\"", xtract);
6869           goto EXPAND_FAILED;
6870           }
6871
6872         /* Insertion sort */
6873
6874         /* copy output list until new-item < list-item */
6875         while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6876           {
6877           uschar * dstfield;
6878
6879           /* field for comparison */
6880           if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6881             goto SORT_MISMATCH;
6882
6883           /* String-comparator names start with a letter; numeric names do not */
6884
6885           if (sortsbefore(cond_type, isalpha(opname[0]),
6886               srcfield, dstfield))
6887             {
6888             /* New-item sorts before this dst-item.  Append new-item,
6889             then dst-item, then remainder of dst list. */
6890
6891             newlist = string_append_listele(newlist, sep, srcitem);
6892             newkeylist = string_append_listele(newkeylist, sep, srcfield);
6893             srcitem = NULL;
6894
6895             newlist = string_append_listele(newlist, sep, dstitem);
6896             newkeylist = string_append_listele(newkeylist, sep, dstfield);
6897
6898 /*XXX why field-at-a-time copy?  Why not just dup the rest of the list? */
6899             while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6900               {
6901               if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6902                 goto SORT_MISMATCH;
6903               newlist = string_append_listele(newlist, sep, dstitem);
6904               newkeylist = string_append_listele(newkeylist, sep, dstfield);
6905               }
6906
6907             break;
6908             }
6909
6910           newlist = string_append_listele(newlist, sep, dstitem);
6911           newkeylist = string_append_listele(newkeylist, sep, dstfield);
6912           }
6913
6914         /* If we ran out of dstlist without consuming srcitem, append it */
6915         if (srcitem)
6916           {
6917           newlist = string_append_listele(newlist, sep, srcitem);
6918           newkeylist = string_append_listele(newkeylist, sep, srcfield);
6919           }
6920
6921         dstlist = newlist->s;
6922         dstkeylist = newkeylist->s;
6923
6924         DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);
6925         DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6926         }
6927
6928       if (dstlist)
6929         yield = string_cat(yield, dstlist);
6930
6931       /* Restore preserved $item */
6932       iterate_item = save_iterate_item;
6933       break;
6934
6935       SORT_MISMATCH:
6936         expand_string_message = US"Internal error in sort (list mismatch)";
6937         goto EXPAND_FAILED;
6938       }
6939
6940
6941     /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6942     functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6943     or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6944     a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6945
6946     #define EXPAND_DLFUNC_MAX_ARGS 8
6947
6948     case EITEM_DLFUNC:
6949 #ifndef EXPAND_DLFUNC
6950       expand_string_message = US"\"${dlfunc\" encountered, but this facility "  /*}*/
6951         "is not included in this binary";
6952       goto EXPAND_FAILED;
6953
6954 #else   /* EXPAND_DLFUNC */
6955       {
6956       tree_node * t;
6957       exim_dlfunc_t * func;
6958       uschar * result;
6959       int status, argc;
6960       uschar * argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6961
6962       if (expand_forbid & RDO_DLFUNC)
6963         {
6964         expand_string_message =
6965           US"dynamically-loaded functions are not permitted";
6966         goto EXPAND_FAILED;
6967         }
6968
6969       switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, flags,
6970            TRUE, name, &resetok, NULL))
6971         {
6972         case -1: continue;      /* skipping */
6973         case 1: goto EXPAND_FAILED_CURLY;
6974         case 2:
6975         case 3: goto EXPAND_FAILED;
6976         }
6977
6978       /* Look up the dynamically loaded object handle in the tree. If it isn't
6979       found, dlopen() the file and put the handle in the tree for next time. */
6980
6981       if (!(t = tree_search(dlobj_anchor, argv[0])))
6982         {
6983         void * handle = dlopen(CS argv[0], RTLD_LAZY);
6984         if (!handle)
6985           {
6986           expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6987             argv[0], dlerror());
6988           log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6989           goto EXPAND_FAILED;
6990           }
6991         t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]), argv[0]);
6992         Ustrcpy(t->name, argv[0]);
6993         t->data.ptr = handle;
6994         (void)tree_insertnode(&dlobj_anchor, t);
6995         }
6996
6997       /* Having obtained the dynamically loaded object handle, look up the
6998       function pointer. */
6999
7000       if (!(func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1])))
7001         {
7002         expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
7003           "%s", argv[1], argv[0], dlerror());
7004         log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
7005         goto EXPAND_FAILED;
7006         }
7007
7008       /* Call the function and work out what to do with the result. If it
7009       returns OK, we have a replacement string; if it returns DEFER then
7010       expansion has failed in a non-forced manner; if it returns FAIL then
7011       failure was forced; if it returns ERROR or any other value there's a
7012       problem, so panic slightly. In any case, assume that the function has
7013       side-effects on the store that must be preserved. */
7014
7015       resetok = FALSE;
7016       result = NULL;
7017       for (argc = 0; argv[argc]; argc++) ;
7018
7019       if ((status = func(&result, argc - 2, &argv[2])) != OK)
7020         {
7021         expand_string_message = result ? result : US"(no message)";
7022         if (status == FAIL_FORCED)
7023           f.expand_string_forcedfail = TRUE;
7024         else if (status != FAIL)
7025           log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
7026               argv[0], argv[1], status, expand_string_message);
7027         goto EXPAND_FAILED;
7028         }
7029
7030       if (result) yield = string_cat(yield, result);
7031       break;
7032       }
7033 #endif /* EXPAND_DLFUNC */
7034
7035     case EITEM_ENV:     /* ${env {name} {val_if_found} {val_if_unfound}} */
7036       {
7037       uschar * key;
7038       uschar *save_lookup_value = lookup_value;
7039
7040       if (Uskip_whitespace(&s) != '{')                                  /*}*/
7041         goto EXPAND_FAILED;
7042
7043       key = expand_string_internal(s+1,
7044               ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
7045       if (!key) goto EXPAND_FAILED;                                     /*{{*/
7046       if (*s++ != '}')
7047         {
7048         expand_string_message = US"missing '}' for name arg of env";
7049         goto EXPAND_FAILED_CURLY;
7050         }
7051
7052       lookup_value = US getenv(CS key);
7053
7054       switch(process_yesno(
7055                flags,                           /* were previously skipping */
7056                lookup_value != NULL,            /* success/failure indicator */
7057                save_lookup_value,               /* value to reset for string2 */
7058                &s,                              /* input pointer */
7059                &yield,                          /* output pointer */
7060                US"env",                         /* condition type */
7061                &resetok))
7062         {
7063         case 1: goto EXPAND_FAILED;          /* when all is well, the */
7064         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
7065         }
7066       if (flags & ESI_SKIPPING) continue;
7067       break;
7068       }
7069
7070 #ifdef SUPPORT_SRS
7071     case EITEM_SRS_ENCODE:
7072       /* ${srs_encode {secret} {return_path} {orig_domain}} */
7073       {
7074       uschar * sub[3];
7075       uschar cksum[4];
7076       gstring * g = NULL;
7077       BOOL quoted = FALSE;
7078
7079       switch (read_subs(sub, 3, 3, CUSS &s, flags, TRUE, name, &resetok, NULL))
7080         {
7081         case -1: continue;      /* skipping */
7082         case 1: goto EXPAND_FAILED_CURLY;
7083         case 2:
7084         case 3: goto EXPAND_FAILED;
7085         }
7086       if (flags & ESI_SKIPPING) continue;
7087
7088       if (sub[1] && *(sub[1]))
7089         {
7090         g = string_catn(g, US"SRS0=", 5);
7091
7092         /* ${l_4:${hmac{md5}{SRS_SECRET}{${lc:$return_path}}}}= */
7093         hmac_md5(sub[0], string_copylc(sub[1]), cksum, sizeof(cksum));
7094         g = string_catn(g, cksum, sizeof(cksum));
7095         g = string_catn(g, US"=", 1);
7096
7097         /* ${base32:${eval:$tod_epoch/86400&0x3ff}}= */
7098           {
7099           struct timeval now;
7100           unsigned long i;
7101
7102           gettimeofday(&now, NULL);
7103           i = (now.tv_sec / 86400) & 0x3ff;
7104           g = string_catn(g, &base32_chars[i >> 5], 1);
7105           g = string_catn(g, &base32_chars[i & 0x1f], 1);
7106           }
7107         g = string_catn(g, US"=", 1);
7108
7109         /* ${domain:$return_path}=${local_part:$return_path} */
7110           {
7111           int start, end, domain;
7112           uschar * t = parse_extract_address(sub[1], &expand_string_message,
7113                                             &start, &end, &domain, FALSE);
7114           uschar * s;
7115
7116           if (!t)
7117             goto EXPAND_FAILED;
7118
7119           if (domain > 0) g = string_cat(g, t + domain);
7120           g = string_catn(g, US"=", 1);
7121
7122           s = domain > 0 ? string_copyn(t, domain - 1) : t;
7123           if ((quoted = Ustrchr(s, '"') != NULL))
7124             {
7125             gstring * h = NULL;
7126             DEBUG(D_expand) debug_printf_indent("auto-quoting local part\n");
7127             while (*s)          /* de-quote */
7128               {
7129               while (*s && *s != '"') h = string_catn(h, s++, 1);
7130               if (*s) s++;
7131               while (*s && *s != '"') h = string_catn(h, s++, 1);
7132               if (*s) s++;
7133               }
7134             gstring_release_unused(h);
7135             s = string_from_gstring(h);
7136             }
7137           if (s) g = string_cat(g, s);
7138           }
7139
7140         /* Assume that if the original local_part had quotes
7141         it was for good reason */
7142
7143         if (quoted) yield = string_catn(yield, US"\"", 1);
7144         yield = gstring_append(yield, g);
7145         if (quoted) yield = string_catn(yield, US"\"", 1);
7146
7147         /* @$original_domain */
7148         yield = string_catn(yield, US"@", 1);
7149         yield = string_cat(yield, sub[2]);
7150         }
7151       else
7152         DEBUG(D_expand) debug_printf_indent("null return_path for srs-encode\n");
7153
7154       break;
7155       }
7156 #endif /*SUPPORT_SRS*/
7157
7158     default:
7159       goto NOT_ITEM;
7160     }   /* EITEM_* switch */
7161     /*NOTREACHED*/
7162
7163   DEBUG(D_expand)               /* only if not the sole expansion of the line */
7164     if (yield && (expansion_start > 0 || *s))
7165       debug_expansion_interim(US"item-res",
7166           yield->s + expansion_start, yield->ptr - expansion_start,
7167           flags);
7168   continue;
7169
7170 NOT_ITEM: ;
7171   }
7172
7173   /* Control reaches here if the name is not recognized as one of the more
7174   complicated expansion items. Check for the "operator" syntax (name terminated
7175   by a colon). Some of the operators have arguments, separated by _ from the
7176   name. */
7177
7178   if (*s == ':')
7179     {
7180     int c;
7181     uschar * arg = NULL, * sub;
7182 #ifndef DISABLE_TLS
7183     var_entry * vp = NULL;
7184 #endif
7185
7186     /* Owing to an historical mis-design, an underscore may be part of the
7187     operator name, or it may introduce arguments.  We therefore first scan the
7188     table of names that contain underscores. If there is no match, we cut off
7189     the arguments and then scan the main table. */
7190
7191     if ((c = chop_match(name, op_table_underscore,
7192                         nelem(op_table_underscore))) < 0)
7193       {
7194       if ((arg = Ustrchr(name, '_')))
7195         *arg = 0;
7196       if ((c = chop_match(name, op_table_main, nelem(op_table_main))) >= 0)
7197         c += nelem(op_table_underscore);
7198       if (arg) *arg++ = '_';            /* Put back for error messages */
7199       }
7200
7201     /* Deal specially with operators that might take a certificate variable
7202     as we do not want to do the usual expansion. For most, expand the string.*/
7203
7204     switch(c)
7205       {
7206 #ifndef DISABLE_TLS
7207       case EOP_MD5:
7208       case EOP_SHA1:
7209       case EOP_SHA256:
7210       case EOP_BASE64:
7211         if (s[1] == '$')
7212           {
7213           const uschar * s1 = s;
7214           sub = expand_string_internal(s+2,
7215               ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s1, &resetok, NULL);
7216           if (!sub)       goto EXPAND_FAILED;           /*{*/
7217           if (*s1 != '}')
7218             {                                           /*{*/
7219             expand_string_message =
7220               string_sprintf("missing '}' closing cert arg of %s", name);
7221             goto EXPAND_FAILED_CURLY;
7222             }
7223           if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
7224             {
7225             s = s1+1;
7226             break;
7227             }
7228           vp = NULL;
7229           }
7230         /*FALLTHROUGH*/
7231 #endif
7232       default:
7233         sub = expand_string_internal(s+1,
7234                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
7235         if (!sub) goto EXPAND_FAILED;
7236         s++;
7237         break;
7238       }
7239
7240     /* If we are skipping, we don't need to perform the operation at all.
7241     This matters for operations like "mask", because the data may not be
7242     in the correct format when skipping. For example, the expression may test
7243     for the existence of $sender_host_address before trying to mask it. For
7244     other operations, doing them may not fail, but it is a waste of time. */
7245
7246     if (flags & ESI_SKIPPING && c >= 0) continue;
7247
7248     /* Otherwise, switch on the operator type.  After handling go back
7249     to the main loop top. */
7250
7251      {
7252      unsigned expansion_start = gstring_length(yield);
7253      switch(c)
7254       {
7255       case EOP_BASE32:
7256         {
7257         uschar * t;
7258         unsigned long int n = Ustrtoul(sub, &t, 10);
7259         gstring * g = NULL;
7260
7261         if (*t)
7262           {
7263           expand_string_message = string_sprintf("argument for base32 "
7264             "operator is \"%s\", which is not a decimal number", sub);
7265           goto EXPAND_FAILED;
7266           }
7267         for ( ; n; n >>= 5)
7268           g = string_catn(g, &base32_chars[n & 0x1f], 1);
7269
7270         if (g) while (g->ptr > 0) yield = string_catn(yield, &g->s[--g->ptr], 1);
7271         break;
7272         }
7273
7274       case EOP_BASE32D:
7275         {
7276         uschar *tt = sub;
7277         unsigned long int n = 0;
7278         while (*tt)
7279           {
7280           uschar * t = Ustrchr(base32_chars, *tt++);
7281           if (!t)
7282             {
7283             expand_string_message = string_sprintf("argument for base32d "
7284               "operator is \"%s\", which is not a base 32 number", sub);
7285             goto EXPAND_FAILED;
7286             }
7287           n = n * 32 + (t - base32_chars);
7288           }
7289         yield = string_fmt_append(yield, "%ld", n);
7290         break;
7291         }
7292
7293       case EOP_BASE62:
7294         {
7295         uschar *t;
7296         unsigned long int n = Ustrtoul(sub, &t, 10);
7297         if (*t)
7298           {
7299           expand_string_message = string_sprintf("argument for base62 "
7300             "operator is \"%s\", which is not a decimal number", sub);
7301           goto EXPAND_FAILED;
7302           }
7303         yield = string_cat(yield, string_base62_32(n));         /*XXX only handles 32b input range.  Need variants? */
7304         break;
7305         }
7306
7307       /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
7308
7309       case EOP_BASE62D:
7310         {
7311         uschar *tt = sub;
7312         unsigned long int n = 0;
7313         while (*tt)
7314           {
7315           uschar *t = Ustrchr(base62_chars, *tt++);
7316           if (!t)
7317             {
7318             expand_string_message = string_sprintf("argument for base62d "
7319               "operator is \"%s\", which is not a base %d number", sub,
7320               BASE_62);
7321             goto EXPAND_FAILED;
7322             }
7323           n = n * BASE_62 + (t - base62_chars);
7324           }
7325         yield = string_fmt_append(yield, "%ld", n);
7326         break;
7327         }
7328
7329       case EOP_EXPAND:
7330         {
7331         uschar *expanded = expand_string_internal(sub,
7332                 ESI_HONOR_DOLLAR | flags & ESI_SKIPPING, NULL, &resetok, NULL);
7333         if (!expanded)
7334           {
7335           expand_string_message =
7336             string_sprintf("internal expansion of \"%s\" failed: %s", sub,
7337               expand_string_message);
7338           goto EXPAND_FAILED;
7339           }
7340         yield = string_cat(yield, expanded);
7341         break;
7342         }
7343
7344       case EOP_LC:
7345         {
7346         uschar * t = sub - 1;
7347         while (*++t) *t = tolower(*t);
7348         yield = string_catn(yield, sub, t-sub);
7349         break;
7350         }
7351
7352       case EOP_UC:
7353         {
7354         uschar * t = sub - 1;
7355         while (*++t) *t = toupper(*t);
7356         yield = string_catn(yield, sub, t-sub);
7357         break;
7358         }
7359
7360       case EOP_MD5:
7361 #ifndef DISABLE_TLS
7362         if (vp && *(void **)vp->value)
7363           {
7364           uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
7365           yield = string_cat(yield, cp);
7366           }
7367         else
7368 #endif
7369           {
7370           md5 base;
7371           uschar digest[16];
7372           md5_start(&base);
7373           md5_end(&base, sub, Ustrlen(sub), digest);
7374           for (int j = 0; j < 16; j++)
7375             yield = string_fmt_append(yield, "%02x", digest[j]);
7376           }
7377         break;
7378
7379       case EOP_SHA1:
7380 #ifndef DISABLE_TLS
7381         if (vp && *(void **)vp->value)
7382           {
7383           uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
7384           yield = string_cat(yield, cp);
7385           }
7386         else
7387 #endif
7388           {
7389           hctx h;
7390           uschar digest[20];
7391           sha1_start(&h);
7392           sha1_end(&h, sub, Ustrlen(sub), digest);
7393           for (int j = 0; j < 20; j++)
7394             yield = string_fmt_append(yield, "%02X", digest[j]);
7395           }
7396         break;
7397
7398       case EOP_SHA2:
7399       case EOP_SHA256:
7400 #ifdef EXIM_HAVE_SHA2
7401         if (vp && *(void **)vp->value)
7402           if (c == EOP_SHA256)
7403             yield = string_cat(yield, tls_cert_fprt_sha256(*(void **)vp->value));
7404           else
7405             expand_string_message = US"sha2_N not supported with certificates";
7406         else
7407           {
7408           hctx h;
7409           blob b;
7410           hashmethod m = !arg ? HASH_SHA2_256
7411             : Ustrcmp(arg, "256") == 0 ? HASH_SHA2_256
7412             : Ustrcmp(arg, "384") == 0 ? HASH_SHA2_384
7413             : Ustrcmp(arg, "512") == 0 ? HASH_SHA2_512
7414             : HASH_BADTYPE;
7415
7416           if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7417             {
7418             expand_string_message = US"unrecognised sha2 variant";
7419             goto EXPAND_FAILED;
7420             }
7421
7422           exim_sha_update_string(&h, sub);
7423           exim_sha_finish(&h, &b);
7424           while (b.len-- > 0)
7425             yield = string_fmt_append(yield, "%02X", *b.data++);
7426           }
7427 #else
7428           expand_string_message = US"sha256 only supported with TLS";
7429 #endif
7430         break;
7431
7432       case EOP_SHA3:
7433 #ifdef EXIM_HAVE_SHA3
7434         {
7435         hctx h;
7436         blob b;
7437         hashmethod m = !arg ? HASH_SHA3_256
7438           : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224
7439           : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256
7440           : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384
7441           : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512
7442           : HASH_BADTYPE;
7443
7444         if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7445           {
7446           expand_string_message = US"unrecognised sha3 variant";
7447           goto EXPAND_FAILED;
7448           }
7449
7450         exim_sha_update_string(&h, sub);
7451         exim_sha_finish(&h, &b);
7452         while (b.len-- > 0)
7453           yield = string_fmt_append(yield, "%02X", *b.data++);
7454         }
7455         break;
7456 #else
7457         expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 + or OpenSSL 1.1.1 +";
7458         goto EXPAND_FAILED;
7459 #endif
7460
7461       /* Line-wrap a string as if it is a header line */
7462
7463       case EOP_HEADERWRAP:
7464         {
7465         unsigned col = 80, lim = 998;
7466         uschar * s;
7467
7468         if (arg)
7469           {
7470           const uschar * list = arg;
7471           int sep = '_';
7472           if ((s = string_nextinlist(&list, &sep, NULL, 0)))
7473             {
7474             col = atoi(CS s);
7475             if ((s = string_nextinlist(&list, &sep, NULL, 0)))
7476               lim = atoi(CS s);
7477             }
7478           }
7479           if ((s =  wrap_header(sub, col, lim, US"\t", 8)))
7480             yield = string_cat(yield, s);
7481         }
7482         break;
7483
7484       /* Convert hex encoding to base64 encoding */
7485
7486       case EOP_HEX2B64:
7487         {
7488         int c = 0;
7489         int b = -1;
7490         uschar *in = sub;
7491         uschar *out = sub;
7492         uschar *enc;
7493
7494         for (enc = sub; *enc; enc++)
7495           {
7496           if (!isxdigit(*enc))
7497             {
7498             expand_string_message = string_sprintf("\"%s\" is not a hex "
7499               "string", sub);
7500             goto EXPAND_FAILED;
7501             }
7502           c++;
7503           }
7504
7505         if ((c & 1) != 0)
7506           {
7507           expand_string_message = string_sprintf("\"%s\" contains an odd "
7508             "number of characters", sub);
7509           goto EXPAND_FAILED;
7510           }
7511
7512         while ((c = *in++) != 0)
7513           {
7514           if (isdigit(c)) c -= '0';
7515           else c = toupper(c) - 'A' + 10;
7516           if (b == -1)
7517             b = c << 4;
7518           else
7519             {
7520             *out++ = b | c;
7521             b = -1;
7522             }
7523           }
7524
7525         enc = b64encode(CUS sub, out - sub);
7526         yield = string_cat(yield, enc);
7527         break;
7528         }
7529
7530       /* Convert octets outside 0x21..0x7E to \xXX form */
7531
7532       case EOP_HEXQUOTE:
7533         {
7534         uschar *t = sub - 1;
7535         while (*(++t) != 0)
7536           {
7537           if (*t < 0x21 || 0x7E < *t)
7538             yield = string_fmt_append(yield, "\\x%02x", *t);
7539           else
7540             yield = string_catn(yield, t, 1);
7541           }
7542         break;
7543         }
7544
7545       /* count the number of list elements */
7546
7547       case EOP_LISTCOUNT:
7548         {
7549         int cnt = 0, sep = 0;
7550         uschar * buf = store_get(2, sub);
7551
7552         while (string_nextinlist(CUSS &sub, &sep, buf, 1)) cnt++;
7553         yield = string_fmt_append(yield, "%d", cnt);
7554         break;
7555         }
7556
7557       /* expand a named list given the name */
7558       /* handles nested named lists; requotes as colon-sep list */
7559
7560       case EOP_LISTNAMED:
7561         expand_string_message = NULL;
7562         yield = expand_listnamed(yield, sub, arg);
7563         if (expand_string_message)
7564           goto EXPAND_FAILED;
7565         break;
7566
7567       /* quote a list-item for the given list-separator */
7568
7569       /* mask applies a mask to an IP address; for example the result of
7570       ${mask:131.111.10.206/28} is 131.111.10.192/28. */
7571
7572       case EOP_MASK:
7573         {
7574         int count;
7575         uschar *endptr;
7576         int binary[4];
7577         int type, mask, maskoffset;
7578         BOOL normalised;
7579         uschar buffer[64];
7580
7581         if ((type = string_is_ip_address(sub, &maskoffset)) == 0)
7582           {
7583           expand_string_message = string_sprintf("\"%s\" is not an IP address",
7584            sub);
7585           goto EXPAND_FAILED;
7586           }
7587
7588         if (maskoffset == 0)
7589           {
7590           expand_string_message = string_sprintf("missing mask value in \"%s\"",
7591             sub);
7592           goto EXPAND_FAILED;
7593           }
7594
7595         mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
7596
7597         if (*endptr || mask < 0 || mask > (type == 4 ? 32 : 128))
7598           {
7599           expand_string_message = string_sprintf("mask value too big in \"%s\"",
7600             sub);
7601           goto EXPAND_FAILED;
7602           }
7603
7604         /* If an optional 'n' was given, ipv6 gets normalised output:
7605         colons rather than dots, and zero-compressed. */
7606
7607         normalised = arg && *arg == 'n';
7608
7609         /* Convert the address to binary integer(s) and apply the mask */
7610
7611         sub[maskoffset] = 0;
7612         count = host_aton(sub, binary);
7613         host_mask(count, binary, mask);
7614
7615         /* Convert to masked textual format and add to output. */
7616
7617         if (type == 4 || !normalised)
7618           yield = string_catn(yield, buffer,
7619             host_nmtoa(count, binary, mask, buffer, '.'));
7620         else
7621           {
7622           ipv6_nmtoa(binary, buffer);
7623           yield = string_fmt_append(yield, "%s/%d", buffer, mask);
7624           }
7625         break;
7626         }
7627
7628       case EOP_IPV6NORM:
7629       case EOP_IPV6DENORM:
7630         {
7631         int type = string_is_ip_address(sub, NULL);
7632         int binary[4];
7633         uschar buffer[44];
7634
7635         switch (type)
7636           {
7637           case 6:
7638             (void) host_aton(sub, binary);
7639             break;
7640
7641           case 4:       /* convert to IPv4-mapped IPv6 */
7642             binary[0] = binary[1] = 0;
7643             binary[2] = 0x0000ffff;
7644             (void) host_aton(sub, binary+3);
7645             break;
7646
7647           case 0:
7648             expand_string_message =
7649               string_sprintf("\"%s\" is not an IP address", sub);
7650             goto EXPAND_FAILED;
7651           }
7652
7653         yield = string_catn(yield, buffer, c == EOP_IPV6NORM
7654                     ? ipv6_nmtoa(binary, buffer)
7655                     : host_nmtoa(4, binary, -1, buffer, ':')
7656                   );
7657         break;
7658         }
7659
7660       case EOP_ADDRESS:
7661       case EOP_LOCAL_PART:
7662       case EOP_DOMAIN:
7663         {
7664         uschar * error;
7665         int start, end, domain;
7666         uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,
7667           FALSE);
7668         if (t)
7669           if (c != EOP_DOMAIN)
7670             yield = c == EOP_LOCAL_PART && domain > 0
7671               ? string_catn(yield, t, domain - 1)
7672               : string_cat(yield, t);
7673           else if (domain > 0)
7674             yield = string_cat(yield, t + domain);
7675         break;
7676         }
7677
7678       case EOP_ADDRESSES:
7679         {
7680         uschar outsep[2] = { ':', '\0' };
7681         uschar *address, *error;
7682         int save_ptr = gstring_length(yield);
7683         int start, end, domain;  /* Not really used */
7684
7685         if (Uskip_whitespace(&sub) == '>')
7686           if (*outsep = *++sub) ++sub;
7687           else
7688             {
7689             expand_string_message = string_sprintf("output separator "
7690               "missing in expanding ${addresses:%s}", --sub);
7691             goto EXPAND_FAILED;
7692             }
7693         f.parse_allow_group = TRUE;
7694
7695         for (;;)
7696           {
7697           uschar * p = parse_find_address_end(sub, FALSE);
7698           uschar saveend = *p;
7699           *p = '\0';
7700           address = parse_extract_address(sub, &error, &start, &end, &domain,
7701             FALSE);
7702           *p = saveend;
7703
7704           /* Add the address to the output list that we are building. This is
7705           done in chunks by searching for the separator character. At the
7706           start, unless we are dealing with the first address of the output
7707           list, add in a space if the new address begins with the separator
7708           character, or is an empty string. */
7709
7710           if (address)
7711             {
7712             if (yield && yield->ptr != save_ptr && address[0] == *outsep)
7713               yield = string_catn(yield, US" ", 1);
7714
7715             for (;;)
7716               {
7717               size_t seglen = Ustrcspn(address, outsep);
7718               yield = string_catn(yield, address, seglen + 1);
7719
7720               /* If we got to the end of the string we output one character
7721               too many. */
7722
7723               if (address[seglen] == '\0') { yield->ptr--; break; }
7724               yield = string_catn(yield, outsep, 1);
7725               address += seglen + 1;
7726               }
7727
7728             /* Output a separator after the string: we will remove the
7729             redundant final one at the end. */
7730
7731             yield = string_catn(yield, outsep, 1);
7732             }
7733
7734           if (saveend == '\0') break;
7735           sub = p + 1;
7736           }
7737
7738         /* If we have generated anything, remove the redundant final
7739         separator. */
7740
7741         if (yield && yield->ptr != save_ptr) yield->ptr--;
7742         f.parse_allow_group = FALSE;
7743         break;
7744         }
7745
7746
7747       /* quote puts a string in quotes if it is empty or contains anything
7748       other than alphamerics, underscore, dot, or hyphen.
7749
7750       quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
7751       be quoted in order to be a valid local part.
7752
7753       In both cases, newlines and carriage returns are converted into \n and \r
7754       respectively */
7755
7756       case EOP_QUOTE:
7757       case EOP_QUOTE_LOCAL_PART:
7758         if (!arg)
7759           {
7760           BOOL needs_quote = (!*sub);      /* TRUE for empty string */
7761           uschar *t = sub - 1;
7762
7763           if (c == EOP_QUOTE)
7764             while (!needs_quote && *++t)
7765               needs_quote = !isalnum(*t) && !strchr("_-.", *t);
7766
7767           else  /* EOP_QUOTE_LOCAL_PART */
7768             while (!needs_quote && *++t)
7769               needs_quote = !isalnum(*t)
7770                 && strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL
7771                 && (*t != '.' || t == sub || !t[1]);
7772
7773           if (needs_quote)
7774             {
7775             yield = string_catn(yield, US"\"", 1);
7776             t = sub - 1;
7777             while (*++t)
7778               if (*t == '\n')
7779                 yield = string_catn(yield, US"\\n", 2);
7780               else if (*t == '\r')
7781                 yield = string_catn(yield, US"\\r", 2);
7782               else
7783                 {
7784                 if (*t == '\\' || *t == '"')
7785                   yield = string_catn(yield, US"\\", 1);
7786                 yield = string_catn(yield, t, 1);
7787                 }
7788             yield = string_catn(yield, US"\"", 1);
7789             }
7790           else
7791             yield = string_cat(yield, sub);
7792           }
7793
7794         /* quote_lookuptype does lookup-specific quoting */
7795
7796         else
7797           {
7798           int n;
7799           uschar * opt = Ustrchr(arg, '_');
7800
7801           if (opt) *opt++ = 0;
7802
7803           if ((n = search_findtype(arg, Ustrlen(arg))) < 0)
7804             {
7805             expand_string_message = search_error_message;
7806             goto EXPAND_FAILED;
7807             }
7808
7809           if (lookup_list[n]->quote)
7810             sub = (lookup_list[n]->quote)(sub, opt, (unsigned)n);
7811           else if (opt)
7812             sub = NULL;
7813
7814           if (!sub)
7815             {
7816             expand_string_message = string_sprintf(
7817               "\"%s\" unrecognized after \"${quote_%s\"",       /*}*/
7818               opt, arg);
7819             goto EXPAND_FAILED;
7820             }
7821
7822           yield = string_cat(yield, sub);
7823           }
7824         break;
7825
7826       /* rx quote sticks in \ before any non-alphameric character so that
7827       the insertion works in a regular expression. */
7828
7829       case EOP_RXQUOTE:
7830         {
7831         uschar *t = sub - 1;
7832         while (*(++t) != 0)
7833           {
7834           if (!isalnum(*t))
7835             yield = string_catn(yield, US"\\", 1);
7836           yield = string_catn(yield, t, 1);
7837           }
7838         break;
7839         }
7840
7841       /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
7842       prescribed by the RFC, if there are characters that need to be encoded */
7843
7844       case EOP_RFC2047:
7845         yield = string_cat(yield,
7846                             parse_quote_2047(sub, Ustrlen(sub), headers_charset,
7847                               FALSE));
7848         break;
7849
7850       /* RFC 2047 decode */
7851
7852       case EOP_RFC2047D:
7853         {
7854         int len;
7855         uschar *error;
7856         uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
7857           headers_charset, '?', &len, &error);
7858         if (error)
7859           {
7860           expand_string_message = error;
7861           goto EXPAND_FAILED;
7862           }
7863         yield = string_catn(yield, decoded, len);
7864         break;
7865         }
7866
7867       /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
7868       underscores */
7869
7870       case EOP_FROM_UTF8:
7871         {
7872         uschar * buff = store_get(4, sub);
7873         while (*sub)
7874           {
7875           int c;
7876           GETUTF8INC(c, sub);
7877           if (c > 255) c = '_';
7878           buff[0] = c;
7879           yield = string_catn(yield, buff, 1);
7880           }
7881         break;
7882         }
7883
7884       /* replace illegal UTF-8 sequences by replacement character  */
7885
7886       #define UTF8_REPLACEMENT_CHAR US"?"
7887
7888       case EOP_UTF8CLEAN:
7889         {
7890         int seq_len = 0, index = 0, bytes_left = 0, complete;
7891         u_long codepoint = (u_long)-1;
7892         uschar seq_buff[4];                     /* accumulate utf-8 here */
7893
7894         /* Manually track tainting, as we deal in individual chars below */
7895
7896         if (!yield)
7897           yield = string_get_tainted(Ustrlen(sub), sub);
7898         else if (!yield->s || !yield->ptr)
7899           {
7900           yield->s = store_get(yield->size = Ustrlen(sub), sub);
7901           gstring_reset(yield);
7902           }
7903         else if (is_incompatible(yield->s, sub))
7904           gstring_rebuffer(yield, sub);
7905
7906         /* Check the UTF-8, byte-by-byte */
7907
7908         while (*sub)
7909           {
7910           complete = 0;
7911           uschar c = *sub++;
7912
7913           if (bytes_left)
7914             {
7915             if ((c & 0xc0) != 0x80)
7916                     /* wrong continuation byte; invalidate all bytes */
7917               complete = 1; /* error */
7918             else
7919               {
7920               codepoint = (codepoint << 6) | (c & 0x3f);
7921               seq_buff[index++] = c;
7922               if (--bytes_left == 0)            /* codepoint complete */
7923                 if(codepoint > 0x10FFFF)        /* is it too large? */
7924                   complete = -1;        /* error (RFC3629 limit) */
7925                 else if ( (codepoint & 0x1FF800 ) == 0xD800 ) /* surrogate */
7926                   /* A UTF-16 surrogate (which should be one of a pair that
7927                   encode a Unicode codepoint that is outside the Basic
7928                   Multilingual Plane).  Error, not UTF8.
7929                   RFC2279.2 is slightly unclear on this, but
7930                   https://unicodebook.readthedocs.io/issues.html#strict-utf8-decoder
7931                   says "Surrogates characters are also invalid in UTF-8:
7932                   characters in U+D800—U+DFFF have to be rejected." */
7933                   complete = -1;
7934                 else
7935                   {             /* finished; output utf-8 sequence */
7936                   yield = string_catn(yield, seq_buff, seq_len);
7937                   index = 0;
7938                   }
7939               }
7940             }
7941           else  /* no bytes left: new sequence */
7942             {
7943             if (!(c & 0x80))    /* 1-byte sequence, US-ASCII, keep it */
7944               {
7945               yield = string_catn(yield, &c, 1);
7946               continue;
7947               }
7948             if ((c & 0xe0) == 0xc0)             /* 2-byte sequence */
7949               if (c == 0xc0 || c == 0xc1)       /* 0xc0 and 0xc1 are illegal */
7950                 complete = -1;
7951               else
7952                 {
7953                 bytes_left = 1;
7954                 codepoint = c & 0x1f;
7955                 }
7956             else if ((c & 0xf0) == 0xe0)                /* 3-byte sequence */
7957               {
7958               bytes_left = 2;
7959               codepoint = c & 0x0f;
7960               }
7961             else if ((c & 0xf8) == 0xf0)                /* 4-byte sequence */
7962               {
7963               bytes_left = 3;
7964               codepoint = c & 0x07;
7965               }
7966             else        /* invalid or too long (RFC3629 allows only 4 bytes) */
7967               complete = -1;
7968
7969             seq_buff[index++] = c;
7970             seq_len = bytes_left + 1;
7971             }           /* if(bytes_left) */
7972
7973           if (complete != 0)
7974             {
7975             bytes_left = index = 0;
7976             yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7977             }
7978           if ((complete == 1) && ((c & 0x80) == 0))
7979                         /* ASCII character follows incomplete sequence */
7980               yield = string_catn(yield, &c, 1);
7981           }
7982         /* If given a sequence truncated mid-character, we also want to report ?
7983         Eg, ${length_1:フィル} is one byte, not one character, so we expect
7984         ${utf8clean:${length_1:フィル}} to yield '?' */
7985
7986         if (bytes_left != 0)
7987           yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7988
7989         break;
7990         }
7991
7992 #ifdef SUPPORT_I18N
7993       case EOP_UTF8_DOMAIN_TO_ALABEL:
7994         {
7995         uschar * error = NULL;
7996         uschar * s = string_domain_utf8_to_alabel(sub, &error);
7997         if (error)
7998           {
7999           expand_string_message = string_sprintf(
8000             "error converting utf8 (%s) to alabel: %s",
8001             string_printing(sub), error);
8002           goto EXPAND_FAILED;
8003           }
8004         yield = string_cat(yield, s);
8005         break;
8006         }
8007
8008       case EOP_UTF8_DOMAIN_FROM_ALABEL:
8009         {
8010         uschar * error = NULL;
8011         uschar * s = string_domain_alabel_to_utf8(sub, &error);
8012         if (error)
8013           {
8014           expand_string_message = string_sprintf(
8015             "error converting alabel (%s) to utf8: %s",
8016             string_printing(sub), error);
8017           goto EXPAND_FAILED;
8018           }
8019         yield = string_cat(yield, s);
8020         break;
8021         }
8022
8023       case EOP_UTF8_LOCALPART_TO_ALABEL:
8024         {
8025         uschar * error = NULL;
8026         uschar * s = string_localpart_utf8_to_alabel(sub, &error);
8027         if (error)
8028           {
8029           expand_string_message = string_sprintf(
8030             "error converting utf8 (%s) to alabel: %s",
8031             string_printing(sub), error);
8032           goto EXPAND_FAILED;
8033           }
8034         yield = string_cat(yield, s);
8035         DEBUG(D_expand) debug_printf_indent("yield: '%Y'\n", yield);
8036         break;
8037         }
8038
8039       case EOP_UTF8_LOCALPART_FROM_ALABEL:
8040         {
8041         uschar * error = NULL;
8042         uschar * s = string_localpart_alabel_to_utf8(sub, &error);
8043         if (error)
8044           {
8045           expand_string_message = string_sprintf(
8046             "error converting alabel (%s) to utf8: %s",
8047             string_printing(sub), error);
8048           goto EXPAND_FAILED;
8049           }
8050         yield = string_cat(yield, s);
8051         break;
8052         }
8053 #endif  /* EXPERIMENTAL_INTERNATIONAL */
8054
8055       /* escape turns all non-printing characters into escape sequences. */
8056
8057       case EOP_ESCAPE:
8058         {
8059         const uschar * t = string_printing(sub);
8060         yield = string_cat(yield, t);
8061         break;
8062         }
8063
8064       case EOP_ESCAPE8BIT:
8065         {
8066         uschar c;
8067
8068         for (const uschar * s = sub; (c = *s); s++)
8069           yield = c < 127 && c != '\\'
8070             ? string_catn(yield, s, 1)
8071             : string_fmt_append(yield, "\\%03o", c);
8072         break;
8073         }
8074
8075       /* Handle numeric expression evaluation */
8076
8077       case EOP_EVAL:
8078       case EOP_EVAL10:
8079         {
8080         uschar *save_sub = sub;
8081         uschar *error = NULL;
8082         int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
8083         if (error)
8084           {
8085           expand_string_message = string_sprintf("error in expression "
8086             "evaluation: %s (after processing \"%.*s\")", error,
8087             (int)(sub-save_sub), save_sub);
8088           goto EXPAND_FAILED;
8089           }
8090         yield = string_fmt_append(yield, PR_EXIM_ARITH, n);
8091         break;
8092         }
8093
8094       /* Handle time period formatting */
8095
8096       case EOP_TIME_EVAL:
8097         {
8098         int n = readconf_readtime(sub, 0, FALSE);
8099         if (n < 0)
8100           {
8101           expand_string_message = string_sprintf("string \"%s\" is not an "
8102             "Exim time interval in \"%s\" operator", sub, name);
8103           goto EXPAND_FAILED;
8104           }
8105         yield = string_fmt_append(yield, "%d", n);
8106         break;
8107         }
8108
8109       case EOP_TIME_INTERVAL:
8110         {
8111         int n;
8112         uschar *t = read_number(&n, sub);
8113         if (*t != 0) /* Not A Number*/
8114           {
8115           expand_string_message = string_sprintf("string \"%s\" is not a "
8116             "positive number in \"%s\" operator", sub, name);
8117           goto EXPAND_FAILED;
8118           }
8119         t = readconf_printtime(n);
8120         yield = string_cat(yield, t);
8121         break;
8122         }
8123
8124       /* Convert string to base64 encoding */
8125
8126       case EOP_STR2B64:
8127       case EOP_BASE64:
8128         {
8129 #ifndef DISABLE_TLS
8130         uschar * s = vp && *(void **)vp->value
8131           ? tls_cert_der_b64(*(void **)vp->value)
8132           : b64encode(CUS sub, Ustrlen(sub));
8133 #else
8134         uschar * s = b64encode(CUS sub, Ustrlen(sub));
8135 #endif
8136         yield = string_cat(yield, s);
8137         break;
8138         }
8139
8140       case EOP_BASE64D:
8141         {
8142         uschar * s;
8143         int len = b64decode(sub, &s, sub);
8144         if (len < 0)
8145           {
8146           expand_string_message = string_sprintf("string \"%s\" is not "
8147             "well-formed for \"%s\" operator", sub, name);
8148           goto EXPAND_FAILED;
8149           }
8150         yield = string_cat(yield, s);
8151         break;
8152         }
8153
8154       /* strlen returns the length of the string */
8155
8156       case EOP_STRLEN:
8157         yield = string_fmt_append(yield, "%d", Ustrlen(sub));
8158         break;
8159
8160       /* length_n or l_n takes just the first n characters or the whole string,
8161       whichever is the shorter;
8162
8163       substr_m_n, and s_m_n take n characters from offset m; negative m take
8164       from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
8165       takes the rest, either to the right or to the left.
8166
8167       hash_n or h_n makes a hash of length n from the string, yielding n
8168       characters from the set a-z; hash_n_m makes a hash of length n, but
8169       uses m characters from the set a-zA-Z0-9.
8170
8171       nhash_n returns a single number between 0 and n-1 (in text form), while
8172       nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
8173       between 0 and n-1 and the second between 0 and m-1. */
8174
8175       case EOP_LENGTH:
8176       case EOP_L:
8177       case EOP_SUBSTR:
8178       case EOP_S:
8179       case EOP_HASH:
8180       case EOP_H:
8181       case EOP_NHASH:
8182       case EOP_NH:
8183         {
8184         int sign = 1;
8185         int value1 = 0;
8186         int value2 = -1;
8187         int *pn;
8188         int len;
8189         uschar *ret;
8190
8191         if (!arg)
8192           {
8193           expand_string_message = string_sprintf("missing values after %s",
8194             name);
8195           goto EXPAND_FAILED;
8196           }
8197
8198         /* "length" has only one argument, effectively being synonymous with
8199         substr_0_n. */
8200
8201         if (c == EOP_LENGTH || c == EOP_L)
8202           {
8203           pn = &value2;
8204           value2 = 0;
8205           }
8206
8207         /* The others have one or two arguments; for "substr" the first may be
8208         negative. The second being negative means "not supplied". */
8209
8210         else
8211           {
8212           pn = &value1;
8213           if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
8214           }
8215
8216         /* Read up to two numbers, separated by underscores */
8217
8218         ret = arg;
8219         while (*arg != 0)
8220           {
8221           if (arg != ret && *arg == '_' && pn == &value1)
8222             {
8223             pn = &value2;
8224             value2 = 0;
8225             if (arg[1] != 0) arg++;
8226             }
8227           else if (!isdigit(*arg))
8228             {
8229             expand_string_message =
8230               string_sprintf("non-digit after underscore in \"%s\"", name);
8231             goto EXPAND_FAILED;
8232             }
8233           else *pn = (*pn)*10 + *arg++ - '0';
8234           }
8235         value1 *= sign;
8236
8237         /* Perform the required operation */
8238
8239         ret = c == EOP_HASH || c == EOP_H
8240           ? compute_hash(sub, value1, value2, &len)
8241           : c == EOP_NHASH || c == EOP_NH
8242           ? compute_nhash(sub, value1, value2, &len)
8243           : extract_substr(sub, value1, value2, &len);
8244         if (!ret) goto EXPAND_FAILED;
8245
8246         yield = string_catn(yield, ret, len);
8247         break;
8248         }
8249
8250       /* Stat a path */
8251
8252       case EOP_STAT:
8253         {
8254         uschar smode[12];
8255         uschar **modetable[3];
8256         mode_t mode;
8257         struct stat st;
8258
8259         if (expand_forbid & RDO_EXISTS)
8260           {
8261           expand_string_message = US"Use of the stat() expansion is not permitted";
8262           goto EXPAND_FAILED;
8263           }
8264
8265         if (stat(CS sub, &st) < 0)
8266           {
8267           expand_string_message = string_sprintf("stat(%s) failed: %s",
8268             sub, strerror(errno));
8269           goto EXPAND_FAILED;
8270           }
8271         mode = st.st_mode;
8272         switch (mode & S_IFMT)
8273           {
8274           case S_IFIFO: smode[0] = 'p'; break;
8275           case S_IFCHR: smode[0] = 'c'; break;
8276           case S_IFDIR: smode[0] = 'd'; break;
8277           case S_IFBLK: smode[0] = 'b'; break;
8278           case S_IFREG: smode[0] = '-'; break;
8279           default: smode[0] = '?'; break;
8280           }
8281
8282         modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
8283         modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
8284         modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
8285
8286         for (int i = 0; i < 3; i++)
8287           {
8288           memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
8289           mode >>= 3;
8290           }
8291
8292         smode[10] = 0;
8293         yield = string_fmt_append(yield,
8294           "mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
8295           "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
8296           (long)(st.st_mode & 077777), smode, (long)st.st_ino,
8297           (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
8298           (long)st.st_gid, st.st_size, (long)st.st_atime,
8299           (long)st.st_mtime, (long)st.st_ctime);
8300         break;
8301         }
8302
8303       /* vaguely random number less than N */
8304
8305       case EOP_RANDINT:
8306         {
8307         int_eximarith_t max = expanded_string_integer(sub, TRUE);
8308
8309         if (expand_string_message)
8310           goto EXPAND_FAILED;
8311         yield = string_fmt_append(yield, "%d", vaguely_random_number((int)max));
8312         break;
8313         }
8314
8315       /* Reverse IP, including IPv6 to dotted-nibble */
8316
8317       case EOP_REVERSE_IP:
8318         {
8319         int family, maskptr;
8320         uschar reversed[128];
8321
8322         family = string_is_ip_address(sub, &maskptr);
8323         if (family == 0)
8324           {
8325           expand_string_message = string_sprintf(
8326               "reverse_ip() not given an IP address [%s]", sub);
8327           goto EXPAND_FAILED;
8328           }
8329         invert_address(reversed, sub);
8330         yield = string_cat(yield, reversed);
8331         break;
8332         }
8333
8334       case EOP_XTEXTD:
8335         {
8336         uschar * s;
8337         int len = xtextdecode(sub, &s);
8338         yield = string_catn(yield, s, len);
8339         break;
8340         }
8341
8342       /* Unknown operator */
8343       default:
8344         expand_string_message =
8345           string_sprintf("unknown expansion operator \"%s\"", name);
8346         goto EXPAND_FAILED;
8347       } /* EOP_* switch */
8348
8349       DEBUG(D_expand)
8350         {
8351         const uschar * res = string_from_gstring(yield);
8352         const uschar * s = res + expansion_start;
8353         int i = gstring_length(yield) - expansion_start;
8354         BOOL tainted = is_tainted(s);
8355
8356         debug_printf_indent("%Vop-res: %.*s\n", "K-----", i, s);
8357         if (tainted)
8358           {
8359           debug_printf_indent("%V          %V",
8360             flags & ESI_SKIPPING ? "|" : " ",
8361             "\\__");
8362           debug_print_taint(res);
8363           }
8364         }
8365        continue;
8366        }
8367     }
8368
8369   /* Not an item or an operator */
8370   /* Handle a plain name. If this is the first thing in the expansion, release
8371   the pre-allocated buffer. If the result data is known to be in a new buffer,
8372   newsize will be set to the size of that buffer, and we can just point at that
8373   store instead of copying. Many expansion strings contain just one reference,
8374   so this is a useful optimization, especially for humungous headers
8375   ($message_headers). */
8376                                                 /*{*/
8377   if (*s++ == '}')
8378     {
8379     const uschar * value;
8380     int len;
8381     int newsize = 0;
8382     gstring * g = NULL;
8383
8384     if (!yield)
8385       g = store_get(sizeof(gstring), GET_UNTAINTED);
8386     else if (yield->ptr == 0)
8387       {
8388       if (resetok) reset_point = store_reset(reset_point);
8389       yield = NULL;
8390       reset_point = store_mark();
8391       g = store_get(sizeof(gstring), GET_UNTAINTED);    /* alloc _before_ calling find_variable() */
8392       }
8393     if (!(value = find_variable(name, flags, &newsize)))
8394       {
8395       expand_string_message =
8396         string_sprintf("unknown variable in \"${%s}\"", name);
8397       check_variable_error_message(name);
8398       goto EXPAND_FAILED;
8399       }
8400     len = Ustrlen(value);
8401     if (!yield && newsize)
8402       {
8403       yield = g;
8404       yield->size = newsize;
8405       yield->ptr = len;
8406       yield->s = US value; /* known to be in new store i.e. a copy, so deconst safe */
8407       }
8408     else
8409       yield = string_catn(yield, value, len);
8410     continue;
8411     }
8412
8413   /* Else there's something wrong */
8414
8415   expand_string_message =
8416     string_sprintf("\"${%s\" is not a known operator (or a } is missing "
8417     "in a variable reference)", name);
8418   goto EXPAND_FAILED;
8419   }
8420
8421 /* If we hit the end of the string when brace_ends is set, there is a missing
8422 terminating brace. */
8423
8424 if (flags & ESI_BRACE_ENDS && !*s)
8425   {                                                     /*{{*/
8426   expand_string_message = malformed_header
8427     ? US"missing } at end of string - could be header name not terminated by colon"
8428     : US"missing } at end of string";
8429   goto EXPAND_FAILED;
8430   }
8431
8432 /* Expansion succeeded; yield may still be NULL here if nothing was actually
8433 added to the string. If so, set up an empty string. Add a terminating zero. If
8434 left != NULL, return a pointer to the terminator. */
8435
8436  {
8437   uschar * res;
8438
8439   if (!yield)
8440     yield = string_get(1);
8441   res = string_from_gstring(yield);
8442   if (left) *left = s;
8443
8444   /* Any stacking store that was used above the final string is no longer needed.
8445   In many cases the final string will be the first one that was got and so there
8446   will be optimal store usage. */
8447
8448   if (resetok) gstring_release_unused(yield);
8449   else if (resetok_p) *resetok_p = FALSE;
8450
8451   DEBUG(D_expand)
8452     {
8453     BOOL tainted = is_tainted(res);
8454     debug_printf_indent("%Vexpanded: %.*W\n",
8455       "K---",
8456       (int)(s - string), string);
8457     debug_printf_indent("%Vresult: ",
8458       flags & ESI_SKIPPING ? "K-----" : "\\_____");
8459     if (*res || !(flags & ESI_SKIPPING))
8460       debug_printf("%W\n", res);
8461     else
8462       debug_printf(" %Vskipped%V\n", "<", ">");
8463     if (tainted)
8464       {
8465       debug_printf_indent("%V          %V",
8466         flags & ESI_SKIPPING ? "|" : " ",
8467         "\\__"
8468         );
8469       debug_print_taint(res);
8470       }
8471     if (flags & ESI_SKIPPING)
8472       debug_printf_indent("%Vskipping: result is not used\n", "\\___");
8473     }
8474   if (textonly_p) *textonly_p = textonly;
8475   expand_level--;
8476   return res;
8477  }
8478
8479 /* This is the failure exit: easiest to program with a goto. We still need
8480 to update the pointer to the terminator, for cases of nested calls with "fail".
8481 */
8482
8483 EXPAND_FAILED_CURLY:
8484 if (malformed_header)
8485   expand_string_message =
8486     US"missing or misplaced { or } - could be header name not terminated by colon";
8487
8488 else if (!expand_string_message || !*expand_string_message)
8489   expand_string_message = US"missing or misplaced { or }";
8490
8491 /* At one point, Exim reset the store to yield (if yield was not NULL), but
8492 that is a bad idea, because expand_string_message is in dynamic store. */
8493
8494 EXPAND_FAILED:
8495 if (left) *left = s;
8496 DEBUG(D_expand)
8497   {
8498   debug_printf_indent("%Vfailed to expand: %s\n", "K", string);
8499   debug_printf_indent("%Verror message: %s\n",
8500     f.expand_string_forcedfail ? "K---" : "\\___", expand_string_message);
8501   if (f.expand_string_forcedfail)
8502     debug_printf_indent("%Vfailure was forced\n", "\\");
8503   }
8504 if (resetok_p && !resetok) *resetok_p = FALSE;
8505 expand_level--;
8506 return NULL;
8507 }
8508
8509
8510
8511 /* This is the external function call. Do a quick check for any expansion
8512 metacharacters, and if there are none, just return the input string.
8513
8514 Arguments
8515         the string to be expanded
8516         optional pointer for return boolean indicating no-dynamic-expansions
8517
8518 Returns:  the expanded string, or NULL if expansion failed; if failure was
8519           due to a lookup deferring, search_find_defer will be TRUE
8520 */
8521
8522 const uschar *
8523 expand_string_2(const uschar * string, BOOL * textonly_p)
8524 {
8525 f.expand_string_forcedfail = f.search_find_defer = malformed_header = FALSE;
8526 if (Ustrpbrk(string, "$\\") != NULL)
8527   {
8528   int old_pool = store_pool;
8529   uschar * s;
8530
8531   store_pool = POOL_MAIN;
8532     s = expand_string_internal(string, ESI_HONOR_DOLLAR, NULL, NULL, textonly_p);
8533   store_pool = old_pool;
8534   return s;
8535   }
8536 if (textonly_p) *textonly_p = TRUE;
8537 return string;
8538 }
8539
8540 const uschar *
8541 expand_cstring(const uschar * string)
8542 { return expand_string_2(string, NULL); }
8543
8544 uschar *
8545 expand_string(uschar * string)
8546 { return US expand_string_2(CUS string, NULL); }
8547
8548
8549
8550
8551
8552
8553 /*************************************************
8554 *              Expand and copy                   *
8555 *************************************************/
8556
8557 /* Now and again we want to expand a string and be sure that the result is in a
8558 new bit of store. This function does that.
8559 Since we know it has been copied, the de-const cast is safe.
8560
8561 Argument: the string to be expanded
8562 Returns:  the expanded string, always in a new bit of store, or NULL
8563 */
8564
8565 uschar *
8566 expand_string_copy(const uschar *string)
8567 {
8568 const uschar *yield = expand_cstring(string);
8569 if (yield == string) yield = string_copy(string);
8570 return US yield;
8571 }
8572
8573
8574
8575 /*************************************************
8576 *        Expand and interpret as an integer      *
8577 *************************************************/
8578
8579 /* Expand a string, and convert the result into an integer.
8580
8581 Arguments:
8582   string  the string to be expanded
8583   isplus  TRUE if a non-negative number is expected
8584
8585 Returns:  the integer value, or
8586           -1 for an expansion error               ) in both cases, message in
8587           -2 for an integer interpretation error  ) expand_string_message
8588           expand_string_message is set NULL for an OK integer
8589 */
8590
8591 int_eximarith_t
8592 expand_string_integer(uschar *string, BOOL isplus)
8593 {
8594 return expanded_string_integer(expand_string(string), isplus);
8595 }
8596
8597
8598 /*************************************************
8599  *         Interpret string as an integer        *
8600  *************************************************/
8601
8602 /* Convert a string (that has already been expanded) into an integer.
8603
8604 This function is used inside the expansion code.
8605
8606 Arguments:
8607   s       the string to be expanded
8608   isplus  TRUE if a non-negative number is expected
8609
8610 Returns:  the integer value, or
8611           -1 if string is NULL (which implies an expansion error)
8612           -2 for an integer interpretation error
8613           expand_string_message is set NULL for an OK integer
8614 */
8615
8616 static int_eximarith_t
8617 expanded_string_integer(const uschar *s, BOOL isplus)
8618 {
8619 int_eximarith_t value;
8620 uschar *msg = US"invalid integer \"%s\"";
8621 uschar *endptr;
8622
8623 /* If expansion failed, expand_string_message will be set. */
8624
8625 if (!s) return -1;
8626
8627 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
8628 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
8629 systems, so we set it zero ourselves. */
8630
8631 errno = 0;
8632 expand_string_message = NULL;               /* Indicates no error */
8633
8634 /* Before Exim 4.64, strings consisting entirely of whitespace compared
8635 equal to 0.  Unfortunately, people actually relied upon that, so preserve
8636 the behaviour explicitly.  Stripping leading whitespace is a harmless
8637 noop change since strtol skips it anyway (provided that there is a number
8638 to find at all). */
8639 if (isspace(*s))
8640   if (Uskip_whitespace(&s) == '\0')
8641     {
8642       DEBUG(D_expand)
8643        debug_printf_indent("treating blank string as number 0\n");
8644       return 0;
8645     }
8646
8647 value = strtoll(CS s, CSS &endptr, 10);
8648
8649 if (endptr == s)
8650   msg = US"integer expected but \"%s\" found";
8651 else if (value < 0 && isplus)
8652   msg = US"non-negative integer expected but \"%s\" found";
8653 else
8654   {
8655   switch (tolower(*endptr))
8656     {
8657     default:
8658       break;
8659     case 'k':
8660       if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
8661       else value *= 1024;
8662       endptr++;
8663       break;
8664     case 'm':
8665       if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
8666       else value *= 1024*1024;
8667       endptr++;
8668       break;
8669     case 'g':
8670       if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
8671       else value *= 1024*1024*1024;
8672       endptr++;
8673       break;
8674     }
8675   if (errno == ERANGE)
8676     msg = US"absolute value of integer \"%s\" is too large (overflow)";
8677   else
8678     if (Uskip_whitespace(&endptr) == 0) return value;
8679   }
8680
8681 expand_string_message = string_sprintf(CS msg, s);
8682 return -2;
8683 }
8684
8685
8686 /* These values are usually fixed boolean values, but they are permitted to be
8687 expanded strings.
8688
8689 Arguments:
8690   addr       address being routed
8691   mtype      the module type
8692   mname      the module name
8693   dbg_opt    debug selectors
8694   oname      the option name
8695   bvalue     the router's boolean value
8696   svalue     the router's string value
8697   rvalue     where to put the returned value
8698
8699 Returns:     OK     value placed in rvalue
8700              DEFER  expansion failed
8701 */
8702
8703 int
8704 exp_bool(address_item * addr,
8705   const uschar * mtype, const uschar * mname, unsigned dbg_opt,
8706   uschar * oname, BOOL bvalue,
8707   const uschar * svalue, BOOL * rvalue)
8708 {
8709 const uschar * expanded;
8710
8711 DEBUG(D_expand) debug_printf("try option %s\n", oname);
8712 if (!svalue) { *rvalue = bvalue; return OK; }
8713
8714 if (!(expanded = expand_cstring(svalue)))
8715   {
8716   if (f.expand_string_forcedfail)
8717     {
8718     DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
8719     *rvalue = bvalue;
8720     return OK;
8721     }
8722   addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
8723       oname, mname, mtype, expand_string_message);
8724   DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
8725   return DEFER;
8726   }
8727
8728 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
8729   expanded);
8730
8731 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
8732   *rvalue = TRUE;
8733 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
8734   *rvalue = FALSE;
8735 else
8736   {
8737   addr->message = string_sprintf("\"%s\" is not a valid value for the "
8738     "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
8739   return DEFER;
8740   }
8741
8742 return OK;
8743 }
8744
8745
8746
8747 /* Avoid potentially exposing a password in a string about to be logged */
8748
8749 uschar *
8750 expand_hide_passwords(uschar * s)
8751 {
8752 return (  (  Ustrstr(s, "failed to expand") != NULL
8753           || Ustrstr(s, "expansion of ")    != NULL
8754           )
8755        && (  Ustrstr(s, "mysql")   != NULL
8756           || Ustrstr(s, "pgsql")   != NULL
8757           || Ustrstr(s, "redis")   != NULL
8758           || Ustrstr(s, "sqlite")  != NULL
8759           || Ustrstr(s, "ldap:")   != NULL
8760           || Ustrstr(s, "ldaps:")  != NULL
8761           || Ustrstr(s, "ldapi:")  != NULL
8762           || Ustrstr(s, "ldapdn:") != NULL
8763           || Ustrstr(s, "ldapm:")  != NULL
8764        )  )
8765   ? US"Temporary internal error" : s;
8766 }
8767
8768
8769 /* Read given named file into big_buffer.  Use for keying material etc.
8770 The content will have an ascii NUL appended.
8771
8772 Arguments:
8773  filename       as it says
8774
8775 Return:  pointer to buffer, or NULL on error.
8776 */
8777
8778 uschar *
8779 expand_file_big_buffer(const uschar * filename)
8780 {
8781 int fd, off = 0, len;
8782
8783 if ((fd = exim_open2(CS filename, O_RDONLY)) < 0)
8784   {
8785   log_write(0, LOG_MAIN | LOG_PANIC, "unable to open file for reading: %s",
8786              filename);
8787   return NULL;
8788   }
8789
8790 do
8791   {
8792   if ((len = read(fd, big_buffer + off, big_buffer_size - 2 - off)) < 0)
8793     {
8794     (void) close(fd);
8795     log_write(0, LOG_MAIN|LOG_PANIC, "unable to read file: %s", filename);
8796     return NULL;
8797     }
8798   off += len;
8799   }
8800 while (len > 0);
8801
8802 (void) close(fd);
8803 big_buffer[off] = '\0';
8804 return big_buffer;
8805 }
8806
8807
8808
8809 /*************************************************
8810 * Error-checking for testsuite                   *
8811 *************************************************/
8812 typedef struct {
8813   uschar *      region_start;
8814   uschar *      region_end;
8815   const uschar *var_name;
8816   const uschar *var_data;
8817 } err_ctx;
8818
8819 /* Called via tree_walk, which allows nonconst name/data.  Our usage is const. */
8820 static void
8821 assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
8822 {
8823 err_ctx * e = ctx;
8824 if (var_data >= e->region_start  &&  var_data < e->region_end)
8825   {
8826   e->var_name = CUS var_name;
8827   e->var_data = CUS var_data;
8828   }
8829 }
8830
8831 void
8832 assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
8833 {
8834 err_ctx e = { .region_start = ptr, .region_end = US ptr + len,
8835               .var_name = NULL, .var_data = NULL };
8836
8837 /* check acl_ variables */
8838 tree_walk(acl_var_c, assert_variable_notin, &e);
8839 tree_walk(acl_var_m, assert_variable_notin, &e);
8840
8841 /* check auth<n> variables.
8842 assert_variable_notin() treats as const, so deconst is safe. */
8843 for (int i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
8844   assert_variable_notin(US"auth<n>", US auth_vars[i], &e);
8845
8846 #ifdef WITH_CONTENT_SCAN
8847 /* check regex<n> variables. assert_variable_notin() treats as const. */
8848 for (int i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
8849   assert_variable_notin(US"regex<n>", US regex_vars[i], &e);
8850 #endif
8851
8852 /* check known-name variables */
8853 for (var_entry * v = var_table; v < var_table + nelem(var_table); v++)
8854   if (v->type == vtype_stringptr)
8855     assert_variable_notin(US v->name, *(USS v->value), &e);
8856
8857 /* check dns and address trees */
8858 tree_walk(tree_dns_fails,     assert_variable_notin, &e);
8859 tree_walk(tree_duplicates,    assert_variable_notin, &e);
8860 tree_walk(tree_nonrecipients, assert_variable_notin, &e);
8861 tree_walk(tree_unusable,      assert_variable_notin, &e);
8862
8863 if (e.var_name)
8864   log_write(0, LOG_MAIN|LOG_PANIC_DIE,
8865     "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
8866     e.var_name, filename, linenumber, e.var_data);
8867 }
8868
8869
8870
8871 /*************************************************
8872 **************************************************
8873 *             Stand-alone test program           *
8874 **************************************************
8875 *************************************************/
8876
8877 #ifdef STAND_ALONE
8878
8879
8880 BOOL
8881 regex_match_and_setup(const pcre2_code *re, uschar *subject, int options, int setup)
8882 {
8883 int ovec[3*(EXPAND_MAXN+1)];
8884 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
8885   ovec, nelem(ovec));
8886 BOOL yield = n >= 0;
8887 if (n == 0) n = EXPAND_MAXN + 1;
8888 if (yield)
8889   {
8890   expand_nmax = setup < 0 ? 0 : setup + 1;
8891   for (int nn = setup < 0 ? 0 : 2; nn < n*2; nn += 2)
8892     {
8893     expand_nstring[expand_nmax] = subject + ovec[nn];
8894     expand_nlength[expand_nmax++] = ovec[nn+1] - ovec[nn];
8895     }
8896   expand_nmax--;
8897   }
8898 return yield;
8899 }
8900
8901
8902 int main(int argc, uschar **argv)
8903 {
8904 uschar buffer[1024];
8905
8906 debug_selector = D_v;
8907 debug_file = stderr;
8908 debug_fd = fileno(debug_file);
8909 big_buffer = malloc(big_buffer_size);
8910 store_init();
8911
8912 for (int i = 1; i < argc; i++)
8913   {
8914   if (argv[i][0] == '+')
8915     {
8916     debug_trace_memory = 2;
8917     argv[i]++;
8918     }
8919   if (isdigit(argv[i][0]))
8920     debug_selector = Ustrtol(argv[i], NULL, 0);
8921   else
8922     if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
8923         Ustrlen(argv[i]))
8924       {
8925 #ifdef LOOKUP_LDAP
8926       eldap_default_servers = argv[i];
8927 #endif
8928 #ifdef LOOKUP_MYSQL
8929       mysql_servers = argv[i];
8930 #endif
8931 #ifdef LOOKUP_PGSQL
8932       pgsql_servers = argv[i];
8933 #endif
8934 #ifdef LOOKUP_REDIS
8935       redis_servers = argv[i];
8936 #endif
8937       }
8938 #ifdef EXIM_PERL
8939   else opt_perl_startup = argv[i];
8940 #endif
8941   }
8942
8943 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
8944
8945 expand_nstring[1] = US"string 1....";
8946 expand_nlength[1] = 8;
8947 expand_nmax = 1;
8948
8949 #ifdef EXIM_PERL
8950 if (opt_perl_startup != NULL)
8951   {
8952   uschar *errstr;
8953   printf("Starting Perl interpreter\n");
8954   errstr = init_perl(opt_perl_startup);
8955   if (errstr != NULL)
8956     {
8957     printf("** error in perl_startup code: %s\n", errstr);
8958     return EXIT_FAILURE;
8959     }
8960   }
8961 #endif /* EXIM_PERL */
8962
8963 /* Thie deliberately regards the input as untainted, so that it can be
8964 expanded; only reasonable since this is a test for string-expansions. */
8965
8966 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
8967   {
8968   rmark reset_point = store_mark();
8969   uschar *yield = expand_string(buffer);
8970   if (yield)
8971     printf("%s\n", yield);
8972   else
8973     {
8974     if (f.search_find_defer) printf("search_find deferred\n");
8975     printf("Failed: %s\n", expand_string_message);
8976     if (f.expand_string_forcedfail) printf("Forced failure\n");
8977     printf("\n");
8978     }
8979   store_reset(reset_point);
8980   }
8981
8982 search_tidyup();
8983
8984 return 0;
8985 }
8986
8987 #endif  /*STAND_ALONE*/
8988
8989 #endif  /*!MACRO_PREDEF*/
8990 /* vi: aw ai sw=2
8991 */
8992 /* End of expand.c */