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