src/src/expand.c

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