src/src/expand.c

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