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