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