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_module,        US"dmarc" },
 517   { "dmarc_status",        vtype_module,        US"dmarc" },
 518   { "dmarc_status_text",   vtype_module,        US"dmarc" },
 519   { "dmarc_used_domain",   vtype_module,        US"dmarc" },
 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)[1];        /* 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         {
4901         misc_module_info * mi = misc_mod_findonly(US"dmarc");
4902         if (mi)
4903           {
4904           /*XXX is authres common enough to be generic? */
4905           typedef gstring * (*fn_t)(gstring *);
4906           fn_t fn = ((fn_t *) mi->functions)[2];        /* authres_dmarc*/
4907           yield = fn(yield);
4908           }
4909         }
4910 #endif
4911 #ifdef EXPERIMENTAL_ARC
4912       yield = authres_arc(yield);
4913 #endif
4914       break;
4915       }
4916
4917     /* Handle conditionals - preserve the values of the numerical expansion
4918     variables in case they get changed by a regular expression match in the
4919     condition. If not, they retain their external settings. At the end
4920     of this "if" section, they get restored to their previous values. */
4921
4922     case EITEM_IF:
4923       {
4924       BOOL cond = FALSE;
4925       const uschar *next_s;
4926       int save_expand_nmax =
4927         save_expand_strings(save_expand_nstring, save_expand_nlength);
4928       uschar * save_lookup_value = lookup_value;
4929
4930       Uskip_whitespace(&s);
4931       if (!(next_s = eval_condition(s, &resetok, flags & ESI_SKIPPING ? NULL : &cond)))
4932         goto EXPAND_FAILED;  /* message already set */
4933
4934       DEBUG(D_expand)
4935         {
4936         debug_expansion_interim(US"condition", s, (int)(next_s - s), flags);
4937         debug_expansion_interim(US"result",
4938           cond ? US"true" : US"false", cond ? 4 : 5, flags);
4939         }
4940
4941       s = next_s;
4942
4943       /* The handling of "yes" and "no" result strings is now in a separate
4944       function that is also used by ${lookup} and ${extract} and ${run}. */
4945
4946       switch(process_yesno(
4947                flags,                   /* were previously skipping */
4948                cond,                    /* success/failure indicator */
4949                lookup_value,                    /* value to reset for string2 */
4950                &s,                      /* input pointer */
4951                &yield,                  /* output pointer */
4952                US"if",                  /* condition type */
4953                &resetok))
4954         {
4955         case 1: goto EXPAND_FAILED;          /* when all is well, the */
4956         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
4957         }
4958
4959       /* Restore external setting of expansion variables for continuation
4960       at this level. */
4961
4962       lookup_value = save_lookup_value;
4963       restore_expand_strings(save_expand_nmax, save_expand_nstring,
4964         save_expand_nlength);
4965       break;
4966       }
4967
4968 #ifdef SUPPORT_I18N
4969     case EITEM_IMAPFOLDER:
4970       {                         /* ${imapfolder {name}{sep}{specials}} */
4971       uschar *sub_arg[3];
4972       uschar *encoded;
4973
4974       switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, flags, TRUE, name, &resetok, NULL))
4975         {
4976         case 1: goto EXPAND_FAILED_CURLY;
4977         case 2:
4978         case 3: goto EXPAND_FAILED;
4979         }
4980
4981       if (!sub_arg[1])                  /* One argument */
4982         {
4983         sub_arg[1] = US"/";             /* default separator */
4984         sub_arg[2] = NULL;
4985         }
4986       else if (Ustrlen(sub_arg[1]) != 1)
4987         {
4988         expand_string_message =
4989           string_sprintf(
4990                 "IMAP folder separator must be one character, found \"%s\"",
4991                 sub_arg[1]);
4992         goto EXPAND_FAILED;
4993         }
4994
4995       if (flags & ESI_SKIPPING) continue;
4996
4997       if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4998                           sub_arg[1][0], sub_arg[2], &expand_string_message)))
4999         goto EXPAND_FAILED;
5000       yield = string_cat(yield, encoded);
5001       break;
5002       }
5003 #endif
5004
5005     /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
5006     expanding an internal string that isn't actually going to be used. All we
5007     need to do is check the syntax, so don't do a lookup at all. Preserve the
5008     values of the numerical expansion variables in case they get changed by a
5009     partial lookup. If not, they retain their external settings. At the end
5010     of this "lookup" section, they get restored to their previous values. */
5011
5012     case EITEM_LOOKUP:
5013       {
5014       int expand_setup = 0, nameptr = 0;
5015       int partial, affixlen, starflags;
5016       const lookup_info * li;
5017       uschar * key, * filename;
5018       const uschar * affix, * opts;
5019       uschar * save_lookup_value = lookup_value;
5020       int save_expand_nmax =
5021         save_expand_strings(save_expand_nstring, save_expand_nlength);
5022
5023       if (expand_forbid & RDO_LOOKUP)
5024         {
5025         expand_string_message = US"lookup expansions are not permitted";
5026         goto EXPAND_FAILED;
5027         }
5028
5029       /* Get the key we are to look up for single-key+file style lookups.
5030       Otherwise set the key NULL pro-tem. */
5031
5032       if (Uskip_whitespace(&s) == '{')                                  /*}*/
5033         {
5034         key = expand_string_internal(s+1,
5035                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
5036         if (!key) goto EXPAND_FAILED;                   /*{{*/
5037         if (*s++ != '}')
5038           {
5039           expand_string_message = US"missing '}' after lookup key";
5040           goto EXPAND_FAILED_CURLY;
5041           }
5042         Uskip_whitespace(&s);
5043         }
5044       else key = NULL;
5045
5046       /* Find out the type of database */
5047
5048       if (!isalpha(*s))
5049         {
5050         expand_string_message = US"missing lookup type";
5051         goto EXPAND_FAILED;
5052         }
5053
5054       /* The type is a string that may contain special characters of various
5055       kinds. Allow everything except space or { to appear; the actual content
5056       is checked by search_findtype_partial. */         /*}*/
5057
5058       while (*s && *s != '{' && !isspace(*s))           /*}*/
5059         {
5060         if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
5061         s++;
5062         }
5063       name[nameptr] = '\0';
5064       Uskip_whitespace(&s);
5065
5066       /* Now check for the individual search type and any partial or default
5067       options. Only those types that are actually in the binary are valid. */
5068
5069       if (!(li = search_findtype_partial(name, &partial, &affix, &affixlen,
5070           &starflags, &opts)))
5071         {
5072         expand_string_message = search_error_message;
5073         goto EXPAND_FAILED;
5074         }
5075
5076       /* Check that a key was provided for those lookup types that need it,
5077       and was not supplied for those that use the query style. */
5078
5079       if (!mac_islookup(li, lookup_querystyle|lookup_absfilequery))
5080         {
5081         if (!key)
5082           {
5083           expand_string_message = string_sprintf("missing {key} for single-"
5084             "key \"%s\" lookup", name);
5085           goto EXPAND_FAILED;
5086           }
5087         }
5088       else if (key)
5089         {
5090         expand_string_message = string_sprintf("a single key was given for "
5091           "lookup type \"%s\", which is not a single-key lookup type", name);
5092         goto EXPAND_FAILED;
5093         }
5094
5095       /* Get the next string in brackets and expand it. It is the file name for
5096       single-key+file lookups, and the whole query otherwise. In the case of
5097       queries that also require a file name (e.g. sqlite), the file name comes
5098       first. */
5099
5100       if (*s != '{')
5101         {
5102         expand_string_message = US"missing '{' for lookup file-or-query arg";
5103         goto EXPAND_FAILED_CURLY;                                               /*}}*/
5104         }
5105       if (!(filename = expand_string_internal(s+1,
5106                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
5107         goto EXPAND_FAILED;
5108                                                                                 /*{{*/
5109       if (*s++ != '}')
5110         {
5111         expand_string_message = US"missing '}' closing lookup file-or-query arg";
5112         goto EXPAND_FAILED_CURLY;
5113         }
5114       Uskip_whitespace(&s);
5115
5116       /* If this isn't a single-key+file lookup, re-arrange the variables
5117       to be appropriate for the search_ functions. For query-style lookups,
5118       there is just a "key", and no file name. For the special query-style +
5119       file types, the query (i.e. "key") starts with a file name. */
5120
5121       if (!key)
5122         key = search_args(li, name, filename, &filename, opts);
5123
5124       /* If skipping, don't do the next bit - just lookup_value == NULL, as if
5125       the entry was not found. Note that there is no search_close() function.
5126       Files are left open in case of re-use. At suitable places in higher logic,
5127       search_tidyup() is called to tidy all open files. This can save opening
5128       the same file several times. However, files may also get closed when
5129       others are opened, if too many are open at once. The rule is that a
5130       handle should not be used after a second search_open().
5131
5132       Request that a partial search sets up $1 and maybe $2 by passing
5133       expand_setup containing zero. If its value changes, reset expand_nmax,
5134       since new variables will have been set. Note that at the end of this
5135       "lookup" section, the old numeric variables are restored. */
5136
5137       if (flags & ESI_SKIPPING)
5138         lookup_value = NULL;
5139       else
5140         {
5141         void * handle = search_open(filename, li, 0, NULL, NULL);
5142         if (!handle)
5143           {
5144           expand_string_message = search_error_message;
5145           goto EXPAND_FAILED;
5146           }
5147         lookup_value = search_find(handle, filename, key, partial, affix,
5148           affixlen, starflags, &expand_setup, opts);
5149         if (f.search_find_defer)
5150           {
5151           expand_string_message =
5152             string_sprintf("lookup of \"%s\" gave DEFER: %s",
5153               string_printing2(key, SP_TAB), search_error_message);
5154           goto EXPAND_FAILED;
5155           }
5156         if (expand_setup > 0) expand_nmax = expand_setup;
5157         }
5158
5159       /* The handling of "yes" and "no" result strings is now in a separate
5160       function that is also used by ${if} and ${extract}. */
5161
5162       switch(process_yesno(
5163                flags,                   /* were previously skipping */
5164                lookup_value != NULL,    /* success/failure indicator */
5165                save_lookup_value,       /* value to reset for string2 */
5166                &s,                      /* input pointer */
5167                &yield,                  /* output pointer */
5168                US"lookup",              /* condition type */
5169                &resetok))
5170         {
5171         case 1: goto EXPAND_FAILED;          /* when all is well, the */
5172         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
5173         }
5174
5175       /* Restore external setting of expansion variables for carrying on
5176       at this level, and continue. */
5177
5178       restore_expand_strings(save_expand_nmax, save_expand_nstring,
5179         save_expand_nlength);
5180
5181       if (flags & ESI_SKIPPING) continue;
5182       break;
5183       }
5184
5185     /* If Perl support is configured, handle calling embedded perl subroutines,
5186     unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
5187     or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
5188     arguments (defined below). */
5189
5190 #define EXIM_PERL_MAX_ARGS 8
5191
5192     case EITEM_PERL:
5193 #ifndef EXIM_PERL
5194       expand_string_message = US"\"${perl\" encountered, but this facility "    /*}*/
5195         "is not included in this binary";
5196       goto EXPAND_FAILED;
5197
5198 #else   /* EXIM_PERL */
5199       {
5200       uschar * sub_arg[EXIM_PERL_MAX_ARGS + 2];
5201       gstring * new_yield;
5202
5203       if (expand_forbid & RDO_PERL)
5204         {
5205         expand_string_message = US"Perl calls are not permitted";
5206         goto EXPAND_FAILED;
5207         }
5208
5209       switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, flags, TRUE,
5210            name, &resetok, NULL))
5211         {
5212         case -1: continue;      /* If skipping, we don't actually do anything */
5213         case 1: goto EXPAND_FAILED_CURLY;
5214         case 2:
5215         case 3: goto EXPAND_FAILED;
5216         }
5217
5218       /* Start the interpreter if necessary */
5219
5220       if (!opt_perl_started)
5221         {
5222         uschar * initerror;
5223         if (!opt_perl_startup)
5224           {
5225           expand_string_message = US"A setting of perl_startup is needed when "
5226             "using the Perl interpreter";
5227           goto EXPAND_FAILED;
5228           }
5229         DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
5230         if ((initerror = init_perl(opt_perl_startup)))
5231           {
5232           expand_string_message =
5233             string_sprintf("error in perl_startup code: %s\n", initerror);
5234           goto EXPAND_FAILED;
5235           }
5236         opt_perl_started = TRUE;
5237         }
5238
5239       /* Call the function */
5240
5241       sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
5242       new_yield = call_perl_cat(yield, &expand_string_message,
5243         sub_arg[0], sub_arg + 1);
5244
5245       /* NULL yield indicates failure; if the message pointer has been set to
5246       NULL, the yield was undef, indicating a forced failure. Otherwise the
5247       message will indicate some kind of Perl error. */
5248
5249       if (!new_yield)
5250         {
5251         if (!expand_string_message)
5252           {
5253           expand_string_message =
5254             string_sprintf("Perl subroutine \"%s\" returned undef to force "
5255               "failure", sub_arg[0]);
5256           f.expand_string_forcedfail = TRUE;
5257           }
5258         goto EXPAND_FAILED;
5259         }
5260
5261       /* Yield succeeded. Ensure forcedfail is unset, just in case it got
5262       set during a callback from Perl. */
5263
5264       f.expand_string_forcedfail = FALSE;
5265       yield = new_yield;
5266       break;
5267       }
5268 #endif /* EXIM_PERL */
5269
5270     /* Transform email address to "prvs" scheme to use
5271        as BATV-signed return path */
5272
5273     case EITEM_PRVS:
5274       {
5275       uschar * sub_arg[3], * p, * domain;
5276
5277       switch(read_subs(sub_arg, 3, 2, &s, flags, TRUE, name, &resetok, NULL))
5278         {
5279         case -1: continue;      /* If skipping, we don't actually do anything */
5280         case 1: goto EXPAND_FAILED_CURLY;
5281         case 2:
5282         case 3: goto EXPAND_FAILED;
5283         }
5284
5285       /* sub_arg[0] is the address */
5286       if (  !(domain = Ustrrchr(sub_arg[0],'@'))
5287          || domain == sub_arg[0] || Ustrlen(domain) == 1)
5288         {
5289         expand_string_message = US"prvs first argument must be a qualified email address";
5290         goto EXPAND_FAILED;
5291         }
5292
5293       /* Calculate the hash. The third argument must be a single-digit
5294       key number, or unset. */
5295
5296       if (  sub_arg[2]
5297          && (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
5298         {
5299         expand_string_message = US"prvs third argument must be a single digit";
5300         goto EXPAND_FAILED;
5301         }
5302
5303       p = prvs_hmac_sha1(sub_arg[0], sub_arg[1], sub_arg[2], prvs_daystamp(7));
5304       if (!p)
5305         {
5306         expand_string_message = US"prvs hmac-sha1 conversion failed";
5307         goto EXPAND_FAILED;
5308         }
5309
5310       /* Now separate the domain from the local part */
5311       *domain++ = '\0';
5312
5313       yield = string_catn(yield, US"prvs=", 5);
5314       yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);
5315       yield = string_catn(yield, prvs_daystamp(7), 3);
5316       yield = string_catn(yield, p, 6);
5317       yield = string_catn(yield, US"=", 1);
5318       yield = string_cat (yield, sub_arg[0]);
5319       yield = string_catn(yield, US"@", 1);
5320       yield = string_cat (yield, domain);
5321
5322       break;
5323       }
5324
5325     /* Check a prvs-encoded address for validity */
5326
5327     case EITEM_PRVSCHECK:
5328       {
5329       uschar * sub_arg[3], * p;
5330       gstring * g;
5331       const pcre2_code * re;
5332
5333       /* Reset expansion variables */
5334       prvscheck_result = NULL;
5335       prvscheck_address = NULL;
5336       prvscheck_keynum = NULL;
5337
5338       switch(read_subs(sub_arg, 1, 1, &s, flags, FALSE, name, &resetok, NULL))
5339         {
5340         case 1: goto EXPAND_FAILED_CURLY;
5341         case 2:
5342         case 3: goto EXPAND_FAILED;
5343         }
5344
5345       re = regex_must_compile(
5346         US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
5347         MCS_CASELESS | MCS_CACHEABLE, FALSE);
5348
5349       if (regex_match_and_setup(re,sub_arg[0],0,-1))
5350         {
5351         uschar * local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
5352         uschar * key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
5353         uschar * daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
5354         uschar * hash = string_copyn(expand_nstring[3],expand_nlength[3]);
5355         uschar * domain = string_copyn(expand_nstring[5],expand_nlength[5]);
5356
5357         DEBUG(D_expand)
5358           {
5359           debug_printf_indent("prvscheck localpart: %s\n", local_part);
5360           debug_printf_indent("prvscheck key number: %s\n", key_num);
5361           debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
5362           debug_printf_indent("prvscheck hash: %s\n", hash);
5363           debug_printf_indent("prvscheck domain: %s\n", domain);
5364           }
5365
5366         /* Set up expansion variables */
5367         g = string_cat (NULL, local_part);
5368         g = string_catn(g, US"@", 1);
5369         g = string_cat (g, domain);
5370         prvscheck_address = string_from_gstring(g);
5371         prvscheck_keynum = string_copy(key_num);
5372
5373         /* Now expand the second argument */
5374         switch(read_subs(sub_arg, 1, 1, &s, flags, FALSE, name, &resetok, NULL))
5375           {
5376           case 1: goto EXPAND_FAILED_CURLY;
5377           case 2:
5378           case 3: goto EXPAND_FAILED;
5379           }
5380
5381         /* Now we have the key and can check the address. */
5382
5383         p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
5384           daystamp);
5385         if (!p)
5386           {
5387           expand_string_message = US"hmac-sha1 conversion failed";
5388           goto EXPAND_FAILED;
5389           }
5390
5391         DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
5392         DEBUG(D_expand) debug_printf_indent("prvscheck:      own hash is %s\n", p);
5393
5394         if (Ustrcmp(p,hash) == 0)
5395           {
5396           /* Success, valid BATV address. Now check the expiry date. */
5397           uschar *now = prvs_daystamp(0);
5398           unsigned int inow = 0,iexpire = 1;
5399
5400           (void)sscanf(CS now,"%u",&inow);
5401           (void)sscanf(CS daystamp,"%u",&iexpire);
5402
5403           /* When "iexpire" is < 7, a "flip" has occurred.
5404              Adjust "inow" accordingly. */
5405           if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
5406
5407           if (iexpire >= inow)
5408             {
5409             prvscheck_result = US"1";
5410             DEBUG(D_expand) debug_printf_indent("prvscheck: success, $prvscheck_result set to 1\n");
5411             }
5412           else
5413             {
5414             prvscheck_result = NULL;
5415             DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $prvscheck_result unset\n");
5416             }
5417           }
5418         else
5419           {
5420           prvscheck_result = NULL;
5421           DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $prvscheck_result unset\n");
5422           }
5423
5424         /* Now expand the final argument. We leave this till now so that
5425         it can include $prvscheck_result. */
5426
5427         switch(read_subs(sub_arg, 1, 0, &s, flags, TRUE, name, &resetok, NULL))
5428           {
5429           case 1: goto EXPAND_FAILED_CURLY;
5430           case 2:
5431           case 3: goto EXPAND_FAILED;
5432           }
5433
5434         yield = string_cat(yield,
5435           !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
5436
5437         /* Reset the "internal" variables afterwards, because they are in
5438         dynamic store that will be reclaimed if the expansion succeeded. */
5439
5440         prvscheck_address = NULL;
5441         prvscheck_keynum = NULL;
5442         }
5443       else
5444         /* Does not look like a prvs encoded address, return the empty string.
5445            We need to make sure all subs are expanded first, so as to skip over
5446            the entire item. */
5447
5448         switch(read_subs(sub_arg, 2, 1, &s, flags, TRUE, name, &resetok, NULL))
5449           {
5450           case 1: goto EXPAND_FAILED_CURLY;
5451           case 2:
5452           case 3: goto EXPAND_FAILED;
5453           }
5454
5455       if (flags & ESI_SKIPPING) continue;
5456       break;
5457       }
5458
5459     /* Handle "readfile" to insert an entire file */
5460
5461     case EITEM_READFILE:
5462       {
5463       FILE * f;
5464       uschar * sub_arg[2];
5465
5466       if ((expand_forbid & RDO_READFILE) != 0)
5467         {
5468         expand_string_message = US"file insertions are not permitted";
5469         goto EXPAND_FAILED;
5470         }
5471
5472       switch(read_subs(sub_arg, 2, 1, &s, flags, TRUE, name, &resetok, NULL))
5473         {
5474         case -1: continue;      /* If skipping, we don't actually do anything */
5475         case 1: goto EXPAND_FAILED_CURLY;
5476         case 2:
5477         case 3: goto EXPAND_FAILED;
5478         }
5479
5480       /* Open the file and read it */
5481
5482       if (!(f = Ufopen(sub_arg[0], "rb")))
5483         {
5484         expand_string_message = string_open_failed("%s", sub_arg[0]);
5485         goto EXPAND_FAILED;
5486         }
5487
5488       yield = cat_file(f, yield, sub_arg[1]);
5489       (void)fclose(f);
5490       break;
5491       }
5492
5493     /* Handle "readsocket" to insert data from a socket, either
5494     Inet or Unix domain */
5495
5496     case EITEM_READSOCK:
5497       {
5498       uschar * arg;
5499       uschar * sub_arg[4];
5500
5501       if (expand_forbid & RDO_READSOCK)
5502         {
5503         expand_string_message = US"socket insertions are not permitted";
5504         goto EXPAND_FAILED;
5505         }
5506
5507       /* Read up to 4 arguments, but don't do the end of item check afterwards,
5508       because there may be a string for expansion on failure. */
5509
5510       switch(read_subs(sub_arg, 4, 2, &s, flags, FALSE, name, &resetok, NULL))
5511         {
5512         case 1: goto EXPAND_FAILED_CURLY;
5513         case 2:                             /* Won't occur: no end check */
5514         case 3: goto EXPAND_FAILED;
5515         }
5516
5517       /* If skipping, we don't actually do anything. Otherwise, arrange to
5518       connect to either an IP or a Unix socket. */
5519
5520       if (!(flags & ESI_SKIPPING))
5521         {
5522         const lookup_info * li = search_findtype(US"readsock", 8);
5523         gstring * g = NULL;
5524         void * handle;
5525         int expand_setup = -1;
5526         uschar * s;
5527
5528         if (!li)
5529           {
5530           expand_string_message = search_error_message;
5531           goto EXPAND_FAILED;
5532           }
5533
5534         /* If the reqstr is empty, flag that and set a dummy */
5535
5536         if (!sub_arg[1][0])
5537           {
5538           g = string_append_listele(g, ',', US"send=no");
5539           sub_arg[1] = US"DUMMY";
5540           }
5541
5542         /* Re-marshall the options */
5543
5544         if (sub_arg[2])
5545           {
5546           const uschar * list = sub_arg[2];
5547           uschar * item;
5548           int sep = 0;
5549
5550           /* First option has no tag and is timeout */
5551           if ((item = string_nextinlist(&list, &sep, NULL, 0)))
5552             g = string_append_listele(g, ',',
5553                   string_sprintf("timeout=%s", item));
5554
5555           /* The rest of the options from the expansion */
5556           while ((item = string_nextinlist(&list, &sep, NULL, 0)))
5557             g = string_append_listele(g, ',', item);
5558
5559           /* possibly plus an EOL string.  Process with escapes, to protect
5560           from list-processing.  The only current user of eol= in search
5561           options is the readsock expansion. */
5562
5563           if (sub_arg[3] && *sub_arg[3])
5564             g = string_append_listele(g, ',',
5565                   string_sprintf("eol=%s",
5566                     string_printing2(sub_arg[3], SP_TAB|SP_SPACE)));
5567           }
5568
5569         /* Gat a (possibly cached) handle for the connection */
5570
5571         if (!(handle = search_open(sub_arg[0], li, 0, NULL, NULL)))
5572           {
5573           if (*expand_string_message) goto EXPAND_FAILED;
5574           expand_string_message = search_error_message;
5575           search_error_message = NULL;
5576           goto SOCK_FAIL;
5577           }
5578
5579         /* Get (possibly cached) results for the lookup */
5580         /* sspec: sub_arg[0]  req: sub_arg[1]  opts: g */
5581
5582         if ((s = search_find(handle, sub_arg[0], sub_arg[1], -1, NULL, 0, 0,
5583                                     &expand_setup, string_from_gstring(g))))
5584           yield = string_cat(yield, s);
5585         else if (f.search_find_defer)
5586           {
5587           expand_string_message = search_error_message;
5588           search_error_message = NULL;
5589           goto SOCK_FAIL;
5590           }
5591         else
5592           {     /* should not happen, at present */
5593           expand_string_message = search_error_message;
5594           search_error_message = NULL;
5595           goto SOCK_FAIL;
5596           }
5597         }
5598
5599       /* The whole thing has worked (or we were skipping). If there is a
5600       failure string following, we need to skip it. */
5601
5602       if (*s == '{')                                                    /*}*/
5603         {
5604         if (!expand_string_internal(s+1,
5605           ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL))
5606           goto EXPAND_FAILED;                                           /*{*/
5607         if (*s++ != '}')
5608           {                                                             /*{*/
5609           expand_string_message = US"missing '}' closing failstring for readsocket";
5610           goto EXPAND_FAILED_CURLY;
5611           }
5612         Uskip_whitespace(&s);
5613         }
5614
5615     READSOCK_DONE:                                                      /*{*/
5616       if (*s++ != '}')
5617         {                                                               /*{*/
5618         expand_string_message = US"missing '}' closing readsocket";
5619         goto EXPAND_FAILED_CURLY;
5620         }
5621       if (flags & ESI_SKIPPING) continue;
5622       break;
5623
5624       /* Come here on failure to create socket, connect socket, write to the
5625       socket, or timeout on reading. If another substring follows, expand and
5626       use it. Otherwise, those conditions give expand errors. */
5627
5628     SOCK_FAIL:
5629       if (*s != '{') goto EXPAND_FAILED;                                /*}*/
5630       DEBUG(D_any) debug_printf("%s\n", expand_string_message);
5631       if (!(arg = expand_string_internal(s+1,
5632                     ESI_BRACE_ENDS | ESI_HONOR_DOLLAR, &s, &resetok, NULL)))
5633         goto EXPAND_FAILED;
5634       yield = string_cat(yield, arg);                                   /*{*/
5635       if (*s++ != '}')
5636         {                                                               /*{*/
5637         expand_string_message = US"missing '}' closing failstring for readsocket";
5638         goto EXPAND_FAILED_CURLY;
5639         }
5640       Uskip_whitespace(&s);
5641       goto READSOCK_DONE;
5642       }
5643
5644     /* Handle "run" to execute a program. */
5645
5646     case EITEM_RUN:
5647       {
5648       FILE * f;
5649       const uschar * arg, ** argv;
5650       unsigned late_expand = TSUC_EXPAND_ARGS | TSUC_ALLOW_TAINTED_ARGS | TSUC_ALLOW_RECIPIENTS;
5651
5652       if (expand_forbid & RDO_RUN)
5653         {
5654         expand_string_message = US"running a command is not permitted";
5655         goto EXPAND_FAILED;
5656         }
5657
5658       /* Handle options to the "run" */
5659
5660       while (*s == ',')
5661         if (Ustrncmp(++s, "preexpand", 9) == 0)
5662           { late_expand = 0; s += 9; }
5663         else
5664           {
5665           const uschar * t = s;
5666           while (isalpha(*++t)) ;
5667           expand_string_message = string_sprintf("bad option '%.*s' for run",
5668                                                   (int)(t-s), s);
5669           goto EXPAND_FAILED;
5670           }
5671       Uskip_whitespace(&s);
5672
5673       if (*s != '{')                                    /*}*/
5674         {
5675         expand_string_message = US"missing '{' for command arg of run";
5676         goto EXPAND_FAILED_CURLY;                       /*"}*/
5677         }
5678       s++;
5679
5680       if (late_expand)          /* this is the default case */
5681         {
5682         int n;
5683         const uschar * t;
5684         /* Locate the end of the args */
5685         (void) expand_string_internal(s,
5686           ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &t, NULL, NULL);
5687         n = t - s;
5688         arg = flags & ESI_SKIPPING ? NULL : string_copyn(s, n);
5689         s += n;
5690         }
5691       else
5692         {
5693         DEBUG(D_expand)
5694           debug_printf_indent("args string for ${run} expand before split\n");
5695         if (!(arg = expand_string_internal(s,
5696                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
5697           goto EXPAND_FAILED;
5698         Uskip_whitespace(&s);
5699         }
5700                                                         /*{*/
5701       if (*s++ != '}')
5702         {                                               /*{*/
5703         expand_string_message = US"missing '}' closing command arg of run";
5704         goto EXPAND_FAILED_CURLY;
5705         }
5706
5707       if (flags & ESI_SKIPPING)   /* Just pretend it worked when we're skipping */
5708         {
5709         runrc = 0;
5710         lookup_value = NULL;
5711         }
5712       else
5713         {
5714         int fd_in, fd_out;
5715         pid_t pid;
5716
5717         if (!transport_set_up_command(&argv,    /* anchor for arg list */
5718             arg,                                /* raw command */
5719             late_expand,                /* expand args if not already done */
5720             0,                          /* not relevant when... */
5721             NULL,                       /* no transporting address */
5722             US"${run} expansion",       /* for error messages */
5723             &expand_string_message))    /* where to put error message */
5724           goto EXPAND_FAILED;
5725
5726         /* Create the child process, making it a group leader. */
5727
5728         if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE,
5729                               US"expand-run")) < 0)
5730           {
5731           expand_string_message =
5732             string_sprintf("couldn't create child process: %s", strerror(errno));
5733           goto EXPAND_FAILED;
5734           }
5735
5736         /* Nothing is written to the standard input. */
5737
5738         (void)close(fd_in);
5739
5740         /* Read the pipe to get the command's output into $value (which is kept
5741         in lookup_value). Read during execution, so that if the output exceeds
5742         the OS pipe buffer limit, we don't block forever. Remember to not release
5743         memory just allocated for $value. */
5744
5745         resetok = FALSE;
5746         f = fdopen(fd_out, "rb");
5747         sigalrm_seen = FALSE;
5748         ALARM(60);
5749         lookup_value = string_from_gstring(cat_file(f, NULL, NULL));
5750         ALARM_CLR(0);
5751         (void)fclose(f);
5752
5753         /* Wait for the process to finish, applying the timeout, and inspect its
5754         return code for serious disasters. Simple non-zero returns are passed on.
5755         */
5756
5757         if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)
5758           {
5759           if (sigalrm_seen || runrc == -256)
5760             {
5761             expand_string_message = US"command timed out";
5762             killpg(pid, SIGKILL);       /* Kill the whole process group */
5763             }
5764
5765           else if (runrc == -257)
5766             expand_string_message = string_sprintf("wait() failed: %s",
5767               strerror(errno));
5768
5769           else
5770             expand_string_message = string_sprintf("command killed by signal %d",
5771               -runrc);
5772
5773           goto EXPAND_FAILED;
5774           }
5775         }
5776
5777       /* Process the yes/no strings; $value may be useful in both cases */
5778
5779       switch(process_yesno(
5780                flags,                   /* were previously skipping */
5781                runrc == 0,              /* success/failure indicator */
5782                lookup_value,            /* value to reset for string2 */
5783                &s,                      /* input pointer */
5784                &yield,                  /* output pointer */
5785                US"run",                 /* condition type */
5786                &resetok))
5787         {
5788         case 1: goto EXPAND_FAILED;          /* when all is well, the */
5789         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
5790         }
5791
5792       if (flags & ESI_SKIPPING) continue;
5793       break;
5794       }
5795
5796     /* Handle character translation for "tr" */
5797
5798     case EITEM_TR:
5799       {
5800       int oldptr = gstring_length(yield);
5801       int o2m;
5802       uschar * sub[3];
5803
5804       switch(read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, NULL))
5805         {
5806         case -1: continue;      /* skipping */
5807         case 1: goto EXPAND_FAILED_CURLY;
5808         case 2:
5809         case 3: goto EXPAND_FAILED;
5810         }
5811
5812       if (  (yield = string_cat(yield, sub[0]))
5813          && (o2m = Ustrlen(sub[2]) - 1) >= 0)
5814           for (; oldptr < yield->ptr; oldptr++)
5815         {
5816         uschar * m = Ustrrchr(sub[1], yield->s[oldptr]);
5817         if (m)
5818           {
5819           int o = m - sub[1];
5820           yield->s[oldptr] = sub[2][o < o2m ? o : o2m];
5821           }
5822         }
5823
5824       break;
5825       }
5826
5827     /* Handle "hash", "length", "nhash", and "substr" when they are given with
5828     expanded arguments. */
5829
5830     case EITEM_HASH:
5831     case EITEM_LENGTH:
5832     case EITEM_NHASH:
5833     case EITEM_SUBSTR:
5834       {
5835       int len;
5836       uschar *ret;
5837       int val[2] = { 0, -1 };
5838       uschar * sub[3];
5839
5840       /* "length" takes only 2 arguments whereas the others take 2 or 3.
5841       Ensure that sub[2] is set in the ${length } case. */
5842
5843       sub[2] = NULL;
5844       switch(read_subs(sub, item_type == EITEM_LENGTH ? 2:3, 2, &s, flags,
5845              TRUE, name, &resetok, NULL))
5846         {
5847         case -1: continue;      /* skipping */
5848         case 1: goto EXPAND_FAILED_CURLY;
5849         case 2:
5850         case 3: goto EXPAND_FAILED;
5851         }
5852
5853       /* Juggle the arguments if there are only two of them: always move the
5854       string to the last position and make ${length{n}{str}} equivalent to
5855       ${substr{0}{n}{str}}. See the defaults for val[] above. */
5856
5857       if (!sub[2])
5858         {
5859         sub[2] = sub[1];
5860         sub[1] = NULL;
5861         if (item_type == EITEM_LENGTH)
5862           {
5863           sub[1] = sub[0];
5864           sub[0] = NULL;
5865           }
5866         }
5867
5868       for (int i = 0; i < 2; i++) if (sub[i])
5869         {
5870         val[i] = (int)Ustrtol(sub[i], &ret, 10);
5871         if (*ret != 0 || (i != 0 && val[i] < 0))
5872           {
5873           expand_string_message = string_sprintf("\"%s\" is not a%s number "
5874             "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5875           goto EXPAND_FAILED;
5876           }
5877         }
5878
5879       ret =
5880         item_type == EITEM_HASH
5881         ?  compute_hash(sub[2], val[0], val[1], &len)
5882         : item_type == EITEM_NHASH
5883         ? compute_nhash(sub[2], val[0], val[1], &len)
5884         : extract_substr(sub[2], val[0], val[1], &len);
5885       if (!ret)
5886         goto EXPAND_FAILED;
5887       yield = string_catn(yield, ret, len);
5888       break;
5889       }
5890
5891     /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5892     This code originally contributed by Steve Haslam. It currently supports
5893     the use of MD5 and SHA-1 hashes.
5894
5895     We need some workspace that is large enough to handle all the supported
5896     hash types. Use macros to set the sizes rather than be too elaborate. */
5897
5898     #define MAX_HASHLEN      20
5899     #define MAX_HASHBLOCKLEN 64
5900
5901     case EITEM_HMAC:
5902       {
5903       uschar * sub[3];
5904       md5 md5_base;
5905       hctx sha1_ctx;
5906       void * use_base;
5907       int type;
5908       int hashlen;      /* Number of octets for the hash algorithm's output */
5909       int hashblocklen; /* Number of octets the hash algorithm processes */
5910       uschar * keyptr, * p;
5911       unsigned int keylen;
5912
5913       uschar keyhash[MAX_HASHLEN];
5914       uschar innerhash[MAX_HASHLEN];
5915       uschar finalhash[MAX_HASHLEN];
5916       uschar finalhash_hex[2*MAX_HASHLEN];
5917       uschar innerkey[MAX_HASHBLOCKLEN];
5918       uschar outerkey[MAX_HASHBLOCKLEN];
5919
5920       switch (read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, NULL))
5921         {
5922         case -1: continue;      /* skipping */
5923         case 1: goto EXPAND_FAILED_CURLY;
5924         case 2:
5925         case 3: goto EXPAND_FAILED;
5926         }
5927
5928       if (Ustrcmp(sub[0], "md5") == 0)
5929         {
5930         type = HMAC_MD5;
5931         use_base = &md5_base;
5932         hashlen = 16;
5933         hashblocklen = 64;
5934         }
5935       else if (Ustrcmp(sub[0], "sha1") == 0)
5936         {
5937         type = HMAC_SHA1;
5938         use_base = &sha1_ctx;
5939         hashlen = 20;
5940         hashblocklen = 64;
5941         }
5942       else
5943         {
5944         expand_string_message =
5945           string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5946         goto EXPAND_FAILED;
5947         }
5948
5949       keyptr = sub[1];
5950       keylen = Ustrlen(keyptr);
5951
5952       /* If the key is longer than the hash block length, then hash the key
5953       first */
5954
5955       if (keylen > hashblocklen)
5956         {
5957         chash_start(type, use_base);
5958         chash_end(type, use_base, keyptr, keylen, keyhash);
5959         keyptr = keyhash;
5960         keylen = hashlen;
5961         }
5962
5963       /* Now make the inner and outer key values */
5964
5965       memset(innerkey, 0x36, hashblocklen);
5966       memset(outerkey, 0x5c, hashblocklen);
5967
5968       for (int i = 0; i < keylen; i++)
5969         {
5970         innerkey[i] ^= keyptr[i];
5971         outerkey[i] ^= keyptr[i];
5972         }
5973
5974       /* Now do the hashes */
5975
5976       chash_start(type, use_base);
5977       chash_mid(type, use_base, innerkey);
5978       chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5979
5980       chash_start(type, use_base);
5981       chash_mid(type, use_base, outerkey);
5982       chash_end(type, use_base, innerhash, hashlen, finalhash);
5983
5984       /* Encode the final hash as a hex string */
5985
5986       p = finalhash_hex;
5987       for (int i = 0; i < hashlen; i++)
5988         {
5989         *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5990         *p++ = hex_digits[finalhash[i] & 0x0f];
5991         }
5992
5993       DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
5994         sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);
5995
5996       yield = string_catn(yield, finalhash_hex, hashlen*2);
5997       break;
5998       }
5999
6000     /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
6001     We have to save the numerical variables and restore them afterwards. */
6002
6003     case EITEM_SG:
6004       {
6005       const pcre2_code * re;
6006       int moffset, moffsetextra, slen;
6007       pcre2_match_data * md;
6008       int emptyopt;
6009       uschar * subject, * sub[3];
6010       int save_expand_nmax =
6011         save_expand_strings(save_expand_nstring, save_expand_nlength);
6012       unsigned sub_textonly = 0;
6013
6014       switch(read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, &sub_textonly))
6015         {
6016         case -1: continue;      /* skipping */
6017         case 1: goto EXPAND_FAILED_CURLY;
6018         case 2:
6019         case 3: goto EXPAND_FAILED;
6020         }
6021
6022       /* Compile the regular expression */
6023
6024       re = regex_compile(sub[1],
6025               sub_textonly & BIT(1) ? MCS_CACHEABLE : MCS_NOFLAGS,
6026               &expand_string_message, pcre_gen_cmp_ctx);
6027       if (!re)
6028         goto EXPAND_FAILED;
6029
6030       md = pcre2_match_data_create(EXPAND_MAXN + 1, pcre_gen_ctx);
6031
6032       /* Now run a loop to do the substitutions as often as necessary. It ends
6033       when there are no more matches. Take care over matches of the null string;
6034       do the same thing as Perl does. */
6035
6036       subject = sub[0];
6037       slen = Ustrlen(sub[0]);
6038       moffset = moffsetextra = 0;
6039       emptyopt = 0;
6040
6041       for (;;)
6042         {
6043         PCRE2_SIZE * ovec = pcre2_get_ovector_pointer(md);
6044         int n = pcre2_match(re, (PCRE2_SPTR)subject, slen, moffset + moffsetextra,
6045           PCRE_EOPT | emptyopt, md, pcre_gen_mtc_ctx);
6046         uschar * insert;
6047
6048         /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
6049         is not necessarily the end. We want to repeat the match from one
6050         character further along, but leaving the basic offset the same (for
6051         copying below). We can't be at the end of the string - that was checked
6052         before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
6053         finished; copy the remaining string and end the loop. */
6054
6055         if (n < 0)
6056           {
6057           if (emptyopt != 0)
6058             {
6059             moffsetextra = 1;
6060             emptyopt = 0;
6061             continue;
6062             }
6063           yield = string_catn(yield, subject+moffset, slen-moffset);
6064           break;
6065           }
6066
6067         /* Match - set up for expanding the replacement. */
6068         DEBUG(D_expand) debug_printf_indent("%s: match\n", name);
6069
6070         if (n == 0) n = EXPAND_MAXN + 1;
6071         expand_nmax = 0;
6072         for (int nn = 0; nn < n*2; nn += 2)
6073           {
6074           expand_nstring[expand_nmax] = subject + ovec[nn];
6075           expand_nlength[expand_nmax++] = ovec[nn+1] - ovec[nn];
6076           }
6077         expand_nmax--;
6078
6079         /* Copy the characters before the match, plus the expanded insertion. */
6080
6081         yield = string_catn(yield, subject + moffset, ovec[0] - moffset);
6082
6083         if (!(insert = expand_string(sub[2])))
6084           goto EXPAND_FAILED;
6085         yield = string_cat(yield, insert);
6086
6087         moffset = ovec[1];
6088         moffsetextra = 0;
6089         emptyopt = 0;
6090
6091         /* If we have matched an empty string, first check to see if we are at
6092         the end of the subject. If so, the loop is over. Otherwise, mimic
6093         what Perl's /g options does. This turns out to be rather cunning. First
6094         we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
6095         string at the same point. If this fails (picked up above) we advance to
6096         the next character. */
6097
6098         if (ovec[0] == ovec[1])
6099           {
6100           if (ovec[0] == slen) break;
6101           emptyopt = PCRE2_NOTEMPTY | PCRE2_ANCHORED;
6102           }
6103         }
6104
6105       /* All done - restore numerical variables. */
6106
6107       /* pcre2_match_data_free(md);     gen ctx needs no free */
6108       restore_expand_strings(save_expand_nmax, save_expand_nstring,
6109         save_expand_nlength);
6110       break;
6111       }
6112
6113     /* Handle keyed and numbered substring extraction. If the first argument
6114     consists entirely of digits, then a numerical extraction is assumed. */
6115
6116     case EITEM_EXTRACT:
6117       {
6118       int field_number = 1;
6119       BOOL field_number_set = FALSE;
6120       uschar * save_lookup_value = lookup_value, * sub[3];
6121       int save_expand_nmax =
6122         save_expand_strings(save_expand_nstring, save_expand_nlength);
6123
6124       /* On reflection the original behaviour of extract-json for a string
6125       result, leaving it quoted, was a mistake.  But it was already published,
6126       hence the addition of jsons.  In a future major version, make json
6127       work like josons, and withdraw jsons. */
6128
6129       enum {extract_basic, extract_json, extract_jsons} fmt = extract_basic;
6130
6131       /* Check for a format-variant specifier */
6132
6133       if (Uskip_whitespace(&s) != '{')                                  /*}*/
6134         if (Ustrncmp(s, "json", 4) == 0)
6135           if (*(s += 4) == 's')
6136             {fmt = extract_jsons; s++;}
6137           else
6138             fmt = extract_json;
6139
6140       /* While skipping we cannot rely on the data for expansions being
6141       available (eg. $item) hence cannot decide on numeric vs. keyed.
6142       Read a maximum of 5 arguments (including the yes/no) */
6143
6144       if (flags & ESI_SKIPPING)
6145         {
6146         for (int j = 5; j > 0 && *s == '{'; j--)                        /*'}'*/
6147           {
6148           if (!expand_string_internal(s+1,
6149                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL))
6150             goto EXPAND_FAILED;                                 /*'{'*/
6151           if (*s++ != '}')
6152             {
6153             expand_string_message = US"missing '{' for arg of extract";
6154             goto EXPAND_FAILED_CURLY;
6155             }
6156           Uskip_whitespace(&s);
6157           }
6158         if (  Ustrncmp(s, "fail", 4) == 0                               /*'{'*/
6159            && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
6160            )
6161           {
6162           s += 4;
6163           Uskip_whitespace(&s);
6164           }                                                             /*'{'*/
6165         if (*s != '}')
6166           {
6167           expand_string_message = US"missing '}' closing extract";
6168           goto EXPAND_FAILED_CURLY;
6169           }
6170         }
6171
6172       else for (int i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
6173         {
6174         if (Uskip_whitespace(&s) == '{')                                /*'}'*/
6175           {
6176           if (!(sub[i] = expand_string_internal(s+1,
6177                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
6178             goto EXPAND_FAILED;                                         /*'{'*/
6179           if (*s++ != '}')
6180             {
6181             expand_string_message = string_sprintf(
6182               "missing '}' closing arg %d of extract", i+1);
6183             goto EXPAND_FAILED_CURLY;
6184             }
6185
6186           /* After removal of leading and trailing white space, the first
6187           argument must not be empty; if it consists entirely of digits
6188           (optionally preceded by a minus sign), this is a numerical
6189           extraction, and we expect 3 arguments (normal) or 2 (json). */
6190
6191           if (i == 0)
6192             {
6193             int len;
6194             int x = 0;
6195             uschar * p = sub[0];
6196
6197             Uskip_whitespace(&p);
6198             sub[0] = p;
6199
6200             len = Ustrlen(p);
6201             while (len > 0 && isspace(p[len-1])) len--;
6202             p[len] = 0;
6203
6204             if (!*p)
6205               {
6206               expand_string_message = US"first argument of \"extract\" must "
6207                 "not be empty";
6208               goto EXPAND_FAILED;
6209               }
6210
6211             if (*p == '-')
6212               {
6213               field_number = -1;
6214               p++;
6215               }
6216             while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
6217             if (!*p)
6218               {
6219               field_number *= x;
6220               if (fmt == extract_basic) j = 3;               /* Need 3 args */
6221               field_number_set = TRUE;
6222               }
6223             }
6224           }
6225         else
6226           {
6227           expand_string_message = string_sprintf(
6228             "missing '{' for arg %d of extract", i+1);
6229           goto EXPAND_FAILED_CURLY;
6230           }
6231         }
6232
6233       /* Extract either the numbered or the keyed substring into $value. If
6234       skipping, just pretend the extraction failed. */
6235
6236       if (flags & ESI_SKIPPING)
6237         lookup_value = NULL;
6238       else switch (fmt)
6239         {
6240         case extract_basic:
6241           lookup_value = field_number_set
6242             ? expand_gettokened(field_number, sub[1], sub[2])
6243             : expand_getkeyed(sub[0], sub[1]);
6244           break;
6245
6246         case extract_json:
6247         case extract_jsons:
6248           {
6249           uschar * s, * item;
6250           const uschar * list;
6251
6252           /* Array: Bracket-enclosed and comma-separated.
6253           Object: Brace-enclosed, comma-sep list of name:value pairs */
6254
6255           if (!(s = dewrap(sub[1], field_number_set ? US"[]" : US"{}")))
6256             {
6257             expand_string_message =
6258               string_sprintf("%s wrapping %s for extract json",
6259                 expand_string_message,
6260                 field_number_set ? "array" : "object");
6261             goto EXPAND_FAILED_CURLY;
6262             }
6263
6264           list = s;
6265           if (field_number_set)
6266             {
6267             if (field_number <= 0)
6268               {
6269               expand_string_message = US"first argument of \"extract\" must "
6270                 "be greater than zero";
6271               goto EXPAND_FAILED;
6272               }
6273             while (field_number > 0 && (item = json_nextinlist(&list)))
6274               field_number--;
6275             if ((lookup_value = s = item))
6276               {
6277               while (*s) s++;
6278               while (--s >= lookup_value && isspace(*s)) *s = '\0';
6279               }
6280             }
6281           else
6282             {
6283             lookup_value = NULL;
6284             while ((item = json_nextinlist(&list)))
6285               {
6286               /* Item is:  string name-sep value.  string is quoted.
6287               Dequote the string and compare with the search key. */
6288
6289               if (!(item = dewrap(item, US"\"\"")))
6290                 {
6291                 expand_string_message =
6292                   string_sprintf("%s wrapping string key for extract json",
6293                     expand_string_message);
6294                 goto EXPAND_FAILED_CURLY;
6295                 }
6296               if (Ustrcmp(item, sub[0]) == 0)   /*XXX should be a UTF8-compare */
6297                 {
6298                 s = item + Ustrlen(item) + 1;
6299                 if (Uskip_whitespace(&s) != ':')
6300                   {
6301                   expand_string_message =
6302                     US"missing object value-separator for extract json";
6303                   goto EXPAND_FAILED_CURLY;
6304                   }
6305                 s++;
6306                 Uskip_whitespace(&s);
6307                 lookup_value = s;
6308                 break;
6309                 }
6310               }
6311             }
6312           }
6313
6314           if (  fmt == extract_jsons
6315              && lookup_value
6316              && !(lookup_value = dewrap(lookup_value, US"\"\"")))
6317             {
6318             expand_string_message =
6319               string_sprintf("%s wrapping string result for extract jsons",
6320                 expand_string_message);
6321             goto EXPAND_FAILED_CURLY;
6322             }
6323           break;        /* json/s */
6324         }
6325
6326       /* If no string follows, $value gets substituted; otherwise there can
6327       be yes/no strings, as for lookup or if. */
6328
6329       switch(process_yesno(
6330                flags,                   /* were previously skipping */
6331                lookup_value != NULL,    /* success/failure indicator */
6332                save_lookup_value,       /* value to reset for string2 */
6333                &s,                      /* input pointer */
6334                &yield,                  /* output pointer */
6335                US"extract",             /* condition type */
6336                &resetok))
6337         {
6338         case 1: goto EXPAND_FAILED;          /* when all is well, the */
6339         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
6340         }
6341
6342       /* All done - restore numerical variables. */
6343
6344       restore_expand_strings(save_expand_nmax, save_expand_nstring,
6345         save_expand_nlength);
6346
6347       if (flags & ESI_SKIPPING) continue;
6348       break;
6349       }
6350
6351     /* return the Nth item from a list */
6352
6353     case EITEM_LISTEXTRACT:
6354       {
6355       int field_number = 1;
6356       uschar * save_lookup_value = lookup_value, * sub[2];
6357       int save_expand_nmax =
6358         save_expand_strings(save_expand_nstring, save_expand_nlength);
6359
6360       /* Read the field & list arguments */
6361       /*XXX Could we use read_subs here (and get better efficiency for skipping)? */
6362
6363       for (int i = 0; i < 2; i++)
6364         {
6365         if (Uskip_whitespace(&s) != '{')                                /*}*/
6366           {
6367           expand_string_message = string_sprintf(
6368             "missing '{' for arg %d of listextract", i+1);              /*}*/
6369           goto EXPAND_FAILED_CURLY;
6370           }
6371
6372         sub[i] = expand_string_internal(s+1,
6373               ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6374         if (!sub[i])     goto EXPAND_FAILED;                            /*{{*/
6375         if (*s++ != '}')
6376           {
6377           expand_string_message = string_sprintf(
6378             "missing '}' closing arg %d of listextract", i+1);
6379           goto EXPAND_FAILED_CURLY;
6380           }
6381
6382         /* After removal of leading and trailing white space, the first
6383         argument must be numeric and nonempty. */
6384
6385         if (i == 0)
6386           {
6387           int len;
6388           int x = 0;
6389           uschar *p = sub[0];
6390
6391           Uskip_whitespace(&p);
6392           sub[0] = p;
6393
6394           len = Ustrlen(p);
6395           while (len > 0 && isspace(p[len-1])) len--;
6396           p[len] = 0;
6397
6398           if (!*p && !(flags & ESI_SKIPPING))
6399             {
6400             expand_string_message = US"first argument of \"listextract\" must "
6401               "not be empty";
6402             goto EXPAND_FAILED;
6403             }
6404
6405           if (*p == '-')
6406             {
6407             field_number = -1;
6408             p++;
6409             }
6410           while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
6411           if (*p)
6412             {
6413             expand_string_message = US"first argument of \"listextract\" must "
6414               "be numeric";
6415             goto EXPAND_FAILED;
6416             }
6417           field_number *= x;
6418           }
6419         }
6420
6421       /* Extract the numbered element into $value. If
6422       skipping, just pretend the extraction failed. */
6423
6424       lookup_value = flags & ESI_SKIPPING ? NULL : expand_getlistele(field_number, sub[1]);
6425
6426       /* If no string follows, $value gets substituted; otherwise there can
6427       be yes/no strings, as for lookup or if. */
6428
6429       switch(process_yesno(
6430                flags,                           /* were previously skipping */
6431                lookup_value != NULL,            /* success/failure indicator */
6432                save_lookup_value,               /* value to reset for string2 */
6433                &s,                              /* input pointer */
6434                &yield,                          /* output pointer */
6435                US"listextract",                 /* condition type */
6436                &resetok))
6437         {
6438         case 1: goto EXPAND_FAILED;          /* when all is well, the */
6439         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
6440         }
6441
6442       /* All done - restore numerical variables. */
6443
6444       restore_expand_strings(save_expand_nmax, save_expand_nstring,
6445         save_expand_nlength);
6446
6447       if (flags & ESI_SKIPPING) continue;
6448       break;
6449       }
6450
6451     case EITEM_LISTQUOTE:
6452       {
6453       uschar * sub[2];
6454       switch(read_subs(sub, 2, 2, &s, flags, TRUE, name, &resetok, NULL))
6455         {
6456         case -1: continue;      /* skipping */
6457         case 1: goto EXPAND_FAILED_CURLY;
6458         case 2:
6459         case 3: goto EXPAND_FAILED;
6460         }
6461       if (*sub[1]) for (uschar sep = *sub[0], c; c = *sub[1]; sub[1]++)
6462         {
6463         if (c == sep) yield = string_catn(yield, sub[1], 1);
6464         yield = string_catn(yield, sub[1], 1);
6465         }
6466       else yield = string_catn(yield, US" ", 1);
6467       break;
6468       }
6469
6470 #ifndef DISABLE_TLS
6471     case EITEM_CERTEXTRACT:
6472       {
6473       uschar * save_lookup_value = lookup_value, * sub[2];
6474       int save_expand_nmax =
6475         save_expand_strings(save_expand_nstring, save_expand_nlength);
6476
6477       /* Read the field argument */
6478       if (Uskip_whitespace(&s) != '{')                                  /*}*/
6479         {
6480         expand_string_message = US"missing '{' for field arg of certextract";
6481         goto EXPAND_FAILED_CURLY;                                       /*}*/
6482         }
6483       sub[0] = expand_string_internal(s+1,
6484                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6485       if (!sub[0])     goto EXPAND_FAILED;                              /*{{*/
6486       if (*s++ != '}')
6487         {
6488         expand_string_message = US"missing '}' closing field arg of certextract";
6489         goto EXPAND_FAILED_CURLY;
6490         }
6491       /* strip spaces fore & aft */
6492       {
6493       int len;
6494       uschar *p = sub[0];
6495
6496       Uskip_whitespace(&p);
6497       sub[0] = p;
6498
6499       len = Ustrlen(p);
6500       while (len > 0 && isspace(p[len-1])) len--;
6501       p[len] = 0;
6502       }
6503
6504       /* inspect the cert argument */
6505       if (Uskip_whitespace(&s) != '{')                                  /*}*/
6506         {
6507         expand_string_message = US"missing '{' for cert variable arg of certextract";
6508         goto EXPAND_FAILED_CURLY;                                       /*}*/
6509         }
6510       if (*++s != '$')
6511         {
6512         expand_string_message = US"second argument of \"certextract\" must "
6513           "be a certificate variable";
6514         goto EXPAND_FAILED;
6515         }
6516       sub[1] = expand_string_internal(s+1,
6517                 ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s, &resetok, NULL);
6518       if (!sub[1])     goto EXPAND_FAILED;                              /*{{*/
6519       if (*s++ != '}')
6520         {
6521         expand_string_message = US"missing '}' closing cert variable arg of certextract";
6522         goto EXPAND_FAILED_CURLY;
6523         }
6524
6525       if (flags & ESI_SKIPPING)
6526         lookup_value = NULL;
6527       else
6528         {
6529         lookup_value = expand_getcertele(sub[0], sub[1]);
6530         if (*expand_string_message) goto EXPAND_FAILED;
6531         }
6532       switch(process_yesno(
6533                flags,                           /* were previously skipping */
6534                lookup_value != NULL,            /* success/failure indicator */
6535                save_lookup_value,               /* value to reset for string2 */
6536                &s,                              /* input pointer */
6537                &yield,                          /* output pointer */
6538                US"certextract",                 /* condition type */
6539                &resetok))
6540         {
6541         case 1: goto EXPAND_FAILED;          /* when all is well, the */
6542         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
6543         }
6544
6545       restore_expand_strings(save_expand_nmax, save_expand_nstring,
6546         save_expand_nlength);
6547       if (flags & ESI_SKIPPING) continue;
6548       break;
6549       }
6550 #endif  /*DISABLE_TLS*/
6551
6552     /* Handle list operations */
6553
6554     case EITEM_FILTER:
6555     case EITEM_MAP:
6556     case EITEM_REDUCE:
6557       {
6558       int sep = 0, save_ptr = gstring_length(yield);
6559       uschar outsep[2] = { '\0', '\0' };
6560       const uschar *list, *expr, *temp;
6561       uschar * save_iterate_item = iterate_item;
6562       uschar * save_lookup_value = lookup_value;
6563
6564       Uskip_whitespace(&s);
6565       if (*s++ != '{')                                                  /*}*/
6566         {
6567         expand_string_message =
6568           string_sprintf("missing '{' for first arg of %s", name);
6569         goto EXPAND_FAILED_CURLY;                                       /*}*/
6570         }
6571
6572       DEBUG(D_expand) debug_printf_indent("%s: evaluate input list list\n", name);
6573       if (!(list = expand_string_internal(s,
6574               ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
6575         goto EXPAND_FAILED;                                             /*{{*/
6576       if (*s++ != '}')
6577         {
6578         expand_string_message =
6579           string_sprintf("missing '}' closing first arg of %s", name);
6580         goto EXPAND_FAILED_CURLY;
6581         }
6582
6583       if (item_type == EITEM_REDUCE)
6584         {
6585         uschar * t;
6586         Uskip_whitespace(&s);
6587         if (*s++ != '{')                                                /*}*/
6588           {
6589           expand_string_message = US"missing '{' for second arg of reduce";
6590           goto EXPAND_FAILED_CURLY;                                     /*}*/
6591           }
6592         DEBUG(D_expand) debug_printf_indent("reduce: initial result list\n");
6593         t = expand_string_internal(s,
6594               ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6595         if (!t) goto EXPAND_FAILED;
6596         lookup_value = t;                                               /*{{*/
6597         if (*s++ != '}')
6598           {
6599           expand_string_message = US"missing '}' closing second arg of reduce";
6600           goto EXPAND_FAILED_CURLY;
6601           }
6602         }
6603
6604       Uskip_whitespace(&s);
6605       if (*s++ != '{')                                                  /*}*/
6606         {
6607         expand_string_message =
6608           string_sprintf("missing '{' for last arg of %s", name);       /*}*/
6609         goto EXPAND_FAILED_CURLY;
6610         }
6611
6612       expr = s;
6613
6614       /* For EITEM_FILTER, call eval_condition once, with result discarded (as
6615       if scanning a "false" part). This allows us to find the end of the
6616       condition, because if the list is empty, we won't actually evaluate the
6617       condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
6618       the normal internal expansion function. */
6619
6620       DEBUG(D_expand) debug_printf_indent("%s: find end of conditionn\n", name);
6621       if (item_type != EITEM_FILTER)
6622         temp = expand_string_internal(s,
6623           ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL);
6624       else
6625         if ((temp = eval_condition(expr, &resetok, NULL))) s = temp;
6626
6627       if (!temp)
6628         {
6629         expand_string_message = string_sprintf("%s inside \"%s\" item",
6630           expand_string_message, 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 condition "
6638           "or expression inside \"%s\"; could be an unquoted } in the content",
6639           name);
6640         goto EXPAND_FAILED;
6641         }
6642
6643       Uskip_whitespace(&s);                                             /*{{*/
6644       if (*s++ != '}')
6645         {
6646         expand_string_message = string_sprintf("missing } at end of \"%s\"",
6647           name);
6648         goto EXPAND_FAILED;
6649         }
6650
6651       /* If we are skipping, we can now just move on to the next item. When
6652       processing for real, we perform the iteration. */
6653
6654       if (flags & ESI_SKIPPING) continue;
6655       while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
6656         {
6657         *outsep = (uschar)sep;      /* Separator as a string */
6658
6659         DEBUG(D_expand) debug_printf_indent("%s: $item = '%s'  $value = '%s'\n",
6660                           name, iterate_item, lookup_value);
6661
6662         if (item_type == EITEM_FILTER)
6663           {
6664           BOOL condresult;
6665           /* the condition could modify $value, as a side-effect */
6666           uschar * save_value = lookup_value;
6667
6668           if (!eval_condition(expr, &resetok, &condresult))
6669             {
6670             iterate_item = save_iterate_item;
6671             lookup_value = save_lookup_value;
6672             expand_string_message = string_sprintf("%s inside \"%s\" condition",
6673               expand_string_message, name);
6674             goto EXPAND_FAILED;
6675             }
6676           lookup_value = save_value;
6677           DEBUG(D_expand) debug_printf_indent("%s: condition is %s\n", name,
6678             condresult? "true":"false");
6679           if (condresult)
6680             temp = iterate_item;    /* TRUE => include this item */
6681           else
6682             continue;               /* FALSE => skip this item */
6683           }
6684
6685         else                    /* EITEM_MAP and EITEM_REDUCE */
6686           {
6687           /* the expansion could modify $value, as a side-effect */
6688           uschar * t = expand_string_internal(expr,
6689             ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, NULL, &resetok, NULL);
6690           if (!(temp = t))
6691             {
6692             iterate_item = save_iterate_item;
6693             expand_string_message = string_sprintf("%s inside \"%s\" item",
6694               expand_string_message, name);
6695             goto EXPAND_FAILED;
6696             }
6697           if (item_type == EITEM_REDUCE)
6698             {
6699             lookup_value = t;         /* Update the value of $value */
6700             continue;                 /* and continue the iteration */
6701             }
6702           }
6703
6704         /* We reach here for FILTER if the condition is true, always for MAP,
6705         and never for REDUCE. The value in "temp" is to be added to the output
6706         list that is being created, ensuring that any occurrences of the
6707         separator character are doubled. Unless we are dealing with the first
6708         item of the output list, add in a space if the new item begins with the
6709         separator character, or is an empty string. */
6710
6711 /*XXX is there not a standard support function for this, appending to a list? */
6712 /* yes, string_append_listele(), but it depends on lack of text before the list */
6713
6714         if (  yield && yield->ptr != save_ptr
6715            && (temp[0] == *outsep || temp[0] == 0))
6716           yield = string_catn(yield, US" ", 1);
6717
6718         /* Add the string in "temp" to the output list that we are building,
6719         This is done in chunks by searching for the separator character. */
6720
6721         for (;;)
6722           {
6723           size_t seglen = Ustrcspn(temp, outsep);
6724
6725           yield = string_catn(yield, temp, seglen + 1);
6726
6727           /* If we got to the end of the string we output one character
6728           too many; backup and end the loop. Otherwise arrange to double the
6729           separator. */
6730
6731           if (!temp[seglen]) { yield->ptr--; break; }
6732           yield = string_catn(yield, outsep, 1);
6733           temp += seglen + 1;
6734           }
6735
6736         /* Output a separator after the string: we will remove the redundant
6737         final one at the end. */
6738
6739         yield = string_catn(yield, outsep, 1);
6740         }   /* End of iteration over the list loop */
6741
6742       /* REDUCE has generated no output above: output the final value of
6743       $value. */
6744
6745       if (item_type == EITEM_REDUCE)
6746         {
6747         yield = string_cat(yield, lookup_value);
6748         lookup_value = save_lookup_value;  /* Restore $value */
6749         }
6750
6751       /* FILTER and MAP generate lists: if they have generated anything, remove
6752       the redundant final separator. Even though an empty item at the end of a
6753       list does not count, this is tidier. */
6754
6755       else if (yield && yield->ptr != save_ptr) yield->ptr--;
6756
6757       /* Restore preserved $item */
6758
6759       iterate_item = save_iterate_item;
6760       if (flags & ESI_SKIPPING) continue;
6761       break;
6762       }
6763
6764     case EITEM_SORT:
6765       {
6766       int sep = 0, cond_type;
6767       const uschar * srclist, * cmp, * xtract;
6768       uschar * opname, * srcitem;
6769       const uschar * dstlist = NULL, * dstkeylist = NULL;
6770       uschar * tmp, * save_iterate_item = iterate_item;
6771
6772       Uskip_whitespace(&s);
6773       if (*s++ != '{')                                                  /*}*/
6774         {
6775         expand_string_message = US"missing '{' for list arg of sort";
6776         goto EXPAND_FAILED_CURLY;                                       /*}*/
6777         }
6778
6779       srclist = expand_string_internal(s,
6780               ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6781       if (!srclist) goto EXPAND_FAILED;                                 /*{{*/
6782       if (*s++ != '}')
6783         {
6784         expand_string_message = US"missing '}' closing list arg of sort";
6785         goto EXPAND_FAILED_CURLY;
6786         }
6787
6788       Uskip_whitespace(&s);
6789       if (*s++ != '{')                                                  /*}*/
6790         {
6791         expand_string_message = US"missing '{' for comparator arg of sort";
6792         goto EXPAND_FAILED_CURLY;                                       /*}*/
6793         }
6794
6795       cmp = expand_string_internal(s,
6796               ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s, &resetok, NULL);
6797       if (!cmp) goto EXPAND_FAILED;                                     /*{{*/
6798       if (*s++ != '}')
6799         {
6800         expand_string_message = US"missing '}' closing comparator arg of sort";
6801         goto EXPAND_FAILED_CURLY;
6802         }
6803
6804       if ((cond_type = identify_operator(&cmp, &opname)) == -1)
6805         {
6806         if (!expand_string_message)
6807           expand_string_message = string_sprintf("unknown condition \"%s\"", s);
6808         goto EXPAND_FAILED;
6809         }
6810       switch(cond_type)
6811         {
6812         case ECOND_NUM_L: case ECOND_NUM_LE:
6813         case ECOND_NUM_G: case ECOND_NUM_GE:
6814         case ECOND_STR_GE: case ECOND_STR_GEI: case ECOND_STR_GT: case ECOND_STR_GTI:
6815         case ECOND_STR_LE: case ECOND_STR_LEI: case ECOND_STR_LT: case ECOND_STR_LTI:
6816           break;
6817
6818         default:
6819           expand_string_message = US"comparator not handled for sort";
6820           goto EXPAND_FAILED;
6821         }
6822
6823       Uskip_whitespace(&s);
6824       if (*s++ != '{')                                                  /*}*/
6825         {
6826         expand_string_message = US"missing '{' for extractor arg of sort";
6827         goto EXPAND_FAILED_CURLY;                                       /*}*/
6828         }
6829
6830       xtract = s;
6831       if (!(tmp = expand_string_internal(s,
6832         ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL)))
6833         goto EXPAND_FAILED;
6834       xtract = string_copyn(xtract, s - xtract);
6835                                                                         /*{{*/
6836       if (*s++ != '}')
6837         {
6838         expand_string_message = US"missing '}' closing extractor arg of sort";
6839         goto EXPAND_FAILED_CURLY;
6840         }
6841                                                                         /*{{*/
6842       if (*s++ != '}')
6843         {
6844         expand_string_message = US"missing } at end of \"sort\"";
6845         goto EXPAND_FAILED;
6846         }
6847
6848       if (flags & ESI_SKIPPING) continue;
6849
6850       while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
6851         {
6852         uschar * srcfield, * dstitem;
6853         gstring * newlist = NULL, * newkeylist = NULL;
6854
6855         DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);
6856
6857         /* extract field for comparisons */
6858         iterate_item = srcitem;
6859         if (  !(srcfield = expand_string_internal(xtract,
6860                                   ESI_HONOR_DOLLAR, NULL, &resetok, NULL))
6861            || !*srcfield)
6862           {
6863           expand_string_message = string_sprintf(
6864               "field-extract in sort: \"%s\"", xtract);
6865           goto EXPAND_FAILED;
6866           }
6867
6868         /* Insertion sort */
6869
6870         /* copy output list until new-item < list-item */
6871         while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6872           {
6873           uschar * dstfield;
6874
6875           /* field for comparison */
6876           if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6877             goto SORT_MISMATCH;
6878
6879           /* String-comparator names start with a letter; numeric names do not */
6880
6881           if (sortsbefore(cond_type, isalpha(opname[0]),
6882               srcfield, dstfield))
6883             {
6884             /* New-item sorts before this dst-item.  Append new-item,
6885             then dst-item, then remainder of dst list. */
6886
6887             newlist = string_append_listele(newlist, sep, srcitem);
6888             newkeylist = string_append_listele(newkeylist, sep, srcfield);
6889             srcitem = NULL;
6890
6891             newlist = string_append_listele(newlist, sep, dstitem);
6892             newkeylist = string_append_listele(newkeylist, sep, dstfield);
6893
6894 /*XXX why field-at-a-time copy?  Why not just dup the rest of the list? */
6895             while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6896               {
6897               if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6898                 goto SORT_MISMATCH;
6899               newlist = string_append_listele(newlist, sep, dstitem);
6900               newkeylist = string_append_listele(newkeylist, sep, dstfield);
6901               }
6902
6903             break;
6904             }
6905
6906           newlist = string_append_listele(newlist, sep, dstitem);
6907           newkeylist = string_append_listele(newkeylist, sep, dstfield);
6908           }
6909
6910         /* If we ran out of dstlist without consuming srcitem, append it */
6911         if (srcitem)
6912           {
6913           newlist = string_append_listele(newlist, sep, srcitem);
6914           newkeylist = string_append_listele(newkeylist, sep, srcfield);
6915           }
6916
6917         dstlist = newlist->s;
6918         dstkeylist = newkeylist->s;
6919
6920         DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);
6921         DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6922         }
6923
6924       if (dstlist)
6925         yield = string_cat(yield, dstlist);
6926
6927       /* Restore preserved $item */
6928       iterate_item = save_iterate_item;
6929       break;
6930
6931       SORT_MISMATCH:
6932         expand_string_message = US"Internal error in sort (list mismatch)";
6933         goto EXPAND_FAILED;
6934       }
6935
6936
6937     /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6938     functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6939     or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6940     a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6941
6942     #define EXPAND_DLFUNC_MAX_ARGS 8
6943
6944     case EITEM_DLFUNC:
6945 #ifndef EXPAND_DLFUNC
6946       expand_string_message = US"\"${dlfunc\" encountered, but this facility "  /*}*/
6947         "is not included in this binary";
6948       goto EXPAND_FAILED;
6949
6950 #else   /* EXPAND_DLFUNC */
6951       {
6952       tree_node * t;
6953       exim_dlfunc_t * func;
6954       uschar * result;
6955       int status, argc;
6956       uschar * argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6957
6958       if (expand_forbid & RDO_DLFUNC)
6959         {
6960         expand_string_message =
6961           US"dynamically-loaded functions are not permitted";
6962         goto EXPAND_FAILED;
6963         }
6964
6965       switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, flags,
6966            TRUE, name, &resetok, NULL))
6967         {
6968         case -1: continue;      /* skipping */
6969         case 1: goto EXPAND_FAILED_CURLY;
6970         case 2:
6971         case 3: goto EXPAND_FAILED;
6972         }
6973
6974       /* Look up the dynamically loaded object handle in the tree. If it isn't
6975       found, dlopen() the file and put the handle in the tree for next time. */
6976
6977       if (!(t = tree_search(dlobj_anchor, argv[0])))
6978         {
6979         void * handle = dlopen(CS argv[0], RTLD_LAZY);
6980         if (!handle)
6981           {
6982           expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6983             argv[0], dlerror());
6984           log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6985           goto EXPAND_FAILED;
6986           }
6987         t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]), argv[0]);
6988         Ustrcpy(t->name, argv[0]);
6989         t->data.ptr = handle;
6990         (void)tree_insertnode(&dlobj_anchor, t);
6991         }
6992
6993       /* Having obtained the dynamically loaded object handle, look up the
6994       function pointer. */
6995
6996       if (!(func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1])))
6997         {
6998         expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
6999           "%s", argv[1], argv[0], dlerror());
7000         log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
7001         goto EXPAND_FAILED;
7002         }
7003
7004       /* Call the function and work out what to do with the result. If it
7005       returns OK, we have a replacement string; if it returns DEFER then
7006       expansion has failed in a non-forced manner; if it returns FAIL then
7007       failure was forced; if it returns ERROR or any other value there's a
7008       problem, so panic slightly. In any case, assume that the function has
7009       side-effects on the store that must be preserved. */
7010
7011       resetok = FALSE;
7012       result = NULL;
7013       for (argc = 0; argv[argc]; argc++) ;
7014
7015       if ((status = func(&result, argc - 2, &argv[2])) != OK)
7016         {
7017         expand_string_message = result ? result : US"(no message)";
7018         if (status == FAIL_FORCED)
7019           f.expand_string_forcedfail = TRUE;
7020         else if (status != FAIL)
7021           log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
7022               argv[0], argv[1], status, expand_string_message);
7023         goto EXPAND_FAILED;
7024         }
7025
7026       if (result) yield = string_cat(yield, result);
7027       break;
7028       }
7029 #endif /* EXPAND_DLFUNC */
7030
7031     case EITEM_ENV:     /* ${env {name} {val_if_found} {val_if_unfound}} */
7032       {
7033       uschar * key;
7034       uschar *save_lookup_value = lookup_value;
7035
7036       if (Uskip_whitespace(&s) != '{')                                  /*}*/
7037         goto EXPAND_FAILED;
7038
7039       key = expand_string_internal(s+1,
7040               ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
7041       if (!key) goto EXPAND_FAILED;                                     /*{{*/
7042       if (*s++ != '}')
7043         {
7044         expand_string_message = US"missing '}' for name arg of env";
7045         goto EXPAND_FAILED_CURLY;
7046         }
7047
7048       lookup_value = US getenv(CS key);
7049
7050       switch(process_yesno(
7051                flags,                           /* were previously skipping */
7052                lookup_value != NULL,            /* success/failure indicator */
7053                save_lookup_value,               /* value to reset for string2 */
7054                &s,                              /* input pointer */
7055                &yield,                          /* output pointer */
7056                US"env",                         /* condition type */
7057                &resetok))
7058         {
7059         case 1: goto EXPAND_FAILED;          /* when all is well, the */
7060         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
7061         }
7062       if (flags & ESI_SKIPPING) continue;
7063       break;
7064       }
7065
7066 #ifdef SUPPORT_SRS
7067     case EITEM_SRS_ENCODE:
7068       /* ${srs_encode {secret} {return_path} {orig_domain}} */
7069       {
7070       uschar * sub[3];
7071       uschar cksum[4];
7072       gstring * g = NULL;
7073       BOOL quoted = FALSE;
7074
7075       switch (read_subs(sub, 3, 3, CUSS &s, flags, TRUE, name, &resetok, NULL))
7076         {
7077         case -1: continue;      /* skipping */
7078         case 1: goto EXPAND_FAILED_CURLY;
7079         case 2:
7080         case 3: goto EXPAND_FAILED;
7081         }
7082       if (flags & ESI_SKIPPING) continue;
7083
7084       if (sub[1] && *(sub[1]))
7085         {
7086         g = string_catn(g, US"SRS0=", 5);
7087
7088         /* ${l_4:${hmac{md5}{SRS_SECRET}{${lc:$return_path}}}}= */
7089         hmac_md5(sub[0], string_copylc(sub[1]), cksum, sizeof(cksum));
7090         g = string_catn(g, cksum, sizeof(cksum));
7091         g = string_catn(g, US"=", 1);
7092
7093         /* ${base32:${eval:$tod_epoch/86400&0x3ff}}= */
7094           {
7095           struct timeval now;
7096           unsigned long i;
7097
7098           gettimeofday(&now, NULL);
7099           i = (now.tv_sec / 86400) & 0x3ff;
7100           g = string_catn(g, &base32_chars[i >> 5], 1);
7101           g = string_catn(g, &base32_chars[i & 0x1f], 1);
7102           }
7103         g = string_catn(g, US"=", 1);
7104
7105         /* ${domain:$return_path}=${local_part:$return_path} */
7106           {
7107           int start, end, domain;
7108           uschar * t = parse_extract_address(sub[1], &expand_string_message,
7109                                             &start, &end, &domain, FALSE);
7110           uschar * s;
7111
7112           if (!t)
7113             goto EXPAND_FAILED;
7114
7115           if (domain > 0) g = string_cat(g, t + domain);
7116           g = string_catn(g, US"=", 1);
7117
7118           s = domain > 0 ? string_copyn(t, domain - 1) : t;
7119           if ((quoted = Ustrchr(s, '"') != NULL))
7120             {
7121             gstring * h = NULL;
7122             DEBUG(D_expand) debug_printf_indent("auto-quoting local part\n");
7123             while (*s)          /* de-quote */
7124               {
7125               while (*s && *s != '"') h = string_catn(h, s++, 1);
7126               if (*s) s++;
7127               while (*s && *s != '"') h = string_catn(h, s++, 1);
7128               if (*s) s++;
7129               }
7130             gstring_release_unused(h);
7131             s = string_from_gstring(h);
7132             }
7133           if (s) g = string_cat(g, s);
7134           }
7135
7136         /* Assume that if the original local_part had quotes
7137         it was for good reason */
7138
7139         if (quoted) yield = string_catn(yield, US"\"", 1);
7140         yield = gstring_append(yield, g);
7141         if (quoted) yield = string_catn(yield, US"\"", 1);
7142
7143         /* @$original_domain */
7144         yield = string_catn(yield, US"@", 1);
7145         yield = string_cat(yield, sub[2]);
7146         }
7147       else
7148         DEBUG(D_expand) debug_printf_indent("null return_path for srs-encode\n");
7149
7150       break;
7151       }
7152 #endif /*SUPPORT_SRS*/
7153
7154     default:
7155       goto NOT_ITEM;
7156     }   /* EITEM_* switch */
7157     /*NOTREACHED*/
7158
7159   DEBUG(D_expand)               /* only if not the sole expansion of the line */
7160     if (yield && (expansion_start > 0 || *s))
7161       debug_expansion_interim(US"item-res",
7162           yield->s + expansion_start, yield->ptr - expansion_start,
7163           flags);
7164   continue;
7165
7166 NOT_ITEM: ;
7167   }
7168
7169   /* Control reaches here if the name is not recognized as one of the more
7170   complicated expansion items. Check for the "operator" syntax (name terminated
7171   by a colon). Some of the operators have arguments, separated by _ from the
7172   name. */
7173
7174   if (*s == ':')
7175     {
7176     int c;
7177     uschar * arg = NULL, * sub;
7178 #ifndef DISABLE_TLS
7179     var_entry * vp = NULL;
7180 #endif
7181
7182     /* Owing to an historical mis-design, an underscore may be part of the
7183     operator name, or it may introduce arguments.  We therefore first scan the
7184     table of names that contain underscores. If there is no match, we cut off
7185     the arguments and then scan the main table. */
7186
7187     if ((c = chop_match(name, op_table_underscore,
7188                         nelem(op_table_underscore))) < 0)
7189       {
7190       if ((arg = Ustrchr(name, '_')))
7191         *arg = 0;
7192       if ((c = chop_match(name, op_table_main, nelem(op_table_main))) >= 0)
7193         c += nelem(op_table_underscore);
7194       if (arg) *arg++ = '_';            /* Put back for error messages */
7195       }
7196
7197     /* Deal specially with operators that might take a certificate variable
7198     as we do not want to do the usual expansion. For most, expand the string.*/
7199
7200     switch(c)
7201       {
7202 #ifndef DISABLE_TLS
7203       case EOP_MD5:
7204       case EOP_SHA1:
7205       case EOP_SHA256:
7206       case EOP_BASE64:
7207         if (s[1] == '$')
7208           {
7209           const uschar * s1 = s;
7210           sub = expand_string_internal(s+2,
7211               ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s1, &resetok, NULL);
7212           if (!sub)       goto EXPAND_FAILED;           /*{*/
7213           if (*s1 != '}')
7214             {                                           /*{*/
7215             expand_string_message =
7216               string_sprintf("missing '}' closing cert arg of %s", name);
7217             goto EXPAND_FAILED_CURLY;
7218             }
7219           if (  (vp = find_var_ent(sub, var_table, nelem(var_table)))
7220              && vp->type == vtype_cert)
7221             {
7222             s = s1+1;
7223             break;
7224             }
7225           vp = NULL;
7226           }
7227         /*FALLTHROUGH*/
7228 #endif
7229       default:
7230         sub = expand_string_internal(s+1,
7231                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
7232         if (!sub) goto EXPAND_FAILED;
7233         s++;
7234         break;
7235       }
7236
7237     /* If we are skipping, we don't need to perform the operation at all.
7238     This matters for operations like "mask", because the data may not be
7239     in the correct format when skipping. For example, the expression may test
7240     for the existence of $sender_host_address before trying to mask it. For
7241     other operations, doing them may not fail, but it is a waste of time. */
7242
7243     if (flags & ESI_SKIPPING && c >= 0) continue;
7244
7245     /* Otherwise, switch on the operator type.  After handling go back
7246     to the main loop top. */
7247
7248      {
7249      unsigned expansion_start = gstring_length(yield);
7250      switch(c)
7251       {
7252       case EOP_BASE32:
7253         {
7254         uschar * t;
7255         unsigned long int n = Ustrtoul(sub, &t, 10);
7256         gstring * g = NULL;
7257
7258         if (*t)
7259           {
7260           expand_string_message = string_sprintf("argument for base32 "
7261             "operator is \"%s\", which is not a decimal number", sub);
7262           goto EXPAND_FAILED;
7263           }
7264         for ( ; n; n >>= 5)
7265           g = string_catn(g, &base32_chars[n & 0x1f], 1);
7266
7267         if (g) while (g->ptr > 0) yield = string_catn(yield, &g->s[--g->ptr], 1);
7268         break;
7269         }
7270
7271       case EOP_BASE32D:
7272         {
7273         uschar *tt = sub;
7274         unsigned long int n = 0;
7275         while (*tt)
7276           {
7277           uschar * t = Ustrchr(base32_chars, *tt++);
7278           if (!t)
7279             {
7280             expand_string_message = string_sprintf("argument for base32d "
7281               "operator is \"%s\", which is not a base 32 number", sub);
7282             goto EXPAND_FAILED;
7283             }
7284           n = n * 32 + (t - base32_chars);
7285           }
7286         yield = string_fmt_append(yield, "%ld", n);
7287         break;
7288         }
7289
7290       case EOP_BASE62:
7291         {
7292         uschar *t;
7293         unsigned long int n = Ustrtoul(sub, &t, 10);
7294         if (*t)
7295           {
7296           expand_string_message = string_sprintf("argument for base62 "
7297             "operator is \"%s\", which is not a decimal number", sub);
7298           goto EXPAND_FAILED;
7299           }
7300         yield = string_cat(yield, string_base62_32(n));         /*XXX only handles 32b input range.  Need variants? */
7301         break;
7302         }
7303
7304       /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
7305
7306       case EOP_BASE62D:
7307         {
7308         uschar *tt = sub;
7309         unsigned long int n = 0;
7310         while (*tt)
7311           {
7312           uschar *t = Ustrchr(base62_chars, *tt++);
7313           if (!t)
7314             {
7315             expand_string_message = string_sprintf("argument for base62d "
7316               "operator is \"%s\", which is not a base %d number", sub,
7317               BASE_62);
7318             goto EXPAND_FAILED;
7319             }
7320           n = n * BASE_62 + (t - base62_chars);
7321           }
7322         yield = string_fmt_append(yield, "%ld", n);
7323         break;
7324         }
7325
7326       case EOP_EXPAND:
7327         {
7328         uschar *expanded = expand_string_internal(sub,
7329                 ESI_HONOR_DOLLAR | flags & ESI_SKIPPING, NULL, &resetok, NULL);
7330         if (!expanded)
7331           {
7332           expand_string_message =
7333             string_sprintf("internal expansion of \"%s\" failed: %s", sub,
7334               expand_string_message);
7335           goto EXPAND_FAILED;
7336           }
7337         yield = string_cat(yield, expanded);
7338         break;
7339         }
7340
7341       case EOP_LC:
7342         {
7343         uschar * t = sub - 1;
7344         while (*++t) *t = tolower(*t);
7345         yield = string_catn(yield, sub, t-sub);
7346         break;
7347         }
7348
7349       case EOP_UC:
7350         {
7351         uschar * t = sub - 1;
7352         while (*++t) *t = toupper(*t);
7353         yield = string_catn(yield, sub, t-sub);
7354         break;
7355         }
7356
7357       case EOP_MD5:
7358 #ifndef DISABLE_TLS
7359         if (vp && *(void **)vp->value)
7360           {
7361           uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
7362           yield = string_cat(yield, cp);
7363           }
7364         else
7365 #endif
7366           {
7367           md5 base;
7368           uschar digest[16];
7369           md5_start(&base);
7370           md5_end(&base, sub, Ustrlen(sub), digest);
7371           for (int j = 0; j < 16; j++)
7372             yield = string_fmt_append(yield, "%02x", digest[j]);
7373           }
7374         break;
7375
7376       case EOP_SHA1:
7377 #ifndef DISABLE_TLS
7378         if (vp && *(void **)vp->value)
7379           {
7380           uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
7381           yield = string_cat(yield, cp);
7382           }
7383         else
7384 #endif
7385           {
7386           hctx h;
7387           uschar digest[20];
7388           sha1_start(&h);
7389           sha1_end(&h, sub, Ustrlen(sub), digest);
7390           for (int j = 0; j < 20; j++)
7391             yield = string_fmt_append(yield, "%02X", digest[j]);
7392           }
7393         break;
7394
7395       case EOP_SHA2:
7396       case EOP_SHA256:
7397 #ifdef EXIM_HAVE_SHA2
7398         if (vp && *(void **)vp->value)
7399           if (c == EOP_SHA256)
7400             yield = string_cat(yield, tls_cert_fprt_sha256(*(void **)vp->value));
7401           else
7402             expand_string_message = US"sha2_N not supported with certificates";
7403         else
7404           {
7405           hctx h;
7406           blob b;
7407           hashmethod m = !arg ? HASH_SHA2_256
7408             : Ustrcmp(arg, "256") == 0 ? HASH_SHA2_256
7409             : Ustrcmp(arg, "384") == 0 ? HASH_SHA2_384
7410             : Ustrcmp(arg, "512") == 0 ? HASH_SHA2_512
7411             : HASH_BADTYPE;
7412
7413           if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7414             {
7415             expand_string_message = US"unrecognised sha2 variant";
7416             goto EXPAND_FAILED;
7417             }
7418
7419           exim_sha_update_string(&h, sub);
7420           exim_sha_finish(&h, &b);
7421           while (b.len-- > 0)
7422             yield = string_fmt_append(yield, "%02X", *b.data++);
7423           }
7424 #else
7425           expand_string_message = US"sha256 only supported with TLS";
7426 #endif
7427         break;
7428
7429       case EOP_SHA3:
7430 #ifdef EXIM_HAVE_SHA3
7431         {
7432         hctx h;
7433         blob b;
7434         hashmethod m = !arg ? HASH_SHA3_256
7435           : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224
7436           : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256
7437           : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384
7438           : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512
7439           : HASH_BADTYPE;
7440
7441         if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7442           {
7443           expand_string_message = US"unrecognised sha3 variant";
7444           goto EXPAND_FAILED;
7445           }
7446
7447         exim_sha_update_string(&h, sub);
7448         exim_sha_finish(&h, &b);
7449         while (b.len-- > 0)
7450           yield = string_fmt_append(yield, "%02X", *b.data++);
7451         }
7452         break;
7453 #else
7454         expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 + or OpenSSL 1.1.1 +";
7455         goto EXPAND_FAILED;
7456 #endif
7457
7458       /* Line-wrap a string as if it is a header line */
7459
7460       case EOP_HEADERWRAP:
7461         {
7462         unsigned col = 80, lim = 998;
7463         uschar * s;
7464
7465         if (arg)
7466           {
7467           const uschar * list = arg;
7468           int sep = '_';
7469           if ((s = string_nextinlist(&list, &sep, NULL, 0)))
7470             {
7471             col = atoi(CS s);
7472             if ((s = string_nextinlist(&list, &sep, NULL, 0)))
7473               lim = atoi(CS s);
7474             }
7475           }
7476           if ((s =  wrap_header(sub, col, lim, US"\t", 8)))
7477             yield = string_cat(yield, s);
7478         }
7479         break;
7480
7481       /* Convert hex encoding to base64 encoding */
7482
7483       case EOP_HEX2B64:
7484         {
7485         int c = 0;
7486         int b = -1;
7487         uschar *in = sub;
7488         uschar *out = sub;
7489         uschar *enc;
7490
7491         for (enc = sub; *enc; enc++)
7492           {
7493           if (!isxdigit(*enc))
7494             {
7495             expand_string_message = string_sprintf("\"%s\" is not a hex "
7496               "string", sub);
7497             goto EXPAND_FAILED;
7498             }
7499           c++;
7500           }
7501
7502         if ((c & 1) != 0)
7503           {
7504           expand_string_message = string_sprintf("\"%s\" contains an odd "
7505             "number of characters", sub);
7506           goto EXPAND_FAILED;
7507           }
7508
7509         while ((c = *in++) != 0)
7510           {
7511           if (isdigit(c)) c -= '0';
7512           else c = toupper(c) - 'A' + 10;
7513           if (b == -1)
7514             b = c << 4;
7515           else
7516             {
7517             *out++ = b | c;
7518             b = -1;
7519             }
7520           }
7521
7522         enc = b64encode(CUS sub, out - sub);
7523         yield = string_cat(yield, enc);
7524         break;
7525         }
7526
7527       /* Convert octets outside 0x21..0x7E to \xXX form */
7528
7529       case EOP_HEXQUOTE:
7530         {
7531         uschar *t = sub - 1;
7532         while (*(++t) != 0)
7533           {
7534           if (*t < 0x21 || 0x7E < *t)
7535             yield = string_fmt_append(yield, "\\x%02x", *t);
7536           else
7537             yield = string_catn(yield, t, 1);
7538           }
7539         break;
7540         }
7541
7542       /* count the number of list elements */
7543
7544       case EOP_LISTCOUNT:
7545         {
7546         int cnt = 0, sep = 0;
7547         uschar * buf = store_get(2, sub);
7548
7549         while (string_nextinlist(CUSS &sub, &sep, buf, 1)) cnt++;
7550         yield = string_fmt_append(yield, "%d", cnt);
7551         break;
7552         }
7553
7554       /* expand a named list given the name */
7555       /* handles nested named lists; requotes as colon-sep list */
7556
7557       case EOP_LISTNAMED:
7558         expand_string_message = NULL;
7559         yield = expand_listnamed(yield, sub, arg);
7560         if (expand_string_message)
7561           goto EXPAND_FAILED;
7562         break;
7563
7564       /* quote a list-item for the given list-separator */
7565
7566       /* mask applies a mask to an IP address; for example the result of
7567       ${mask:131.111.10.206/28} is 131.111.10.192/28. */
7568
7569       case EOP_MASK:
7570         {
7571         int count;
7572         uschar *endptr;
7573         int binary[4];
7574         int type, mask, maskoffset;
7575         BOOL normalised;
7576         uschar buffer[64];
7577
7578         if ((type = string_is_ip_address(sub, &maskoffset)) == 0)
7579           {
7580           expand_string_message = string_sprintf("\"%s\" is not an IP address",
7581            sub);
7582           goto EXPAND_FAILED;
7583           }
7584
7585         if (maskoffset == 0)
7586           {
7587           expand_string_message = string_sprintf("missing mask value in \"%s\"",
7588             sub);
7589           goto EXPAND_FAILED;
7590           }
7591
7592         mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
7593
7594         if (*endptr || mask < 0 || mask > (type == 4 ? 32 : 128))
7595           {
7596           expand_string_message = string_sprintf("mask value too big in \"%s\"",
7597             sub);
7598           goto EXPAND_FAILED;
7599           }
7600
7601         /* If an optional 'n' was given, ipv6 gets normalised output:
7602         colons rather than dots, and zero-compressed. */
7603
7604         normalised = arg && *arg == 'n';
7605
7606         /* Convert the address to binary integer(s) and apply the mask */
7607
7608         sub[maskoffset] = 0;
7609         count = host_aton(sub, binary);
7610         host_mask(count, binary, mask);
7611
7612         /* Convert to masked textual format and add to output. */
7613
7614         if (type == 4 || !normalised)
7615           yield = string_catn(yield, buffer,
7616             host_nmtoa(count, binary, mask, buffer, '.'));
7617         else
7618           {
7619           ipv6_nmtoa(binary, buffer);
7620           yield = string_fmt_append(yield, "%s/%d", buffer, mask);
7621           }
7622         break;
7623         }
7624
7625       case EOP_IPV6NORM:
7626       case EOP_IPV6DENORM:
7627         {
7628         int type = string_is_ip_address(sub, NULL);
7629         int binary[4];
7630         uschar buffer[44];
7631
7632         switch (type)
7633           {
7634           case 6:
7635             (void) host_aton(sub, binary);
7636             break;
7637
7638           case 4:       /* convert to IPv4-mapped IPv6 */
7639             binary[0] = binary[1] = 0;
7640             binary[2] = 0x0000ffff;
7641             (void) host_aton(sub, binary+3);
7642             break;
7643
7644           case 0:
7645             expand_string_message =
7646               string_sprintf("\"%s\" is not an IP address", sub);
7647             goto EXPAND_FAILED;
7648           }
7649
7650         yield = string_catn(yield, buffer, c == EOP_IPV6NORM
7651                     ? ipv6_nmtoa(binary, buffer)
7652                     : host_nmtoa(4, binary, -1, buffer, ':')
7653                   );
7654         break;
7655         }
7656
7657       case EOP_ADDRESS:
7658       case EOP_LOCAL_PART:
7659       case EOP_DOMAIN:
7660         {
7661         uschar * error;
7662         int start, end, domain;
7663         uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,
7664           FALSE);
7665         if (t)
7666           if (c != EOP_DOMAIN)
7667             yield = c == EOP_LOCAL_PART && domain > 0
7668               ? string_catn(yield, t, domain - 1)
7669               : string_cat(yield, t);
7670           else if (domain > 0)
7671             yield = string_cat(yield, t + domain);
7672         break;
7673         }
7674
7675       case EOP_ADDRESSES:
7676         {
7677         uschar outsep[2] = { ':', '\0' };
7678         uschar *address, *error;
7679         int save_ptr = gstring_length(yield);
7680         int start, end, domain;  /* Not really used */
7681
7682         if (Uskip_whitespace(&sub) == '>')
7683           if (*outsep = *++sub) ++sub;
7684           else
7685             {
7686             expand_string_message = string_sprintf("output separator "
7687               "missing in expanding ${addresses:%s}", --sub);
7688             goto EXPAND_FAILED;
7689             }
7690         f.parse_allow_group = TRUE;
7691
7692         for (;;)
7693           {
7694           uschar * p = parse_find_address_end(sub, FALSE);
7695           uschar saveend = *p;
7696           *p = '\0';
7697           address = parse_extract_address(sub, &error, &start, &end, &domain,
7698             FALSE);
7699           *p = saveend;
7700
7701           /* Add the address to the output list that we are building. This is
7702           done in chunks by searching for the separator character. At the
7703           start, unless we are dealing with the first address of the output
7704           list, add in a space if the new address begins with the separator
7705           character, or is an empty string. */
7706
7707           if (address)
7708             {
7709             if (yield && yield->ptr != save_ptr && address[0] == *outsep)
7710               yield = string_catn(yield, US" ", 1);
7711
7712             for (;;)
7713               {
7714               size_t seglen = Ustrcspn(address, outsep);
7715               yield = string_catn(yield, address, seglen + 1);
7716
7717               /* If we got to the end of the string we output one character
7718               too many. */
7719
7720               if (address[seglen] == '\0') { yield->ptr--; break; }
7721               yield = string_catn(yield, outsep, 1);
7722               address += seglen + 1;
7723               }
7724
7725             /* Output a separator after the string: we will remove the
7726             redundant final one at the end. */
7727
7728             yield = string_catn(yield, outsep, 1);
7729             }
7730
7731           if (saveend == '\0') break;
7732           sub = p + 1;
7733           }
7734
7735         /* If we have generated anything, remove the redundant final
7736         separator. */
7737
7738         if (yield && yield->ptr != save_ptr) yield->ptr--;
7739         f.parse_allow_group = FALSE;
7740         break;
7741         }
7742
7743
7744       /* quote puts a string in quotes if it is empty or contains anything
7745       other than alphamerics, underscore, dot, or hyphen.
7746
7747       quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
7748       be quoted in order to be a valid local part.
7749
7750       In both cases, newlines and carriage returns are converted into \n and \r
7751       respectively */
7752
7753       case EOP_QUOTE:
7754       case EOP_QUOTE_LOCAL_PART:
7755         if (!arg)
7756           {
7757           BOOL needs_quote = (!*sub);      /* TRUE for empty string */
7758           uschar *t = sub - 1;
7759
7760           if (c == EOP_QUOTE)
7761             while (!needs_quote && *++t)
7762               needs_quote = !isalnum(*t) && !strchr("_-.", *t);
7763
7764           else  /* EOP_QUOTE_LOCAL_PART */
7765             while (!needs_quote && *++t)
7766               needs_quote = !isalnum(*t)
7767                 && strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL
7768                 && (*t != '.' || t == sub || !t[1]);
7769
7770           if (needs_quote)
7771             {
7772             yield = string_catn(yield, US"\"", 1);
7773             t = sub - 1;
7774             while (*++t)
7775               if (*t == '\n')
7776                 yield = string_catn(yield, US"\\n", 2);
7777               else if (*t == '\r')
7778                 yield = string_catn(yield, US"\\r", 2);
7779               else
7780                 {
7781                 if (*t == '\\' || *t == '"')
7782                   yield = string_catn(yield, US"\\", 1);
7783                 yield = string_catn(yield, t, 1);
7784                 }
7785             yield = string_catn(yield, US"\"", 1);
7786             }
7787           else
7788             yield = string_cat(yield, sub);
7789           }
7790
7791         /* quote_lookuptype does lookup-specific quoting */
7792
7793         else
7794           {
7795           const lookup_info * li;
7796           uschar * opt = Ustrchr(arg, '_');
7797
7798           if (opt) *opt++ = 0;
7799
7800           if (!(li = search_findtype(arg, Ustrlen(arg))))
7801             {
7802             expand_string_message = search_error_message;
7803             goto EXPAND_FAILED;
7804             }
7805
7806           if (li->quote)
7807             sub = (li->quote)(sub, opt, li->acq_num);
7808           else if (opt)
7809             sub = NULL;
7810
7811           if (!sub)
7812             {
7813             expand_string_message = string_sprintf(
7814               "\"%s\" unrecognized after \"${quote_%s\"",       /*}*/
7815               opt, arg);
7816             goto EXPAND_FAILED;
7817             }
7818
7819           yield = string_cat(yield, sub);
7820           }
7821         break;
7822
7823       /* rx quote sticks in \ before any non-alphameric character so that
7824       the insertion works in a regular expression. */
7825
7826       case EOP_RXQUOTE:
7827         {
7828         uschar *t = sub - 1;
7829         while (*(++t) != 0)
7830           {
7831           if (!isalnum(*t))
7832             yield = string_catn(yield, US"\\", 1);
7833           yield = string_catn(yield, t, 1);
7834           }
7835         break;
7836         }
7837
7838       /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
7839       prescribed by the RFC, if there are characters that need to be encoded */
7840
7841       case EOP_RFC2047:
7842         yield = string_cat(yield,
7843                             parse_quote_2047(sub, Ustrlen(sub), headers_charset,
7844                               FALSE));
7845         break;
7846
7847       /* RFC 2047 decode */
7848
7849       case EOP_RFC2047D:
7850         {
7851         int len;
7852         uschar *error;
7853         uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
7854           headers_charset, '?', &len, &error);
7855         if (error)
7856           {
7857           expand_string_message = error;
7858           goto EXPAND_FAILED;
7859           }
7860         yield = string_catn(yield, decoded, len);
7861         break;
7862         }
7863
7864       /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
7865       underscores */
7866
7867       case EOP_FROM_UTF8:
7868         {
7869         uschar * buff = store_get(4, sub);
7870         while (*sub)
7871           {
7872           int c;
7873           GETUTF8INC(c, sub);
7874           if (c > 255) c = '_';
7875           buff[0] = c;
7876           yield = string_catn(yield, buff, 1);
7877           }
7878         break;
7879         }
7880
7881       /* replace illegal UTF-8 sequences by replacement character  */
7882
7883       #define UTF8_REPLACEMENT_CHAR US"?"
7884
7885       case EOP_UTF8CLEAN:
7886         {
7887         int seq_len = 0, index = 0, bytes_left = 0, complete;
7888         u_long codepoint = (u_long)-1;
7889         uschar seq_buff[4];                     /* accumulate utf-8 here */
7890
7891         /* Manually track tainting, as we deal in individual chars below */
7892
7893         if (!yield)
7894           yield = string_get_tainted(Ustrlen(sub), sub);
7895         else if (!yield->s || !yield->ptr)
7896           {
7897           yield->s = store_get(yield->size = Ustrlen(sub), sub);
7898           gstring_reset(yield);
7899           }
7900         else if (is_incompatible(yield->s, sub))
7901           gstring_rebuffer(yield, sub);
7902
7903         /* Check the UTF-8, byte-by-byte */
7904
7905         while (*sub)
7906           {
7907           complete = 0;
7908           uschar c = *sub++;
7909
7910           if (bytes_left)
7911             {
7912             if ((c & 0xc0) != 0x80)
7913                     /* wrong continuation byte; invalidate all bytes */
7914               complete = 1; /* error */
7915             else
7916               {
7917               codepoint = (codepoint << 6) | (c & 0x3f);
7918               seq_buff[index++] = c;
7919               if (--bytes_left == 0)            /* codepoint complete */
7920                 if(codepoint > 0x10FFFF)        /* is it too large? */
7921                   complete = -1;        /* error (RFC3629 limit) */
7922                 else if ( (codepoint & 0x1FF800 ) == 0xD800 ) /* surrogate */
7923                   /* A UTF-16 surrogate (which should be one of a pair that
7924                   encode a Unicode codepoint that is outside the Basic
7925                   Multilingual Plane).  Error, not UTF8.
7926                   RFC2279.2 is slightly unclear on this, but
7927                   https://unicodebook.readthedocs.io/issues.html#strict-utf8-decoder
7928                   says "Surrogates characters are also invalid in UTF-8:
7929                   characters in U+D800—U+DFFF have to be rejected." */
7930                   complete = -1;
7931                 else
7932                   {             /* finished; output utf-8 sequence */
7933                   yield = string_catn(yield, seq_buff, seq_len);
7934                   index = 0;
7935                   }
7936               }
7937             }
7938           else  /* no bytes left: new sequence */
7939             {
7940             if (!(c & 0x80))    /* 1-byte sequence, US-ASCII, keep it */
7941               {
7942               yield = string_catn(yield, &c, 1);
7943               continue;
7944               }
7945             if ((c & 0xe0) == 0xc0)             /* 2-byte sequence */
7946               if (c == 0xc0 || c == 0xc1)       /* 0xc0 and 0xc1 are illegal */
7947                 complete = -1;
7948               else
7949                 {
7950                 bytes_left = 1;
7951                 codepoint = c & 0x1f;
7952                 }
7953             else if ((c & 0xf0) == 0xe0)                /* 3-byte sequence */
7954               {
7955               bytes_left = 2;
7956               codepoint = c & 0x0f;
7957               }
7958             else if ((c & 0xf8) == 0xf0)                /* 4-byte sequence */
7959               {
7960               bytes_left = 3;
7961               codepoint = c & 0x07;
7962               }
7963             else        /* invalid or too long (RFC3629 allows only 4 bytes) */
7964               complete = -1;
7965
7966             seq_buff[index++] = c;
7967             seq_len = bytes_left + 1;
7968             }           /* if(bytes_left) */
7969
7970           if (complete != 0)
7971             {
7972             bytes_left = index = 0;
7973             yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7974             }
7975           if ((complete == 1) && ((c & 0x80) == 0))
7976                         /* ASCII character follows incomplete sequence */
7977               yield = string_catn(yield, &c, 1);
7978           }
7979         /* If given a sequence truncated mid-character, we also want to report ?
7980         Eg, ${length_1:フィル} is one byte, not one character, so we expect
7981         ${utf8clean:${length_1:フィル}} to yield '?' */
7982
7983         if (bytes_left != 0)
7984           yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7985
7986         break;
7987         }
7988
7989 #ifdef SUPPORT_I18N
7990       case EOP_UTF8_DOMAIN_TO_ALABEL:
7991         {
7992         uschar * error = NULL;
7993         uschar * s = string_domain_utf8_to_alabel(sub, &error);
7994         if (error)
7995           {
7996           expand_string_message = string_sprintf(
7997             "error converting utf8 (%s) to alabel: %s",
7998             string_printing(sub), error);
7999           goto EXPAND_FAILED;
8000           }
8001         yield = string_cat(yield, s);
8002         break;
8003         }
8004
8005       case EOP_UTF8_DOMAIN_FROM_ALABEL:
8006         {
8007         uschar * error = NULL;
8008         uschar * s = string_domain_alabel_to_utf8(sub, &error);
8009         if (error)
8010           {
8011           expand_string_message = string_sprintf(
8012             "error converting alabel (%s) to utf8: %s",
8013             string_printing(sub), error);
8014           goto EXPAND_FAILED;
8015           }
8016         yield = string_cat(yield, s);
8017         break;
8018         }
8019
8020       case EOP_UTF8_LOCALPART_TO_ALABEL:
8021         {
8022         uschar * error = NULL;
8023         uschar * s = string_localpart_utf8_to_alabel(sub, &error);
8024         if (error)
8025           {
8026           expand_string_message = string_sprintf(
8027             "error converting utf8 (%s) to alabel: %s",
8028             string_printing(sub), error);
8029           goto EXPAND_FAILED;
8030           }
8031         yield = string_cat(yield, s);
8032         DEBUG(D_expand) debug_printf_indent("yield: '%Y'\n", yield);
8033         break;
8034         }
8035
8036       case EOP_UTF8_LOCALPART_FROM_ALABEL:
8037         {
8038         uschar * error = NULL;
8039         uschar * s = string_localpart_alabel_to_utf8(sub, &error);
8040         if (error)
8041           {
8042           expand_string_message = string_sprintf(
8043             "error converting alabel (%s) to utf8: %s",
8044             string_printing(sub), error);
8045           goto EXPAND_FAILED;
8046           }
8047         yield = string_cat(yield, s);
8048         break;
8049         }
8050 #endif  /* EXPERIMENTAL_INTERNATIONAL */
8051
8052       /* escape turns all non-printing characters into escape sequences. */
8053
8054       case EOP_ESCAPE:
8055         {
8056         const uschar * t = string_printing(sub);
8057         yield = string_cat(yield, t);
8058         break;
8059         }
8060
8061       case EOP_ESCAPE8BIT:
8062         {
8063         uschar c;
8064
8065         for (const uschar * s = sub; (c = *s); s++)
8066           yield = c < 127 && c != '\\'
8067             ? string_catn(yield, s, 1)
8068             : string_fmt_append(yield, "\\%03o", c);
8069         break;
8070         }
8071
8072       /* Handle numeric expression evaluation */
8073
8074       case EOP_EVAL:
8075       case EOP_EVAL10:
8076         {
8077         uschar *save_sub = sub;
8078         uschar *error = NULL;
8079         int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
8080         if (error)
8081           {
8082           expand_string_message = string_sprintf("error in expression "
8083             "evaluation: %s (after processing \"%.*s\")", error,
8084             (int)(sub-save_sub), save_sub);
8085           goto EXPAND_FAILED;
8086           }
8087         yield = string_fmt_append(yield, PR_EXIM_ARITH, n);
8088         break;
8089         }
8090
8091       /* Handle time period formatting */
8092
8093       case EOP_TIME_EVAL:
8094         {
8095         int n = readconf_readtime(sub, 0, FALSE);
8096         if (n < 0)
8097           {
8098           expand_string_message = string_sprintf("string \"%s\" is not an "
8099             "Exim time interval in \"%s\" operator", sub, name);
8100           goto EXPAND_FAILED;
8101           }
8102         yield = string_fmt_append(yield, "%d", n);
8103         break;
8104         }
8105
8106       case EOP_TIME_INTERVAL:
8107         {
8108         int n;
8109         uschar *t = read_number(&n, sub);
8110         if (*t != 0) /* Not A Number*/
8111           {
8112           expand_string_message = string_sprintf("string \"%s\" is not a "
8113             "positive number in \"%s\" operator", sub, name);
8114           goto EXPAND_FAILED;
8115           }
8116         t = readconf_printtime(n);
8117         yield = string_cat(yield, t);
8118         break;
8119         }
8120
8121       /* Convert string to base64 encoding */
8122
8123       case EOP_STR2B64:
8124       case EOP_BASE64:
8125         {
8126 #ifndef DISABLE_TLS
8127         uschar * s = vp && *(void **)vp->value
8128           ? tls_cert_der_b64(*(void **)vp->value)
8129           : b64encode(CUS sub, Ustrlen(sub));
8130 #else
8131         uschar * s = b64encode(CUS sub, Ustrlen(sub));
8132 #endif
8133         yield = string_cat(yield, s);
8134         break;
8135         }
8136
8137       case EOP_BASE64D:
8138         {
8139         uschar * s;
8140         int len = b64decode(sub, &s, sub);
8141         if (len < 0)
8142           {
8143           expand_string_message = string_sprintf("string \"%s\" is not "
8144             "well-formed for \"%s\" operator", sub, name);
8145           goto EXPAND_FAILED;
8146           }
8147         yield = string_cat(yield, s);
8148         break;
8149         }
8150
8151       /* strlen returns the length of the string */
8152
8153       case EOP_STRLEN:
8154         yield = string_fmt_append(yield, "%d", Ustrlen(sub));
8155         break;
8156
8157       /* length_n or l_n takes just the first n characters or the whole string,
8158       whichever is the shorter;
8159
8160       substr_m_n, and s_m_n take n characters from offset m; negative m take
8161       from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
8162       takes the rest, either to the right or to the left.
8163
8164       hash_n or h_n makes a hash of length n from the string, yielding n
8165       characters from the set a-z; hash_n_m makes a hash of length n, but
8166       uses m characters from the set a-zA-Z0-9.
8167
8168       nhash_n returns a single number between 0 and n-1 (in text form), while
8169       nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
8170       between 0 and n-1 and the second between 0 and m-1. */
8171
8172       case EOP_LENGTH:
8173       case EOP_L:
8174       case EOP_SUBSTR:
8175       case EOP_S:
8176       case EOP_HASH:
8177       case EOP_H:
8178       case EOP_NHASH:
8179       case EOP_NH:
8180         {
8181         int sign = 1;
8182         int value1 = 0;
8183         int value2 = -1;
8184         int *pn;
8185         int len;
8186         uschar *ret;
8187
8188         if (!arg)
8189           {
8190           expand_string_message = string_sprintf("missing values after %s",
8191             name);
8192           goto EXPAND_FAILED;
8193           }
8194
8195         /* "length" has only one argument, effectively being synonymous with
8196         substr_0_n. */
8197
8198         if (c == EOP_LENGTH || c == EOP_L)
8199           {
8200           pn = &value2;
8201           value2 = 0;
8202           }
8203
8204         /* The others have one or two arguments; for "substr" the first may be
8205         negative. The second being negative means "not supplied". */
8206
8207         else
8208           {
8209           pn = &value1;
8210           if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
8211           }
8212
8213         /* Read up to two numbers, separated by underscores */
8214
8215         ret = arg;
8216         while (*arg != 0)
8217           {
8218           if (arg != ret && *arg == '_' && pn == &value1)
8219             {
8220             pn = &value2;
8221             value2 = 0;
8222             if (arg[1] != 0) arg++;
8223             }
8224           else if (!isdigit(*arg))
8225             {
8226             expand_string_message =
8227               string_sprintf("non-digit after underscore in \"%s\"", name);
8228             goto EXPAND_FAILED;
8229             }
8230           else *pn = (*pn)*10 + *arg++ - '0';
8231           }
8232         value1 *= sign;
8233
8234         /* Perform the required operation */
8235
8236         ret = c == EOP_HASH || c == EOP_H
8237           ? compute_hash(sub, value1, value2, &len)
8238           : c == EOP_NHASH || c == EOP_NH
8239           ? compute_nhash(sub, value1, value2, &len)
8240           : extract_substr(sub, value1, value2, &len);
8241         if (!ret) goto EXPAND_FAILED;
8242
8243         yield = string_catn(yield, ret, len);
8244         break;
8245         }
8246
8247       /* Stat a path */
8248
8249       case EOP_STAT:
8250         {
8251         uschar smode[12];
8252         uschar **modetable[3];
8253         mode_t mode;
8254         struct stat st;
8255
8256         if (expand_forbid & RDO_EXISTS)
8257           {
8258           expand_string_message = US"Use of the stat() expansion is not permitted";
8259           goto EXPAND_FAILED;
8260           }
8261
8262         if (stat(CS sub, &st) < 0)
8263           {
8264           expand_string_message = string_sprintf("stat(%s) failed: %s",
8265             sub, strerror(errno));
8266           goto EXPAND_FAILED;
8267           }
8268         mode = st.st_mode;
8269         switch (mode & S_IFMT)
8270           {
8271           case S_IFIFO: smode[0] = 'p'; break;
8272           case S_IFCHR: smode[0] = 'c'; break;
8273           case S_IFDIR: smode[0] = 'd'; break;
8274           case S_IFBLK: smode[0] = 'b'; break;
8275           case S_IFREG: smode[0] = '-'; break;
8276           default: smode[0] = '?'; break;
8277           }
8278
8279         modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
8280         modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
8281         modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
8282
8283         for (int i = 0; i < 3; i++)
8284           {
8285           memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
8286           mode >>= 3;
8287           }
8288
8289         smode[10] = 0;
8290         yield = string_fmt_append(yield,
8291           "mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
8292           "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
8293           (long)(st.st_mode & 077777), smode, (long)st.st_ino,
8294           (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
8295           (long)st.st_gid, st.st_size, (long)st.st_atime,
8296           (long)st.st_mtime, (long)st.st_ctime);
8297         break;
8298         }
8299
8300       /* vaguely random number less than N */
8301
8302       case EOP_RANDINT:
8303         {
8304         int_eximarith_t max = expanded_string_integer(sub, TRUE);
8305
8306         if (expand_string_message)
8307           goto EXPAND_FAILED;
8308         yield = string_fmt_append(yield, "%d", vaguely_random_number((int)max));
8309         break;
8310         }
8311
8312       /* Reverse IP, including IPv6 to dotted-nibble */
8313
8314       case EOP_REVERSE_IP:
8315         {
8316         int family, maskptr;
8317         uschar reversed[128];
8318
8319         family = string_is_ip_address(sub, &maskptr);
8320         if (family == 0)
8321           {
8322           expand_string_message = string_sprintf(
8323               "reverse_ip() not given an IP address [%s]", sub);
8324           goto EXPAND_FAILED;
8325           }
8326         invert_address(reversed, sub);
8327         yield = string_cat(yield, reversed);
8328         break;
8329         }
8330
8331       case EOP_XTEXTD:
8332         {
8333         uschar * s;
8334         int len = xtextdecode(sub, &s);
8335         yield = string_catn(yield, s, len);
8336         break;
8337         }
8338
8339       /* Unknown operator */
8340       default:
8341         expand_string_message =
8342           string_sprintf("unknown expansion operator \"%s\"", name);
8343         goto EXPAND_FAILED;
8344       } /* EOP_* switch */
8345
8346       DEBUG(D_expand)
8347         {
8348         const uschar * res = string_from_gstring(yield);
8349         const uschar * s = res + expansion_start;
8350         int i = gstring_length(yield) - expansion_start;
8351         BOOL tainted = is_tainted(s);
8352
8353         debug_printf_indent("%Vop-res: %.*s\n", "K-----", i, s);
8354         if (tainted)
8355           {
8356           debug_printf_indent("%V          %V",
8357             flags & ESI_SKIPPING ? "|" : " ",
8358             "\\__");
8359           debug_print_taint(res);
8360           }
8361         }
8362        continue;
8363        }
8364     }
8365
8366   /* Not an item or an operator */
8367   /* Handle a plain name. If this is the first thing in the expansion, release
8368   the pre-allocated buffer. If the result data is known to be in a new buffer,
8369   newsize will be set to the size of that buffer, and we can just point at that
8370   store instead of copying. Many expansion strings contain just one reference,
8371   so this is a useful optimization, especially for humungous headers
8372   ($message_headers). */
8373                                                 /*{*/
8374   if (*s++ == '}')
8375     {
8376     const uschar * value;
8377     int len;
8378     int newsize = 0;
8379     gstring * g = NULL;
8380
8381     if (!yield)
8382       g = store_get(sizeof(gstring), GET_UNTAINTED);
8383     else if (yield->ptr == 0)
8384       {
8385       if (resetok) reset_point = store_reset(reset_point);
8386       yield = NULL;
8387       reset_point = store_mark();
8388       g = store_get(sizeof(gstring), GET_UNTAINTED);    /* alloc _before_ calling find_variable() */
8389       }
8390     if (!(value = find_variable(name, flags, &newsize)))
8391       {
8392       expand_string_message =
8393         string_sprintf("unknown variable in \"${%s}\"", name);
8394       check_variable_error_message(name);
8395       goto EXPAND_FAILED;
8396       }
8397     len = Ustrlen(value);
8398     if (!yield && newsize)
8399       {
8400       yield = g;
8401       yield->size = newsize;
8402       yield->ptr = len;
8403       yield->s = US value; /* known to be in new store i.e. a copy, so deconst safe */
8404       }
8405     else
8406       yield = string_catn(yield, value, len);
8407     continue;
8408     }
8409
8410   /* Else there's something wrong */
8411
8412   expand_string_message =
8413     string_sprintf("\"${%s\" is not a known operator (or a } is missing "
8414     "in a variable reference)", name);
8415   goto EXPAND_FAILED;
8416   }
8417
8418 /* If we hit the end of the string when brace_ends is set, there is a missing
8419 terminating brace. */
8420
8421 if (flags & ESI_BRACE_ENDS && !*s)
8422   {                                                     /*{{*/
8423   expand_string_message = malformed_header
8424     ? US"missing } at end of string - could be header name not terminated by colon"
8425     : US"missing } at end of string";
8426   goto EXPAND_FAILED;
8427   }
8428
8429 /* Expansion succeeded; yield may still be NULL here if nothing was actually
8430 added to the string. If so, set up an empty string. Add a terminating zero. If
8431 left != NULL, return a pointer to the terminator. */
8432
8433  {
8434   uschar * res;
8435
8436   if (!yield)
8437     yield = string_get(1);
8438   res = string_from_gstring(yield);
8439   if (left) *left = s;
8440
8441   /* Any stacking store that was used above the final string is no longer needed.
8442   In many cases the final string will be the first one that was got and so there
8443   will be optimal store usage. */
8444
8445   if (resetok) gstring_release_unused(yield);
8446   else if (resetok_p) *resetok_p = FALSE;
8447
8448   DEBUG(D_expand)
8449     {
8450     BOOL tainted = is_tainted(res);
8451     debug_printf_indent("%Vexpanded: %.*W\n",
8452       "K---",
8453       (int)(s - string), string);
8454     debug_printf_indent("%Vresult: ",
8455       flags & ESI_SKIPPING ? "K-----" : "\\_____");
8456     if (*res || !(flags & ESI_SKIPPING))
8457       debug_printf("%W\n", res);
8458     else
8459       debug_printf(" %Vskipped%V\n", "<", ">");
8460     if (tainted)
8461       {
8462       debug_printf_indent("%V          %V",
8463         flags & ESI_SKIPPING ? "|" : " ",
8464         "\\__"
8465         );
8466       debug_print_taint(res);
8467       }
8468     if (flags & ESI_SKIPPING)
8469       debug_printf_indent("%Vskipping: result is not used\n", "\\___");
8470     }
8471   if (textonly_p) *textonly_p = textonly;
8472   expand_level--;
8473   return res;
8474  }
8475
8476 /* This is the failure exit: easiest to program with a goto. We still need
8477 to update the pointer to the terminator, for cases of nested calls with "fail".
8478 */
8479
8480 EXPAND_FAILED_CURLY:
8481 if (malformed_header)
8482   expand_string_message =
8483     US"missing or misplaced { or } - could be header name not terminated by colon";
8484
8485 else if (!expand_string_message || !*expand_string_message)
8486   expand_string_message = US"missing or misplaced { or }";
8487
8488 /* At one point, Exim reset the store to yield (if yield was not NULL), but
8489 that is a bad idea, because expand_string_message is in dynamic store. */
8490
8491 EXPAND_FAILED:
8492 if (left) *left = s;
8493 DEBUG(D_expand)
8494   {
8495   debug_printf_indent("%Vfailed to expand: %s\n", "K", string);
8496   debug_printf_indent("%Verror message: %s\n",
8497     f.expand_string_forcedfail ? "K---" : "\\___", expand_string_message);
8498   if (f.expand_string_forcedfail)
8499     debug_printf_indent("%Vfailure was forced\n", "\\");
8500   }
8501 if (resetok_p && !resetok) *resetok_p = FALSE;
8502 expand_level--;
8503 return NULL;
8504 }
8505
8506
8507
8508 /* This is the external function call. Do a quick check for any expansion
8509 metacharacters, and if there are none, just return the input string.
8510
8511 Arguments
8512         the string to be expanded
8513         optional pointer for return boolean indicating no-dynamic-expansions
8514
8515 Returns:  the expanded string, or NULL if expansion failed; if failure was
8516           due to a lookup deferring, search_find_defer will be TRUE
8517 */
8518
8519 const uschar *
8520 expand_string_2(const uschar * string, BOOL * textonly_p)
8521 {
8522 f.expand_string_forcedfail = f.search_find_defer = malformed_header = FALSE;
8523 if (Ustrpbrk(string, "$\\") != NULL)
8524   {
8525   int old_pool = store_pool;
8526   uschar * s;
8527
8528   store_pool = POOL_MAIN;
8529     s = expand_string_internal(string, ESI_HONOR_DOLLAR, NULL, NULL, textonly_p);
8530   store_pool = old_pool;
8531   return s;
8532   }
8533 if (textonly_p) *textonly_p = TRUE;
8534 return string;
8535 }
8536
8537 const uschar *
8538 expand_cstring(const uschar * string)
8539 { return expand_string_2(string, NULL); }
8540
8541 uschar *
8542 expand_string(uschar * string)
8543 { return US expand_string_2(CUS string, NULL); }
8544
8545
8546
8547
8548
8549
8550 /*************************************************
8551 *              Expand and copy                   *
8552 *************************************************/
8553
8554 /* Now and again we want to expand a string and be sure that the result is in a
8555 new bit of store. This function does that.
8556 Since we know it has been copied, the de-const cast is safe.
8557
8558 Argument: the string to be expanded
8559 Returns:  the expanded string, always in a new bit of store, or NULL
8560 */
8561
8562 uschar *
8563 expand_string_copy(const uschar *string)
8564 {
8565 const uschar *yield = expand_cstring(string);
8566 if (yield == string) yield = string_copy(string);
8567 return US yield;
8568 }
8569
8570
8571
8572 /*************************************************
8573 *        Expand and interpret as an integer      *
8574 *************************************************/
8575
8576 /* Expand a string, and convert the result into an integer.
8577
8578 Arguments:
8579   string  the string to be expanded
8580   isplus  TRUE if a non-negative number is expected
8581
8582 Returns:  the integer value, or
8583           -1 for an expansion error               ) in both cases, message in
8584           -2 for an integer interpretation error  ) expand_string_message
8585           expand_string_message is set NULL for an OK integer
8586 */
8587
8588 int_eximarith_t
8589 expand_string_integer(uschar *string, BOOL isplus)
8590 {
8591 return expanded_string_integer(expand_string(string), isplus);
8592 }
8593
8594
8595 /*************************************************
8596  *         Interpret string as an integer        *
8597  *************************************************/
8598
8599 /* Convert a string (that has already been expanded) into an integer.
8600
8601 This function is used inside the expansion code.
8602
8603 Arguments:
8604   s       the string to be expanded
8605   isplus  TRUE if a non-negative number is expected
8606
8607 Returns:  the integer value, or
8608           -1 if string is NULL (which implies an expansion error)
8609           -2 for an integer interpretation error
8610           expand_string_message is set NULL for an OK integer
8611 */
8612
8613 static int_eximarith_t
8614 expanded_string_integer(const uschar *s, BOOL isplus)
8615 {
8616 int_eximarith_t value;
8617 uschar *msg = US"invalid integer \"%s\"";
8618 uschar *endptr;
8619
8620 /* If expansion failed, expand_string_message will be set. */
8621
8622 if (!s) return -1;
8623
8624 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
8625 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
8626 systems, so we set it zero ourselves. */
8627
8628 errno = 0;
8629 expand_string_message = NULL;               /* Indicates no error */
8630
8631 /* Before Exim 4.64, strings consisting entirely of whitespace compared
8632 equal to 0.  Unfortunately, people actually relied upon that, so preserve
8633 the behaviour explicitly.  Stripping leading whitespace is a harmless
8634 noop change since strtol skips it anyway (provided that there is a number
8635 to find at all). */
8636 if (isspace(*s))
8637   if (Uskip_whitespace(&s) == '\0')
8638     {
8639       DEBUG(D_expand)
8640        debug_printf_indent("treating blank string as number 0\n");
8641       return 0;
8642     }
8643
8644 value = strtoll(CS s, CSS &endptr, 10);
8645
8646 if (endptr == s)
8647   msg = US"integer expected but \"%s\" found";
8648 else if (value < 0 && isplus)
8649   msg = US"non-negative integer expected but \"%s\" found";
8650 else
8651   {
8652   switch (tolower(*endptr))
8653     {
8654     default:
8655       break;
8656     case 'k':
8657       if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
8658       else value *= 1024;
8659       endptr++;
8660       break;
8661     case 'm':
8662       if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
8663       else value *= 1024*1024;
8664       endptr++;
8665       break;
8666     case 'g':
8667       if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
8668       else value *= 1024*1024*1024;
8669       endptr++;
8670       break;
8671     }
8672   if (errno == ERANGE)
8673     msg = US"absolute value of integer \"%s\" is too large (overflow)";
8674   else
8675     if (Uskip_whitespace(&endptr) == 0) return value;
8676   }
8677
8678 expand_string_message = string_sprintf(CS msg, s);
8679 return -2;
8680 }
8681
8682
8683 /* These values are usually fixed boolean values, but they are permitted to be
8684 expanded strings.
8685
8686 Arguments:
8687   addr       address being routed
8688   mtype      the module type
8689   mname      the module name
8690   dbg_opt    debug selectors
8691   oname      the option name
8692   bvalue     the router's boolean value
8693   svalue     the router's string value
8694   rvalue     where to put the returned value
8695
8696 Returns:     OK     value placed in rvalue
8697              DEFER  expansion failed
8698 */
8699
8700 int
8701 exp_bool(address_item * addr,
8702   const uschar * mtype, const uschar * mname, unsigned dbg_opt,
8703   uschar * oname, BOOL bvalue,
8704   const uschar * svalue, BOOL * rvalue)
8705 {
8706 const uschar * expanded;
8707
8708 DEBUG(D_expand) debug_printf("try option %s\n", oname);
8709 if (!svalue) { *rvalue = bvalue; return OK; }
8710
8711 if (!(expanded = expand_cstring(svalue)))
8712   {
8713   if (f.expand_string_forcedfail)
8714     {
8715     DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
8716     *rvalue = bvalue;
8717     return OK;
8718     }
8719   addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
8720       oname, mname, mtype, expand_string_message);
8721   DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
8722   return DEFER;
8723   }
8724
8725 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
8726   expanded);
8727
8728 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
8729   *rvalue = TRUE;
8730 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
8731   *rvalue = FALSE;
8732 else
8733   {
8734   addr->message = string_sprintf("\"%s\" is not a valid value for the "
8735     "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
8736   return DEFER;
8737   }
8738
8739 return OK;
8740 }
8741
8742
8743
8744 /* Avoid potentially exposing a password in a string about to be logged */
8745
8746 uschar *
8747 expand_hide_passwords(uschar * s)
8748 {
8749 return (  (  Ustrstr(s, "failed to expand") != NULL
8750           || Ustrstr(s, "expansion of ")    != NULL
8751           )
8752        && (  Ustrstr(s, "mysql")   != NULL
8753           || Ustrstr(s, "pgsql")   != NULL
8754           || Ustrstr(s, "redis")   != NULL
8755           || Ustrstr(s, "sqlite")  != NULL
8756           || Ustrstr(s, "ldap:")   != NULL
8757           || Ustrstr(s, "ldaps:")  != NULL
8758           || Ustrstr(s, "ldapi:")  != NULL
8759           || Ustrstr(s, "ldapdn:") != NULL
8760           || Ustrstr(s, "ldapm:")  != NULL
8761        )  )
8762   ? US"Temporary internal error" : s;
8763 }
8764
8765
8766 /* Read given named file into big_buffer.  Use for keying material etc.
8767 The content will have an ascii NUL appended.
8768
8769 Arguments:
8770  filename       as it says
8771
8772 Return:  pointer to buffer, or NULL on error.
8773 */
8774
8775 uschar *
8776 expand_file_big_buffer(const uschar * filename)
8777 {
8778 int fd, off = 0, len;
8779
8780 if ((fd = exim_open2(CS filename, O_RDONLY)) < 0)
8781   {
8782   log_write(0, LOG_MAIN | LOG_PANIC, "unable to open file for reading: %s",
8783              filename);
8784   return NULL;
8785   }
8786
8787 do
8788   {
8789   if ((len = read(fd, big_buffer + off, big_buffer_size - 2 - off)) < 0)
8790     {
8791     (void) close(fd);
8792     log_write(0, LOG_MAIN|LOG_PANIC, "unable to read file: %s", filename);
8793     return NULL;
8794     }
8795   off += len;
8796   }
8797 while (len > 0);
8798
8799 (void) close(fd);
8800 big_buffer[off] = '\0';
8801 return big_buffer;
8802 }
8803
8804
8805
8806 /*************************************************
8807 * Error-checking for testsuite                   *
8808 *************************************************/
8809 typedef struct {
8810   uschar *      region_start;
8811   uschar *      region_end;
8812   const uschar *var_name;
8813   const uschar *var_data;
8814 } err_ctx;
8815
8816 /* Called via tree_walk, which allows nonconst name/data.  Our usage is const. */
8817 static void
8818 assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
8819 {
8820 err_ctx * e = ctx;
8821 if (var_data >= e->region_start  &&  var_data < e->region_end)
8822   {
8823   e->var_name = CUS var_name;
8824   e->var_data = CUS var_data;
8825   }
8826 }
8827
8828 void
8829 assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
8830 {
8831 err_ctx e = { .region_start = ptr, .region_end = US ptr + len,
8832               .var_name = NULL, .var_data = NULL };
8833
8834 /* check acl_ variables */
8835 tree_walk(acl_var_c, assert_variable_notin, &e);
8836 tree_walk(acl_var_m, assert_variable_notin, &e);
8837
8838 /* check auth<n> variables.
8839 assert_variable_notin() treats as const, so deconst is safe. */
8840 for (int i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
8841   assert_variable_notin(US"auth<n>", US auth_vars[i], &e);
8842
8843 #ifdef WITH_CONTENT_SCAN
8844 /* check regex<n> variables. assert_variable_notin() treats as const. */
8845 for (int i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
8846   assert_variable_notin(US"regex<n>", US regex_vars[i], &e);
8847 #endif
8848
8849 /* check known-name variables */
8850 for (var_entry * v = var_table; v < var_table + nelem(var_table); v++)
8851   if (v->type == vtype_stringptr)
8852     assert_variable_notin(US v->name, *(USS v->value), &e);
8853
8854 /* check dns and address trees */
8855 tree_walk(tree_dns_fails,     assert_variable_notin, &e);
8856 tree_walk(tree_duplicates,    assert_variable_notin, &e);
8857 tree_walk(tree_nonrecipients, assert_variable_notin, &e);
8858 tree_walk(tree_unusable,      assert_variable_notin, &e);
8859
8860 if (e.var_name)
8861   log_write(0, LOG_MAIN|LOG_PANIC_DIE,
8862     "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
8863     e.var_name, filename, linenumber, e.var_data);
8864 }
8865
8866
8867
8868 /*************************************************
8869 **************************************************
8870 *             Stand-alone test program           *
8871 **************************************************
8872 *************************************************/
8873
8874 #ifdef STAND_ALONE
8875
8876
8877 BOOL
8878 regex_match_and_setup(const pcre2_code *re, uschar *subject, int options, int setup)
8879 {
8880 int ovec[3*(EXPAND_MAXN+1)];
8881 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
8882   ovec, nelem(ovec));
8883 BOOL yield = n >= 0;
8884 if (n == 0) n = EXPAND_MAXN + 1;
8885 if (yield)
8886   {
8887   expand_nmax = setup < 0 ? 0 : setup + 1;
8888   for (int nn = setup < 0 ? 0 : 2; nn < n*2; nn += 2)
8889     {
8890     expand_nstring[expand_nmax] = subject + ovec[nn];
8891     expand_nlength[expand_nmax++] = ovec[nn+1] - ovec[nn];
8892     }
8893   expand_nmax--;
8894   }
8895 return yield;
8896 }
8897
8898
8899 int main(int argc, uschar **argv)
8900 {
8901 uschar buffer[1024];
8902
8903 debug_selector = D_v;
8904 debug_file = stderr;
8905 debug_fd = fileno(debug_file);
8906 big_buffer = malloc(big_buffer_size);
8907 store_init();
8908
8909 for (int i = 1; i < argc; i++)
8910   {
8911   if (argv[i][0] == '+')
8912     {
8913     debug_trace_memory = 2;
8914     argv[i]++;
8915     }
8916   if (isdigit(argv[i][0]))
8917     debug_selector = Ustrtol(argv[i], NULL, 0);
8918   else
8919     if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
8920         Ustrlen(argv[i]))
8921       {
8922 #ifdef LOOKUP_LDAP
8923       eldap_default_servers = argv[i];
8924 #endif
8925 #ifdef LOOKUP_MYSQL
8926       mysql_servers = argv[i];
8927 #endif
8928 #ifdef LOOKUP_PGSQL
8929       pgsql_servers = argv[i];
8930 #endif
8931 #ifdef LOOKUP_REDIS
8932       redis_servers = argv[i];
8933 #endif
8934       }
8935 #ifdef EXIM_PERL
8936   else opt_perl_startup = argv[i];
8937 #endif
8938   }
8939
8940 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
8941
8942 expand_nstring[1] = US"string 1....";
8943 expand_nlength[1] = 8;
8944 expand_nmax = 1;
8945
8946 #ifdef EXIM_PERL
8947 if (opt_perl_startup != NULL)
8948   {
8949   uschar *errstr;
8950   printf("Starting Perl interpreter\n");
8951   errstr = init_perl(opt_perl_startup);
8952   if (errstr != NULL)
8953     {
8954     printf("** error in perl_startup code: %s\n", errstr);
8955     return EXIT_FAILURE;
8956     }
8957   }
8958 #endif /* EXIM_PERL */
8959
8960 /* Thie deliberately regards the input as untainted, so that it can be
8961 expanded; only reasonable since this is a test for string-expansions. */
8962
8963 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
8964   {
8965   rmark reset_point = store_mark();
8966   uschar *yield = expand_string(buffer);
8967   if (yield)
8968     printf("%s\n", yield);
8969   else
8970     {
8971     if (f.search_find_defer) printf("search_find deferred\n");
8972     printf("Failed: %s\n", expand_string_message);
8973     if (f.expand_string_forcedfail) printf("Forced failure\n");
8974     printf("\n");
8975     }
8976   store_reset(reset_point);
8977   }
8978
8979 search_tidyup();
8980
8981 return 0;
8982 }
8983
8984 #endif  /*STAND_ALONE*/
8985
8986 #endif  /*!MACRO_PREDEF*/
8987 /* vi: aw ai sw=2
8988 */
8989 /* End of expand.c */