src/src/expand.c

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) The Exim Maintainers 2020 - 2024 */
   6 /* Copyright (c) University of Cambridge 1995 - 2018 */
   7 /* See the file NOTICE for conditions of use and distribution. */
   8 /* SPDX-License-Identifier: GPL-2.0-or-later */
   9
  10
  11 /* Functions for handling string expansion. */
  12
  13
  14 #include "exim.h"
  15
  16 #ifdef MACRO_PREDEF
  17 # include "macro_predef.h"
  18 #endif
  19
  20 typedef unsigned esi_flags;
  21 #define ESI_NOFLAGS             0
  22 #define ESI_BRACE_ENDS          BIT(0)  /* expansion should stop at } */
  23 #define ESI_HONOR_DOLLAR        BIT(1)  /* $ is meaningfull */
  24 #define ESI_SKIPPING            BIT(2)  /* value will not be needed */
  25 #define ESI_EXISTS_ONLY         BIT(3)  /* actual value not needed */
  26
  27 #ifdef STAND_ALONE
  28 # ifndef SUPPORT_CRYPTEQ
  29 #  define SUPPORT_CRYPTEQ
  30 # endif
  31 #endif  /*!STAND_ALONE*/
  32
  33 #ifdef SUPPORT_CRYPTEQ
  34 # ifdef CRYPT_H
  35 #  include <crypt.h>
  36 # endif
  37 # ifndef HAVE_CRYPT16
  38 extern char* crypt16(char*, char*);
  39 # endif
  40 #endif
  41
  42 /* The handling of crypt16() is a mess. I will record below the analysis of the
  43 mess that was sent to me. We decided, however, to make changing this very low
  44 priority, because in practice people are moving away from the crypt()
  45 algorithms nowadays, so it doesn't seem worth it.
  46
  47 <quote>
  48 There is an algorithm named "crypt16" in Ultrix and Tru64.  It crypts
  49 the first 8 characters of the password using a 20-round version of crypt
  50 (standard crypt does 25 rounds).  It then crypts the next 8 characters,
  51 or an empty block if the password is less than 9 characters, using a
  52 20-round version of crypt and the same salt as was used for the first
  53 block.  Characters after the first 16 are ignored.  It always generates
  54 a 16-byte hash, which is expressed together with the salt as a string
  55 of 24 base 64 digits.  Here are some links to peruse:
  56
  57         http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
  58         http://seclists.org/bugtraq/1999/Mar/0076.html
  59
  60 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
  61 and OSF/1.  This is the same as the standard crypt if given a password
  62 of 8 characters or less.  If given more, it first does the same as crypt
  63 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
  64 using as salt the first two base 64 digits from the first hash block.
  65 If the password is more than 16 characters then it crypts the 17th to 24th
  66 characters using as salt the first two base 64 digits from the second hash
  67 block.  And so on: I've seen references to it cutting off the password at
  68 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks).  Some links:
  69
  70         http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
  71         http://seclists.org/bugtraq/1999/Mar/0109.html
  72         http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
  73              TET1_html/sec.c222.html#no_id_208
  74
  75 Exim has something it calls "crypt16".  It will either use a native
  76 crypt16 or its own implementation.  A native crypt16 will presumably
  77 be the one that I called "crypt16" above.  The internal "crypt16"
  78 function, however, is a two-block-maximum implementation of what I called
  79 "bigcrypt".  The documentation matches the internal code.
  80
  81 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
  82 that crypt16 and bigcrypt were different things.
  83
  84 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
  85 to whatever it is using under that name.  This unfortunately sets a
  86 precedent for using "{crypt16}" to identify two incompatible algorithms
  87 whose output can't be distinguished.  With "{crypt16}" thus rendered
  88 ambiguous, I suggest you deprecate it and invent two new identifiers
  89 for the two algorithms.
  90
  91 Both crypt16 and bigcrypt are very poor algorithms, btw.  Hashing parts
  92 of the password separately means they can be cracked separately, so
  93 the double-length hash only doubles the cracking effort instead of
  94 squaring it.  I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
  95 bcrypt ({CRYPT}$2a$).
  96 </quote>
  97 */
  98
  99
 100
 101 /*************************************************
 102 *            Local statics and tables            *
 103 *************************************************/
 104
 105 /* Table of item names, and corresponding switch numbers. The names must be in
 106 alphabetical order. */
 107
 108 static uschar *item_table[] = {
 109   US"acl",
 110   US"authresults",
 111   US"certextract",
 112   US"dlfunc",
 113   US"env",
 114   US"extract",
 115   US"filter",
 116   US"hash",
 117   US"hmac",
 118   US"if",
 119 #ifdef SUPPORT_I18N
 120   US"imapfolder",
 121 #endif
 122   US"length",
 123   US"listextract",
 124   US"listquote",
 125   US"lookup",
 126   US"map",
 127   US"nhash",
 128   US"perl",
 129   US"prvs",
 130   US"prvscheck",
 131   US"readfile",
 132   US"readsocket",
 133   US"reduce",
 134   US"run",
 135   US"sg",
 136   US"sort",
 137 #ifdef SUPPORT_SRS
 138   US"srs_encode",
 139 #endif
 140   US"substr",
 141   US"tr" };
 142
 143 enum {
 144   EITEM_ACL,
 145   EITEM_AUTHRESULTS,
 146   EITEM_CERTEXTRACT,
 147   EITEM_DLFUNC,
 148   EITEM_ENV,
 149   EITEM_EXTRACT,
 150   EITEM_FILTER,
 151   EITEM_HASH,
 152   EITEM_HMAC,
 153   EITEM_IF,
 154 #ifdef SUPPORT_I18N
 155   EITEM_IMAPFOLDER,
 156 #endif
 157   EITEM_LENGTH,
 158   EITEM_LISTEXTRACT,
 159   EITEM_LISTQUOTE,
 160   EITEM_LOOKUP,
 161   EITEM_MAP,
 162   EITEM_NHASH,
 163   EITEM_PERL,
 164   EITEM_PRVS,
 165   EITEM_PRVSCHECK,
 166   EITEM_READFILE,
 167   EITEM_READSOCK,
 168   EITEM_REDUCE,
 169   EITEM_RUN,
 170   EITEM_SG,
 171   EITEM_SORT,
 172 #ifdef SUPPORT_SRS
 173   EITEM_SRS_ENCODE,
 174 #endif
 175   EITEM_SUBSTR,
 176   EITEM_TR };
 177
 178 /* Tables of operator names, and corresponding switch numbers. The names must be
 179 in alphabetical order. There are two tables, because underscore is used in some
 180 cases to introduce arguments, whereas for other it is part of the name. This is
 181 an historical mis-design. */
 182
 183 static uschar * op_table_underscore[] = {
 184   US"from_utf8",
 185   US"local_part",
 186   US"quote_local_part",
 187   US"reverse_ip",
 188   US"time_eval",
 189   US"time_interval"
 190 #ifdef SUPPORT_I18N
 191  ,US"utf8_domain_from_alabel",
 192   US"utf8_domain_to_alabel",
 193   US"utf8_localpart_from_alabel",
 194   US"utf8_localpart_to_alabel"
 195 #endif
 196   };
 197
 198 enum {
 199   EOP_FROM_UTF8,
 200   EOP_LOCAL_PART,
 201   EOP_QUOTE_LOCAL_PART,
 202   EOP_REVERSE_IP,
 203   EOP_TIME_EVAL,
 204   EOP_TIME_INTERVAL
 205 #ifdef SUPPORT_I18N
 206  ,EOP_UTF8_DOMAIN_FROM_ALABEL,
 207   EOP_UTF8_DOMAIN_TO_ALABEL,
 208   EOP_UTF8_LOCALPART_FROM_ALABEL,
 209   EOP_UTF8_LOCALPART_TO_ALABEL
 210 #endif
 211   };
 212
 213 static uschar *op_table_main[] = {
 214   US"address",
 215   US"addresses",
 216   US"base32",
 217   US"base32d",
 218   US"base62",
 219   US"base62d",
 220   US"base64",
 221   US"base64d",
 222   US"domain",
 223   US"escape",
 224   US"escape8bit",
 225   US"eval",
 226   US"eval10",
 227   US"expand",
 228   US"h",
 229   US"hash",
 230   US"headerwrap",
 231   US"hex2b64",
 232   US"hexquote",
 233   US"ipv6denorm",
 234   US"ipv6norm",
 235   US"l",
 236   US"lc",
 237   US"length",
 238   US"listcount",
 239   US"listnamed",
 240   US"mask",
 241   US"md5",
 242   US"nh",
 243   US"nhash",
 244   US"quote",
 245   US"randint",
 246   US"rfc2047",
 247   US"rfc2047d",
 248   US"rxquote",
 249   US"s",
 250   US"sha1",
 251   US"sha2",
 252   US"sha256",
 253   US"sha3",
 254   US"stat",
 255   US"str2b64",
 256   US"strlen",
 257   US"substr",
 258   US"uc",
 259   US"utf8clean",
 260   US"xtextd",
 261   };
 262
 263 enum {
 264   EOP_ADDRESS =  nelem(op_table_underscore),
 265   EOP_ADDRESSES,
 266   EOP_BASE32,
 267   EOP_BASE32D,
 268   EOP_BASE62,
 269   EOP_BASE62D,
 270   EOP_BASE64,
 271   EOP_BASE64D,
 272   EOP_DOMAIN,
 273   EOP_ESCAPE,
 274   EOP_ESCAPE8BIT,
 275   EOP_EVAL,
 276   EOP_EVAL10,
 277   EOP_EXPAND,
 278   EOP_H,
 279   EOP_HASH,
 280   EOP_HEADERWRAP,
 281   EOP_HEX2B64,
 282   EOP_HEXQUOTE,
 283   EOP_IPV6DENORM,
 284   EOP_IPV6NORM,
 285   EOP_L,
 286   EOP_LC,
 287   EOP_LENGTH,
 288   EOP_LISTCOUNT,
 289   EOP_LISTNAMED,
 290   EOP_MASK,
 291   EOP_MD5,
 292   EOP_NH,
 293   EOP_NHASH,
 294   EOP_QUOTE,
 295   EOP_RANDINT,
 296   EOP_RFC2047,
 297   EOP_RFC2047D,
 298   EOP_RXQUOTE,
 299   EOP_S,
 300   EOP_SHA1,
 301   EOP_SHA2,
 302   EOP_SHA256,
 303   EOP_SHA3,
 304   EOP_STAT,
 305   EOP_STR2B64,
 306   EOP_STRLEN,
 307   EOP_SUBSTR,
 308   EOP_UC,
 309   EOP_UTF8CLEAN,
 310   EOP_XTEXTD,
 311   };
 312
 313
 314 /* Table of condition names, and corresponding switch numbers. The names must
 315 be in alphabetical order. */
 316
 317 static uschar *cond_table[] = {
 318   US"<",
 319   US"<=",
 320   US"=",
 321   US"==",     /* Backward compatibility */
 322   US">",
 323   US">=",
 324   US"acl",
 325   US"and",
 326   US"bool",
 327   US"bool_lax",
 328   US"crypteq",
 329   US"def",
 330   US"eq",
 331   US"eqi",
 332   US"exists",
 333   US"first_delivery",
 334   US"forall",
 335   US"forall_json",
 336   US"forall_jsons",
 337   US"forany",
 338   US"forany_json",
 339   US"forany_jsons",
 340   US"ge",
 341   US"gei",
 342   US"gt",
 343   US"gti",
 344 #ifdef SUPPORT_SRS
 345   US"inbound_srs",
 346 #endif
 347   US"inlist",
 348   US"inlisti",
 349   US"isip",
 350   US"isip4",
 351   US"isip6",
 352   US"ldapauth",
 353   US"le",
 354   US"lei",
 355   US"lt",
 356   US"lti",
 357   US"match",
 358   US"match_address",
 359   US"match_domain",
 360   US"match_ip",
 361   US"match_local_part",
 362   US"or",
 363   US"pam",
 364   US"pwcheck",
 365   US"queue_running",
 366   US"radius",
 367   US"saslauthd"
 368 };
 369
 370 enum {
 371   ECOND_NUM_L,
 372   ECOND_NUM_LE,
 373   ECOND_NUM_E,
 374   ECOND_NUM_EE,
 375   ECOND_NUM_G,
 376   ECOND_NUM_GE,
 377   ECOND_ACL,
 378   ECOND_AND,
 379   ECOND_BOOL,
 380   ECOND_BOOL_LAX,
 381   ECOND_CRYPTEQ,
 382   ECOND_DEF,
 383   ECOND_STR_EQ,
 384   ECOND_STR_EQI,
 385   ECOND_EXISTS,
 386   ECOND_FIRST_DELIVERY,
 387   ECOND_FORALL,
 388   ECOND_FORALL_JSON,
 389   ECOND_FORALL_JSONS,
 390   ECOND_FORANY,
 391   ECOND_FORANY_JSON,
 392   ECOND_FORANY_JSONS,
 393   ECOND_STR_GE,
 394   ECOND_STR_GEI,
 395   ECOND_STR_GT,
 396   ECOND_STR_GTI,
 397 #ifdef SUPPORT_SRS
 398   ECOND_INBOUND_SRS,
 399 #endif
 400   ECOND_INLIST,
 401   ECOND_INLISTI,
 402   ECOND_ISIP,
 403   ECOND_ISIP4,
 404   ECOND_ISIP6,
 405   ECOND_LDAPAUTH,
 406   ECOND_STR_LE,
 407   ECOND_STR_LEI,
 408   ECOND_STR_LT,
 409   ECOND_STR_LTI,
 410   ECOND_MATCH,
 411   ECOND_MATCH_ADDRESS,
 412   ECOND_MATCH_DOMAIN,
 413   ECOND_MATCH_IP,
 414   ECOND_MATCH_LOCAL_PART,
 415   ECOND_OR,
 416   ECOND_PAM,
 417   ECOND_PWCHECK,
 418   ECOND_QUEUE_RUNNING,
 419   ECOND_RADIUS,
 420   ECOND_SASLAUTHD
 421 };
 422
 423
 424 /* Type for entries pointing to address/length pairs. Not currently
 425 in use. */
 426
 427 typedef struct {
 428   uschar **address;
 429   int  *length;
 430 } alblock;
 431
 432 typedef uschar * stringptr_fn_t(void);
 433 static uschar * fn_recipients(void);
 434 static uschar * fn_recipients_list(void);
 435 static uschar * fn_queue_size(void);
 436
 437 /* This table must be kept in alphabetical order. */
 438
 439 static var_entry var_table[] = {
 440   /* WARNING: Do not invent variables whose names start acl_c or acl_m because
 441      they will be confused with user-creatable ACL variables. */
 442   { "acl_arg1",            vtype_stringptr,   &acl_arg[0] },
 443   { "acl_arg2",            vtype_stringptr,   &acl_arg[1] },
 444   { "acl_arg3",            vtype_stringptr,   &acl_arg[2] },
 445   { "acl_arg4",            vtype_stringptr,   &acl_arg[3] },
 446   { "acl_arg5",            vtype_stringptr,   &acl_arg[4] },
 447   { "acl_arg6",            vtype_stringptr,   &acl_arg[5] },
 448   { "acl_arg7",            vtype_stringptr,   &acl_arg[6] },
 449   { "acl_arg8",            vtype_stringptr,   &acl_arg[7] },
 450   { "acl_arg9",            vtype_stringptr,   &acl_arg[8] },
 451   { "acl_narg",            vtype_int,         &acl_narg },
 452   { "acl_verify_message",  vtype_stringptr,   &acl_verify_message },
 453   { "address_data",        vtype_stringptr,   &deliver_address_data },
 454   { "address_file",        vtype_stringptr,   &address_file },
 455   { "address_pipe",        vtype_stringptr,   &address_pipe },
 456 #ifdef EXPERIMENTAL_ARC
 457   { "arc_domains",         vtype_string_func, (void *) &fn_arc_domains },
 458   { "arc_oldest_pass",     vtype_int,         &arc_oldest_pass },
 459   { "arc_state",           vtype_stringptr,   &arc_state },
 460   { "arc_state_reason",    vtype_stringptr,   &arc_state_reason },
 461 #endif
 462   { "authenticated_fail_id",vtype_stringptr,  &authenticated_fail_id },
 463   { "authenticated_id",    vtype_stringptr,   &authenticated_id },
 464   { "authenticated_sender",vtype_stringptr,   &authenticated_sender },
 465   { "authentication_failed",vtype_int,        &authentication_failed },
 466 #ifdef WITH_CONTENT_SCAN
 467   { "av_failed",           vtype_int,         &av_failed },
 468 #endif
 469 #ifdef EXPERIMENTAL_BRIGHTMAIL
 470   { "bmi_alt_location",    vtype_stringptr,   &bmi_alt_location },
 471   { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
 472   { "bmi_base64_verdict",  vtype_stringptr,   &bmi_base64_verdict },
 473   { "bmi_deliver",         vtype_int,         &bmi_deliver },
 474 #endif
 475   { "body_linecount",      vtype_int,         &body_linecount },
 476   { "body_zerocount",      vtype_int,         &body_zerocount },
 477   { "bounce_recipient",    vtype_stringptr,   &bounce_recipient },
 478   { "bounce_return_size_limit", vtype_int,    &bounce_return_size_limit },
 479   { "caller_gid",          vtype_gid,         &real_gid },
 480   { "caller_uid",          vtype_uid,         &real_uid },
 481   { "callout_address",     vtype_stringptr,   &callout_address },
 482   { "compile_date",        vtype_stringptr,   &version_date },
 483   { "compile_number",      vtype_stringptr,   &version_cnumber },
 484   { "config_dir",          vtype_stringptr,   &config_main_directory },
 485   { "config_file",         vtype_stringptr,   &config_main_filename },
 486   { "connection_id",       vtype_stringptr,   &connection_id },
 487   { "csa_status",          vtype_stringptr,   &csa_status },
 488 #ifdef EXPERIMENTAL_DCC
 489   { "dcc_header",          vtype_stringptr,   &dcc_header },
 490   { "dcc_result",          vtype_stringptr,   &dcc_result },
 491 #endif
 492 #ifndef DISABLE_DKIM
 493   { "dkim_algo",           vtype_dkim,        (void *)DKIM_ALGO },
 494   { "dkim_bodylength",     vtype_dkim,        (void *)DKIM_BODYLENGTH },
 495   { "dkim_canon_body",     vtype_dkim,        (void *)DKIM_CANON_BODY },
 496   { "dkim_canon_headers",  vtype_dkim,        (void *)DKIM_CANON_HEADERS },
 497   { "dkim_copiedheaders",  vtype_dkim,        (void *)DKIM_COPIEDHEADERS },
 498   { "dkim_created",        vtype_dkim,        (void *)DKIM_CREATED },
 499   { "dkim_cur_signer",     vtype_stringptr,   &dkim_cur_signer },
 500   { "dkim_domain",         vtype_stringptr,   &dkim_signing_domain },
 501   { "dkim_expires",        vtype_dkim,        (void *)DKIM_EXPIRES },
 502   { "dkim_headernames",    vtype_dkim,        (void *)DKIM_HEADERNAMES },
 503   { "dkim_identity",       vtype_dkim,        (void *)DKIM_IDENTITY },
 504   { "dkim_key_granularity",vtype_dkim,        (void *)DKIM_KEY_GRANULARITY },
 505   { "dkim_key_length",     vtype_int,         &dkim_key_length },
 506   { "dkim_key_nosubdomains",vtype_dkim,       (void *)DKIM_NOSUBDOMAINS },
 507   { "dkim_key_notes",      vtype_dkim,        (void *)DKIM_KEY_NOTES },
 508   { "dkim_key_srvtype",    vtype_dkim,        (void *)DKIM_KEY_SRVTYPE },
 509   { "dkim_key_testing",    vtype_dkim,        (void *)DKIM_KEY_TESTING },
 510   { "dkim_selector",       vtype_stringptr,   &dkim_signing_selector },
 511   { "dkim_signers",        vtype_stringptr,   &dkim_signers },
 512   { "dkim_verify_reason",  vtype_stringptr,   &dkim_verify_reason },
 513   { "dkim_verify_status",  vtype_stringptr,   &dkim_verify_status },
 514 #endif
 515 #ifdef SUPPORT_DMARC
 516   { "dmarc_domain_policy", vtype_stringptr,   &dmarc_domain_policy },
 517   { "dmarc_status",        vtype_stringptr,   &dmarc_status },
 518   { "dmarc_status_text",   vtype_stringptr,   &dmarc_status_text },
 519   { "dmarc_used_domain",   vtype_stringptr,   &dmarc_used_domain },
 520 #endif
 521   { "dnslist_domain",      vtype_stringptr,   &dnslist_domain },
 522   { "dnslist_matched",     vtype_stringptr,   &dnslist_matched },
 523   { "dnslist_text",        vtype_stringptr,   &dnslist_text },
 524   { "dnslist_value",       vtype_stringptr,   &dnslist_value },
 525   { "domain",              vtype_stringptr,   &deliver_domain },
 526   { "domain_data",         vtype_stringptr,   &deliver_domain_data },
 527 #ifndef DISABLE_EVENT
 528   { "event_data",          vtype_stringptr,   &event_data },
 529
 530   /*XXX want to use generic vars for as many of these as possible*/
 531   { "event_defer_errno",   vtype_int,         &event_defer_errno },
 532
 533   { "event_name",          vtype_stringptr,   &event_name },
 534 #endif
 535   { "exim_gid",            vtype_gid,         &exim_gid },
 536   { "exim_path",           vtype_stringptr,   &exim_path },
 537   { "exim_uid",            vtype_uid,         &exim_uid },
 538   { "exim_version",        vtype_stringptr,   &version_string },
 539   { "headers_added",       vtype_string_func, (void *) &fn_hdrs_added },
 540   { "home",                vtype_stringptr,   &deliver_home },
 541   { "host",                vtype_stringptr,   &deliver_host },
 542   { "host_address",        vtype_stringptr,   &deliver_host_address },
 543   { "host_data",           vtype_stringptr,   &host_data },
 544   { "host_lookup_deferred",vtype_int,         &host_lookup_deferred },
 545   { "host_lookup_failed",  vtype_int,         &host_lookup_failed },
 546   { "host_port",           vtype_int,         &deliver_host_port },
 547   { "initial_cwd",         vtype_stringptr,   &initial_cwd },
 548   { "inode",               vtype_ino,         &deliver_inode },
 549   { "interface_address",   vtype_stringptr,   &interface_address },
 550   { "interface_port",      vtype_int,         &interface_port },
 551   { "item",                vtype_stringptr,   &iterate_item },
 552 #ifdef LOOKUP_LDAP
 553   { "ldap_dn",             vtype_stringptr,   &eldap_dn },
 554 #endif
 555   { "load_average",        vtype_load_avg,    NULL },
 556   { "local_part",          vtype_stringptr,   &deliver_localpart },
 557   { "local_part_data",     vtype_stringptr,   &deliver_localpart_data },
 558   { "local_part_prefix",   vtype_stringptr,   &deliver_localpart_prefix },
 559   { "local_part_prefix_v", vtype_stringptr,   &deliver_localpart_prefix_v },
 560   { "local_part_suffix",   vtype_stringptr,   &deliver_localpart_suffix },
 561   { "local_part_suffix_v", vtype_stringptr,   &deliver_localpart_suffix_v },
 562 #ifdef HAVE_LOCAL_SCAN
 563   { "local_scan_data",     vtype_stringptr,   &local_scan_data },
 564 #endif
 565   { "local_user_gid",      vtype_gid,         &local_user_gid },
 566   { "local_user_uid",      vtype_uid,         &local_user_uid },
 567   { "localhost_number",    vtype_int,         &host_number },
 568   { "log_inodes",          vtype_pinodes,     (void *)FALSE },
 569   { "log_space",           vtype_pspace,      (void *)FALSE },
 570   { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
 571   { "mailstore_basename",  vtype_stringptr,   &mailstore_basename },
 572 #ifdef WITH_CONTENT_SCAN
 573   { "malware_name",        vtype_stringptr,   &malware_name },
 574 #endif
 575   { "max_received_linelength", vtype_int,     &max_received_linelength },
 576   { "message_age",         vtype_int,         &message_age },
 577   { "message_body",        vtype_msgbody,     &message_body },
 578   { "message_body_end",    vtype_msgbody_end, &message_body_end },
 579   { "message_body_size",   vtype_int,         &message_body_size },
 580   { "message_exim_id",     vtype_stringptr,   &message_id },
 581   { "message_headers",     vtype_msgheaders,  NULL },
 582   { "message_headers_raw", vtype_msgheaders_raw, NULL },
 583   { "message_id",          vtype_stringptr,   &message_id },
 584   { "message_linecount",   vtype_int,         &message_linecount },
 585   { "message_size",        vtype_int,         &message_size },
 586 #ifdef SUPPORT_I18N
 587   { "message_smtputf8",    vtype_bool,        &message_smtputf8 },
 588 #endif
 589 #ifdef WITH_CONTENT_SCAN
 590   { "mime_anomaly_level",  vtype_int,         &mime_anomaly_level },
 591   { "mime_anomaly_text",   vtype_stringptr,   &mime_anomaly_text },
 592   { "mime_boundary",       vtype_stringptr,   &mime_boundary },
 593   { "mime_charset",        vtype_stringptr,   &mime_charset },
 594   { "mime_content_description", vtype_stringptr, &mime_content_description },
 595   { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
 596   { "mime_content_id",     vtype_stringptr,   &mime_content_id },
 597   { "mime_content_size",   vtype_int,         &mime_content_size },
 598   { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
 599   { "mime_content_type",   vtype_stringptr,   &mime_content_type },
 600   { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
 601   { "mime_filename",       vtype_stringptr,   &mime_filename },
 602   { "mime_is_coverletter", vtype_int,         &mime_is_coverletter },
 603   { "mime_is_multipart",   vtype_int,         &mime_is_multipart },
 604   { "mime_is_rfc822",      vtype_int,         &mime_is_rfc822 },
 605   { "mime_part_count",     vtype_int,         &mime_part_count },
 606 #endif
 607   { "n0",                  vtype_filter_int,  &filter_n[0] },
 608   { "n1",                  vtype_filter_int,  &filter_n[1] },
 609   { "n2",                  vtype_filter_int,  &filter_n[2] },
 610   { "n3",                  vtype_filter_int,  &filter_n[3] },
 611   { "n4",                  vtype_filter_int,  &filter_n[4] },
 612   { "n5",                  vtype_filter_int,  &filter_n[5] },
 613   { "n6",                  vtype_filter_int,  &filter_n[6] },
 614   { "n7",                  vtype_filter_int,  &filter_n[7] },
 615   { "n8",                  vtype_filter_int,  &filter_n[8] },
 616   { "n9",                  vtype_filter_int,  &filter_n[9] },
 617   { "original_domain",     vtype_stringptr,   &deliver_domain_orig },
 618   { "original_local_part", vtype_stringptr,   &deliver_localpart_orig },
 619   { "originator_gid",      vtype_gid,         &originator_gid },
 620   { "originator_uid",      vtype_uid,         &originator_uid },
 621   { "parent_domain",       vtype_stringptr,   &deliver_domain_parent },
 622   { "parent_local_part",   vtype_stringptr,   &deliver_localpart_parent },
 623   { "pid",                 vtype_pid,         NULL },
 624 #ifndef DISABLE_PRDR
 625   { "prdr_requested",      vtype_bool,        &prdr_requested },
 626 #endif
 627   { "primary_hostname",    vtype_stringptr,   &primary_hostname },
 628 #if defined(SUPPORT_PROXY) || defined(SUPPORT_SOCKS)
 629   { "proxy_external_address",vtype_stringptr, &proxy_external_address },
 630   { "proxy_external_port", vtype_int,         &proxy_external_port },
 631   { "proxy_local_address", vtype_stringptr,   &proxy_local_address },
 632   { "proxy_local_port",    vtype_int,         &proxy_local_port },
 633   { "proxy_session",       vtype_bool,        &proxy_session },
 634 #endif
 635   { "prvscheck_address",   vtype_stringptr,   &prvscheck_address },
 636   { "prvscheck_keynum",    vtype_stringptr,   &prvscheck_keynum },
 637   { "prvscheck_result",    vtype_stringptr,   &prvscheck_result },
 638   { "qualify_domain",      vtype_stringptr,   &qualify_domain_sender },
 639   { "qualify_recipient",   vtype_stringptr,   &qualify_domain_recipient },
 640   { "queue_name",          vtype_stringptr,   &queue_name },
 641   { "queue_size",          vtype_string_func, (void *) &fn_queue_size },
 642   { "rcpt_count",          vtype_int,         &rcpt_count },
 643   { "rcpt_defer_count",    vtype_int,         &rcpt_defer_count },
 644   { "rcpt_fail_count",     vtype_int,         &rcpt_fail_count },
 645   { "received_count",      vtype_int,         &received_count },
 646   { "received_for",        vtype_stringptr,   &received_for },
 647   { "received_ip_address", vtype_stringptr,   &interface_address },
 648   { "received_port",       vtype_int,         &interface_port },
 649   { "received_protocol",   vtype_stringptr,   &received_protocol },
 650   { "received_time",       vtype_int,         &received_time.tv_sec },
 651   { "recipient_data",      vtype_stringptr,   &recipient_data },
 652   { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
 653   { "recipients",          vtype_string_func, (void *) &fn_recipients },
 654   { "recipients_count",    vtype_int,         &recipients_count },
 655   { "recipients_list",     vtype_string_func, (void *) &fn_recipients_list },
 656   { "regex_cachesize",     vtype_int,         &regex_cachesize },/* undocumented; devel observability */
 657 #ifdef WITH_CONTENT_SCAN
 658   { "regex_match_string",  vtype_stringptr,   &regex_match_string },
 659 #endif
 660   { "reply_address",       vtype_reply,       NULL },
 661   { "return_path",         vtype_stringptr,   &return_path },
 662   { "return_size_limit",   vtype_int,         &bounce_return_size_limit },
 663   { "router_name",         vtype_stringptr,   &router_name },
 664   { "runrc",               vtype_int,         &runrc },
 665   { "self_hostname",       vtype_stringptr,   &self_hostname },
 666   { "sender_address",      vtype_stringptr,   &sender_address },
 667   { "sender_address_data", vtype_stringptr,   &sender_address_data },
 668   { "sender_address_domain", vtype_domain,    &sender_address },
 669   { "sender_address_local_part", vtype_localpart, &sender_address },
 670   { "sender_data",         vtype_stringptr,   &sender_data },
 671   { "sender_fullhost",     vtype_stringptr,   &sender_fullhost },
 672   { "sender_helo_dnssec",  vtype_bool,        &sender_helo_dnssec },
 673   { "sender_helo_name",    vtype_stringptr,   &sender_helo_name },
 674   { "sender_helo_verified",vtype_string_func, (void *) &sender_helo_verified_boolstr },
 675   { "sender_host_address", vtype_stringptr,   &sender_host_address },
 676   { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
 677   { "sender_host_dnssec",  vtype_bool,        &sender_host_dnssec },
 678   { "sender_host_name",    vtype_host_lookup, NULL },
 679   { "sender_host_port",    vtype_int,         &sender_host_port },
 680   { "sender_ident",        vtype_stringptr,   &sender_ident },
 681   { "sender_rate",         vtype_stringptr,   &sender_rate },
 682   { "sender_rate_limit",   vtype_stringptr,   &sender_rate_limit },
 683   { "sender_rate_period",  vtype_stringptr,   &sender_rate_period },
 684   { "sender_rcvhost",      vtype_stringptr,   &sender_rcvhost },
 685   { "sender_verify_failure",vtype_stringptr,  &sender_verify_failure },
 686   { "sending_ip_address",  vtype_stringptr,   &sending_ip_address },
 687   { "sending_port",        vtype_int,         &sending_port },
 688   { "smtp_active_hostname", vtype_stringptr,  &smtp_active_hostname },
 689   { "smtp_command",        vtype_stringptr,   &smtp_cmd_buffer },
 690   { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
 691   { "smtp_command_history", vtype_string_func, (void *) &smtp_cmd_hist },
 692   { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
 693   { "smtp_notquit_reason", vtype_stringptr,   &smtp_notquit_reason },
 694   { "sn0",                 vtype_filter_int,  &filter_sn[0] },
 695   { "sn1",                 vtype_filter_int,  &filter_sn[1] },
 696   { "sn2",                 vtype_filter_int,  &filter_sn[2] },
 697   { "sn3",                 vtype_filter_int,  &filter_sn[3] },
 698   { "sn4",                 vtype_filter_int,  &filter_sn[4] },
 699   { "sn5",                 vtype_filter_int,  &filter_sn[5] },
 700   { "sn6",                 vtype_filter_int,  &filter_sn[6] },
 701   { "sn7",                 vtype_filter_int,  &filter_sn[7] },
 702   { "sn8",                 vtype_filter_int,  &filter_sn[8] },
 703   { "sn9",                 vtype_filter_int,  &filter_sn[9] },
 704 #ifdef WITH_CONTENT_SCAN
 705   { "spam_action",         vtype_stringptr,   &spam_action },
 706   { "spam_bar",            vtype_stringptr,   &spam_bar },
 707   { "spam_report",         vtype_stringptr,   &spam_report },
 708   { "spam_score",          vtype_stringptr,   &spam_score },
 709   { "spam_score_int",      vtype_stringptr,   &spam_score_int },
 710 #endif
 711 #ifdef SUPPORT_SPF
 712   { "spf_guess",           vtype_module,        US"spf" },
 713   { "spf_header_comment",  vtype_module,        US"spf" },
 714   { "spf_received",        vtype_module,        US"spf" },
 715   { "spf_result",          vtype_module,        US"spf" },
 716   { "spf_result_guessed",  vtype_module,        US"spf" },
 717   { "spf_smtp_comment",    vtype_module,        US"spf" },
 718 #endif
 719   { "spool_directory",     vtype_stringptr,   &spool_directory },
 720   { "spool_inodes",        vtype_pinodes,     (void *)TRUE },
 721   { "spool_space",         vtype_pspace,      (void *)TRUE },
 722 #ifdef SUPPORT_SRS
 723   { "srs_recipient",       vtype_stringptr,   &srs_recipient },
 724 #endif
 725   { "thisaddress",         vtype_stringptr,   &filter_thisaddress },
 726
 727   /* The non-(in,out) variables are now deprecated */
 728   { "tls_bits",            vtype_int,         &tls_in.bits },
 729   { "tls_certificate_verified", vtype_int,    &tls_in.certificate_verified },
 730   { "tls_cipher",          vtype_stringptr,   &tls_in.cipher },
 731
 732   { "tls_in_bits",         vtype_int,         &tls_in.bits },
 733   { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
 734   { "tls_in_cipher",       vtype_stringptr,   &tls_in.cipher },
 735   { "tls_in_cipher_std",   vtype_stringptr,   &tls_in.cipher_stdname },
 736   { "tls_in_ocsp",         vtype_int,         &tls_in.ocsp },
 737   { "tls_in_ourcert",      vtype_cert,        &tls_in.ourcert },
 738   { "tls_in_peercert",     vtype_cert,        &tls_in.peercert },
 739   { "tls_in_peerdn",       vtype_stringptr,   &tls_in.peerdn },
 740 #ifndef DISABLE_TLS_RESUME
 741   { "tls_in_resumption",   vtype_int,         &tls_in.resumption },
 742 #endif
 743 #ifndef DISABLE_TLS
 744   { "tls_in_sni",          vtype_stringptr,   &tls_in.sni },
 745 #endif
 746   { "tls_in_ver",          vtype_stringptr,   &tls_in.ver },
 747   { "tls_out_bits",        vtype_int,         &tls_out.bits },
 748   { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
 749   { "tls_out_cipher",      vtype_stringptr,   &tls_out.cipher },
 750   { "tls_out_cipher_std",  vtype_stringptr,   &tls_out.cipher_stdname },
 751 #ifdef SUPPORT_DANE
 752   { "tls_out_dane",        vtype_bool,        &tls_out.dane_verified },
 753 #endif
 754   { "tls_out_ocsp",        vtype_int,         &tls_out.ocsp },
 755   { "tls_out_ourcert",     vtype_cert,        &tls_out.ourcert },
 756   { "tls_out_peercert",    vtype_cert,        &tls_out.peercert },
 757   { "tls_out_peerdn",      vtype_stringptr,   &tls_out.peerdn },
 758 #ifndef DISABLE_TLS_RESUME
 759   { "tls_out_resumption",  vtype_int,         &tls_out.resumption },
 760 #endif
 761 #ifndef DISABLE_TLS
 762   { "tls_out_sni",         vtype_stringptr,   &tls_out.sni },
 763 #endif
 764 #ifdef SUPPORT_DANE
 765   { "tls_out_tlsa_usage",  vtype_int,         &tls_out.tlsa_usage },
 766 #endif
 767   { "tls_out_ver",         vtype_stringptr,   &tls_out.ver },
 768
 769   { "tls_peerdn",          vtype_stringptr,   &tls_in.peerdn }, /* mind the alphabetical order! */
 770 #ifndef DISABLE_TLS
 771   { "tls_sni",             vtype_stringptr,   &tls_in.sni },    /* mind the alphabetical order! */
 772 #endif
 773
 774   { "tod_bsdinbox",        vtype_todbsdin,    NULL },
 775   { "tod_epoch",           vtype_tode,        NULL },
 776   { "tod_epoch_l",         vtype_todel,       NULL },
 777   { "tod_full",            vtype_todf,        NULL },
 778   { "tod_log",             vtype_todl,        NULL },
 779   { "tod_logfile",         vtype_todlf,       NULL },
 780   { "tod_zone",            vtype_todzone,     NULL },
 781   { "tod_zulu",            vtype_todzulu,     NULL },
 782   { "transport_name",      vtype_stringptr,   &transport_name },
 783   { "value",               vtype_stringptr,   &lookup_value },
 784   { "verify_mode",         vtype_stringptr,   &verify_mode },
 785   { "version_number",      vtype_stringptr,   &version_string },
 786   { "warn_message_delay",  vtype_stringptr,   &warnmsg_delay },
 787   { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
 788   { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
 789   { "warnmsg_delay",       vtype_stringptr,   &warnmsg_delay },
 790   { "warnmsg_recipient",   vtype_stringptr,   &warnmsg_recipients },
 791   { "warnmsg_recipients",  vtype_stringptr,   &warnmsg_recipients }
 792 };
 793
 794 #ifdef MACRO_PREDEF
 795
 796 /* dummies */
 797 uschar * fn_arc_domains(void) {return NULL;}
 798 uschar * fn_hdrs_added(void) {return NULL;}
 799 uschar * fn_queue_size(void) {return NULL;}
 800 uschar * fn_recipients(void) {return NULL;}
 801 uschar * fn_recipients_list(void) {return NULL;}
 802 uschar * sender_helo_verified_boolstr(void) {return NULL;}
 803 uschar * smtp_cmd_hist(void) {return NULL;}
 804
 805
 806
 807 static void
 808 expansion_items(void)
 809 {
 810 uschar buf[64];
 811 for (int i = 0; i < nelem(item_table); i++)
 812   {
 813   spf(buf, sizeof(buf), CUS"_EXP_ITEM_%T", item_table[i]);
 814   builtin_macro_create(buf);
 815   }
 816 }
 817 static void
 818 expansion_operators(void)
 819 {
 820 uschar buf[64];
 821 for (int i = 0; i < nelem(op_table_underscore); i++)
 822   {
 823   spf(buf, sizeof(buf), CUS"_EXP_OP_%T", op_table_underscore[i]);
 824   builtin_macro_create(buf);
 825   }
 826 for (int i = 0; i < nelem(op_table_main); i++)
 827   {
 828   spf(buf, sizeof(buf), CUS"_EXP_OP_%T", op_table_main[i]);
 829   builtin_macro_create(buf);
 830   }
 831 }
 832 static void
 833 expansion_conditions(void)
 834 {
 835 uschar buf[64];
 836 for (int i = 0; i < nelem(cond_table); i++)
 837   {
 838   spf(buf, sizeof(buf), CUS"_EXP_COND_%T", cond_table[i]);
 839   builtin_macro_create(buf);
 840   }
 841 }
 842 static void
 843 expansion_variables(void)
 844 {
 845 uschar buf[64];
 846 for (int i = 0; i < nelem(var_table); i++)
 847   {
 848   spf(buf, sizeof(buf), CUS"_EXP_VAR_%T", var_table[i].name);
 849   builtin_macro_create(buf);
 850   }
 851 }
 852
 853 void
 854 expansions(void)
 855 {
 856 expansion_items();
 857 expansion_operators();
 858 expansion_conditions();
 859 expansion_variables();
 860 }
 861
 862 #else   /*!MACRO_PREDEF*/
 863
 864 static uschar var_buffer[256];
 865 static BOOL malformed_header;
 866
 867 /* For textual hashes */
 868
 869 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
 870                                "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
 871                                "0123456789";
 872
 873 enum { HMAC_MD5, HMAC_SHA1 };
 874
 875 /* For numeric hashes */
 876
 877 static unsigned int prime[] = {
 878   2,   3,   5,   7,  11,  13,  17,  19,  23,  29,
 879  31,  37,  41,  43,  47,  53,  59,  61,  67,  71,
 880  73,  79,  83,  89,  97, 101, 103, 107, 109, 113};
 881
 882 /* For printing modes in symbolic form */
 883
 884 static uschar *mtable_normal[] =
 885   { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
 886
 887 static uschar *mtable_setid[] =
 888   { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
 889
 890 static uschar *mtable_sticky[] =
 891   { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
 892
 893 /* flags for find_header() */
 894 #define FH_EXISTS_ONLY  BIT(0)
 895 #define FH_WANT_RAW     BIT(1)
 896 #define FH_WANT_LIST    BIT(2)
 897
 898 /* Recursively called function */
 899 static uschar *expand_string_internal(const uschar *, esi_flags, const uschar **, BOOL *, BOOL *);
 900 static int_eximarith_t expanded_string_integer(const uschar *, BOOL);
 901
 902
 903 /*************************************************
 904 *           Tables for UTF-8 support             *
 905 *************************************************/
 906
 907 /* Table of the number of extra characters, indexed by the first character
 908 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
 909 0x3d. */
 910
 911 static uschar utf8_table1[] = {
 912   1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
 913   1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
 914   2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
 915   3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
 916
 917 /* These are the masks for the data bits in the first byte of a character,
 918 indexed by the number of additional bytes. */
 919
 920 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
 921
 922 /* Get the next UTF-8 character, advancing the pointer. */
 923
 924 #define GETUTF8INC(c, ptr) \
 925   c = *ptr++; \
 926   if ((c & 0xc0) == 0xc0) \
 927     { \
 928     int a = utf8_table1[c & 0x3f];  /* Number of additional bytes */ \
 929     int s = 6*a; \
 930     c = (c & utf8_table2[a]) << s; \
 931     while (a-- > 0) \
 932       { \
 933       s -= 6; \
 934       c |= (*ptr++ & 0x3f) << s; \
 935       } \
 936     }
 937
 938
 939
 940 static uschar * base32_chars = US"abcdefghijklmnopqrstuvwxyz234567";
 941
 942 /*************************************************
 943 *           Binary chop search on a table        *
 944 *************************************************/
 945
 946 /* This is used for matching expansion items and operators.
 947
 948 Arguments:
 949   name        the name that is being sought
 950   table       the table to search
 951   table_size  the number of items in the table
 952
 953 Returns:      the offset in the table, or -1
 954 */
 955
 956 static int
 957 chop_match(uschar *name, uschar **table, int table_size)
 958 {
 959 uschar **bot = table;
 960 uschar **top = table + table_size;
 961
 962 while (top > bot)
 963   {
 964   uschar **mid = bot + (top - bot)/2;
 965   int c = Ustrcmp(name, *mid);
 966   if (c == 0) return mid - table;
 967   if (c > 0) bot = mid + 1; else top = mid;
 968   }
 969
 970 return -1;
 971 }
 972
 973
 974
 975 /*************************************************
 976 *          Check a condition string              *
 977 *************************************************/
 978
 979 /* This function is called to expand a string, and test the result for a "true"
 980 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
 981 forced fail or lookup defer.
 982
 983 We used to release all store used, but this is not not safe due
 984 to ${dlfunc } and ${acl }.  In any case expand_string_internal()
 985 is reasonably careful to release what it can.
 986
 987 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
 988
 989 Arguments:
 990   condition     the condition string
 991   m1            text to be incorporated in panic error
 992   m2            ditto
 993
 994 Returns:        TRUE if condition is met, FALSE if not
 995 */
 996
 997 BOOL
 998 expand_check_condition(const uschar * condition,
 999   const uschar * m1, const uschar * m2)
1000 {
1001 const uschar * ss = expand_cstring(condition);
1002 if (!ss)
1003   {
1004   if (!f.expand_string_forcedfail && !f.search_find_defer)
1005     log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
1006       "for %s %s: %s", condition, m1, m2, expand_string_message);
1007   return FALSE;
1008   }
1009 return *ss && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
1010   strcmpic(ss, US"false") != 0;
1011 }
1012
1013
1014
1015
1016 /*************************************************
1017 *        Pseudo-random number generation         *
1018 *************************************************/
1019
1020 /* Pseudo-random number generation.  The result is not "expected" to be
1021 cryptographically strong but not so weak that someone will shoot themselves
1022 in the foot using it as a nonce in some email header scheme or whatever
1023 weirdness they'll twist this into.  The result should ideally handle fork().
1024
1025 However, if we're stuck unable to provide this, then we'll fall back to
1026 appallingly bad randomness.
1027
1028 If DISABLE_TLS is not defined then this will not be used except as an emergency
1029 fallback.
1030
1031 Arguments:
1032   max       range maximum
1033 Returns     a random number in range [0, max-1]
1034 */
1035
1036 #ifndef DISABLE_TLS
1037 # define vaguely_random_number vaguely_random_number_fallback
1038 #endif
1039 int
1040 vaguely_random_number(int max)
1041 {
1042 #ifndef DISABLE_TLS
1043 # undef vaguely_random_number
1044 #endif
1045 static pid_t pid = 0;
1046 pid_t p2;
1047
1048 if ((p2 = getpid()) != pid)
1049   {
1050   if (pid != 0)
1051     {
1052
1053 #ifdef HAVE_ARC4RANDOM
1054     /* cryptographically strong randomness, common on *BSD platforms, not
1055     so much elsewhere.  Alas. */
1056 # ifndef NOT_HAVE_ARC4RANDOM_STIR
1057     arc4random_stir();
1058 # endif
1059 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1060 # ifdef HAVE_SRANDOMDEV
1061     /* uses random(4) for seeding */
1062     srandomdev();
1063 # else
1064     {
1065     struct timeval tv;
1066     gettimeofday(&tv, NULL);
1067     srandom(tv.tv_sec | tv.tv_usec | getpid());
1068     }
1069 # endif
1070 #else
1071     /* Poor randomness and no seeding here */
1072 #endif
1073
1074     }
1075   pid = p2;
1076   }
1077
1078 #ifdef HAVE_ARC4RANDOM
1079 return arc4random() % max;
1080 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1081 return random() % max;
1082 #else
1083 /* This one returns a 16-bit number, definitely not crypto-strong */
1084 return random_number(max);
1085 #endif
1086 }
1087
1088
1089
1090
1091 /*************************************************
1092 *             Pick out a name from a string      *
1093 *************************************************/
1094
1095 /* If the name is too long, it is silently truncated.
1096
1097 Arguments:
1098   name      points to a buffer into which to put the name
1099   max       is the length of the buffer
1100   s         points to the first alphabetic character of the name
1101   extras    chars other than alphanumerics to permit
1102
1103 Returns:    pointer to the first character after the name
1104
1105 Note: The test for *s != 0 in the while loop is necessary because
1106 Ustrchr() yields non-NULL if the character is zero (which is not something
1107 I expected). */
1108
1109 static const uschar *
1110 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1111 {
1112 int ptr = 0;
1113 while (*s && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1114   {
1115   if (ptr < max-1) name[ptr++] = *s;
1116   s++;
1117   }
1118 name[ptr] = 0;
1119 return s;
1120 }
1121
1122
1123
1124 /*************************************************
1125 *     Pick out the rest of a header name         *
1126 *************************************************/
1127
1128 /* A variable name starting $header_ (or just $h_ for those who like
1129 abbreviations) might not be the complete header name because headers can
1130 contain any printing characters in their names, except ':'. This function is
1131 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1132 on the end, if the name was terminated by white space.
1133
1134 Arguments:
1135   name      points to a buffer in which the name read so far exists
1136   max       is the length of the buffer
1137   s         points to the first character after the name so far, i.e. the
1138             first non-alphameric character after $header_xxxxx
1139
1140 Returns:    a pointer to the first character after the header name
1141 */
1142
1143 static const uschar *
1144 read_header_name(uschar *name, int max, const uschar *s)
1145 {
1146 int prelen = Ustrchr(name, '_') - name + 1;
1147 int ptr = Ustrlen(name) - prelen;
1148 if (ptr > 0) memmove(name, name+prelen, ptr);
1149 while (mac_isgraph(*s) && *s != ':')
1150   {
1151   if (ptr < max-1) name[ptr++] = *s;
1152   s++;
1153   }
1154 if (*s == ':') s++;
1155 name[ptr++] = ':';
1156 name[ptr] = 0;
1157 return s;
1158 }
1159
1160
1161
1162 /*************************************************
1163 *           Pick out a number from a string      *
1164 *************************************************/
1165
1166 /* Arguments:
1167   n     points to an integer into which to put the number
1168   s     points to the first digit of the number
1169
1170 Returns:  a pointer to the character after the last digit
1171 */
1172 /*XXX consider expanding to int_eximarith_t.  But the test for
1173 "overbig numbers" in 0002 still needs to overflow it. */
1174
1175 static uschar *
1176 read_number(int *n, uschar *s)
1177 {
1178 *n = 0;
1179 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1180 return s;
1181 }
1182
1183 static const uschar *
1184 read_cnumber(int *n, const uschar *s)
1185 {
1186 *n = 0;
1187 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1188 return s;
1189 }
1190
1191
1192
1193 /*************************************************
1194 *        Extract keyed subfield from a string    *
1195 *************************************************/
1196
1197 /* The yield is in dynamic store; NULL means that the key was not found.
1198
1199 Arguments:
1200   key       points to the name of the key
1201   s         points to the string from which to extract the subfield
1202
1203 Returns:    NULL if the subfield was not found, or
1204             a pointer to the subfield's data
1205 */
1206
1207 uschar *
1208 expand_getkeyed(const uschar * key, const uschar * s)
1209 {
1210 int length = Ustrlen(key);
1211 Uskip_whitespace(&s);
1212
1213 /* Loop to search for the key */
1214
1215 while (*s)
1216   {
1217   int dkeylength;
1218   uschar * data;
1219   const uschar * dkey = s;
1220
1221   while (*s && *s != '=' && !isspace(*s)) s++;
1222   dkeylength = s - dkey;
1223   if (Uskip_whitespace(&s) == '=')
1224     while (isspace(*++s)) ;
1225
1226   data = string_dequote(&s);
1227   if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1228     return data;
1229
1230   Uskip_whitespace(&s);
1231   }
1232
1233 return NULL;
1234 }
1235
1236
1237
1238 static var_entry *
1239 find_var_ent(uschar * name, var_entry * table, unsigned nent)
1240 {
1241 int first = 0;
1242 int last = nent;
1243
1244 while (last > first)
1245   {
1246   int middle = (first + last)/2;
1247   int c = Ustrcmp(name, table[middle].name);
1248
1249   if (c > 0) { first = middle + 1; continue; }
1250   if (c < 0) { last = middle; continue; }
1251   return &table[middle];
1252   }
1253 return NULL;
1254 }
1255
1256 /*************************************************
1257 *   Extract numbered subfield from string        *
1258 *************************************************/
1259
1260 /* Extracts a numbered field from a string that is divided by tokens - for
1261 example a line from /etc/passwd is divided by colon characters.  First field is
1262 numbered one.  Negative arguments count from the right. Zero returns the whole
1263 string. Returns NULL if there are insufficient tokens in the string
1264
1265 ***WARNING***
1266 Modifies final argument - this is a dynamically generated string, so that's OK.
1267
1268 Arguments:
1269   field       number of field to be extracted,
1270                 first field = 1, whole string = 0, last field = -1
1271   separators  characters that are used to break string into tokens
1272   s           points to the string from which to extract the subfield
1273
1274 Returns:      NULL if the field was not found,
1275               a pointer to the field's data inside s (modified to add 0)
1276 */
1277
1278 static uschar *
1279 expand_gettokened (int field, uschar *separators, uschar *s)
1280 {
1281 int sep = 1;
1282 int count;
1283 uschar *ss = s;
1284 uschar *fieldtext = NULL;
1285
1286 if (field == 0) return s;
1287
1288 /* Break the line up into fields in place; for field > 0 we stop when we have
1289 done the number of fields we want. For field < 0 we continue till the end of
1290 the string, counting the number of fields. */
1291
1292 count = (field > 0)? field : INT_MAX;
1293
1294 while (count-- > 0)
1295   {
1296   size_t len;
1297
1298   /* Previous field was the last one in the string. For a positive field
1299   number, this means there are not enough fields. For a negative field number,
1300   check that there are enough, and scan back to find the one that is wanted. */
1301
1302   if (sep == 0)
1303     {
1304     if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1305     if ((-field) == (INT_MAX - count - 1)) return s;
1306     while (field++ < 0)
1307       {
1308       ss--;
1309       while (ss[-1] != 0) ss--;
1310       }
1311     fieldtext = ss;
1312     break;
1313     }
1314
1315   /* Previous field was not last in the string; save its start and put a
1316   zero at its end. */
1317
1318   fieldtext = ss;
1319   len = Ustrcspn(ss, separators);
1320   sep = ss[len];
1321   ss[len] = 0;
1322   ss += len + 1;
1323   }
1324
1325 return fieldtext;
1326 }
1327
1328
1329 static uschar *
1330 expand_getlistele(int field, const uschar * list)
1331 {
1332 const uschar * tlist = list;
1333 int sep = 0;
1334 /* Tainted mem for the throwaway element copies */
1335 uschar * dummy = store_get(2, GET_TAINTED);
1336
1337 if (field < 0)
1338   {
1339   for (field++; string_nextinlist(&tlist, &sep, dummy, 1); ) field++;
1340   sep = 0;
1341   }
1342 if (field == 0) return NULL;
1343 while (--field > 0 && (string_nextinlist(&list, &sep, dummy, 1))) ;
1344 return string_nextinlist(&list, &sep, NULL, 0);
1345 }
1346
1347
1348 /* Certificate fields, by name.  Worry about by-OID later */
1349 /* Names are chosen to not have common prefixes */
1350
1351 #ifndef DISABLE_TLS
1352 typedef struct
1353 {
1354 uschar * name;
1355 int      namelen;
1356 uschar * (*getfn)(void * cert, uschar * mod);
1357 } certfield;
1358 static certfield certfields[] =
1359 {                       /* linear search; no special order */
1360   { US"version",         7,  &tls_cert_version },
1361   { US"serial_number",   13, &tls_cert_serial_number },
1362   { US"subject",         7,  &tls_cert_subject },
1363   { US"notbefore",       9,  &tls_cert_not_before },
1364   { US"notafter",        8,  &tls_cert_not_after },
1365   { US"issuer",          6,  &tls_cert_issuer },
1366   { US"signature",       9,  &tls_cert_signature },
1367   { US"sig_algorithm",   13, &tls_cert_signature_algorithm },
1368   { US"subj_altname",    12, &tls_cert_subject_altname },
1369   { US"ocsp_uri",        8,  &tls_cert_ocsp_uri },
1370   { US"crl_uri",         7,  &tls_cert_crl_uri },
1371 };
1372
1373 static uschar *
1374 expand_getcertele(uschar * field, uschar * certvar)
1375 {
1376 var_entry * vp;
1377
1378 if (!(vp = find_var_ent(certvar, var_table, nelem(var_table))))
1379   {
1380   expand_string_message =
1381     string_sprintf("no variable named \"%s\"", certvar);
1382   return NULL;          /* Unknown variable name */
1383   }
1384 /* NB this stops us passing certs around in variable.  Might
1385 want to do that in future */
1386 if (vp->type != vtype_cert)
1387   {
1388   expand_string_message =
1389     string_sprintf("\"%s\" is not a certificate", certvar);
1390   return NULL;          /* Unknown variable name */
1391   }
1392 if (!*(void **)vp->value)
1393   return NULL;
1394
1395 if (*field >= '0' && *field <= '9')
1396   return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1397
1398 for (certfield * cp = certfields;
1399      cp < certfields + nelem(certfields);
1400      cp++)
1401   if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1402     {
1403     uschar * modifier = *(field += cp->namelen) == ','
1404       ? ++field : NULL;
1405     return (*cp->getfn)( *(void **)vp->value, modifier );
1406     }
1407
1408 expand_string_message =
1409   string_sprintf("bad field selector \"%s\" for certextract", field);
1410 return NULL;
1411 }
1412 #endif  /*DISABLE_TLS*/
1413
1414 /*************************************************
1415 *        Extract a substring from a string       *
1416 *************************************************/
1417
1418 /* Perform the ${substr or ${length expansion operations.
1419
1420 Arguments:
1421   subject     the input string
1422   value1      the offset from the start of the input string to the start of
1423                 the output string; if negative, count from the right.
1424   value2      the length of the output string, or negative (-1) for unset
1425                 if value1 is positive, unset means "all after"
1426                 if value1 is negative, unset means "all before"
1427   len         set to the length of the returned string
1428
1429 Returns:      pointer to the output string, or NULL if there is an error
1430 */
1431
1432 static uschar *
1433 extract_substr(uschar *subject, int value1, int value2, int *len)
1434 {
1435 int sublen = Ustrlen(subject);
1436
1437 if (value1 < 0)    /* count from right */
1438   {
1439   value1 += sublen;
1440
1441   /* If the position is before the start, skip to the start, and adjust the
1442   length. If the length ends up negative, the substring is null because nothing
1443   can precede. This falls out naturally when the length is unset, meaning "all
1444   to the left". */
1445
1446   if (value1 < 0)
1447     {
1448     value2 += value1;
1449     if (value2 < 0) value2 = 0;
1450     value1 = 0;
1451     }
1452
1453   /* Otherwise an unset length => characters before value1 */
1454
1455   else if (value2 < 0)
1456     {
1457     value2 = value1;
1458     value1 = 0;
1459     }
1460   }
1461
1462 /* For a non-negative offset, if the starting position is past the end of the
1463 string, the result will be the null string. Otherwise, an unset length means
1464 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1465
1466 else
1467   {
1468   if (value1 > sublen)
1469     {
1470     value1 = sublen;
1471     value2 = 0;
1472     }
1473   else if (value2 < 0) value2 = sublen;
1474   }
1475
1476 /* Cut the length down to the maximum possible for the offset value, and get
1477 the required characters. */
1478
1479 if (value1 + value2 > sublen) value2 = sublen - value1;
1480 *len = value2;
1481 return subject + value1;
1482 }
1483
1484
1485
1486
1487 /*************************************************
1488 *            Old-style hash of a string          *
1489 *************************************************/
1490
1491 /* Perform the ${hash expansion operation.
1492
1493 Arguments:
1494   subject     the input string (an expanded substring)
1495   value1      the length of the output string; if greater or equal to the
1496                 length of the input string, the input string is returned
1497   value2      the number of hash characters to use, or 26 if negative
1498   len         set to the length of the returned string
1499
1500 Returns:      pointer to the output string, or NULL if there is an error
1501 */
1502
1503 static uschar *
1504 compute_hash(uschar *subject, int value1, int value2, int *len)
1505 {
1506 int sublen = Ustrlen(subject);
1507
1508 if (value2 < 0) value2 = 26;
1509 else if (value2 > Ustrlen(hashcodes))
1510   {
1511   expand_string_message =
1512     string_sprintf("hash count \"%d\" too big", value2);
1513   return NULL;
1514   }
1515
1516 /* Calculate the hash text. We know it is shorter than the original string, so
1517 can safely place it in subject[] (we know that subject is always itself an
1518 expanded substring). */
1519
1520 if (value1 < sublen)
1521   {
1522   int c;
1523   int i = 0;
1524   int j = value1;
1525   while ((c = (subject[j])) != 0)
1526     {
1527     int shift = (c + j++) & 7;
1528     subject[i] ^= (c << shift) | (c >> (8-shift));
1529     if (++i >= value1) i = 0;
1530     }
1531   for (i = 0; i < value1; i++)
1532     subject[i] = hashcodes[(subject[i]) % value2];
1533   }
1534 else value1 = sublen;
1535
1536 *len = value1;
1537 return subject;
1538 }
1539
1540
1541
1542
1543 /*************************************************
1544 *             Numeric hash of a string           *
1545 *************************************************/
1546
1547 /* Perform the ${nhash expansion operation. The first characters of the
1548 string are treated as most important, and get the highest prime numbers.
1549
1550 Arguments:
1551   subject     the input string
1552   value1      the maximum value of the first part of the result
1553   value2      the maximum value of the second part of the result,
1554                 or negative to produce only a one-part result
1555   len         set to the length of the returned string
1556
1557 Returns:  pointer to the output string, or NULL if there is an error.
1558 */
1559
1560 static uschar *
1561 compute_nhash (uschar *subject, int value1, int value2, int *len)
1562 {
1563 uschar *s = subject;
1564 int i = 0;
1565 unsigned long int total = 0; /* no overflow */
1566
1567 while (*s != 0)
1568   {
1569   if (i == 0) i = nelem(prime) - 1;
1570   total += prime[i--] * (unsigned int)(*s++);
1571   }
1572
1573 /* If value2 is unset, just compute one number */
1574
1575 if (value2 < 0)
1576   s = string_sprintf("%lu", total % value1);
1577
1578 /* Otherwise do a div/mod hash */
1579
1580 else
1581   {
1582   total = total % (value1 * value2);
1583   s = string_sprintf("%lu/%lu", total/value2, total % value2);
1584   }
1585
1586 *len = Ustrlen(s);
1587 return s;
1588 }
1589
1590
1591
1592
1593
1594 /*************************************************
1595 *     Find the value of a header or headers      *
1596 *************************************************/
1597
1598 /* Multiple instances of the same header get concatenated, and this function
1599 can also return a concatenation of all the header lines. When concatenating
1600 specific headers that contain lists of addresses, a comma is inserted between
1601 them. Otherwise we use a straight concatenation. Because some messages can have
1602 pathologically large number of lines, there is a limit on the length that is
1603 returned.
1604
1605 Arguments:
1606   name          the name of the header, without the leading $header_ or $h_,
1607                 or NULL if a concatenation of all headers is required
1608   newsize       return the size of memory block that was obtained; may be NULL
1609                 if exists_only is TRUE
1610   flags         FH_EXISTS_ONLY
1611                   set if called from a def: test; don't need to build a string;
1612                   just return a string that is not "" and not "0" if the header
1613                   exists
1614                 FH_WANT_RAW
1615                   set if called for $rh_ or $rheader_ items; no processing,
1616                   other than concatenating, will be done on the header. Also used
1617                   for $message_headers_raw.
1618                 FH_WANT_LIST
1619                   Double colon chars in the content, and replace newline with
1620                   colon between each element when concatenating; returning a
1621                   colon-sep list (elements might contain newlines)
1622   charset       name of charset to translate MIME words to; used only if
1623                 want_raw is false; if NULL, no translation is done (this is
1624                 used for $bh_ and $bheader_)
1625
1626 Returns:        NULL if the header does not exist, else a pointer to a new
1627                 store block
1628 */
1629
1630 static uschar *
1631 find_header(uschar * name, int * newsize, unsigned flags, const uschar * charset)
1632 {
1633 BOOL found = !name;
1634 int len = name ? Ustrlen(name) : 0;
1635 BOOL comma = FALSE;
1636 gstring * g = NULL;
1637 uschar * rawhdr;
1638
1639 for (header_line * h = header_list; h; h = h->next)
1640   if (h->type != htype_old && h->text)  /* NULL => Received: placeholder */
1641     if (!name || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1642       {
1643       uschar * s, * t;
1644       size_t inc;
1645
1646       if (flags & FH_EXISTS_ONLY)
1647         return US"1";  /* don't need actual string */
1648
1649       found = TRUE;
1650       s = h->text + len;                /* text to insert */
1651       if (!(flags & FH_WANT_RAW))       /* unless wanted raw, */
1652         Uskip_whitespace(&s);           /* remove leading white space */
1653       t = h->text + h->slen;            /* end-point */
1654
1655       /* Unless wanted raw, remove trailing whitespace, including the
1656       newline. */
1657
1658       if (flags & FH_WANT_LIST)
1659         while (t > s && t[-1] == '\n') t--;
1660       else if (!(flags & FH_WANT_RAW))
1661         {
1662         while (t > s && isspace(t[-1])) t--;
1663
1664         /* Set comma if handling a single header and it's one of those
1665         that contains an address list, except when asked for raw headers. Only
1666         need to do this once. */
1667
1668         if (name && !comma && Ustrchr("BCFRST", h->type)) comma = TRUE;
1669         }
1670
1671       /* Trim the header roughly if we're approaching limits */
1672       inc = t - s;
1673       if (gstring_length(g) + inc > header_insert_maxlen)
1674         inc = header_insert_maxlen - gstring_length(g);
1675
1676       /* For raw just copy the data; for a list, add the data as a colon-sep
1677       list-element; for comma-list add as an unchecked comma,newline sep
1678       list-elemment; for other nonraw add as an unchecked newline-sep list (we
1679       stripped trailing WS above including the newline). We ignore the potential
1680       expansion due to colon-doubling, just leaving the loop if the limit is met
1681       or exceeded. */
1682
1683       if (flags & FH_WANT_LIST)
1684         g = string_append_listele_n(g, ':', s, (unsigned)inc);
1685       else if (flags & FH_WANT_RAW)
1686         g = string_catn(g, s, (unsigned)inc);
1687       else if (inc > 0)
1688         g = string_append2_listele_n(g, comma ? US",\n" : US"\n",
1689           s, (unsigned)inc);
1690
1691       if (gstring_length(g) >= header_insert_maxlen) break;
1692       }
1693
1694 if (!found) return NULL;        /* No header found */
1695 if (!g) return US"";
1696
1697 /* That's all we do for raw header expansion. */
1698
1699 *newsize = g->size;
1700 rawhdr = string_from_gstring(g);
1701 if (flags & FH_WANT_RAW)
1702   return rawhdr;
1703
1704 /* Otherwise do RFC 2047 decoding, translating the charset if requested.
1705 The rfc2047_decode2() function can return an error with decoded data if the
1706 charset translation fails. If decoding fails, it returns NULL. */
1707
1708 else
1709   {
1710   uschar * error, * decoded = rfc2047_decode2(rawhdr,
1711     check_rfc2047_length, charset, '?', NULL, newsize, &error);
1712   if (error)
1713     DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1714       "    input was: %s\n", error, rawhdr);
1715   return decoded ? decoded : rawhdr;
1716   }
1717 }
1718
1719
1720
1721
1722 /* Append a "local" element to an Authentication-Results: header
1723 if this was a non-smtp message.
1724 */
1725
1726 static gstring *
1727 authres_local(gstring * g, const uschar * sysname)
1728 {
1729 if (!f.authentication_local)
1730   return g;
1731 g = string_append(g, 3, US";\n\tlocal=pass (non-smtp, ", sysname, US")");
1732 if (authenticated_id) g = string_append(g, 2, " u=", authenticated_id);
1733 return g;
1734 }
1735
1736
1737 /* Append an "iprev" element to an Authentication-Results: header
1738 if we have attempted to get the calling host's name.
1739 */
1740
1741 static gstring *
1742 authres_iprev(gstring * g)
1743 {
1744 if (sender_host_name)
1745   g = string_append(g, 3, US";\n\tiprev=pass (", sender_host_name, US")");
1746 else if (host_lookup_deferred)
1747   g = string_cat(g, US";\n\tiprev=temperror");
1748 else if (host_lookup_failed)
1749   g = string_cat(g, US";\n\tiprev=fail");
1750 else
1751   return g;
1752
1753 if (sender_host_address)
1754   g = string_append(g, 2, US" smtp.remote-ip=", sender_host_address);
1755 return g;
1756 }
1757
1758
1759
1760 /*************************************************
1761 *               Return list of recipients        *
1762 *************************************************/
1763 /* A recipients list is available only during system message filtering,
1764 during ACL processing after DATA, and while expanding pipe commands
1765 generated from a system filter, but not elsewhere.  Note that this does
1766 not check for commas in the elements, and uses comma-space as seperator -
1767 so cannot be used as an exim list as-is. */
1768
1769 static uschar *
1770 fn_recipients(void)
1771 {
1772 gstring * g = NULL;
1773
1774 if (!f.enable_dollar_recipients) return NULL;
1775
1776 for (int i = 0; i < recipients_count; i++)
1777   {
1778   const uschar * s = recipients_list[i].address;
1779   g = string_append2_listele_n(g, US", ", s, Ustrlen(s));
1780   }
1781 gstring_release_unused(g);
1782 return string_from_gstring(g);
1783 }
1784
1785 /* Similar, but as a properly-quoted exim list */
1786
1787
1788 static uschar *
1789 fn_recipients_list(void)
1790 {
1791 gstring * g = NULL;
1792
1793 if (!f.enable_dollar_recipients) return NULL;
1794
1795 for (int i = 0; i < recipients_count; i++)
1796   g = string_append_listele(g, ':', recipients_list[i].address);
1797 gstring_release_unused(g);
1798 return string_from_gstring(g);
1799 }
1800
1801
1802 /*************************************************
1803 *               Return size of queue             *
1804 *************************************************/
1805 /* Ask the daemon for the queue size */
1806
1807 static uschar *
1808 fn_queue_size(void)
1809 {
1810 struct sockaddr_un sa_un = {.sun_family = AF_UNIX};
1811 uschar buf[16];
1812 int fd;
1813 ssize_t len;
1814 const uschar * where;
1815 uschar * sname;
1816
1817 if ((fd = socket(AF_UNIX, SOCK_DGRAM, 0)) < 0)
1818   {
1819   DEBUG(D_expand) debug_printf(" socket: %s\n", strerror(errno));
1820   return NULL;
1821   }
1822
1823 len = daemon_client_sockname(&sa_un, &sname);
1824
1825 if (bind(fd, (const struct sockaddr *)&sa_un, (socklen_t)len) < 0)
1826   { where = US"bind"; goto bad; }
1827
1828 #ifdef notdef
1829 debug_printf("local addr '%s%s'\n",
1830   *sa_un.sun_path ? "" : "@",
1831   sa_un.sun_path + (*sa_un.sun_path ? 0 : 1));
1832 #endif
1833
1834 len = daemon_notifier_sockname(&sa_un);
1835 if (connect(fd, (const struct sockaddr *)&sa_un, len) < 0)
1836   { where = US"connect"; goto bad2; }
1837
1838 buf[0] = NOTIFY_QUEUE_SIZE_REQ;
1839 if (send(fd, buf, 1, 0) < 0) { where = US"send"; goto bad; }
1840
1841 if (poll_one_fd(fd, POLLIN, 2 * 1000) != 1)
1842   {
1843   DEBUG(D_expand) debug_printf("no daemon response; using local evaluation\n");
1844   len = snprintf(CS buf, sizeof(buf), "%u", queue_count_cached());
1845   }
1846 else if ((len = recv(fd, buf, sizeof(buf), 0)) < 0)
1847   { where = US"recv"; goto bad2; }
1848
1849 close(fd);
1850 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1851 Uunlink(sname);
1852 #endif
1853 return string_copyn(buf, len);
1854
1855 bad2:
1856 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1857   Uunlink(sname);
1858 #endif
1859 bad:
1860   close(fd);
1861   DEBUG(D_expand) debug_printf(" %s: %s\n", where, strerror(errno));
1862   return NULL;
1863 }
1864
1865
1866 /*************************************************
1867 *               Find value of a variable         *
1868 *************************************************/
1869
1870 /* The table of variables is kept in alphabetic order, so we can search it
1871 using a binary chop. The "choplen" variable is nothing to do with the binary
1872 chop.
1873
1874 Arguments:
1875   name          the name of the variable being sought
1876   flags
1877     exists_only  TRUE if this is a def: test; passed on to find_header()
1878     skipping     TRUE => skip any processing evaluation; this is not the same as
1879                   exists_only because def: may test for values that are first
1880                   evaluated here
1881   newsize       pointer to an int which is initially zero; if the answer is in
1882                 a new memory buffer, *newsize is set to its size
1883
1884 Returns:        NULL if the variable does not exist, or
1885                 a pointer to the variable's contents, or
1886                 something non-NULL if exists_only is TRUE
1887 */
1888
1889 static const uschar *
1890 find_variable(uschar * name, esi_flags flags, int * newsize)
1891 {
1892 var_entry * vp;
1893 uschar * s, * domain;
1894 uschar ** ss;
1895 void * val;
1896 var_entry * table = var_table;
1897 unsigned table_count = nelem(var_table);
1898
1899 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1900 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1901 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1902 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1903 (this gave backwards compatibility at the changeover). There may be built-in
1904 variables whose names start acl_ but they should never start in this way. This
1905 slightly messy specification is a consequence of the history, needless to say.
1906
1907 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1908 set, in which case give an error. */
1909
1910 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1911      !isalpha(name[5]))
1912   {
1913   tree_node * node =
1914     tree_search(name[4] == 'c' ? acl_var_c : acl_var_m, name + 4);
1915   return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1916   }
1917 else if (Ustrncmp(name, "r_", 2) == 0)
1918   {
1919   tree_node * node = tree_search(router_var, name + 2);
1920   return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1921   }
1922
1923 /* Handle $auth<n>, $regex<n> variables. */
1924
1925 if (Ustrncmp(name, "auth", 4) == 0)
1926   {
1927   uschar *endptr;
1928   int n = Ustrtoul(name + 4, &endptr, 10);
1929   if (!*endptr && n != 0 && n <= AUTH_VARS)
1930     return auth_vars[n-1] ? auth_vars[n-1] : US"";
1931   }
1932 #ifdef WITH_CONTENT_SCAN
1933 else if (Ustrncmp(name, "regex", 5) == 0)
1934   {
1935   uschar *endptr;
1936   int n = Ustrtoul(name + 5, &endptr, 10);
1937   if (!*endptr && n != 0 && n <= REGEX_VARS)
1938     return regex_vars[n-1] ? regex_vars[n-1] : US"";
1939   }
1940 #endif
1941
1942 sublist:
1943
1944 /* For all other variables, search the table */
1945
1946 if (!(vp = find_var_ent(name, table, table_count)))
1947   return NULL;          /* Unknown variable name */
1948
1949 /* Found an existing variable. If in skipping state, the value isn't needed,
1950 and we want to avoid processing (such as looking up the host name). */
1951
1952 if (flags & ESI_SKIPPING)
1953   return US"";
1954
1955 val = vp->value;
1956 switch (vp->type)
1957   {
1958   case vtype_filter_int:
1959     if (!f.filter_running) return NULL;
1960     /* Fall through */
1961     /* VVVVVVVVVVVV */
1962   case vtype_int:
1963     sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1964     return var_buffer;
1965
1966   case vtype_ino:
1967     sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1968     return var_buffer;
1969
1970   case vtype_gid:
1971     sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1972     return var_buffer;
1973
1974   case vtype_uid:
1975     sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1976     return var_buffer;
1977
1978   case vtype_bool:
1979     sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1980     return var_buffer;
1981
1982   case vtype_stringptr:                      /* Pointer to string */
1983     return (s = *((uschar **)(val))) ? s : US"";
1984
1985   case vtype_pid:
1986     sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1987     return var_buffer;
1988
1989   case vtype_load_avg:
1990     sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1991     return var_buffer;
1992
1993   case vtype_host_lookup:                    /* Lookup if not done so */
1994     if (  !sender_host_name && sender_host_address
1995        && !host_lookup_failed && host_name_lookup() == OK)
1996       host_build_sender_fullhost();
1997     return sender_host_name ? sender_host_name : US"";
1998
1999   case vtype_localpart:                      /* Get local part from address */
2000     if (!(s = *((uschar **)(val)))) return US"";
2001     if (!(domain = Ustrrchr(s, '@'))) return s;
2002     if (domain - s > sizeof(var_buffer) - 1)
2003       log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
2004           " in string expansion", sizeof(var_buffer));
2005     return string_copyn(s, domain - s);
2006
2007   case vtype_domain:                         /* Get domain from address */
2008     if (!(s = *((uschar **)(val)))) return US"";
2009     domain = Ustrrchr(s, '@');
2010     return domain ? domain + 1 : US"";
2011
2012   case vtype_msgheaders:
2013     return find_header(NULL, newsize,
2014             flags & ESI_EXISTS_ONLY ? FH_EXISTS_ONLY : 0, NULL);
2015
2016   case vtype_msgheaders_raw:
2017     return find_header(NULL, newsize,
2018             flags & ESI_EXISTS_ONLY ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2019             NULL);
2020
2021   case vtype_msgbody:                        /* Pointer to msgbody string */
2022   case vtype_msgbody_end:                    /* Ditto, the end of the msg */
2023     ss = (uschar **)(val);
2024     if (!*ss && deliver_datafile >= 0)  /* Read body when needed */
2025       {
2026       uschar * body;
2027       off_t start_offset_o = spool_data_start_offset(message_id);
2028       off_t start_offset = start_offset_o;
2029       int len = message_body_visible;
2030
2031       if (len > message_size) len = message_size;
2032       *ss = body = store_get(len+1, GET_TAINTED);
2033       body[0] = 0;
2034       if (vp->type == vtype_msgbody_end)
2035         {
2036         struct stat statbuf;
2037         if (fstat(deliver_datafile, &statbuf) == 0)
2038           {
2039           start_offset = statbuf.st_size - len;
2040           if (start_offset < start_offset_o)
2041             start_offset = start_offset_o;
2042           }
2043         }
2044       if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)
2045         log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",
2046           strerror(errno));
2047       if ((len = read(deliver_datafile, body, len)) > 0)
2048         {
2049         body[len] = 0;
2050         if (message_body_newlines)   /* Separate loops for efficiency */
2051           while (len > 0)
2052             { if (body[--len] == 0) body[len] = ' '; }
2053         else
2054           while (len > 0)
2055             { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
2056         }
2057       }
2058     return *ss ? *ss : US"";
2059
2060   case vtype_todbsdin:                       /* BSD inbox time of day */
2061     return tod_stamp(tod_bsdin);
2062
2063   case vtype_tode:                           /* Unix epoch time of day */
2064     return tod_stamp(tod_epoch);
2065
2066   case vtype_todel:                          /* Unix epoch/usec time of day */
2067     return tod_stamp(tod_epoch_l);
2068
2069   case vtype_todf:                           /* Full time of day */
2070     return tod_stamp(tod_full);
2071
2072   case vtype_todl:                           /* Log format time of day */
2073     return tod_stamp(tod_log_bare);            /* (without timezone) */
2074
2075   case vtype_todzone:                        /* Time zone offset only */
2076     return tod_stamp(tod_zone);
2077
2078   case vtype_todzulu:                        /* Zulu time */
2079     return tod_stamp(tod_zulu);
2080
2081   case vtype_todlf:                          /* Log file datestamp tod */
2082     return tod_stamp(tod_log_datestamp_daily);
2083
2084   case vtype_reply:                          /* Get reply address */
2085     s = find_header(US"reply-to:", newsize,
2086             flags & ESI_EXISTS_ONLY ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2087             headers_charset);
2088     if (s) Uskip_whitespace(&s);
2089     if (!s || !*s)
2090       {
2091       *newsize = 0;                            /* For the *s==0 case */
2092       s = find_header(US"from:", newsize,
2093             flags & ESI_EXISTS_ONLY ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2094             headers_charset);
2095       }
2096     if (s)
2097       {
2098       uschar *t;
2099       Uskip_whitespace(&s);
2100       for (t = s; *t; t++) if (*t == '\n') *t = ' ';
2101       while (t > s && isspace(t[-1])) t--;
2102       *t = 0;
2103       }
2104     return s ? s : US"";
2105
2106   case vtype_string_func:
2107     {
2108     stringptr_fn_t * fn = (stringptr_fn_t *) val;
2109     uschar * s = fn();
2110     return s ? s : US"";
2111     }
2112
2113   case vtype_pspace:
2114     {
2115     int inodes;
2116     sprintf(CS var_buffer, PR_EXIM_ARITH,
2117       receive_statvfs(val == (void *)TRUE, &inodes));
2118     }
2119   return var_buffer;
2120
2121   case vtype_pinodes:
2122     {
2123     int inodes;
2124     (void) receive_statvfs(val == (void *)TRUE, &inodes);
2125     sprintf(CS var_buffer, "%d", inodes);
2126     }
2127   return var_buffer;
2128
2129   case vtype_cert:
2130     return *(void **)val ? US"<cert>" : US"";
2131
2132 #ifndef DISABLE_DKIM
2133   case vtype_dkim:
2134     return dkim_exim_expand_query((int)(long)val);
2135 #endif
2136
2137   case vtype_module:
2138     {
2139     uschar * errstr;
2140     misc_module_info * mi = misc_mod_find(val, &errstr);
2141     if (mi)
2142       {
2143       table = mi->variables;
2144       table_count = mi->variables_count;
2145       goto sublist;
2146       }
2147     log_write(0, LOG_MAIN|LOG_PANIC,
2148       "failed to find %s module for %s: %s", US val, name, errstr);
2149     return US"";
2150     }
2151   }
2152
2153 return NULL;  /* Unknown variable. Silences static checkers. */
2154 }
2155
2156
2157
2158
2159 void
2160 modify_variable(uschar *name, void * value)
2161 {
2162 var_entry * vp;
2163 if ((vp = find_var_ent(name, var_table, nelem(var_table))))
2164   vp->value = value;
2165 return;          /* Unknown variable name, fail silently */
2166 }
2167
2168
2169
2170
2171
2172
2173 /*************************************************
2174 *           Read and expand substrings           *
2175 *************************************************/
2176
2177 /* This function is called to read and expand argument substrings for various
2178 expansion items. Some have a minimum requirement that is less than the maximum;
2179 in these cases, the first non-present one is set to NULL.
2180
2181 Arguments:
2182   sub        points to vector of pointers to set
2183   n          maximum number of substrings
2184   m          minimum required
2185   sptr       points to current string pointer
2186   flags
2187    skipping   the skipping flag
2188   check_end  if TRUE, check for final '}'
2189   name       name of item, for error message
2190   resetok    if not NULL, pointer to flag - write FALSE if unsafe to reset
2191              the store
2192   textonly_p if not NULL, pointer to bitmask of which subs were text-only
2193              (did not change when expended)
2194
2195 Returns:     -1 OK; string pointer updated, but in "skipping" mode
2196              0 OK; string pointer updated
2197              1 curly bracketing error (too few arguments)
2198              2 too many arguments (only if check_end is set); message set
2199              3 other error (expansion failure)
2200 */
2201
2202 static int
2203 read_subs(uschar ** sub, int n, int m, const uschar ** sptr, esi_flags flags,
2204   BOOL check_end, uschar * name, BOOL * resetok, unsigned * textonly_p)
2205 {
2206 const uschar * s = *sptr;
2207 unsigned textonly_l = 0;
2208
2209 Uskip_whitespace(&s);
2210 for (int i = 0; i < n; i++)
2211   {
2212   BOOL textonly;
2213   if (*s != '{')
2214     {
2215     if (i < m)
2216       {
2217       expand_string_message = string_sprintf("Not enough arguments for '%s' "
2218         "(min is %d)", name, m);
2219       return 1;
2220       }
2221     sub[i] = NULL;
2222     break;
2223     }
2224   if (!(sub[i] = expand_string_internal(s+1,
2225           ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags & ESI_SKIPPING, &s, resetok,
2226           textonly_p ? &textonly : NULL)))
2227     return 3;
2228   if (*s++ != '}') return 1;
2229   if (textonly_p && textonly) textonly_l |= BIT(i);
2230   Uskip_whitespace(&s);
2231   }                                             /*{*/
2232 if (check_end && *s++ != '}')
2233   {
2234   if (s[-1] == '{')
2235     {
2236     expand_string_message = string_sprintf("Too many arguments for '%s' "
2237       "(max is %d)", name, n);
2238     return 2;
2239     }
2240   expand_string_message = string_sprintf("missing '}' after '%s'", name);
2241   return 1;
2242   }
2243
2244 if (textonly_p) *textonly_p = textonly_l;
2245 *sptr = s;
2246 return flags & ESI_SKIPPING ? -1 : 0;
2247 }
2248
2249
2250
2251
2252 /*************************************************
2253 *     Elaborate message for bad variable         *
2254 *************************************************/
2255
2256 /* For the "unknown variable" message, take a look at the variable's name, and
2257 give additional information about possible ACL variables. The extra information
2258 is added on to expand_string_message.
2259
2260 Argument:   the name of the variable
2261 Returns:    nothing
2262 */
2263
2264 static void
2265 check_variable_error_message(uschar *name)
2266 {
2267 if (Ustrncmp(name, "acl_", 4) == 0)
2268   expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2269     (name[4] == 'c' || name[4] == 'm')?
2270       (isalpha(name[5])?
2271         US"6th character of a user-defined ACL variable must be a digit or underscore" :
2272         US"strict_acl_vars is set"    /* Syntax is OK, it has to be this */
2273       ) :
2274       US"user-defined ACL variables must start acl_c or acl_m");
2275 }
2276
2277
2278
2279 /*
2280 Load args from sub array to globals, and call acl_check().
2281 Sub array will be corrupted on return.
2282
2283 Returns:       OK         access is granted by an ACCEPT verb
2284                DISCARD    access is (apparently) granted by a DISCARD verb
2285                FAIL       access is denied
2286                FAIL_DROP  access is denied; drop the connection
2287                DEFER      can't tell at the moment
2288                ERROR      disaster
2289 */
2290 static int
2291 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2292 {
2293 int i;
2294 int sav_narg = acl_narg;
2295 int ret;
2296 uschar * dummy_logmsg;
2297 extern int acl_where;
2298
2299 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2300 for (i = 0; i < nsub && sub[i+1]; i++)
2301   {
2302   uschar * tmp = acl_arg[i];
2303   acl_arg[i] = sub[i+1];        /* place callers args in the globals */
2304   sub[i+1] = tmp;               /* stash the old args using our caller's storage */
2305   }
2306 acl_narg = i;
2307 while (i < nsub)
2308   {
2309   sub[i+1] = acl_arg[i];
2310   acl_arg[i++] = NULL;
2311   }
2312
2313 DEBUG(D_expand)
2314   debug_printf_indent("expanding: acl: %s  arg: %s%s\n",
2315     sub[0],
2316     acl_narg>0 ? acl_arg[0] : US"<none>",
2317     acl_narg>1 ? " +more"   : "");
2318
2319 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2320
2321 for (i = 0; i < nsub; i++)
2322   acl_arg[i] = sub[i+1];        /* restore old args */
2323 acl_narg = sav_narg;
2324
2325 return ret;
2326 }
2327
2328
2329
2330
2331 /* Return pointer to dewrapped string, with enclosing specified chars removed.
2332 The given string is modified on return.  Leading whitespace is skipped while
2333 looking for the opening wrap character, then the rest is scanned for the trailing
2334 (non-escaped) wrap character.  A backslash in the string will act as an escape.
2335
2336 A nul is written over the trailing wrap, and a pointer to the char after the
2337 leading wrap is returned.
2338
2339 Arguments:
2340   s     String for de-wrapping
2341   wrap  Two-char string, the first being the opener, second the closer wrapping
2342         character
2343 Return:
2344   Pointer to de-wrapped string, or NULL on error (with expand_string_message set).
2345 */
2346
2347 static uschar *
2348 dewrap(uschar * s, const uschar * wrap)
2349 {
2350 uschar * p = s;
2351 unsigned depth = 0;
2352 BOOL quotesmode = wrap[0] == wrap[1];
2353
2354 if (Uskip_whitespace(&p) == *wrap)
2355   {
2356   s = ++p;
2357   wrap++;
2358   while (*p)
2359     {
2360     if (*p == '\\') p++;
2361     else if (!quotesmode && *p == wrap[-1]) depth++;
2362     else if (*p == *wrap)
2363       if (depth == 0)
2364         {
2365         *p = '\0';
2366         return s;
2367         }
2368       else
2369         depth--;
2370     p++;
2371     }
2372   }
2373 expand_string_message = string_sprintf("missing '%c'", *wrap);
2374 return NULL;
2375 }
2376
2377
2378 /* Pull off the leading array or object element, returning
2379 a copy in an allocated string.  Update the list pointer.
2380
2381 The element may itself be an abject or array.
2382 Return NULL when the list is empty.
2383 */
2384
2385 static uschar *
2386 json_nextinlist(const uschar ** list)
2387 {
2388 unsigned array_depth = 0, object_depth = 0;
2389 BOOL quoted = FALSE;
2390 const uschar * s = *list, * item;
2391
2392 skip_whitespace(&s);
2393
2394 for (item = s;
2395      *s && (*s != ',' || array_depth != 0 || object_depth != 0 || quoted);
2396      s++)
2397   if (!quoted) switch (*s)
2398     {
2399     case '[': array_depth++; break;
2400     case ']': array_depth--; break;
2401     case '{': object_depth++; break;
2402     case '}': object_depth--; break;
2403     case '"': quoted = TRUE;
2404     }
2405   else switch(*s)
2406     {
2407     case '\\': s++; break;              /* backslash protects one char */
2408     case '"':  quoted = FALSE; break;
2409     }
2410 *list = *s ? s+1 : s;
2411 if (item == s) return NULL;
2412 item = string_copyn(item, s - item);
2413 DEBUG(D_expand) debug_printf_indent("  json ele: '%s'\n", item);
2414 return US item;
2415 }
2416
2417
2418
2419 /************************************************/
2420 /*  Return offset in ops table, or -1 if not found.
2421 Repoint to just after the operator in the string.
2422
2423 Argument:
2424  ss     string representation of operator
2425  opname split-out operator name
2426 */
2427
2428 static int
2429 identify_operator(const uschar ** ss, uschar ** opname)
2430 {
2431 const uschar * s = *ss;
2432 uschar name[256];
2433
2434 /* Numeric comparisons are symbolic */
2435
2436 if (*s == '=' || *s == '>' || *s == '<')
2437   {
2438   int p = 0;
2439   name[p++] = *s++;
2440   if (*s == '=')
2441     {
2442     name[p++] = '=';
2443     s++;
2444     }
2445   name[p] = 0;
2446   }
2447
2448 /* All other conditions are named */
2449
2450 else
2451   s = read_name(name, sizeof(name), s, US"_");
2452 *ss = s;
2453
2454 /* If we haven't read a name, it means some non-alpha character is first. */
2455
2456 if (!name[0])
2457   {
2458   expand_string_message = string_sprintf("condition name expected, "
2459     "but found \"%.16s\"", s);
2460   return -1;
2461   }
2462 DEBUG(D_expand) debug_printf_indent("cond: %s\n", name);
2463 if (opname)
2464   *opname = string_copy(name);
2465
2466 return chop_match(name, cond_table, nelem(cond_table));
2467 }
2468
2469
2470 /*************************************************
2471 *    Handle MD5 or SHA-1 computation for HMAC    *
2472 *************************************************/
2473
2474 /* These are some wrapping functions that enable the HMAC code to be a bit
2475 cleaner. A good compiler will spot the tail recursion.
2476
2477 Arguments:
2478   type         HMAC_MD5 or HMAC_SHA1
2479   remaining    are as for the cryptographic hash functions
2480
2481 Returns:       nothing
2482 */
2483
2484 static void
2485 chash_start(int type, void * base)
2486 {
2487 if (type == HMAC_MD5)
2488   md5_start((md5 *)base);
2489 else
2490   sha1_start((hctx *)base);
2491 }
2492
2493 static void
2494 chash_mid(int type, void * base, const uschar * string)
2495 {
2496 if (type == HMAC_MD5)
2497   md5_mid((md5 *)base, string);
2498 else
2499   sha1_mid((hctx *)base, string);
2500 }
2501
2502 static void
2503 chash_end(int type, void * base, const uschar * string, int length,
2504   uschar * digest)
2505 {
2506 if (type == HMAC_MD5)
2507   md5_end((md5 *)base, string, length, digest);
2508 else
2509   sha1_end((hctx *)base, string, length, digest);
2510 }
2511
2512
2513
2514
2515 #ifdef SUPPORT_SRS
2516 /* Do an hmac_md5.  The result is _not_ nul-terminated, and is sized as
2517 the smaller of a full hmac_md5 result (16 bytes) or the supplied output buffer.
2518
2519 Arguments:
2520         key     encoding key, nul-terminated
2521         src     data to be hashed, nul-terminated
2522         buf     output buffer
2523         len     size of output buffer
2524 */
2525
2526 static void
2527 hmac_md5(const uschar * key, const uschar * src, uschar * buf, unsigned len)
2528 {
2529 md5 md5_base;
2530 const uschar * keyptr;
2531 uschar * p;
2532 unsigned int keylen;
2533
2534 #define MD5_HASHLEN      16
2535 #define MD5_HASHBLOCKLEN 64
2536
2537 uschar keyhash[MD5_HASHLEN];
2538 uschar innerhash[MD5_HASHLEN];
2539 uschar finalhash[MD5_HASHLEN];
2540 uschar innerkey[MD5_HASHBLOCKLEN];
2541 uschar outerkey[MD5_HASHBLOCKLEN];
2542
2543 keyptr = key;
2544 keylen = Ustrlen(keyptr);
2545
2546 /* If the key is longer than the hash block length, then hash the key
2547 first */
2548
2549 if (keylen > MD5_HASHBLOCKLEN)
2550   {
2551   chash_start(HMAC_MD5, &md5_base);
2552   chash_end(HMAC_MD5, &md5_base, keyptr, keylen, keyhash);
2553   keyptr = keyhash;
2554   keylen = MD5_HASHLEN;
2555   }
2556
2557 /* Now make the inner and outer key values */
2558
2559 memset(innerkey, 0x36, MD5_HASHBLOCKLEN);
2560 memset(outerkey, 0x5c, MD5_HASHBLOCKLEN);
2561
2562 for (int i = 0; i < keylen; i++)
2563   {
2564   innerkey[i] ^= keyptr[i];
2565   outerkey[i] ^= keyptr[i];
2566   }
2567
2568 /* Now do the hashes */
2569
2570 chash_start(HMAC_MD5, &md5_base);
2571 chash_mid(HMAC_MD5, &md5_base, innerkey);
2572 chash_end(HMAC_MD5, &md5_base, src, Ustrlen(src), innerhash);
2573
2574 chash_start(HMAC_MD5, &md5_base);
2575 chash_mid(HMAC_MD5, &md5_base, outerkey);
2576 chash_end(HMAC_MD5, &md5_base, innerhash, MD5_HASHLEN, finalhash);
2577
2578 /* Encode the final hash as a hex string, limited by output buffer size */
2579
2580 p = buf;
2581 for (int i = 0, j = len; i < MD5_HASHLEN; i++)
2582   {
2583   if (j-- <= 0) break;
2584   *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
2585   if (j-- <= 0) break;
2586   *p++ = hex_digits[finalhash[i] & 0x0f];
2587   }
2588 return;
2589 }
2590 #endif /*SUPPORT_SRS*/
2591
2592
2593 /*************************************************
2594 *        Read and evaluate a condition           *
2595 *************************************************/
2596
2597 /*
2598 Arguments:
2599   s        points to the start of the condition text
2600   resetok  points to a BOOL which is written false if it is unsafe to
2601            free memory. Certain condition types (acl) may have side-effect
2602            allocation which must be preserved.
2603   yield    points to a BOOL to hold the result of the condition test;
2604            if NULL, we are just reading through a condition that is
2605            part of an "or" combination to check syntax, or in a state
2606            where the answer isn't required
2607
2608 Returns:   a pointer to the first character after the condition, or
2609            NULL after an error
2610 */
2611
2612 static const uschar *
2613 eval_condition(const uschar * s, BOOL * resetok, BOOL * yield)
2614 {
2615 BOOL testfor = TRUE, tempcond, combined_cond;
2616 BOOL * subcondptr;
2617 BOOL sub2_honour_dollar = TRUE, is_forany, is_json, is_jsons;
2618 int rc, cond_type;
2619 int_eximarith_t num[2];
2620 struct stat statbuf;
2621 uschar * opname;
2622 uschar name[256];
2623 const uschar * sub[10], * next;
2624 unsigned sub_textonly = 0;
2625
2626 expand_level++;
2627 for (;;)
2628   if (Uskip_whitespace(&s) == '!') { testfor = !testfor; s++; } else break;
2629
2630 switch(cond_type = identify_operator(&s, &opname))
2631   {
2632   /* def: tests for a non-empty variable, or for the existence of a header. If
2633   yield == NULL we are in a skipping state, and don't care about the answer. */
2634
2635   case ECOND_DEF:
2636     {
2637     const uschar * t;
2638
2639     if (*s != ':')
2640       {
2641       expand_string_message = US"\":\" expected after \"def\"";
2642       goto failout;
2643       }
2644
2645     s = read_name(name, sizeof(name), s+1, US"_");
2646
2647     /* Test for a header's existence. If the name contains a closing brace
2648     character, this may be a user error where the terminating colon has been
2649     omitted. Set a flag to adjust a subsequent error message in this case. */
2650
2651     if (  ( *(t = name) == 'h'
2652           || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
2653           )
2654        && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
2655        )
2656       {
2657       s = read_header_name(name, sizeof(name), s);
2658       /* {-for-text-editors */
2659       if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2660       if (yield) *yield =
2661         (find_header(name, NULL, FH_EXISTS_ONLY, NULL) != NULL) == testfor;
2662       }
2663
2664     /* Test for a variable's having a non-empty value. A non-existent variable
2665     causes an expansion failure. */
2666
2667     else
2668       {
2669       if (!(t = find_variable(name,
2670         yield ? ESI_EXISTS_ONLY : ESI_EXISTS_ONLY | ESI_SKIPPING, NULL)))
2671         {
2672         expand_string_message = name[0]
2673           ? string_sprintf("unknown variable \"%s\" after \"def:\"", name)
2674           : US"variable name omitted after \"def:\"";
2675         check_variable_error_message(name);
2676         goto failout;
2677         }
2678       if (yield) *yield = (t[0] != 0) == testfor;
2679       }
2680
2681     next = s; goto out;
2682     }
2683
2684
2685   /* first_delivery tests for first delivery attempt */
2686
2687   case ECOND_FIRST_DELIVERY:
2688   if (yield) *yield = f.deliver_firsttime == testfor;
2689   next = s; goto out;
2690
2691
2692   /* queue_running tests for any process started by a queue runner */
2693
2694   case ECOND_QUEUE_RUNNING:
2695   if (yield) *yield = (queue_run_pid != (pid_t)0) == testfor;
2696   next = s; goto out;
2697
2698
2699   /* exists:  tests for file existence
2700        isip:  tests for any IP address
2701       isip4:  tests for an IPv4 address
2702       isip6:  tests for an IPv6 address
2703         pam:  does PAM authentication
2704      radius:  does RADIUS authentication
2705    ldapauth:  does LDAP authentication
2706     pwcheck:  does Cyrus SASL pwcheck authentication
2707   */
2708
2709   case ECOND_EXISTS:
2710   case ECOND_ISIP:
2711   case ECOND_ISIP4:
2712   case ECOND_ISIP6:
2713   case ECOND_PAM:
2714   case ECOND_RADIUS:
2715   case ECOND_LDAPAUTH:
2716   case ECOND_PWCHECK:
2717
2718   if (Uskip_whitespace(&s) != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2719
2720    {
2721     BOOL textonly;
2722     sub[0] = expand_string_internal(s+1,
2723       ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yield ? ESI_NOFLAGS : ESI_SKIPPING),
2724       &s, resetok, &textonly);
2725     if (!sub[0]) goto failout;
2726     if (textonly) sub_textonly |= BIT(0);
2727    }
2728   /* {-for-text-editors */
2729   if (*s++ != '}') goto COND_FAILED_CURLY_END;
2730
2731   if (!yield) { next = s; goto out; }  /* No need to run the test if skipping */
2732
2733   switch(cond_type)
2734     {
2735     case ECOND_EXISTS:
2736     if ((expand_forbid & RDO_EXISTS) != 0)
2737       {
2738       expand_string_message = US"File existence tests are not permitted";
2739       goto failout;
2740       }
2741     *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2742     break;
2743
2744     case ECOND_ISIP:
2745     case ECOND_ISIP4:
2746     case ECOND_ISIP6:
2747     {
2748       const uschar *errp;
2749       const uschar **errpp;
2750       DEBUG(D_expand) errpp = &errp; else errpp = 0;
2751       if (0 == (rc = string_is_ip_addressX(sub[0], NULL, errpp)))
2752         DEBUG(D_expand) debug_printf("failed: %s\n", errp);
2753
2754       *yield = ( cond_type == ECOND_ISIP  ? rc != 0 :
2755                  cond_type == ECOND_ISIP4 ? rc == 4 : rc == 6) == testfor;
2756     }
2757
2758     break;
2759
2760     /* Various authentication tests - all optionally compiled */
2761
2762     case ECOND_PAM:
2763     #ifdef SUPPORT_PAM
2764     rc = auth_call_pam(sub[0], &expand_string_message);
2765     goto END_AUTH;
2766     #else
2767     goto COND_FAILED_NOT_COMPILED;
2768     #endif  /* SUPPORT_PAM */
2769
2770     case ECOND_RADIUS:
2771     #ifdef RADIUS_CONFIG_FILE
2772     rc = auth_call_radius(sub[0], &expand_string_message);
2773     goto END_AUTH;
2774     #else
2775     goto COND_FAILED_NOT_COMPILED;
2776     #endif  /* RADIUS_CONFIG_FILE */
2777
2778     case ECOND_LDAPAUTH:
2779     #ifdef LOOKUP_LDAP
2780       {
2781       int expand_setup = -1;
2782       const lookup_info * li = search_findtype(US"ldapauth", 8);
2783       void * handle;
2784
2785       if (li && (handle = search_open(NULL, li, 0, NULL, NULL)))
2786         rc = search_find(handle, NULL, sub[0],
2787                         -1, NULL, 0, 0, &expand_setup, NULL)
2788           ? OK : f.search_find_defer ? DEFER : FAIL;
2789       else
2790         { expand_string_message = search_error_message; rc = FAIL; }
2791       }
2792     goto END_AUTH;
2793     #else
2794     goto COND_FAILED_NOT_COMPILED;
2795     #endif  /* LOOKUP_LDAP */
2796
2797     case ECOND_PWCHECK:
2798     #ifdef CYRUS_PWCHECK_SOCKET
2799     rc = auth_call_pwcheck(sub[0], &expand_string_message);
2800     goto END_AUTH;
2801     #else
2802     goto COND_FAILED_NOT_COMPILED;
2803     #endif  /* CYRUS_PWCHECK_SOCKET */
2804
2805     #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2806         defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2807     END_AUTH:
2808     if (rc == ERROR || rc == DEFER) goto failout;
2809     *yield = (rc == OK) == testfor;
2810     #endif
2811     }
2812   next = s; goto out;
2813
2814
2815   /* call ACL (in a conditional context).  Accept true, deny false.
2816   Defer is a forced-fail.  Anything set by message= goes to $value.
2817   Up to ten parameters are used; we use the braces round the name+args
2818   like the saslauthd condition does, to permit a variable number of args.
2819   See also the expansion-item version EITEM_ACL and the traditional
2820   acl modifier ACLC_ACL.
2821   Since the ACL may allocate new global variables, tell our caller to not
2822   reclaim memory.
2823   */
2824
2825   case ECOND_ACL:
2826     /* ${if acl {{name}{arg1}{arg2}...}  {yes}{no}} */
2827     {
2828     uschar *sub[10];
2829     uschar *user_msg;
2830     BOOL cond = FALSE;
2831
2832     Uskip_whitespace(&s);
2833     if (*s++ != '{') goto COND_FAILED_CURLY_START;      /*}*/
2834
2835     switch(read_subs(sub, nelem(sub), 1, &s,
2836         yield ? ESI_NOFLAGS : ESI_SKIPPING, TRUE, name, resetok, NULL))
2837       {
2838       case 1: expand_string_message = US"too few arguments or bracketing "
2839         "error for acl";
2840       case 2:
2841       case 3: goto failout;
2842       }
2843
2844     if (yield)
2845       {
2846       int rc;
2847       *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2848       switch(rc = eval_acl(sub, nelem(sub), &user_msg))
2849         {
2850         case OK:
2851           cond = TRUE;
2852         case FAIL:
2853           lookup_value = NULL;
2854           if (user_msg)
2855             lookup_value = string_copy(user_msg);
2856           *yield = cond == testfor;
2857           break;
2858
2859         case DEFER:
2860           f.expand_string_forcedfail = TRUE;
2861           /*FALLTHROUGH*/
2862         default:
2863           expand_string_message = string_sprintf("%s from acl \"%s\"",
2864             rc_names[rc], sub[0]);
2865           goto failout;
2866         }
2867       }
2868     next = s; goto out;
2869     }
2870
2871
2872   /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2873
2874      ${if saslauthd {{username}{password}{service}{realm}}  {yes}{no}}
2875
2876   However, the last two are optional. That is why the whole set is enclosed
2877   in their own set of braces. */
2878
2879   case ECOND_SASLAUTHD:
2880 #ifndef CYRUS_SASLAUTHD_SOCKET
2881     goto COND_FAILED_NOT_COMPILED;
2882 #else
2883     {
2884     uschar *sub[4];
2885     Uskip_whitespace(&s);
2886     if (*s++ != '{') goto COND_FAILED_CURLY_START;      /* }-for-text-editors */
2887     switch(read_subs(sub, nelem(sub), 2, &s,
2888         yield ? ESI_NOFLAGS : ESI_SKIPPING, TRUE, name, resetok, NULL))
2889       {
2890       case 1: expand_string_message = US"too few arguments or bracketing "
2891         "error for saslauthd";
2892       case 2:
2893       case 3: goto failout;
2894       }
2895     if (!sub[2]) sub[3] = NULL;  /* realm if no service */
2896     if (yield)
2897       {
2898       int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2899         &expand_string_message);
2900       if (rc == ERROR || rc == DEFER) goto failout;
2901       *yield = (rc == OK) == testfor;
2902       }
2903     next = s; goto out;
2904     }
2905 #endif /* CYRUS_SASLAUTHD_SOCKET */
2906
2907
2908   /* symbolic operators for numeric and string comparison, and a number of
2909   other operators, all requiring two arguments.
2910
2911   crypteq:           encrypts plaintext and compares against an encrypted text,
2912                        using crypt(), crypt16(), MD5 or SHA-1
2913   inlist/inlisti:    checks if first argument is in the list of the second
2914   match:             does a regular expression match and sets up the numerical
2915                        variables if it succeeds
2916   match_address:     matches in an address list
2917   match_domain:      matches in a domain list
2918   match_ip:          matches a host list that is restricted to IP addresses
2919   match_local_part:  matches in a local part list
2920   */
2921
2922   case ECOND_MATCH_ADDRESS:
2923   case ECOND_MATCH_DOMAIN:
2924   case ECOND_MATCH_IP:
2925   case ECOND_MATCH_LOCAL_PART:
2926 #ifndef EXPAND_LISTMATCH_RHS
2927     sub2_honour_dollar = FALSE;
2928 #endif
2929     /* FALLTHROUGH */
2930
2931   case ECOND_CRYPTEQ:
2932   case ECOND_INLIST:
2933   case ECOND_INLISTI:
2934   case ECOND_MATCH:
2935
2936   case ECOND_NUM_L:     /* Numerical comparisons */
2937   case ECOND_NUM_LE:
2938   case ECOND_NUM_E:
2939   case ECOND_NUM_EE:
2940   case ECOND_NUM_G:
2941   case ECOND_NUM_GE:
2942
2943   case ECOND_STR_LT:    /* String comparisons */
2944   case ECOND_STR_LTI:
2945   case ECOND_STR_LE:
2946   case ECOND_STR_LEI:
2947   case ECOND_STR_EQ:
2948   case ECOND_STR_EQI:
2949   case ECOND_STR_GT:
2950   case ECOND_STR_GTI:
2951   case ECOND_STR_GE:
2952   case ECOND_STR_GEI:
2953
2954   for (int i = 0; i < 2; i++)
2955     {
2956     BOOL textonly;
2957     /* Sometimes, we don't expand substrings; too many insecure configurations
2958     created using match_address{}{} and friends, where the second param
2959     includes information from untrustworthy sources. */
2960     /*XXX is this moot given taint-tracking? */
2961
2962     esi_flags flags = ESI_BRACE_ENDS;
2963
2964     if (!(i > 0 && !sub2_honour_dollar)) flags |= ESI_HONOR_DOLLAR;
2965     if (!yield) flags |= ESI_SKIPPING;
2966
2967     if (Uskip_whitespace(&s) != '{')
2968       {
2969       if (i == 0) goto COND_FAILED_CURLY_START;
2970       expand_string_message = string_sprintf("missing 2nd string in {} "
2971         "after \"%s\"", opname);
2972       goto failout;
2973       }
2974     if (!(sub[i] = expand_string_internal(s+1, flags, &s, resetok, &textonly)))
2975       goto failout;
2976     if (textonly) sub_textonly |= BIT(i);
2977     DEBUG(D_expand) if (i == 1 && !sub2_honour_dollar && Ustrchr(sub[1], '$'))
2978       debug_printf_indent("WARNING: the second arg is NOT expanded,"
2979                         " for security reasons\n");
2980     if (*s++ != '}') goto COND_FAILED_CURLY_END;
2981
2982     /* Convert to numerical if required; we know that the names of all the
2983     conditions that compare numbers do not start with a letter. This just saves
2984     checking for them individually. */
2985
2986     if (!isalpha(opname[0]) && yield)
2987       if (sub[i][0] == 0)
2988         {
2989         num[i] = 0;
2990         DEBUG(D_expand)
2991           debug_printf_indent("empty string cast to zero for numerical comparison\n");
2992         }
2993       else
2994         {
2995         num[i] = expanded_string_integer(sub[i], FALSE);
2996         if (expand_string_message) goto failout;
2997         }
2998     }
2999
3000   /* Result not required */
3001
3002   if (!yield) { next = s; goto out; }
3003
3004   /* Do an appropriate comparison */
3005
3006   switch(cond_type)
3007     {
3008     case ECOND_NUM_E:
3009     case ECOND_NUM_EE:
3010       tempcond = (num[0] == num[1]); break;
3011
3012     case ECOND_NUM_G:
3013       tempcond = (num[0] > num[1]); break;
3014
3015     case ECOND_NUM_GE:
3016       tempcond = (num[0] >= num[1]); break;
3017
3018     case ECOND_NUM_L:
3019       tempcond = (num[0] < num[1]); break;
3020
3021     case ECOND_NUM_LE:
3022       tempcond = (num[0] <= num[1]); break;
3023
3024     case ECOND_STR_LT:
3025       tempcond = (Ustrcmp(sub[0], sub[1]) < 0); break;
3026
3027     case ECOND_STR_LTI:
3028       tempcond = (strcmpic(sub[0], sub[1]) < 0); break;
3029
3030     case ECOND_STR_LE:
3031       tempcond = (Ustrcmp(sub[0], sub[1]) <= 0); break;
3032
3033     case ECOND_STR_LEI:
3034       tempcond = (strcmpic(sub[0], sub[1]) <= 0); break;
3035
3036     case ECOND_STR_EQ:
3037       tempcond = (Ustrcmp(sub[0], sub[1]) == 0); break;
3038
3039     case ECOND_STR_EQI:
3040       tempcond = (strcmpic(sub[0], sub[1]) == 0); break;
3041
3042     case ECOND_STR_GT:
3043       tempcond = (Ustrcmp(sub[0], sub[1]) > 0); break;
3044
3045     case ECOND_STR_GTI:
3046       tempcond = (strcmpic(sub[0], sub[1]) > 0); break;
3047
3048     case ECOND_STR_GE:
3049       tempcond = (Ustrcmp(sub[0], sub[1]) >= 0); break;
3050
3051     case ECOND_STR_GEI:
3052       tempcond = (strcmpic(sub[0], sub[1]) >= 0); break;
3053
3054     case ECOND_MATCH:   /* Regular expression match */
3055       {
3056       const pcre2_code * re = regex_compile(sub[1],
3057                   sub_textonly & BIT(1) ? MCS_CACHEABLE : MCS_NOFLAGS,
3058                   &expand_string_message, pcre_gen_cmp_ctx);
3059       if (!re)
3060         goto failout;
3061
3062       tempcond = regex_match_and_setup(re, sub[0], 0, -1);
3063       break;
3064       }
3065
3066     case ECOND_MATCH_ADDRESS:  /* Match in an address list */
3067       rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0,
3068                               CUSS &lookup_value);
3069       goto MATCHED_SOMETHING;
3070
3071     case ECOND_MATCH_DOMAIN:   /* Match in a domain list */
3072       rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
3073         MCL_DOMAIN + MCL_NOEXPAND, TRUE, CUSS &lookup_value);
3074       goto MATCHED_SOMETHING;
3075
3076     case ECOND_MATCH_IP:       /* Match IP address in a host list */
3077       if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
3078         {
3079         expand_string_message = string_sprintf("\"%s\" is not an IP address",
3080           sub[0]);
3081         goto failout;
3082         }
3083       else
3084         {
3085         unsigned int *nullcache = NULL;
3086         check_host_block cb;
3087
3088         cb.host_name = US"";
3089         cb.host_address = sub[0];
3090
3091         /* If the host address starts off ::ffff: it is an IPv6 address in
3092         IPv4-compatible mode. Find the IPv4 part for checking against IPv4
3093         addresses. */
3094
3095         cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
3096           cb.host_address + 7 : cb.host_address;
3097
3098         rc = match_check_list(
3099                &sub[1],                   /* the list */
3100                0,                         /* separator character */
3101                &hostlist_anchor,          /* anchor pointer */
3102                &nullcache,                /* cache pointer */
3103                check_host,                /* function for testing */
3104                &cb,                       /* argument for function */
3105                MCL_HOST,                  /* type of check */
3106                sub[0],                    /* text for debugging */
3107                CUSS &lookup_value);       /* where to pass back data */
3108         }
3109       goto MATCHED_SOMETHING;
3110
3111     case ECOND_MATCH_LOCAL_PART:
3112       rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
3113         MCL_LOCALPART + MCL_NOEXPAND, TRUE, CUSS &lookup_value);
3114       /* Fall through */
3115       /* VVVVVVVVVVVV */
3116       MATCHED_SOMETHING:
3117       switch(rc)
3118         {
3119         case OK:   tempcond = TRUE;  break;
3120         case FAIL: tempcond = FALSE; break;
3121
3122         case DEFER:
3123           expand_string_message = string_sprintf("unable to complete match "
3124             "against \"%s\": %s", sub[1], search_error_message);
3125           goto failout;
3126         }
3127
3128       break;
3129
3130     /* Various "encrypted" comparisons. If the second string starts with
3131     "{" then an encryption type is given. Default to crypt() or crypt16()
3132     (build-time choice). */
3133     /* }-for-text-editors */
3134
3135     case ECOND_CRYPTEQ:
3136     #ifndef SUPPORT_CRYPTEQ
3137       goto COND_FAILED_NOT_COMPILED;
3138     #else
3139       if (strncmpic(sub[1], US"{md5}", 5) == 0)
3140         {
3141         int sublen = Ustrlen(sub[1]+5);
3142         md5 base;
3143         uschar digest[16];
3144
3145         md5_start(&base);
3146         md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
3147
3148         /* If the length that we are comparing against is 24, the MD5 digest
3149         is expressed as a base64 string. This is the way LDAP does it. However,
3150         some other software uses a straightforward hex representation. We assume
3151         this if the length is 32. Other lengths fail. */
3152
3153         if (sublen == 24)
3154           {
3155           uschar *coded = b64encode(CUS digest, 16);
3156           DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
3157             "  subject=%s\n  crypted=%s\n", coded, sub[1]+5);
3158           tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
3159           }
3160         else if (sublen == 32)
3161           {
3162           uschar coded[36];
3163           for (int i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
3164           coded[32] = 0;
3165           DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
3166             "  subject=%s\n  crypted=%s\n", coded, sub[1]+5);
3167           tempcond = (strcmpic(coded, sub[1]+5) == 0);
3168           }
3169         else
3170           {
3171           DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
3172             "fail\n  crypted=%s\n", sub[1]+5);
3173           tempcond = FALSE;
3174           }
3175         }
3176
3177       else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
3178         {
3179         int sublen = Ustrlen(sub[1]+6);
3180         hctx h;
3181         uschar digest[20];
3182
3183         sha1_start(&h);
3184         sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
3185
3186         /* If the length that we are comparing against is 28, assume the SHA1
3187         digest is expressed as a base64 string. If the length is 40, assume a
3188         straightforward hex representation. Other lengths fail. */
3189
3190         if (sublen == 28)
3191           {
3192           uschar *coded = b64encode(CUS digest, 20);
3193           DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
3194             "  subject=%s\n  crypted=%s\n", coded, sub[1]+6);
3195           tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
3196           }
3197         else if (sublen == 40)
3198           {
3199           uschar coded[44];
3200           for (int i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
3201           coded[40] = 0;
3202           DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
3203             "  subject=%s\n  crypted=%s\n", coded, sub[1]+6);
3204           tempcond = (strcmpic(coded, sub[1]+6) == 0);
3205           }
3206         else
3207           {
3208           DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
3209             "fail\n  crypted=%s\n", sub[1]+6);
3210           tempcond = FALSE;
3211           }
3212         }
3213
3214       else   /* {crypt} or {crypt16} and non-{ at start */
3215              /* }-for-text-editors */
3216         {
3217         int which = 0;
3218         uschar *coded;
3219
3220         if (strncmpic(sub[1], US"{crypt}", 7) == 0)
3221           {
3222           sub[1] += 7;
3223           which = 1;
3224           }
3225         else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
3226           {
3227           sub[1] += 9;
3228           which = 2;
3229           }
3230         else if (sub[1][0] == '{')              /* }-for-text-editors */
3231           {
3232           expand_string_message = string_sprintf("unknown encryption mechanism "
3233             "in \"%s\"", sub[1]);
3234           goto failout;
3235           }
3236
3237         switch(which)
3238           {
3239           case 0:  coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
3240           case 1:  coded = US crypt(CS sub[0], CS sub[1]); break;
3241           default: coded = US crypt16(CS sub[0], CS sub[1]); break;
3242           }
3243
3244         #define STR(s) # s
3245         #define XSTR(s) STR(s)
3246         DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
3247           "  subject=%s\n  crypted=%s\n",
3248           which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
3249           coded, sub[1]);
3250         #undef STR
3251         #undef XSTR
3252
3253         /* If the encrypted string contains fewer than two characters (for the
3254         salt), force failure. Otherwise we get false positives: with an empty
3255         string the yield of crypt() is an empty string! */
3256
3257         if (coded)
3258           tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
3259         else if (errno == EINVAL)
3260           tempcond = FALSE;
3261         else
3262           {
3263           expand_string_message = string_sprintf("crypt error: %s\n",
3264             US strerror(errno));
3265           goto failout;
3266           }
3267         }
3268       break;
3269     #endif  /* SUPPORT_CRYPTEQ */
3270
3271     case ECOND_INLIST:
3272     case ECOND_INLISTI:
3273       {
3274       const uschar * list = sub[1];
3275       int sep = 0;
3276       uschar *save_iterate_item = iterate_item;
3277       int (*compare)(const uschar *, const uschar *);
3278
3279       DEBUG(D_expand) debug_printf_indent("condition: %s  item: %s\n", opname, sub[0]);
3280
3281       tempcond = FALSE;
3282       compare = cond_type == ECOND_INLISTI
3283         ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
3284
3285       while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
3286         {
3287         DEBUG(D_expand) debug_printf_indent(" compare %s\n", iterate_item);
3288         if (compare(sub[0], iterate_item) == 0)
3289           {
3290           tempcond = TRUE;
3291           lookup_value = iterate_item;
3292           break;
3293           }
3294         }
3295       iterate_item = save_iterate_item;
3296       }
3297
3298     }   /* Switch for comparison conditions */
3299
3300   *yield = tempcond == testfor;
3301   next = s; goto out;    /* End of comparison conditions */
3302
3303
3304   /* and/or: computes logical and/or of several conditions */
3305
3306   case ECOND_AND:
3307   case ECOND_OR:
3308   subcondptr = (yield == NULL) ? NULL : &tempcond;
3309   combined_cond = (cond_type == ECOND_AND);
3310
3311   Uskip_whitespace(&s);
3312   if (*s++ != '{') goto COND_FAILED_CURLY_START;        /* }-for-text-editors */
3313
3314   for (;;)
3315     {
3316     /* {-for-text-editors */
3317     if (Uskip_whitespace(&s) == '}') break;
3318     if (*s != '{')                                      /* }-for-text-editors */
3319       {
3320       expand_string_message = string_sprintf("each subcondition "
3321         "inside an \"%s{...}\" condition must be in its own {}", opname);
3322       goto failout;
3323       }
3324
3325     if (!(s = eval_condition(s+1, resetok, subcondptr)))
3326       {
3327       expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
3328         expand_string_message, opname);
3329       goto failout;
3330       }
3331     Uskip_whitespace(&s);
3332
3333     /* {-for-text-editors */
3334     if (*s++ != '}')
3335       {
3336       /* {-for-text-editors */
3337       expand_string_message = string_sprintf("missing } at end of condition "
3338         "inside \"%s\" group", opname);
3339       goto failout;
3340       }
3341
3342     if (yield)
3343       if (cond_type == ECOND_AND)
3344         {
3345         combined_cond &= tempcond;
3346         if (!combined_cond) subcondptr = NULL;  /* once false, don't */
3347         }                                       /* evaluate any more */
3348       else
3349         {
3350         combined_cond |= tempcond;
3351         if (combined_cond) subcondptr = NULL;   /* once true, don't */
3352         }                                       /* evaluate any more */
3353     }
3354
3355   if (yield) *yield = (combined_cond == testfor);
3356   next = ++s; goto out;
3357
3358
3359   /* forall/forany: iterates a condition with different values */
3360
3361   case ECOND_FORALL:      is_forany = FALSE;  is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3362   case ECOND_FORANY:      is_forany = TRUE;   is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3363   case ECOND_FORALL_JSON: is_forany = FALSE;  is_json = TRUE;  is_jsons = FALSE; goto FORMANY;
3364   case ECOND_FORANY_JSON: is_forany = TRUE;   is_json = TRUE;  is_jsons = FALSE; goto FORMANY;
3365   case ECOND_FORALL_JSONS: is_forany = FALSE; is_json = TRUE;  is_jsons = TRUE;  goto FORMANY;
3366   case ECOND_FORANY_JSONS: is_forany = TRUE;  is_json = TRUE;  is_jsons = TRUE;  goto FORMANY;
3367
3368   FORMANY:
3369     {
3370     const uschar * list;
3371     int sep = 0;
3372     uschar *save_iterate_item = iterate_item;
3373
3374     DEBUG(D_expand) debug_printf_indent("condition: %s\n", opname);
3375
3376     Uskip_whitespace(&s);
3377     if (*s++ != '{') goto COND_FAILED_CURLY_START;      /* }-for-text-editors */
3378     if (!(sub[0] = expand_string_internal(s,
3379       ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yield ? ESI_NOFLAGS : ESI_SKIPPING),
3380       &s, resetok, NULL)))
3381       goto failout;
3382     /* {-for-text-editors */
3383     if (*s++ != '}') goto COND_FAILED_CURLY_END;
3384
3385     Uskip_whitespace(&s);
3386     if (*s++ != '{') goto COND_FAILED_CURLY_START;      /* }-for-text-editors */
3387
3388     sub[1] = s;
3389
3390     /* Call eval_condition once, with result discarded (as if scanning a
3391     "false" part). This allows us to find the end of the condition, because if
3392     the list it empty, we won't actually evaluate the condition for real. */
3393
3394     if (!(s = eval_condition(sub[1], resetok, NULL)))
3395       {
3396       expand_string_message = string_sprintf("%s inside \"%s\" condition",
3397         expand_string_message, opname);
3398       goto failout;
3399       }
3400     Uskip_whitespace(&s);
3401
3402     /* {-for-text-editors */
3403     if (*s++ != '}')
3404       {
3405       /* {-for-text-editors */
3406       expand_string_message = string_sprintf("missing } at end of condition "
3407         "inside \"%s\"", opname);
3408       goto failout;
3409       }
3410
3411     if (yield) *yield = !testfor;
3412     list = sub[0];
3413     if (is_json) list = dewrap(string_copy(list), US"[]");
3414     while ((iterate_item = is_json
3415       ? json_nextinlist(&list) : string_nextinlist(&list, &sep, NULL, 0)))
3416       {
3417       if (is_jsons)
3418         if (!(iterate_item = dewrap(iterate_item, US"\"\"")))
3419           {
3420           expand_string_message =
3421             string_sprintf("%s wrapping string result for extract jsons",
3422               expand_string_message);
3423           iterate_item = save_iterate_item;
3424           goto failout;
3425           }
3426
3427       DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", opname, iterate_item);
3428       if (!eval_condition(sub[1], resetok, &tempcond))
3429         {
3430         expand_string_message = string_sprintf("%s inside \"%s\" condition",
3431           expand_string_message, opname);
3432         iterate_item = save_iterate_item;
3433         goto failout;
3434         }
3435       DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", opname,
3436         tempcond? "true":"false");
3437
3438       if (yield) *yield = (tempcond == testfor);
3439       if (tempcond == is_forany) break;
3440       }
3441
3442     iterate_item = save_iterate_item;
3443     next = s; goto out;
3444     }
3445
3446
3447   /* The bool{} expansion condition maps a string to boolean.
3448   The values supported should match those supported by the ACL condition
3449   (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
3450   of true/false.  Note that Router "condition" rules have a different
3451   interpretation, where general data can be used and only a few values
3452   map to FALSE.
3453   Note that readconf.c boolean matching, for boolean configuration options,
3454   only matches true/yes/false/no.
3455   The bool_lax{} condition matches the Router logic, which is much more
3456   liberal. */
3457   case ECOND_BOOL:
3458   case ECOND_BOOL_LAX:
3459     {
3460     uschar *sub_arg[1];
3461     uschar *t, *t2;
3462     uschar *ourname;
3463     size_t len;
3464     BOOL boolvalue = FALSE;
3465
3466     if (Uskip_whitespace(&s) != '{') goto COND_FAILED_CURLY_START;      /* }-for-text-editors */
3467     ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
3468     switch(read_subs(sub_arg, 1, 1, &s,
3469             yield ? ESI_NOFLAGS : ESI_SKIPPING, FALSE, ourname, resetok, NULL))
3470       {
3471       case 1: expand_string_message = string_sprintf(
3472                   "too few arguments or bracketing error for %s",
3473                   ourname);
3474       /*FALLTHROUGH*/
3475       case 2:
3476       case 3: goto failout;
3477       }
3478     t = sub_arg[0];
3479     Uskip_whitespace(&t);
3480     if ((len = Ustrlen(t)))
3481       {
3482       /* trailing whitespace: seems like a good idea to ignore it too */
3483       t2 = t + len - 1;
3484       while (isspace(*t2)) t2--;
3485       if (t2 != (t + len))
3486         {
3487         *++t2 = '\0';
3488         len = t2 - t;
3489         }
3490       }
3491     DEBUG(D_expand)
3492       debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>");
3493     /* logic for the lax case from expand_check_condition(), which also does
3494     expands, and the logic is both short and stable enough that there should
3495     be no maintenance burden from replicating it. */
3496     if (len == 0)
3497       boolvalue = FALSE;
3498     else if (*t == '-'
3499              ? Ustrspn(t+1, "0123456789") == len-1
3500              : Ustrspn(t,   "0123456789") == len)
3501       {
3502       boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3503       /* expand_check_condition only does a literal string "0" check */
3504       if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3505         boolvalue = TRUE;
3506       }
3507     else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3508       boolvalue = TRUE;
3509     else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3510       boolvalue = FALSE;
3511     else if (cond_type == ECOND_BOOL_LAX)
3512       boolvalue = TRUE;
3513     else
3514       {
3515       expand_string_message = string_sprintf("unrecognised boolean "
3516        "value \"%s\"", t);
3517       goto failout;
3518       }
3519     DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname,
3520         boolvalue? "true":"false");
3521     if (yield) *yield = (boolvalue == testfor);
3522     next = s; goto out;
3523     }
3524
3525 #ifdef SUPPORT_SRS
3526   case ECOND_INBOUND_SRS:
3527     /* ${if inbound_srs {local_part}{secret}  {yes}{no}} */
3528     {
3529     uschar * sub[2];
3530     const pcre2_code * re;
3531     pcre2_match_data * md;
3532     PCRE2_SIZE * ovec;
3533     int quoting = 0;
3534     uschar cksum[4];
3535     BOOL boolvalue = FALSE;
3536
3537     switch(read_subs(sub, 2, 2, CUSS &s,
3538             yield ? ESI_NOFLAGS : ESI_SKIPPING, FALSE, name, resetok, NULL))
3539       {
3540       case 1: expand_string_message = US"too few arguments or bracketing "
3541         "error for inbound_srs";
3542       case 2:
3543       case 3: goto failout;
3544       }
3545
3546     /* Match the given local_part against the SRS-encoded pattern */
3547
3548     re = regex_must_compile(US"^(?i)SRS0=([^=]+)=([A-Z2-7]{2})=([^=]*)=(.*)$",
3549                             MCS_CASELESS | MCS_CACHEABLE, FALSE);
3550     md = pcre2_match_data_create(4+1, pcre_gen_ctx);
3551     if (pcre2_match(re, sub[0], PCRE2_ZERO_TERMINATED, 0, PCRE_EOPT,
3552                     md, pcre_gen_mtc_ctx) < 0)
3553       {
3554       DEBUG(D_expand) debug_printf("no match for SRS'd local-part pattern\n");
3555       goto srs_result;
3556       }
3557     ovec = pcre2_get_ovector_pointer(md);
3558
3559     if (sub[0][0] == '"')
3560       quoting = 1;
3561     else for (uschar * s = sub[0]; *s; s++)
3562       if (!isalnum(*s) && Ustrchr(".!#$%&'*+-/=?^_`{|}~", *s) == NULL)
3563         { quoting = 1; break; }
3564     if (quoting)
3565       DEBUG(D_expand) debug_printf_indent("auto-quoting local part\n");
3566
3567     /* Record the (quoted, if needed) decoded recipient as $srs_recipient */
3568
3569     srs_recipient = string_sprintf("%.*s%.*S%.*s@%.*S",         /* lowercased */
3570                       quoting, "\"",
3571                       (int) (ovec[9]-ovec[8]), sub[0] + ovec[8],  /* substr 4 */
3572                       quoting, "\"",
3573                       (int) (ovec[7]-ovec[6]), sub[0] + ovec[6]); /* substr 3 */
3574
3575     /* If a zero-length secret was given, we're done.  Otherwise carry on
3576     and validate the given SRS local_part againt our secret. */
3577
3578     if (*sub[1])
3579       {
3580       /* check the timestamp */
3581         {
3582         struct timeval now;
3583         uschar * ss = sub[0] + ovec[4]; /* substring 2, the timestamp */
3584         long d;
3585         int n;
3586
3587         gettimeofday(&now, NULL);
3588         now.tv_sec /= 86400;                    /* days since epoch */
3589
3590         /* Decode substring 2 from base32 to a number */
3591
3592         for (d = 0, n = ovec[5]-ovec[4]; n; n--)
3593           {
3594           uschar * t = Ustrchr(base32_chars, *ss++);
3595           d = d * 32 + (t - base32_chars);
3596           }
3597
3598         if (((now.tv_sec - d) & 0x3ff) > 10)    /* days since SRS generated */
3599           {
3600           DEBUG(D_expand) debug_printf("SRS too old\n");
3601           goto srs_result;
3602           }
3603         }
3604
3605       /* check length of substring 1, the offered checksum */
3606
3607       if (ovec[3]-ovec[2] != 4)
3608         {
3609         DEBUG(D_expand) debug_printf("SRS checksum wrong size\n");
3610         goto srs_result;
3611         }
3612
3613       /* Hash the address with our secret, and compare that computed checksum
3614       with the one extracted from the arg */
3615
3616       hmac_md5(sub[1], srs_recipient, cksum, sizeof(cksum));
3617       if (Ustrncmp(cksum, sub[0] + ovec[2], 4) != 0)
3618         {
3619         DEBUG(D_expand) debug_printf("SRS checksum mismatch\n");
3620         goto srs_result;
3621         }
3622       }
3623     boolvalue = TRUE;
3624
3625 srs_result:
3626     /* pcre2_match_data_free(md);       gen ctx needs no free */
3627     if (yield) *yield = (boolvalue == testfor);
3628     next = s; goto out;
3629     }
3630 #endif /*SUPPORT_SRS*/
3631
3632   /* Unknown condition */
3633
3634   default:
3635     if (!expand_string_message || !*expand_string_message)
3636       expand_string_message = string_sprintf("unknown condition \"%s\"", opname);
3637     goto failout;
3638   }   /* End switch on condition type */
3639
3640 /* Missing braces at start and end of data */
3641
3642 COND_FAILED_CURLY_START:
3643 expand_string_message = string_sprintf("missing { after \"%s\"", opname);
3644 goto failout;
3645
3646 COND_FAILED_CURLY_END:
3647 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3648   opname);
3649 goto failout;
3650
3651 /* A condition requires code that is not compiled */
3652
3653 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3654     !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3655     !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3656 COND_FAILED_NOT_COMPILED:
3657 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3658   opname);
3659 goto failout;
3660 #endif
3661
3662 failout:
3663   next = NULL;
3664 out:
3665   expand_level--;
3666   return next;
3667 }
3668
3669
3670
3671
3672 /*************************************************
3673 *          Save numerical variables              *
3674 *************************************************/
3675
3676 /* This function is called from items such as "if" that want to preserve and
3677 restore the numbered variables.
3678
3679 Arguments:
3680   save_expand_string    points to an array of pointers to set
3681   save_expand_nlength   points to an array of ints for the lengths
3682
3683 Returns:                the value of expand max to save
3684 */
3685
3686 static int
3687 save_expand_strings(const uschar **save_expand_nstring, int *save_expand_nlength)
3688 {
3689 for (int i = 0; i <= expand_nmax; i++)
3690   {
3691   save_expand_nstring[i] = expand_nstring[i];
3692   save_expand_nlength[i] = expand_nlength[i];
3693   }
3694 return expand_nmax;
3695 }
3696
3697
3698
3699 /*************************************************
3700 *           Restore numerical variables          *
3701 *************************************************/
3702
3703 /* This function restored saved values of numerical strings.
3704
3705 Arguments:
3706   save_expand_nmax      the number of strings to restore
3707   save_expand_string    points to an array of pointers
3708   save_expand_nlength   points to an array of ints
3709
3710 Returns:                nothing
3711 */
3712
3713 static void
3714 restore_expand_strings(int save_expand_nmax, const uschar **save_expand_nstring,
3715   int *save_expand_nlength)
3716 {
3717 expand_nmax = save_expand_nmax;
3718 for (int i = 0; i <= expand_nmax; i++)
3719   {
3720   expand_nstring[i] = save_expand_nstring[i];
3721   expand_nlength[i] = save_expand_nlength[i];
3722   }
3723 }
3724
3725
3726
3727
3728
3729 /*************************************************
3730 *            Handle yes/no substrings            *
3731 *************************************************/
3732
3733 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3734 alternative substrings that depend on whether or not the condition was true,
3735 or the lookup or extraction succeeded. The substrings always have to be
3736 expanded, to check their syntax, but "skipping" is set when the result is not
3737 needed - this avoids unnecessary nested lookups.
3738
3739 Arguments:
3740   flags
3741    skipping       TRUE if we were skipping when this item was reached
3742   yes            TRUE if the first string is to be used, else use the second
3743   save_lookup    a value to put back into lookup_value before the 2nd expansion
3744   sptr           points to the input string pointer
3745   yieldptr       points to the output growable-string pointer
3746   type           "lookup", "if", "extract", "run", "env", "listextract" or
3747                  "certextract" for error message
3748   resetok        if not NULL, pointer to flag - write FALSE if unsafe to reset
3749                 the store.
3750
3751 Returns:         0 OK; lookup_value has been reset to save_lookup
3752                  1 expansion failed
3753                  2 expansion failed because of bracketing error
3754 */
3755
3756 static int
3757 process_yesno(esi_flags flags, BOOL yes, uschar *save_lookup, const uschar **sptr,
3758   gstring ** yieldptr, uschar *type, BOOL *resetok)
3759 {
3760 int rc = 0;
3761 const uschar *s = *sptr;    /* Local value */
3762 uschar *sub1, *sub2;
3763 const uschar * errwhere;
3764
3765 flags &= ESI_SKIPPING;          /* Ignore all buf the skipping flag */
3766
3767 /* If there are no following strings, we substitute the contents of $value for
3768 lookups and for extractions in the success case. For the ${if item, the string
3769 "true" is substituted. In the fail case, nothing is substituted for all three
3770 items. */
3771
3772 if (skip_whitespace(&s) == '}')
3773   {
3774   if (type[0] == 'i')
3775     {
3776     if (yes && !(flags & ESI_SKIPPING))
3777       *yieldptr = string_catn(*yieldptr, US"true", 4);
3778     }
3779   else
3780     {
3781     if (yes && lookup_value && !(flags & ESI_SKIPPING))
3782       *yieldptr = string_cat(*yieldptr, lookup_value);
3783     lookup_value = save_lookup;
3784     }
3785   s++;
3786   goto RETURN;
3787   }
3788
3789 /* The first following string must be braced. */
3790
3791 if (*s++ != '{')
3792   {
3793   errwhere = US"'yes' part did not start with '{'";             /*}}*/
3794   goto FAILED_CURLY;
3795   }
3796
3797 /* Expand the first substring. Forced failures are noticed only if we actually
3798 want this string. Set skipping in the call in the fail case (this will always
3799 be the case if we were already skipping). */
3800
3801 sub1 = expand_string_internal(s,
3802   ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yes ? ESI_NOFLAGS : ESI_SKIPPING),
3803   &s, resetok, NULL);
3804 if (sub1 == NULL && (yes || !f.expand_string_forcedfail)) goto FAILED;
3805 f.expand_string_forcedfail = FALSE;
3806                                                                 /*{{*/
3807 if (*s++ != '}')
3808   {
3809   errwhere = US"'yes' part did not end with '}'";
3810   goto FAILED_CURLY;
3811   }
3812
3813 /* If we want the first string, add it to the output */
3814
3815 if (yes)
3816   *yieldptr = string_cat(*yieldptr, sub1);
3817
3818 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3819 $value to what it was at the start of the item, so that it has this value
3820 during the second string expansion. For the call from "if" or "run" to this
3821 function, save_lookup is set to lookup_value, so that this statement does
3822 nothing. */
3823
3824 lookup_value = save_lookup;
3825
3826 /* There now follows either another substring, or "fail", or nothing. This
3827 time, forced failures are noticed only if we want the second string. We must
3828 set skipping in the nested call if we don't want this string, or if we were
3829 already skipping. */
3830
3831 if (skip_whitespace(&s) == '{')                                 /*}*/
3832   {
3833   esi_flags s_flags = ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags;
3834   if (yes) s_flags |= ESI_SKIPPING;
3835   sub2 = expand_string_internal(s+1, s_flags, &s, resetok, NULL);
3836   if (!sub2 && (!yes || !f.expand_string_forcedfail)) goto FAILED;
3837   f.expand_string_forcedfail = FALSE;                           /*{*/
3838   if (*s++ != '}')
3839     {
3840     errwhere = US"'no' part did not start with '{'";            /*}*/
3841     goto FAILED_CURLY;
3842     }
3843
3844   /* If we want the second string, add it to the output */
3845
3846   if (!yes)
3847     *yieldptr = string_cat(*yieldptr, sub2);
3848   }
3849                                                                 /*{{*/
3850 /* If there is no second string, but the word "fail" is present when the use of
3851 the second string is wanted, set a flag indicating it was a forced failure
3852 rather than a syntactic error. Swallow the terminating } in case this is nested
3853 inside another lookup or if or extract. */
3854
3855 else if (*s != '}')
3856   {
3857   uschar name[256];
3858   /* deconst cast ok here as source is s anyway */
3859   s = US read_name(name, sizeof(name), s, US"_");
3860   if (Ustrcmp(name, "fail") == 0)
3861     {
3862     if (!yes && !(flags & ESI_SKIPPING))
3863       {
3864       Uskip_whitespace(&s);                                     /*{{*/
3865       if (*s++ != '}')
3866         {
3867         errwhere = US"did not close with '}' after forcedfail";
3868         goto FAILED_CURLY;
3869         }
3870       expand_string_message =
3871         string_sprintf("\"%s\" failed and \"fail\" requested", type);
3872       f.expand_string_forcedfail = TRUE;
3873       goto FAILED;
3874       }
3875     }
3876   else
3877     {
3878     expand_string_message =
3879       string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3880     goto FAILED;
3881     }
3882   }
3883
3884 /* All we have to do now is to check on the final closing brace. */
3885
3886 skip_whitespace(&s);                                            /*{{*/
3887 if (*s++ != '}')
3888   {
3889   errwhere = US"did not close with '}'";
3890   goto FAILED_CURLY;
3891   }
3892
3893
3894 RETURN:
3895 /* Update the input pointer value before returning */
3896 *sptr = s;
3897 return rc;
3898
3899 FAILED_CURLY:
3900   /* Get here if there is a bracketing failure */
3901   expand_string_message = string_sprintf(
3902     "curly-bracket problem in conditional yes/no parsing: %s\n"
3903     " remaining string is '%s'", errwhere, --s);
3904   rc = 2;
3905   goto RETURN;
3906
3907 FAILED:
3908   /* Get here for other failures */
3909   rc = 1;
3910   goto RETURN;
3911 }
3912
3913
3914
3915
3916 /********************************************************
3917 * prvs: Get last three digits of days since Jan 1, 1970 *
3918 ********************************************************/
3919
3920 /* This is needed to implement the "prvs" BATV reverse
3921    path signing scheme
3922
3923 Argument: integer "days" offset to add or substract to
3924           or from the current number of days.
3925
3926 Returns:  pointer to string containing the last three
3927           digits of the number of days since Jan 1, 1970,
3928           modified by the offset argument, NULL if there
3929           was an error in the conversion.
3930
3931 */
3932
3933 static uschar *
3934 prvs_daystamp(int day_offset)
3935 {
3936 uschar * days = store_get(32, GET_UNTAINTED);      /* Need at least 24 for cases */
3937 (void)string_format(days, 32, TIME_T_FMT,          /* where TIME_T_FMT is %lld */
3938   (time(NULL) + day_offset*86400)/86400);
3939 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3940 }
3941
3942
3943
3944 /********************************************************
3945 *   prvs: perform HMAC-SHA1 computation of prvs bits    *
3946 ********************************************************/
3947
3948 /* This is needed to implement the "prvs" BATV reverse
3949    path signing scheme
3950
3951 Arguments:
3952   address RFC2821 Address to use
3953       key The key to use (must be less than 64 characters
3954           in size)
3955   key_num Single-digit key number to use. Defaults to
3956           '0' when NULL.
3957
3958 Returns:  pointer to string containing the first three
3959           bytes of the final hash in hex format, NULL if
3960           there was an error in the process.
3961 */
3962
3963 static uschar *
3964 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3965 {
3966 gstring * hash_source;
3967 uschar * p;
3968 hctx h;
3969 uschar innerhash[20];
3970 uschar finalhash[20];
3971 uschar innerkey[64];
3972 uschar outerkey[64];
3973 uschar *finalhash_hex;
3974
3975 if (!key_num)
3976   key_num = US"0";
3977
3978 if (Ustrlen(key) > 64)
3979   return NULL;
3980
3981 hash_source = string_catn(NULL, key_num, 1);
3982 hash_source = string_catn(hash_source, daystamp, 3);
3983 hash_source = string_cat(hash_source, address);
3984
3985 DEBUG(D_expand)
3986   debug_printf_indent("prvs: hash source is '%Y'\n", hash_source);
3987
3988 memset(innerkey, 0x36, 64);
3989 memset(outerkey, 0x5c, 64);
3990
3991 for (int i = 0; i < Ustrlen(key); i++)
3992   {
3993   innerkey[i] ^= key[i];
3994   outerkey[i] ^= key[i];
3995   }
3996
3997 chash_start(HMAC_SHA1, &h);
3998 chash_mid(HMAC_SHA1, &h, innerkey);
3999 chash_end(HMAC_SHA1, &h, hash_source->s, hash_source->ptr, innerhash);
4000
4001 chash_start(HMAC_SHA1, &h);
4002 chash_mid(HMAC_SHA1, &h, outerkey);
4003 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
4004
4005 /* Hashing is deemed sufficient to de-taint any input data */
4006
4007 p = finalhash_hex = store_get(40, GET_UNTAINTED);
4008 for (int i = 0; i < 3; i++)
4009   {
4010   *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
4011   *p++ = hex_digits[finalhash[i] & 0x0f];
4012   }
4013 *p = '\0';
4014
4015 return finalhash_hex;
4016 }
4017
4018
4019
4020
4021 /*************************************************
4022 *        Join a file onto the output string      *
4023 *************************************************/
4024
4025 /* This is used for readfile/readsock and after a run expansion.
4026 It joins the contents of a file onto the output string, globally replacing
4027 newlines with a given string (optionally).
4028
4029 Arguments:
4030   f            the FILE
4031   yield        pointer to the expandable string struct
4032   eol          newline replacement string, or NULL
4033
4034 Returns:       new pointer for expandable string, terminated if non-null
4035 */
4036
4037 gstring *
4038 cat_file(FILE * f, gstring * yield, uschar * eol)
4039 {
4040 uschar buffer[1024];
4041
4042 while (Ufgets(buffer, sizeof(buffer), f))
4043   {
4044   int len = Ustrlen(buffer);
4045   if (eol && buffer[len-1] == '\n') len--;
4046   yield = string_catn(yield, buffer, len);
4047   if (eol && buffer[len])
4048     yield = string_cat(yield, eol);
4049   }
4050 return yield;
4051 }
4052
4053
4054 #ifndef DISABLE_TLS
4055 gstring *
4056 cat_file_tls(void * tls_ctx, gstring * yield, uschar * eol)
4057 {
4058 int rc;
4059 uschar buffer[1024];
4060
4061 /*XXX could we read direct into a pre-grown string? */
4062
4063 while ((rc = tls_read(tls_ctx, buffer, sizeof(buffer))) > 0)
4064   for (uschar * s = buffer; rc--; s++)
4065     yield = eol && *s == '\n'
4066       ? string_cat(yield, eol) : string_catn(yield, s, 1);
4067
4068 /* We assume that all errors, and any returns of zero bytes,
4069 are actually EOF. */
4070
4071 return yield;
4072 }
4073 #endif
4074
4075
4076 /*************************************************
4077 *          Evaluate numeric expression           *
4078 *************************************************/
4079
4080 /* This is a set of mutually recursive functions that evaluate an arithmetic
4081 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
4082 these functions that is called from elsewhere is eval_expr, whose interface is:
4083
4084 Arguments:
4085   sptr        pointer to the pointer to the string - gets updated
4086   decimal     TRUE if numbers are to be assumed decimal
4087   error       pointer to where to put an error message - must be NULL on input
4088   endket      TRUE if ')' must terminate - FALSE for external call
4089
4090 Returns:      on success: the value of the expression, with *error still NULL
4091               on failure: an undefined value, with *error = a message
4092 */
4093
4094 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
4095
4096
4097 static int_eximarith_t
4098 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
4099 {
4100 uschar *s = *sptr;
4101 int_eximarith_t x = eval_op_or(&s, decimal, error);
4102
4103 if (!*error)
4104   if (endket)
4105     if (*s != ')')
4106       *error = US"expecting closing parenthesis";
4107     else
4108       while (isspace(*++s)) ;
4109   else if (*s)
4110     *error = US"expecting operator";
4111 *sptr = s;
4112 return x;
4113 }
4114
4115
4116 static int_eximarith_t
4117 eval_number(uschar **sptr, BOOL decimal, uschar **error)
4118 {
4119 int c;
4120 int_eximarith_t n;
4121 uschar *s = *sptr;
4122
4123 if (isdigit((c = Uskip_whitespace(&s))))
4124   {
4125   int count;
4126   (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
4127   s += count;
4128   switch (tolower(*s))
4129     {
4130     default: break;
4131     case 'k': n *= 1024; s++; break;
4132     case 'm': n *= 1024*1024; s++; break;
4133     case 'g': n *= 1024*1024*1024; s++; break;
4134     }
4135   Uskip_whitespace(&s);
4136   }
4137 else if (c == '(')
4138   {
4139   s++;
4140   n = eval_expr(&s, decimal, error, 1);
4141   }
4142 else
4143   {
4144   *error = US"expecting number or opening parenthesis";
4145   n = 0;
4146   }
4147 *sptr = s;
4148 return n;
4149 }
4150
4151
4152 static int_eximarith_t
4153 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
4154 {
4155 uschar *s = *sptr;
4156 int_eximarith_t x;
4157 Uskip_whitespace(&s);
4158 if (*s == '+' || *s == '-' || *s == '~')
4159   {
4160   int op = *s++;
4161   x = eval_op_unary(&s, decimal, error);
4162   if (op == '-') x = -x;
4163     else if (op == '~') x = ~x;
4164   }
4165 else
4166   x = eval_number(&s, decimal, error);
4167
4168 *sptr = s;
4169 return x;
4170 }
4171
4172
4173 static int_eximarith_t
4174 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
4175 {
4176 uschar *s = *sptr;
4177 int_eximarith_t x = eval_op_unary(&s, decimal, error);
4178 if (!*error)
4179   {
4180   while (*s == '*' || *s == '/' || *s == '%')
4181     {
4182     int op = *s++;
4183     int_eximarith_t y = eval_op_unary(&s, decimal, error);
4184     if (*error) break;
4185     /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
4186      * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
4187      * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64].  In fact, -N*-M where
4188      * -N*M is INT_MIN will yield INT_MIN.
4189      * Since we don't support floating point, this is somewhat simpler.
4190      * Ideally, we'd return an error, but since we overflow for all other
4191      * arithmetic, consistency suggests otherwise, but what's the correct value
4192      * to use?  There is none.
4193      * The C standard guarantees overflow for unsigned arithmetic but signed
4194      * overflow invokes undefined behaviour; in practice, this is overflow
4195      * except for converting INT_MIN to INT_MAX+1.  We also can't guarantee
4196      * that long/longlong larger than int are available, or we could just work
4197      * with larger types.  We should consider whether to guarantee 32bit eval
4198      * and 64-bit working variables, with errors returned.  For now ...
4199      * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
4200      * can just let the other invalid results occur otherwise, as they have
4201      * until now.  For this one case, we can coerce.
4202      */
4203     if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
4204       {
4205       DEBUG(D_expand)
4206         debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
4207             EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
4208       x = EXIM_ARITH_MAX;
4209       continue;
4210       }
4211     if (op == '*')
4212       x *= y;
4213     else
4214       {
4215       if (y == 0)
4216         {
4217         *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
4218         x = 0;
4219         break;
4220         }
4221       if (op == '/')
4222         x /= y;
4223       else
4224         x %= y;
4225       }
4226     }
4227   }
4228 *sptr = s;
4229 return x;
4230 }
4231
4232
4233 static int_eximarith_t
4234 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
4235 {
4236 uschar *s = *sptr;
4237 int_eximarith_t x = eval_op_mult(&s, decimal, error);
4238 if (!*error)
4239   {
4240   while (*s == '+' || *s == '-')
4241     {
4242     int op = *s++;
4243     int_eximarith_t y = eval_op_mult(&s, decimal, error);
4244     if (*error) break;
4245     if (  (x >=   EXIM_ARITH_MAX/2  && x >=   EXIM_ARITH_MAX/2)
4246        || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
4247       {                 /* over-conservative check */
4248       *error = op == '+'
4249         ? US"overflow in sum" : US"overflow in difference";
4250       break;
4251       }
4252     if (op == '+') x += y; else x -= y;
4253     }
4254   }
4255 *sptr = s;
4256 return x;
4257 }
4258
4259
4260 static int_eximarith_t
4261 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
4262 {
4263 uschar *s = *sptr;
4264 int_eximarith_t x = eval_op_sum(&s, decimal, error);
4265 if (!*error)
4266   {
4267   while ((*s == '<' || *s == '>') && s[1] == s[0])
4268     {
4269     int_eximarith_t y;
4270     int op = *s++;
4271     s++;
4272     y = eval_op_sum(&s, decimal, error);
4273     if (*error) break;
4274     if (op == '<') x <<= y; else x >>= y;
4275     }
4276   }
4277 *sptr = s;
4278 return x;
4279 }
4280
4281
4282 static int_eximarith_t
4283 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
4284 {
4285 uschar *s = *sptr;
4286 int_eximarith_t x = eval_op_shift(&s, decimal, error);
4287 if (!*error)
4288   {
4289   while (*s == '&')
4290     {
4291     int_eximarith_t y;
4292     s++;
4293     y = eval_op_shift(&s, decimal, error);
4294     if (*error) break;
4295     x &= y;
4296     }
4297   }
4298 *sptr = s;
4299 return x;
4300 }
4301
4302
4303 static int_eximarith_t
4304 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
4305 {
4306 uschar *s = *sptr;
4307 int_eximarith_t x = eval_op_and(&s, decimal, error);
4308 if (!*error)
4309   {
4310   while (*s == '^')
4311     {
4312     int_eximarith_t y;
4313     s++;
4314     y = eval_op_and(&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_or(uschar **sptr, BOOL decimal, uschar **error)
4326 {
4327 uschar *s = *sptr;
4328 int_eximarith_t x = eval_op_xor(&s, decimal, error);
4329 if (!*error)
4330   {
4331   while (*s == '|')
4332     {
4333     int_eximarith_t y;
4334     s++;
4335     y = eval_op_xor(&s, decimal, error);
4336     if (*error) break;
4337     x |= y;
4338     }
4339   }
4340 *sptr = s;
4341 return x;
4342 }
4343
4344
4345
4346 /************************************************/
4347 /* Comparison operation for sort expansion.  We need to avoid
4348 re-expanding the fields being compared, so need a custom routine.
4349
4350 Arguments:
4351  cond_type              Comparison operator code
4352  leftarg, rightarg      Arguments for comparison
4353
4354 Return true iff (leftarg compare rightarg)
4355 */
4356
4357 static BOOL
4358 sortsbefore(int cond_type, BOOL alpha_cond,
4359   const uschar * leftarg, const uschar * rightarg)
4360 {
4361 int_eximarith_t l_num, r_num;
4362
4363 if (!alpha_cond)
4364   {
4365   l_num = expanded_string_integer(leftarg, FALSE);
4366   if (expand_string_message) return FALSE;
4367   r_num = expanded_string_integer(rightarg, FALSE);
4368   if (expand_string_message) return FALSE;
4369
4370   switch (cond_type)
4371     {
4372     case ECOND_NUM_G:   return l_num >  r_num;
4373     case ECOND_NUM_GE:  return l_num >= r_num;
4374     case ECOND_NUM_L:   return l_num <  r_num;
4375     case ECOND_NUM_LE:  return l_num <= r_num;
4376     default: break;
4377     }
4378   }
4379 else
4380   switch (cond_type)
4381     {
4382     case ECOND_STR_LT:  return Ustrcmp (leftarg, rightarg) <  0;
4383     case ECOND_STR_LTI: return strcmpic(leftarg, rightarg) <  0;
4384     case ECOND_STR_LE:  return Ustrcmp (leftarg, rightarg) <= 0;
4385     case ECOND_STR_LEI: return strcmpic(leftarg, rightarg) <= 0;
4386     case ECOND_STR_GT:  return Ustrcmp (leftarg, rightarg) >  0;
4387     case ECOND_STR_GTI: return strcmpic(leftarg, rightarg) >  0;
4388     case ECOND_STR_GE:  return Ustrcmp (leftarg, rightarg) >= 0;
4389     case ECOND_STR_GEI: return strcmpic(leftarg, rightarg) >= 0;
4390     default: break;
4391     }
4392 return FALSE;   /* should not happen */
4393 }
4394
4395
4396 /* Expand a named list.  Return false on failure. */
4397 static gstring *
4398 expand_listnamed(gstring * yield, const uschar * name, const uschar * listtype)
4399 {
4400 tree_node *t = NULL;
4401 const uschar * list;
4402 int sep = 0;
4403 uschar * item;
4404 BOOL needsep = FALSE;
4405 #define LISTNAMED_BUF_SIZE 256
4406 uschar b[LISTNAMED_BUF_SIZE];
4407 uschar * buffer = b;
4408
4409 if (*name == '+') name++;
4410 if (!listtype)          /* no-argument version */
4411   {
4412   if (  !(t = tree_search(addresslist_anchor, name))
4413      && !(t = tree_search(domainlist_anchor,  name))
4414      && !(t = tree_search(hostlist_anchor,    name)))
4415     t = tree_search(localpartlist_anchor, name);
4416   }
4417 else switch(*listtype)  /* specific list-type version */
4418   {
4419   case 'a': t = tree_search(addresslist_anchor,   name); break;
4420   case 'd': t = tree_search(domainlist_anchor,    name); break;
4421   case 'h': t = tree_search(hostlist_anchor,      name); break;
4422   case 'l': t = tree_search(localpartlist_anchor, name); break;
4423   default:
4424     expand_string_message = US"bad suffix on \"list\" operator";
4425     return yield;
4426   }
4427
4428 if(!t)
4429   {
4430   expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
4431     name, !listtype?""
4432       : *listtype=='a'?"address "
4433       : *listtype=='d'?"domain "
4434       : *listtype=='h'?"host "
4435       : *listtype=='l'?"localpart "
4436       : 0);
4437   return yield;
4438   }
4439
4440 list = ((namedlist_block *)(t->data.ptr))->string;
4441
4442 /* The list could be quite long so we (re)use a buffer for each element
4443 rather than getting each in new memory */
4444
4445 if (is_tainted(list)) buffer = store_get(LISTNAMED_BUF_SIZE, GET_TAINTED);
4446 while ((item = string_nextinlist(&list, &sep, buffer, LISTNAMED_BUF_SIZE)))
4447   {
4448   uschar * buf = US" : ";
4449   if (needsep)
4450     yield = string_catn(yield, buf, 3);
4451   else
4452     needsep = TRUE;
4453
4454   if (*item == '+')     /* list item is itself a named list */
4455     {
4456     yield = expand_listnamed(yield, item, listtype);
4457     if (expand_string_message)
4458       return yield;
4459     }
4460
4461   else if (sep != ':')  /* item from non-colon-sep list, re-quote for colon list-separator */
4462     {
4463     char tok[3];
4464     tok[0] = sep; tok[1] = ':'; tok[2] = 0;
4465
4466     for(char * cp; cp = strpbrk(CCS item, tok); item = US cp)
4467       {
4468       yield = string_catn(yield, item, cp - CS item);
4469       if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
4470         yield = string_catn(yield, US"::", 2);
4471       else              /* sep in item; should already be doubled; emit once */
4472         {
4473         yield = string_catn(yield, US tok, 1);
4474         if (*cp == sep) cp++;
4475         }
4476       }
4477     yield = string_cat(yield, item);
4478     }
4479   else
4480     yield = string_cat(yield, item);
4481   }
4482 return yield;
4483 }
4484
4485
4486
4487 /************************************************/
4488 static void
4489 debug_expansion_interim(const uschar * what, const uschar * value, int nchar,
4490   esi_flags flags)
4491 {
4492 debug_printf_indent("%V", "K");
4493
4494 for (int fill = 11 - Ustrlen(what); fill > 0; fill--)
4495   debug_printf("%V", "-");
4496
4497 debug_printf("%s: %.*W\n", what, nchar, value);
4498 if (is_tainted(value))
4499   debug_printf_indent("%V          %V(tainted)\n",
4500     flags & ESI_SKIPPING ? "|" : " ", "\\__");
4501 }
4502
4503
4504 /*************************************************
4505 *                 Expand string                  *
4506 *************************************************/
4507
4508 /* Returns either an unchanged string, or the expanded string in stacking pool
4509 store. Interpreted sequences are:
4510
4511    \...                    normal escaping rules
4512    $name                   substitutes the variable
4513    ${name}                 ditto
4514    ${op:string}            operates on the expanded string value
4515    ${item{arg1}{arg2}...}  expands the args and then does the business
4516                              some literal args are not enclosed in {}
4517
4518 There are now far too many operators and item types to make it worth listing
4519 them here in detail any more.
4520
4521 We use an internal routine recursively to handle embedded substrings. The
4522 external function follows. The yield is NULL if the expansion failed, and there
4523 are two cases: if something collapsed syntactically, or if "fail" was given
4524 as the action on a lookup failure. These can be distinguished by looking at the
4525 variable expand_string_forcedfail, which is TRUE in the latter case.
4526
4527 The skipping flag is set true when expanding a substring that isn't actually
4528 going to be used (after "if" or "lookup") and it prevents lookups from
4529 happening lower down.
4530
4531 Store usage: At start, a store block of the length of the input plus 64
4532 is obtained. This is expanded as necessary by string_cat(), which might have to
4533 get a new block, or might be able to expand the original. At the end of the
4534 function we can release any store above that portion of the yield block that
4535 was actually used. In many cases this will be optimal.
4536
4537 However: if the first item in the expansion is a variable name or header name,
4538 we reset the store before processing it; if the result is in fresh store, we
4539 use that without copying. This is helpful for expanding strings like
4540 $message_headers which can get very long.
4541
4542 There's a problem if a ${dlfunc item has side-effects that cause allocation,
4543 since resetting the store at the end of the expansion will free store that was
4544 allocated by the plugin code as well as the slop after the expanded string. So
4545 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
4546 and, given the acl condition, ${if }. This is an unfortunate consequence of
4547 string expansion becoming too powerful.
4548
4549 Arguments:
4550   string         the string to be expanded
4551   flags
4552    brace_ends     expansion is to stop at }
4553    honour_dollar  TRUE if $ is to be expanded,
4554                   FALSE if it's just another character
4555    skipping       TRUE for recursive calls when the value isn't actually going
4556                   to be used (to allow for optimisation)
4557   left           if not NULL, a pointer to the first character after the
4558                  expansion is placed here (typically used with brace_ends)
4559   resetok_p      if not NULL, pointer to flag - write FALSE if unsafe to reset
4560                  the store.
4561   textonly_p     if not NULL, pointer to flag - write bool for only-met-text
4562
4563 Returns:         NULL if expansion fails:
4564                    expand_string_forcedfail is set TRUE if failure was forced
4565                    expand_string_message contains a textual error message
4566                  a pointer to the expanded string on success
4567 */
4568
4569 static uschar *
4570 expand_string_internal(const uschar * string, esi_flags flags, const uschar ** left,
4571   BOOL *resetok_p, BOOL * textonly_p)
4572 {
4573 rmark reset_point = store_mark();
4574 gstring * yield = string_get(Ustrlen(string) + 64);
4575 int item_type;
4576 const uschar * s = string;
4577 const uschar * save_expand_nstring[EXPAND_MAXN+1];
4578 int save_expand_nlength[EXPAND_MAXN+1];
4579 BOOL resetok = TRUE, first = TRUE, textonly = TRUE;
4580
4581 expand_level++;
4582 f.expand_string_forcedfail = FALSE;
4583 expand_string_message = US"";
4584
4585 if (is_tainted(string))
4586   {
4587   expand_string_message =
4588     string_sprintf("attempt to expand tainted string '%s'", s);
4589   log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4590   goto EXPAND_FAILED;
4591   }
4592
4593 while (*s)
4594   {
4595   uschar name[256];
4596
4597   DEBUG(D_expand)
4598     {
4599     debug_printf_indent("%V%V%s: %W\n",
4600       first ? "/" : "K",
4601       flags & ESI_SKIPPING ? "---" : "",
4602       flags & ESI_SKIPPING ? "scanning" : "considering", s);
4603     first = FALSE;
4604     }
4605
4606   /* \ escapes the next character, which must exist, or else
4607   the expansion fails. There's a special escape, \N, which causes
4608   copying of the subject verbatim up to the next \N. Otherwise,
4609   the escapes are the standard set. */
4610
4611   if (*s == '\\')
4612     {
4613     if (s[1] == 0)
4614       {
4615       expand_string_message = US"\\ at end of string";
4616       goto EXPAND_FAILED;
4617       }
4618
4619     if (s[1] == 'N')
4620       {
4621       const uschar * t = s + 2;
4622       for (s = t; *s ; s++) if (*s == '\\' && s[1] == 'N') break;
4623
4624       DEBUG(D_expand)
4625         debug_expansion_interim(US"protected", t, (int)(s - t), flags);
4626       if (!(flags & ESI_SKIPPING))
4627         yield = string_catn(yield, t, s - t);
4628       if (*s) s += 2;
4629       }
4630     else
4631       {
4632       uschar ch[1];
4633       DEBUG(D_expand)
4634         debug_printf_indent("%Vbackslashed: '\\%c'\n", "K", s[1]);
4635       ch[0] = string_interpret_escape(&s);
4636       if (!(flags & ESI_SKIPPING))
4637         yield = string_catn(yield, ch, 1);
4638       s++;
4639       }
4640     continue;
4641     }
4642
4643                                                                         /*{{*/
4644   /* Anything other than $ is just copied verbatim, unless we are
4645   looking for a terminating } character. */
4646
4647   if (flags & ESI_BRACE_ENDS && *s == '}') break;
4648
4649   if (*s != '$' || !(flags & ESI_HONOR_DOLLAR))
4650     {
4651     int i = 1;                                                          /*{*/
4652     for (const uschar * t = s+1;
4653         *t && *t != '$' && *t != '}' && *t != '\\'; t++) i++;
4654
4655     DEBUG(D_expand) debug_expansion_interim(US"text", s, i, flags);
4656
4657     if (!(flags & ESI_SKIPPING))
4658       yield = string_catn(yield, s, i);
4659     s += i;
4660     continue;
4661     }
4662   textonly = FALSE;
4663
4664   /* No { after the $ - must be a plain name or a number for string
4665   match variable. There has to be a fudge for variables that are the
4666   names of header fields preceded by "$header_" because header field
4667   names can contain any printing characters except space and colon.
4668   For those that don't like typing this much, "$h_" is a synonym for
4669   "$header_". A non-existent header yields a NULL value; nothing is
4670   inserted. */  /*}*/
4671
4672   if (isalpha(*++s))
4673     {
4674     const uschar * value;
4675     int newsize = 0, len;
4676     gstring * g = NULL;
4677     uschar * t;
4678
4679     s = read_name(name, sizeof(name), s, US"_");
4680
4681     /* If this is the first thing to be expanded, release the pre-allocated
4682     buffer. */
4683
4684     if (!(flags & ESI_SKIPPING))
4685       if (!yield)
4686         g = store_get(sizeof(gstring), GET_UNTAINTED);
4687       else if (yield->ptr == 0)
4688         {
4689         if (resetok) reset_point = store_reset(reset_point);
4690         yield = NULL;
4691         reset_point = store_mark();
4692         g = store_get(sizeof(gstring), GET_UNTAINTED);  /* alloc _before_ calling find_variable() */
4693         }
4694
4695     /* Header */
4696
4697     if (  ( *(t = name) == 'h'
4698           || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
4699           )
4700        && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
4701        )
4702       {
4703       unsigned flags = *name == 'r' ? FH_WANT_RAW
4704                       : *name == 'l' ? FH_WANT_RAW|FH_WANT_LIST
4705                       : 0;
4706       const uschar * charset = *name == 'b' ? NULL : headers_charset;
4707
4708       s = read_header_name(name, sizeof(name), s);
4709       value = find_header(name, &newsize, flags, charset);
4710
4711       /* If we didn't find the header, and the header contains a closing brace
4712       character, this may be a user error where the terminating colon
4713       has been omitted. Set a flag to adjust the error message in this case.
4714       But there is no error here - nothing gets inserted. */
4715
4716       if (!value)
4717         {                                                               /*{*/
4718         if (Ustrchr(name, '}')) malformed_header = TRUE;
4719         continue;
4720         }
4721       }
4722
4723     /* Variable */
4724
4725     else if (!(value = find_variable(name, flags, &newsize)))
4726       {
4727       expand_string_message =
4728         string_sprintf("unknown variable name \"%s\"", name);
4729         check_variable_error_message(name);
4730       goto EXPAND_FAILED;
4731       }
4732
4733     /* If the data is known to be in a new buffer, newsize will be set to the
4734     size of that buffer. If this is the first thing in an expansion string,
4735     yield will be NULL; just point it at the new store instead of copying. Many
4736     expansion strings contain just one reference, so this is a useful
4737     optimization, especially for humungous headers.  We need to use a gstring
4738     structure that is not allocated after that new-buffer, else a later store
4739     reset in the middle of the buffer will make it inaccessible. */
4740
4741     len = Ustrlen(value);
4742     DEBUG(D_expand) debug_expansion_interim(US"value", value, len, flags);
4743     if (!(flags & ESI_SKIPPING))
4744       if (!yield && newsize != 0)
4745         {
4746         yield = g;
4747         yield->size = newsize;
4748         yield->ptr = len;
4749         yield->s = US value; /* known to be in new store i.e. a copy, so deconst safe */
4750         }
4751       else
4752         yield = string_catn(yield, value, len);
4753
4754     continue;
4755     }
4756
4757   if (isdigit(*s))              /* A $<n> variable */
4758     {
4759     int n;
4760     s = read_cnumber(&n, s);
4761     if (n >= 0 && n <= expand_nmax)
4762       {
4763       DEBUG(D_expand) debug_expansion_interim(US"value", expand_nstring[n], expand_nlength[n], flags);
4764       if (!(flags & ESI_SKIPPING))
4765         yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4766       }
4767     continue;
4768     }
4769
4770   /* Otherwise, if there's no '{' after $ it's an error. */             /*}*/
4771
4772   if (*s != '{')                                                        /*}*/
4773     {
4774     expand_string_message = US"$ not followed by letter, digit, or {";  /*}*/
4775     goto EXPAND_FAILED;
4776     }
4777
4778   /* After { there can be various things, but they all start with
4779   an initial word, except for a number for a string match variable. */  /*}*/
4780
4781   if (isdigit(*++s))
4782     {
4783     int n;
4784     s = read_cnumber(&n, s);                                            /*{{*/
4785     if (*s++ != '}')
4786       {
4787       expand_string_message = US"} expected after number";
4788       goto EXPAND_FAILED;
4789       }
4790     if (n >= 0 && n <= expand_nmax)
4791       {
4792       DEBUG(D_expand) debug_expansion_interim(US"value", expand_nstring[n], expand_nlength[n], flags);
4793       if (!(flags & ESI_SKIPPING))
4794         yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4795       }
4796     continue;
4797     }
4798
4799   if (!isalpha(*s))
4800     {
4801     expand_string_message = US"letter or digit expected after ${";      /*}*/
4802     goto EXPAND_FAILED;
4803     }
4804
4805   /* Allow "-" in names to cater for substrings with negative
4806   arguments. Since we are checking for known names after { this is
4807   OK. */                                                                /*}*/
4808
4809   s = read_name(name, sizeof(name), s, US"_-");
4810   item_type = chop_match(name, item_table, nelem(item_table));
4811
4812   /* Switch on item type.  All nondefault choices should "continue* when
4813   skipping, but "break" otherwise so we get debug output for the item
4814   expansion. */
4815   {
4816   int expansion_start = gstring_length(yield);
4817   switch(item_type)
4818     {
4819     /* Call an ACL from an expansion.  We feed data in via $acl_arg1 - $acl_arg9.
4820     If the ACL returns accept or reject we return content set by "message ="
4821     There is currently no limit on recursion; this would have us call
4822     acl_check_internal() directly and get a current level from somewhere.
4823     See also the acl expansion condition ECOND_ACL and the traditional
4824     acl modifier ACLC_ACL.
4825     Assume that the function has side-effects on the store that must be preserved.
4826     */
4827
4828     case EITEM_ACL:
4829       /* ${acl {name} {arg1}{arg2}...} */
4830       {
4831       uschar * sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4832       uschar * user_msg;
4833       int rc;
4834
4835       switch(read_subs(sub, nelem(sub), 1, &s, flags, TRUE, name, &resetok, NULL))
4836         {
4837         case -1: continue;              /* skipping */
4838         case 1: goto EXPAND_FAILED_CURLY;
4839         case 2:
4840         case 3: goto EXPAND_FAILED;
4841         }
4842
4843       resetok = FALSE;
4844       switch(rc = eval_acl(sub, nelem(sub), &user_msg))
4845         {
4846         case OK:
4847         case FAIL:
4848           DEBUG(D_expand)
4849             debug_printf_indent("acl expansion yield: %s\n", user_msg);
4850           if (user_msg)
4851             yield = string_cat(yield, user_msg);
4852           break;
4853
4854         case DEFER:
4855           f.expand_string_forcedfail = TRUE;
4856           /*FALLTHROUGH*/
4857         default:
4858           expand_string_message = string_sprintf("%s from acl \"%s\"",
4859             rc_names[rc], sub[0]);
4860           goto EXPAND_FAILED;
4861         }
4862       break;
4863       }
4864
4865     case EITEM_AUTHRESULTS:
4866       /* ${authresults {mysystemname}} */
4867       {
4868       uschar * sub_arg[1];
4869
4870       switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, flags, TRUE, name, &resetok, NULL))
4871         {
4872         case -1: continue;      /* If skipping, we don't actually do anything */
4873         case 1: goto EXPAND_FAILED_CURLY;
4874         case 2:
4875         case 3: goto EXPAND_FAILED;
4876         }
4877
4878       yield = string_append(yield, 3,
4879                         US"Authentication-Results: ", sub_arg[0], US"; none");
4880       yield->ptr -= 6;                  /* ignore tha ": none" for now */
4881
4882       yield = authres_local(yield, sub_arg[0]);
4883       yield = authres_iprev(yield);
4884       yield = authres_smtpauth(yield);
4885 #ifdef SUPPORT_SPF
4886         {
4887         misc_module_info * mi = misc_mod_findonly(US"spf");
4888         if (mi)
4889           {
4890           typedef gstring * (*fn_t)(gstring *);
4891           fn_t fn = ((fn_t *) mi->functions)[2];        /* authres_spf */
4892           yield = fn(yield);
4893           }
4894         }
4895 #endif
4896 #ifndef DISABLE_DKIM
4897       yield = authres_dkim(yield);
4898 #endif
4899 #ifdef SUPPORT_DMARC
4900       yield = authres_dmarc(yield);
4901 #endif
4902 #ifdef EXPERIMENTAL_ARC
4903       yield = authres_arc(yield);
4904 #endif
4905       break;
4906       }
4907
4908     /* Handle conditionals - preserve the values of the numerical expansion
4909     variables in case they get changed by a regular expression match in the
4910     condition. If not, they retain their external settings. At the end
4911     of this "if" section, they get restored to their previous values. */
4912
4913     case EITEM_IF:
4914       {
4915       BOOL cond = FALSE;
4916       const uschar *next_s;
4917       int save_expand_nmax =
4918         save_expand_strings(save_expand_nstring, save_expand_nlength);
4919       uschar * save_lookup_value = lookup_value;
4920
4921       Uskip_whitespace(&s);
4922       if (!(next_s = eval_condition(s, &resetok, flags & ESI_SKIPPING ? NULL : &cond)))
4923         goto EXPAND_FAILED;  /* message already set */
4924
4925       DEBUG(D_expand)
4926         {
4927         debug_expansion_interim(US"condition", s, (int)(next_s - s), flags);
4928         debug_expansion_interim(US"result",
4929           cond ? US"true" : US"false", cond ? 4 : 5, flags);
4930         }
4931
4932       s = next_s;
4933
4934       /* The handling of "yes" and "no" result strings is now in a separate
4935       function that is also used by ${lookup} and ${extract} and ${run}. */
4936
4937       switch(process_yesno(
4938                flags,                   /* were previously skipping */
4939                cond,                    /* success/failure indicator */
4940                lookup_value,                    /* value to reset for string2 */
4941                &s,                      /* input pointer */
4942                &yield,                  /* output pointer */
4943                US"if",                  /* condition type */
4944                &resetok))
4945         {
4946         case 1: goto EXPAND_FAILED;          /* when all is well, the */
4947         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
4948         }
4949
4950       /* Restore external setting of expansion variables for continuation
4951       at this level. */
4952
4953       lookup_value = save_lookup_value;
4954       restore_expand_strings(save_expand_nmax, save_expand_nstring,
4955         save_expand_nlength);
4956       break;
4957       }
4958
4959 #ifdef SUPPORT_I18N
4960     case EITEM_IMAPFOLDER:
4961       {                         /* ${imapfolder {name}{sep}{specials}} */
4962       uschar *sub_arg[3];
4963       uschar *encoded;
4964
4965       switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, flags, TRUE, name, &resetok, NULL))
4966         {
4967         case 1: goto EXPAND_FAILED_CURLY;
4968         case 2:
4969         case 3: goto EXPAND_FAILED;
4970         }
4971
4972       if (!sub_arg[1])                  /* One argument */
4973         {
4974         sub_arg[1] = US"/";             /* default separator */
4975         sub_arg[2] = NULL;
4976         }
4977       else if (Ustrlen(sub_arg[1]) != 1)
4978         {
4979         expand_string_message =
4980           string_sprintf(
4981                 "IMAP folder separator must be one character, found \"%s\"",
4982                 sub_arg[1]);
4983         goto EXPAND_FAILED;
4984         }
4985
4986       if (flags & ESI_SKIPPING) continue;
4987
4988       if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4989                           sub_arg[1][0], sub_arg[2], &expand_string_message)))
4990         goto EXPAND_FAILED;
4991       yield = string_cat(yield, encoded);
4992       break;
4993       }
4994 #endif
4995
4996     /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4997     expanding an internal string that isn't actually going to be used. All we
4998     need to do is check the syntax, so don't do a lookup at all. Preserve the
4999     values of the numerical expansion variables in case they get changed by a
5000     partial lookup. If not, they retain their external settings. At the end
5001     of this "lookup" section, they get restored to their previous values. */
5002
5003     case EITEM_LOOKUP:
5004       {
5005       int expand_setup = 0, nameptr = 0;
5006       int partial, affixlen, starflags;
5007       const lookup_info * li;
5008       uschar * key, * filename;
5009       const uschar * affix, * opts;
5010       uschar * save_lookup_value = lookup_value;
5011       int save_expand_nmax =
5012         save_expand_strings(save_expand_nstring, save_expand_nlength);
5013
5014       if (expand_forbid & RDO_LOOKUP)
5015         {
5016         expand_string_message = US"lookup expansions are not permitted";
5017         goto EXPAND_FAILED;
5018         }
5019
5020       /* Get the key we are to look up for single-key+file style lookups.
5021       Otherwise set the key NULL pro-tem. */
5022
5023       if (Uskip_whitespace(&s) == '{')                                  /*}*/
5024         {
5025         key = expand_string_internal(s+1,
5026                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
5027         if (!key) goto EXPAND_FAILED;                   /*{{*/
5028         if (*s++ != '}')
5029           {
5030           expand_string_message = US"missing '}' after lookup key";
5031           goto EXPAND_FAILED_CURLY;
5032           }
5033         Uskip_whitespace(&s);
5034         }
5035       else key = NULL;
5036
5037       /* Find out the type of database */
5038
5039       if (!isalpha(*s))
5040         {
5041         expand_string_message = US"missing lookup type";
5042         goto EXPAND_FAILED;
5043         }
5044
5045       /* The type is a string that may contain special characters of various
5046       kinds. Allow everything except space or { to appear; the actual content
5047       is checked by search_findtype_partial. */         /*}*/
5048
5049       while (*s && *s != '{' && !isspace(*s))           /*}*/
5050         {
5051         if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
5052         s++;
5053         }
5054       name[nameptr] = '\0';
5055       Uskip_whitespace(&s);
5056
5057       /* Now check for the individual search type and any partial or default
5058       options. Only those types that are actually in the binary are valid. */
5059
5060       if (!(li = search_findtype_partial(name, &partial, &affix, &affixlen,
5061           &starflags, &opts)))
5062         {
5063         expand_string_message = search_error_message;
5064         goto EXPAND_FAILED;
5065         }
5066
5067       /* Check that a key was provided for those lookup types that need it,
5068       and was not supplied for those that use the query style. */
5069
5070       if (!mac_islookup(li, lookup_querystyle|lookup_absfilequery))
5071         {
5072         if (!key)
5073           {
5074           expand_string_message = string_sprintf("missing {key} for single-"
5075             "key \"%s\" lookup", name);
5076           goto EXPAND_FAILED;
5077           }
5078         }
5079       else if (key)
5080         {
5081         expand_string_message = string_sprintf("a single key was given for "
5082           "lookup type \"%s\", which is not a single-key lookup type", name);
5083         goto EXPAND_FAILED;
5084         }
5085
5086       /* Get the next string in brackets and expand it. It is the file name for
5087       single-key+file lookups, and the whole query otherwise. In the case of
5088       queries that also require a file name (e.g. sqlite), the file name comes
5089       first. */
5090
5091       if (*s != '{')
5092         {
5093         expand_string_message = US"missing '{' for lookup file-or-query arg";
5094         goto EXPAND_FAILED_CURLY;                                               /*}}*/
5095         }
5096       if (!(filename = expand_string_internal(s+1,
5097                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
5098         goto EXPAND_FAILED;
5099                                                                                 /*{{*/
5100       if (*s++ != '}')
5101         {
5102         expand_string_message = US"missing '}' closing lookup file-or-query arg";
5103         goto EXPAND_FAILED_CURLY;
5104         }
5105       Uskip_whitespace(&s);
5106
5107       /* If this isn't a single-key+file lookup, re-arrange the variables
5108       to be appropriate for the search_ functions. For query-style lookups,
5109       there is just a "key", and no file name. For the special query-style +
5110       file types, the query (i.e. "key") starts with a file name. */
5111
5112       if (!key)
5113         key = search_args(li, name, filename, &filename, opts);
5114
5115       /* If skipping, don't do the next bit - just lookup_value == NULL, as if
5116       the entry was not found. Note that there is no search_close() function.
5117       Files are left open in case of re-use. At suitable places in higher logic,
5118       search_tidyup() is called to tidy all open files. This can save opening
5119       the same file several times. However, files may also get closed when
5120       others are opened, if too many are open at once. The rule is that a
5121       handle should not be used after a second search_open().
5122
5123       Request that a partial search sets up $1 and maybe $2 by passing
5124       expand_setup containing zero. If its value changes, reset expand_nmax,
5125       since new variables will have been set. Note that at the end of this
5126       "lookup" section, the old numeric variables are restored. */
5127
5128       if (flags & ESI_SKIPPING)
5129         lookup_value = NULL;
5130       else
5131         {
5132         void * handle = search_open(filename, li, 0, NULL, NULL);
5133         if (!handle)
5134           {
5135           expand_string_message = search_error_message;
5136           goto EXPAND_FAILED;
5137           }
5138         lookup_value = search_find(handle, filename, key, partial, affix,
5139           affixlen, starflags, &expand_setup, opts);
5140         if (f.search_find_defer)
5141           {
5142           expand_string_message =
5143             string_sprintf("lookup of \"%s\" gave DEFER: %s",
5144               string_printing2(key, SP_TAB), search_error_message);
5145           goto EXPAND_FAILED;
5146           }
5147         if (expand_setup > 0) expand_nmax = expand_setup;
5148         }
5149
5150       /* The handling of "yes" and "no" result strings is now in a separate
5151       function that is also used by ${if} and ${extract}. */
5152
5153       switch(process_yesno(
5154                flags,                   /* were previously skipping */
5155                lookup_value != NULL,    /* success/failure indicator */
5156                save_lookup_value,       /* value to reset for string2 */
5157                &s,                      /* input pointer */
5158                &yield,                  /* output pointer */
5159                US"lookup",              /* condition type */
5160                &resetok))
5161         {
5162         case 1: goto EXPAND_FAILED;          /* when all is well, the */
5163         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
5164         }
5165
5166       /* Restore external setting of expansion variables for carrying on
5167       at this level, and continue. */
5168
5169       restore_expand_strings(save_expand_nmax, save_expand_nstring,
5170         save_expand_nlength);
5171
5172       if (flags & ESI_SKIPPING) continue;
5173       break;
5174       }
5175
5176     /* If Perl support is configured, handle calling embedded perl subroutines,
5177     unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
5178     or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
5179     arguments (defined below). */
5180
5181 #define EXIM_PERL_MAX_ARGS 8
5182
5183     case EITEM_PERL:
5184 #ifndef EXIM_PERL
5185       expand_string_message = US"\"${perl\" encountered, but this facility "    /*}*/
5186         "is not included in this binary";
5187       goto EXPAND_FAILED;
5188
5189 #else   /* EXIM_PERL */
5190       {
5191       uschar * sub_arg[EXIM_PERL_MAX_ARGS + 2];
5192       gstring * new_yield;
5193
5194       if (expand_forbid & RDO_PERL)
5195         {
5196         expand_string_message = US"Perl calls are not permitted";
5197         goto EXPAND_FAILED;
5198         }
5199
5200       switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, flags, TRUE,
5201            name, &resetok, NULL))
5202         {
5203         case -1: continue;      /* If skipping, we don't actually do anything */
5204         case 1: goto EXPAND_FAILED_CURLY;
5205         case 2:
5206         case 3: goto EXPAND_FAILED;
5207         }
5208
5209       /* Start the interpreter if necessary */
5210
5211       if (!opt_perl_started)
5212         {
5213         uschar * initerror;
5214         if (!opt_perl_startup)
5215           {
5216           expand_string_message = US"A setting of perl_startup is needed when "
5217             "using the Perl interpreter";
5218           goto EXPAND_FAILED;
5219           }
5220         DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
5221         if ((initerror = init_perl(opt_perl_startup)))
5222           {
5223           expand_string_message =
5224             string_sprintf("error in perl_startup code: %s\n", initerror);
5225           goto EXPAND_FAILED;
5226           }
5227         opt_perl_started = TRUE;
5228         }
5229
5230       /* Call the function */
5231
5232       sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
5233       new_yield = call_perl_cat(yield, &expand_string_message,
5234         sub_arg[0], sub_arg + 1);
5235
5236       /* NULL yield indicates failure; if the message pointer has been set to
5237       NULL, the yield was undef, indicating a forced failure. Otherwise the
5238       message will indicate some kind of Perl error. */
5239
5240       if (!new_yield)
5241         {
5242         if (!expand_string_message)
5243           {
5244           expand_string_message =
5245             string_sprintf("Perl subroutine \"%s\" returned undef to force "
5246               "failure", sub_arg[0]);
5247           f.expand_string_forcedfail = TRUE;
5248           }
5249         goto EXPAND_FAILED;
5250         }
5251
5252       /* Yield succeeded. Ensure forcedfail is unset, just in case it got
5253       set during a callback from Perl. */
5254
5255       f.expand_string_forcedfail = FALSE;
5256       yield = new_yield;
5257       break;
5258       }
5259 #endif /* EXIM_PERL */
5260
5261     /* Transform email address to "prvs" scheme to use
5262        as BATV-signed return path */
5263
5264     case EITEM_PRVS:
5265       {
5266       uschar * sub_arg[3], * p, * domain;
5267
5268       switch(read_subs(sub_arg, 3, 2, &s, flags, TRUE, name, &resetok, NULL))
5269         {
5270         case -1: continue;      /* If skipping, we don't actually do anything */
5271         case 1: goto EXPAND_FAILED_CURLY;
5272         case 2:
5273         case 3: goto EXPAND_FAILED;
5274         }
5275
5276       /* sub_arg[0] is the address */
5277       if (  !(domain = Ustrrchr(sub_arg[0],'@'))
5278          || domain == sub_arg[0] || Ustrlen(domain) == 1)
5279         {
5280         expand_string_message = US"prvs first argument must be a qualified email address";
5281         goto EXPAND_FAILED;
5282         }
5283
5284       /* Calculate the hash. The third argument must be a single-digit
5285       key number, or unset. */
5286
5287       if (  sub_arg[2]
5288          && (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
5289         {
5290         expand_string_message = US"prvs third argument must be a single digit";
5291         goto EXPAND_FAILED;
5292         }
5293
5294       p = prvs_hmac_sha1(sub_arg[0], sub_arg[1], sub_arg[2], prvs_daystamp(7));
5295       if (!p)
5296         {
5297         expand_string_message = US"prvs hmac-sha1 conversion failed";
5298         goto EXPAND_FAILED;
5299         }
5300
5301       /* Now separate the domain from the local part */
5302       *domain++ = '\0';
5303
5304       yield = string_catn(yield, US"prvs=", 5);
5305       yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);
5306       yield = string_catn(yield, prvs_daystamp(7), 3);
5307       yield = string_catn(yield, p, 6);
5308       yield = string_catn(yield, US"=", 1);
5309       yield = string_cat (yield, sub_arg[0]);
5310       yield = string_catn(yield, US"@", 1);
5311       yield = string_cat (yield, domain);
5312
5313       break;
5314       }
5315
5316     /* Check a prvs-encoded address for validity */
5317
5318     case EITEM_PRVSCHECK:
5319       {
5320       uschar * sub_arg[3], * p;
5321       gstring * g;
5322       const pcre2_code * re;
5323
5324       /* Reset expansion variables */
5325       prvscheck_result = NULL;
5326       prvscheck_address = NULL;
5327       prvscheck_keynum = NULL;
5328
5329       switch(read_subs(sub_arg, 1, 1, &s, flags, FALSE, name, &resetok, NULL))
5330         {
5331         case 1: goto EXPAND_FAILED_CURLY;
5332         case 2:
5333         case 3: goto EXPAND_FAILED;
5334         }
5335
5336       re = regex_must_compile(
5337         US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
5338         MCS_CASELESS | MCS_CACHEABLE, FALSE);
5339
5340       if (regex_match_and_setup(re,sub_arg[0],0,-1))
5341         {
5342         uschar * local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
5343         uschar * key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
5344         uschar * daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
5345         uschar * hash = string_copyn(expand_nstring[3],expand_nlength[3]);
5346         uschar * domain = string_copyn(expand_nstring[5],expand_nlength[5]);
5347
5348         DEBUG(D_expand)
5349           {
5350           debug_printf_indent("prvscheck localpart: %s\n", local_part);
5351           debug_printf_indent("prvscheck key number: %s\n", key_num);
5352           debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
5353           debug_printf_indent("prvscheck hash: %s\n", hash);
5354           debug_printf_indent("prvscheck domain: %s\n", domain);
5355           }
5356
5357         /* Set up expansion variables */
5358         g = string_cat (NULL, local_part);
5359         g = string_catn(g, US"@", 1);
5360         g = string_cat (g, domain);
5361         prvscheck_address = string_from_gstring(g);
5362         prvscheck_keynum = string_copy(key_num);
5363
5364         /* Now expand the second argument */
5365         switch(read_subs(sub_arg, 1, 1, &s, flags, FALSE, name, &resetok, NULL))
5366           {
5367           case 1: goto EXPAND_FAILED_CURLY;
5368           case 2:
5369           case 3: goto EXPAND_FAILED;
5370           }
5371
5372         /* Now we have the key and can check the address. */
5373
5374         p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
5375           daystamp);
5376         if (!p)
5377           {
5378           expand_string_message = US"hmac-sha1 conversion failed";
5379           goto EXPAND_FAILED;
5380           }
5381
5382         DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
5383         DEBUG(D_expand) debug_printf_indent("prvscheck:      own hash is %s\n", p);
5384
5385         if (Ustrcmp(p,hash) == 0)
5386           {
5387           /* Success, valid BATV address. Now check the expiry date. */
5388           uschar *now = prvs_daystamp(0);
5389           unsigned int inow = 0,iexpire = 1;
5390
5391           (void)sscanf(CS now,"%u",&inow);
5392           (void)sscanf(CS daystamp,"%u",&iexpire);
5393
5394           /* When "iexpire" is < 7, a "flip" has occurred.
5395              Adjust "inow" accordingly. */
5396           if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
5397
5398           if (iexpire >= inow)
5399             {
5400             prvscheck_result = US"1";
5401             DEBUG(D_expand) debug_printf_indent("prvscheck: success, $prvscheck_result set to 1\n");
5402             }
5403           else
5404             {
5405             prvscheck_result = NULL;
5406             DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $prvscheck_result unset\n");
5407             }
5408           }
5409         else
5410           {
5411           prvscheck_result = NULL;
5412           DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $prvscheck_result unset\n");
5413           }
5414
5415         /* Now expand the final argument. We leave this till now so that
5416         it can include $prvscheck_result. */
5417
5418         switch(read_subs(sub_arg, 1, 0, &s, flags, TRUE, name, &resetok, NULL))
5419           {
5420           case 1: goto EXPAND_FAILED_CURLY;
5421           case 2:
5422           case 3: goto EXPAND_FAILED;
5423           }
5424
5425         yield = string_cat(yield,
5426           !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
5427
5428         /* Reset the "internal" variables afterwards, because they are in
5429         dynamic store that will be reclaimed if the expansion succeeded. */
5430
5431         prvscheck_address = NULL;
5432         prvscheck_keynum = NULL;
5433         }
5434       else
5435         /* Does not look like a prvs encoded address, return the empty string.
5436            We need to make sure all subs are expanded first, so as to skip over
5437            the entire item. */
5438
5439         switch(read_subs(sub_arg, 2, 1, &s, flags, TRUE, name, &resetok, NULL))
5440           {
5441           case 1: goto EXPAND_FAILED_CURLY;
5442           case 2:
5443           case 3: goto EXPAND_FAILED;
5444           }
5445
5446       if (flags & ESI_SKIPPING) continue;
5447       break;
5448       }
5449
5450     /* Handle "readfile" to insert an entire file */
5451
5452     case EITEM_READFILE:
5453       {
5454       FILE * f;
5455       uschar * sub_arg[2];
5456
5457       if ((expand_forbid & RDO_READFILE) != 0)
5458         {
5459         expand_string_message = US"file insertions are not permitted";
5460         goto EXPAND_FAILED;
5461         }
5462
5463       switch(read_subs(sub_arg, 2, 1, &s, flags, TRUE, name, &resetok, NULL))
5464         {
5465         case -1: continue;      /* If skipping, we don't actually do anything */
5466         case 1: goto EXPAND_FAILED_CURLY;
5467         case 2:
5468         case 3: goto EXPAND_FAILED;
5469         }
5470
5471       /* Open the file and read it */
5472
5473       if (!(f = Ufopen(sub_arg[0], "rb")))
5474         {
5475         expand_string_message = string_open_failed("%s", sub_arg[0]);
5476         goto EXPAND_FAILED;
5477         }
5478
5479       yield = cat_file(f, yield, sub_arg[1]);
5480       (void)fclose(f);
5481       break;
5482       }
5483
5484     /* Handle "readsocket" to insert data from a socket, either
5485     Inet or Unix domain */
5486
5487     case EITEM_READSOCK:
5488       {
5489       uschar * arg;
5490       uschar * sub_arg[4];
5491
5492       if (expand_forbid & RDO_READSOCK)
5493         {
5494         expand_string_message = US"socket insertions are not permitted";
5495         goto EXPAND_FAILED;
5496         }
5497
5498       /* Read up to 4 arguments, but don't do the end of item check afterwards,
5499       because there may be a string for expansion on failure. */
5500
5501       switch(read_subs(sub_arg, 4, 2, &s, flags, FALSE, name, &resetok, NULL))
5502         {
5503         case 1: goto EXPAND_FAILED_CURLY;
5504         case 2:                             /* Won't occur: no end check */
5505         case 3: goto EXPAND_FAILED;
5506         }
5507
5508       /* If skipping, we don't actually do anything. Otherwise, arrange to
5509       connect to either an IP or a Unix socket. */
5510
5511       if (!(flags & ESI_SKIPPING))
5512         {
5513         const lookup_info * li = search_findtype(US"readsock", 8);
5514         gstring * g = NULL;
5515         void * handle;
5516         int expand_setup = -1;
5517         uschar * s;
5518
5519         if (!li)
5520           {
5521           expand_string_message = search_error_message;
5522           goto EXPAND_FAILED;
5523           }
5524
5525         /* If the reqstr is empty, flag that and set a dummy */
5526
5527         if (!sub_arg[1][0])
5528           {
5529           g = string_append_listele(g, ',', US"send=no");
5530           sub_arg[1] = US"DUMMY";
5531           }
5532
5533         /* Re-marshall the options */
5534
5535         if (sub_arg[2])
5536           {
5537           const uschar * list = sub_arg[2];
5538           uschar * item;
5539           int sep = 0;
5540
5541           /* First option has no tag and is timeout */
5542           if ((item = string_nextinlist(&list, &sep, NULL, 0)))
5543             g = string_append_listele(g, ',',
5544                   string_sprintf("timeout=%s", item));
5545
5546           /* The rest of the options from the expansion */
5547           while ((item = string_nextinlist(&list, &sep, NULL, 0)))
5548             g = string_append_listele(g, ',', item);
5549
5550           /* possibly plus an EOL string.  Process with escapes, to protect
5551           from list-processing.  The only current user of eol= in search
5552           options is the readsock expansion. */
5553
5554           if (sub_arg[3] && *sub_arg[3])
5555             g = string_append_listele(g, ',',
5556                   string_sprintf("eol=%s",
5557                     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 */