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