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