src/src/expand.c

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