src/src/expand.c

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