src/src/expand.c

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) The Exim Maintainers 2020 - 2023 */
   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 #endif  /*!STAND_ALONE*/
  31
  32 #ifdef LOOKUP_LDAP
  33 # include "lookups/ldap.h"
  34 #endif
  35
  36 #ifdef SUPPORT_CRYPTEQ
  37 # ifdef CRYPT_H
  38 #  include <crypt.h>
  39 # endif
  40 # ifndef HAVE_CRYPT16
  41 extern char* crypt16(char*, char*);
  42 # endif
  43 #endif
  44
  45 /* The handling of crypt16() is a mess. I will record below the analysis of the
  46 mess that was sent to me. We decided, however, to make changing this very low
  47 priority, because in practice people are moving away from the crypt()
  48 algorithms nowadays, so it doesn't seem worth it.
  49
  50 <quote>
  51 There is an algorithm named "crypt16" in Ultrix and Tru64.  It crypts
  52 the first 8 characters of the password using a 20-round version of crypt
  53 (standard crypt does 25 rounds).  It then crypts the next 8 characters,
  54 or an empty block if the password is less than 9 characters, using a
  55 20-round version of crypt and the same salt as was used for the first
  56 block.  Characters after the first 16 are ignored.  It always generates
  57 a 16-byte hash, which is expressed together with the salt as a string
  58 of 24 base 64 digits.  Here are some links to peruse:
  59
  60         http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
  61         http://seclists.org/bugtraq/1999/Mar/0076.html
  62
  63 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
  64 and OSF/1.  This is the same as the standard crypt if given a password
  65 of 8 characters or less.  If given more, it first does the same as crypt
  66 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
  67 using as salt the first two base 64 digits from the first hash block.
  68 If the password is more than 16 characters then it crypts the 17th to 24th
  69 characters using as salt the first two base 64 digits from the second hash
  70 block.  And so on: I've seen references to it cutting off the password at
  71 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks).  Some links:
  72
  73         http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
  74         http://seclists.org/bugtraq/1999/Mar/0109.html
  75         http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
  76              TET1_html/sec.c222.html#no_id_208
  77
  78 Exim has something it calls "crypt16".  It will either use a native
  79 crypt16 or its own implementation.  A native crypt16 will presumably
  80 be the one that I called "crypt16" above.  The internal "crypt16"
  81 function, however, is a two-block-maximum implementation of what I called
  82 "bigcrypt".  The documentation matches the internal code.
  83
  84 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
  85 that crypt16 and bigcrypt were different things.
  86
  87 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
  88 to whatever it is using under that name.  This unfortunately sets a
  89 precedent for using "{crypt16}" to identify two incompatible algorithms
  90 whose output can't be distinguished.  With "{crypt16}" thus rendered
  91 ambiguous, I suggest you deprecate it and invent two new identifiers
  92 for the two algorithms.
  93
  94 Both crypt16 and bigcrypt are very poor algorithms, btw.  Hashing parts
  95 of the password separately means they can be cracked separately, so
  96 the double-length hash only doubles the cracking effort instead of
  97 squaring it.  I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
  98 bcrypt ({CRYPT}$2a$).
  99 </quote>
 100 */
 101
 102
 103
 104 /*************************************************
 105 *            Local statics and tables            *
 106 *************************************************/
 107
 108 /* Table of item names, and corresponding switch numbers. The names must be in
 109 alphabetical order. */
 110
 111 static uschar *item_table[] = {
 112   US"acl",
 113   US"authresults",
 114   US"certextract",
 115   US"dlfunc",
 116   US"env",
 117   US"extract",
 118   US"filter",
 119   US"hash",
 120   US"hmac",
 121   US"if",
 122 #ifdef SUPPORT_I18N
 123   US"imapfolder",
 124 #endif
 125   US"length",
 126   US"listextract",
 127   US"listquote",
 128   US"lookup",
 129   US"map",
 130   US"nhash",
 131   US"perl",
 132   US"prvs",
 133   US"prvscheck",
 134   US"readfile",
 135   US"readsocket",
 136   US"reduce",
 137   US"run",
 138   US"sg",
 139   US"sort",
 140 #ifdef SUPPORT_SRS
 141   US"srs_encode",
 142 #endif
 143   US"substr",
 144   US"tr" };
 145
 146 enum {
 147   EITEM_ACL,
 148   EITEM_AUTHRESULTS,
 149   EITEM_CERTEXTRACT,
 150   EITEM_DLFUNC,
 151   EITEM_ENV,
 152   EITEM_EXTRACT,
 153   EITEM_FILTER,
 154   EITEM_HASH,
 155   EITEM_HMAC,
 156   EITEM_IF,
 157 #ifdef SUPPORT_I18N
 158   EITEM_IMAPFOLDER,
 159 #endif
 160   EITEM_LENGTH,
 161   EITEM_LISTEXTRACT,
 162   EITEM_LISTQUOTE,
 163   EITEM_LOOKUP,
 164   EITEM_MAP,
 165   EITEM_NHASH,
 166   EITEM_PERL,
 167   EITEM_PRVS,
 168   EITEM_PRVSCHECK,
 169   EITEM_READFILE,
 170   EITEM_READSOCK,
 171   EITEM_REDUCE,
 172   EITEM_RUN,
 173   EITEM_SG,
 174   EITEM_SORT,
 175 #ifdef SUPPORT_SRS
 176   EITEM_SRS_ENCODE,
 177 #endif
 178   EITEM_SUBSTR,
 179   EITEM_TR };
 180
 181 /* Tables of operator names, and corresponding switch numbers. The names must be
 182 in alphabetical order. There are two tables, because underscore is used in some
 183 cases to introduce arguments, whereas for other it is part of the name. This is
 184 an historical mis-design. */
 185
 186 static uschar * op_table_underscore[] = {
 187   US"from_utf8",
 188   US"local_part",
 189   US"quote_local_part",
 190   US"reverse_ip",
 191   US"time_eval",
 192   US"time_interval"
 193 #ifdef SUPPORT_I18N
 194  ,US"utf8_domain_from_alabel",
 195   US"utf8_domain_to_alabel",
 196   US"utf8_localpart_from_alabel",
 197   US"utf8_localpart_to_alabel"
 198 #endif
 199   };
 200
 201 enum {
 202   EOP_FROM_UTF8,
 203   EOP_LOCAL_PART,
 204   EOP_QUOTE_LOCAL_PART,
 205   EOP_REVERSE_IP,
 206   EOP_TIME_EVAL,
 207   EOP_TIME_INTERVAL
 208 #ifdef SUPPORT_I18N
 209  ,EOP_UTF8_DOMAIN_FROM_ALABEL,
 210   EOP_UTF8_DOMAIN_TO_ALABEL,
 211   EOP_UTF8_LOCALPART_FROM_ALABEL,
 212   EOP_UTF8_LOCALPART_TO_ALABEL
 213 #endif
 214   };
 215
 216 static uschar *op_table_main[] = {
 217   US"address",
 218   US"addresses",
 219   US"base32",
 220   US"base32d",
 221   US"base62",
 222   US"base62d",
 223   US"base64",
 224   US"base64d",
 225   US"domain",
 226   US"escape",
 227   US"escape8bit",
 228   US"eval",
 229   US"eval10",
 230   US"expand",
 231   US"h",
 232   US"hash",
 233   US"headerwrap",
 234   US"hex2b64",
 235   US"hexquote",
 236   US"ipv6denorm",
 237   US"ipv6norm",
 238   US"l",
 239   US"lc",
 240   US"length",
 241   US"listcount",
 242   US"listnamed",
 243   US"mask",
 244   US"md5",
 245   US"nh",
 246   US"nhash",
 247   US"quote",
 248   US"randint",
 249   US"rfc2047",
 250   US"rfc2047d",
 251   US"rxquote",
 252   US"s",
 253   US"sha1",
 254   US"sha2",
 255   US"sha256",
 256   US"sha3",
 257   US"stat",
 258   US"str2b64",
 259   US"strlen",
 260   US"substr",
 261   US"uc",
 262   US"utf8clean" };
 263
 264 enum {
 265   EOP_ADDRESS =  nelem(op_table_underscore),
 266   EOP_ADDRESSES,
 267   EOP_BASE32,
 268   EOP_BASE32D,
 269   EOP_BASE62,
 270   EOP_BASE62D,
 271   EOP_BASE64,
 272   EOP_BASE64D,
 273   EOP_DOMAIN,
 274   EOP_ESCAPE,
 275   EOP_ESCAPE8BIT,
 276   EOP_EVAL,
 277   EOP_EVAL10,
 278   EOP_EXPAND,
 279   EOP_H,
 280   EOP_HASH,
 281   EOP_HEADERWRAP,
 282   EOP_HEX2B64,
 283   EOP_HEXQUOTE,
 284   EOP_IPV6DENORM,
 285   EOP_IPV6NORM,
 286   EOP_L,
 287   EOP_LC,
 288   EOP_LENGTH,
 289   EOP_LISTCOUNT,
 290   EOP_LISTNAMED,
 291   EOP_MASK,
 292   EOP_MD5,
 293   EOP_NH,
 294   EOP_NHASH,
 295   EOP_QUOTE,
 296   EOP_RANDINT,
 297   EOP_RFC2047,
 298   EOP_RFC2047D,
 299   EOP_RXQUOTE,
 300   EOP_S,
 301   EOP_SHA1,
 302   EOP_SHA2,
 303   EOP_SHA256,
 304   EOP_SHA3,
 305   EOP_STAT,
 306   EOP_STR2B64,
 307   EOP_STRLEN,
 308   EOP_SUBSTR,
 309   EOP_UC,
 310   EOP_UTF8CLEAN };
 311
 312
 313 /* Table of condition names, and corresponding switch numbers. The names must
 314 be in alphabetical order. */
 315
 316 static uschar *cond_table[] = {
 317   US"<",
 318   US"<=",
 319   US"=",
 320   US"==",     /* Backward compatibility */
 321   US">",
 322   US">=",
 323   US"acl",
 324   US"and",
 325   US"bool",
 326   US"bool_lax",
 327   US"crypteq",
 328   US"def",
 329   US"eq",
 330   US"eqi",
 331   US"exists",
 332   US"first_delivery",
 333   US"forall",
 334   US"forall_json",
 335   US"forall_jsons",
 336   US"forany",
 337   US"forany_json",
 338   US"forany_jsons",
 339   US"ge",
 340   US"gei",
 341   US"gt",
 342   US"gti",
 343 #ifdef SUPPORT_SRS
 344   US"inbound_srs",
 345 #endif
 346   US"inlist",
 347   US"inlisti",
 348   US"isip",
 349   US"isip4",
 350   US"isip6",
 351   US"ldapauth",
 352   US"le",
 353   US"lei",
 354   US"lt",
 355   US"lti",
 356   US"match",
 357   US"match_address",
 358   US"match_domain",
 359   US"match_ip",
 360   US"match_local_part",
 361   US"or",
 362   US"pam",
 363   US"pwcheck",
 364   US"queue_running",
 365   US"radius",
 366   US"saslauthd"
 367 };
 368
 369 enum {
 370   ECOND_NUM_L,
 371   ECOND_NUM_LE,
 372   ECOND_NUM_E,
 373   ECOND_NUM_EE,
 374   ECOND_NUM_G,
 375   ECOND_NUM_GE,
 376   ECOND_ACL,
 377   ECOND_AND,
 378   ECOND_BOOL,
 379   ECOND_BOOL_LAX,
 380   ECOND_CRYPTEQ,
 381   ECOND_DEF,
 382   ECOND_STR_EQ,
 383   ECOND_STR_EQI,
 384   ECOND_EXISTS,
 385   ECOND_FIRST_DELIVERY,
 386   ECOND_FORALL,
 387   ECOND_FORALL_JSON,
 388   ECOND_FORALL_JSONS,
 389   ECOND_FORANY,
 390   ECOND_FORANY_JSON,
 391   ECOND_FORANY_JSONS,
 392   ECOND_STR_GE,
 393   ECOND_STR_GEI,
 394   ECOND_STR_GT,
 395   ECOND_STR_GTI,
 396 #ifdef SUPPORT_SRS
 397   ECOND_INBOUND_SRS,
 398 #endif
 399   ECOND_INLIST,
 400   ECOND_INLISTI,
 401   ECOND_ISIP,
 402   ECOND_ISIP4,
 403   ECOND_ISIP6,
 404   ECOND_LDAPAUTH,
 405   ECOND_STR_LE,
 406   ECOND_STR_LEI,
 407   ECOND_STR_LT,
 408   ECOND_STR_LTI,
 409   ECOND_MATCH,
 410   ECOND_MATCH_ADDRESS,
 411   ECOND_MATCH_DOMAIN,
 412   ECOND_MATCH_IP,
 413   ECOND_MATCH_LOCAL_PART,
 414   ECOND_OR,
 415   ECOND_PAM,
 416   ECOND_PWCHECK,
 417   ECOND_QUEUE_RUNNING,
 418   ECOND_RADIUS,
 419   ECOND_SASLAUTHD
 420 };
 421
 422
 423 /* Types of table entry */
 424
 425 enum vtypes {
 426   vtype_int,            /* value is address of int */
 427   vtype_filter_int,     /* ditto, but recognized only when filtering */
 428   vtype_ino,            /* value is address of ino_t (not always an int) */
 429   vtype_uid,            /* value is address of uid_t (not always an int) */
 430   vtype_gid,            /* value is address of gid_t (not always an int) */
 431   vtype_bool,           /* value is address of bool */
 432   vtype_stringptr,      /* value is address of pointer to string */
 433   vtype_msgbody,        /* as stringptr, but read when first required */
 434   vtype_msgbody_end,    /* ditto, the end of the message */
 435   vtype_msgheaders,     /* the message's headers, processed */
 436   vtype_msgheaders_raw, /* the message's headers, unprocessed */
 437   vtype_localpart,      /* extract local part from string */
 438   vtype_domain,         /* extract domain from string */
 439   vtype_string_func,    /* value is string returned by given function */
 440   vtype_todbsdin,       /* value not used; generate BSD inbox tod */
 441   vtype_tode,           /* value not used; generate tod in epoch format */
 442   vtype_todel,          /* value not used; generate tod in epoch/usec format */
 443   vtype_todf,           /* value not used; generate full tod */
 444   vtype_todl,           /* value not used; generate log tod */
 445   vtype_todlf,          /* value not used; generate log file datestamp tod */
 446   vtype_todzone,        /* value not used; generate time zone only */
 447   vtype_todzulu,        /* value not used; generate zulu tod */
 448   vtype_reply,          /* value not used; get reply from headers */
 449   vtype_pid,            /* value not used; result is pid */
 450   vtype_host_lookup,    /* value not used; get host name */
 451   vtype_load_avg,       /* value not used; result is int from os_getloadavg */
 452   vtype_pspace,         /* partition space; value is T/F for spool/log */
 453   vtype_pinodes,        /* partition inodes; value is T/F for spool/log */
 454   vtype_cert            /* SSL certificate */
 455 #ifndef DISABLE_DKIM
 456   ,vtype_dkim           /* Lookup of value in DKIM signature */
 457 #endif
 458 };
 459
 460 /* Type for main variable table */
 461
 462 typedef struct {
 463   const char *name;
 464   enum vtypes type;
 465   void       *value;
 466 } var_entry;
 467
 468 /* Type for entries pointing to address/length pairs. Not currently
 469 in use. */
 470
 471 typedef struct {
 472   uschar **address;
 473   int  *length;
 474 } alblock;
 475
 476 typedef uschar * stringptr_fn_t(void);
 477 static uschar * fn_recipients(void);
 478 static uschar * fn_queue_size(void);
 479
 480 /* This table must be kept in alphabetical order. */
 481
 482 static var_entry var_table[] = {
 483   /* WARNING: Do not invent variables whose names start acl_c or acl_m because
 484      they will be confused with user-creatable ACL variables. */
 485   { "acl_arg1",            vtype_stringptr,   &acl_arg[0] },
 486   { "acl_arg2",            vtype_stringptr,   &acl_arg[1] },
 487   { "acl_arg3",            vtype_stringptr,   &acl_arg[2] },
 488   { "acl_arg4",            vtype_stringptr,   &acl_arg[3] },
 489   { "acl_arg5",            vtype_stringptr,   &acl_arg[4] },
 490   { "acl_arg6",            vtype_stringptr,   &acl_arg[5] },
 491   { "acl_arg7",            vtype_stringptr,   &acl_arg[6] },
 492   { "acl_arg8",            vtype_stringptr,   &acl_arg[7] },
 493   { "acl_arg9",            vtype_stringptr,   &acl_arg[8] },
 494   { "acl_narg",            vtype_int,         &acl_narg },
 495   { "acl_verify_message",  vtype_stringptr,   &acl_verify_message },
 496   { "address_data",        vtype_stringptr,   &deliver_address_data },
 497   { "address_file",        vtype_stringptr,   &address_file },
 498   { "address_pipe",        vtype_stringptr,   &address_pipe },
 499 #ifdef EXPERIMENTAL_ARC
 500   { "arc_domains",         vtype_string_func, (void *) &fn_arc_domains },
 501   { "arc_oldest_pass",     vtype_int,         &arc_oldest_pass },
 502   { "arc_state",           vtype_stringptr,   &arc_state },
 503   { "arc_state_reason",    vtype_stringptr,   &arc_state_reason },
 504 #endif
 505   { "authenticated_fail_id",vtype_stringptr,  &authenticated_fail_id },
 506   { "authenticated_id",    vtype_stringptr,   &authenticated_id },
 507   { "authenticated_sender",vtype_stringptr,   &authenticated_sender },
 508   { "authentication_failed",vtype_int,        &authentication_failed },
 509 #ifdef WITH_CONTENT_SCAN
 510   { "av_failed",           vtype_int,         &av_failed },
 511 #endif
 512 #ifdef EXPERIMENTAL_BRIGHTMAIL
 513   { "bmi_alt_location",    vtype_stringptr,   &bmi_alt_location },
 514   { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
 515   { "bmi_base64_verdict",  vtype_stringptr,   &bmi_base64_verdict },
 516   { "bmi_deliver",         vtype_int,         &bmi_deliver },
 517 #endif
 518   { "body_linecount",      vtype_int,         &body_linecount },
 519   { "body_zerocount",      vtype_int,         &body_zerocount },
 520   { "bounce_recipient",    vtype_stringptr,   &bounce_recipient },
 521   { "bounce_return_size_limit", vtype_int,    &bounce_return_size_limit },
 522   { "caller_gid",          vtype_gid,         &real_gid },
 523   { "caller_uid",          vtype_uid,         &real_uid },
 524   { "callout_address",     vtype_stringptr,   &callout_address },
 525   { "compile_date",        vtype_stringptr,   &version_date },
 526   { "compile_number",      vtype_stringptr,   &version_cnumber },
 527   { "config_dir",          vtype_stringptr,   &config_main_directory },
 528   { "config_file",         vtype_stringptr,   &config_main_filename },
 529   { "csa_status",          vtype_stringptr,   &csa_status },
 530 #ifdef EXPERIMENTAL_DCC
 531   { "dcc_header",          vtype_stringptr,   &dcc_header },
 532   { "dcc_result",          vtype_stringptr,   &dcc_result },
 533 #endif
 534 #ifndef DISABLE_DKIM
 535   { "dkim_algo",           vtype_dkim,        (void *)DKIM_ALGO },
 536   { "dkim_bodylength",     vtype_dkim,        (void *)DKIM_BODYLENGTH },
 537   { "dkim_canon_body",     vtype_dkim,        (void *)DKIM_CANON_BODY },
 538   { "dkim_canon_headers",  vtype_dkim,        (void *)DKIM_CANON_HEADERS },
 539   { "dkim_copiedheaders",  vtype_dkim,        (void *)DKIM_COPIEDHEADERS },
 540   { "dkim_created",        vtype_dkim,        (void *)DKIM_CREATED },
 541   { "dkim_cur_signer",     vtype_stringptr,   &dkim_cur_signer },
 542   { "dkim_domain",         vtype_stringptr,   &dkim_signing_domain },
 543   { "dkim_expires",        vtype_dkim,        (void *)DKIM_EXPIRES },
 544   { "dkim_headernames",    vtype_dkim,        (void *)DKIM_HEADERNAMES },
 545   { "dkim_identity",       vtype_dkim,        (void *)DKIM_IDENTITY },
 546   { "dkim_key_granularity",vtype_dkim,        (void *)DKIM_KEY_GRANULARITY },
 547   { "dkim_key_length",     vtype_int,         &dkim_key_length },
 548   { "dkim_key_nosubdomains",vtype_dkim,       (void *)DKIM_NOSUBDOMAINS },
 549   { "dkim_key_notes",      vtype_dkim,        (void *)DKIM_KEY_NOTES },
 550   { "dkim_key_srvtype",    vtype_dkim,        (void *)DKIM_KEY_SRVTYPE },
 551   { "dkim_key_testing",    vtype_dkim,        (void *)DKIM_KEY_TESTING },
 552   { "dkim_selector",       vtype_stringptr,   &dkim_signing_selector },
 553   { "dkim_signers",        vtype_stringptr,   &dkim_signers },
 554   { "dkim_verify_reason",  vtype_stringptr,   &dkim_verify_reason },
 555   { "dkim_verify_status",  vtype_stringptr,   &dkim_verify_status },
 556 #endif
 557 #ifdef SUPPORT_DMARC
 558   { "dmarc_domain_policy", vtype_stringptr,   &dmarc_domain_policy },
 559   { "dmarc_status",        vtype_stringptr,   &dmarc_status },
 560   { "dmarc_status_text",   vtype_stringptr,   &dmarc_status_text },
 561   { "dmarc_used_domain",   vtype_stringptr,   &dmarc_used_domain },
 562 #endif
 563   { "dnslist_domain",      vtype_stringptr,   &dnslist_domain },
 564   { "dnslist_matched",     vtype_stringptr,   &dnslist_matched },
 565   { "dnslist_text",        vtype_stringptr,   &dnslist_text },
 566   { "dnslist_value",       vtype_stringptr,   &dnslist_value },
 567   { "domain",              vtype_stringptr,   &deliver_domain },
 568   { "domain_data",         vtype_stringptr,   &deliver_domain_data },
 569 #ifndef DISABLE_EVENT
 570   { "event_data",          vtype_stringptr,   &event_data },
 571
 572   /*XXX want to use generic vars for as many of these as possible*/
 573   { "event_defer_errno",   vtype_int,         &event_defer_errno },
 574
 575   { "event_name",          vtype_stringptr,   &event_name },
 576 #endif
 577   { "exim_gid",            vtype_gid,         &exim_gid },
 578   { "exim_path",           vtype_stringptr,   &exim_path },
 579   { "exim_uid",            vtype_uid,         &exim_uid },
 580   { "exim_version",        vtype_stringptr,   &version_string },
 581   { "headers_added",       vtype_string_func, (void *) &fn_hdrs_added },
 582   { "home",                vtype_stringptr,   &deliver_home },
 583   { "host",                vtype_stringptr,   &deliver_host },
 584   { "host_address",        vtype_stringptr,   &deliver_host_address },
 585   { "host_data",           vtype_stringptr,   &host_data },
 586   { "host_lookup_deferred",vtype_int,         &host_lookup_deferred },
 587   { "host_lookup_failed",  vtype_int,         &host_lookup_failed },
 588   { "host_port",           vtype_int,         &deliver_host_port },
 589   { "initial_cwd",         vtype_stringptr,   &initial_cwd },
 590   { "inode",               vtype_ino,         &deliver_inode },
 591   { "interface_address",   vtype_stringptr,   &interface_address },
 592   { "interface_port",      vtype_int,         &interface_port },
 593   { "item",                vtype_stringptr,   &iterate_item },
 594 #ifdef LOOKUP_LDAP
 595   { "ldap_dn",             vtype_stringptr,   &eldap_dn },
 596 #endif
 597   { "load_average",        vtype_load_avg,    NULL },
 598   { "local_part",          vtype_stringptr,   &deliver_localpart },
 599   { "local_part_data",     vtype_stringptr,   &deliver_localpart_data },
 600   { "local_part_prefix",   vtype_stringptr,   &deliver_localpart_prefix },
 601   { "local_part_prefix_v", vtype_stringptr,   &deliver_localpart_prefix_v },
 602   { "local_part_suffix",   vtype_stringptr,   &deliver_localpart_suffix },
 603   { "local_part_suffix_v", vtype_stringptr,   &deliver_localpart_suffix_v },
 604 #ifdef HAVE_LOCAL_SCAN
 605   { "local_scan_data",     vtype_stringptr,   &local_scan_data },
 606 #endif
 607   { "local_user_gid",      vtype_gid,         &local_user_gid },
 608   { "local_user_uid",      vtype_uid,         &local_user_uid },
 609   { "localhost_number",    vtype_int,         &host_number },
 610   { "log_inodes",          vtype_pinodes,     (void *)FALSE },
 611   { "log_space",           vtype_pspace,      (void *)FALSE },
 612   { "lookup_dnssec_authenticated",vtype_stringptr,&lookup_dnssec_authenticated},
 613   { "mailstore_basename",  vtype_stringptr,   &mailstore_basename },
 614 #ifdef WITH_CONTENT_SCAN
 615   { "malware_name",        vtype_stringptr,   &malware_name },
 616 #endif
 617   { "max_received_linelength", vtype_int,     &max_received_linelength },
 618   { "message_age",         vtype_int,         &message_age },
 619   { "message_body",        vtype_msgbody,     &message_body },
 620   { "message_body_end",    vtype_msgbody_end, &message_body_end },
 621   { "message_body_size",   vtype_int,         &message_body_size },
 622   { "message_exim_id",     vtype_stringptr,   &message_id },
 623   { "message_headers",     vtype_msgheaders,  NULL },
 624   { "message_headers_raw", vtype_msgheaders_raw, NULL },
 625   { "message_id",          vtype_stringptr,   &message_id },
 626   { "message_linecount",   vtype_int,         &message_linecount },
 627   { "message_size",        vtype_int,         &message_size },
 628 #ifdef SUPPORT_I18N
 629   { "message_smtputf8",    vtype_bool,        &message_smtputf8 },
 630 #endif
 631 #ifdef WITH_CONTENT_SCAN
 632   { "mime_anomaly_level",  vtype_int,         &mime_anomaly_level },
 633   { "mime_anomaly_text",   vtype_stringptr,   &mime_anomaly_text },
 634   { "mime_boundary",       vtype_stringptr,   &mime_boundary },
 635   { "mime_charset",        vtype_stringptr,   &mime_charset },
 636   { "mime_content_description", vtype_stringptr, &mime_content_description },
 637   { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
 638   { "mime_content_id",     vtype_stringptr,   &mime_content_id },
 639   { "mime_content_size",   vtype_int,         &mime_content_size },
 640   { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
 641   { "mime_content_type",   vtype_stringptr,   &mime_content_type },
 642   { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
 643   { "mime_filename",       vtype_stringptr,   &mime_filename },
 644   { "mime_is_coverletter", vtype_int,         &mime_is_coverletter },
 645   { "mime_is_multipart",   vtype_int,         &mime_is_multipart },
 646   { "mime_is_rfc822",      vtype_int,         &mime_is_rfc822 },
 647   { "mime_part_count",     vtype_int,         &mime_part_count },
 648 #endif
 649   { "n0",                  vtype_filter_int,  &filter_n[0] },
 650   { "n1",                  vtype_filter_int,  &filter_n[1] },
 651   { "n2",                  vtype_filter_int,  &filter_n[2] },
 652   { "n3",                  vtype_filter_int,  &filter_n[3] },
 653   { "n4",                  vtype_filter_int,  &filter_n[4] },
 654   { "n5",                  vtype_filter_int,  &filter_n[5] },
 655   { "n6",                  vtype_filter_int,  &filter_n[6] },
 656   { "n7",                  vtype_filter_int,  &filter_n[7] },
 657   { "n8",                  vtype_filter_int,  &filter_n[8] },
 658   { "n9",                  vtype_filter_int,  &filter_n[9] },
 659   { "original_domain",     vtype_stringptr,   &deliver_domain_orig },
 660   { "original_local_part", vtype_stringptr,   &deliver_localpart_orig },
 661   { "originator_gid",      vtype_gid,         &originator_gid },
 662   { "originator_uid",      vtype_uid,         &originator_uid },
 663   { "parent_domain",       vtype_stringptr,   &deliver_domain_parent },
 664   { "parent_local_part",   vtype_stringptr,   &deliver_localpart_parent },
 665   { "pid",                 vtype_pid,         NULL },
 666 #ifndef DISABLE_PRDR
 667   { "prdr_requested",      vtype_bool,        &prdr_requested },
 668 #endif
 669   { "primary_hostname",    vtype_stringptr,   &primary_hostname },
 670 #if defined(SUPPORT_PROXY) || defined(SUPPORT_SOCKS)
 671   { "proxy_external_address",vtype_stringptr, &proxy_external_address },
 672   { "proxy_external_port", vtype_int,         &proxy_external_port },
 673   { "proxy_local_address", vtype_stringptr,   &proxy_local_address },
 674   { "proxy_local_port",    vtype_int,         &proxy_local_port },
 675   { "proxy_session",       vtype_bool,        &proxy_session },
 676 #endif
 677   { "prvscheck_address",   vtype_stringptr,   &prvscheck_address },
 678   { "prvscheck_keynum",    vtype_stringptr,   &prvscheck_keynum },
 679   { "prvscheck_result",    vtype_stringptr,   &prvscheck_result },
 680   { "qualify_domain",      vtype_stringptr,   &qualify_domain_sender },
 681   { "qualify_recipient",   vtype_stringptr,   &qualify_domain_recipient },
 682   { "queue_name",          vtype_stringptr,   &queue_name },
 683   { "queue_size",          vtype_string_func, (void *) &fn_queue_size },
 684   { "rcpt_count",          vtype_int,         &rcpt_count },
 685   { "rcpt_defer_count",    vtype_int,         &rcpt_defer_count },
 686   { "rcpt_fail_count",     vtype_int,         &rcpt_fail_count },
 687   { "received_count",      vtype_int,         &received_count },
 688   { "received_for",        vtype_stringptr,   &received_for },
 689   { "received_ip_address", vtype_stringptr,   &interface_address },
 690   { "received_port",       vtype_int,         &interface_port },
 691   { "received_protocol",   vtype_stringptr,   &received_protocol },
 692   { "received_time",       vtype_int,         &received_time.tv_sec },
 693   { "recipient_data",      vtype_stringptr,   &recipient_data },
 694   { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
 695   { "recipients",          vtype_string_func, (void *) &fn_recipients },
 696   { "recipients_count",    vtype_int,         &recipients_count },
 697   { "regex_cachesize",     vtype_int,         &regex_cachesize },/* undocumented; devel observability */
 698 #ifdef WITH_CONTENT_SCAN
 699   { "regex_match_string",  vtype_stringptr,   &regex_match_string },
 700 #endif
 701   { "reply_address",       vtype_reply,       NULL },
 702   { "return_path",         vtype_stringptr,   &return_path },
 703   { "return_size_limit",   vtype_int,         &bounce_return_size_limit },
 704   { "router_name",         vtype_stringptr,   &router_name },
 705   { "runrc",               vtype_int,         &runrc },
 706   { "self_hostname",       vtype_stringptr,   &self_hostname },
 707   { "sender_address",      vtype_stringptr,   &sender_address },
 708   { "sender_address_data", vtype_stringptr,   &sender_address_data },
 709   { "sender_address_domain", vtype_domain,    &sender_address },
 710   { "sender_address_local_part", vtype_localpart, &sender_address },
 711   { "sender_data",         vtype_stringptr,   &sender_data },
 712   { "sender_fullhost",     vtype_stringptr,   &sender_fullhost },
 713   { "sender_helo_dnssec",  vtype_bool,        &sender_helo_dnssec },
 714   { "sender_helo_name",    vtype_stringptr,   &sender_helo_name },
 715   { "sender_helo_verified",vtype_string_func, (void *) &sender_helo_verified_boolstr },
 716   { "sender_host_address", vtype_stringptr,   &sender_host_address },
 717   { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
 718   { "sender_host_dnssec",  vtype_bool,        &sender_host_dnssec },
 719   { "sender_host_name",    vtype_host_lookup, NULL },
 720   { "sender_host_port",    vtype_int,         &sender_host_port },
 721   { "sender_ident",        vtype_stringptr,   &sender_ident },
 722   { "sender_rate",         vtype_stringptr,   &sender_rate },
 723   { "sender_rate_limit",   vtype_stringptr,   &sender_rate_limit },
 724   { "sender_rate_period",  vtype_stringptr,   &sender_rate_period },
 725   { "sender_rcvhost",      vtype_stringptr,   &sender_rcvhost },
 726   { "sender_verify_failure",vtype_stringptr,  &sender_verify_failure },
 727   { "sending_ip_address",  vtype_stringptr,   &sending_ip_address },
 728   { "sending_port",        vtype_int,         &sending_port },
 729   { "smtp_active_hostname", vtype_stringptr,  &smtp_active_hostname },
 730   { "smtp_command",        vtype_stringptr,   &smtp_cmd_buffer },
 731   { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
 732   { "smtp_command_history", vtype_string_func, (void *) &smtp_cmd_hist },
 733   { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
 734   { "smtp_notquit_reason", vtype_stringptr,   &smtp_notquit_reason },
 735   { "sn0",                 vtype_filter_int,  &filter_sn[0] },
 736   { "sn1",                 vtype_filter_int,  &filter_sn[1] },
 737   { "sn2",                 vtype_filter_int,  &filter_sn[2] },
 738   { "sn3",                 vtype_filter_int,  &filter_sn[3] },
 739   { "sn4",                 vtype_filter_int,  &filter_sn[4] },
 740   { "sn5",                 vtype_filter_int,  &filter_sn[5] },
 741   { "sn6",                 vtype_filter_int,  &filter_sn[6] },
 742   { "sn7",                 vtype_filter_int,  &filter_sn[7] },
 743   { "sn8",                 vtype_filter_int,  &filter_sn[8] },
 744   { "sn9",                 vtype_filter_int,  &filter_sn[9] },
 745 #ifdef WITH_CONTENT_SCAN
 746   { "spam_action",         vtype_stringptr,   &spam_action },
 747   { "spam_bar",            vtype_stringptr,   &spam_bar },
 748   { "spam_report",         vtype_stringptr,   &spam_report },
 749   { "spam_score",          vtype_stringptr,   &spam_score },
 750   { "spam_score_int",      vtype_stringptr,   &spam_score_int },
 751 #endif
 752 #ifdef SUPPORT_SPF
 753   { "spf_guess",           vtype_stringptr,   &spf_guess },
 754   { "spf_header_comment",  vtype_stringptr,   &spf_header_comment },
 755   { "spf_received",        vtype_stringptr,   &spf_received },
 756   { "spf_result",          vtype_stringptr,   &spf_result },
 757   { "spf_result_guessed",  vtype_bool,        &spf_result_guessed },
 758   { "spf_smtp_comment",    vtype_stringptr,   &spf_smtp_comment },
 759 #endif
 760   { "spool_directory",     vtype_stringptr,   &spool_directory },
 761   { "spool_inodes",        vtype_pinodes,     (void *)TRUE },
 762   { "spool_space",         vtype_pspace,      (void *)TRUE },
 763 #ifdef SUPPORT_SRS
 764   { "srs_recipient",       vtype_stringptr,   &srs_recipient },
 765 #endif
 766   { "thisaddress",         vtype_stringptr,   &filter_thisaddress },
 767
 768   /* The non-(in,out) variables are now deprecated */
 769   { "tls_bits",            vtype_int,         &tls_in.bits },
 770   { "tls_certificate_verified", vtype_int,    &tls_in.certificate_verified },
 771   { "tls_cipher",          vtype_stringptr,   &tls_in.cipher },
 772
 773   { "tls_in_bits",         vtype_int,         &tls_in.bits },
 774   { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
 775   { "tls_in_cipher",       vtype_stringptr,   &tls_in.cipher },
 776   { "tls_in_cipher_std",   vtype_stringptr,   &tls_in.cipher_stdname },
 777   { "tls_in_ocsp",         vtype_int,         &tls_in.ocsp },
 778   { "tls_in_ourcert",      vtype_cert,        &tls_in.ourcert },
 779   { "tls_in_peercert",     vtype_cert,        &tls_in.peercert },
 780   { "tls_in_peerdn",       vtype_stringptr,   &tls_in.peerdn },
 781 #ifndef DISABLE_TLS_RESUME
 782   { "tls_in_resumption",   vtype_int,         &tls_in.resumption },
 783 #endif
 784 #ifndef DISABLE_TLS
 785   { "tls_in_sni",          vtype_stringptr,   &tls_in.sni },
 786 #endif
 787   { "tls_in_ver",          vtype_stringptr,   &tls_in.ver },
 788   { "tls_out_bits",        vtype_int,         &tls_out.bits },
 789   { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
 790   { "tls_out_cipher",      vtype_stringptr,   &tls_out.cipher },
 791   { "tls_out_cipher_std",  vtype_stringptr,   &tls_out.cipher_stdname },
 792 #ifdef SUPPORT_DANE
 793   { "tls_out_dane",        vtype_bool,        &tls_out.dane_verified },
 794 #endif
 795   { "tls_out_ocsp",        vtype_int,         &tls_out.ocsp },
 796   { "tls_out_ourcert",     vtype_cert,        &tls_out.ourcert },
 797   { "tls_out_peercert",    vtype_cert,        &tls_out.peercert },
 798   { "tls_out_peerdn",      vtype_stringptr,   &tls_out.peerdn },
 799 #ifndef DISABLE_TLS_RESUME
 800   { "tls_out_resumption",  vtype_int,         &tls_out.resumption },
 801 #endif
 802 #ifndef DISABLE_TLS
 803   { "tls_out_sni",         vtype_stringptr,   &tls_out.sni },
 804 #endif
 805 #ifdef SUPPORT_DANE
 806   { "tls_out_tlsa_usage",  vtype_int,         &tls_out.tlsa_usage },
 807 #endif
 808   { "tls_out_ver",         vtype_stringptr,   &tls_out.ver },
 809
 810   { "tls_peerdn",          vtype_stringptr,   &tls_in.peerdn }, /* mind the alphabetical order! */
 811 #ifndef DISABLE_TLS
 812   { "tls_sni",             vtype_stringptr,   &tls_in.sni },    /* mind the alphabetical order! */
 813 #endif
 814
 815   { "tod_bsdinbox",        vtype_todbsdin,    NULL },
 816   { "tod_epoch",           vtype_tode,        NULL },
 817   { "tod_epoch_l",         vtype_todel,       NULL },
 818   { "tod_full",            vtype_todf,        NULL },
 819   { "tod_log",             vtype_todl,        NULL },
 820   { "tod_logfile",         vtype_todlf,       NULL },
 821   { "tod_zone",            vtype_todzone,     NULL },
 822   { "tod_zulu",            vtype_todzulu,     NULL },
 823   { "transport_name",      vtype_stringptr,   &transport_name },
 824   { "value",               vtype_stringptr,   &lookup_value },
 825   { "verify_mode",         vtype_stringptr,   &verify_mode },
 826   { "version_number",      vtype_stringptr,   &version_string },
 827   { "warn_message_delay",  vtype_stringptr,   &warnmsg_delay },
 828   { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
 829   { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
 830   { "warnmsg_delay",       vtype_stringptr,   &warnmsg_delay },
 831   { "warnmsg_recipient",   vtype_stringptr,   &warnmsg_recipients },
 832   { "warnmsg_recipients",  vtype_stringptr,   &warnmsg_recipients }
 833 };
 834
 835 #ifdef MACRO_PREDEF
 836
 837 /* dummies */
 838 uschar * fn_arc_domains(void) {return NULL;}
 839 uschar * fn_hdrs_added(void) {return NULL;}
 840 uschar * fn_queue_size(void) {return NULL;}
 841 uschar * fn_recipients(void) {return NULL;}
 842 uschar * sender_helo_verified_boolstr(void) {return NULL;}
 843 uschar * smtp_cmd_hist(void) {return NULL;}
 844
 845
 846
 847 static void
 848 expansion_items(void)
 849 {
 850 uschar buf[64];
 851 for (int i = 0; i < nelem(item_table); i++)
 852   {
 853   spf(buf, sizeof(buf), CUS"_EXP_ITEM_%T", item_table[i]);
 854   builtin_macro_create(buf);
 855   }
 856 }
 857 static void
 858 expansion_operators(void)
 859 {
 860 uschar buf[64];
 861 for (int i = 0; i < nelem(op_table_underscore); i++)
 862   {
 863   spf(buf, sizeof(buf), CUS"_EXP_OP_%T", op_table_underscore[i]);
 864   builtin_macro_create(buf);
 865   }
 866 for (int i = 0; i < nelem(op_table_main); i++)
 867   {
 868   spf(buf, sizeof(buf), CUS"_EXP_OP_%T", op_table_main[i]);
 869   builtin_macro_create(buf);
 870   }
 871 }
 872 static void
 873 expansion_conditions(void)
 874 {
 875 uschar buf[64];
 876 for (int i = 0; i < nelem(cond_table); i++)
 877   {
 878   spf(buf, sizeof(buf), CUS"_EXP_COND_%T", cond_table[i]);
 879   builtin_macro_create(buf);
 880   }
 881 }
 882 static void
 883 expansion_variables(void)
 884 {
 885 uschar buf[64];
 886 for (int i = 0; i < nelem(var_table); i++)
 887   {
 888   spf(buf, sizeof(buf), CUS"_EXP_VAR_%T", var_table[i].name);
 889   builtin_macro_create(buf);
 890   }
 891 }
 892
 893 void
 894 expansions(void)
 895 {
 896 expansion_items();
 897 expansion_operators();
 898 expansion_conditions();
 899 expansion_variables();
 900 }
 901
 902 #else   /*!MACRO_PREDEF*/
 903
 904 static uschar var_buffer[256];
 905 static BOOL malformed_header;
 906
 907 /* For textual hashes */
 908
 909 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
 910                                "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
 911                                "0123456789";
 912
 913 enum { HMAC_MD5, HMAC_SHA1 };
 914
 915 /* For numeric hashes */
 916
 917 static unsigned int prime[] = {
 918   2,   3,   5,   7,  11,  13,  17,  19,  23,  29,
 919  31,  37,  41,  43,  47,  53,  59,  61,  67,  71,
 920  73,  79,  83,  89,  97, 101, 103, 107, 109, 113};
 921
 922 /* For printing modes in symbolic form */
 923
 924 static uschar *mtable_normal[] =
 925   { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
 926
 927 static uschar *mtable_setid[] =
 928   { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
 929
 930 static uschar *mtable_sticky[] =
 931   { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
 932
 933 /* flags for find_header() */
 934 #define FH_EXISTS_ONLY  BIT(0)
 935 #define FH_WANT_RAW     BIT(1)
 936 #define FH_WANT_LIST    BIT(2)
 937
 938 /* Recursively called function */
 939 static uschar *expand_string_internal(const uschar *, esi_flags, const uschar **, BOOL *, BOOL *);
 940 static int_eximarith_t expanded_string_integer(const uschar *, BOOL);
 941
 942
 943 /*************************************************
 944 *           Tables for UTF-8 support             *
 945 *************************************************/
 946
 947 /* Table of the number of extra characters, indexed by the first character
 948 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
 949 0x3d. */
 950
 951 static uschar utf8_table1[] = {
 952   1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
 953   1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
 954   2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
 955   3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
 956
 957 /* These are the masks for the data bits in the first byte of a character,
 958 indexed by the number of additional bytes. */
 959
 960 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
 961
 962 /* Get the next UTF-8 character, advancing the pointer. */
 963
 964 #define GETUTF8INC(c, ptr) \
 965   c = *ptr++; \
 966   if ((c & 0xc0) == 0xc0) \
 967     { \
 968     int a = utf8_table1[c & 0x3f];  /* Number of additional bytes */ \
 969     int s = 6*a; \
 970     c = (c & utf8_table2[a]) << s; \
 971     while (a-- > 0) \
 972       { \
 973       s -= 6; \
 974       c |= (*ptr++ & 0x3f) << s; \
 975       } \
 976     }
 977
 978
 979
 980 static uschar * base32_chars = US"abcdefghijklmnopqrstuvwxyz234567";
 981
 982 /*************************************************
 983 *           Binary chop search on a table        *
 984 *************************************************/
 985
 986 /* This is used for matching expansion items and operators.
 987
 988 Arguments:
 989   name        the name that is being sought
 990   table       the table to search
 991   table_size  the number of items in the table
 992
 993 Returns:      the offset in the table, or -1
 994 */
 995
 996 static int
 997 chop_match(uschar *name, uschar **table, int table_size)
 998 {
 999 uschar **bot = table;
1000 uschar **top = table + table_size;
1001
1002 while (top > bot)
1003   {
1004   uschar **mid = bot + (top - bot)/2;
1005   int c = Ustrcmp(name, *mid);
1006   if (c == 0) return mid - table;
1007   if (c > 0) bot = mid + 1; else top = mid;
1008   }
1009
1010 return -1;
1011 }
1012
1013
1014
1015 /*************************************************
1016 *          Check a condition string              *
1017 *************************************************/
1018
1019 /* This function is called to expand a string, and test the result for a "true"
1020 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
1021 forced fail or lookup defer.
1022
1023 We used to release all store used, but this is not not safe due
1024 to ${dlfunc } and ${acl }.  In any case expand_string_internal()
1025 is reasonably careful to release what it can.
1026
1027 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
1028
1029 Arguments:
1030   condition     the condition string
1031   m1            text to be incorporated in panic error
1032   m2            ditto
1033
1034 Returns:        TRUE if condition is met, FALSE if not
1035 */
1036
1037 BOOL
1038 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
1039 {
1040 uschar * ss = expand_string(condition);
1041 if (!ss)
1042   {
1043   if (!f.expand_string_forcedfail && !f.search_find_defer)
1044     log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
1045       "for %s %s: %s", condition, m1, m2, expand_string_message);
1046   return FALSE;
1047   }
1048 return *ss && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
1049   strcmpic(ss, US"false") != 0;
1050 }
1051
1052
1053
1054
1055 /*************************************************
1056 *        Pseudo-random number generation         *
1057 *************************************************/
1058
1059 /* Pseudo-random number generation.  The result is not "expected" to be
1060 cryptographically strong but not so weak that someone will shoot themselves
1061 in the foot using it as a nonce in some email header scheme or whatever
1062 weirdness they'll twist this into.  The result should ideally handle fork().
1063
1064 However, if we're stuck unable to provide this, then we'll fall back to
1065 appallingly bad randomness.
1066
1067 If DISABLE_TLS is not defined then this will not be used except as an emergency
1068 fallback.
1069
1070 Arguments:
1071   max       range maximum
1072 Returns     a random number in range [0, max-1]
1073 */
1074
1075 #ifndef DISABLE_TLS
1076 # define vaguely_random_number vaguely_random_number_fallback
1077 #endif
1078 int
1079 vaguely_random_number(int max)
1080 {
1081 #ifndef DISABLE_TLS
1082 # undef vaguely_random_number
1083 #endif
1084 static pid_t pid = 0;
1085 pid_t p2;
1086
1087 if ((p2 = getpid()) != pid)
1088   {
1089   if (pid != 0)
1090     {
1091
1092 #ifdef HAVE_ARC4RANDOM
1093     /* cryptographically strong randomness, common on *BSD platforms, not
1094     so much elsewhere.  Alas. */
1095 # ifndef NOT_HAVE_ARC4RANDOM_STIR
1096     arc4random_stir();
1097 # endif
1098 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1099 # ifdef HAVE_SRANDOMDEV
1100     /* uses random(4) for seeding */
1101     srandomdev();
1102 # else
1103     {
1104     struct timeval tv;
1105     gettimeofday(&tv, NULL);
1106     srandom(tv.tv_sec | tv.tv_usec | getpid());
1107     }
1108 # endif
1109 #else
1110     /* Poor randomness and no seeding here */
1111 #endif
1112
1113     }
1114   pid = p2;
1115   }
1116
1117 #ifdef HAVE_ARC4RANDOM
1118 return arc4random() % max;
1119 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
1120 return random() % max;
1121 #else
1122 /* This one returns a 16-bit number, definitely not crypto-strong */
1123 return random_number(max);
1124 #endif
1125 }
1126
1127
1128
1129
1130 /*************************************************
1131 *             Pick out a name from a string      *
1132 *************************************************/
1133
1134 /* If the name is too long, it is silently truncated.
1135
1136 Arguments:
1137   name      points to a buffer into which to put the name
1138   max       is the length of the buffer
1139   s         points to the first alphabetic character of the name
1140   extras    chars other than alphanumerics to permit
1141
1142 Returns:    pointer to the first character after the name
1143
1144 Note: The test for *s != 0 in the while loop is necessary because
1145 Ustrchr() yields non-NULL if the character is zero (which is not something
1146 I expected). */
1147
1148 static const uschar *
1149 read_name(uschar *name, int max, const uschar *s, uschar *extras)
1150 {
1151 int ptr = 0;
1152 while (*s && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
1153   {
1154   if (ptr < max-1) name[ptr++] = *s;
1155   s++;
1156   }
1157 name[ptr] = 0;
1158 return s;
1159 }
1160
1161
1162
1163 /*************************************************
1164 *     Pick out the rest of a header name         *
1165 *************************************************/
1166
1167 /* A variable name starting $header_ (or just $h_ for those who like
1168 abbreviations) might not be the complete header name because headers can
1169 contain any printing characters in their names, except ':'. This function is
1170 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
1171 on the end, if the name was terminated by white space.
1172
1173 Arguments:
1174   name      points to a buffer in which the name read so far exists
1175   max       is the length of the buffer
1176   s         points to the first character after the name so far, i.e. the
1177             first non-alphameric character after $header_xxxxx
1178
1179 Returns:    a pointer to the first character after the header name
1180 */
1181
1182 static const uschar *
1183 read_header_name(uschar *name, int max, const uschar *s)
1184 {
1185 int prelen = Ustrchr(name, '_') - name + 1;
1186 int ptr = Ustrlen(name) - prelen;
1187 if (ptr > 0) memmove(name, name+prelen, ptr);
1188 while (mac_isgraph(*s) && *s != ':')
1189   {
1190   if (ptr < max-1) name[ptr++] = *s;
1191   s++;
1192   }
1193 if (*s == ':') s++;
1194 name[ptr++] = ':';
1195 name[ptr] = 0;
1196 return s;
1197 }
1198
1199
1200
1201 /*************************************************
1202 *           Pick out a number from a string      *
1203 *************************************************/
1204
1205 /* Arguments:
1206   n     points to an integer into which to put the number
1207   s     points to the first digit of the number
1208
1209 Returns:  a pointer to the character after the last digit
1210 */
1211 /*XXX consider expanding to int_eximarith_t.  But the test for
1212 "overbig numbers" in 0002 still needs to overflow it. */
1213
1214 static uschar *
1215 read_number(int *n, uschar *s)
1216 {
1217 *n = 0;
1218 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1219 return s;
1220 }
1221
1222 static const uschar *
1223 read_cnumber(int *n, const uschar *s)
1224 {
1225 *n = 0;
1226 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1227 return s;
1228 }
1229
1230
1231
1232 /*************************************************
1233 *        Extract keyed subfield from a string    *
1234 *************************************************/
1235
1236 /* The yield is in dynamic store; NULL means that the key was not found.
1237
1238 Arguments:
1239   key       points to the name of the key
1240   s         points to the string from which to extract the subfield
1241
1242 Returns:    NULL if the subfield was not found, or
1243             a pointer to the subfield's data
1244 */
1245
1246 uschar *
1247 expand_getkeyed(const uschar * key, const uschar * s)
1248 {
1249 int length = Ustrlen(key);
1250 Uskip_whitespace(&s);
1251
1252 /* Loop to search for the key */
1253
1254 while (*s)
1255   {
1256   int dkeylength;
1257   uschar * data;
1258   const uschar * dkey = s;
1259
1260   while (*s && *s != '=' && !isspace(*s)) s++;
1261   dkeylength = s - dkey;
1262   if (Uskip_whitespace(&s) == '=') while (isspace(*++s));
1263
1264   data = string_dequote(&s);
1265   if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1266     return data;
1267
1268   Uskip_whitespace(&s);
1269   }
1270
1271 return NULL;
1272 }
1273
1274
1275
1276 static var_entry *
1277 find_var_ent(uschar * name)
1278 {
1279 int first = 0;
1280 int last = nelem(var_table);
1281
1282 while (last > first)
1283   {
1284   int middle = (first + last)/2;
1285   int c = Ustrcmp(name, var_table[middle].name);
1286
1287   if (c > 0) { first = middle + 1; continue; }
1288   if (c < 0) { last = middle; continue; }
1289   return &var_table[middle];
1290   }
1291 return NULL;
1292 }
1293
1294 /*************************************************
1295 *   Extract numbered subfield from string        *
1296 *************************************************/
1297
1298 /* Extracts a numbered field from a string that is divided by tokens - for
1299 example a line from /etc/passwd is divided by colon characters.  First field is
1300 numbered one.  Negative arguments count from the right. Zero returns the whole
1301 string. Returns NULL if there are insufficient tokens in the string
1302
1303 ***WARNING***
1304 Modifies final argument - this is a dynamically generated string, so that's OK.
1305
1306 Arguments:
1307   field       number of field to be extracted,
1308                 first field = 1, whole string = 0, last field = -1
1309   separators  characters that are used to break string into tokens
1310   s           points to the string from which to extract the subfield
1311
1312 Returns:      NULL if the field was not found,
1313               a pointer to the field's data inside s (modified to add 0)
1314 */
1315
1316 static uschar *
1317 expand_gettokened (int field, uschar *separators, uschar *s)
1318 {
1319 int sep = 1;
1320 int count;
1321 uschar *ss = s;
1322 uschar *fieldtext = NULL;
1323
1324 if (field == 0) return s;
1325
1326 /* Break the line up into fields in place; for field > 0 we stop when we have
1327 done the number of fields we want. For field < 0 we continue till the end of
1328 the string, counting the number of fields. */
1329
1330 count = (field > 0)? field : INT_MAX;
1331
1332 while (count-- > 0)
1333   {
1334   size_t len;
1335
1336   /* Previous field was the last one in the string. For a positive field
1337   number, this means there are not enough fields. For a negative field number,
1338   check that there are enough, and scan back to find the one that is wanted. */
1339
1340   if (sep == 0)
1341     {
1342     if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1343     if ((-field) == (INT_MAX - count - 1)) return s;
1344     while (field++ < 0)
1345       {
1346       ss--;
1347       while (ss[-1] != 0) ss--;
1348       }
1349     fieldtext = ss;
1350     break;
1351     }
1352
1353   /* Previous field was not last in the string; save its start and put a
1354   zero at its end. */
1355
1356   fieldtext = ss;
1357   len = Ustrcspn(ss, separators);
1358   sep = ss[len];
1359   ss[len] = 0;
1360   ss += len + 1;
1361   }
1362
1363 return fieldtext;
1364 }
1365
1366
1367 static uschar *
1368 expand_getlistele(int field, const uschar * list)
1369 {
1370 const uschar * tlist = list;
1371 int sep = 0;
1372 /* Tainted mem for the throwaway element copies */
1373 uschar * dummy = store_get(2, GET_TAINTED);
1374
1375 if (field < 0)
1376   {
1377   for (field++; string_nextinlist(&tlist, &sep, dummy, 1); ) field++;
1378   sep = 0;
1379   }
1380 if (field == 0) return NULL;
1381 while (--field > 0 && (string_nextinlist(&list, &sep, dummy, 1))) ;
1382 return string_nextinlist(&list, &sep, NULL, 0);
1383 }
1384
1385
1386 /* Certificate fields, by name.  Worry about by-OID later */
1387 /* Names are chosen to not have common prefixes */
1388
1389 #ifndef DISABLE_TLS
1390 typedef struct
1391 {
1392 uschar * name;
1393 int      namelen;
1394 uschar * (*getfn)(void * cert, uschar * mod);
1395 } certfield;
1396 static certfield certfields[] =
1397 {                       /* linear search; no special order */
1398   { US"version",         7,  &tls_cert_version },
1399   { US"serial_number",   13, &tls_cert_serial_number },
1400   { US"subject",         7,  &tls_cert_subject },
1401   { US"notbefore",       9,  &tls_cert_not_before },
1402   { US"notafter",        8,  &tls_cert_not_after },
1403   { US"issuer",          6,  &tls_cert_issuer },
1404   { US"signature",       9,  &tls_cert_signature },
1405   { US"sig_algorithm",   13, &tls_cert_signature_algorithm },
1406   { US"subj_altname",    12, &tls_cert_subject_altname },
1407   { US"ocsp_uri",        8,  &tls_cert_ocsp_uri },
1408   { US"crl_uri",         7,  &tls_cert_crl_uri },
1409 };
1410
1411 static uschar *
1412 expand_getcertele(uschar * field, uschar * certvar)
1413 {
1414 var_entry * vp;
1415
1416 if (!(vp = find_var_ent(certvar)))
1417   {
1418   expand_string_message =
1419     string_sprintf("no variable named \"%s\"", certvar);
1420   return NULL;          /* Unknown variable name */
1421   }
1422 /* NB this stops us passing certs around in variable.  Might
1423 want to do that in future */
1424 if (vp->type != vtype_cert)
1425   {
1426   expand_string_message =
1427     string_sprintf("\"%s\" is not a certificate", certvar);
1428   return NULL;          /* Unknown variable name */
1429   }
1430 if (!*(void **)vp->value)
1431   return NULL;
1432
1433 if (*field >= '0' && *field <= '9')
1434   return tls_cert_ext_by_oid(*(void **)vp->value, field, 0);
1435
1436 for (certfield * cp = certfields;
1437      cp < certfields + nelem(certfields);
1438      cp++)
1439   if (Ustrncmp(cp->name, field, cp->namelen) == 0)
1440     {
1441     uschar * modifier = *(field += cp->namelen) == ','
1442       ? ++field : NULL;
1443     return (*cp->getfn)( *(void **)vp->value, modifier );
1444     }
1445
1446 expand_string_message =
1447   string_sprintf("bad field selector \"%s\" for certextract", field);
1448 return NULL;
1449 }
1450 #endif  /*DISABLE_TLS*/
1451
1452 /*************************************************
1453 *        Extract a substring from a string       *
1454 *************************************************/
1455
1456 /* Perform the ${substr or ${length expansion operations.
1457
1458 Arguments:
1459   subject     the input string
1460   value1      the offset from the start of the input string to the start of
1461                 the output string; if negative, count from the right.
1462   value2      the length of the output string, or negative (-1) for unset
1463                 if value1 is positive, unset means "all after"
1464                 if value1 is negative, unset means "all before"
1465   len         set to the length of the returned string
1466
1467 Returns:      pointer to the output string, or NULL if there is an error
1468 */
1469
1470 static uschar *
1471 extract_substr(uschar *subject, int value1, int value2, int *len)
1472 {
1473 int sublen = Ustrlen(subject);
1474
1475 if (value1 < 0)    /* count from right */
1476   {
1477   value1 += sublen;
1478
1479   /* If the position is before the start, skip to the start, and adjust the
1480   length. If the length ends up negative, the substring is null because nothing
1481   can precede. This falls out naturally when the length is unset, meaning "all
1482   to the left". */
1483
1484   if (value1 < 0)
1485     {
1486     value2 += value1;
1487     if (value2 < 0) value2 = 0;
1488     value1 = 0;
1489     }
1490
1491   /* Otherwise an unset length => characters before value1 */
1492
1493   else if (value2 < 0)
1494     {
1495     value2 = value1;
1496     value1 = 0;
1497     }
1498   }
1499
1500 /* For a non-negative offset, if the starting position is past the end of the
1501 string, the result will be the null string. Otherwise, an unset length means
1502 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1503
1504 else
1505   {
1506   if (value1 > sublen)
1507     {
1508     value1 = sublen;
1509     value2 = 0;
1510     }
1511   else if (value2 < 0) value2 = sublen;
1512   }
1513
1514 /* Cut the length down to the maximum possible for the offset value, and get
1515 the required characters. */
1516
1517 if (value1 + value2 > sublen) value2 = sublen - value1;
1518 *len = value2;
1519 return subject + value1;
1520 }
1521
1522
1523
1524
1525 /*************************************************
1526 *            Old-style hash of a string          *
1527 *************************************************/
1528
1529 /* Perform the ${hash expansion operation.
1530
1531 Arguments:
1532   subject     the input string (an expanded substring)
1533   value1      the length of the output string; if greater or equal to the
1534                 length of the input string, the input string is returned
1535   value2      the number of hash characters to use, or 26 if negative
1536   len         set to the length of the returned string
1537
1538 Returns:      pointer to the output string, or NULL if there is an error
1539 */
1540
1541 static uschar *
1542 compute_hash(uschar *subject, int value1, int value2, int *len)
1543 {
1544 int sublen = Ustrlen(subject);
1545
1546 if (value2 < 0) value2 = 26;
1547 else if (value2 > Ustrlen(hashcodes))
1548   {
1549   expand_string_message =
1550     string_sprintf("hash count \"%d\" too big", value2);
1551   return NULL;
1552   }
1553
1554 /* Calculate the hash text. We know it is shorter than the original string, so
1555 can safely place it in subject[] (we know that subject is always itself an
1556 expanded substring). */
1557
1558 if (value1 < sublen)
1559   {
1560   int c;
1561   int i = 0;
1562   int j = value1;
1563   while ((c = (subject[j])) != 0)
1564     {
1565     int shift = (c + j++) & 7;
1566     subject[i] ^= (c << shift) | (c >> (8-shift));
1567     if (++i >= value1) i = 0;
1568     }
1569   for (i = 0; i < value1; i++)
1570     subject[i] = hashcodes[(subject[i]) % value2];
1571   }
1572 else value1 = sublen;
1573
1574 *len = value1;
1575 return subject;
1576 }
1577
1578
1579
1580
1581 /*************************************************
1582 *             Numeric hash of a string           *
1583 *************************************************/
1584
1585 /* Perform the ${nhash expansion operation. The first characters of the
1586 string are treated as most important, and get the highest prime numbers.
1587
1588 Arguments:
1589   subject     the input string
1590   value1      the maximum value of the first part of the result
1591   value2      the maximum value of the second part of the result,
1592                 or negative to produce only a one-part result
1593   len         set to the length of the returned string
1594
1595 Returns:  pointer to the output string, or NULL if there is an error.
1596 */
1597
1598 static uschar *
1599 compute_nhash (uschar *subject, int value1, int value2, int *len)
1600 {
1601 uschar *s = subject;
1602 int i = 0;
1603 unsigned long int total = 0; /* no overflow */
1604
1605 while (*s != 0)
1606   {
1607   if (i == 0) i = nelem(prime) - 1;
1608   total += prime[i--] * (unsigned int)(*s++);
1609   }
1610
1611 /* If value2 is unset, just compute one number */
1612
1613 if (value2 < 0)
1614   s = string_sprintf("%lu", total % value1);
1615
1616 /* Otherwise do a div/mod hash */
1617
1618 else
1619   {
1620   total = total % (value1 * value2);
1621   s = string_sprintf("%lu/%lu", total/value2, total % value2);
1622   }
1623
1624 *len = Ustrlen(s);
1625 return s;
1626 }
1627
1628
1629
1630
1631
1632 /*************************************************
1633 *     Find the value of a header or headers      *
1634 *************************************************/
1635
1636 /* Multiple instances of the same header get concatenated, and this function
1637 can also return a concatenation of all the header lines. When concatenating
1638 specific headers that contain lists of addresses, a comma is inserted between
1639 them. Otherwise we use a straight concatenation. Because some messages can have
1640 pathologically large number of lines, there is a limit on the length that is
1641 returned.
1642
1643 Arguments:
1644   name          the name of the header, without the leading $header_ or $h_,
1645                 or NULL if a concatenation of all headers is required
1646   newsize       return the size of memory block that was obtained; may be NULL
1647                 if exists_only is TRUE
1648   flags         FH_EXISTS_ONLY
1649                   set if called from a def: test; don't need to build a string;
1650                   just return a string that is not "" and not "0" if the header
1651                   exists
1652                 FH_WANT_RAW
1653                   set if called for $rh_ or $rheader_ items; no processing,
1654                   other than concatenating, will be done on the header. Also used
1655                   for $message_headers_raw.
1656                 FH_WANT_LIST
1657                   Double colon chars in the content, and replace newline with
1658                   colon between each element when concatenating; returning a
1659                   colon-sep list (elements might contain newlines)
1660   charset       name of charset to translate MIME words to; used only if
1661                 want_raw is false; if NULL, no translation is done (this is
1662                 used for $bh_ and $bheader_)
1663
1664 Returns:        NULL if the header does not exist, else a pointer to a new
1665                 store block
1666 */
1667
1668 static uschar *
1669 find_header(uschar * name, int * newsize, unsigned flags, const uschar * charset)
1670 {
1671 BOOL found = !name;
1672 int len = name ? Ustrlen(name) : 0;
1673 BOOL comma = FALSE;
1674 gstring * g = NULL;
1675 uschar * rawhdr;
1676
1677 for (header_line * h = header_list; h; h = h->next)
1678   if (h->type != htype_old && h->text)  /* NULL => Received: placeholder */
1679     if (!name || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1680       {
1681       uschar * s, * t;
1682       size_t inc;
1683
1684       if (flags & FH_EXISTS_ONLY)
1685         return US"1";  /* don't need actual string */
1686
1687       found = TRUE;
1688       s = h->text + len;                /* text to insert */
1689       if (!(flags & FH_WANT_RAW))       /* unless wanted raw, */
1690         Uskip_whitespace(&s);           /* remove leading white space */
1691       t = h->text + h->slen;            /* end-point */
1692
1693       /* Unless wanted raw, remove trailing whitespace, including the
1694       newline. */
1695
1696       if (flags & FH_WANT_LIST)
1697         while (t > s && t[-1] == '\n') t--;
1698       else if (!(flags & FH_WANT_RAW))
1699         {
1700         while (t > s && isspace(t[-1])) t--;
1701
1702         /* Set comma if handling a single header and it's one of those
1703         that contains an address list, except when asked for raw headers. Only
1704         need to do this once. */
1705
1706         if (name && !comma && Ustrchr("BCFRST", h->type)) comma = TRUE;
1707         }
1708
1709       /* Trim the header roughly if we're approaching limits */
1710       inc = t - s;
1711       if (gstring_length(g) + inc > header_insert_maxlen)
1712         inc = header_insert_maxlen - gstring_length(g);
1713
1714       /* For raw just copy the data; for a list, add the data as a colon-sep
1715       list-element; for comma-list add as an unchecked comma,newline sep
1716       list-elemment; for other nonraw add as an unchecked newline-sep list (we
1717       stripped trailing WS above including the newline). We ignore the potential
1718       expansion due to colon-doubling, just leaving the loop if the limit is met
1719       or exceeded. */
1720
1721       if (flags & FH_WANT_LIST)
1722         g = string_append_listele_n(g, ':', s, (unsigned)inc);
1723       else if (flags & FH_WANT_RAW)
1724         g = string_catn(g, s, (unsigned)inc);
1725       else if (inc > 0)
1726         g = string_append2_listele_n(g, comma ? US",\n" : US"\n",
1727           s, (unsigned)inc);
1728
1729       if (gstring_length(g) >= header_insert_maxlen) break;
1730       }
1731
1732 if (!found) return NULL;        /* No header found */
1733 if (!g) return US"";
1734
1735 /* That's all we do for raw header expansion. */
1736
1737 *newsize = g->size;
1738 rawhdr = string_from_gstring(g);
1739 if (flags & FH_WANT_RAW)
1740   return rawhdr;
1741
1742 /* Otherwise do RFC 2047 decoding, translating the charset if requested.
1743 The rfc2047_decode2() function can return an error with decoded data if the
1744 charset translation fails. If decoding fails, it returns NULL. */
1745
1746 else
1747   {
1748   uschar * error, * decoded = rfc2047_decode2(rawhdr,
1749     check_rfc2047_length, charset, '?', NULL, newsize, &error);
1750   if (error)
1751     DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1752       "    input was: %s\n", error, rawhdr);
1753   return decoded ? decoded : rawhdr;
1754   }
1755 }
1756
1757
1758
1759
1760 /* Append a "local" element to an Authentication-Results: header
1761 if this was a non-smtp message.
1762 */
1763
1764 static gstring *
1765 authres_local(gstring * g, const uschar * sysname)
1766 {
1767 if (!f.authentication_local)
1768   return g;
1769 g = string_append(g, 3, US";\n\tlocal=pass (non-smtp, ", sysname, US")");
1770 if (authenticated_id) g = string_append(g, 2, " u=", authenticated_id);
1771 return g;
1772 }
1773
1774
1775 /* Append an "iprev" element to an Authentication-Results: header
1776 if we have attempted to get the calling host's name.
1777 */
1778
1779 static gstring *
1780 authres_iprev(gstring * g)
1781 {
1782 if (sender_host_name)
1783   g = string_append(g, 3, US";\n\tiprev=pass (", sender_host_name, US")");
1784 else if (host_lookup_deferred)
1785   g = string_cat(g, US";\n\tiprev=temperror");
1786 else if (host_lookup_failed)
1787   g = string_cat(g, US";\n\tiprev=fail");
1788 else
1789   return g;
1790
1791 if (sender_host_address)
1792   g = string_append(g, 2, US" smtp.remote-ip=", sender_host_address);
1793 return g;
1794 }
1795
1796
1797
1798 /*************************************************
1799 *               Return list of recipients        *
1800 *************************************************/
1801 /* A recipients list is available only during system message filtering,
1802 during ACL processing after DATA, and while expanding pipe commands
1803 generated from a system filter, but not elsewhere. */
1804
1805 static uschar *
1806 fn_recipients(void)
1807 {
1808 uschar * s;
1809 gstring * g = NULL;
1810
1811 if (!f.enable_dollar_recipients) return NULL;
1812
1813 for (int i = 0; i < recipients_count; i++)
1814   {
1815   s = recipients_list[i].address;
1816   g = string_append2_listele_n(g, US", ", s, Ustrlen(s));
1817   }
1818 return string_from_gstring(g);
1819 }
1820
1821
1822 /*************************************************
1823 *               Return size of queue             *
1824 *************************************************/
1825 /* Ask the daemon for the queue size */
1826
1827 static uschar *
1828 fn_queue_size(void)
1829 {
1830 struct sockaddr_un sa_un = {.sun_family = AF_UNIX};
1831 uschar buf[16];
1832 int fd;
1833 ssize_t len;
1834 const uschar * where;
1835 uschar * sname;
1836
1837 if ((fd = socket(AF_UNIX, SOCK_DGRAM, 0)) < 0)
1838   {
1839   DEBUG(D_expand) debug_printf(" socket: %s\n", strerror(errno));
1840   return NULL;
1841   }
1842
1843 len = daemon_client_sockname(&sa_un, &sname);
1844
1845 if (bind(fd, (const struct sockaddr *)&sa_un, (socklen_t)len) < 0)
1846   { where = US"bind"; goto bad; }
1847
1848 #ifdef notdef
1849 debug_printf("local addr '%s%s'\n",
1850   *sa_un.sun_path ? "" : "@",
1851   sa_un.sun_path + (*sa_un.sun_path ? 0 : 1));
1852 #endif
1853
1854 len = daemon_notifier_sockname(&sa_un);
1855 if (connect(fd, (const struct sockaddr *)&sa_un, len) < 0)
1856   { where = US"connect"; goto bad2; }
1857
1858 buf[0] = NOTIFY_QUEUE_SIZE_REQ;
1859 if (send(fd, buf, 1, 0) < 0) { where = US"send"; goto bad; }
1860
1861 if (poll_one_fd(fd, POLLIN, 2 * 1000) != 1)
1862   {
1863   DEBUG(D_expand) debug_printf("no daemon response; using local evaluation\n");
1864   len = snprintf(CS buf, sizeof(buf), "%u", queue_count_cached());
1865   }
1866 else if ((len = recv(fd, buf, sizeof(buf), 0)) < 0)
1867   { where = US"recv"; goto bad2; }
1868
1869 close(fd);
1870 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1871 Uunlink(sname);
1872 #endif
1873 return string_copyn(buf, len);
1874
1875 bad2:
1876 #ifndef EXIM_HAVE_ABSTRACT_UNIX_SOCKETS
1877   Uunlink(sname);
1878 #endif
1879 bad:
1880   close(fd);
1881   DEBUG(D_expand) debug_printf(" %s: %s\n", where, strerror(errno));
1882   return NULL;
1883 }
1884
1885
1886 /*************************************************
1887 *               Find value of a variable         *
1888 *************************************************/
1889
1890 /* The table of variables is kept in alphabetic order, so we can search it
1891 using a binary chop. The "choplen" variable is nothing to do with the binary
1892 chop.
1893
1894 Arguments:
1895   name          the name of the variable being sought
1896   exists_only   TRUE if this is a def: test; passed on to find_header()
1897   skipping      TRUE => skip any processing evaluation; this is not the same as
1898                   exists_only because def: may test for values that are first
1899                   evaluated here
1900   newsize       pointer to an int which is initially zero; if the answer is in
1901                 a new memory buffer, *newsize is set to its size
1902
1903 Returns:        NULL if the variable does not exist, or
1904                 a pointer to the variable's contents, or
1905                 something non-NULL if exists_only is TRUE
1906 */
1907
1908 static const uschar *
1909 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1910 {
1911 var_entry * vp;
1912 uschar *s, *domain;
1913 uschar **ss;
1914 void * val;
1915
1916 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1917 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1918 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1919 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1920 (this gave backwards compatibility at the changeover). There may be built-in
1921 variables whose names start acl_ but they should never start in this way. This
1922 slightly messy specification is a consequence of the history, needless to say.
1923
1924 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1925 set, in which case give an error. */
1926
1927 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1928      !isalpha(name[5]))
1929   {
1930   tree_node * node =
1931     tree_search(name[4] == 'c' ? acl_var_c : acl_var_m, name + 4);
1932   return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1933   }
1934 else if (Ustrncmp(name, "r_", 2) == 0)
1935   {
1936   tree_node * node = tree_search(router_var, name + 2);
1937   return node ? node->data.ptr : strict_acl_vars ? NULL : US"";
1938   }
1939
1940 /* Handle $auth<n>, $regex<n> variables. */
1941
1942 if (Ustrncmp(name, "auth", 4) == 0)
1943   {
1944   uschar *endptr;
1945   int n = Ustrtoul(name + 4, &endptr, 10);
1946   if (!*endptr && n != 0 && n <= AUTH_VARS)
1947     return auth_vars[n-1] ? auth_vars[n-1] : US"";
1948   }
1949 #ifdef WITH_CONTENT_SCAN
1950 else if (Ustrncmp(name, "regex", 5) == 0)
1951   {
1952   uschar *endptr;
1953   int n = Ustrtoul(name + 5, &endptr, 10);
1954   if (!*endptr && n != 0 && n <= REGEX_VARS)
1955     return regex_vars[n-1] ? regex_vars[n-1] : US"";
1956   }
1957 #endif
1958
1959 /* For all other variables, search the table */
1960
1961 if (!(vp = find_var_ent(name)))
1962   return NULL;          /* Unknown variable name */
1963
1964 /* Found an existing variable. If in skipping state, the value isn't needed,
1965 and we want to avoid processing (such as looking up the host name). */
1966
1967 if (skipping)
1968   return US"";
1969
1970 val = vp->value;
1971 switch (vp->type)
1972   {
1973   case vtype_filter_int:
1974     if (!f.filter_running) return NULL;
1975     /* Fall through */
1976     /* VVVVVVVVVVVV */
1977   case vtype_int:
1978     sprintf(CS var_buffer, "%d", *(int *)(val)); /* Integer */
1979     return var_buffer;
1980
1981   case vtype_ino:
1982     sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(val))); /* Inode */
1983     return var_buffer;
1984
1985   case vtype_gid:
1986     sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(val))); /* gid */
1987     return var_buffer;
1988
1989   case vtype_uid:
1990     sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(val))); /* uid */
1991     return var_buffer;
1992
1993   case vtype_bool:
1994     sprintf(CS var_buffer, "%s", *(BOOL *)(val) ? "yes" : "no"); /* bool */
1995     return var_buffer;
1996
1997   case vtype_stringptr:                      /* Pointer to string */
1998     return (s = *((uschar **)(val))) ? s : US"";
1999
2000   case vtype_pid:
2001     sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
2002     return var_buffer;
2003
2004   case vtype_load_avg:
2005     sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
2006     return var_buffer;
2007
2008   case vtype_host_lookup:                    /* Lookup if not done so */
2009     if (  !sender_host_name && sender_host_address
2010        && !host_lookup_failed && host_name_lookup() == OK)
2011       host_build_sender_fullhost();
2012     return sender_host_name ? sender_host_name : US"";
2013
2014   case vtype_localpart:                      /* Get local part from address */
2015     if (!(s = *((uschar **)(val)))) return US"";
2016     if (!(domain = Ustrrchr(s, '@'))) return s;
2017     if (domain - s > sizeof(var_buffer) - 1)
2018       log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
2019           " in string expansion", sizeof(var_buffer));
2020     return string_copyn(s, domain - s);
2021
2022   case vtype_domain:                         /* Get domain from address */
2023     if (!(s = *((uschar **)(val)))) return US"";
2024     domain = Ustrrchr(s, '@');
2025     return domain ? domain + 1 : US"";
2026
2027   case vtype_msgheaders:
2028     return find_header(NULL, newsize, exists_only ? FH_EXISTS_ONLY : 0, NULL);
2029
2030   case vtype_msgheaders_raw:
2031     return find_header(NULL, newsize,
2032                 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW, NULL);
2033
2034   case vtype_msgbody:                        /* Pointer to msgbody string */
2035   case vtype_msgbody_end:                    /* Ditto, the end of the msg */
2036     ss = (uschar **)(val);
2037     if (!*ss && deliver_datafile >= 0)  /* Read body when needed */
2038       {
2039       uschar * body;
2040       off_t start_offset_o = spool_data_start_offset(message_id);
2041       off_t start_offset = start_offset_o;
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 < start_offset_o)
2054             start_offset = start_offset_o;
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]{2})=([^=]*)=(.*)$",
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, $prvscheck_result set to 1\n");
5387             }
5388           else
5389             {
5390             prvscheck_result = NULL;
5391             DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $prvscheck_result unset\n");
5392             }
5393           }
5394         else
5395           {
5396           prvscheck_result = NULL;
5397           DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $prvscheck_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         if (Ustrncmp(++s, "preexpand", 9) == 0)
5632           { late_expand = FALSE; s += 9; }
5633         else
5634           {
5635           const uschar * t = s;
5636           while (isalpha(*++t)) ;
5637           expand_string_message = string_sprintf("bad option '%.*s' for run",
5638                                                   (int)(t-s), s);
5639           goto EXPAND_FAILED;
5640           }
5641       Uskip_whitespace(&s);
5642
5643       if (*s != '{')                                    /*}*/
5644         {
5645         expand_string_message = US"missing '{' for command arg of run";
5646         goto EXPAND_FAILED_CURLY;                       /*"}*/
5647         }
5648       s++;
5649
5650       if (late_expand)          /* this is the default case */
5651         {
5652         int n;
5653         const uschar * t;
5654         /* Locate the end of the args */
5655         (void) expand_string_internal(s,
5656           ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &t, NULL, NULL);
5657         n = t - s;
5658         arg = flags & ESI_SKIPPING ? NULL : string_copyn(s, n);
5659         s += n;
5660         }
5661       else
5662         {
5663         DEBUG(D_expand)
5664           debug_printf_indent("args string for ${run} expand before split\n");
5665         if (!(arg = expand_string_internal(s,
5666                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
5667           goto EXPAND_FAILED;
5668         Uskip_whitespace(&s);
5669         }
5670                                                         /*{*/
5671       if (*s++ != '}')
5672         {                                               /*{*/
5673         expand_string_message = US"missing '}' closing command arg of run";
5674         goto EXPAND_FAILED_CURLY;
5675         }
5676
5677       if (flags & ESI_SKIPPING)   /* Just pretend it worked when we're skipping */
5678         {
5679         runrc = 0;
5680         lookup_value = NULL;
5681         }
5682       else
5683         {
5684         int fd_in, fd_out;
5685         pid_t pid;
5686
5687         if (!transport_set_up_command(&argv,    /* anchor for arg list */
5688             arg,                                /* raw command */
5689             late_expand,                /* expand args if not already done */
5690             0,                          /* not relevant when... */
5691             NULL,                       /* no transporting address */
5692             late_expand,                /* allow tainted args, when expand-after-split */
5693             US"${run} expansion",       /* for error messages */
5694             &expand_string_message))    /* where to put error message */
5695           goto EXPAND_FAILED;
5696
5697         /* Create the child process, making it a group leader. */
5698
5699         if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE,
5700                               US"expand-run")) < 0)
5701           {
5702           expand_string_message =
5703             string_sprintf("couldn't create child process: %s", strerror(errno));
5704           goto EXPAND_FAILED;
5705           }
5706
5707         /* Nothing is written to the standard input. */
5708
5709         (void)close(fd_in);
5710
5711         /* Read the pipe to get the command's output into $value (which is kept
5712         in lookup_value). Read during execution, so that if the output exceeds
5713         the OS pipe buffer limit, we don't block forever. Remember to not release
5714         memory just allocated for $value. */
5715
5716         resetok = FALSE;
5717         f = fdopen(fd_out, "rb");
5718         sigalrm_seen = FALSE;
5719         ALARM(60);
5720         lookup_value = string_from_gstring(cat_file(f, NULL, NULL));
5721         ALARM_CLR(0);
5722         (void)fclose(f);
5723
5724         /* Wait for the process to finish, applying the timeout, and inspect its
5725         return code for serious disasters. Simple non-zero returns are passed on.
5726         */
5727
5728         if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)
5729           {
5730           if (sigalrm_seen || runrc == -256)
5731             {
5732             expand_string_message = US"command timed out";
5733             killpg(pid, SIGKILL);       /* Kill the whole process group */
5734             }
5735
5736           else if (runrc == -257)
5737             expand_string_message = string_sprintf("wait() failed: %s",
5738               strerror(errno));
5739
5740           else
5741             expand_string_message = string_sprintf("command killed by signal %d",
5742               -runrc);
5743
5744           goto EXPAND_FAILED;
5745           }
5746         }
5747
5748       /* Process the yes/no strings; $value may be useful in both cases */
5749
5750       switch(process_yesno(
5751                flags,                   /* were previously skipping */
5752                runrc == 0,              /* success/failure indicator */
5753                lookup_value,            /* value to reset for string2 */
5754                &s,                      /* input pointer */
5755                &yield,                  /* output pointer */
5756                US"run",                 /* condition type */
5757                &resetok))
5758         {
5759         case 1: goto EXPAND_FAILED;          /* when all is well, the */
5760         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
5761         }
5762
5763       if (flags & ESI_SKIPPING) continue;
5764       break;
5765       }
5766
5767     /* Handle character translation for "tr" */
5768
5769     case EITEM_TR:
5770       {
5771       int oldptr = gstring_length(yield);
5772       int o2m;
5773       uschar * sub[3];
5774
5775       switch(read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, NULL))
5776         {
5777         case -1: continue;      /* skipping */
5778         case 1: goto EXPAND_FAILED_CURLY;
5779         case 2:
5780         case 3: goto EXPAND_FAILED;
5781         }
5782
5783       yield = string_cat(yield, sub[0]);
5784       o2m = Ustrlen(sub[2]) - 1;
5785
5786       if (o2m >= 0) for (; oldptr < yield->ptr; oldptr++)
5787         {
5788         uschar * m = Ustrrchr(sub[1], yield->s[oldptr]);
5789         if (m)
5790           {
5791           int o = m - sub[1];
5792           yield->s[oldptr] = sub[2][(o < o2m)? o : o2m];
5793           }
5794         }
5795
5796       break;
5797       }
5798
5799     /* Handle "hash", "length", "nhash", and "substr" when they are given with
5800     expanded arguments. */
5801
5802     case EITEM_HASH:
5803     case EITEM_LENGTH:
5804     case EITEM_NHASH:
5805     case EITEM_SUBSTR:
5806       {
5807       int len;
5808       uschar *ret;
5809       int val[2] = { 0, -1 };
5810       uschar * sub[3];
5811
5812       /* "length" takes only 2 arguments whereas the others take 2 or 3.
5813       Ensure that sub[2] is set in the ${length } case. */
5814
5815       sub[2] = NULL;
5816       switch(read_subs(sub, item_type == EITEM_LENGTH ? 2:3, 2, &s, flags,
5817              TRUE, name, &resetok, NULL))
5818         {
5819         case -1: continue;      /* skipping */
5820         case 1: goto EXPAND_FAILED_CURLY;
5821         case 2:
5822         case 3: goto EXPAND_FAILED;
5823         }
5824
5825       /* Juggle the arguments if there are only two of them: always move the
5826       string to the last position and make ${length{n}{str}} equivalent to
5827       ${substr{0}{n}{str}}. See the defaults for val[] above. */
5828
5829       if (!sub[2])
5830         {
5831         sub[2] = sub[1];
5832         sub[1] = NULL;
5833         if (item_type == EITEM_LENGTH)
5834           {
5835           sub[1] = sub[0];
5836           sub[0] = NULL;
5837           }
5838         }
5839
5840       for (int i = 0; i < 2; i++) if (sub[i])
5841         {
5842         val[i] = (int)Ustrtol(sub[i], &ret, 10);
5843         if (*ret != 0 || (i != 0 && val[i] < 0))
5844           {
5845           expand_string_message = string_sprintf("\"%s\" is not a%s number "
5846             "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5847           goto EXPAND_FAILED;
5848           }
5849         }
5850
5851       ret =
5852         item_type == EITEM_HASH
5853         ?  compute_hash(sub[2], val[0], val[1], &len)
5854         : item_type == EITEM_NHASH
5855         ? compute_nhash(sub[2], val[0], val[1], &len)
5856         : extract_substr(sub[2], val[0], val[1], &len);
5857       if (!ret)
5858         goto EXPAND_FAILED;
5859       yield = string_catn(yield, ret, len);
5860       break;
5861       }
5862
5863     /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5864     This code originally contributed by Steve Haslam. It currently supports
5865     the use of MD5 and SHA-1 hashes.
5866
5867     We need some workspace that is large enough to handle all the supported
5868     hash types. Use macros to set the sizes rather than be too elaborate. */
5869
5870     #define MAX_HASHLEN      20
5871     #define MAX_HASHBLOCKLEN 64
5872
5873     case EITEM_HMAC:
5874       {
5875       uschar * sub[3];
5876       md5 md5_base;
5877       hctx sha1_ctx;
5878       void * use_base;
5879       int type;
5880       int hashlen;      /* Number of octets for the hash algorithm's output */
5881       int hashblocklen; /* Number of octets the hash algorithm processes */
5882       uschar * keyptr, * p;
5883       unsigned int keylen;
5884
5885       uschar keyhash[MAX_HASHLEN];
5886       uschar innerhash[MAX_HASHLEN];
5887       uschar finalhash[MAX_HASHLEN];
5888       uschar finalhash_hex[2*MAX_HASHLEN];
5889       uschar innerkey[MAX_HASHBLOCKLEN];
5890       uschar outerkey[MAX_HASHBLOCKLEN];
5891
5892       switch (read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, NULL))
5893         {
5894         case -1: continue;      /* skipping */
5895         case 1: goto EXPAND_FAILED_CURLY;
5896         case 2:
5897         case 3: goto EXPAND_FAILED;
5898         }
5899
5900       if (Ustrcmp(sub[0], "md5") == 0)
5901         {
5902         type = HMAC_MD5;
5903         use_base = &md5_base;
5904         hashlen = 16;
5905         hashblocklen = 64;
5906         }
5907       else if (Ustrcmp(sub[0], "sha1") == 0)
5908         {
5909         type = HMAC_SHA1;
5910         use_base = &sha1_ctx;
5911         hashlen = 20;
5912         hashblocklen = 64;
5913         }
5914       else
5915         {
5916         expand_string_message =
5917           string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5918         goto EXPAND_FAILED;
5919         }
5920
5921       keyptr = sub[1];
5922       keylen = Ustrlen(keyptr);
5923
5924       /* If the key is longer than the hash block length, then hash the key
5925       first */
5926
5927       if (keylen > hashblocklen)
5928         {
5929         chash_start(type, use_base);
5930         chash_end(type, use_base, keyptr, keylen, keyhash);
5931         keyptr = keyhash;
5932         keylen = hashlen;
5933         }
5934
5935       /* Now make the inner and outer key values */
5936
5937       memset(innerkey, 0x36, hashblocklen);
5938       memset(outerkey, 0x5c, hashblocklen);
5939
5940       for (int i = 0; i < keylen; i++)
5941         {
5942         innerkey[i] ^= keyptr[i];
5943         outerkey[i] ^= keyptr[i];
5944         }
5945
5946       /* Now do the hashes */
5947
5948       chash_start(type, use_base);
5949       chash_mid(type, use_base, innerkey);
5950       chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5951
5952       chash_start(type, use_base);
5953       chash_mid(type, use_base, outerkey);
5954       chash_end(type, use_base, innerhash, hashlen, finalhash);
5955
5956       /* Encode the final hash as a hex string */
5957
5958       p = finalhash_hex;
5959       for (int i = 0; i < hashlen; i++)
5960         {
5961         *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5962         *p++ = hex_digits[finalhash[i] & 0x0f];
5963         }
5964
5965       DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
5966         sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);
5967
5968       yield = string_catn(yield, finalhash_hex, hashlen*2);
5969       break;
5970       }
5971
5972     /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5973     We have to save the numerical variables and restore them afterwards. */
5974
5975     case EITEM_SG:
5976       {
5977       const pcre2_code * re;
5978       int moffset, moffsetextra, slen;
5979       pcre2_match_data * md;
5980       int emptyopt;
5981       uschar * subject, * sub[3];
5982       int save_expand_nmax =
5983         save_expand_strings(save_expand_nstring, save_expand_nlength);
5984       unsigned sub_textonly = 0;
5985
5986       switch(read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, &sub_textonly))
5987         {
5988         case -1: continue;      /* skipping */
5989         case 1: goto EXPAND_FAILED_CURLY;
5990         case 2:
5991         case 3: goto EXPAND_FAILED;
5992         }
5993
5994       /* Compile the regular expression */
5995
5996       re = regex_compile(sub[1],
5997               sub_textonly & BIT(1) ? MCS_CACHEABLE : MCS_NOFLAGS,
5998               &expand_string_message, pcre_gen_cmp_ctx);
5999       if (!re)
6000         goto EXPAND_FAILED;
6001
6002       md = pcre2_match_data_create(EXPAND_MAXN + 1, pcre_gen_ctx);
6003
6004       /* Now run a loop to do the substitutions as often as necessary. It ends
6005       when there are no more matches. Take care over matches of the null string;
6006       do the same thing as Perl does. */
6007
6008       subject = sub[0];
6009       slen = Ustrlen(sub[0]);
6010       moffset = moffsetextra = 0;
6011       emptyopt = 0;
6012
6013       for (;;)
6014         {
6015         PCRE2_SIZE * ovec = pcre2_get_ovector_pointer(md);
6016         int n = pcre2_match(re, (PCRE2_SPTR)subject, slen, moffset + moffsetextra,
6017           PCRE_EOPT | emptyopt, md, pcre_gen_mtc_ctx);
6018         uschar * insert;
6019
6020         /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
6021         is not necessarily the end. We want to repeat the match from one
6022         character further along, but leaving the basic offset the same (for
6023         copying below). We can't be at the end of the string - that was checked
6024         before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
6025         finished; copy the remaining string and end the loop. */
6026
6027         if (n < 0)
6028           {
6029           if (emptyopt != 0)
6030             {
6031             moffsetextra = 1;
6032             emptyopt = 0;
6033             continue;
6034             }
6035           yield = string_catn(yield, subject+moffset, slen-moffset);
6036           break;
6037           }
6038
6039         /* Match - set up for expanding the replacement. */
6040         DEBUG(D_expand) debug_printf_indent("%s: match\n", name);
6041
6042         if (n == 0) n = EXPAND_MAXN + 1;
6043         expand_nmax = 0;
6044         for (int nn = 0; nn < n*2; nn += 2)
6045           {
6046           expand_nstring[expand_nmax] = subject + ovec[nn];
6047           expand_nlength[expand_nmax++] = ovec[nn+1] - ovec[nn];
6048           }
6049         expand_nmax--;
6050
6051         /* Copy the characters before the match, plus the expanded insertion. */
6052
6053         yield = string_catn(yield, subject + moffset, ovec[0] - moffset);
6054
6055         if (!(insert = expand_string(sub[2])))
6056           goto EXPAND_FAILED;
6057         yield = string_cat(yield, insert);
6058
6059         moffset = ovec[1];
6060         moffsetextra = 0;
6061         emptyopt = 0;
6062
6063         /* If we have matched an empty string, first check to see if we are at
6064         the end of the subject. If so, the loop is over. Otherwise, mimic
6065         what Perl's /g options does. This turns out to be rather cunning. First
6066         we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
6067         string at the same point. If this fails (picked up above) we advance to
6068         the next character. */
6069
6070         if (ovec[0] == ovec[1])
6071           {
6072           if (ovec[0] == slen) break;
6073           emptyopt = PCRE2_NOTEMPTY | PCRE2_ANCHORED;
6074           }
6075         }
6076
6077       /* All done - restore numerical variables. */
6078
6079       /* pcre2_match_data_free(md);     gen ctx needs no free */
6080       restore_expand_strings(save_expand_nmax, save_expand_nstring,
6081         save_expand_nlength);
6082       break;
6083       }
6084
6085     /* Handle keyed and numbered substring extraction. If the first argument
6086     consists entirely of digits, then a numerical extraction is assumed. */
6087
6088     case EITEM_EXTRACT:
6089       {
6090       int field_number = 1;
6091       BOOL field_number_set = FALSE;
6092       uschar * save_lookup_value = lookup_value, * sub[3];
6093       int save_expand_nmax =
6094         save_expand_strings(save_expand_nstring, save_expand_nlength);
6095
6096       /* On reflection the original behaviour of extract-json for a string
6097       result, leaving it quoted, was a mistake.  But it was already published,
6098       hence the addition of jsons.  In a future major version, make json
6099       work like josons, and withdraw jsons. */
6100
6101       enum {extract_basic, extract_json, extract_jsons} fmt = extract_basic;
6102
6103       /* Check for a format-variant specifier */
6104
6105       if (Uskip_whitespace(&s) != '{')                                  /*}*/
6106         if (Ustrncmp(s, "json", 4) == 0)
6107           if (*(s += 4) == 's')
6108             {fmt = extract_jsons; s++;}
6109           else
6110             fmt = extract_json;
6111
6112       /* While skipping we cannot rely on the data for expansions being
6113       available (eg. $item) hence cannot decide on numeric vs. keyed.
6114       Read a maximum of 5 arguments (including the yes/no) */
6115
6116       if (flags & ESI_SKIPPING)
6117         {
6118         for (int j = 5; j > 0 && *s == '{'; j--)                        /*'}'*/
6119           {
6120           if (!expand_string_internal(s+1,
6121                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL))
6122             goto EXPAND_FAILED;                                 /*'{'*/
6123           if (*s++ != '}')
6124             {
6125             expand_string_message = US"missing '{' for arg of extract";
6126             goto EXPAND_FAILED_CURLY;
6127             }
6128           Uskip_whitespace(&s);
6129           }
6130         if (  Ustrncmp(s, "fail", 4) == 0                               /*'{'*/
6131            && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
6132            )
6133           {
6134           s += 4;
6135           Uskip_whitespace(&s);
6136           }                                                             /*'{'*/
6137         if (*s != '}')
6138           {
6139           expand_string_message = US"missing '}' closing extract";
6140           goto EXPAND_FAILED_CURLY;
6141           }
6142         }
6143
6144       else for (int i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
6145         {
6146         if (Uskip_whitespace(&s) == '{')                                /*'}'*/
6147           {
6148           if (!(sub[i] = expand_string_internal(s+1,
6149                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
6150             goto EXPAND_FAILED;                                         /*'{'*/
6151           if (*s++ != '}')
6152             {
6153             expand_string_message = string_sprintf(
6154               "missing '}' closing arg %d of extract", i+1);
6155             goto EXPAND_FAILED_CURLY;
6156             }
6157
6158           /* After removal of leading and trailing white space, the first
6159           argument must not be empty; if it consists entirely of digits
6160           (optionally preceded by a minus sign), this is a numerical
6161           extraction, and we expect 3 arguments (normal) or 2 (json). */
6162
6163           if (i == 0)
6164             {
6165             int len;
6166             int x = 0;
6167             uschar * p = sub[0];
6168
6169             Uskip_whitespace(&p);
6170             sub[0] = p;
6171
6172             len = Ustrlen(p);
6173             while (len > 0 && isspace(p[len-1])) len--;
6174             p[len] = 0;
6175
6176             if (!*p)
6177               {
6178               expand_string_message = US"first argument of \"extract\" must "
6179                 "not be empty";
6180               goto EXPAND_FAILED;
6181               }
6182
6183             if (*p == '-')
6184               {
6185               field_number = -1;
6186               p++;
6187               }
6188             while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
6189             if (!*p)
6190               {
6191               field_number *= x;
6192               if (fmt == extract_basic) j = 3;               /* Need 3 args */
6193               field_number_set = TRUE;
6194               }
6195             }
6196           }
6197         else
6198           {
6199           expand_string_message = string_sprintf(
6200             "missing '{' for arg %d of extract", i+1);
6201           goto EXPAND_FAILED_CURLY;
6202           }
6203         }
6204
6205       /* Extract either the numbered or the keyed substring into $value. If
6206       skipping, just pretend the extraction failed. */
6207
6208       if (flags & ESI_SKIPPING)
6209         lookup_value = NULL;
6210       else switch (fmt)
6211         {
6212         case extract_basic:
6213           lookup_value = field_number_set
6214             ? expand_gettokened(field_number, sub[1], sub[2])
6215             : expand_getkeyed(sub[0], sub[1]);
6216           break;
6217
6218         case extract_json:
6219         case extract_jsons:
6220           {
6221           uschar * s, * item;
6222           const uschar * list;
6223
6224           /* Array: Bracket-enclosed and comma-separated.
6225           Object: Brace-enclosed, comma-sep list of name:value pairs */
6226
6227           if (!(s = dewrap(sub[1], field_number_set ? US"[]" : US"{}")))
6228             {
6229             expand_string_message =
6230               string_sprintf("%s wrapping %s for extract json",
6231                 expand_string_message,
6232                 field_number_set ? "array" : "object");
6233             goto EXPAND_FAILED_CURLY;
6234             }
6235
6236           list = s;
6237           if (field_number_set)
6238             {
6239             if (field_number <= 0)
6240               {
6241               expand_string_message = US"first argument of \"extract\" must "
6242                 "be greater than zero";
6243               goto EXPAND_FAILED;
6244               }
6245             while (field_number > 0 && (item = json_nextinlist(&list)))
6246               field_number--;
6247             if ((lookup_value = s = item))
6248               {
6249               while (*s) s++;
6250               while (--s >= lookup_value && isspace(*s)) *s = '\0';
6251               }
6252             }
6253           else
6254             {
6255             lookup_value = NULL;
6256             while ((item = json_nextinlist(&list)))
6257               {
6258               /* Item is:  string name-sep value.  string is quoted.
6259               Dequote the string and compare with the search key. */
6260
6261               if (!(item = dewrap(item, US"\"\"")))
6262                 {
6263                 expand_string_message =
6264                   string_sprintf("%s wrapping string key for extract json",
6265                     expand_string_message);
6266                 goto EXPAND_FAILED_CURLY;
6267                 }
6268               if (Ustrcmp(item, sub[0]) == 0)   /*XXX should be a UTF8-compare */
6269                 {
6270                 s = item + Ustrlen(item) + 1;
6271                 if (Uskip_whitespace(&s) != ':')
6272                   {
6273                   expand_string_message =
6274                     US"missing object value-separator for extract json";
6275                   goto EXPAND_FAILED_CURLY;
6276                   }
6277                 s++;
6278                 Uskip_whitespace(&s);
6279                 lookup_value = s;
6280                 break;
6281                 }
6282               }
6283             }
6284           }
6285
6286           if (  fmt == extract_jsons
6287              && lookup_value
6288              && !(lookup_value = dewrap(lookup_value, US"\"\"")))
6289             {
6290             expand_string_message =
6291               string_sprintf("%s wrapping string result for extract jsons",
6292                 expand_string_message);
6293             goto EXPAND_FAILED_CURLY;
6294             }
6295           break;        /* json/s */
6296         }
6297
6298       /* If no string follows, $value gets substituted; otherwise there can
6299       be yes/no strings, as for lookup or if. */
6300
6301       switch(process_yesno(
6302                flags,                   /* were previously skipping */
6303                lookup_value != NULL,    /* success/failure indicator */
6304                save_lookup_value,       /* value to reset for string2 */
6305                &s,                      /* input pointer */
6306                &yield,                  /* output pointer */
6307                US"extract",             /* condition type */
6308                &resetok))
6309         {
6310         case 1: goto EXPAND_FAILED;          /* when all is well, the */
6311         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
6312         }
6313
6314       /* All done - restore numerical variables. */
6315
6316       restore_expand_strings(save_expand_nmax, save_expand_nstring,
6317         save_expand_nlength);
6318
6319       if (flags & ESI_SKIPPING) continue;
6320       break;
6321       }
6322
6323     /* return the Nth item from a list */
6324
6325     case EITEM_LISTEXTRACT:
6326       {
6327       int field_number = 1;
6328       uschar * save_lookup_value = lookup_value, * sub[2];
6329       int save_expand_nmax =
6330         save_expand_strings(save_expand_nstring, save_expand_nlength);
6331
6332       /* Read the field & list arguments */
6333       /*XXX Could we use read_subs here (and get better efficiency for skipping)? */
6334
6335       for (int i = 0; i < 2; i++)
6336         {
6337         if (Uskip_whitespace(&s) != '{')                                /*}*/
6338           {
6339           expand_string_message = string_sprintf(
6340             "missing '{' for arg %d of listextract", i+1);              /*}*/
6341           goto EXPAND_FAILED_CURLY;
6342           }
6343
6344         sub[i] = expand_string_internal(s+1,
6345               ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6346         if (!sub[i])     goto EXPAND_FAILED;                            /*{{*/
6347         if (*s++ != '}')
6348           {
6349           expand_string_message = string_sprintf(
6350             "missing '}' closing arg %d of listextract", i+1);
6351           goto EXPAND_FAILED_CURLY;
6352           }
6353
6354         /* After removal of leading and trailing white space, the first
6355         argument must be numeric and nonempty. */
6356
6357         if (i == 0)
6358           {
6359           int len;
6360           int x = 0;
6361           uschar *p = sub[0];
6362
6363           Uskip_whitespace(&p);
6364           sub[0] = p;
6365
6366           len = Ustrlen(p);
6367           while (len > 0 && isspace(p[len-1])) len--;
6368           p[len] = 0;
6369
6370           if (!*p && !(flags & ESI_SKIPPING))
6371             {
6372             expand_string_message = US"first argument of \"listextract\" must "
6373               "not be empty";
6374             goto EXPAND_FAILED;
6375             }
6376
6377           if (*p == '-')
6378             {
6379             field_number = -1;
6380             p++;
6381             }
6382           while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
6383           if (*p)
6384             {
6385             expand_string_message = US"first argument of \"listextract\" must "
6386               "be numeric";
6387             goto EXPAND_FAILED;
6388             }
6389           field_number *= x;
6390           }
6391         }
6392
6393       /* Extract the numbered element into $value. If
6394       skipping, just pretend the extraction failed. */
6395
6396       lookup_value = flags & ESI_SKIPPING ? NULL : expand_getlistele(field_number, sub[1]);
6397
6398       /* If no string follows, $value gets substituted; otherwise there can
6399       be yes/no strings, as for lookup or if. */
6400
6401       switch(process_yesno(
6402                flags,                           /* were previously skipping */
6403                lookup_value != NULL,            /* success/failure indicator */
6404                save_lookup_value,               /* value to reset for string2 */
6405                &s,                              /* input pointer */
6406                &yield,                          /* output pointer */
6407                US"listextract",                 /* condition type */
6408                &resetok))
6409         {
6410         case 1: goto EXPAND_FAILED;          /* when all is well, the */
6411         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
6412         }
6413
6414       /* All done - restore numerical variables. */
6415
6416       restore_expand_strings(save_expand_nmax, save_expand_nstring,
6417         save_expand_nlength);
6418
6419       if (flags & ESI_SKIPPING) continue;
6420       break;
6421       }
6422
6423     case EITEM_LISTQUOTE:
6424       {
6425       uschar * sub[2];
6426       switch(read_subs(sub, 2, 2, &s, flags, TRUE, name, &resetok, NULL))
6427         {
6428         case -1: continue;      /* skipping */
6429         case 1: goto EXPAND_FAILED_CURLY;
6430         case 2:
6431         case 3: goto EXPAND_FAILED;
6432         }
6433       if (*sub[1]) for (uschar sep = *sub[0], c; c = *sub[1]; sub[1]++)
6434         {
6435         if (c == sep) yield = string_catn(yield, sub[1], 1);
6436         yield = string_catn(yield, sub[1], 1);
6437         }
6438       else yield = string_catn(yield, US" ", 1);
6439       break;
6440       }
6441
6442 #ifndef DISABLE_TLS
6443     case EITEM_CERTEXTRACT:
6444       {
6445       uschar * save_lookup_value = lookup_value, * sub[2];
6446       int save_expand_nmax =
6447         save_expand_strings(save_expand_nstring, save_expand_nlength);
6448
6449       /* Read the field argument */
6450       if (Uskip_whitespace(&s) != '{')                                  /*}*/
6451         {
6452         expand_string_message = US"missing '{' for field arg of certextract";
6453         goto EXPAND_FAILED_CURLY;                                       /*}*/
6454         }
6455       sub[0] = expand_string_internal(s+1,
6456                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6457       if (!sub[0])     goto EXPAND_FAILED;                              /*{{*/
6458       if (*s++ != '}')
6459         {
6460         expand_string_message = US"missing '}' closing field arg of certextract";
6461         goto EXPAND_FAILED_CURLY;
6462         }
6463       /* strip spaces fore & aft */
6464       {
6465       int len;
6466       uschar *p = sub[0];
6467
6468       Uskip_whitespace(&p);
6469       sub[0] = p;
6470
6471       len = Ustrlen(p);
6472       while (len > 0 && isspace(p[len-1])) len--;
6473       p[len] = 0;
6474       }
6475
6476       /* inspect the cert argument */
6477       if (Uskip_whitespace(&s) != '{')                                  /*}*/
6478         {
6479         expand_string_message = US"missing '{' for cert variable arg of certextract";
6480         goto EXPAND_FAILED_CURLY;                                       /*}*/
6481         }
6482       if (*++s != '$')
6483         {
6484         expand_string_message = US"second argument of \"certextract\" must "
6485           "be a certificate variable";
6486         goto EXPAND_FAILED;
6487         }
6488       sub[1] = expand_string_internal(s+1,
6489                 ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s, &resetok, NULL);
6490       if (!sub[1])     goto EXPAND_FAILED;                              /*{{*/
6491       if (*s++ != '}')
6492         {
6493         expand_string_message = US"missing '}' closing cert variable arg of certextract";
6494         goto EXPAND_FAILED_CURLY;
6495         }
6496
6497       if (flags & ESI_SKIPPING)
6498         lookup_value = NULL;
6499       else
6500         {
6501         lookup_value = expand_getcertele(sub[0], sub[1]);
6502         if (*expand_string_message) goto EXPAND_FAILED;
6503         }
6504       switch(process_yesno(
6505                flags,                           /* were previously skipping */
6506                lookup_value != NULL,            /* success/failure indicator */
6507                save_lookup_value,               /* value to reset for string2 */
6508                &s,                              /* input pointer */
6509                &yield,                          /* output pointer */
6510                US"certextract",                 /* condition type */
6511                &resetok))
6512         {
6513         case 1: goto EXPAND_FAILED;          /* when all is well, the */
6514         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
6515         }
6516
6517       restore_expand_strings(save_expand_nmax, save_expand_nstring,
6518         save_expand_nlength);
6519       if (flags & ESI_SKIPPING) continue;
6520       break;
6521       }
6522 #endif  /*DISABLE_TLS*/
6523
6524     /* Handle list operations */
6525
6526     case EITEM_FILTER:
6527     case EITEM_MAP:
6528     case EITEM_REDUCE:
6529       {
6530       int sep = 0, save_ptr = gstring_length(yield);
6531       uschar outsep[2] = { '\0', '\0' };
6532       const uschar *list, *expr, *temp;
6533       uschar * save_iterate_item = iterate_item;
6534       uschar * save_lookup_value = lookup_value;
6535
6536       Uskip_whitespace(&s);
6537       if (*s++ != '{')                                                  /*}*/
6538         {
6539         expand_string_message =
6540           string_sprintf("missing '{' for first arg of %s", name);
6541         goto EXPAND_FAILED_CURLY;                                       /*}*/
6542         }
6543
6544       if (!(list = expand_string_internal(s,
6545               ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
6546         goto EXPAND_FAILED;                                             /*{{*/
6547       if (*s++ != '}')
6548         {
6549         expand_string_message =
6550           string_sprintf("missing '}' closing first arg of %s", name);
6551         goto EXPAND_FAILED_CURLY;
6552         }
6553
6554       if (item_type == EITEM_REDUCE)
6555         {
6556         uschar * t;
6557         Uskip_whitespace(&s);
6558         if (*s++ != '{')                                                /*}*/
6559           {
6560           expand_string_message = US"missing '{' for second arg of reduce";
6561           goto EXPAND_FAILED_CURLY;                                     /*}*/
6562           }
6563         t = expand_string_internal(s,
6564               ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6565         if (!t) goto EXPAND_FAILED;
6566         lookup_value = t;                                               /*{{*/
6567         if (*s++ != '}')
6568           {
6569           expand_string_message = US"missing '}' closing second arg of reduce";
6570           goto EXPAND_FAILED_CURLY;
6571           }
6572         }
6573
6574       Uskip_whitespace(&s);
6575       if (*s++ != '{')                                                  /*}*/
6576         {
6577         expand_string_message =
6578           string_sprintf("missing '{' for last arg of %s", name);       /*}*/
6579         goto EXPAND_FAILED_CURLY;
6580         }
6581
6582       expr = s;
6583
6584       /* For EITEM_FILTER, call eval_condition once, with result discarded (as
6585       if scanning a "false" part). This allows us to find the end of the
6586       condition, because if the list is empty, we won't actually evaluate the
6587       condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
6588       the normal internal expansion function. */
6589
6590       if (item_type != EITEM_FILTER)
6591         temp = expand_string_internal(s,
6592           ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL);
6593       else
6594         if ((temp = eval_condition(expr, &resetok, NULL))) s = temp;
6595
6596       if (!temp)
6597         {
6598         expand_string_message = string_sprintf("%s inside \"%s\" item",
6599           expand_string_message, name);
6600         goto EXPAND_FAILED;
6601         }
6602
6603       Uskip_whitespace(&s);                                             /*{{{*/
6604       if (*s++ != '}')
6605         {
6606         expand_string_message = string_sprintf("missing } at end of condition "
6607           "or expression inside \"%s\"; could be an unquoted } in the content",
6608           name);
6609         goto EXPAND_FAILED;
6610         }
6611
6612       Uskip_whitespace(&s);                                             /*{{*/
6613       if (*s++ != '}')
6614         {
6615         expand_string_message = string_sprintf("missing } at end of \"%s\"",
6616           name);
6617         goto EXPAND_FAILED;
6618         }
6619
6620       /* If we are skipping, we can now just move on to the next item. When
6621       processing for real, we perform the iteration. */
6622
6623       if (flags & ESI_SKIPPING) continue;
6624       while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
6625         {
6626         *outsep = (uschar)sep;      /* Separator as a string */
6627
6628         DEBUG(D_expand) debug_printf_indent("%s: $item = '%s'  $value = '%s'\n",
6629                           name, iterate_item, lookup_value);
6630
6631         if (item_type == EITEM_FILTER)
6632           {
6633           BOOL condresult;
6634           /* the condition could modify $value, as a side-effect */
6635           uschar * save_value = lookup_value;
6636
6637           if (!eval_condition(expr, &resetok, &condresult))
6638             {
6639             iterate_item = save_iterate_item;
6640             lookup_value = save_lookup_value;
6641             expand_string_message = string_sprintf("%s inside \"%s\" condition",
6642               expand_string_message, name);
6643             goto EXPAND_FAILED;
6644             }
6645           lookup_value = save_value;
6646           DEBUG(D_expand) debug_printf_indent("%s: condition is %s\n", name,
6647             condresult? "true":"false");
6648           if (condresult)
6649             temp = iterate_item;    /* TRUE => include this item */
6650           else
6651             continue;               /* FALSE => skip this item */
6652           }
6653
6654         else                    /* EITEM_MAP and EITEM_REDUCE */
6655           {
6656           /* the expansion could modify $value, as a side-effect */
6657           uschar * t = expand_string_internal(expr,
6658             ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, NULL, &resetok, NULL);
6659           if (!(temp = t))
6660             {
6661             iterate_item = save_iterate_item;
6662             expand_string_message = string_sprintf("%s inside \"%s\" item",
6663               expand_string_message, name);
6664             goto EXPAND_FAILED;
6665             }
6666           if (item_type == EITEM_REDUCE)
6667             {
6668             lookup_value = t;         /* Update the value of $value */
6669             continue;                 /* and continue the iteration */
6670             }
6671           }
6672
6673         /* We reach here for FILTER if the condition is true, always for MAP,
6674         and never for REDUCE. The value in "temp" is to be added to the output
6675         list that is being created, ensuring that any occurrences of the
6676         separator character are doubled. Unless we are dealing with the first
6677         item of the output list, add in a space if the new item begins with the
6678         separator character, or is an empty string. */
6679
6680 /*XXX is there not a standard support function for this, appending to a list? */
6681 /* yes, string_append_listele(), but it depends on lack of text before the list */
6682
6683         if (  yield && yield->ptr != save_ptr
6684            && (temp[0] == *outsep || temp[0] == 0))
6685           yield = string_catn(yield, US" ", 1);
6686
6687         /* Add the string in "temp" to the output list that we are building,
6688         This is done in chunks by searching for the separator character. */
6689
6690         for (;;)
6691           {
6692           size_t seglen = Ustrcspn(temp, outsep);
6693
6694           yield = string_catn(yield, temp, seglen + 1);
6695
6696           /* If we got to the end of the string we output one character
6697           too many; backup and end the loop. Otherwise arrange to double the
6698           separator. */
6699
6700           if (!temp[seglen]) { yield->ptr--; break; }
6701           yield = string_catn(yield, outsep, 1);
6702           temp += seglen + 1;
6703           }
6704
6705         /* Output a separator after the string: we will remove the redundant
6706         final one at the end. */
6707
6708         yield = string_catn(yield, outsep, 1);
6709         }   /* End of iteration over the list loop */
6710
6711       /* REDUCE has generated no output above: output the final value of
6712       $value. */
6713
6714       if (item_type == EITEM_REDUCE)
6715         {
6716         yield = string_cat(yield, lookup_value);
6717         lookup_value = save_lookup_value;  /* Restore $value */
6718         }
6719
6720       /* FILTER and MAP generate lists: if they have generated anything, remove
6721       the redundant final separator. Even though an empty item at the end of a
6722       list does not count, this is tidier. */
6723
6724       else if (yield && yield->ptr != save_ptr) yield->ptr--;
6725
6726       /* Restore preserved $item */
6727
6728       iterate_item = save_iterate_item;
6729       if (flags & ESI_SKIPPING) continue;
6730       break;
6731       }
6732
6733     case EITEM_SORT:
6734       {
6735       int sep = 0, cond_type;
6736       const uschar * srclist, * cmp, * xtract;
6737       uschar * opname, * srcitem;
6738       const uschar * dstlist = NULL, * dstkeylist = NULL;
6739       uschar * tmp, * save_iterate_item = iterate_item;
6740
6741       Uskip_whitespace(&s);
6742       if (*s++ != '{')                                                  /*}*/
6743         {
6744         expand_string_message = US"missing '{' for list arg of sort";
6745         goto EXPAND_FAILED_CURLY;                                       /*}*/
6746         }
6747
6748       srclist = expand_string_internal(s,
6749               ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6750       if (!srclist) goto EXPAND_FAILED;                                 /*{{*/
6751       if (*s++ != '}')
6752         {
6753         expand_string_message = US"missing '}' closing list arg of sort";
6754         goto EXPAND_FAILED_CURLY;
6755         }
6756
6757       Uskip_whitespace(&s);
6758       if (*s++ != '{')                                                  /*}*/
6759         {
6760         expand_string_message = US"missing '{' for comparator arg of sort";
6761         goto EXPAND_FAILED_CURLY;                                       /*}*/
6762         }
6763
6764       cmp = expand_string_internal(s,
6765               ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s, &resetok, NULL);
6766       if (!cmp) goto EXPAND_FAILED;                                     /*{{*/
6767       if (*s++ != '}')
6768         {
6769         expand_string_message = US"missing '}' closing comparator arg of sort";
6770         goto EXPAND_FAILED_CURLY;
6771         }
6772
6773       if ((cond_type = identify_operator(&cmp, &opname)) == -1)
6774         {
6775         if (!expand_string_message)
6776           expand_string_message = string_sprintf("unknown condition \"%s\"", s);
6777         goto EXPAND_FAILED;
6778         }
6779       switch(cond_type)
6780         {
6781         case ECOND_NUM_L: case ECOND_NUM_LE:
6782         case ECOND_NUM_G: case ECOND_NUM_GE:
6783         case ECOND_STR_GE: case ECOND_STR_GEI: case ECOND_STR_GT: case ECOND_STR_GTI:
6784         case ECOND_STR_LE: case ECOND_STR_LEI: case ECOND_STR_LT: case ECOND_STR_LTI:
6785           break;
6786
6787         default:
6788           expand_string_message = US"comparator not handled for sort";
6789           goto EXPAND_FAILED;
6790         }
6791
6792       Uskip_whitespace(&s);
6793       if (*s++ != '{')                                                  /*}*/
6794         {
6795         expand_string_message = US"missing '{' for extractor arg of sort";
6796         goto EXPAND_FAILED_CURLY;                                       /*}*/
6797         }
6798
6799       xtract = s;
6800       if (!(tmp = expand_string_internal(s,
6801         ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL)))
6802         goto EXPAND_FAILED;
6803       xtract = string_copyn(xtract, s - xtract);
6804                                                                         /*{{*/
6805       if (*s++ != '}')
6806         {
6807         expand_string_message = US"missing '}' closing extractor arg of sort";
6808         goto EXPAND_FAILED_CURLY;
6809         }
6810                                                                         /*{{*/
6811       if (*s++ != '}')
6812         {
6813         expand_string_message = US"missing } at end of \"sort\"";
6814         goto EXPAND_FAILED;
6815         }
6816
6817       if (flags & ESI_SKIPPING) continue;
6818
6819       while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
6820         {
6821         uschar * srcfield, * dstitem;
6822         gstring * newlist = NULL, * newkeylist = NULL;
6823
6824         DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);
6825
6826         /* extract field for comparisons */
6827         iterate_item = srcitem;
6828         if (  !(srcfield = expand_string_internal(xtract,
6829                                   ESI_HONOR_DOLLAR, NULL, &resetok, NULL))
6830            || !*srcfield)
6831           {
6832           expand_string_message = string_sprintf(
6833               "field-extract in sort: \"%s\"", xtract);
6834           goto EXPAND_FAILED;
6835           }
6836
6837         /* Insertion sort */
6838
6839         /* copy output list until new-item < list-item */
6840         while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6841           {
6842           uschar * dstfield;
6843
6844           /* field for comparison */
6845           if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6846             goto SORT_MISMATCH;
6847
6848           /* String-comparator names start with a letter; numeric names do not */
6849
6850           if (sortsbefore(cond_type, isalpha(opname[0]),
6851               srcfield, dstfield))
6852             {
6853             /* New-item sorts before this dst-item.  Append new-item,
6854             then dst-item, then remainder of dst list. */
6855
6856             newlist = string_append_listele(newlist, sep, srcitem);
6857             newkeylist = string_append_listele(newkeylist, sep, srcfield);
6858             srcitem = NULL;
6859
6860             newlist = string_append_listele(newlist, sep, dstitem);
6861             newkeylist = string_append_listele(newkeylist, sep, dstfield);
6862
6863 /*XXX why field-at-a-time copy?  Why not just dup the rest of the list? */
6864             while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6865               {
6866               if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6867                 goto SORT_MISMATCH;
6868               newlist = string_append_listele(newlist, sep, dstitem);
6869               newkeylist = string_append_listele(newkeylist, sep, dstfield);
6870               }
6871
6872             break;
6873             }
6874
6875           newlist = string_append_listele(newlist, sep, dstitem);
6876           newkeylist = string_append_listele(newkeylist, sep, dstfield);
6877           }
6878
6879         /* If we ran out of dstlist without consuming srcitem, append it */
6880         if (srcitem)
6881           {
6882           newlist = string_append_listele(newlist, sep, srcitem);
6883           newkeylist = string_append_listele(newkeylist, sep, srcfield);
6884           }
6885
6886         dstlist = newlist->s;
6887         dstkeylist = newkeylist->s;
6888
6889         DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);
6890         DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6891         }
6892
6893       if (dstlist)
6894         yield = string_cat(yield, dstlist);
6895
6896       /* Restore preserved $item */
6897       iterate_item = save_iterate_item;
6898       break;
6899
6900       SORT_MISMATCH:
6901         expand_string_message = US"Internal error in sort (list mismatch)";
6902         goto EXPAND_FAILED;
6903       }
6904
6905
6906     /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6907     functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6908     or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6909     a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6910
6911     #define EXPAND_DLFUNC_MAX_ARGS 8
6912
6913     case EITEM_DLFUNC:
6914 #ifndef EXPAND_DLFUNC
6915       expand_string_message = US"\"${dlfunc\" encountered, but this facility "  /*}*/
6916         "is not included in this binary";
6917       goto EXPAND_FAILED;
6918
6919 #else   /* EXPAND_DLFUNC */
6920       {
6921       tree_node * t;
6922       exim_dlfunc_t * func;
6923       uschar * result;
6924       int status, argc;
6925       uschar * argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6926
6927       if (expand_forbid & RDO_DLFUNC)
6928         {
6929         expand_string_message =
6930           US"dynamically-loaded functions are not permitted";
6931         goto EXPAND_FAILED;
6932         }
6933
6934       switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, flags,
6935            TRUE, name, &resetok, NULL))
6936         {
6937         case -1: continue;      /* skipping */
6938         case 1: goto EXPAND_FAILED_CURLY;
6939         case 2:
6940         case 3: goto EXPAND_FAILED;
6941         }
6942
6943       /* Look up the dynamically loaded object handle in the tree. If it isn't
6944       found, dlopen() the file and put the handle in the tree for next time. */
6945
6946       if (!(t = tree_search(dlobj_anchor, argv[0])))
6947         {
6948         void * handle = dlopen(CS argv[0], RTLD_LAZY);
6949         if (!handle)
6950           {
6951           expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6952             argv[0], dlerror());
6953           log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6954           goto EXPAND_FAILED;
6955           }
6956         t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]), argv[0]);
6957         Ustrcpy(t->name, argv[0]);
6958         t->data.ptr = handle;
6959         (void)tree_insertnode(&dlobj_anchor, t);
6960         }
6961
6962       /* Having obtained the dynamically loaded object handle, look up the
6963       function pointer. */
6964
6965       if (!(func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1])))
6966         {
6967         expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
6968           "%s", argv[1], argv[0], dlerror());
6969         log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6970         goto EXPAND_FAILED;
6971         }
6972
6973       /* Call the function and work out what to do with the result. If it
6974       returns OK, we have a replacement string; if it returns DEFER then
6975       expansion has failed in a non-forced manner; if it returns FAIL then
6976       failure was forced; if it returns ERROR or any other value there's a
6977       problem, so panic slightly. In any case, assume that the function has
6978       side-effects on the store that must be preserved. */
6979
6980       resetok = FALSE;
6981       result = NULL;
6982       for (argc = 0; argv[argc]; argc++) ;
6983
6984       if ((status = func(&result, argc - 2, &argv[2])) != OK)
6985         {
6986         expand_string_message = result ? result : US"(no message)";
6987         if (status == FAIL_FORCED)
6988           f.expand_string_forcedfail = TRUE;
6989         else if (status != FAIL)
6990           log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
6991               argv[0], argv[1], status, expand_string_message);
6992         goto EXPAND_FAILED;
6993         }
6994
6995       if (result) yield = string_cat(yield, result);
6996       break;
6997       }
6998 #endif /* EXPAND_DLFUNC */
6999
7000     case EITEM_ENV:     /* ${env {name} {val_if_found} {val_if_unfound}} */
7001       {
7002       uschar * key;
7003       uschar *save_lookup_value = lookup_value;
7004
7005       if (Uskip_whitespace(&s) != '{')                                  /*}*/
7006         goto EXPAND_FAILED;
7007
7008       key = expand_string_internal(s+1,
7009               ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
7010       if (!key) goto EXPAND_FAILED;                                     /*{{*/
7011       if (*s++ != '}')
7012         {
7013         expand_string_message = US"missing '}' for name arg of env";
7014         goto EXPAND_FAILED_CURLY;
7015         }
7016
7017       lookup_value = US getenv(CS key);
7018
7019       switch(process_yesno(
7020                flags,                           /* were previously skipping */
7021                lookup_value != NULL,            /* success/failure indicator */
7022                save_lookup_value,               /* value to reset for string2 */
7023                &s,                              /* input pointer */
7024                &yield,                          /* output pointer */
7025                US"env",                         /* condition type */
7026                &resetok))
7027         {
7028         case 1: goto EXPAND_FAILED;          /* when all is well, the */
7029         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
7030         }
7031       if (flags & ESI_SKIPPING) continue;
7032       break;
7033       }
7034
7035 #ifdef SUPPORT_SRS
7036     case EITEM_SRS_ENCODE:
7037       /* ${srs_encode {secret} {return_path} {orig_domain}} */
7038       {
7039       uschar * sub[3];
7040       uschar cksum[4];
7041       gstring * g = NULL;
7042       BOOL quoted = FALSE;
7043
7044       switch (read_subs(sub, 3, 3, CUSS &s, flags, TRUE, name, &resetok, NULL))
7045         {
7046         case -1: continue;      /* skipping */
7047         case 1: goto EXPAND_FAILED_CURLY;
7048         case 2:
7049         case 3: goto EXPAND_FAILED;
7050         }
7051       if (flags & ESI_SKIPPING) continue;
7052
7053       if (sub[1] && *(sub[1]))
7054         {
7055         g = string_catn(g, US"SRS0=", 5);
7056
7057         /* ${l_4:${hmac{md5}{SRS_SECRET}{${lc:$return_path}}}}= */
7058         hmac_md5(sub[0], string_copylc(sub[1]), cksum, sizeof(cksum));
7059         g = string_catn(g, cksum, sizeof(cksum));
7060         g = string_catn(g, US"=", 1);
7061
7062         /* ${base32:${eval:$tod_epoch/86400&0x3ff}}= */
7063           {
7064           struct timeval now;
7065           unsigned long i;
7066
7067           gettimeofday(&now, NULL);
7068           i = (now.tv_sec / 86400) & 0x3ff;
7069           g = string_catn(g, &base32_chars[i >> 5], 1);
7070           g = string_catn(g, &base32_chars[i & 0x1f], 1);
7071           }
7072         g = string_catn(g, US"=", 1);
7073
7074         /* ${domain:$return_path}=${local_part:$return_path} */
7075           {
7076           int start, end, domain;
7077           uschar * t = parse_extract_address(sub[1], &expand_string_message,
7078                                             &start, &end, &domain, FALSE);
7079           uschar * s;
7080
7081           if (!t)
7082             goto EXPAND_FAILED;
7083
7084           if (domain > 0) g = string_cat(g, t + domain);
7085           g = string_catn(g, US"=", 1);
7086
7087           s = domain > 0 ? string_copyn(t, domain - 1) : t;
7088           if ((quoted = Ustrchr(s, '"') != NULL))
7089             {
7090             gstring * h = NULL;
7091             DEBUG(D_expand) debug_printf_indent("auto-quoting local part\n");
7092             while (*s)          /* de-quote */
7093               {
7094               while (*s && *s != '"') h = string_catn(h, s++, 1);
7095               if (*s) s++;
7096               while (*s && *s != '"') h = string_catn(h, s++, 1);
7097               if (*s) s++;
7098               }
7099             gstring_release_unused(h);
7100             s = string_from_gstring(h);
7101             }
7102           g = string_cat(g, s);
7103           }
7104
7105         /* Assume that if the original local_part had quotes
7106         it was for good reason */
7107
7108         if (quoted) yield = string_catn(yield, US"\"", 1);
7109         yield = gstring_append(yield, g);
7110         if (quoted) yield = string_catn(yield, US"\"", 1);
7111
7112         /* @$original_domain */
7113         yield = string_catn(yield, US"@", 1);
7114         yield = string_cat(yield, sub[2]);
7115         }
7116       else
7117         DEBUG(D_expand) debug_printf_indent("null return_path for srs-encode\n");
7118
7119       break;
7120       }
7121 #endif /*SUPPORT_SRS*/
7122
7123     default:
7124       goto NOT_ITEM;
7125     }   /* EITEM_* switch */
7126     /*NOTREACHED*/
7127
7128   DEBUG(D_expand)               /* only if not the sole expansion of the line */
7129     if (yield && (expansion_start > 0 || *s))
7130       debug_expansion_interim(US"item-res",
7131           yield->s + expansion_start, yield->ptr - expansion_start,
7132           !!(flags & ESI_SKIPPING));
7133   continue;
7134
7135 NOT_ITEM: ;
7136   }
7137
7138   /* Control reaches here if the name is not recognized as one of the more
7139   complicated expansion items. Check for the "operator" syntax (name terminated
7140   by a colon). Some of the operators have arguments, separated by _ from the
7141   name. */
7142
7143   if (*s == ':')
7144     {
7145     int c;
7146     uschar * arg = NULL, * sub;
7147 #ifndef DISABLE_TLS
7148     var_entry * vp = NULL;
7149 #endif
7150
7151     /* Owing to an historical mis-design, an underscore may be part of the
7152     operator name, or it may introduce arguments.  We therefore first scan the
7153     table of names that contain underscores. If there is no match, we cut off
7154     the arguments and then scan the main table. */
7155
7156     if ((c = chop_match(name, op_table_underscore,
7157                         nelem(op_table_underscore))) < 0)
7158       {
7159       if ((arg = Ustrchr(name, '_')))
7160         *arg = 0;
7161       if ((c = chop_match(name, op_table_main, nelem(op_table_main))) >= 0)
7162         c += nelem(op_table_underscore);
7163       if (arg) *arg++ = '_';            /* Put back for error messages */
7164       }
7165
7166     /* Deal specially with operators that might take a certificate variable
7167     as we do not want to do the usual expansion. For most, expand the string.*/
7168
7169     switch(c)
7170       {
7171 #ifndef DISABLE_TLS
7172       case EOP_MD5:
7173       case EOP_SHA1:
7174       case EOP_SHA256:
7175       case EOP_BASE64:
7176         if (s[1] == '$')
7177           {
7178           const uschar * s1 = s;
7179           sub = expand_string_internal(s+2,
7180               ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s1, &resetok, NULL);
7181           if (!sub)       goto EXPAND_FAILED;           /*{*/
7182           if (*s1 != '}')
7183             {                                           /*{*/
7184             expand_string_message =
7185               string_sprintf("missing '}' closing cert arg of %s", name);
7186             goto EXPAND_FAILED_CURLY;
7187             }
7188           if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
7189             {
7190             s = s1+1;
7191             break;
7192             }
7193           vp = NULL;
7194           }
7195         /*FALLTHROUGH*/
7196 #endif
7197       default:
7198         sub = expand_string_internal(s+1,
7199                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
7200         if (!sub) goto EXPAND_FAILED;
7201         s++;
7202         break;
7203       }
7204
7205     /* If we are skipping, we don't need to perform the operation at all.
7206     This matters for operations like "mask", because the data may not be
7207     in the correct format when skipping. For example, the expression may test
7208     for the existence of $sender_host_address before trying to mask it. For
7209     other operations, doing them may not fail, but it is a waste of time. */
7210
7211     if (flags & ESI_SKIPPING && c >= 0) continue;
7212
7213     /* Otherwise, switch on the operator type.  After handling go back
7214     to the main loop top. */
7215
7216      {
7217      unsigned expansion_start = gstring_length(yield);
7218      switch(c)
7219       {
7220       case EOP_BASE32:
7221         {
7222         uschar * t;
7223         unsigned long int n = Ustrtoul(sub, &t, 10);
7224         gstring * g = NULL;
7225
7226         if (*t)
7227           {
7228           expand_string_message = string_sprintf("argument for base32 "
7229             "operator is \"%s\", which is not a decimal number", sub);
7230           goto EXPAND_FAILED;
7231           }
7232         for ( ; n; n >>= 5)
7233           g = string_catn(g, &base32_chars[n & 0x1f], 1);
7234
7235         if (g) while (g->ptr > 0) yield = string_catn(yield, &g->s[--g->ptr], 1);
7236         break;
7237         }
7238
7239       case EOP_BASE32D:
7240         {
7241         uschar *tt = sub;
7242         unsigned long int n = 0;
7243         while (*tt)
7244           {
7245           uschar * t = Ustrchr(base32_chars, *tt++);
7246           if (!t)
7247             {
7248             expand_string_message = string_sprintf("argument for base32d "
7249               "operator is \"%s\", which is not a base 32 number", sub);
7250             goto EXPAND_FAILED;
7251             }
7252           n = n * 32 + (t - base32_chars);
7253           }
7254         yield = string_fmt_append(yield, "%ld", n);
7255         break;
7256         }
7257
7258       case EOP_BASE62:
7259         {
7260         uschar *t;
7261         unsigned long int n = Ustrtoul(sub, &t, 10);
7262         if (*t)
7263           {
7264           expand_string_message = string_sprintf("argument for base62 "
7265             "operator is \"%s\", which is not a decimal number", sub);
7266           goto EXPAND_FAILED;
7267           }
7268         yield = string_cat(yield, string_base62_32(n));         /*XXX only handles 32b input range.  Need variants? */
7269         break;
7270         }
7271
7272       /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
7273
7274       case EOP_BASE62D:
7275         {
7276         uschar *tt = sub;
7277         unsigned long int n = 0;
7278         while (*tt)
7279           {
7280           uschar *t = Ustrchr(base62_chars, *tt++);
7281           if (!t)
7282             {
7283             expand_string_message = string_sprintf("argument for base62d "
7284               "operator is \"%s\", which is not a base %d number", sub,
7285               BASE_62);
7286             goto EXPAND_FAILED;
7287             }
7288           n = n * BASE_62 + (t - base62_chars);
7289           }
7290         yield = string_fmt_append(yield, "%ld", n);
7291         break;
7292         }
7293
7294       case EOP_EXPAND:
7295         {
7296         uschar *expanded = expand_string_internal(sub,
7297                 ESI_HONOR_DOLLAR | flags & ESI_SKIPPING, NULL, &resetok, NULL);
7298         if (!expanded)
7299           {
7300           expand_string_message =
7301             string_sprintf("internal expansion of \"%s\" failed: %s", sub,
7302               expand_string_message);
7303           goto EXPAND_FAILED;
7304           }
7305         yield = string_cat(yield, expanded);
7306         break;
7307         }
7308
7309       case EOP_LC:
7310         {
7311         int count = 0;
7312         uschar *t = sub - 1;
7313         while (*(++t) != 0) { *t = tolower(*t); count++; }
7314         yield = string_catn(yield, sub, count);
7315         break;
7316         }
7317
7318       case EOP_UC:
7319         {
7320         int count = 0;
7321         uschar *t = sub - 1;
7322         while (*(++t) != 0) { *t = toupper(*t); count++; }
7323         yield = string_catn(yield, sub, count);
7324         break;
7325         }
7326
7327       case EOP_MD5:
7328 #ifndef DISABLE_TLS
7329         if (vp && *(void **)vp->value)
7330           {
7331           uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
7332           yield = string_cat(yield, cp);
7333           }
7334         else
7335 #endif
7336           {
7337           md5 base;
7338           uschar digest[16];
7339           md5_start(&base);
7340           md5_end(&base, sub, Ustrlen(sub), digest);
7341           for (int j = 0; j < 16; j++)
7342             yield = string_fmt_append(yield, "%02x", digest[j]);
7343           }
7344         break;
7345
7346       case EOP_SHA1:
7347 #ifndef DISABLE_TLS
7348         if (vp && *(void **)vp->value)
7349           {
7350           uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
7351           yield = string_cat(yield, cp);
7352           }
7353         else
7354 #endif
7355           {
7356           hctx h;
7357           uschar digest[20];
7358           sha1_start(&h);
7359           sha1_end(&h, sub, Ustrlen(sub), digest);
7360           for (int j = 0; j < 20; j++)
7361             yield = string_fmt_append(yield, "%02X", digest[j]);
7362           }
7363         break;
7364
7365       case EOP_SHA2:
7366       case EOP_SHA256:
7367 #ifdef EXIM_HAVE_SHA2
7368         if (vp && *(void **)vp->value)
7369           if (c == EOP_SHA256)
7370             yield = string_cat(yield, tls_cert_fprt_sha256(*(void **)vp->value));
7371           else
7372             expand_string_message = US"sha2_N not supported with certificates";
7373         else
7374           {
7375           hctx h;
7376           blob b;
7377           hashmethod m = !arg ? HASH_SHA2_256
7378             : Ustrcmp(arg, "256") == 0 ? HASH_SHA2_256
7379             : Ustrcmp(arg, "384") == 0 ? HASH_SHA2_384
7380             : Ustrcmp(arg, "512") == 0 ? HASH_SHA2_512
7381             : HASH_BADTYPE;
7382
7383           if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7384             {
7385             expand_string_message = US"unrecognised sha2 variant";
7386             goto EXPAND_FAILED;
7387             }
7388
7389           exim_sha_update_string(&h, sub);
7390           exim_sha_finish(&h, &b);
7391           while (b.len-- > 0)
7392             yield = string_fmt_append(yield, "%02X", *b.data++);
7393           }
7394 #else
7395           expand_string_message = US"sha256 only supported with TLS";
7396 #endif
7397         break;
7398
7399       case EOP_SHA3:
7400 #ifdef EXIM_HAVE_SHA3
7401         {
7402         hctx h;
7403         blob b;
7404         hashmethod m = !arg ? HASH_SHA3_256
7405           : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224
7406           : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256
7407           : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384
7408           : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512
7409           : HASH_BADTYPE;
7410
7411         if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7412           {
7413           expand_string_message = US"unrecognised sha3 variant";
7414           goto EXPAND_FAILED;
7415           }
7416
7417         exim_sha_update_string(&h, sub);
7418         exim_sha_finish(&h, &b);
7419         while (b.len-- > 0)
7420           yield = string_fmt_append(yield, "%02X", *b.data++);
7421         }
7422         break;
7423 #else
7424         expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 + or OpenSSL 1.1.1 +";
7425         goto EXPAND_FAILED;
7426 #endif
7427
7428       /* Line-wrap a string as if it is a header line */
7429
7430       case EOP_HEADERWRAP:
7431         {
7432         unsigned col = 80, lim = 998;
7433         uschar * s;
7434
7435         if (arg)
7436           {
7437           const uschar * list = arg;
7438           int sep = '_';
7439           if ((s = string_nextinlist(&list, &sep, NULL, 0)))
7440             {
7441             col = atoi(CS s);
7442             if ((s = string_nextinlist(&list, &sep, NULL, 0)))
7443               lim = atoi(CS s);
7444             }
7445           }
7446           if ((s =  wrap_header(sub, col, lim, US"\t", 8)))
7447             yield = string_cat(yield, s);
7448         }
7449         break;
7450
7451       /* Convert hex encoding to base64 encoding */
7452
7453       case EOP_HEX2B64:
7454         {
7455         int c = 0;
7456         int b = -1;
7457         uschar *in = sub;
7458         uschar *out = sub;
7459         uschar *enc;
7460
7461         for (enc = sub; *enc; enc++)
7462           {
7463           if (!isxdigit(*enc))
7464             {
7465             expand_string_message = string_sprintf("\"%s\" is not a hex "
7466               "string", sub);
7467             goto EXPAND_FAILED;
7468             }
7469           c++;
7470           }
7471
7472         if ((c & 1) != 0)
7473           {
7474           expand_string_message = string_sprintf("\"%s\" contains an odd "
7475             "number of characters", sub);
7476           goto EXPAND_FAILED;
7477           }
7478
7479         while ((c = *in++) != 0)
7480           {
7481           if (isdigit(c)) c -= '0';
7482           else c = toupper(c) - 'A' + 10;
7483           if (b == -1)
7484             b = c << 4;
7485           else
7486             {
7487             *out++ = b | c;
7488             b = -1;
7489             }
7490           }
7491
7492         enc = b64encode(CUS sub, out - sub);
7493         yield = string_cat(yield, enc);
7494         break;
7495         }
7496
7497       /* Convert octets outside 0x21..0x7E to \xXX form */
7498
7499       case EOP_HEXQUOTE:
7500         {
7501         uschar *t = sub - 1;
7502         while (*(++t) != 0)
7503           {
7504           if (*t < 0x21 || 0x7E < *t)
7505             yield = string_fmt_append(yield, "\\x%02x", *t);
7506           else
7507             yield = string_catn(yield, t, 1);
7508           }
7509         break;
7510         }
7511
7512       /* count the number of list elements */
7513
7514       case EOP_LISTCOUNT:
7515         {
7516         int cnt = 0, sep = 0;
7517         uschar * buf = store_get(2, sub);
7518
7519         while (string_nextinlist(CUSS &sub, &sep, buf, 1)) cnt++;
7520         yield = string_fmt_append(yield, "%d", cnt);
7521         break;
7522         }
7523
7524       /* expand a named list given the name */
7525       /* handles nested named lists; requotes as colon-sep list */
7526
7527       case EOP_LISTNAMED:
7528         expand_string_message = NULL;
7529         yield = expand_listnamed(yield, sub, arg);
7530         if (expand_string_message)
7531           goto EXPAND_FAILED;
7532         break;
7533
7534       /* quote a list-item for the given list-separator */
7535
7536       /* mask applies a mask to an IP address; for example the result of
7537       ${mask:131.111.10.206/28} is 131.111.10.192/28. */
7538
7539       case EOP_MASK:
7540         {
7541         int count;
7542         uschar *endptr;
7543         int binary[4];
7544         int type, mask, maskoffset;
7545         BOOL normalised;
7546         uschar buffer[64];
7547
7548         if ((type = string_is_ip_address(sub, &maskoffset)) == 0)
7549           {
7550           expand_string_message = string_sprintf("\"%s\" is not an IP address",
7551            sub);
7552           goto EXPAND_FAILED;
7553           }
7554
7555         if (maskoffset == 0)
7556           {
7557           expand_string_message = string_sprintf("missing mask value in \"%s\"",
7558             sub);
7559           goto EXPAND_FAILED;
7560           }
7561
7562         mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
7563
7564         if (*endptr || mask < 0 || mask > (type == 4 ? 32 : 128))
7565           {
7566           expand_string_message = string_sprintf("mask value too big in \"%s\"",
7567             sub);
7568           goto EXPAND_FAILED;
7569           }
7570
7571         /* If an optional 'n' was given, ipv6 gets normalised output:
7572         colons rather than dots, and zero-compressed. */
7573
7574         normalised = arg && *arg == 'n';
7575
7576         /* Convert the address to binary integer(s) and apply the mask */
7577
7578         sub[maskoffset] = 0;
7579         count = host_aton(sub, binary);
7580         host_mask(count, binary, mask);
7581
7582         /* Convert to masked textual format and add to output. */
7583
7584         if (type == 4 || !normalised)
7585           yield = string_catn(yield, buffer,
7586             host_nmtoa(count, binary, mask, buffer, '.'));
7587         else
7588           {
7589           ipv6_nmtoa(binary, buffer);
7590           yield = string_fmt_append(yield, "%s/%d", buffer, mask);
7591           }
7592         break;
7593         }
7594
7595       case EOP_IPV6NORM:
7596       case EOP_IPV6DENORM:
7597         {
7598         int type = string_is_ip_address(sub, NULL);
7599         int binary[4];
7600         uschar buffer[44];
7601
7602         switch (type)
7603           {
7604           case 6:
7605             (void) host_aton(sub, binary);
7606             break;
7607
7608           case 4:       /* convert to IPv4-mapped IPv6 */
7609             binary[0] = binary[1] = 0;
7610             binary[2] = 0x0000ffff;
7611             (void) host_aton(sub, binary+3);
7612             break;
7613
7614           case 0:
7615             expand_string_message =
7616               string_sprintf("\"%s\" is not an IP address", sub);
7617             goto EXPAND_FAILED;
7618           }
7619
7620         yield = string_catn(yield, buffer, c == EOP_IPV6NORM
7621                     ? ipv6_nmtoa(binary, buffer)
7622                     : host_nmtoa(4, binary, -1, buffer, ':')
7623                   );
7624         break;
7625         }
7626
7627       case EOP_ADDRESS:
7628       case EOP_LOCAL_PART:
7629       case EOP_DOMAIN:
7630         {
7631         uschar * error;
7632         int start, end, domain;
7633         uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,
7634           FALSE);
7635         if (t)
7636           if (c != EOP_DOMAIN)
7637             yield = c == EOP_LOCAL_PART && domain > 0
7638               ? string_catn(yield, t, domain - 1)
7639               : string_cat(yield, t);
7640           else if (domain > 0)
7641             yield = string_cat(yield, t + domain);
7642         break;
7643         }
7644
7645       case EOP_ADDRESSES:
7646         {
7647         uschar outsep[2] = { ':', '\0' };
7648         uschar *address, *error;
7649         int save_ptr = gstring_length(yield);
7650         int start, end, domain;  /* Not really used */
7651
7652         if (Uskip_whitespace(&sub) == '>')
7653           if (*outsep = *++sub) ++sub;
7654           else
7655             {
7656             expand_string_message = string_sprintf("output separator "
7657               "missing in expanding ${addresses:%s}", --sub);
7658             goto EXPAND_FAILED;
7659             }
7660         f.parse_allow_group = TRUE;
7661
7662         for (;;)
7663           {
7664           uschar * p = parse_find_address_end(sub, FALSE);
7665           uschar saveend = *p;
7666           *p = '\0';
7667           address = parse_extract_address(sub, &error, &start, &end, &domain,
7668             FALSE);
7669           *p = saveend;
7670
7671           /* Add the address to the output list that we are building. This is
7672           done in chunks by searching for the separator character. At the
7673           start, unless we are dealing with the first address of the output
7674           list, add in a space if the new address begins with the separator
7675           character, or is an empty string. */
7676
7677           if (address)
7678             {
7679             if (yield && yield->ptr != save_ptr && address[0] == *outsep)
7680               yield = string_catn(yield, US" ", 1);
7681
7682             for (;;)
7683               {
7684               size_t seglen = Ustrcspn(address, outsep);
7685               yield = string_catn(yield, address, seglen + 1);
7686
7687               /* If we got to the end of the string we output one character
7688               too many. */
7689
7690               if (address[seglen] == '\0') { yield->ptr--; break; }
7691               yield = string_catn(yield, outsep, 1);
7692               address += seglen + 1;
7693               }
7694
7695             /* Output a separator after the string: we will remove the
7696             redundant final one at the end. */
7697
7698             yield = string_catn(yield, outsep, 1);
7699             }
7700
7701           if (saveend == '\0') break;
7702           sub = p + 1;
7703           }
7704
7705         /* If we have generated anything, remove the redundant final
7706         separator. */
7707
7708         if (yield && yield->ptr != save_ptr) yield->ptr--;
7709         f.parse_allow_group = FALSE;
7710         break;
7711         }
7712
7713
7714       /* quote puts a string in quotes if it is empty or contains anything
7715       other than alphamerics, underscore, dot, or hyphen.
7716
7717       quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
7718       be quoted in order to be a valid local part.
7719
7720       In both cases, newlines and carriage returns are converted into \n and \r
7721       respectively */
7722
7723       case EOP_QUOTE:
7724       case EOP_QUOTE_LOCAL_PART:
7725         if (!arg)
7726           {
7727           BOOL needs_quote = (!*sub);      /* TRUE for empty string */
7728           uschar *t = sub - 1;
7729
7730           if (c == EOP_QUOTE)
7731             while (!needs_quote && *++t)
7732               needs_quote = !isalnum(*t) && !strchr("_-.", *t);
7733
7734           else  /* EOP_QUOTE_LOCAL_PART */
7735             while (!needs_quote && *++t)
7736               needs_quote = !isalnum(*t)
7737                 && strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL
7738                 && (*t != '.' || t == sub || !t[1]);
7739
7740           if (needs_quote)
7741             {
7742             yield = string_catn(yield, US"\"", 1);
7743             t = sub - 1;
7744             while (*++t)
7745               if (*t == '\n')
7746                 yield = string_catn(yield, US"\\n", 2);
7747               else if (*t == '\r')
7748                 yield = string_catn(yield, US"\\r", 2);
7749               else
7750                 {
7751                 if (*t == '\\' || *t == '"')
7752                   yield = string_catn(yield, US"\\", 1);
7753                 yield = string_catn(yield, t, 1);
7754                 }
7755             yield = string_catn(yield, US"\"", 1);
7756             }
7757           else
7758             yield = string_cat(yield, sub);
7759           break;
7760           }
7761
7762         /* quote_lookuptype does lookup-specific quoting */
7763
7764         else
7765           {
7766           int n;
7767           uschar * opt = Ustrchr(arg, '_');
7768
7769           if (opt) *opt++ = 0;
7770
7771           if ((n = search_findtype(arg, Ustrlen(arg))) < 0)
7772             {
7773             expand_string_message = search_error_message;
7774             goto EXPAND_FAILED;
7775             }
7776
7777           if (lookup_list[n]->quote)
7778             sub = (lookup_list[n]->quote)(sub, opt, (unsigned)n);
7779           else if (opt)
7780             sub = NULL;
7781
7782           if (!sub)
7783             {
7784             expand_string_message = string_sprintf(
7785               "\"%s\" unrecognized after \"${quote_%s\"",       /*}*/
7786               opt, arg);
7787             goto EXPAND_FAILED;
7788             }
7789
7790           yield = string_cat(yield, sub);
7791           break;
7792           }
7793
7794         /* rx quote sticks in \ before any non-alphameric character so that
7795         the insertion works in a regular expression. */
7796
7797         case EOP_RXQUOTE:
7798           {
7799           uschar *t = sub - 1;
7800           while (*(++t) != 0)
7801             {
7802             if (!isalnum(*t))
7803               yield = string_catn(yield, US"\\", 1);
7804             yield = string_catn(yield, t, 1);
7805             }
7806           break;
7807           }
7808
7809         /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
7810         prescribed by the RFC, if there are characters that need to be encoded */
7811
7812         case EOP_RFC2047:
7813           yield = string_cat(yield,
7814                               parse_quote_2047(sub, Ustrlen(sub), headers_charset,
7815                                 FALSE));
7816           break;
7817
7818         /* RFC 2047 decode */
7819
7820         case EOP_RFC2047D:
7821           {
7822           int len;
7823           uschar *error;
7824           uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
7825             headers_charset, '?', &len, &error);
7826           if (error)
7827             {
7828             expand_string_message = error;
7829             goto EXPAND_FAILED;
7830             }
7831           yield = string_catn(yield, decoded, len);
7832           break;
7833           }
7834
7835         /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
7836         underscores */
7837
7838         case EOP_FROM_UTF8:
7839           {
7840           uschar * buff = store_get(4, sub);
7841           while (*sub)
7842             {
7843             int c;
7844             GETUTF8INC(c, sub);
7845             if (c > 255) c = '_';
7846             buff[0] = c;
7847             yield = string_catn(yield, buff, 1);
7848             }
7849           break;
7850           }
7851
7852         /* replace illegal UTF-8 sequences by replacement character  */
7853
7854         #define UTF8_REPLACEMENT_CHAR US"?"
7855
7856         case EOP_UTF8CLEAN:
7857           {
7858           int seq_len = 0, index = 0, bytes_left = 0, complete;
7859           long codepoint = -1;
7860           uschar seq_buff[4];                   /* accumulate utf-8 here */
7861
7862           /* Manually track tainting, as we deal in individual chars below */
7863
7864           if (!yield)
7865             yield = string_get_tainted(Ustrlen(sub), sub);
7866           else if (!yield->s || !yield->ptr)
7867             {
7868             yield->s = store_get(yield->size = Ustrlen(sub), sub);
7869             gstring_reset(yield);
7870             }
7871           else if (is_incompatible(yield->s, sub))
7872             gstring_rebuffer(yield, sub);
7873
7874           /* Check the UTF-8, byte-by-byte */
7875
7876           while (*sub)
7877             {
7878             complete = 0;
7879             uschar c = *sub++;
7880
7881             if (bytes_left)
7882               {
7883               if ((c & 0xc0) != 0x80)
7884                       /* wrong continuation byte; invalidate all bytes */
7885                 complete = 1; /* error */
7886               else
7887                 {
7888                 codepoint = (codepoint << 6) | (c & 0x3f);
7889                 seq_buff[index++] = c;
7890                 if (--bytes_left == 0)          /* codepoint complete */
7891                   if(codepoint > 0x10FFFF)      /* is it too large? */
7892                     complete = -1;      /* error (RFC3629 limit) */
7893                   else
7894                     {           /* finished; output utf-8 sequence */
7895                     yield = string_catn(yield, seq_buff, seq_len);
7896                     index = 0;
7897                     }
7898                 }
7899               }
7900             else        /* no bytes left: new sequence */
7901               {
7902               if(!(c & 0x80))   /* 1-byte sequence, US-ASCII, keep it */
7903                 {
7904                 yield = string_catn(yield, &c, 1);
7905                 continue;
7906                 }
7907               if((c & 0xe0) == 0xc0)            /* 2-byte sequence */
7908                 {
7909                 if(c == 0xc0 || c == 0xc1)      /* 0xc0 and 0xc1 are illegal */
7910                   complete = -1;
7911                 else
7912                   {
7913                     bytes_left = 1;
7914                     codepoint = c & 0x1f;
7915                   }
7916                 }
7917               else if((c & 0xf0) == 0xe0)               /* 3-byte sequence */
7918                 {
7919                 bytes_left = 2;
7920                 codepoint = c & 0x0f;
7921                 }
7922               else if((c & 0xf8) == 0xf0)               /* 4-byte sequence */
7923                 {
7924                 bytes_left = 3;
7925                 codepoint = c & 0x07;
7926                 }
7927               else      /* invalid or too long (RFC3629 allows only 4 bytes) */
7928                 complete = -1;
7929
7930               seq_buff[index++] = c;
7931               seq_len = bytes_left + 1;
7932               }         /* if(bytes_left) */
7933
7934             if (complete != 0)
7935               {
7936               bytes_left = index = 0;
7937               yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7938               }
7939             if ((complete == 1) && ((c & 0x80) == 0))
7940                           /* ASCII character follows incomplete sequence */
7941                 yield = string_catn(yield, &c, 1);
7942             }
7943           /* If given a sequence truncated mid-character, we also want to report ?
7944           Eg, ${length_1:フィル} is one byte, not one character, so we expect
7945           ${utf8clean:${length_1:フィル}} to yield '?' */
7946
7947           if (bytes_left != 0)
7948             yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7949
7950           break;
7951           }
7952
7953 #ifdef SUPPORT_I18N
7954         case EOP_UTF8_DOMAIN_TO_ALABEL:
7955           {
7956           uschar * error = NULL;
7957           uschar * s = string_domain_utf8_to_alabel(sub, &error);
7958           if (error)
7959             {
7960             expand_string_message = string_sprintf(
7961               "error converting utf8 (%s) to alabel: %s",
7962               string_printing(sub), error);
7963             goto EXPAND_FAILED;
7964             }
7965           yield = string_cat(yield, s);
7966           break;
7967           }
7968
7969         case EOP_UTF8_DOMAIN_FROM_ALABEL:
7970           {
7971           uschar * error = NULL;
7972           uschar * s = string_domain_alabel_to_utf8(sub, &error);
7973           if (error)
7974             {
7975             expand_string_message = string_sprintf(
7976               "error converting alabel (%s) to utf8: %s",
7977               string_printing(sub), error);
7978             goto EXPAND_FAILED;
7979             }
7980           yield = string_cat(yield, s);
7981           break;
7982           }
7983
7984         case EOP_UTF8_LOCALPART_TO_ALABEL:
7985           {
7986           uschar * error = NULL;
7987           uschar * s = string_localpart_utf8_to_alabel(sub, &error);
7988           if (error)
7989             {
7990             expand_string_message = string_sprintf(
7991               "error converting utf8 (%s) to alabel: %s",
7992               string_printing(sub), error);
7993             goto EXPAND_FAILED;
7994             }
7995           yield = string_cat(yield, s);
7996           DEBUG(D_expand) debug_printf_indent("yield: '%s'\n", string_from_gstring(yield));
7997           break;
7998           }
7999
8000         case EOP_UTF8_LOCALPART_FROM_ALABEL:
8001           {
8002           uschar * error = NULL;
8003           uschar * s = string_localpart_alabel_to_utf8(sub, &error);
8004           if (error)
8005             {
8006             expand_string_message = string_sprintf(
8007               "error converting alabel (%s) to utf8: %s",
8008               string_printing(sub), error);
8009             goto EXPAND_FAILED;
8010             }
8011           yield = string_cat(yield, s);
8012           break;
8013           }
8014 #endif  /* EXPERIMENTAL_INTERNATIONAL */
8015
8016         /* escape turns all non-printing characters into escape sequences. */
8017
8018         case EOP_ESCAPE:
8019           {
8020           const uschar * t = string_printing(sub);
8021           yield = string_cat(yield, t);
8022           break;
8023           }
8024
8025         case EOP_ESCAPE8BIT:
8026           {
8027           uschar c;
8028
8029           for (const uschar * s = sub; (c = *s); s++)
8030             yield = c < 127 && c != '\\'
8031               ? string_catn(yield, s, 1)
8032               : string_fmt_append(yield, "\\%03o", c);
8033           break;
8034           }
8035
8036         /* Handle numeric expression evaluation */
8037
8038         case EOP_EVAL:
8039         case EOP_EVAL10:
8040           {
8041           uschar *save_sub = sub;
8042           uschar *error = NULL;
8043           int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
8044           if (error)
8045             {
8046             expand_string_message = string_sprintf("error in expression "
8047               "evaluation: %s (after processing \"%.*s\")", error,
8048               (int)(sub-save_sub), save_sub);
8049             goto EXPAND_FAILED;
8050             }
8051           yield = string_fmt_append(yield, PR_EXIM_ARITH, n);
8052           break;
8053           }
8054
8055         /* Handle time period formatting */
8056
8057         case EOP_TIME_EVAL:
8058           {
8059           int n = readconf_readtime(sub, 0, FALSE);
8060           if (n < 0)
8061             {
8062             expand_string_message = string_sprintf("string \"%s\" is not an "
8063               "Exim time interval in \"%s\" operator", sub, name);
8064             goto EXPAND_FAILED;
8065             }
8066           yield = string_fmt_append(yield, "%d", n);
8067           break;
8068           }
8069
8070         case EOP_TIME_INTERVAL:
8071           {
8072           int n;
8073           uschar *t = read_number(&n, sub);
8074           if (*t != 0) /* Not A Number*/
8075             {
8076             expand_string_message = string_sprintf("string \"%s\" is not a "
8077               "positive number in \"%s\" operator", sub, name);
8078             goto EXPAND_FAILED;
8079             }
8080           t = readconf_printtime(n);
8081           yield = string_cat(yield, t);
8082           break;
8083           }
8084
8085         /* Convert string to base64 encoding */
8086
8087         case EOP_STR2B64:
8088         case EOP_BASE64:
8089           {
8090 #ifndef DISABLE_TLS
8091           uschar * s = vp && *(void **)vp->value
8092             ? tls_cert_der_b64(*(void **)vp->value)
8093             : b64encode(CUS sub, Ustrlen(sub));
8094 #else
8095           uschar * s = b64encode(CUS sub, Ustrlen(sub));
8096 #endif
8097           yield = string_cat(yield, s);
8098           break;
8099           }
8100
8101         case EOP_BASE64D:
8102           {
8103           uschar * s;
8104           int len = b64decode(sub, &s);
8105           if (len < 0)
8106             {
8107             expand_string_message = string_sprintf("string \"%s\" is not "
8108               "well-formed for \"%s\" operator", sub, name);
8109             goto EXPAND_FAILED;
8110             }
8111           yield = string_cat(yield, s);
8112           break;
8113           }
8114
8115         /* strlen returns the length of the string */
8116
8117         case EOP_STRLEN:
8118           yield = string_fmt_append(yield, "%d", Ustrlen(sub));
8119           break;
8120
8121         /* length_n or l_n takes just the first n characters or the whole string,
8122         whichever is the shorter;
8123
8124         substr_m_n, and s_m_n take n characters from offset m; negative m take
8125         from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
8126         takes the rest, either to the right or to the left.
8127
8128         hash_n or h_n makes a hash of length n from the string, yielding n
8129         characters from the set a-z; hash_n_m makes a hash of length n, but
8130         uses m characters from the set a-zA-Z0-9.
8131
8132         nhash_n returns a single number between 0 and n-1 (in text form), while
8133         nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
8134         between 0 and n-1 and the second between 0 and m-1. */
8135
8136         case EOP_LENGTH:
8137         case EOP_L:
8138         case EOP_SUBSTR:
8139         case EOP_S:
8140         case EOP_HASH:
8141         case EOP_H:
8142         case EOP_NHASH:
8143         case EOP_NH:
8144           {
8145           int sign = 1;
8146           int value1 = 0;
8147           int value2 = -1;
8148           int *pn;
8149           int len;
8150           uschar *ret;
8151
8152           if (!arg)
8153             {
8154             expand_string_message = string_sprintf("missing values after %s",
8155               name);
8156             goto EXPAND_FAILED;
8157             }
8158
8159           /* "length" has only one argument, effectively being synonymous with
8160           substr_0_n. */
8161
8162           if (c == EOP_LENGTH || c == EOP_L)
8163             {
8164             pn = &value2;
8165             value2 = 0;
8166             }
8167
8168           /* The others have one or two arguments; for "substr" the first may be
8169           negative. The second being negative means "not supplied". */
8170
8171           else
8172             {
8173             pn = &value1;
8174             if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
8175             }
8176
8177           /* Read up to two numbers, separated by underscores */
8178
8179           ret = arg;
8180           while (*arg != 0)
8181             {
8182             if (arg != ret && *arg == '_' && pn == &value1)
8183               {
8184               pn = &value2;
8185               value2 = 0;
8186               if (arg[1] != 0) arg++;
8187               }
8188             else if (!isdigit(*arg))
8189               {
8190               expand_string_message =
8191                 string_sprintf("non-digit after underscore in \"%s\"", name);
8192               goto EXPAND_FAILED;
8193               }
8194             else *pn = (*pn)*10 + *arg++ - '0';
8195             }
8196           value1 *= sign;
8197
8198           /* Perform the required operation */
8199
8200           ret = c == EOP_HASH || c == EOP_H
8201             ? compute_hash(sub, value1, value2, &len)
8202             : c == EOP_NHASH || c == EOP_NH
8203             ? compute_nhash(sub, value1, value2, &len)
8204             : extract_substr(sub, value1, value2, &len);
8205           if (!ret) goto EXPAND_FAILED;
8206
8207           yield = string_catn(yield, ret, len);
8208           break;
8209           }
8210
8211         /* Stat a path */
8212
8213         case EOP_STAT:
8214           {
8215           uschar smode[12];
8216           uschar **modetable[3];
8217           mode_t mode;
8218           struct stat st;
8219
8220           if (expand_forbid & RDO_EXISTS)
8221             {
8222             expand_string_message = US"Use of the stat() expansion is not permitted";
8223             goto EXPAND_FAILED;
8224             }
8225
8226           if (stat(CS sub, &st) < 0)
8227             {
8228             expand_string_message = string_sprintf("stat(%s) failed: %s",
8229               sub, strerror(errno));
8230             goto EXPAND_FAILED;
8231             }
8232           mode = st.st_mode;
8233           switch (mode & S_IFMT)
8234             {
8235             case S_IFIFO: smode[0] = 'p'; break;
8236             case S_IFCHR: smode[0] = 'c'; break;
8237             case S_IFDIR: smode[0] = 'd'; break;
8238             case S_IFBLK: smode[0] = 'b'; break;
8239             case S_IFREG: smode[0] = '-'; break;
8240             default: smode[0] = '?'; break;
8241             }
8242
8243           modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
8244           modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
8245           modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
8246
8247           for (int i = 0; i < 3; i++)
8248             {
8249             memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
8250             mode >>= 3;
8251             }
8252
8253           smode[10] = 0;
8254           yield = string_fmt_append(yield,
8255             "mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
8256             "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
8257             (long)(st.st_mode & 077777), smode, (long)st.st_ino,
8258             (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
8259             (long)st.st_gid, st.st_size, (long)st.st_atime,
8260             (long)st.st_mtime, (long)st.st_ctime);
8261           break;
8262           }
8263
8264         /* vaguely random number less than N */
8265
8266         case EOP_RANDINT:
8267           {
8268           int_eximarith_t max = expanded_string_integer(sub, TRUE);
8269
8270           if (expand_string_message)
8271             goto EXPAND_FAILED;
8272           yield = string_fmt_append(yield, "%d", vaguely_random_number((int)max));
8273           break;
8274           }
8275
8276         /* Reverse IP, including IPv6 to dotted-nibble */
8277
8278         case EOP_REVERSE_IP:
8279           {
8280           int family, maskptr;
8281           uschar reversed[128];
8282
8283           family = string_is_ip_address(sub, &maskptr);
8284           if (family == 0)
8285             {
8286             expand_string_message = string_sprintf(
8287                 "reverse_ip() not given an IP address [%s]", sub);
8288             goto EXPAND_FAILED;
8289             }
8290           invert_address(reversed, sub);
8291           yield = string_cat(yield, reversed);
8292           break;
8293           }
8294
8295         /* Unknown operator */
8296
8297         default:
8298           expand_string_message =
8299             string_sprintf("unknown expansion operator \"%s\"", name);
8300           goto EXPAND_FAILED;
8301         }       /* EOP_* switch */
8302
8303        DEBUG(D_expand)
8304         {
8305         const uschar * res = string_from_gstring(yield);
8306         const uschar * s = res + expansion_start;
8307         int i = gstring_length(yield) - expansion_start;
8308         BOOL tainted = is_tainted(s);
8309
8310         DEBUG(D_noutf8)
8311           {
8312           debug_printf_indent("|-----op-res: %.*s\n", i, s);
8313           if (tainted)
8314             {
8315             debug_printf_indent("%s     \\__", flags & ESI_SKIPPING ? "|     " : "      ");
8316             debug_print_taint(res);
8317             }
8318           }
8319         else
8320           {
8321           debug_printf_indent(UTF8_VERT_RIGHT
8322             UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8323             "op-res: %.*s\n", i, s);
8324           if (tainted)
8325             {
8326             debug_printf_indent("%s",
8327               flags & ESI_SKIPPING
8328               ? UTF8_VERT "             " : "           " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
8329             debug_print_taint(res);
8330             }
8331           }
8332         }
8333        continue;
8334        }
8335     }
8336
8337   /* Not an item or an operator */
8338   /* Handle a plain name. If this is the first thing in the expansion, release
8339   the pre-allocated buffer. If the result data is known to be in a new buffer,
8340   newsize will be set to the size of that buffer, and we can just point at that
8341   store instead of copying. Many expansion strings contain just one reference,
8342   so this is a useful optimization, especially for humungous headers
8343   ($message_headers). */
8344                                                 /*{*/
8345   if (*s++ == '}')
8346     {
8347     const uschar * value;
8348     int len;
8349     int newsize = 0;
8350     gstring * g = NULL;
8351
8352     if (!yield)
8353       g = store_get(sizeof(gstring), GET_UNTAINTED);
8354     else if (yield->ptr == 0)
8355       {
8356       if (resetok) reset_point = store_reset(reset_point);
8357       yield = NULL;
8358       reset_point = store_mark();
8359       g = store_get(sizeof(gstring), GET_UNTAINTED);    /* alloc _before_ calling find_variable() */
8360       }
8361     if (!(value = find_variable(name, FALSE, !!(flags & ESI_SKIPPING), &newsize)))
8362       {
8363       expand_string_message =
8364         string_sprintf("unknown variable in \"${%s}\"", name);
8365       check_variable_error_message(name);
8366       goto EXPAND_FAILED;
8367       }
8368     len = Ustrlen(value);
8369     if (!yield && newsize)
8370       {
8371       yield = g;
8372       yield->size = newsize;
8373       yield->ptr = len;
8374       yield->s = US value; /* known to be in new store i.e. a copy, so deconst safe */
8375       }
8376     else
8377       yield = string_catn(yield, value, len);
8378     continue;
8379     }
8380
8381   /* Else there's something wrong */
8382
8383   expand_string_message =
8384     string_sprintf("\"${%s\" is not a known operator (or a } is missing "
8385     "in a variable reference)", name);
8386   goto EXPAND_FAILED;
8387   }
8388
8389 /* If we hit the end of the string when brace_ends is set, there is a missing
8390 terminating brace. */
8391
8392 if (flags & ESI_BRACE_ENDS && !*s)
8393   {                                                     /*{{*/
8394   expand_string_message = malformed_header
8395     ? US"missing } at end of string - could be header name not terminated by colon"
8396     : US"missing } at end of string";
8397   goto EXPAND_FAILED;
8398   }
8399
8400 /* Expansion succeeded; yield may still be NULL here if nothing was actually
8401 added to the string. If so, set up an empty string. Add a terminating zero. If
8402 left != NULL, return a pointer to the terminator. */
8403
8404  {
8405   uschar * res;
8406
8407   if (!yield)
8408     yield = string_get(1);
8409   res = string_from_gstring(yield);
8410   if (left) *left = s;
8411
8412   /* Any stacking store that was used above the final string is no longer needed.
8413   In many cases the final string will be the first one that was got and so there
8414   will be optimal store usage. */
8415
8416   if (resetok) gstring_release_unused(yield);
8417   else if (resetok_p) *resetok_p = FALSE;
8418
8419   DEBUG(D_expand)
8420     {
8421     BOOL tainted = is_tainted(res);
8422     DEBUG(D_noutf8)
8423       {
8424       debug_printf_indent("|--expanding: %.*s\n", (int)(s - string), string);
8425       debug_printf_indent("%sresult: %s\n",
8426         flags & ESI_SKIPPING ? "|-----" : "\\_____", res);
8427       if (tainted)
8428         {
8429         debug_printf_indent("%s     \\__", flags & ESI_SKIPPING ? "|     " : "      ");
8430         debug_print_taint(res);
8431         }
8432       if (flags & ESI_SKIPPING)
8433         debug_printf_indent("\\___skipping: result is not used\n");
8434       }
8435     else
8436       {
8437       debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
8438         "expanding: %.*s\n",
8439         (int)(s - string), string);
8440       debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8441         "result: %s\n",
8442         flags & ESI_SKIPPING ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8443         res);
8444       if (tainted)
8445         {
8446         debug_printf_indent("%s",
8447           flags & ESI_SKIPPING
8448           ? UTF8_VERT "             " : "           " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
8449         debug_print_taint(res);
8450         }
8451       if (flags & ESI_SKIPPING)
8452         debug_printf_indent(UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8453           "skipping: result is not used\n");
8454       }
8455     }
8456   if (textonly_p) *textonly_p = textonly;
8457   expand_level--;
8458   return res;
8459  }
8460
8461 /* This is the failure exit: easiest to program with a goto. We still need
8462 to update the pointer to the terminator, for cases of nested calls with "fail".
8463 */
8464
8465 EXPAND_FAILED_CURLY:
8466 if (malformed_header)
8467   expand_string_message =
8468     US"missing or misplaced { or } - could be header name not terminated by colon";
8469
8470 else if (!expand_string_message || !*expand_string_message)
8471   expand_string_message = US"missing or misplaced { or }";
8472
8473 /* At one point, Exim reset the store to yield (if yield was not NULL), but
8474 that is a bad idea, because expand_string_message is in dynamic store. */
8475
8476 EXPAND_FAILED:
8477 if (left) *left = s;
8478 DEBUG(D_expand)
8479   {
8480   DEBUG(D_noutf8)
8481     {
8482     debug_printf_indent("|failed to expand: %s\n", string);
8483     debug_printf_indent("%serror message: %s\n",
8484       f.expand_string_forcedfail ? "|---" : "\\___", expand_string_message);
8485     if (f.expand_string_forcedfail)
8486       debug_printf_indent("\\failure was forced\n");
8487     }
8488   else
8489     {
8490     debug_printf_indent(UTF8_VERT_RIGHT "failed to expand: %s\n",
8491       string);
8492     debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8493       "error message: %s\n",
8494       f.expand_string_forcedfail ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8495       expand_string_message);
8496     if (f.expand_string_forcedfail)
8497       debug_printf_indent(UTF8_UP_RIGHT "failure was forced\n");
8498     }
8499   }
8500 if (resetok_p && !resetok) *resetok_p = FALSE;
8501 expand_level--;
8502 return NULL;
8503 }
8504
8505
8506
8507 /* This is the external function call. Do a quick check for any expansion
8508 metacharacters, and if there are none, just return the input string.
8509
8510 Arguments
8511         the string to be expanded
8512         optional pointer for return boolean indicating no-dynamic-expansions
8513
8514 Returns:  the expanded string, or NULL if expansion failed; if failure was
8515           due to a lookup deferring, search_find_defer will be TRUE
8516 */
8517
8518 const uschar *
8519 expand_string_2(const uschar * string, BOOL * textonly_p)
8520 {
8521 if (Ustrpbrk(string, "$\\") != NULL)
8522   {
8523   int old_pool = store_pool;
8524   uschar * s;
8525
8526   f.search_find_defer = FALSE;
8527   malformed_header = FALSE;
8528   store_pool = POOL_MAIN;
8529     s = expand_string_internal(string, ESI_HONOR_DOLLAR, NULL, NULL, textonly_p);
8530   store_pool = old_pool;
8531   return s;
8532   }
8533 if (textonly_p) *textonly_p = TRUE;
8534 return string;
8535 }
8536
8537 const uschar *
8538 expand_cstring(const uschar * string)
8539 { return expand_string_2(string, NULL); }
8540
8541 uschar *
8542 expand_string(uschar * string)
8543 { return US expand_string_2(CUS string, NULL); }
8544
8545
8546
8547
8548
8549
8550 /*************************************************
8551 *              Expand and copy                   *
8552 *************************************************/
8553
8554 /* Now and again we want to expand a string and be sure that the result is in a
8555 new bit of store. This function does that.
8556 Since we know it has been copied, the de-const cast is safe.
8557
8558 Argument: the string to be expanded
8559 Returns:  the expanded string, always in a new bit of store, or NULL
8560 */
8561
8562 uschar *
8563 expand_string_copy(const uschar *string)
8564 {
8565 const uschar *yield = expand_cstring(string);
8566 if (yield == string) yield = string_copy(string);
8567 return US yield;
8568 }
8569
8570
8571
8572 /*************************************************
8573 *        Expand and interpret as an integer      *
8574 *************************************************/
8575
8576 /* Expand a string, and convert the result into an integer.
8577
8578 Arguments:
8579   string  the string to be expanded
8580   isplus  TRUE if a non-negative number is expected
8581
8582 Returns:  the integer value, or
8583           -1 for an expansion error               ) in both cases, message in
8584           -2 for an integer interpretation error  ) expand_string_message
8585           expand_string_message is set NULL for an OK integer
8586 */
8587
8588 int_eximarith_t
8589 expand_string_integer(uschar *string, BOOL isplus)
8590 {
8591 return expanded_string_integer(expand_string(string), isplus);
8592 }
8593
8594
8595 /*************************************************
8596  *         Interpret string as an integer        *
8597  *************************************************/
8598
8599 /* Convert a string (that has already been expanded) into an integer.
8600
8601 This function is used inside the expansion code.
8602
8603 Arguments:
8604   s       the string to be expanded
8605   isplus  TRUE if a non-negative number is expected
8606
8607 Returns:  the integer value, or
8608           -1 if string is NULL (which implies an expansion error)
8609           -2 for an integer interpretation error
8610           expand_string_message is set NULL for an OK integer
8611 */
8612
8613 static int_eximarith_t
8614 expanded_string_integer(const uschar *s, BOOL isplus)
8615 {
8616 int_eximarith_t value;
8617 uschar *msg = US"invalid integer \"%s\"";
8618 uschar *endptr;
8619
8620 /* If expansion failed, expand_string_message will be set. */
8621
8622 if (!s) return -1;
8623
8624 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
8625 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
8626 systems, so we set it zero ourselves. */
8627
8628 errno = 0;
8629 expand_string_message = NULL;               /* Indicates no error */
8630
8631 /* Before Exim 4.64, strings consisting entirely of whitespace compared
8632 equal to 0.  Unfortunately, people actually relied upon that, so preserve
8633 the behaviour explicitly.  Stripping leading whitespace is a harmless
8634 noop change since strtol skips it anyway (provided that there is a number
8635 to find at all). */
8636 if (isspace(*s))
8637   if (Uskip_whitespace(&s) == '\0')
8638     {
8639       DEBUG(D_expand)
8640        debug_printf_indent("treating blank string as number 0\n");
8641       return 0;
8642     }
8643
8644 value = strtoll(CS s, CSS &endptr, 10);
8645
8646 if (endptr == s)
8647   msg = US"integer expected but \"%s\" found";
8648 else if (value < 0 && isplus)
8649   msg = US"non-negative integer expected but \"%s\" found";
8650 else
8651   {
8652   switch (tolower(*endptr))
8653     {
8654     default:
8655       break;
8656     case 'k':
8657       if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
8658       else value *= 1024;
8659       endptr++;
8660       break;
8661     case 'm':
8662       if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
8663       else value *= 1024*1024;
8664       endptr++;
8665       break;
8666     case 'g':
8667       if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
8668       else value *= 1024*1024*1024;
8669       endptr++;
8670       break;
8671     }
8672   if (errno == ERANGE)
8673     msg = US"absolute value of integer \"%s\" is too large (overflow)";
8674   else
8675     if (Uskip_whitespace(&endptr) == 0) return value;
8676   }
8677
8678 expand_string_message = string_sprintf(CS msg, s);
8679 return -2;
8680 }
8681
8682
8683 /* These values are usually fixed boolean values, but they are permitted to be
8684 expanded strings.
8685
8686 Arguments:
8687   addr       address being routed
8688   mtype      the module type
8689   mname      the module name
8690   dbg_opt    debug selectors
8691   oname      the option name
8692   bvalue     the router's boolean value
8693   svalue     the router's string value
8694   rvalue     where to put the returned value
8695
8696 Returns:     OK     value placed in rvalue
8697              DEFER  expansion failed
8698 */
8699
8700 int
8701 exp_bool(address_item *addr,
8702   uschar *mtype, uschar *mname, unsigned dbg_opt,
8703   uschar *oname, BOOL bvalue,
8704   uschar *svalue, BOOL *rvalue)
8705 {
8706 uschar *expanded;
8707 if (!svalue) { *rvalue = bvalue; return OK; }
8708
8709 if (!(expanded = expand_string(svalue)))
8710   {
8711   if (f.expand_string_forcedfail)
8712     {
8713     DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
8714     *rvalue = bvalue;
8715     return OK;
8716     }
8717   addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
8718       oname, mname, mtype, expand_string_message);
8719   DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
8720   return DEFER;
8721   }
8722
8723 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
8724   expanded);
8725
8726 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
8727   *rvalue = TRUE;
8728 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
8729   *rvalue = FALSE;
8730 else
8731   {
8732   addr->message = string_sprintf("\"%s\" is not a valid value for the "
8733     "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
8734   return DEFER;
8735   }
8736
8737 return OK;
8738 }
8739
8740
8741
8742 /* Avoid potentially exposing a password in a string about to be logged */
8743
8744 uschar *
8745 expand_hide_passwords(uschar * s)
8746 {
8747 return (  (  Ustrstr(s, "failed to expand") != NULL
8748           || Ustrstr(s, "expansion of ")    != NULL
8749           )
8750        && (  Ustrstr(s, "mysql")   != NULL
8751           || Ustrstr(s, "pgsql")   != NULL
8752           || Ustrstr(s, "redis")   != NULL
8753           || Ustrstr(s, "sqlite")  != NULL
8754           || Ustrstr(s, "ldap:")   != NULL
8755           || Ustrstr(s, "ldaps:")  != NULL
8756           || Ustrstr(s, "ldapi:")  != NULL
8757           || Ustrstr(s, "ldapdn:") != NULL
8758           || Ustrstr(s, "ldapm:")  != NULL
8759        )  )
8760   ? US"Temporary internal error" : s;
8761 }
8762
8763
8764 /* Read given named file into big_buffer.  Use for keying material etc.
8765 The content will have an ascii NUL appended.
8766
8767 Arguments:
8768  filename       as it says
8769
8770 Return:  pointer to buffer, or NULL on error.
8771 */
8772
8773 uschar *
8774 expand_file_big_buffer(const uschar * filename)
8775 {
8776 int fd, off = 0, len;
8777
8778 if ((fd = exim_open2(CS filename, O_RDONLY)) < 0)
8779   {
8780   log_write(0, LOG_MAIN | LOG_PANIC, "unable to open file for reading: %s",
8781              filename);
8782   return NULL;
8783   }
8784
8785 do
8786   {
8787   if ((len = read(fd, big_buffer + off, big_buffer_size - 2 - off)) < 0)
8788     {
8789     (void) close(fd);
8790     log_write(0, LOG_MAIN|LOG_PANIC, "unable to read file: %s", filename);
8791     return NULL;
8792     }
8793   off += len;
8794   }
8795 while (len > 0);
8796
8797 (void) close(fd);
8798 big_buffer[off] = '\0';
8799 return big_buffer;
8800 }
8801
8802
8803
8804 /*************************************************
8805 * Error-checking for testsuite                   *
8806 *************************************************/
8807 typedef struct {
8808   uschar *      region_start;
8809   uschar *      region_end;
8810   const uschar *var_name;
8811   const uschar *var_data;
8812 } err_ctx;
8813
8814 /* Called via tree_walk, which allows nonconst name/data.  Our usage is const. */
8815 static void
8816 assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
8817 {
8818 err_ctx * e = ctx;
8819 if (var_data >= e->region_start  &&  var_data < e->region_end)
8820   {
8821   e->var_name = CUS var_name;
8822   e->var_data = CUS var_data;
8823   }
8824 }
8825
8826 void
8827 assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
8828 {
8829 err_ctx e = { .region_start = ptr, .region_end = US ptr + len,
8830               .var_name = NULL, .var_data = NULL };
8831
8832 /* check acl_ variables */
8833 tree_walk(acl_var_c, assert_variable_notin, &e);
8834 tree_walk(acl_var_m, assert_variable_notin, &e);
8835
8836 /* check auth<n> variables.
8837 assert_variable_notin() treats as const, so deconst is safe. */
8838 for (int i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
8839   assert_variable_notin(US"auth<n>", US auth_vars[i], &e);
8840
8841 #ifdef WITH_CONTENT_SCAN
8842 /* check regex<n> variables. assert_variable_notin() treats as const. */
8843 for (int i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
8844   assert_variable_notin(US"regex<n>", US regex_vars[i], &e);
8845 #endif
8846
8847 /* check known-name variables */
8848 for (var_entry * v = var_table; v < var_table + nelem(var_table); v++)
8849   if (v->type == vtype_stringptr)
8850     assert_variable_notin(US v->name, *(USS v->value), &e);
8851
8852 /* check dns and address trees */
8853 tree_walk(tree_dns_fails,     assert_variable_notin, &e);
8854 tree_walk(tree_duplicates,    assert_variable_notin, &e);
8855 tree_walk(tree_nonrecipients, assert_variable_notin, &e);
8856 tree_walk(tree_unusable,      assert_variable_notin, &e);
8857
8858 if (e.var_name)
8859   log_write(0, LOG_MAIN|LOG_PANIC_DIE,
8860     "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
8861     e.var_name, filename, linenumber, e.var_data);
8862 }
8863
8864
8865
8866 /*************************************************
8867 **************************************************
8868 *             Stand-alone test program           *
8869 **************************************************
8870 *************************************************/
8871
8872 #ifdef STAND_ALONE
8873
8874
8875 BOOL
8876 regex_match_and_setup(const pcre2_code *re, uschar *subject, int options, int setup)
8877 {
8878 int ovec[3*(EXPAND_MAXN+1)];
8879 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
8880   ovec, nelem(ovec));
8881 BOOL yield = n >= 0;
8882 if (n == 0) n = EXPAND_MAXN + 1;
8883 if (yield)
8884   {
8885   expand_nmax = setup < 0 ? 0 : setup + 1;
8886   for (int nn = setup < 0 ? 0 : 2; nn < n*2; nn += 2)
8887     {
8888     expand_nstring[expand_nmax] = subject + ovec[nn];
8889     expand_nlength[expand_nmax++] = ovec[nn+1] - ovec[nn];
8890     }
8891   expand_nmax--;
8892   }
8893 return yield;
8894 }
8895
8896
8897 int main(int argc, uschar **argv)
8898 {
8899 uschar buffer[1024];
8900
8901 debug_selector = D_v;
8902 debug_file = stderr;
8903 debug_fd = fileno(debug_file);
8904 big_buffer = malloc(big_buffer_size);
8905 store_init();
8906
8907 for (int i = 1; i < argc; i++)
8908   {
8909   if (argv[i][0] == '+')
8910     {
8911     debug_trace_memory = 2;
8912     argv[i]++;
8913     }
8914   if (isdigit(argv[i][0]))
8915     debug_selector = Ustrtol(argv[i], NULL, 0);
8916   else
8917     if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
8918         Ustrlen(argv[i]))
8919       {
8920 #ifdef LOOKUP_LDAP
8921       eldap_default_servers = argv[i];
8922 #endif
8923 #ifdef LOOKUP_MYSQL
8924       mysql_servers = argv[i];
8925 #endif
8926 #ifdef LOOKUP_PGSQL
8927       pgsql_servers = argv[i];
8928 #endif
8929 #ifdef LOOKUP_REDIS
8930       redis_servers = argv[i];
8931 #endif
8932       }
8933 #ifdef EXIM_PERL
8934   else opt_perl_startup = argv[i];
8935 #endif
8936   }
8937
8938 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
8939
8940 expand_nstring[1] = US"string 1....";
8941 expand_nlength[1] = 8;
8942 expand_nmax = 1;
8943
8944 #ifdef EXIM_PERL
8945 if (opt_perl_startup != NULL)
8946   {
8947   uschar *errstr;
8948   printf("Starting Perl interpreter\n");
8949   errstr = init_perl(opt_perl_startup);
8950   if (errstr != NULL)
8951     {
8952     printf("** error in perl_startup code: %s\n", errstr);
8953     return EXIT_FAILURE;
8954     }
8955   }
8956 #endif /* EXIM_PERL */
8957
8958 /* Thie deliberately regards the input as untainted, so that it can be
8959 expanded; only reasonable since this is a test for string-expansions. */
8960
8961 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
8962   {
8963   rmark reset_point = store_mark();
8964   uschar *yield = expand_string(buffer);
8965   if (yield)
8966     printf("%s\n", yield);
8967   else
8968     {
8969     if (f.search_find_defer) printf("search_find deferred\n");
8970     printf("Failed: %s\n", expand_string_message);
8971     if (f.expand_string_forcedfail) printf("Forced failure\n");
8972     printf("\n");
8973     }
8974   store_reset(reset_point);
8975   }
8976
8977 search_tidyup();
8978
8979 return 0;
8980 }
8981
8982 #endif  /*STAND_ALONE*/
8983
8984 #endif  /*!MACRO_PREDEF*/
8985 /* vi: aw ai sw=2
8986 */
8987 /* End of expand.c */