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 = SPOOL_DATA_START_OFFSET;
2041       int len = message_body_visible;
2042
2043       if (len > message_size) len = message_size;
2044       *ss = body = store_get(len+1, GET_TAINTED);
2045       body[0] = 0;
2046       if (vp->type == vtype_msgbody_end)
2047         {
2048         struct stat statbuf;
2049         if (fstat(deliver_datafile, &statbuf) == 0)
2050           {
2051           start_offset = statbuf.st_size - len;
2052           if (start_offset < SPOOL_DATA_START_OFFSET)
2053             start_offset = SPOOL_DATA_START_OFFSET;
2054           }
2055         }
2056       if (lseek(deliver_datafile, start_offset, SEEK_SET) < 0)
2057         log_write(0, LOG_MAIN|LOG_PANIC_DIE, "deliver_datafile lseek: %s",
2058           strerror(errno));
2059       if ((len = read(deliver_datafile, body, len)) > 0)
2060         {
2061         body[len] = 0;
2062         if (message_body_newlines)   /* Separate loops for efficiency */
2063           while (len > 0)
2064             { if (body[--len] == 0) body[len] = ' '; }
2065         else
2066           while (len > 0)
2067             { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
2068         }
2069       }
2070     return *ss ? *ss : US"";
2071
2072   case vtype_todbsdin:                       /* BSD inbox time of day */
2073     return tod_stamp(tod_bsdin);
2074
2075   case vtype_tode:                           /* Unix epoch time of day */
2076     return tod_stamp(tod_epoch);
2077
2078   case vtype_todel:                          /* Unix epoch/usec time of day */
2079     return tod_stamp(tod_epoch_l);
2080
2081   case vtype_todf:                           /* Full time of day */
2082     return tod_stamp(tod_full);
2083
2084   case vtype_todl:                           /* Log format time of day */
2085     return tod_stamp(tod_log_bare);            /* (without timezone) */
2086
2087   case vtype_todzone:                        /* Time zone offset only */
2088     return tod_stamp(tod_zone);
2089
2090   case vtype_todzulu:                        /* Zulu time */
2091     return tod_stamp(tod_zulu);
2092
2093   case vtype_todlf:                          /* Log file datestamp tod */
2094     return tod_stamp(tod_log_datestamp_daily);
2095
2096   case vtype_reply:                          /* Get reply address */
2097     s = find_header(US"reply-to:", newsize,
2098                 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2099                 headers_charset);
2100     if (s) Uskip_whitespace(&s);
2101     if (!s || !*s)
2102       {
2103       *newsize = 0;                            /* For the *s==0 case */
2104       s = find_header(US"from:", newsize,
2105                 exists_only ? FH_EXISTS_ONLY|FH_WANT_RAW : FH_WANT_RAW,
2106                 headers_charset);
2107       }
2108     if (s)
2109       {
2110       uschar *t;
2111       Uskip_whitespace(&s);
2112       for (t = s; *t; t++) if (*t == '\n') *t = ' ';
2113       while (t > s && isspace(t[-1])) t--;
2114       *t = 0;
2115       }
2116     return s ? s : US"";
2117
2118   case vtype_string_func:
2119     {
2120     stringptr_fn_t * fn = (stringptr_fn_t *) val;
2121     uschar* s = fn();
2122     return s ? s : US"";
2123     }
2124
2125   case vtype_pspace:
2126     {
2127     int inodes;
2128     sprintf(CS var_buffer, PR_EXIM_ARITH,
2129       receive_statvfs(val == (void *)TRUE, &inodes));
2130     }
2131   return var_buffer;
2132
2133   case vtype_pinodes:
2134     {
2135     int inodes;
2136     (void) receive_statvfs(val == (void *)TRUE, &inodes);
2137     sprintf(CS var_buffer, "%d", inodes);
2138     }
2139   return var_buffer;
2140
2141   case vtype_cert:
2142     return *(void **)val ? US"<cert>" : US"";
2143
2144 #ifndef DISABLE_DKIM
2145   case vtype_dkim:
2146     return dkim_exim_expand_query((int)(long)val);
2147 #endif
2148
2149   }
2150
2151 return NULL;  /* Unknown variable. Silences static checkers. */
2152 }
2153
2154
2155
2156
2157 void
2158 modify_variable(uschar *name, void * value)
2159 {
2160 var_entry * vp;
2161 if ((vp = find_var_ent(name))) vp->value = value;
2162 return;          /* Unknown variable name, fail silently */
2163 }
2164
2165
2166
2167
2168
2169
2170 /*************************************************
2171 *           Read and expand substrings           *
2172 *************************************************/
2173
2174 /* This function is called to read and expand argument substrings for various
2175 expansion items. Some have a minimum requirement that is less than the maximum;
2176 in these cases, the first non-present one is set to NULL.
2177
2178 Arguments:
2179   sub        points to vector of pointers to set
2180   n          maximum number of substrings
2181   m          minimum required
2182   sptr       points to current string pointer
2183   flags
2184    skipping   the skipping flag
2185   check_end  if TRUE, check for final '}'
2186   name       name of item, for error message
2187   resetok    if not NULL, pointer to flag - write FALSE if unsafe to reset
2188              the store
2189   textonly_p if not NULL, pointer to bitmask of which subs were text-only
2190              (did not change when expended)
2191
2192 Returns:     -1 OK; string pointer updated, but in "skipping" mode
2193              0 OK; string pointer updated
2194              1 curly bracketing error (too few arguments)
2195              2 too many arguments (only if check_end is set); message set
2196              3 other error (expansion failure)
2197 */
2198
2199 static int
2200 read_subs(uschar ** sub, int n, int m, const uschar ** sptr, esi_flags flags,
2201   BOOL check_end, uschar * name, BOOL * resetok, unsigned * textonly_p)
2202 {
2203 const uschar * s = *sptr;
2204 unsigned textonly_l = 0;
2205
2206 Uskip_whitespace(&s);
2207 for (int i = 0; i < n; i++)
2208   {
2209   BOOL textonly;
2210   if (*s != '{')
2211     {
2212     if (i < m)
2213       {
2214       expand_string_message = string_sprintf("Not enough arguments for '%s' "
2215         "(min is %d)", name, m);
2216       return 1;
2217       }
2218     sub[i] = NULL;
2219     break;
2220     }
2221   if (!(sub[i] = expand_string_internal(s+1,
2222           ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags & ESI_SKIPPING, &s, resetok,
2223           textonly_p ? &textonly : NULL)))
2224     return 3;
2225   if (*s++ != '}') return 1;
2226   if (textonly_p && textonly) textonly_l |= BIT(i);
2227   Uskip_whitespace(&s);
2228   }                                             /*{*/
2229 if (check_end && *s++ != '}')
2230   {
2231   if (s[-1] == '{')
2232     {
2233     expand_string_message = string_sprintf("Too many arguments for '%s' "
2234       "(max is %d)", name, n);
2235     return 2;
2236     }
2237   expand_string_message = string_sprintf("missing '}' after '%s'", name);
2238   return 1;
2239   }
2240
2241 if (textonly_p) *textonly_p = textonly_l;
2242 *sptr = s;
2243 return flags & ESI_SKIPPING ? -1 : 0;
2244 }
2245
2246
2247
2248
2249 /*************************************************
2250 *     Elaborate message for bad variable         *
2251 *************************************************/
2252
2253 /* For the "unknown variable" message, take a look at the variable's name, and
2254 give additional information about possible ACL variables. The extra information
2255 is added on to expand_string_message.
2256
2257 Argument:   the name of the variable
2258 Returns:    nothing
2259 */
2260
2261 static void
2262 check_variable_error_message(uschar *name)
2263 {
2264 if (Ustrncmp(name, "acl_", 4) == 0)
2265   expand_string_message = string_sprintf("%s (%s)", expand_string_message,
2266     (name[4] == 'c' || name[4] == 'm')?
2267       (isalpha(name[5])?
2268         US"6th character of a user-defined ACL variable must be a digit or underscore" :
2269         US"strict_acl_vars is set"    /* Syntax is OK, it has to be this */
2270       ) :
2271       US"user-defined ACL variables must start acl_c or acl_m");
2272 }
2273
2274
2275
2276 /*
2277 Load args from sub array to globals, and call acl_check().
2278 Sub array will be corrupted on return.
2279
2280 Returns:       OK         access is granted by an ACCEPT verb
2281                DISCARD    access is (apparently) granted by a DISCARD verb
2282                FAIL       access is denied
2283                FAIL_DROP  access is denied; drop the connection
2284                DEFER      can't tell at the moment
2285                ERROR      disaster
2286 */
2287 static int
2288 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
2289 {
2290 int i;
2291 int sav_narg = acl_narg;
2292 int ret;
2293 uschar * dummy_logmsg;
2294 extern int acl_where;
2295
2296 if(--nsub > nelem(acl_arg)) nsub = nelem(acl_arg);
2297 for (i = 0; i < nsub && sub[i+1]; i++)
2298   {
2299   uschar * tmp = acl_arg[i];
2300   acl_arg[i] = sub[i+1];        /* place callers args in the globals */
2301   sub[i+1] = tmp;               /* stash the old args using our caller's storage */
2302   }
2303 acl_narg = i;
2304 while (i < nsub)
2305   {
2306   sub[i+1] = acl_arg[i];
2307   acl_arg[i++] = NULL;
2308   }
2309
2310 DEBUG(D_expand)
2311   debug_printf_indent("expanding: acl: %s  arg: %s%s\n",
2312     sub[0],
2313     acl_narg>0 ? acl_arg[0] : US"<none>",
2314     acl_narg>1 ? " +more"   : "");
2315
2316 ret = acl_eval(acl_where, sub[0], user_msgp, &dummy_logmsg);
2317
2318 for (i = 0; i < nsub; i++)
2319   acl_arg[i] = sub[i+1];        /* restore old args */
2320 acl_narg = sav_narg;
2321
2322 return ret;
2323 }
2324
2325
2326
2327
2328 /* Return pointer to dewrapped string, with enclosing specified chars removed.
2329 The given string is modified on return.  Leading whitespace is skipped while
2330 looking for the opening wrap character, then the rest is scanned for the trailing
2331 (non-escaped) wrap character.  A backslash in the string will act as an escape.
2332
2333 A nul is written over the trailing wrap, and a pointer to the char after the
2334 leading wrap is returned.
2335
2336 Arguments:
2337   s     String for de-wrapping
2338   wrap  Two-char string, the first being the opener, second the closer wrapping
2339         character
2340 Return:
2341   Pointer to de-wrapped string, or NULL on error (with expand_string_message set).
2342 */
2343
2344 static uschar *
2345 dewrap(uschar * s, const uschar * wrap)
2346 {
2347 uschar * p = s;
2348 unsigned depth = 0;
2349 BOOL quotesmode = wrap[0] == wrap[1];
2350
2351 if (Uskip_whitespace(&p) == *wrap)
2352   {
2353   s = ++p;
2354   wrap++;
2355   while (*p)
2356     {
2357     if (*p == '\\') p++;
2358     else if (!quotesmode && *p == wrap[-1]) depth++;
2359     else if (*p == *wrap)
2360       if (depth == 0)
2361         {
2362         *p = '\0';
2363         return s;
2364         }
2365       else
2366         depth--;
2367     p++;
2368     }
2369   }
2370 expand_string_message = string_sprintf("missing '%c'", *wrap);
2371 return NULL;
2372 }
2373
2374
2375 /* Pull off the leading array or object element, returning
2376 a copy in an allocated string.  Update the list pointer.
2377
2378 The element may itself be an abject or array.
2379 Return NULL when the list is empty.
2380 */
2381
2382 static uschar *
2383 json_nextinlist(const uschar ** list)
2384 {
2385 unsigned array_depth = 0, object_depth = 0;
2386 const uschar * s = *list, * item;
2387
2388 skip_whitespace(&s);
2389
2390 for (item = s;
2391      *s && (*s != ',' || array_depth != 0 || object_depth != 0);
2392      s++)
2393   switch (*s)
2394     {
2395     case '[': array_depth++; break;
2396     case ']': array_depth--; break;
2397     case '{': object_depth++; break;
2398     case '}': object_depth--; break;
2399     }
2400 *list = *s ? s+1 : s;
2401 if (item == s) return NULL;
2402 item = string_copyn(item, s - item);
2403 DEBUG(D_expand) debug_printf_indent("  json ele: '%s'\n", item);
2404 return US item;
2405 }
2406
2407
2408
2409 /************************************************/
2410 /*  Return offset in ops table, or -1 if not found.
2411 Repoint to just after the operator in the string.
2412
2413 Argument:
2414  ss     string representation of operator
2415  opname split-out operator name
2416 */
2417
2418 static int
2419 identify_operator(const uschar ** ss, uschar ** opname)
2420 {
2421 const uschar * s = *ss;
2422 uschar name[256];
2423
2424 /* Numeric comparisons are symbolic */
2425
2426 if (*s == '=' || *s == '>' || *s == '<')
2427   {
2428   int p = 0;
2429   name[p++] = *s++;
2430   if (*s == '=')
2431     {
2432     name[p++] = '=';
2433     s++;
2434     }
2435   name[p] = 0;
2436   }
2437
2438 /* All other conditions are named */
2439
2440 else
2441   s = read_name(name, sizeof(name), s, US"_");
2442 *ss = s;
2443
2444 /* If we haven't read a name, it means some non-alpha character is first. */
2445
2446 if (!name[0])
2447   {
2448   expand_string_message = string_sprintf("condition name expected, "
2449     "but found \"%.16s\"", s);
2450   return -1;
2451   }
2452 if (opname)
2453   *opname = string_copy(name);
2454
2455 return chop_match(name, cond_table, nelem(cond_table));
2456 }
2457
2458
2459 /*************************************************
2460 *    Handle MD5 or SHA-1 computation for HMAC    *
2461 *************************************************/
2462
2463 /* These are some wrapping functions that enable the HMAC code to be a bit
2464 cleaner. A good compiler will spot the tail recursion.
2465
2466 Arguments:
2467   type         HMAC_MD5 or HMAC_SHA1
2468   remaining    are as for the cryptographic hash functions
2469
2470 Returns:       nothing
2471 */
2472
2473 static void
2474 chash_start(int type, void * base)
2475 {
2476 if (type == HMAC_MD5)
2477   md5_start((md5 *)base);
2478 else
2479   sha1_start((hctx *)base);
2480 }
2481
2482 static void
2483 chash_mid(int type, void * base, const uschar * string)
2484 {
2485 if (type == HMAC_MD5)
2486   md5_mid((md5 *)base, string);
2487 else
2488   sha1_mid((hctx *)base, string);
2489 }
2490
2491 static void
2492 chash_end(int type, void * base, const uschar * string, int length,
2493   uschar * digest)
2494 {
2495 if (type == HMAC_MD5)
2496   md5_end((md5 *)base, string, length, digest);
2497 else
2498   sha1_end((hctx *)base, string, length, digest);
2499 }
2500
2501
2502
2503
2504 #ifdef SUPPORT_SRS
2505 /* Do an hmac_md5.  The result is _not_ nul-terminated, and is sized as
2506 the smaller of a full hmac_md5 result (16 bytes) or the supplied output buffer.
2507
2508 Arguments:
2509         key     encoding key, nul-terminated
2510         src     data to be hashed, nul-terminated
2511         buf     output buffer
2512         len     size of output buffer
2513 */
2514
2515 static void
2516 hmac_md5(const uschar * key, const uschar * src, uschar * buf, unsigned len)
2517 {
2518 md5 md5_base;
2519 const uschar * keyptr;
2520 uschar * p;
2521 unsigned int keylen;
2522
2523 #define MD5_HASHLEN      16
2524 #define MD5_HASHBLOCKLEN 64
2525
2526 uschar keyhash[MD5_HASHLEN];
2527 uschar innerhash[MD5_HASHLEN];
2528 uschar finalhash[MD5_HASHLEN];
2529 uschar innerkey[MD5_HASHBLOCKLEN];
2530 uschar outerkey[MD5_HASHBLOCKLEN];
2531
2532 keyptr = key;
2533 keylen = Ustrlen(keyptr);
2534
2535 /* If the key is longer than the hash block length, then hash the key
2536 first */
2537
2538 if (keylen > MD5_HASHBLOCKLEN)
2539   {
2540   chash_start(HMAC_MD5, &md5_base);
2541   chash_end(HMAC_MD5, &md5_base, keyptr, keylen, keyhash);
2542   keyptr = keyhash;
2543   keylen = MD5_HASHLEN;
2544   }
2545
2546 /* Now make the inner and outer key values */
2547
2548 memset(innerkey, 0x36, MD5_HASHBLOCKLEN);
2549 memset(outerkey, 0x5c, MD5_HASHBLOCKLEN);
2550
2551 for (int i = 0; i < keylen; i++)
2552   {
2553   innerkey[i] ^= keyptr[i];
2554   outerkey[i] ^= keyptr[i];
2555   }
2556
2557 /* Now do the hashes */
2558
2559 chash_start(HMAC_MD5, &md5_base);
2560 chash_mid(HMAC_MD5, &md5_base, innerkey);
2561 chash_end(HMAC_MD5, &md5_base, src, Ustrlen(src), innerhash);
2562
2563 chash_start(HMAC_MD5, &md5_base);
2564 chash_mid(HMAC_MD5, &md5_base, outerkey);
2565 chash_end(HMAC_MD5, &md5_base, innerhash, MD5_HASHLEN, finalhash);
2566
2567 /* Encode the final hash as a hex string, limited by output buffer size */
2568
2569 p = buf;
2570 for (int i = 0, j = len; i < MD5_HASHLEN; i++)
2571   {
2572   if (j-- <= 0) break;
2573   *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
2574   if (j-- <= 0) break;
2575   *p++ = hex_digits[finalhash[i] & 0x0f];
2576   }
2577 return;
2578 }
2579 #endif /*SUPPORT_SRS*/
2580
2581
2582 /*************************************************
2583 *        Read and evaluate a condition           *
2584 *************************************************/
2585
2586 /*
2587 Arguments:
2588   s        points to the start of the condition text
2589   resetok  points to a BOOL which is written false if it is unsafe to
2590            free memory. Certain condition types (acl) may have side-effect
2591            allocation which must be preserved.
2592   yield    points to a BOOL to hold the result of the condition test;
2593            if NULL, we are just reading through a condition that is
2594            part of an "or" combination to check syntax, or in a state
2595            where the answer isn't required
2596
2597 Returns:   a pointer to the first character after the condition, or
2598            NULL after an error
2599 */
2600
2601 static const uschar *
2602 eval_condition(const uschar * s, BOOL * resetok, BOOL * yield)
2603 {
2604 BOOL testfor = TRUE;
2605 BOOL tempcond, combined_cond;
2606 BOOL * subcondptr;
2607 BOOL sub2_honour_dollar = TRUE;
2608 BOOL is_forany, is_json, is_jsons;
2609 int rc, cond_type;
2610 int_eximarith_t num[2];
2611 struct stat statbuf;
2612 uschar * opname;
2613 uschar name[256];
2614 const uschar * sub[10];
2615 unsigned sub_textonly = 0;
2616
2617 for (;;)
2618   if (Uskip_whitespace(&s) == '!') { testfor = !testfor; s++; } else break;
2619
2620 switch(cond_type = identify_operator(&s, &opname))
2621   {
2622   /* def: tests for a non-empty variable, or for the existence of a header. If
2623   yield == NULL we are in a skipping state, and don't care about the answer. */
2624
2625   case ECOND_DEF:
2626     {
2627     const uschar * t;
2628
2629     if (*s != ':')
2630       {
2631       expand_string_message = US"\":\" expected after \"def\"";
2632       return NULL;
2633       }
2634
2635     s = read_name(name, sizeof(name), s+1, US"_");
2636
2637     /* Test for a header's existence. If the name contains a closing brace
2638     character, this may be a user error where the terminating colon has been
2639     omitted. Set a flag to adjust a subsequent error message in this case. */
2640
2641     if (  ( *(t = name) == 'h'
2642           || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
2643           )
2644        && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
2645        )
2646       {
2647       s = read_header_name(name, sizeof(name), s);
2648       /* {-for-text-editors */
2649       if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2650       if (yield) *yield =
2651         (find_header(name, NULL, FH_EXISTS_ONLY, NULL) != NULL) == testfor;
2652       }
2653
2654     /* Test for a variable's having a non-empty value. A non-existent variable
2655     causes an expansion failure. */
2656
2657     else
2658       {
2659       if (!(t = find_variable(name, TRUE, yield == NULL, NULL)))
2660         {
2661         expand_string_message = name[0]
2662           ? string_sprintf("unknown variable \"%s\" after \"def:\"", name)
2663           : US"variable name omitted after \"def:\"";
2664         check_variable_error_message(name);
2665         return NULL;
2666         }
2667       if (yield) *yield = (t[0] != 0) == testfor;
2668       }
2669
2670     return s;
2671     }
2672
2673
2674   /* first_delivery tests for first delivery attempt */
2675
2676   case ECOND_FIRST_DELIVERY:
2677   if (yield) *yield = f.deliver_firsttime == testfor;
2678   return s;
2679
2680
2681   /* queue_running tests for any process started by a queue runner */
2682
2683   case ECOND_QUEUE_RUNNING:
2684   if (yield) *yield = (queue_run_pid != (pid_t)0) == testfor;
2685   return s;
2686
2687
2688   /* exists:  tests for file existence
2689        isip:  tests for any IP address
2690       isip4:  tests for an IPv4 address
2691       isip6:  tests for an IPv6 address
2692         pam:  does PAM authentication
2693      radius:  does RADIUS authentication
2694    ldapauth:  does LDAP authentication
2695     pwcheck:  does Cyrus SASL pwcheck authentication
2696   */
2697
2698   case ECOND_EXISTS:
2699   case ECOND_ISIP:
2700   case ECOND_ISIP4:
2701   case ECOND_ISIP6:
2702   case ECOND_PAM:
2703   case ECOND_RADIUS:
2704   case ECOND_LDAPAUTH:
2705   case ECOND_PWCHECK:
2706
2707   if (Uskip_whitespace(&s) != '{') goto COND_FAILED_CURLY_START; /* }-for-text-editors */
2708
2709    {
2710     BOOL textonly;
2711     sub[0] = expand_string_internal(s+1,
2712       ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yield ? ESI_NOFLAGS : ESI_SKIPPING),
2713       &s, resetok, &textonly);
2714     if (!sub[0]) return NULL;
2715     if (textonly) sub_textonly |= BIT(0);
2716    }
2717   /* {-for-text-editors */
2718   if (*s++ != '}') goto COND_FAILED_CURLY_END;
2719
2720   if (!yield) return s;   /* No need to run the test if skipping */
2721
2722   switch(cond_type)
2723     {
2724     case ECOND_EXISTS:
2725     if ((expand_forbid & RDO_EXISTS) != 0)
2726       {
2727       expand_string_message = US"File existence tests are not permitted";
2728       return NULL;
2729       }
2730     *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2731     break;
2732
2733     case ECOND_ISIP:
2734     case ECOND_ISIP4:
2735     case ECOND_ISIP6:
2736     rc = string_is_ip_address(sub[0], NULL);
2737     *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2738              (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2739     break;
2740
2741     /* Various authentication tests - all optionally compiled */
2742
2743     case ECOND_PAM:
2744     #ifdef SUPPORT_PAM
2745     rc = auth_call_pam(sub[0], &expand_string_message);
2746     goto END_AUTH;
2747     #else
2748     goto COND_FAILED_NOT_COMPILED;
2749     #endif  /* SUPPORT_PAM */
2750
2751     case ECOND_RADIUS:
2752     #ifdef RADIUS_CONFIG_FILE
2753     rc = auth_call_radius(sub[0], &expand_string_message);
2754     goto END_AUTH;
2755     #else
2756     goto COND_FAILED_NOT_COMPILED;
2757     #endif  /* RADIUS_CONFIG_FILE */
2758
2759     case ECOND_LDAPAUTH:
2760     #ifdef LOOKUP_LDAP
2761       {
2762       /* Just to keep the interface the same */
2763       BOOL do_cache;
2764       int old_pool = store_pool;
2765       store_pool = POOL_SEARCH;
2766       rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2767         &expand_string_message, &do_cache);
2768       store_pool = old_pool;
2769       }
2770     goto END_AUTH;
2771     #else
2772     goto COND_FAILED_NOT_COMPILED;
2773     #endif  /* LOOKUP_LDAP */
2774
2775     case ECOND_PWCHECK:
2776     #ifdef CYRUS_PWCHECK_SOCKET
2777     rc = auth_call_pwcheck(sub[0], &expand_string_message);
2778     goto END_AUTH;
2779     #else
2780     goto COND_FAILED_NOT_COMPILED;
2781     #endif  /* CYRUS_PWCHECK_SOCKET */
2782
2783     #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2784         defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2785     END_AUTH:
2786     if (rc == ERROR || rc == DEFER) return NULL;
2787     *yield = (rc == OK) == testfor;
2788     #endif
2789     }
2790   return s;
2791
2792
2793   /* call ACL (in a conditional context).  Accept true, deny false.
2794   Defer is a forced-fail.  Anything set by message= goes to $value.
2795   Up to ten parameters are used; we use the braces round the name+args
2796   like the saslauthd condition does, to permit a variable number of args.
2797   See also the expansion-item version EITEM_ACL and the traditional
2798   acl modifier ACLC_ACL.
2799   Since the ACL may allocate new global variables, tell our caller to not
2800   reclaim memory.
2801   */
2802
2803   case ECOND_ACL:
2804     /* ${if acl {{name}{arg1}{arg2}...}  {yes}{no}} */
2805     {
2806     uschar *sub[10];
2807     uschar *user_msg;
2808     BOOL cond = FALSE;
2809
2810     Uskip_whitespace(&s);
2811     if (*s++ != '{') goto COND_FAILED_CURLY_START;      /*}*/
2812
2813     switch(read_subs(sub, nelem(sub), 1, &s,
2814         yield ? ESI_NOFLAGS : ESI_SKIPPING, TRUE, name, resetok, NULL))
2815       {
2816       case 1: expand_string_message = US"too few arguments or bracketing "
2817         "error for acl";
2818       case 2:
2819       case 3: return NULL;
2820       }
2821
2822     if (yield)
2823       {
2824       int rc;
2825       *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2826       switch(rc = eval_acl(sub, nelem(sub), &user_msg))
2827         {
2828         case OK:
2829           cond = TRUE;
2830         case FAIL:
2831           lookup_value = NULL;
2832           if (user_msg)
2833             lookup_value = string_copy(user_msg);
2834           *yield = cond == testfor;
2835           break;
2836
2837         case DEFER:
2838           f.expand_string_forcedfail = TRUE;
2839           /*FALLTHROUGH*/
2840         default:
2841           expand_string_message = string_sprintf("%s from acl \"%s\"",
2842             rc_names[rc], sub[0]);
2843           return NULL;
2844         }
2845       }
2846     return s;
2847     }
2848
2849
2850   /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2851
2852      ${if saslauthd {{username}{password}{service}{realm}}  {yes}{no}}
2853
2854   However, the last two are optional. That is why the whole set is enclosed
2855   in their own set of braces. */
2856
2857   case ECOND_SASLAUTHD:
2858 #ifndef CYRUS_SASLAUTHD_SOCKET
2859     goto COND_FAILED_NOT_COMPILED;
2860 #else
2861     {
2862     uschar *sub[4];
2863     Uskip_whitespace(&s);
2864     if (*s++ != '{') goto COND_FAILED_CURLY_START;      /* }-for-text-editors */
2865     switch(read_subs(sub, nelem(sub), 2, &s,
2866         yield ? ESI_NOFLAGS : ESI_SKIPPING, TRUE, name, resetok, NULL))
2867       {
2868       case 1: expand_string_message = US"too few arguments or bracketing "
2869         "error for saslauthd";
2870       case 2:
2871       case 3: return NULL;
2872       }
2873     if (!sub[2]) sub[3] = NULL;  /* realm if no service */
2874     if (yield)
2875       {
2876       int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2877         &expand_string_message);
2878       if (rc == ERROR || rc == DEFER) return NULL;
2879       *yield = (rc == OK) == testfor;
2880       }
2881     return s;
2882     }
2883 #endif /* CYRUS_SASLAUTHD_SOCKET */
2884
2885
2886   /* symbolic operators for numeric and string comparison, and a number of
2887   other operators, all requiring two arguments.
2888
2889   crypteq:           encrypts plaintext and compares against an encrypted text,
2890                        using crypt(), crypt16(), MD5 or SHA-1
2891   inlist/inlisti:    checks if first argument is in the list of the second
2892   match:             does a regular expression match and sets up the numerical
2893                        variables if it succeeds
2894   match_address:     matches in an address list
2895   match_domain:      matches in a domain list
2896   match_ip:          matches a host list that is restricted to IP addresses
2897   match_local_part:  matches in a local part list
2898   */
2899
2900   case ECOND_MATCH_ADDRESS:
2901   case ECOND_MATCH_DOMAIN:
2902   case ECOND_MATCH_IP:
2903   case ECOND_MATCH_LOCAL_PART:
2904 #ifndef EXPAND_LISTMATCH_RHS
2905     sub2_honour_dollar = FALSE;
2906 #endif
2907     /* FALLTHROUGH */
2908
2909   case ECOND_CRYPTEQ:
2910   case ECOND_INLIST:
2911   case ECOND_INLISTI:
2912   case ECOND_MATCH:
2913
2914   case ECOND_NUM_L:     /* Numerical comparisons */
2915   case ECOND_NUM_LE:
2916   case ECOND_NUM_E:
2917   case ECOND_NUM_EE:
2918   case ECOND_NUM_G:
2919   case ECOND_NUM_GE:
2920
2921   case ECOND_STR_LT:    /* String comparisons */
2922   case ECOND_STR_LTI:
2923   case ECOND_STR_LE:
2924   case ECOND_STR_LEI:
2925   case ECOND_STR_EQ:
2926   case ECOND_STR_EQI:
2927   case ECOND_STR_GT:
2928   case ECOND_STR_GTI:
2929   case ECOND_STR_GE:
2930   case ECOND_STR_GEI:
2931
2932   for (int i = 0; i < 2; i++)
2933     {
2934     BOOL textonly;
2935     /* Sometimes, we don't expand substrings; too many insecure configurations
2936     created using match_address{}{} and friends, where the second param
2937     includes information from untrustworthy sources. */
2938     /*XXX is this moot given taint-tracking? */
2939
2940     esi_flags flags = ESI_BRACE_ENDS;
2941
2942     if (!(i > 0 && !sub2_honour_dollar)) flags |= ESI_HONOR_DOLLAR;
2943     if (!yield) flags |= ESI_SKIPPING;
2944
2945     if (Uskip_whitespace(&s) != '{')
2946       {
2947       if (i == 0) goto COND_FAILED_CURLY_START;
2948       expand_string_message = string_sprintf("missing 2nd string in {} "
2949         "after \"%s\"", opname);
2950       return NULL;
2951       }
2952     if (!(sub[i] = expand_string_internal(s+1, flags, &s, resetok, &textonly)))
2953       return NULL;
2954     if (textonly) sub_textonly |= BIT(i);
2955     DEBUG(D_expand) if (i == 1 && !sub2_honour_dollar && Ustrchr(sub[1], '$'))
2956       debug_printf_indent("WARNING: the second arg is NOT expanded,"
2957                         " for security reasons\n");
2958     if (*s++ != '}') goto COND_FAILED_CURLY_END;
2959
2960     /* Convert to numerical if required; we know that the names of all the
2961     conditions that compare numbers do not start with a letter. This just saves
2962     checking for them individually. */
2963
2964     if (!isalpha(opname[0]) && yield)
2965       if (sub[i][0] == 0)
2966         {
2967         num[i] = 0;
2968         DEBUG(D_expand)
2969           debug_printf_indent("empty string cast to zero for numerical comparison\n");
2970         }
2971       else
2972         {
2973         num[i] = expanded_string_integer(sub[i], FALSE);
2974         if (expand_string_message) return NULL;
2975         }
2976     }
2977
2978   /* Result not required */
2979
2980   if (!yield) return s;
2981
2982   /* Do an appropriate comparison */
2983
2984   switch(cond_type)
2985     {
2986     case ECOND_NUM_E:
2987     case ECOND_NUM_EE:
2988       tempcond = (num[0] == num[1]); break;
2989
2990     case ECOND_NUM_G:
2991       tempcond = (num[0] > num[1]); break;
2992
2993     case ECOND_NUM_GE:
2994       tempcond = (num[0] >= num[1]); break;
2995
2996     case ECOND_NUM_L:
2997       tempcond = (num[0] < num[1]); break;
2998
2999     case ECOND_NUM_LE:
3000       tempcond = (num[0] <= num[1]); break;
3001
3002     case ECOND_STR_LT:
3003       tempcond = (Ustrcmp(sub[0], sub[1]) < 0); break;
3004
3005     case ECOND_STR_LTI:
3006       tempcond = (strcmpic(sub[0], sub[1]) < 0); break;
3007
3008     case ECOND_STR_LE:
3009       tempcond = (Ustrcmp(sub[0], sub[1]) <= 0); break;
3010
3011     case ECOND_STR_LEI:
3012       tempcond = (strcmpic(sub[0], sub[1]) <= 0); break;
3013
3014     case ECOND_STR_EQ:
3015       tempcond = (Ustrcmp(sub[0], sub[1]) == 0); break;
3016
3017     case ECOND_STR_EQI:
3018       tempcond = (strcmpic(sub[0], sub[1]) == 0); break;
3019
3020     case ECOND_STR_GT:
3021       tempcond = (Ustrcmp(sub[0], sub[1]) > 0); break;
3022
3023     case ECOND_STR_GTI:
3024       tempcond = (strcmpic(sub[0], sub[1]) > 0); break;
3025
3026     case ECOND_STR_GE:
3027       tempcond = (Ustrcmp(sub[0], sub[1]) >= 0); break;
3028
3029     case ECOND_STR_GEI:
3030       tempcond = (strcmpic(sub[0], sub[1]) >= 0); break;
3031
3032     case ECOND_MATCH:   /* Regular expression match */
3033       {
3034       const pcre2_code * re = regex_compile(sub[1],
3035                   sub_textonly & BIT(1) ? MCS_CACHEABLE : MCS_NOFLAGS,
3036                   &expand_string_message, pcre_gen_cmp_ctx);
3037       if (!re)
3038         return NULL;
3039
3040       tempcond = regex_match_and_setup(re, sub[0], 0, -1);
3041       break;
3042       }
3043
3044     case ECOND_MATCH_ADDRESS:  /* Match in an address list */
3045       rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0,
3046                               CUSS &lookup_value);
3047       goto MATCHED_SOMETHING;
3048
3049     case ECOND_MATCH_DOMAIN:   /* Match in a domain list */
3050       rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
3051         MCL_DOMAIN + MCL_NOEXPAND, TRUE, CUSS &lookup_value);
3052       goto MATCHED_SOMETHING;
3053
3054     case ECOND_MATCH_IP:       /* Match IP address in a host list */
3055       if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
3056         {
3057         expand_string_message = string_sprintf("\"%s\" is not an IP address",
3058           sub[0]);
3059         return NULL;
3060         }
3061       else
3062         {
3063         unsigned int *nullcache = NULL;
3064         check_host_block cb;
3065
3066         cb.host_name = US"";
3067         cb.host_address = sub[0];
3068
3069         /* If the host address starts off ::ffff: it is an IPv6 address in
3070         IPv4-compatible mode. Find the IPv4 part for checking against IPv4
3071         addresses. */
3072
3073         cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
3074           cb.host_address + 7 : cb.host_address;
3075
3076         rc = match_check_list(
3077                &sub[1],                   /* the list */
3078                0,                         /* separator character */
3079                &hostlist_anchor,          /* anchor pointer */
3080                &nullcache,                /* cache pointer */
3081                check_host,                /* function for testing */
3082                &cb,                       /* argument for function */
3083                MCL_HOST,                  /* type of check */
3084                sub[0],                    /* text for debugging */
3085                CUSS &lookup_value);       /* where to pass back data */
3086         }
3087       goto MATCHED_SOMETHING;
3088
3089     case ECOND_MATCH_LOCAL_PART:
3090       rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
3091         MCL_LOCALPART + MCL_NOEXPAND, TRUE, CUSS &lookup_value);
3092       /* Fall through */
3093       /* VVVVVVVVVVVV */
3094       MATCHED_SOMETHING:
3095       switch(rc)
3096         {
3097         case OK:   tempcond = TRUE;  break;
3098         case FAIL: tempcond = FALSE; break;
3099
3100         case DEFER:
3101           expand_string_message = string_sprintf("unable to complete match "
3102             "against \"%s\": %s", sub[1], search_error_message);
3103           return NULL;
3104         }
3105
3106       break;
3107
3108     /* Various "encrypted" comparisons. If the second string starts with
3109     "{" then an encryption type is given. Default to crypt() or crypt16()
3110     (build-time choice). */
3111     /* }-for-text-editors */
3112
3113     case ECOND_CRYPTEQ:
3114     #ifndef SUPPORT_CRYPTEQ
3115       goto COND_FAILED_NOT_COMPILED;
3116     #else
3117       if (strncmpic(sub[1], US"{md5}", 5) == 0)
3118         {
3119         int sublen = Ustrlen(sub[1]+5);
3120         md5 base;
3121         uschar digest[16];
3122
3123         md5_start(&base);
3124         md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
3125
3126         /* If the length that we are comparing against is 24, the MD5 digest
3127         is expressed as a base64 string. This is the way LDAP does it. However,
3128         some other software uses a straightforward hex representation. We assume
3129         this if the length is 32. Other lengths fail. */
3130
3131         if (sublen == 24)
3132           {
3133           uschar *coded = b64encode(CUS digest, 16);
3134           DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
3135             "  subject=%s\n  crypted=%s\n", coded, sub[1]+5);
3136           tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
3137           }
3138         else if (sublen == 32)
3139           {
3140           uschar coded[36];
3141           for (int i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
3142           coded[32] = 0;
3143           DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
3144             "  subject=%s\n  crypted=%s\n", coded, sub[1]+5);
3145           tempcond = (strcmpic(coded, sub[1]+5) == 0);
3146           }
3147         else
3148           {
3149           DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
3150             "fail\n  crypted=%s\n", sub[1]+5);
3151           tempcond = FALSE;
3152           }
3153         }
3154
3155       else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
3156         {
3157         int sublen = Ustrlen(sub[1]+6);
3158         hctx h;
3159         uschar digest[20];
3160
3161         sha1_start(&h);
3162         sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
3163
3164         /* If the length that we are comparing against is 28, assume the SHA1
3165         digest is expressed as a base64 string. If the length is 40, assume a
3166         straightforward hex representation. Other lengths fail. */
3167
3168         if (sublen == 28)
3169           {
3170           uschar *coded = b64encode(CUS digest, 20);
3171           DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
3172             "  subject=%s\n  crypted=%s\n", coded, sub[1]+6);
3173           tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
3174           }
3175         else if (sublen == 40)
3176           {
3177           uschar coded[44];
3178           for (int i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
3179           coded[40] = 0;
3180           DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
3181             "  subject=%s\n  crypted=%s\n", coded, sub[1]+6);
3182           tempcond = (strcmpic(coded, sub[1]+6) == 0);
3183           }
3184         else
3185           {
3186           DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
3187             "fail\n  crypted=%s\n", sub[1]+6);
3188           tempcond = FALSE;
3189           }
3190         }
3191
3192       else   /* {crypt} or {crypt16} and non-{ at start */
3193              /* }-for-text-editors */
3194         {
3195         int which = 0;
3196         uschar *coded;
3197
3198         if (strncmpic(sub[1], US"{crypt}", 7) == 0)
3199           {
3200           sub[1] += 7;
3201           which = 1;
3202           }
3203         else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
3204           {
3205           sub[1] += 9;
3206           which = 2;
3207           }
3208         else if (sub[1][0] == '{')              /* }-for-text-editors */
3209           {
3210           expand_string_message = string_sprintf("unknown encryption mechanism "
3211             "in \"%s\"", sub[1]);
3212           return NULL;
3213           }
3214
3215         switch(which)
3216           {
3217           case 0:  coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
3218           case 1:  coded = US crypt(CS sub[0], CS sub[1]); break;
3219           default: coded = US crypt16(CS sub[0], CS sub[1]); break;
3220           }
3221
3222         #define STR(s) # s
3223         #define XSTR(s) STR(s)
3224         DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
3225           "  subject=%s\n  crypted=%s\n",
3226           which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
3227           coded, sub[1]);
3228         #undef STR
3229         #undef XSTR
3230
3231         /* If the encrypted string contains fewer than two characters (for the
3232         salt), force failure. Otherwise we get false positives: with an empty
3233         string the yield of crypt() is an empty string! */
3234
3235         if (coded)
3236           tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
3237         else if (errno == EINVAL)
3238           tempcond = FALSE;
3239         else
3240           {
3241           expand_string_message = string_sprintf("crypt error: %s\n",
3242             US strerror(errno));
3243           return NULL;
3244           }
3245         }
3246       break;
3247     #endif  /* SUPPORT_CRYPTEQ */
3248
3249     case ECOND_INLIST:
3250     case ECOND_INLISTI:
3251       {
3252       const uschar * list = sub[1];
3253       int sep = 0;
3254       uschar *save_iterate_item = iterate_item;
3255       int (*compare)(const uschar *, const uschar *);
3256
3257       DEBUG(D_expand) debug_printf_indent("condition: %s  item: %s\n", opname, sub[0]);
3258
3259       tempcond = FALSE;
3260       compare = cond_type == ECOND_INLISTI
3261         ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
3262
3263       while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
3264         {
3265         DEBUG(D_expand) debug_printf_indent(" compare %s\n", iterate_item);
3266         if (compare(sub[0], iterate_item) == 0)
3267           {
3268           tempcond = TRUE;
3269           lookup_value = iterate_item;
3270           break;
3271           }
3272         }
3273       iterate_item = save_iterate_item;
3274       }
3275
3276     }   /* Switch for comparison conditions */
3277
3278   *yield = tempcond == testfor;
3279   return s;    /* End of comparison conditions */
3280
3281
3282   /* and/or: computes logical and/or of several conditions */
3283
3284   case ECOND_AND:
3285   case ECOND_OR:
3286   subcondptr = (yield == NULL) ? NULL : &tempcond;
3287   combined_cond = (cond_type == ECOND_AND);
3288
3289   Uskip_whitespace(&s);
3290   if (*s++ != '{') goto COND_FAILED_CURLY_START;        /* }-for-text-editors */
3291
3292   for (;;)
3293     {
3294     /* {-for-text-editors */
3295     if (Uskip_whitespace(&s) == '}') break;
3296     if (*s != '{')                                      /* }-for-text-editors */
3297       {
3298       expand_string_message = string_sprintf("each subcondition "
3299         "inside an \"%s{...}\" condition must be in its own {}", opname);
3300       return NULL;
3301       }
3302
3303     if (!(s = eval_condition(s+1, resetok, subcondptr)))
3304       {
3305       expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
3306         expand_string_message, opname);
3307       return NULL;
3308       }
3309     Uskip_whitespace(&s);
3310
3311     /* {-for-text-editors */
3312     if (*s++ != '}')
3313       {
3314       /* {-for-text-editors */
3315       expand_string_message = string_sprintf("missing } at end of condition "
3316         "inside \"%s\" group", opname);
3317       return NULL;
3318       }
3319
3320     if (yield)
3321       if (cond_type == ECOND_AND)
3322         {
3323         combined_cond &= tempcond;
3324         if (!combined_cond) subcondptr = NULL;  /* once false, don't */
3325         }                                       /* evaluate any more */
3326       else
3327         {
3328         combined_cond |= tempcond;
3329         if (combined_cond) subcondptr = NULL;   /* once true, don't */
3330         }                                       /* evaluate any more */
3331     }
3332
3333   if (yield) *yield = (combined_cond == testfor);
3334   return ++s;
3335
3336
3337   /* forall/forany: iterates a condition with different values */
3338
3339   case ECOND_FORALL:      is_forany = FALSE;  is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3340   case ECOND_FORANY:      is_forany = TRUE;   is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3341   case ECOND_FORALL_JSON: is_forany = FALSE;  is_json = TRUE;  is_jsons = FALSE; goto FORMANY;
3342   case ECOND_FORANY_JSON: is_forany = TRUE;   is_json = TRUE;  is_jsons = FALSE; goto FORMANY;
3343   case ECOND_FORALL_JSONS: is_forany = FALSE; is_json = TRUE;  is_jsons = TRUE;  goto FORMANY;
3344   case ECOND_FORANY_JSONS: is_forany = TRUE;  is_json = TRUE;  is_jsons = TRUE;  goto FORMANY;
3345
3346   FORMANY:
3347     {
3348     const uschar * list;
3349     int sep = 0;
3350     uschar *save_iterate_item = iterate_item;
3351
3352     DEBUG(D_expand) debug_printf_indent("condition: %s\n", opname);
3353
3354     Uskip_whitespace(&s);
3355     if (*s++ != '{') goto COND_FAILED_CURLY_START;      /* }-for-text-editors */
3356     if (!(sub[0] = expand_string_internal(s,
3357       ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yield ? ESI_NOFLAGS : ESI_SKIPPING),
3358       &s, resetok, NULL)))
3359       return NULL;
3360     /* {-for-text-editors */
3361     if (*s++ != '}') goto COND_FAILED_CURLY_END;
3362
3363     Uskip_whitespace(&s);
3364     if (*s++ != '{') goto COND_FAILED_CURLY_START;      /* }-for-text-editors */
3365
3366     sub[1] = s;
3367
3368     /* Call eval_condition once, with result discarded (as if scanning a
3369     "false" part). This allows us to find the end of the condition, because if
3370     the list it empty, we won't actually evaluate the condition for real. */
3371
3372     if (!(s = eval_condition(sub[1], resetok, NULL)))
3373       {
3374       expand_string_message = string_sprintf("%s inside \"%s\" condition",
3375         expand_string_message, opname);
3376       return NULL;
3377       }
3378     Uskip_whitespace(&s);
3379
3380     /* {-for-text-editors */
3381     if (*s++ != '}')
3382       {
3383       /* {-for-text-editors */
3384       expand_string_message = string_sprintf("missing } at end of condition "
3385         "inside \"%s\"", opname);
3386       return NULL;
3387       }
3388
3389     if (yield) *yield = !testfor;
3390     list = sub[0];
3391     if (is_json) list = dewrap(string_copy(list), US"[]");
3392     while ((iterate_item = is_json
3393       ? json_nextinlist(&list) : string_nextinlist(&list, &sep, NULL, 0)))
3394       {
3395       if (is_jsons)
3396         if (!(iterate_item = dewrap(iterate_item, US"\"\"")))
3397           {
3398           expand_string_message =
3399             string_sprintf("%s wrapping string result for extract jsons",
3400               expand_string_message);
3401           iterate_item = save_iterate_item;
3402           return NULL;
3403           }
3404
3405       DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", opname, iterate_item);
3406       if (!eval_condition(sub[1], resetok, &tempcond))
3407         {
3408         expand_string_message = string_sprintf("%s inside \"%s\" condition",
3409           expand_string_message, opname);
3410         iterate_item = save_iterate_item;
3411         return NULL;
3412         }
3413       DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", opname,
3414         tempcond? "true":"false");
3415
3416       if (yield) *yield = (tempcond == testfor);
3417       if (tempcond == is_forany) break;
3418       }
3419
3420     iterate_item = save_iterate_item;
3421     return s;
3422     }
3423
3424
3425   /* The bool{} expansion condition maps a string to boolean.
3426   The values supported should match those supported by the ACL condition
3427   (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
3428   of true/false.  Note that Router "condition" rules have a different
3429   interpretation, where general data can be used and only a few values
3430   map to FALSE.
3431   Note that readconf.c boolean matching, for boolean configuration options,
3432   only matches true/yes/false/no.
3433   The bool_lax{} condition matches the Router logic, which is much more
3434   liberal. */
3435   case ECOND_BOOL:
3436   case ECOND_BOOL_LAX:
3437     {
3438     uschar *sub_arg[1];
3439     uschar *t, *t2;
3440     uschar *ourname;
3441     size_t len;
3442     BOOL boolvalue = FALSE;
3443
3444     if (Uskip_whitespace(&s) != '{') goto COND_FAILED_CURLY_START;      /* }-for-text-editors */
3445     ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
3446     switch(read_subs(sub_arg, 1, 1, &s,
3447             yield ? ESI_NOFLAGS : ESI_SKIPPING, FALSE, ourname, resetok, NULL))
3448       {
3449       case 1: expand_string_message = string_sprintf(
3450                   "too few arguments or bracketing error for %s",
3451                   ourname);
3452       /*FALLTHROUGH*/
3453       case 2:
3454       case 3: return NULL;
3455       }
3456     t = sub_arg[0];
3457     Uskip_whitespace(&t);
3458     if ((len = Ustrlen(t)))
3459       {
3460       /* trailing whitespace: seems like a good idea to ignore it too */
3461       t2 = t + len - 1;
3462       while (isspace(*t2)) t2--;
3463       if (t2 != (t + len))
3464         {
3465         *++t2 = '\0';
3466         len = t2 - t;
3467         }
3468       }
3469     DEBUG(D_expand)
3470       debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>");
3471     /* logic for the lax case from expand_check_condition(), which also does
3472     expands, and the logic is both short and stable enough that there should
3473     be no maintenance burden from replicating it. */
3474     if (len == 0)
3475       boolvalue = FALSE;
3476     else if (*t == '-'
3477              ? Ustrspn(t+1, "0123456789") == len-1
3478              : Ustrspn(t,   "0123456789") == len)
3479       {
3480       boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3481       /* expand_check_condition only does a literal string "0" check */
3482       if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3483         boolvalue = TRUE;
3484       }
3485     else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3486       boolvalue = TRUE;
3487     else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3488       boolvalue = FALSE;
3489     else if (cond_type == ECOND_BOOL_LAX)
3490       boolvalue = TRUE;
3491     else
3492       {
3493       expand_string_message = string_sprintf("unrecognised boolean "
3494        "value \"%s\"", t);
3495       return NULL;
3496       }
3497     DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname,
3498         boolvalue? "true":"false");
3499     if (yield) *yield = (boolvalue == testfor);
3500     return s;
3501     }
3502
3503 #ifdef SUPPORT_SRS
3504   case ECOND_INBOUND_SRS:
3505     /* ${if inbound_srs {local_part}{secret}  {yes}{no}} */
3506     {
3507     uschar * sub[2];
3508     const pcre2_code * re;
3509     pcre2_match_data * md;
3510     PCRE2_SIZE * ovec;
3511     int quoting = 0;
3512     uschar cksum[4];
3513     BOOL boolvalue = FALSE;
3514
3515     switch(read_subs(sub, 2, 2, CUSS &s,
3516             yield ? ESI_NOFLAGS : ESI_SKIPPING, FALSE, name, resetok, NULL))
3517       {
3518       case 1: expand_string_message = US"too few arguments or bracketing "
3519         "error for inbound_srs";
3520       case 2:
3521       case 3: return NULL;
3522       }
3523
3524     /* Match the given local_part against the SRS-encoded pattern */
3525
3526     re = regex_must_compile(US"^(?i)SRS0=([^=]+)=([A-Z2-7]+)=([^=]*)=(.*)$",
3527                             MCS_CASELESS | MCS_CACHEABLE, FALSE);
3528     md = pcre2_match_data_create(4+1, pcre_gen_ctx);
3529     if (pcre2_match(re, sub[0], PCRE2_ZERO_TERMINATED, 0, PCRE_EOPT,
3530                     md, pcre_gen_mtc_ctx) < 0)
3531       {
3532       DEBUG(D_expand) debug_printf("no match for SRS'd local-part pattern\n");
3533       goto srs_result;
3534       }
3535     ovec = pcre2_get_ovector_pointer(md);
3536
3537     if (sub[0][0] == '"')
3538       quoting = 1;
3539     else for (uschar * s = sub[0]; *s; s++)
3540       if (!isalnum(*s) && Ustrchr(".!#$%&'*+-/=?^_`{|}~", *s) == NULL)
3541         { quoting = 1; break; }
3542     if (quoting)
3543       DEBUG(D_expand) debug_printf_indent("auto-quoting local part\n");
3544
3545     /* Record the (quoted, if needed) decoded recipient as $srs_recipient */
3546
3547     srs_recipient = string_sprintf("%.*s%.*S%.*s@%.*S",         /* lowercased */
3548                       quoting, "\"",
3549                       (int) (ovec[9]-ovec[8]), sub[0] + ovec[8],  /* substr 4 */
3550                       quoting, "\"",
3551                       (int) (ovec[7]-ovec[6]), sub[0] + ovec[6]); /* substr 3 */
3552
3553     /* If a zero-length secret was given, we're done.  Otherwise carry on
3554     and validate the given SRS local_part againt our secret. */
3555
3556     if (!*sub[1])
3557       {
3558       boolvalue = TRUE;
3559       goto srs_result;
3560       }
3561
3562     /* check the timestamp */
3563       {
3564       struct timeval now;
3565       uschar * ss = sub[0] + ovec[4];   /* substring 2, the timestamp */
3566       long d;
3567       int n;
3568
3569       gettimeofday(&now, NULL);
3570       now.tv_sec /= 86400;              /* days since epoch */
3571
3572       /* Decode substring 2 from base32 to a number */
3573
3574       for (d = 0, n = ovec[5]-ovec[4]; n; n--)
3575         {
3576         uschar * t = Ustrchr(base32_chars, *ss++);
3577         d = d * 32 + (t - base32_chars);
3578         }
3579
3580       if (((now.tv_sec - d) & 0x3ff) > 10)      /* days since SRS generated */
3581         {
3582         DEBUG(D_expand) debug_printf("SRS too old\n");
3583         goto srs_result;
3584         }
3585       }
3586
3587     /* check length of substring 1, the offered checksum */
3588
3589     if (ovec[3]-ovec[2] != 4)
3590       {
3591       DEBUG(D_expand) debug_printf("SRS checksum wrong size\n");
3592       goto srs_result;
3593       }
3594
3595     /* Hash the address with our secret, and compare that computed checksum
3596     with the one extracted from the arg */
3597
3598     hmac_md5(sub[1], srs_recipient, cksum, sizeof(cksum));
3599     if (Ustrncmp(cksum, sub[0] + ovec[2], 4) != 0)
3600       {
3601       DEBUG(D_expand) debug_printf("SRS checksum mismatch\n");
3602       goto srs_result;
3603       }
3604     boolvalue = TRUE;
3605
3606 srs_result:
3607     /* pcre2_match_data_free(md);       gen ctx needs no free */
3608     if (yield) *yield = (boolvalue == testfor);
3609     return s;
3610     }
3611 #endif /*SUPPORT_SRS*/
3612
3613   /* Unknown condition */
3614
3615   default:
3616     if (!expand_string_message || !*expand_string_message)
3617       expand_string_message = string_sprintf("unknown condition \"%s\"", opname);
3618     return NULL;
3619   }   /* End switch on condition type */
3620
3621 /* Missing braces at start and end of data */
3622
3623 COND_FAILED_CURLY_START:
3624 expand_string_message = string_sprintf("missing { after \"%s\"", opname);
3625 return NULL;
3626
3627 COND_FAILED_CURLY_END:
3628 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3629   opname);
3630 return NULL;
3631
3632 /* A condition requires code that is not compiled */
3633
3634 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3635     !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3636     !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3637 COND_FAILED_NOT_COMPILED:
3638 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3639   opname);
3640 return NULL;
3641 #endif
3642 }
3643
3644
3645
3646
3647 /*************************************************
3648 *          Save numerical variables              *
3649 *************************************************/
3650
3651 /* This function is called from items such as "if" that want to preserve and
3652 restore the numbered variables.
3653
3654 Arguments:
3655   save_expand_string    points to an array of pointers to set
3656   save_expand_nlength   points to an array of ints for the lengths
3657
3658 Returns:                the value of expand max to save
3659 */
3660
3661 static int
3662 save_expand_strings(const uschar **save_expand_nstring, int *save_expand_nlength)
3663 {
3664 for (int i = 0; i <= expand_nmax; i++)
3665   {
3666   save_expand_nstring[i] = expand_nstring[i];
3667   save_expand_nlength[i] = expand_nlength[i];
3668   }
3669 return expand_nmax;
3670 }
3671
3672
3673
3674 /*************************************************
3675 *           Restore numerical variables          *
3676 *************************************************/
3677
3678 /* This function restored saved values of numerical strings.
3679
3680 Arguments:
3681   save_expand_nmax      the number of strings to restore
3682   save_expand_string    points to an array of pointers
3683   save_expand_nlength   points to an array of ints
3684
3685 Returns:                nothing
3686 */
3687
3688 static void
3689 restore_expand_strings(int save_expand_nmax, const uschar **save_expand_nstring,
3690   int *save_expand_nlength)
3691 {
3692 expand_nmax = save_expand_nmax;
3693 for (int i = 0; i <= expand_nmax; i++)
3694   {
3695   expand_nstring[i] = save_expand_nstring[i];
3696   expand_nlength[i] = save_expand_nlength[i];
3697   }
3698 }
3699
3700
3701
3702
3703
3704 /*************************************************
3705 *            Handle yes/no substrings            *
3706 *************************************************/
3707
3708 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3709 alternative substrings that depend on whether or not the condition was true,
3710 or the lookup or extraction succeeded. The substrings always have to be
3711 expanded, to check their syntax, but "skipping" is set when the result is not
3712 needed - this avoids unnecessary nested lookups.
3713
3714 Arguments:
3715   flags
3716    skipping       TRUE if we were skipping when this item was reached
3717   yes            TRUE if the first string is to be used, else use the second
3718   save_lookup    a value to put back into lookup_value before the 2nd expansion
3719   sptr           points to the input string pointer
3720   yieldptr       points to the output growable-string pointer
3721   type           "lookup", "if", "extract", "run", "env", "listextract" or
3722                  "certextract" for error message
3723   resetok        if not NULL, pointer to flag - write FALSE if unsafe to reset
3724                 the store.
3725
3726 Returns:         0 OK; lookup_value has been reset to save_lookup
3727                  1 expansion failed
3728                  2 expansion failed because of bracketing error
3729 */
3730
3731 static int
3732 process_yesno(esi_flags flags, BOOL yes, uschar *save_lookup, const uschar **sptr,
3733   gstring ** yieldptr, uschar *type, BOOL *resetok)
3734 {
3735 int rc = 0;
3736 const uschar *s = *sptr;    /* Local value */
3737 uschar *sub1, *sub2;
3738 const uschar * errwhere;
3739
3740 flags &= ESI_SKIPPING;          /* Ignore all buf the skipping flag */
3741
3742 /* If there are no following strings, we substitute the contents of $value for
3743 lookups and for extractions in the success case. For the ${if item, the string
3744 "true" is substituted. In the fail case, nothing is substituted for all three
3745 items. */
3746
3747 if (skip_whitespace(&s) == '}')
3748   {
3749   if (type[0] == 'i')
3750     {
3751     if (yes && !(flags & ESI_SKIPPING))
3752       *yieldptr = string_catn(*yieldptr, US"true", 4);
3753     }
3754   else
3755     {
3756     if (yes && lookup_value && !(flags & ESI_SKIPPING))
3757       *yieldptr = string_cat(*yieldptr, lookup_value);
3758     lookup_value = save_lookup;
3759     }
3760   s++;
3761   goto RETURN;
3762   }
3763
3764 /* The first following string must be braced. */
3765
3766 if (*s++ != '{')
3767   {
3768   errwhere = US"'yes' part did not start with '{'";             /*}}*/
3769   goto FAILED_CURLY;
3770   }
3771
3772 /* Expand the first substring. Forced failures are noticed only if we actually
3773 want this string. Set skipping in the call in the fail case (this will always
3774 be the case if we were already skipping). */
3775
3776 sub1 = expand_string_internal(s,
3777   ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yes ? ESI_NOFLAGS : ESI_SKIPPING),
3778   &s, resetok, NULL);
3779 if (sub1 == NULL && (yes || !f.expand_string_forcedfail)) goto FAILED;
3780 f.expand_string_forcedfail = FALSE;
3781                                                                 /*{{*/
3782 if (*s++ != '}')
3783   {
3784   errwhere = US"'yes' part did not end with '}'";
3785   goto FAILED_CURLY;
3786   }
3787
3788 /* If we want the first string, add it to the output */
3789
3790 if (yes)
3791   *yieldptr = string_cat(*yieldptr, sub1);
3792
3793 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3794 $value to what it was at the start of the item, so that it has this value
3795 during the second string expansion. For the call from "if" or "run" to this
3796 function, save_lookup is set to lookup_value, so that this statement does
3797 nothing. */
3798
3799 lookup_value = save_lookup;
3800
3801 /* There now follows either another substring, or "fail", or nothing. This
3802 time, forced failures are noticed only if we want the second string. We must
3803 set skipping in the nested call if we don't want this string, or if we were
3804 already skipping. */
3805
3806 if (skip_whitespace(&s) == '{')                                 /*}*/
3807   {
3808   esi_flags s_flags = ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags;
3809   if (yes) s_flags |= ESI_SKIPPING;
3810   sub2 = expand_string_internal(s+1, s_flags, &s, resetok, NULL);
3811   if (!sub2 && (!yes || !f.expand_string_forcedfail)) goto FAILED;
3812   f.expand_string_forcedfail = FALSE;                           /*{*/
3813   if (*s++ != '}')
3814     {
3815     errwhere = US"'no' part did not start with '{'";            /*}*/
3816     goto FAILED_CURLY;
3817     }
3818
3819   /* If we want the second string, add it to the output */
3820
3821   if (!yes)
3822     *yieldptr = string_cat(*yieldptr, sub2);
3823   }
3824                                                                 /*{{*/
3825 /* If there is no second string, but the word "fail" is present when the use of
3826 the second string is wanted, set a flag indicating it was a forced failure
3827 rather than a syntactic error. Swallow the terminating } in case this is nested
3828 inside another lookup or if or extract. */
3829
3830 else if (*s != '}')
3831   {
3832   uschar name[256];
3833   /* deconst cast ok here as source is s anyway */
3834   s = US read_name(name, sizeof(name), s, US"_");
3835   if (Ustrcmp(name, "fail") == 0)
3836     {
3837     if (!yes && !(flags & ESI_SKIPPING))
3838       {
3839       Uskip_whitespace(&s);                                     /*{{*/
3840       if (*s++ != '}')
3841         {
3842         errwhere = US"did not close with '}' after forcedfail";
3843         goto FAILED_CURLY;
3844         }
3845       expand_string_message =
3846         string_sprintf("\"%s\" failed and \"fail\" requested", type);
3847       f.expand_string_forcedfail = TRUE;
3848       goto FAILED;
3849       }
3850     }
3851   else
3852     {
3853     expand_string_message =
3854       string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3855     goto FAILED;
3856     }
3857   }
3858
3859 /* All we have to do now is to check on the final closing brace. */
3860
3861 skip_whitespace(&s);                                            /*{{*/
3862 if (*s++ != '}')
3863   {
3864   errwhere = US"did not close with '}'";
3865   goto FAILED_CURLY;
3866   }
3867
3868
3869 RETURN:
3870 /* Update the input pointer value before returning */
3871 *sptr = s;
3872 return rc;
3873
3874 FAILED_CURLY:
3875   /* Get here if there is a bracketing failure */
3876   expand_string_message = string_sprintf(
3877     "curly-bracket problem in conditional yes/no parsing: %s\n"
3878     " remaining string is '%s'", errwhere, --s);
3879   rc = 2;
3880   goto RETURN;
3881
3882 FAILED:
3883   /* Get here for other failures */
3884   rc = 1;
3885   goto RETURN;
3886 }
3887
3888
3889
3890
3891 /********************************************************
3892 * prvs: Get last three digits of days since Jan 1, 1970 *
3893 ********************************************************/
3894
3895 /* This is needed to implement the "prvs" BATV reverse
3896    path signing scheme
3897
3898 Argument: integer "days" offset to add or substract to
3899           or from the current number of days.
3900
3901 Returns:  pointer to string containing the last three
3902           digits of the number of days since Jan 1, 1970,
3903           modified by the offset argument, NULL if there
3904           was an error in the conversion.
3905
3906 */
3907
3908 static uschar *
3909 prvs_daystamp(int day_offset)
3910 {
3911 uschar * days = store_get(32, GET_UNTAINTED);      /* Need at least 24 for cases */
3912 (void)string_format(days, 32, TIME_T_FMT,          /* where TIME_T_FMT is %lld */
3913   (time(NULL) + day_offset*86400)/86400);
3914 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3915 }
3916
3917
3918
3919 /********************************************************
3920 *   prvs: perform HMAC-SHA1 computation of prvs bits    *
3921 ********************************************************/
3922
3923 /* This is needed to implement the "prvs" BATV reverse
3924    path signing scheme
3925
3926 Arguments:
3927   address RFC2821 Address to use
3928       key The key to use (must be less than 64 characters
3929           in size)
3930   key_num Single-digit key number to use. Defaults to
3931           '0' when NULL.
3932
3933 Returns:  pointer to string containing the first three
3934           bytes of the final hash in hex format, NULL if
3935           there was an error in the process.
3936 */
3937
3938 static uschar *
3939 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3940 {
3941 gstring * hash_source;
3942 uschar * p;
3943 hctx h;
3944 uschar innerhash[20];
3945 uschar finalhash[20];
3946 uschar innerkey[64];
3947 uschar outerkey[64];
3948 uschar *finalhash_hex;
3949
3950 if (!key_num)
3951   key_num = US"0";
3952
3953 if (Ustrlen(key) > 64)
3954   return NULL;
3955
3956 hash_source = string_catn(NULL, key_num, 1);
3957 hash_source = string_catn(hash_source, daystamp, 3);
3958 hash_source = string_cat(hash_source, address);
3959 (void) string_from_gstring(hash_source);
3960
3961 DEBUG(D_expand)
3962   debug_printf_indent("prvs: hash source is '%s'\n", hash_source->s);
3963
3964 memset(innerkey, 0x36, 64);
3965 memset(outerkey, 0x5c, 64);
3966
3967 for (int i = 0; i < Ustrlen(key); i++)
3968   {
3969   innerkey[i] ^= key[i];
3970   outerkey[i] ^= key[i];
3971   }
3972
3973 chash_start(HMAC_SHA1, &h);
3974 chash_mid(HMAC_SHA1, &h, innerkey);
3975 chash_end(HMAC_SHA1, &h, hash_source->s, hash_source->ptr, innerhash);
3976
3977 chash_start(HMAC_SHA1, &h);
3978 chash_mid(HMAC_SHA1, &h, outerkey);
3979 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
3980
3981 /* Hashing is deemed sufficient to de-taint any input data */
3982
3983 p = finalhash_hex = store_get(40, GET_UNTAINTED);
3984 for (int i = 0; i < 3; i++)
3985   {
3986   *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3987   *p++ = hex_digits[finalhash[i] & 0x0f];
3988   }
3989 *p = '\0';
3990
3991 return finalhash_hex;
3992 }
3993
3994
3995
3996
3997 /*************************************************
3998 *        Join a file onto the output string      *
3999 *************************************************/
4000
4001 /* This is used for readfile/readsock and after a run expansion.
4002 It joins the contents of a file onto the output string, globally replacing
4003 newlines with a given string (optionally).
4004
4005 Arguments:
4006   f            the FILE
4007   yield        pointer to the expandable string struct
4008   eol          newline replacement string, or NULL
4009
4010 Returns:       new pointer for expandable string, terminated if non-null
4011 */
4012
4013 gstring *
4014 cat_file(FILE * f, gstring * yield, uschar * eol)
4015 {
4016 uschar buffer[1024];
4017
4018 while (Ufgets(buffer, sizeof(buffer), f))
4019   {
4020   int len = Ustrlen(buffer);
4021   if (eol && buffer[len-1] == '\n') len--;
4022   yield = string_catn(yield, buffer, len);
4023   if (eol && buffer[len])
4024     yield = string_cat(yield, eol);
4025   }
4026 return yield;
4027 }
4028
4029
4030 #ifndef DISABLE_TLS
4031 gstring *
4032 cat_file_tls(void * tls_ctx, gstring * yield, uschar * eol)
4033 {
4034 int rc;
4035 uschar buffer[1024];
4036
4037 /*XXX could we read direct into a pre-grown string? */
4038
4039 while ((rc = tls_read(tls_ctx, buffer, sizeof(buffer))) > 0)
4040   for (uschar * s = buffer; rc--; s++)
4041     yield = eol && *s == '\n'
4042       ? string_cat(yield, eol) : string_catn(yield, s, 1);
4043
4044 /* We assume that all errors, and any returns of zero bytes,
4045 are actually EOF. */
4046
4047 return yield;
4048 }
4049 #endif
4050
4051
4052 /*************************************************
4053 *          Evaluate numeric expression           *
4054 *************************************************/
4055
4056 /* This is a set of mutually recursive functions that evaluate an arithmetic
4057 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
4058 these functions that is called from elsewhere is eval_expr, whose interface is:
4059
4060 Arguments:
4061   sptr        pointer to the pointer to the string - gets updated
4062   decimal     TRUE if numbers are to be assumed decimal
4063   error       pointer to where to put an error message - must be NULL on input
4064   endket      TRUE if ')' must terminate - FALSE for external call
4065
4066 Returns:      on success: the value of the expression, with *error still NULL
4067               on failure: an undefined value, with *error = a message
4068 */
4069
4070 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
4071
4072
4073 static int_eximarith_t
4074 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
4075 {
4076 uschar *s = *sptr;
4077 int_eximarith_t x = eval_op_or(&s, decimal, error);
4078
4079 if (!*error)
4080   if (endket)
4081     if (*s != ')')
4082       *error = US"expecting closing parenthesis";
4083     else
4084       while (isspace(*++s));
4085   else if (*s)
4086     *error = US"expecting operator";
4087 *sptr = s;
4088 return x;
4089 }
4090
4091
4092 static int_eximarith_t
4093 eval_number(uschar **sptr, BOOL decimal, uschar **error)
4094 {
4095 int c;
4096 int_eximarith_t n;
4097 uschar *s = *sptr;
4098
4099 if (isdigit((c = Uskip_whitespace(&s))))
4100   {
4101   int count;
4102   (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
4103   s += count;
4104   switch (tolower(*s))
4105     {
4106     default: break;
4107     case 'k': n *= 1024; s++; break;
4108     case 'm': n *= 1024*1024; s++; break;
4109     case 'g': n *= 1024*1024*1024; s++; break;
4110     }
4111   Uskip_whitespace(&s);
4112   }
4113 else if (c == '(')
4114   {
4115   s++;
4116   n = eval_expr(&s, decimal, error, 1);
4117   }
4118 else
4119   {
4120   *error = US"expecting number or opening parenthesis";
4121   n = 0;
4122   }
4123 *sptr = s;
4124 return n;
4125 }
4126
4127
4128 static int_eximarith_t
4129 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
4130 {
4131 uschar *s = *sptr;
4132 int_eximarith_t x;
4133 Uskip_whitespace(&s);
4134 if (*s == '+' || *s == '-' || *s == '~')
4135   {
4136   int op = *s++;
4137   x = eval_op_unary(&s, decimal, error);
4138   if (op == '-') x = -x;
4139     else if (op == '~') x = ~x;
4140   }
4141 else
4142   x = eval_number(&s, decimal, error);
4143
4144 *sptr = s;
4145 return x;
4146 }
4147
4148
4149 static int_eximarith_t
4150 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
4151 {
4152 uschar *s = *sptr;
4153 int_eximarith_t x = eval_op_unary(&s, decimal, error);
4154 if (!*error)
4155   {
4156   while (*s == '*' || *s == '/' || *s == '%')
4157     {
4158     int op = *s++;
4159     int_eximarith_t y = eval_op_unary(&s, decimal, error);
4160     if (*error) break;
4161     /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
4162      * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
4163      * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64].  In fact, -N*-M where
4164      * -N*M is INT_MIN will yield INT_MIN.
4165      * Since we don't support floating point, this is somewhat simpler.
4166      * Ideally, we'd return an error, but since we overflow for all other
4167      * arithmetic, consistency suggests otherwise, but what's the correct value
4168      * to use?  There is none.
4169      * The C standard guarantees overflow for unsigned arithmetic but signed
4170      * overflow invokes undefined behaviour; in practice, this is overflow
4171      * except for converting INT_MIN to INT_MAX+1.  We also can't guarantee
4172      * that long/longlong larger than int are available, or we could just work
4173      * with larger types.  We should consider whether to guarantee 32bit eval
4174      * and 64-bit working variables, with errors returned.  For now ...
4175      * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
4176      * can just let the other invalid results occur otherwise, as they have
4177      * until now.  For this one case, we can coerce.
4178      */
4179     if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
4180       {
4181       DEBUG(D_expand)
4182         debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
4183             EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
4184       x = EXIM_ARITH_MAX;
4185       continue;
4186       }
4187     if (op == '*')
4188       x *= y;
4189     else
4190       {
4191       if (y == 0)
4192         {
4193         *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
4194         x = 0;
4195         break;
4196         }
4197       if (op == '/')
4198         x /= y;
4199       else
4200         x %= y;
4201       }
4202     }
4203   }
4204 *sptr = s;
4205 return x;
4206 }
4207
4208
4209 static int_eximarith_t
4210 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
4211 {
4212 uschar *s = *sptr;
4213 int_eximarith_t x = eval_op_mult(&s, decimal, error);
4214 if (!*error)
4215   {
4216   while (*s == '+' || *s == '-')
4217     {
4218     int op = *s++;
4219     int_eximarith_t y = eval_op_mult(&s, decimal, error);
4220     if (*error) break;
4221     if (  (x >=   EXIM_ARITH_MAX/2  && x >=   EXIM_ARITH_MAX/2)
4222        || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
4223       {                 /* over-conservative check */
4224       *error = op == '+'
4225         ? US"overflow in sum" : US"overflow in difference";
4226       break;
4227       }
4228     if (op == '+') x += y; else x -= y;
4229     }
4230   }
4231 *sptr = s;
4232 return x;
4233 }
4234
4235
4236 static int_eximarith_t
4237 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
4238 {
4239 uschar *s = *sptr;
4240 int_eximarith_t x = eval_op_sum(&s, decimal, error);
4241 if (!*error)
4242   {
4243   while ((*s == '<' || *s == '>') && s[1] == s[0])
4244     {
4245     int_eximarith_t y;
4246     int op = *s++;
4247     s++;
4248     y = eval_op_sum(&s, decimal, error);
4249     if (*error) break;
4250     if (op == '<') x <<= y; else x >>= y;
4251     }
4252   }
4253 *sptr = s;
4254 return x;
4255 }
4256
4257
4258 static int_eximarith_t
4259 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
4260 {
4261 uschar *s = *sptr;
4262 int_eximarith_t x = eval_op_shift(&s, decimal, error);
4263 if (!*error)
4264   {
4265   while (*s == '&')
4266     {
4267     int_eximarith_t y;
4268     s++;
4269     y = eval_op_shift(&s, decimal, error);
4270     if (*error) break;
4271     x &= y;
4272     }
4273   }
4274 *sptr = s;
4275 return x;
4276 }
4277
4278
4279 static int_eximarith_t
4280 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
4281 {
4282 uschar *s = *sptr;
4283 int_eximarith_t x = eval_op_and(&s, decimal, error);
4284 if (!*error)
4285   {
4286   while (*s == '^')
4287     {
4288     int_eximarith_t y;
4289     s++;
4290     y = eval_op_and(&s, decimal, error);
4291     if (*error) break;
4292     x ^= y;
4293     }
4294   }
4295 *sptr = s;
4296 return x;
4297 }
4298
4299
4300 static int_eximarith_t
4301 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
4302 {
4303 uschar *s = *sptr;
4304 int_eximarith_t x = eval_op_xor(&s, decimal, error);
4305 if (!*error)
4306   {
4307   while (*s == '|')
4308     {
4309     int_eximarith_t y;
4310     s++;
4311     y = eval_op_xor(&s, decimal, error);
4312     if (*error) break;
4313     x |= y;
4314     }
4315   }
4316 *sptr = s;
4317 return x;
4318 }
4319
4320
4321
4322 /************************************************/
4323 /* Comparison operation for sort expansion.  We need to avoid
4324 re-expanding the fields being compared, so need a custom routine.
4325
4326 Arguments:
4327  cond_type              Comparison operator code
4328  leftarg, rightarg      Arguments for comparison
4329
4330 Return true iff (leftarg compare rightarg)
4331 */
4332
4333 static BOOL
4334 sortsbefore(int cond_type, BOOL alpha_cond,
4335   const uschar * leftarg, const uschar * rightarg)
4336 {
4337 int_eximarith_t l_num, r_num;
4338
4339 if (!alpha_cond)
4340   {
4341   l_num = expanded_string_integer(leftarg, FALSE);
4342   if (expand_string_message) return FALSE;
4343   r_num = expanded_string_integer(rightarg, FALSE);
4344   if (expand_string_message) return FALSE;
4345
4346   switch (cond_type)
4347     {
4348     case ECOND_NUM_G:   return l_num >  r_num;
4349     case ECOND_NUM_GE:  return l_num >= r_num;
4350     case ECOND_NUM_L:   return l_num <  r_num;
4351     case ECOND_NUM_LE:  return l_num <= r_num;
4352     default: break;
4353     }
4354   }
4355 else
4356   switch (cond_type)
4357     {
4358     case ECOND_STR_LT:  return Ustrcmp (leftarg, rightarg) <  0;
4359     case ECOND_STR_LTI: return strcmpic(leftarg, rightarg) <  0;
4360     case ECOND_STR_LE:  return Ustrcmp (leftarg, rightarg) <= 0;
4361     case ECOND_STR_LEI: return strcmpic(leftarg, rightarg) <= 0;
4362     case ECOND_STR_GT:  return Ustrcmp (leftarg, rightarg) >  0;
4363     case ECOND_STR_GTI: return strcmpic(leftarg, rightarg) >  0;
4364     case ECOND_STR_GE:  return Ustrcmp (leftarg, rightarg) >= 0;
4365     case ECOND_STR_GEI: return strcmpic(leftarg, rightarg) >= 0;
4366     default: break;
4367     }
4368 return FALSE;   /* should not happen */
4369 }
4370
4371
4372 /* Expand a named list.  Return false on failure. */
4373 static gstring *
4374 expand_listnamed(gstring * yield, const uschar * name, const uschar * listtype)
4375 {
4376 tree_node *t = NULL;
4377 const uschar * list;
4378 int sep = 0;
4379 uschar * item;
4380 BOOL needsep = FALSE;
4381 #define LISTNAMED_BUF_SIZE 256
4382 uschar b[LISTNAMED_BUF_SIZE];
4383 uschar * buffer = b;
4384
4385 if (*name == '+') name++;
4386 if (!listtype)          /* no-argument version */
4387   {
4388   if (  !(t = tree_search(addresslist_anchor, name))
4389      && !(t = tree_search(domainlist_anchor,  name))
4390      && !(t = tree_search(hostlist_anchor,    name)))
4391     t = tree_search(localpartlist_anchor, name);
4392   }
4393 else switch(*listtype)  /* specific list-type version */
4394   {
4395   case 'a': t = tree_search(addresslist_anchor,   name); break;
4396   case 'd': t = tree_search(domainlist_anchor,    name); break;
4397   case 'h': t = tree_search(hostlist_anchor,      name); break;
4398   case 'l': t = tree_search(localpartlist_anchor, name); break;
4399   default:
4400     expand_string_message = US"bad suffix on \"list\" operator";
4401     return yield;
4402   }
4403
4404 if(!t)
4405   {
4406   expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
4407     name, !listtype?""
4408       : *listtype=='a'?"address "
4409       : *listtype=='d'?"domain "
4410       : *listtype=='h'?"host "
4411       : *listtype=='l'?"localpart "
4412       : 0);
4413   return yield;
4414   }
4415
4416 list = ((namedlist_block *)(t->data.ptr))->string;
4417
4418 /* The list could be quite long so we (re)use a buffer for each element
4419 rather than getting each in new memory */
4420
4421 if (is_tainted(list)) buffer = store_get(LISTNAMED_BUF_SIZE, GET_TAINTED);
4422 while ((item = string_nextinlist(&list, &sep, buffer, LISTNAMED_BUF_SIZE)))
4423   {
4424   uschar * buf = US" : ";
4425   if (needsep)
4426     yield = string_catn(yield, buf, 3);
4427   else
4428     needsep = TRUE;
4429
4430   if (*item == '+')     /* list item is itself a named list */
4431     {
4432     yield = expand_listnamed(yield, item, listtype);
4433     if (expand_string_message)
4434       return yield;
4435     }
4436
4437   else if (sep != ':')  /* item from non-colon-sep list, re-quote for colon list-separator */
4438     {
4439     char tok[3];
4440     tok[0] = sep; tok[1] = ':'; tok[2] = 0;
4441
4442     for(char * cp; cp = strpbrk(CCS item, tok); item = US cp)
4443       {
4444       yield = string_catn(yield, item, cp - CS item);
4445       if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
4446         yield = string_catn(yield, US"::", 2);
4447       else              /* sep in item; should already be doubled; emit once */
4448         {
4449         yield = string_catn(yield, US tok, 1);
4450         if (*cp == sep) cp++;
4451         }
4452       }
4453     yield = string_cat(yield, item);
4454     }
4455   else
4456     yield = string_cat(yield, item);
4457   }
4458 return yield;
4459 }
4460
4461
4462
4463 /************************************************/
4464 static void
4465 debug_expansion_interim(const uschar * what, const uschar * value, int nchar,
4466   BOOL skipping)
4467 {
4468 DEBUG(D_noutf8)
4469   debug_printf_indent("|");
4470 else
4471   debug_printf_indent(UTF8_VERT_RIGHT);
4472
4473 for (int fill = 11 - Ustrlen(what); fill > 0; fill--)
4474   DEBUG(D_noutf8)
4475     debug_printf("-");
4476   else
4477     debug_printf(UTF8_HORIZ);
4478
4479 debug_printf("%s: %.*s\n", what, nchar, value);
4480 if (is_tainted(value))
4481   {
4482   DEBUG(D_noutf8)
4483     debug_printf_indent("%s     \\__", skipping ? "|     " : "      ");
4484   else
4485     debug_printf_indent("%s",
4486       skipping
4487       ? UTF8_VERT "             " : "           " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
4488   debug_printf("(tainted)\n");
4489   }
4490 }
4491
4492
4493 /*************************************************
4494 *                 Expand string                  *
4495 *************************************************/
4496
4497 /* Returns either an unchanged string, or the expanded string in stacking pool
4498 store. Interpreted sequences are:
4499
4500    \...                    normal escaping rules
4501    $name                   substitutes the variable
4502    ${name}                 ditto
4503    ${op:string}            operates on the expanded string value
4504    ${item{arg1}{arg2}...}  expands the args and then does the business
4505                              some literal args are not enclosed in {}
4506
4507 There are now far too many operators and item types to make it worth listing
4508 them here in detail any more.
4509
4510 We use an internal routine recursively to handle embedded substrings. The
4511 external function follows. The yield is NULL if the expansion failed, and there
4512 are two cases: if something collapsed syntactically, or if "fail" was given
4513 as the action on a lookup failure. These can be distinguished by looking at the
4514 variable expand_string_forcedfail, which is TRUE in the latter case.
4515
4516 The skipping flag is set true when expanding a substring that isn't actually
4517 going to be used (after "if" or "lookup") and it prevents lookups from
4518 happening lower down.
4519
4520 Store usage: At start, a store block of the length of the input plus 64
4521 is obtained. This is expanded as necessary by string_cat(), which might have to
4522 get a new block, or might be able to expand the original. At the end of the
4523 function we can release any store above that portion of the yield block that
4524 was actually used. In many cases this will be optimal.
4525
4526 However: if the first item in the expansion is a variable name or header name,
4527 we reset the store before processing it; if the result is in fresh store, we
4528 use that without copying. This is helpful for expanding strings like
4529 $message_headers which can get very long.
4530
4531 There's a problem if a ${dlfunc item has side-effects that cause allocation,
4532 since resetting the store at the end of the expansion will free store that was
4533 allocated by the plugin code as well as the slop after the expanded string. So
4534 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
4535 and, given the acl condition, ${if }. This is an unfortunate consequence of
4536 string expansion becoming too powerful.
4537
4538 Arguments:
4539   string         the string to be expanded
4540   flags
4541    brace_ends     expansion is to stop at }
4542    honour_dollar  TRUE if $ is to be expanded,
4543                   FALSE if it's just another character
4544    skipping       TRUE for recursive calls when the value isn't actually going
4545                   to be used (to allow for optimisation)
4546   left           if not NULL, a pointer to the first character after the
4547                  expansion is placed here (typically used with brace_ends)
4548   resetok_p      if not NULL, pointer to flag - write FALSE if unsafe to reset
4549                  the store.
4550   textonly_p     if not NULL, pointer to flag - write bool for only-met-text
4551
4552 Returns:         NULL if expansion fails:
4553                    expand_string_forcedfail is set TRUE if failure was forced
4554                    expand_string_message contains a textual error message
4555                  a pointer to the expanded string on success
4556 */
4557
4558 static uschar *
4559 expand_string_internal(const uschar * string, esi_flags flags, const uschar ** left,
4560   BOOL *resetok_p, BOOL * textonly_p)
4561 {
4562 rmark reset_point = store_mark();
4563 gstring * yield = string_get(Ustrlen(string) + 64);
4564 int item_type;
4565 const uschar * s = string;
4566 const uschar * save_expand_nstring[EXPAND_MAXN+1];
4567 int save_expand_nlength[EXPAND_MAXN+1];
4568 BOOL resetok = TRUE, first = TRUE, textonly = TRUE;
4569
4570 expand_level++;
4571 f.expand_string_forcedfail = FALSE;
4572 expand_string_message = US"";
4573
4574 if (is_tainted(string))
4575   {
4576   expand_string_message =
4577     string_sprintf("attempt to expand tainted string '%s'", s);
4578   log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4579   goto EXPAND_FAILED;
4580   }
4581
4582 while (*s)
4583   {
4584   uschar name[256];
4585
4586   DEBUG(D_expand)
4587     {
4588     DEBUG(D_noutf8)
4589       debug_printf_indent("%c%s: %s\n",
4590         first ? '/' : '|',
4591         flags & ESI_SKIPPING ? "---scanning" : "considering", s);
4592     else
4593       debug_printf_indent("%s%s: %s\n",
4594         first ? UTF8_DOWN_RIGHT : UTF8_VERT_RIGHT,
4595         flags & ESI_SKIPPING
4596         ? UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ "scanning"
4597         : "considering",
4598         s);
4599     first = FALSE;
4600     }
4601
4602   /* \ escapes the next character, which must exist, or else
4603   the expansion fails. There's a special escape, \N, which causes
4604   copying of the subject verbatim up to the next \N. Otherwise,
4605   the escapes are the standard set. */
4606
4607   if (*s == '\\')
4608     {
4609     if (s[1] == 0)
4610       {
4611       expand_string_message = US"\\ at end of string";
4612       goto EXPAND_FAILED;
4613       }
4614
4615     if (s[1] == 'N')
4616       {
4617       const uschar * t = s + 2;
4618       for (s = t; *s ; s++) if (*s == '\\' && s[1] == 'N') break;
4619
4620       DEBUG(D_expand)
4621         debug_expansion_interim(US"protected", t, (int)(s - t), !!(flags & ESI_SKIPPING));
4622       yield = string_catn(yield, t, s - t);
4623       if (*s) s += 2;
4624       }
4625     else
4626       {
4627       uschar ch[1];
4628       DEBUG(D_expand)
4629         DEBUG(D_noutf8)
4630           debug_printf_indent("|backslashed: '\\%c'\n", s[1]);
4631         else
4632           debug_printf_indent(UTF8_VERT_RIGHT "backslashed: '\\%c'\n", s[1]);
4633       ch[0] = string_interpret_escape(&s);
4634       s++;
4635       yield = string_catn(yield, ch, 1);
4636       }
4637     continue;
4638     }
4639
4640                                                                         /*{{*/
4641   /* Anything other than $ is just copied verbatim, unless we are
4642   looking for a terminating } character. */
4643
4644   if (flags & ESI_BRACE_ENDS && *s == '}') break;
4645
4646   if (*s != '$' || !(flags & ESI_HONOR_DOLLAR))
4647     {
4648     int i = 1;                                                          /*{*/
4649     for (const uschar * t = s+1;
4650         *t && *t != '$' && *t != '}' && *t != '\\'; t++) i++;
4651
4652     DEBUG(D_expand) debug_expansion_interim(US"text", s, i, !!(flags & ESI_SKIPPING));
4653
4654     yield = string_catn(yield, s, i);
4655     s += i;
4656     continue;
4657     }
4658   textonly = FALSE;
4659
4660   /* No { after the $ - must be a plain name or a number for string
4661   match variable. There has to be a fudge for variables that are the
4662   names of header fields preceded by "$header_" because header field
4663   names can contain any printing characters except space and colon.
4664   For those that don't like typing this much, "$h_" is a synonym for
4665   "$header_". A non-existent header yields a NULL value; nothing is
4666   inserted. */  /*}*/
4667
4668   if (isalpha(*++s))
4669     {
4670     const uschar * value;
4671     int newsize = 0, len;
4672     gstring * g = NULL;
4673     uschar * t;
4674
4675     s = read_name(name, sizeof(name), s, US"_");
4676
4677     /* If this is the first thing to be expanded, release the pre-allocated
4678     buffer. */
4679
4680     if (!yield)
4681       g = store_get(sizeof(gstring), GET_UNTAINTED);
4682     else if (yield->ptr == 0)
4683       {
4684       if (resetok) reset_point = store_reset(reset_point);
4685       yield = NULL;
4686       reset_point = store_mark();
4687       g = store_get(sizeof(gstring), GET_UNTAINTED);    /* alloc _before_ calling find_variable() */
4688       }
4689
4690     /* Header */
4691
4692     if (  ( *(t = name) == 'h'
4693           || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
4694           )
4695        && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
4696        )
4697       {
4698       unsigned flags = *name == 'r' ? FH_WANT_RAW
4699                       : *name == 'l' ? FH_WANT_RAW|FH_WANT_LIST
4700                       : 0;
4701       const uschar * charset = *name == 'b' ? NULL : headers_charset;
4702
4703       s = read_header_name(name, sizeof(name), s);
4704       value = find_header(name, &newsize, flags, charset);
4705
4706       /* If we didn't find the header, and the header contains a closing brace
4707       character, this may be a user error where the terminating colon
4708       has been omitted. Set a flag to adjust the error message in this case.
4709       But there is no error here - nothing gets inserted. */
4710
4711       if (!value)
4712         {                                                               /*{*/
4713         if (Ustrchr(name, '}')) malformed_header = TRUE;
4714         continue;
4715         }
4716       }
4717
4718     /* Variable */
4719
4720     else if (!(value = find_variable(name, FALSE, !!(flags & ESI_SKIPPING), &newsize)))
4721       {
4722       expand_string_message =
4723         string_sprintf("unknown variable name \"%s\"", name);
4724         check_variable_error_message(name);
4725       goto EXPAND_FAILED;
4726       }
4727
4728     /* If the data is known to be in a new buffer, newsize will be set to the
4729     size of that buffer. If this is the first thing in an expansion string,
4730     yield will be NULL; just point it at the new store instead of copying. Many
4731     expansion strings contain just one reference, so this is a useful
4732     optimization, especially for humungous headers.  We need to use a gstring
4733     structure that is not allocated after that new-buffer, else a later store
4734     reset in the middle of the buffer will make it inaccessible. */
4735
4736     len = Ustrlen(value);
4737     DEBUG(D_expand) debug_expansion_interim(US"value", value, len, !!(flags & ESI_SKIPPING));
4738     if (!yield && newsize != 0)
4739       {
4740       yield = g;
4741       yield->size = newsize;
4742       yield->ptr = len;
4743       yield->s = US value; /* known to be in new store i.e. a copy, so deconst safe */
4744       }
4745     else
4746       yield = string_catn(yield, value, len);
4747
4748     continue;
4749     }
4750
4751   if (isdigit(*s))              /* A $<n> variable */
4752     {
4753     int n;
4754     s = read_cnumber(&n, s);
4755     if (n >= 0 && n <= expand_nmax)
4756       {
4757       DEBUG(D_expand) debug_expansion_interim(US"value", expand_nstring[n], expand_nlength[n], !!(flags & ESI_SKIPPING));
4758       yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4759       }
4760     continue;
4761     }
4762
4763   /* Otherwise, if there's no '{' after $ it's an error. */             /*}*/
4764
4765   if (*s != '{')                                                        /*}*/
4766     {
4767     expand_string_message = US"$ not followed by letter, digit, or {";  /*}*/
4768     goto EXPAND_FAILED;
4769     }
4770
4771   /* After { there can be various things, but they all start with
4772   an initial word, except for a number for a string match variable. */  /*}*/
4773
4774   if (isdigit(*++s))
4775     {
4776     int n;
4777     s = read_cnumber(&n, s);                                            /*{{*/
4778     if (*s++ != '}')
4779       {
4780       expand_string_message = US"} expected after number";
4781       goto EXPAND_FAILED;
4782       }
4783     if (n >= 0 && n <= expand_nmax)
4784       {
4785       DEBUG(D_expand) debug_expansion_interim(US"value", expand_nstring[n], expand_nlength[n], !!(flags & ESI_SKIPPING));
4786       yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4787       }
4788     continue;
4789     }
4790
4791   if (!isalpha(*s))
4792     {
4793     expand_string_message = US"letter or digit expected after ${";      /*}*/
4794     goto EXPAND_FAILED;
4795     }
4796
4797   /* Allow "-" in names to cater for substrings with negative
4798   arguments. Since we are checking for known names after { this is
4799   OK. */                                                                /*}*/
4800
4801   s = read_name(name, sizeof(name), s, US"_-");
4802   item_type = chop_match(name, item_table, nelem(item_table));
4803
4804   /* Switch on item type.  All nondefault choices should "continue* when
4805   skipping, but "break" otherwise so we get debug output for the item
4806   expansion. */
4807   {
4808   int expansion_start = gstring_length(yield);
4809   switch(item_type)
4810     {
4811     /* Call an ACL from an expansion.  We feed data in via $acl_arg1 - $acl_arg9.
4812     If the ACL returns accept or reject we return content set by "message ="
4813     There is currently no limit on recursion; this would have us call
4814     acl_check_internal() directly and get a current level from somewhere.
4815     See also the acl expansion condition ECOND_ACL and the traditional
4816     acl modifier ACLC_ACL.
4817     Assume that the function has side-effects on the store that must be preserved.
4818     */
4819
4820     case EITEM_ACL:
4821       /* ${acl {name} {arg1}{arg2}...} */
4822       {
4823       uschar * sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4824       uschar * user_msg;
4825       int rc;
4826
4827       switch(read_subs(sub, nelem(sub), 1, &s, flags, TRUE, name, &resetok, NULL))
4828         {
4829         case -1: continue;              /* skipping */
4830         case 1: goto EXPAND_FAILED_CURLY;
4831         case 2:
4832         case 3: goto EXPAND_FAILED;
4833         }
4834
4835       resetok = FALSE;
4836       switch(rc = eval_acl(sub, nelem(sub), &user_msg))
4837         {
4838         case OK:
4839         case FAIL:
4840           DEBUG(D_expand)
4841             debug_printf_indent("acl expansion yield: %s\n", user_msg);
4842           if (user_msg)
4843             yield = string_cat(yield, user_msg);
4844           break;
4845
4846         case DEFER:
4847           f.expand_string_forcedfail = TRUE;
4848           /*FALLTHROUGH*/
4849         default:
4850           expand_string_message = string_sprintf("%s from acl \"%s\"",
4851             rc_names[rc], sub[0]);
4852           goto EXPAND_FAILED;
4853         }
4854       break;
4855       }
4856
4857     case EITEM_AUTHRESULTS:
4858       /* ${authresults {mysystemname}} */
4859       {
4860       uschar * sub_arg[1];
4861
4862       switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, flags, TRUE, name, &resetok, NULL))
4863         {
4864         case -1: continue;      /* If skipping, we don't actually do anything */
4865         case 1: goto EXPAND_FAILED_CURLY;
4866         case 2:
4867         case 3: goto EXPAND_FAILED;
4868         }
4869
4870       yield = string_append(yield, 3,
4871                         US"Authentication-Results: ", sub_arg[0], US"; none");
4872       yield->ptr -= 6;                  /* ignore tha ": none" for now */
4873
4874       yield = authres_local(yield, sub_arg[0]);
4875       yield = authres_iprev(yield);
4876       yield = authres_smtpauth(yield);
4877 #ifdef SUPPORT_SPF
4878       yield = authres_spf(yield);
4879 #endif
4880 #ifndef DISABLE_DKIM
4881       yield = authres_dkim(yield);
4882 #endif
4883 #ifdef SUPPORT_DMARC
4884       yield = authres_dmarc(yield);
4885 #endif
4886 #ifdef EXPERIMENTAL_ARC
4887       yield = authres_arc(yield);
4888 #endif
4889       break;
4890       }
4891
4892     /* Handle conditionals - preserve the values of the numerical expansion
4893     variables in case they get changed by a regular expression match in the
4894     condition. If not, they retain their external settings. At the end
4895     of this "if" section, they get restored to their previous values. */
4896
4897     case EITEM_IF:
4898       {
4899       BOOL cond = FALSE;
4900       const uschar *next_s;
4901       int save_expand_nmax =
4902         save_expand_strings(save_expand_nstring, save_expand_nlength);
4903       uschar * save_lookup_value = lookup_value;
4904
4905       Uskip_whitespace(&s);
4906       if (!(next_s = eval_condition(s, &resetok, flags & ESI_SKIPPING ? NULL : &cond)))
4907         goto EXPAND_FAILED;  /* message already set */
4908
4909       DEBUG(D_expand)
4910         {
4911         debug_expansion_interim(US"condition", s, (int)(next_s - s), !!(flags & ESI_SKIPPING));
4912         debug_expansion_interim(US"result",
4913           cond ? US"true" : US"false", cond ? 4 : 5, !!(flags & ESI_SKIPPING));
4914         }
4915
4916       s = next_s;
4917
4918       /* The handling of "yes" and "no" result strings is now in a separate
4919       function that is also used by ${lookup} and ${extract} and ${run}. */
4920
4921       switch(process_yesno(
4922                flags,                   /* were previously skipping */
4923                cond,                    /* success/failure indicator */
4924                lookup_value,                    /* value to reset for string2 */
4925                &s,                      /* input pointer */
4926                &yield,                  /* output pointer */
4927                US"if",                  /* condition type */
4928                &resetok))
4929         {
4930         case 1: goto EXPAND_FAILED;          /* when all is well, the */
4931         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
4932         }
4933
4934       /* Restore external setting of expansion variables for continuation
4935       at this level. */
4936
4937       lookup_value = save_lookup_value;
4938       restore_expand_strings(save_expand_nmax, save_expand_nstring,
4939         save_expand_nlength);
4940       break;
4941       }
4942
4943 #ifdef SUPPORT_I18N
4944     case EITEM_IMAPFOLDER:
4945       {                         /* ${imapfolder {name}{sep}{specials}} */
4946       uschar *sub_arg[3];
4947       uschar *encoded;
4948
4949       switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, flags, TRUE, name, &resetok, NULL))
4950         {
4951         case 1: goto EXPAND_FAILED_CURLY;
4952         case 2:
4953         case 3: goto EXPAND_FAILED;
4954         }
4955
4956       if (!sub_arg[1])                  /* One argument */
4957         {
4958         sub_arg[1] = US"/";             /* default separator */
4959         sub_arg[2] = NULL;
4960         }
4961       else if (Ustrlen(sub_arg[1]) != 1)
4962         {
4963         expand_string_message =
4964           string_sprintf(
4965                 "IMAP folder separator must be one character, found \"%s\"",
4966                 sub_arg[1]);
4967         goto EXPAND_FAILED;
4968         }
4969
4970       if (flags & ESI_SKIPPING) continue;
4971
4972       if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
4973                           sub_arg[1][0], sub_arg[2], &expand_string_message)))
4974         goto EXPAND_FAILED;
4975       yield = string_cat(yield, encoded);
4976       break;
4977       }
4978 #endif
4979
4980     /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
4981     expanding an internal string that isn't actually going to be used. All we
4982     need to do is check the syntax, so don't do a lookup at all. Preserve the
4983     values of the numerical expansion variables in case they get changed by a
4984     partial lookup. If not, they retain their external settings. At the end
4985     of this "lookup" section, they get restored to their previous values. */
4986
4987     case EITEM_LOOKUP:
4988       {
4989       int stype, partial, affixlen, starflags;
4990       int expand_setup = 0;
4991       int nameptr = 0;
4992       uschar * key, * filename;
4993       const uschar * affix, * opts;
4994       uschar * save_lookup_value = lookup_value;
4995       int save_expand_nmax =
4996         save_expand_strings(save_expand_nstring, save_expand_nlength);
4997
4998       if (expand_forbid & RDO_LOOKUP)
4999         {
5000         expand_string_message = US"lookup expansions are not permitted";
5001         goto EXPAND_FAILED;
5002         }
5003
5004       /* Get the key we are to look up for single-key+file style lookups.
5005       Otherwise set the key NULL pro-tem. */
5006
5007       if (Uskip_whitespace(&s) == '{')                                  /*}*/
5008         {
5009         key = expand_string_internal(s+1,
5010                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
5011         if (!key) goto EXPAND_FAILED;                   /*{{*/
5012         if (*s++ != '}')
5013           {
5014           expand_string_message = US"missing '}' after lookup key";
5015           goto EXPAND_FAILED_CURLY;
5016           }
5017         Uskip_whitespace(&s);
5018         }
5019       else key = NULL;
5020
5021       /* Find out the type of database */
5022
5023       if (!isalpha(*s))
5024         {
5025         expand_string_message = US"missing lookup type";
5026         goto EXPAND_FAILED;
5027         }
5028
5029       /* The type is a string that may contain special characters of various
5030       kinds. Allow everything except space or { to appear; the actual content
5031       is checked by search_findtype_partial. */         /*}*/
5032
5033       while (*s && *s != '{' && !isspace(*s))           /*}*/
5034         {
5035         if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
5036         s++;
5037         }
5038       name[nameptr] = '\0';
5039       Uskip_whitespace(&s);
5040
5041       /* Now check for the individual search type and any partial or default
5042       options. Only those types that are actually in the binary are valid. */
5043
5044       if ((stype = search_findtype_partial(name, &partial, &affix, &affixlen,
5045           &starflags, &opts)) < 0)
5046         {
5047         expand_string_message = search_error_message;
5048         goto EXPAND_FAILED;
5049         }
5050
5051       /* Check that a key was provided for those lookup types that need it,
5052       and was not supplied for those that use the query style. */
5053
5054       if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
5055         {
5056         if (!key)
5057           {
5058           expand_string_message = string_sprintf("missing {key} for single-"
5059             "key \"%s\" lookup", name);
5060           goto EXPAND_FAILED;
5061           }
5062         }
5063       else if (key)
5064         {
5065         expand_string_message = string_sprintf("a single key was given for "
5066           "lookup type \"%s\", which is not a single-key lookup type", name);
5067         goto EXPAND_FAILED;
5068         }
5069
5070       /* Get the next string in brackets and expand it. It is the file name for
5071       single-key+file lookups, and the whole query otherwise. In the case of
5072       queries that also require a file name (e.g. sqlite), the file name comes
5073       first. */
5074
5075       if (*s != '{')
5076         {
5077         expand_string_message = US"missing '{' for lookup file-or-query arg";
5078         goto EXPAND_FAILED_CURLY;                                               /*}}*/
5079         }
5080       if (!(filename = expand_string_internal(s+1,
5081                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
5082         goto EXPAND_FAILED;
5083                                                                                 /*{{*/
5084       if (*s++ != '}')
5085         {
5086         expand_string_message = US"missing '}' closing lookup file-or-query arg";
5087         goto EXPAND_FAILED_CURLY;
5088         }
5089       Uskip_whitespace(&s);
5090
5091       /* If this isn't a single-key+file lookup, re-arrange the variables
5092       to be appropriate for the search_ functions. For query-style lookups,
5093       there is just a "key", and no file name. For the special query-style +
5094       file types, the query (i.e. "key") starts with a file name. */
5095
5096       if (!key)
5097         key = search_args(stype, name, filename, &filename, opts);
5098
5099       /* If skipping, don't do the next bit - just lookup_value == NULL, as if
5100       the entry was not found. Note that there is no search_close() function.
5101       Files are left open in case of re-use. At suitable places in higher logic,
5102       search_tidyup() is called to tidy all open files. This can save opening
5103       the same file several times. However, files may also get closed when
5104       others are opened, if too many are open at once. The rule is that a
5105       handle should not be used after a second search_open().
5106
5107       Request that a partial search sets up $1 and maybe $2 by passing
5108       expand_setup containing zero. If its value changes, reset expand_nmax,
5109       since new variables will have been set. Note that at the end of this
5110       "lookup" section, the old numeric variables are restored. */
5111
5112       if (flags & ESI_SKIPPING)
5113         lookup_value = NULL;
5114       else
5115         {
5116         void * handle = search_open(filename, stype, 0, NULL, NULL);
5117         if (!handle)
5118           {
5119           expand_string_message = search_error_message;
5120           goto EXPAND_FAILED;
5121           }
5122         lookup_value = search_find(handle, filename, key, partial, affix,
5123           affixlen, starflags, &expand_setup, opts);
5124         if (f.search_find_defer)
5125           {
5126           expand_string_message =
5127             string_sprintf("lookup of \"%s\" gave DEFER: %s",
5128               string_printing2(key, SP_TAB), search_error_message);
5129           goto EXPAND_FAILED;
5130           }
5131         if (expand_setup > 0) expand_nmax = expand_setup;
5132         }
5133
5134       /* The handling of "yes" and "no" result strings is now in a separate
5135       function that is also used by ${if} and ${extract}. */
5136
5137       switch(process_yesno(
5138                flags,                   /* were previously skipping */
5139                lookup_value != NULL,    /* success/failure indicator */
5140                save_lookup_value,       /* value to reset for string2 */
5141                &s,                      /* input pointer */
5142                &yield,                  /* output pointer */
5143                US"lookup",              /* condition type */
5144                &resetok))
5145         {
5146         case 1: goto EXPAND_FAILED;          /* when all is well, the */
5147         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
5148         }
5149
5150       /* Restore external setting of expansion variables for carrying on
5151       at this level, and continue. */
5152
5153       restore_expand_strings(save_expand_nmax, save_expand_nstring,
5154         save_expand_nlength);
5155
5156       if (flags & ESI_SKIPPING) continue;
5157       break;
5158       }
5159
5160     /* If Perl support is configured, handle calling embedded perl subroutines,
5161     unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
5162     or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
5163     arguments (defined below). */
5164
5165 #define EXIM_PERL_MAX_ARGS 8
5166
5167     case EITEM_PERL:
5168 #ifndef EXIM_PERL
5169       expand_string_message = US"\"${perl\" encountered, but this facility "    /*}*/
5170         "is not included in this binary";
5171       goto EXPAND_FAILED;
5172
5173 #else   /* EXIM_PERL */
5174       {
5175       uschar * sub_arg[EXIM_PERL_MAX_ARGS + 2];
5176       gstring * new_yield;
5177
5178       if (expand_forbid & RDO_PERL)
5179         {
5180         expand_string_message = US"Perl calls are not permitted";
5181         goto EXPAND_FAILED;
5182         }
5183
5184       switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, flags, TRUE,
5185            name, &resetok, NULL))
5186         {
5187         case -1: continue;      /* If skipping, we don't actually do anything */
5188         case 1: goto EXPAND_FAILED_CURLY;
5189         case 2:
5190         case 3: goto EXPAND_FAILED;
5191         }
5192
5193       /* Start the interpreter if necessary */
5194
5195       if (!opt_perl_started)
5196         {
5197         uschar * initerror;
5198         if (!opt_perl_startup)
5199           {
5200           expand_string_message = US"A setting of perl_startup is needed when "
5201             "using the Perl interpreter";
5202           goto EXPAND_FAILED;
5203           }
5204         DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
5205         if ((initerror = init_perl(opt_perl_startup)))
5206           {
5207           expand_string_message =
5208             string_sprintf("error in perl_startup code: %s\n", initerror);
5209           goto EXPAND_FAILED;
5210           }
5211         opt_perl_started = TRUE;
5212         }
5213
5214       /* Call the function */
5215
5216       sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
5217       new_yield = call_perl_cat(yield, &expand_string_message,
5218         sub_arg[0], sub_arg + 1);
5219
5220       /* NULL yield indicates failure; if the message pointer has been set to
5221       NULL, the yield was undef, indicating a forced failure. Otherwise the
5222       message will indicate some kind of Perl error. */
5223
5224       if (!new_yield)
5225         {
5226         if (!expand_string_message)
5227           {
5228           expand_string_message =
5229             string_sprintf("Perl subroutine \"%s\" returned undef to force "
5230               "failure", sub_arg[0]);
5231           f.expand_string_forcedfail = TRUE;
5232           }
5233         goto EXPAND_FAILED;
5234         }
5235
5236       /* Yield succeeded. Ensure forcedfail is unset, just in case it got
5237       set during a callback from Perl. */
5238
5239       f.expand_string_forcedfail = FALSE;
5240       yield = new_yield;
5241       break;
5242       }
5243 #endif /* EXIM_PERL */
5244
5245     /* Transform email address to "prvs" scheme to use
5246        as BATV-signed return path */
5247
5248     case EITEM_PRVS:
5249       {
5250       uschar * sub_arg[3], * p, * domain;
5251
5252       switch(read_subs(sub_arg, 3, 2, &s, flags, TRUE, name, &resetok, NULL))
5253         {
5254         case -1: continue;      /* If skipping, we don't actually do anything */
5255         case 1: goto EXPAND_FAILED_CURLY;
5256         case 2:
5257         case 3: goto EXPAND_FAILED;
5258         }
5259
5260       /* sub_arg[0] is the address */
5261       if (  !(domain = Ustrrchr(sub_arg[0],'@'))
5262          || domain == sub_arg[0] || Ustrlen(domain) == 1)
5263         {
5264         expand_string_message = US"prvs first argument must be a qualified email address";
5265         goto EXPAND_FAILED;
5266         }
5267
5268       /* Calculate the hash. The third argument must be a single-digit
5269       key number, or unset. */
5270
5271       if (  sub_arg[2]
5272          && (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
5273         {
5274         expand_string_message = US"prvs third argument must be a single digit";
5275         goto EXPAND_FAILED;
5276         }
5277
5278       p = prvs_hmac_sha1(sub_arg[0], sub_arg[1], sub_arg[2], prvs_daystamp(7));
5279       if (!p)
5280         {
5281         expand_string_message = US"prvs hmac-sha1 conversion failed";
5282         goto EXPAND_FAILED;
5283         }
5284
5285       /* Now separate the domain from the local part */
5286       *domain++ = '\0';
5287
5288       yield = string_catn(yield, US"prvs=", 5);
5289       yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);
5290       yield = string_catn(yield, prvs_daystamp(7), 3);
5291       yield = string_catn(yield, p, 6);
5292       yield = string_catn(yield, US"=", 1);
5293       yield = string_cat (yield, sub_arg[0]);
5294       yield = string_catn(yield, US"@", 1);
5295       yield = string_cat (yield, domain);
5296
5297       break;
5298       }
5299
5300     /* Check a prvs-encoded address for validity */
5301
5302     case EITEM_PRVSCHECK:
5303       {
5304       uschar * sub_arg[3], * p;
5305       gstring * g;
5306       const pcre2_code * re;
5307
5308       /* Reset expansion variables */
5309       prvscheck_result = NULL;
5310       prvscheck_address = NULL;
5311       prvscheck_keynum = NULL;
5312
5313       switch(read_subs(sub_arg, 1, 1, &s, flags, FALSE, name, &resetok, NULL))
5314         {
5315         case 1: goto EXPAND_FAILED_CURLY;
5316         case 2:
5317         case 3: goto EXPAND_FAILED;
5318         }
5319
5320       re = regex_must_compile(
5321         US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
5322         MCS_CASELESS | MCS_CACHEABLE, FALSE);
5323
5324       if (regex_match_and_setup(re,sub_arg[0],0,-1))
5325         {
5326         uschar * local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
5327         uschar * key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
5328         uschar * daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
5329         uschar * hash = string_copyn(expand_nstring[3],expand_nlength[3]);
5330         uschar * domain = string_copyn(expand_nstring[5],expand_nlength[5]);
5331
5332         DEBUG(D_expand)
5333           {
5334           debug_printf_indent("prvscheck localpart: %s\n", local_part);
5335           debug_printf_indent("prvscheck key number: %s\n", key_num);
5336           debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
5337           debug_printf_indent("prvscheck hash: %s\n", hash);
5338           debug_printf_indent("prvscheck domain: %s\n", domain);
5339           }
5340
5341         /* Set up expansion variables */
5342         g = string_cat (NULL, local_part);
5343         g = string_catn(g, US"@", 1);
5344         g = string_cat (g, domain);
5345         prvscheck_address = string_from_gstring(g);
5346         prvscheck_keynum = string_copy(key_num);
5347
5348         /* Now expand the second argument */
5349         switch(read_subs(sub_arg, 1, 1, &s, flags, FALSE, name, &resetok, NULL))
5350           {
5351           case 1: goto EXPAND_FAILED_CURLY;
5352           case 2:
5353           case 3: goto EXPAND_FAILED;
5354           }
5355
5356         /* Now we have the key and can check the address. */
5357
5358         p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
5359           daystamp);
5360         if (!p)
5361           {
5362           expand_string_message = US"hmac-sha1 conversion failed";
5363           goto EXPAND_FAILED;
5364           }
5365
5366         DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
5367         DEBUG(D_expand) debug_printf_indent("prvscheck:      own hash is %s\n", p);
5368
5369         if (Ustrcmp(p,hash) == 0)
5370           {
5371           /* Success, valid BATV address. Now check the expiry date. */
5372           uschar *now = prvs_daystamp(0);
5373           unsigned int inow = 0,iexpire = 1;
5374
5375           (void)sscanf(CS now,"%u",&inow);
5376           (void)sscanf(CS daystamp,"%u",&iexpire);
5377
5378           /* When "iexpire" is < 7, a "flip" has occurred.
5379              Adjust "inow" accordingly. */
5380           if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
5381
5382           if (iexpire >= inow)
5383             {
5384             prvscheck_result = US"1";
5385             DEBUG(D_expand) debug_printf_indent("prvscheck: success, $pvrs_result set to 1\n");
5386             }
5387           else
5388             {
5389             prvscheck_result = NULL;
5390             DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $pvrs_result unset\n");
5391             }
5392           }
5393         else
5394           {
5395           prvscheck_result = NULL;
5396           DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $pvrs_result unset\n");
5397           }
5398
5399         /* Now expand the final argument. We leave this till now so that
5400         it can include $prvscheck_result. */
5401
5402         switch(read_subs(sub_arg, 1, 0, &s, flags, TRUE, name, &resetok, NULL))
5403           {
5404           case 1: goto EXPAND_FAILED_CURLY;
5405           case 2:
5406           case 3: goto EXPAND_FAILED;
5407           }
5408
5409         yield = string_cat(yield,
5410           !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
5411
5412         /* Reset the "internal" variables afterwards, because they are in
5413         dynamic store that will be reclaimed if the expansion succeeded. */
5414
5415         prvscheck_address = NULL;
5416         prvscheck_keynum = NULL;
5417         }
5418       else
5419         /* Does not look like a prvs encoded address, return the empty string.
5420            We need to make sure all subs are expanded first, so as to skip over
5421            the entire item. */
5422
5423         switch(read_subs(sub_arg, 2, 1, &s, flags, TRUE, name, &resetok, NULL))
5424           {
5425           case 1: goto EXPAND_FAILED_CURLY;
5426           case 2:
5427           case 3: goto EXPAND_FAILED;
5428           }
5429
5430       if (flags & ESI_SKIPPING) continue;
5431       break;
5432       }
5433
5434     /* Handle "readfile" to insert an entire file */
5435
5436     case EITEM_READFILE:
5437       {
5438       FILE * f;
5439       uschar * sub_arg[2];
5440
5441       if ((expand_forbid & RDO_READFILE) != 0)
5442         {
5443         expand_string_message = US"file insertions are not permitted";
5444         goto EXPAND_FAILED;
5445         }
5446
5447       switch(read_subs(sub_arg, 2, 1, &s, flags, TRUE, name, &resetok, NULL))
5448         {
5449         case -1: continue;      /* If skipping, we don't actually do anything */
5450         case 1: goto EXPAND_FAILED_CURLY;
5451         case 2:
5452         case 3: goto EXPAND_FAILED;
5453         }
5454
5455       /* Open the file and read it */
5456
5457       if (!(f = Ufopen(sub_arg[0], "rb")))
5458         {
5459         expand_string_message = string_open_failed("%s", sub_arg[0]);
5460         goto EXPAND_FAILED;
5461         }
5462
5463       yield = cat_file(f, yield, sub_arg[1]);
5464       (void)fclose(f);
5465       break;
5466       }
5467
5468     /* Handle "readsocket" to insert data from a socket, either
5469     Inet or Unix domain */
5470
5471     case EITEM_READSOCK:
5472       {
5473       uschar * arg;
5474       uschar * sub_arg[4];
5475
5476       if (expand_forbid & RDO_READSOCK)
5477         {
5478         expand_string_message = US"socket insertions are not permitted";
5479         goto EXPAND_FAILED;
5480         }
5481
5482       /* Read up to 4 arguments, but don't do the end of item check afterwards,
5483       because there may be a string for expansion on failure. */
5484
5485       switch(read_subs(sub_arg, 4, 2, &s, flags, FALSE, name, &resetok, NULL))
5486         {
5487         case 1: goto EXPAND_FAILED_CURLY;
5488         case 2:                             /* Won't occur: no end check */
5489         case 3: goto EXPAND_FAILED;
5490         }
5491
5492       /* If skipping, we don't actually do anything. Otherwise, arrange to
5493       connect to either an IP or a Unix socket. */
5494
5495       if (!(flags & ESI_SKIPPING))
5496         {
5497         int stype = search_findtype(US"readsock", 8);
5498         gstring * g = NULL;
5499         void * handle;
5500         int expand_setup = -1;
5501         uschar * s;
5502
5503         /* If the reqstr is empty, flag that and set a dummy */
5504
5505         if (!sub_arg[1][0])
5506           {
5507           g = string_append_listele(g, ',', US"send=no");
5508           sub_arg[1] = US"DUMMY";
5509           }
5510
5511         /* Re-marshall the options */
5512
5513         if (sub_arg[2])
5514           {
5515           const uschar * list = sub_arg[2];
5516           uschar * item;
5517           int sep = 0;
5518
5519           /* First option has no tag and is timeout */
5520           if ((item = string_nextinlist(&list, &sep, NULL, 0)))
5521             g = string_append_listele(g, ',',
5522                   string_sprintf("timeout=%s", item));
5523
5524           /* The rest of the options from the expansion */
5525           while ((item = string_nextinlist(&list, &sep, NULL, 0)))
5526             g = string_append_listele(g, ',', item);
5527
5528           /* possibly plus an EOL string.  Process with escapes, to protect
5529           from list-processing.  The only current user of eol= in search
5530           options is the readsock expansion. */
5531
5532           if (sub_arg[3] && *sub_arg[3])
5533             g = string_append_listele(g, ',',
5534                   string_sprintf("eol=%s",
5535                     string_printing2(sub_arg[3], SP_TAB|SP_SPACE)));
5536           }
5537
5538         /* Gat a (possibly cached) handle for the connection */
5539
5540         if (!(handle = search_open(sub_arg[0], stype, 0, NULL, NULL)))
5541           {
5542           if (*expand_string_message) goto EXPAND_FAILED;
5543           expand_string_message = search_error_message;
5544           search_error_message = NULL;
5545           goto SOCK_FAIL;
5546           }
5547
5548         /* Get (possibly cached) results for the lookup */
5549         /* sspec: sub_arg[0]  req: sub_arg[1]  opts: g */
5550
5551         if ((s = search_find(handle, sub_arg[0], sub_arg[1], -1, NULL, 0, 0,
5552                                     &expand_setup, string_from_gstring(g))))
5553           yield = string_cat(yield, s);
5554         else if (f.search_find_defer)
5555           {
5556           expand_string_message = search_error_message;
5557           search_error_message = NULL;
5558           goto SOCK_FAIL;
5559           }
5560         else
5561           {     /* should not happen, at present */
5562           expand_string_message = search_error_message;
5563           search_error_message = NULL;
5564           goto SOCK_FAIL;
5565           }
5566         }
5567
5568       /* The whole thing has worked (or we were skipping). If there is a
5569       failure string following, we need to skip it. */
5570
5571       if (*s == '{')                                                    /*}*/
5572         {
5573         if (!expand_string_internal(s+1,
5574           ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL))
5575           goto EXPAND_FAILED;                                           /*{*/
5576         if (*s++ != '}')
5577           {                                                             /*{*/
5578           expand_string_message = US"missing '}' closing failstring for readsocket";
5579           goto EXPAND_FAILED_CURLY;
5580           }
5581         Uskip_whitespace(&s);
5582         }
5583
5584     READSOCK_DONE:                                                      /*{*/
5585       if (*s++ != '}')
5586         {                                                               /*{*/
5587         expand_string_message = US"missing '}' closing readsocket";
5588         goto EXPAND_FAILED_CURLY;
5589         }
5590       if (flags & ESI_SKIPPING) continue;
5591       break;
5592
5593       /* Come here on failure to create socket, connect socket, write to the
5594       socket, or timeout on reading. If another substring follows, expand and
5595       use it. Otherwise, those conditions give expand errors. */
5596
5597     SOCK_FAIL:
5598       if (*s != '{') goto EXPAND_FAILED;                                /*}*/
5599       DEBUG(D_any) debug_printf("%s\n", expand_string_message);
5600       if (!(arg = expand_string_internal(s+1,
5601                     ESI_BRACE_ENDS | ESI_HONOR_DOLLAR, &s, &resetok, NULL)))
5602         goto EXPAND_FAILED;
5603       yield = string_cat(yield, arg);                                   /*{*/
5604       if (*s++ != '}')
5605         {                                                               /*{*/
5606         expand_string_message = US"missing '}' closing failstring for readsocket";
5607         goto EXPAND_FAILED_CURLY;
5608         }
5609       Uskip_whitespace(&s);
5610       goto READSOCK_DONE;
5611       }
5612
5613     /* Handle "run" to execute a program. */
5614
5615     case EITEM_RUN:
5616       {
5617       FILE * f;
5618       const uschar * arg, ** argv;
5619       BOOL late_expand = TRUE;
5620
5621       if (expand_forbid & RDO_RUN)
5622         {
5623         expand_string_message = US"running a command is not permitted";
5624         goto EXPAND_FAILED;
5625         }
5626
5627       /* Handle options to the "run" */
5628
5629       while (*s == ',')
5630         if (Ustrncmp(++s, "preexpand", 9) == 0)
5631           { late_expand = FALSE; s += 9; }
5632         else
5633           {
5634           const uschar * t = s;
5635           while (isalpha(*++t)) ;
5636           expand_string_message = string_sprintf("bad option '%.*s' for run",
5637                                                   (int)(t-s), s);
5638           goto EXPAND_FAILED;
5639           }
5640       Uskip_whitespace(&s);
5641
5642       if (*s != '{')                                    /*}*/
5643         {
5644         expand_string_message = US"missing '{' for command arg of run";
5645         goto EXPAND_FAILED_CURLY;                       /*"}*/
5646         }
5647       s++;
5648
5649       if (late_expand)          /* this is the default case */
5650         {
5651         int n;
5652         const uschar * t;
5653         /* Locate the end of the args */
5654         (void) expand_string_internal(s,
5655           ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &t, NULL, NULL);
5656         n = t - s;
5657         arg = flags & ESI_SKIPPING ? NULL : string_copyn(s, n);
5658         s += n;
5659         }
5660       else
5661         {
5662         DEBUG(D_expand)
5663           debug_printf_indent("args string for ${run} expand before split\n");
5664         if (!(arg = expand_string_internal(s,
5665                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
5666           goto EXPAND_FAILED;
5667         Uskip_whitespace(&s);
5668         }
5669                                                         /*{*/
5670       if (*s++ != '}')
5671         {                                               /*{*/
5672         expand_string_message = US"missing '}' closing command arg of run";
5673         goto EXPAND_FAILED_CURLY;
5674         }
5675
5676       if (flags & ESI_SKIPPING)   /* Just pretend it worked when we're skipping */
5677         {
5678         runrc = 0;
5679         lookup_value = NULL;
5680         }
5681       else
5682         {
5683         int fd_in, fd_out;
5684         pid_t pid;
5685
5686         if (!transport_set_up_command(&argv,    /* anchor for arg list */
5687             arg,                                /* raw command */
5688             late_expand,                /* expand args if not already done */
5689             0,                          /* not relevant when... */
5690             NULL,                       /* no transporting address */
5691             late_expand,                /* allow tainted args, when expand-after-split */
5692             US"${run} expansion",       /* for error messages */
5693             &expand_string_message))    /* where to put error message */
5694           goto EXPAND_FAILED;
5695
5696         /* Create the child process, making it a group leader. */
5697
5698         if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE,
5699                               US"expand-run")) < 0)
5700           {
5701           expand_string_message =
5702             string_sprintf("couldn't create child process: %s", strerror(errno));
5703           goto EXPAND_FAILED;
5704           }
5705
5706         /* Nothing is written to the standard input. */
5707
5708         (void)close(fd_in);
5709
5710         /* Read the pipe to get the command's output into $value (which is kept
5711         in lookup_value). Read during execution, so that if the output exceeds
5712         the OS pipe buffer limit, we don't block forever. Remember to not release
5713         memory just allocated for $value. */
5714
5715         resetok = FALSE;
5716         f = fdopen(fd_out, "rb");
5717         sigalrm_seen = FALSE;
5718         ALARM(60);
5719         lookup_value = string_from_gstring(cat_file(f, NULL, NULL));
5720         ALARM_CLR(0);
5721         (void)fclose(f);
5722
5723         /* Wait for the process to finish, applying the timeout, and inspect its
5724         return code for serious disasters. Simple non-zero returns are passed on.
5725         */
5726
5727         if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)
5728           {
5729           if (sigalrm_seen || runrc == -256)
5730             {
5731             expand_string_message = US"command timed out";
5732             killpg(pid, SIGKILL);       /* Kill the whole process group */
5733             }
5734
5735           else if (runrc == -257)
5736             expand_string_message = string_sprintf("wait() failed: %s",
5737               strerror(errno));
5738
5739           else
5740             expand_string_message = string_sprintf("command killed by signal %d",
5741               -runrc);
5742
5743           goto EXPAND_FAILED;
5744           }
5745         }
5746
5747       /* Process the yes/no strings; $value may be useful in both cases */
5748
5749       switch(process_yesno(
5750                flags,                   /* were previously skipping */
5751                runrc == 0,              /* success/failure indicator */
5752                lookup_value,            /* value to reset for string2 */
5753                &s,                      /* input pointer */
5754                &yield,                  /* output pointer */
5755                US"run",                 /* condition type */
5756                &resetok))
5757         {
5758         case 1: goto EXPAND_FAILED;          /* when all is well, the */
5759         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
5760         }
5761
5762       if (flags & ESI_SKIPPING) continue;
5763       break;
5764       }
5765
5766     /* Handle character translation for "tr" */
5767
5768     case EITEM_TR:
5769       {
5770       int oldptr = gstring_length(yield);
5771       int o2m;
5772       uschar * sub[3];
5773
5774       switch(read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, NULL))
5775         {
5776         case -1: continue;      /* skipping */
5777         case 1: goto EXPAND_FAILED_CURLY;
5778         case 2:
5779         case 3: goto EXPAND_FAILED;
5780         }
5781
5782       yield = string_cat(yield, sub[0]);
5783       o2m = Ustrlen(sub[2]) - 1;
5784
5785       if (o2m >= 0) for (; oldptr < yield->ptr; oldptr++)
5786         {
5787         uschar * m = Ustrrchr(sub[1], yield->s[oldptr]);
5788         if (m)
5789           {
5790           int o = m - sub[1];
5791           yield->s[oldptr] = sub[2][(o < o2m)? o : o2m];
5792           }
5793         }
5794
5795       break;
5796       }
5797
5798     /* Handle "hash", "length", "nhash", and "substr" when they are given with
5799     expanded arguments. */
5800
5801     case EITEM_HASH:
5802     case EITEM_LENGTH:
5803     case EITEM_NHASH:
5804     case EITEM_SUBSTR:
5805       {
5806       int len;
5807       uschar *ret;
5808       int val[2] = { 0, -1 };
5809       uschar * sub[3];
5810
5811       /* "length" takes only 2 arguments whereas the others take 2 or 3.
5812       Ensure that sub[2] is set in the ${length } case. */
5813
5814       sub[2] = NULL;
5815       switch(read_subs(sub, item_type == EITEM_LENGTH ? 2:3, 2, &s, flags,
5816              TRUE, name, &resetok, NULL))
5817         {
5818         case -1: continue;      /* skipping */
5819         case 1: goto EXPAND_FAILED_CURLY;
5820         case 2:
5821         case 3: goto EXPAND_FAILED;
5822         }
5823
5824       /* Juggle the arguments if there are only two of them: always move the
5825       string to the last position and make ${length{n}{str}} equivalent to
5826       ${substr{0}{n}{str}}. See the defaults for val[] above. */
5827
5828       if (!sub[2])
5829         {
5830         sub[2] = sub[1];
5831         sub[1] = NULL;
5832         if (item_type == EITEM_LENGTH)
5833           {
5834           sub[1] = sub[0];
5835           sub[0] = NULL;
5836           }
5837         }
5838
5839       for (int i = 0; i < 2; i++) if (sub[i])
5840         {
5841         val[i] = (int)Ustrtol(sub[i], &ret, 10);
5842         if (*ret != 0 || (i != 0 && val[i] < 0))
5843           {
5844           expand_string_message = string_sprintf("\"%s\" is not a%s number "
5845             "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5846           goto EXPAND_FAILED;
5847           }
5848         }
5849
5850       ret =
5851         item_type == EITEM_HASH
5852         ?  compute_hash(sub[2], val[0], val[1], &len)
5853         : item_type == EITEM_NHASH
5854         ? compute_nhash(sub[2], val[0], val[1], &len)
5855         : extract_substr(sub[2], val[0], val[1], &len);
5856       if (!ret)
5857         goto EXPAND_FAILED;
5858       yield = string_catn(yield, ret, len);
5859       break;
5860       }
5861
5862     /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5863     This code originally contributed by Steve Haslam. It currently supports
5864     the use of MD5 and SHA-1 hashes.
5865
5866     We need some workspace that is large enough to handle all the supported
5867     hash types. Use macros to set the sizes rather than be too elaborate. */
5868
5869     #define MAX_HASHLEN      20
5870     #define MAX_HASHBLOCKLEN 64
5871
5872     case EITEM_HMAC:
5873       {
5874       uschar * sub[3];
5875       md5 md5_base;
5876       hctx sha1_ctx;
5877       void * use_base;
5878       int type;
5879       int hashlen;      /* Number of octets for the hash algorithm's output */
5880       int hashblocklen; /* Number of octets the hash algorithm processes */
5881       uschar * keyptr, * p;
5882       unsigned int keylen;
5883
5884       uschar keyhash[MAX_HASHLEN];
5885       uschar innerhash[MAX_HASHLEN];
5886       uschar finalhash[MAX_HASHLEN];
5887       uschar finalhash_hex[2*MAX_HASHLEN];
5888       uschar innerkey[MAX_HASHBLOCKLEN];
5889       uschar outerkey[MAX_HASHBLOCKLEN];
5890
5891       switch (read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, NULL))
5892         {
5893         case -1: continue;      /* skipping */
5894         case 1: goto EXPAND_FAILED_CURLY;
5895         case 2:
5896         case 3: goto EXPAND_FAILED;
5897         }
5898
5899       if (Ustrcmp(sub[0], "md5") == 0)
5900         {
5901         type = HMAC_MD5;
5902         use_base = &md5_base;
5903         hashlen = 16;
5904         hashblocklen = 64;
5905         }
5906       else if (Ustrcmp(sub[0], "sha1") == 0)
5907         {
5908         type = HMAC_SHA1;
5909         use_base = &sha1_ctx;
5910         hashlen = 20;
5911         hashblocklen = 64;
5912         }
5913       else
5914         {
5915         expand_string_message =
5916           string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5917         goto EXPAND_FAILED;
5918         }
5919
5920       keyptr = sub[1];
5921       keylen = Ustrlen(keyptr);
5922
5923       /* If the key is longer than the hash block length, then hash the key
5924       first */
5925
5926       if (keylen > hashblocklen)
5927         {
5928         chash_start(type, use_base);
5929         chash_end(type, use_base, keyptr, keylen, keyhash);
5930         keyptr = keyhash;
5931         keylen = hashlen;
5932         }
5933
5934       /* Now make the inner and outer key values */
5935
5936       memset(innerkey, 0x36, hashblocklen);
5937       memset(outerkey, 0x5c, hashblocklen);
5938
5939       for (int i = 0; i < keylen; i++)
5940         {
5941         innerkey[i] ^= keyptr[i];
5942         outerkey[i] ^= keyptr[i];
5943         }
5944
5945       /* Now do the hashes */
5946
5947       chash_start(type, use_base);
5948       chash_mid(type, use_base, innerkey);
5949       chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5950
5951       chash_start(type, use_base);
5952       chash_mid(type, use_base, outerkey);
5953       chash_end(type, use_base, innerhash, hashlen, finalhash);
5954
5955       /* Encode the final hash as a hex string */
5956
5957       p = finalhash_hex;
5958       for (int i = 0; i < hashlen; i++)
5959         {
5960         *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5961         *p++ = hex_digits[finalhash[i] & 0x0f];
5962         }
5963
5964       DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
5965         sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);
5966
5967       yield = string_catn(yield, finalhash_hex, hashlen*2);
5968       break;
5969       }
5970
5971     /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
5972     We have to save the numerical variables and restore them afterwards. */
5973
5974     case EITEM_SG:
5975       {
5976       const pcre2_code * re;
5977       int moffset, moffsetextra, slen;
5978       pcre2_match_data * md;
5979       int emptyopt;
5980       uschar * subject, * sub[3];
5981       int save_expand_nmax =
5982         save_expand_strings(save_expand_nstring, save_expand_nlength);
5983       unsigned sub_textonly = 0;
5984
5985       switch(read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, &sub_textonly))
5986         {
5987         case -1: continue;      /* skipping */
5988         case 1: goto EXPAND_FAILED_CURLY;
5989         case 2:
5990         case 3: goto EXPAND_FAILED;
5991         }
5992
5993       /* Compile the regular expression */
5994
5995       re = regex_compile(sub[1],
5996               sub_textonly & BIT(1) ? MCS_CACHEABLE : MCS_NOFLAGS,
5997               &expand_string_message, pcre_gen_cmp_ctx);
5998       if (!re)
5999         goto EXPAND_FAILED;
6000
6001       md = pcre2_match_data_create(EXPAND_MAXN + 1, pcre_gen_ctx);
6002
6003       /* Now run a loop to do the substitutions as often as necessary. It ends
6004       when there are no more matches. Take care over matches of the null string;
6005       do the same thing as Perl does. */
6006
6007       subject = sub[0];
6008       slen = Ustrlen(sub[0]);
6009       moffset = moffsetextra = 0;
6010       emptyopt = 0;
6011
6012       for (;;)
6013         {
6014         PCRE2_SIZE * ovec = pcre2_get_ovector_pointer(md);
6015         int n = pcre2_match(re, (PCRE2_SPTR)subject, slen, moffset + moffsetextra,
6016           PCRE_EOPT | emptyopt, md, pcre_gen_mtc_ctx);
6017         uschar * insert;
6018
6019         /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
6020         is not necessarily the end. We want to repeat the match from one
6021         character further along, but leaving the basic offset the same (for
6022         copying below). We can't be at the end of the string - that was checked
6023         before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
6024         finished; copy the remaining string and end the loop. */
6025
6026         if (n < 0)
6027           {
6028           if (emptyopt != 0)
6029             {
6030             moffsetextra = 1;
6031             emptyopt = 0;
6032             continue;
6033             }
6034           yield = string_catn(yield, subject+moffset, slen-moffset);
6035           break;
6036           }
6037
6038         /* Match - set up for expanding the replacement. */
6039         DEBUG(D_expand) debug_printf_indent("%s: match\n", name);
6040
6041         if (n == 0) n = EXPAND_MAXN + 1;
6042         expand_nmax = 0;
6043         for (int nn = 0; nn < n*2; nn += 2)
6044           {
6045           expand_nstring[expand_nmax] = subject + ovec[nn];
6046           expand_nlength[expand_nmax++] = ovec[nn+1] - ovec[nn];
6047           }
6048         expand_nmax--;
6049
6050         /* Copy the characters before the match, plus the expanded insertion. */
6051
6052         yield = string_catn(yield, subject + moffset, ovec[0] - moffset);
6053
6054         if (!(insert = expand_string(sub[2])))
6055           goto EXPAND_FAILED;
6056         yield = string_cat(yield, insert);
6057
6058         moffset = ovec[1];
6059         moffsetextra = 0;
6060         emptyopt = 0;
6061
6062         /* If we have matched an empty string, first check to see if we are at
6063         the end of the subject. If so, the loop is over. Otherwise, mimic
6064         what Perl's /g options does. This turns out to be rather cunning. First
6065         we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
6066         string at the same point. If this fails (picked up above) we advance to
6067         the next character. */
6068
6069         if (ovec[0] == ovec[1])
6070           {
6071           if (ovec[0] == slen) break;
6072           emptyopt = PCRE2_NOTEMPTY | PCRE2_ANCHORED;
6073           }
6074         }
6075
6076       /* All done - restore numerical variables. */
6077
6078       /* pcre2_match_data_free(md);     gen ctx needs no free */
6079       restore_expand_strings(save_expand_nmax, save_expand_nstring,
6080         save_expand_nlength);
6081       break;
6082       }
6083
6084     /* Handle keyed and numbered substring extraction. If the first argument
6085     consists entirely of digits, then a numerical extraction is assumed. */
6086
6087     case EITEM_EXTRACT:
6088       {
6089       int field_number = 1;
6090       BOOL field_number_set = FALSE;
6091       uschar * save_lookup_value = lookup_value, * sub[3];
6092       int save_expand_nmax =
6093         save_expand_strings(save_expand_nstring, save_expand_nlength);
6094
6095       /* On reflection the original behaviour of extract-json for a string
6096       result, leaving it quoted, was a mistake.  But it was already published,
6097       hence the addition of jsons.  In a future major version, make json
6098       work like josons, and withdraw jsons. */
6099
6100       enum {extract_basic, extract_json, extract_jsons} fmt = extract_basic;
6101
6102       /* Check for a format-variant specifier */
6103
6104       if (Uskip_whitespace(&s) != '{')                                  /*}*/
6105         if (Ustrncmp(s, "json", 4) == 0)
6106           if (*(s += 4) == 's')
6107             {fmt = extract_jsons; s++;}
6108           else
6109             fmt = extract_json;
6110
6111       /* While skipping we cannot rely on the data for expansions being
6112       available (eg. $item) hence cannot decide on numeric vs. keyed.
6113       Read a maximum of 5 arguments (including the yes/no) */
6114
6115       if (flags & ESI_SKIPPING)
6116         {
6117         for (int j = 5; j > 0 && *s == '{'; j--)                        /*'}'*/
6118           {
6119           if (!expand_string_internal(s+1,
6120                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL))
6121             goto EXPAND_FAILED;                                 /*'{'*/
6122           if (*s++ != '}')
6123             {
6124             expand_string_message = US"missing '{' for arg of extract";
6125             goto EXPAND_FAILED_CURLY;
6126             }
6127           Uskip_whitespace(&s);
6128           }
6129         if (  Ustrncmp(s, "fail", 4) == 0                               /*'{'*/
6130            && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
6131            )
6132           {
6133           s += 4;
6134           Uskip_whitespace(&s);
6135           }                                                             /*'{'*/
6136         if (*s != '}')
6137           {
6138           expand_string_message = US"missing '}' closing extract";
6139           goto EXPAND_FAILED_CURLY;
6140           }
6141         }
6142
6143       else for (int i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
6144         {
6145         if (Uskip_whitespace(&s) == '{')                                /*'}'*/
6146           {
6147           if (!(sub[i] = expand_string_internal(s+1,
6148                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
6149             goto EXPAND_FAILED;                                         /*'{'*/
6150           if (*s++ != '}')
6151             {
6152             expand_string_message = string_sprintf(
6153               "missing '}' closing arg %d of extract", i+1);
6154             goto EXPAND_FAILED_CURLY;
6155             }
6156
6157           /* After removal of leading and trailing white space, the first
6158           argument must not be empty; if it consists entirely of digits
6159           (optionally preceded by a minus sign), this is a numerical
6160           extraction, and we expect 3 arguments (normal) or 2 (json). */
6161
6162           if (i == 0)
6163             {
6164             int len;
6165             int x = 0;
6166             uschar * p = sub[0];
6167
6168             Uskip_whitespace(&p);
6169             sub[0] = p;
6170
6171             len = Ustrlen(p);
6172             while (len > 0 && isspace(p[len-1])) len--;
6173             p[len] = 0;
6174
6175             if (!*p)
6176               {
6177               expand_string_message = US"first argument of \"extract\" must "
6178                 "not be empty";
6179               goto EXPAND_FAILED;
6180               }
6181
6182             if (*p == '-')
6183               {
6184               field_number = -1;
6185               p++;
6186               }
6187             while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
6188             if (!*p)
6189               {
6190               field_number *= x;
6191               if (fmt == extract_basic) j = 3;               /* Need 3 args */
6192               field_number_set = TRUE;
6193               }
6194             }
6195           }
6196         else
6197           {
6198           expand_string_message = string_sprintf(
6199             "missing '{' for arg %d of extract", i+1);
6200           goto EXPAND_FAILED_CURLY;
6201           }
6202         }
6203
6204       /* Extract either the numbered or the keyed substring into $value. If
6205       skipping, just pretend the extraction failed. */
6206
6207       if (flags & ESI_SKIPPING)
6208         lookup_value = NULL;
6209       else switch (fmt)
6210         {
6211         case extract_basic:
6212           lookup_value = field_number_set
6213             ? expand_gettokened(field_number, sub[1], sub[2])
6214             : expand_getkeyed(sub[0], sub[1]);
6215           break;
6216
6217         case extract_json:
6218         case extract_jsons:
6219           {
6220           uschar * s, * item;
6221           const uschar * list;
6222
6223           /* Array: Bracket-enclosed and comma-separated.
6224           Object: Brace-enclosed, comma-sep list of name:value pairs */
6225
6226           if (!(s = dewrap(sub[1], field_number_set ? US"[]" : US"{}")))
6227             {
6228             expand_string_message =
6229               string_sprintf("%s wrapping %s for extract json",
6230                 expand_string_message,
6231                 field_number_set ? "array" : "object");
6232             goto EXPAND_FAILED_CURLY;
6233             }
6234
6235           list = s;
6236           if (field_number_set)
6237             {
6238             if (field_number <= 0)
6239               {
6240               expand_string_message = US"first argument of \"extract\" must "
6241                 "be greater than zero";
6242               goto EXPAND_FAILED;
6243               }
6244             while (field_number > 0 && (item = json_nextinlist(&list)))
6245               field_number--;
6246             if ((lookup_value = s = item))
6247               {
6248               while (*s) s++;
6249               while (--s >= lookup_value && isspace(*s)) *s = '\0';
6250               }
6251             }
6252           else
6253             {
6254             lookup_value = NULL;
6255             while ((item = json_nextinlist(&list)))
6256               {
6257               /* Item is:  string name-sep value.  string is quoted.
6258               Dequote the string and compare with the search key. */
6259
6260               if (!(item = dewrap(item, US"\"\"")))
6261                 {
6262                 expand_string_message =
6263                   string_sprintf("%s wrapping string key for extract json",
6264                     expand_string_message);
6265                 goto EXPAND_FAILED_CURLY;
6266                 }
6267               if (Ustrcmp(item, sub[0]) == 0)   /*XXX should be a UTF8-compare */
6268                 {
6269                 s = item + Ustrlen(item) + 1;
6270                 if (Uskip_whitespace(&s) != ':')
6271                   {
6272                   expand_string_message =
6273                     US"missing object value-separator for extract json";
6274                   goto EXPAND_FAILED_CURLY;
6275                   }
6276                 s++;
6277                 Uskip_whitespace(&s);
6278                 lookup_value = s;
6279                 break;
6280                 }
6281               }
6282             }
6283           }
6284
6285           if (  fmt == extract_jsons
6286              && lookup_value
6287              && !(lookup_value = dewrap(lookup_value, US"\"\"")))
6288             {
6289             expand_string_message =
6290               string_sprintf("%s wrapping string result for extract jsons",
6291                 expand_string_message);
6292             goto EXPAND_FAILED_CURLY;
6293             }
6294           break;        /* json/s */
6295         }
6296
6297       /* If no string follows, $value gets substituted; otherwise there can
6298       be yes/no strings, as for lookup or if. */
6299
6300       switch(process_yesno(
6301                flags,                   /* were previously skipping */
6302                lookup_value != NULL,    /* success/failure indicator */
6303                save_lookup_value,       /* value to reset for string2 */
6304                &s,                      /* input pointer */
6305                &yield,                  /* output pointer */
6306                US"extract",             /* condition type */
6307                &resetok))
6308         {
6309         case 1: goto EXPAND_FAILED;          /* when all is well, the */
6310         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
6311         }
6312
6313       /* All done - restore numerical variables. */
6314
6315       restore_expand_strings(save_expand_nmax, save_expand_nstring,
6316         save_expand_nlength);
6317
6318       if (flags & ESI_SKIPPING) continue;
6319       break;
6320       }
6321
6322     /* return the Nth item from a list */
6323
6324     case EITEM_LISTEXTRACT:
6325       {
6326       int field_number = 1;
6327       uschar * save_lookup_value = lookup_value, * sub[2];
6328       int save_expand_nmax =
6329         save_expand_strings(save_expand_nstring, save_expand_nlength);
6330
6331       /* Read the field & list arguments */
6332       /*XXX Could we use read_subs here (and get better efficiency for skipping)? */
6333
6334       for (int i = 0; i < 2; i++)
6335         {
6336         if (Uskip_whitespace(&s) != '{')                                /*}*/
6337           {
6338           expand_string_message = string_sprintf(
6339             "missing '{' for arg %d of listextract", i+1);              /*}*/
6340           goto EXPAND_FAILED_CURLY;
6341           }
6342
6343         sub[i] = expand_string_internal(s+1,
6344               ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6345         if (!sub[i])     goto EXPAND_FAILED;                            /*{{*/
6346         if (*s++ != '}')
6347           {
6348           expand_string_message = string_sprintf(
6349             "missing '}' closing arg %d of listextract", i+1);
6350           goto EXPAND_FAILED_CURLY;
6351           }
6352
6353         /* After removal of leading and trailing white space, the first
6354         argument must be numeric and nonempty. */
6355
6356         if (i == 0)
6357           {
6358           int len;
6359           int x = 0;
6360           uschar *p = sub[0];
6361
6362           Uskip_whitespace(&p);
6363           sub[0] = p;
6364
6365           len = Ustrlen(p);
6366           while (len > 0 && isspace(p[len-1])) len--;
6367           p[len] = 0;
6368
6369           if (!*p && !(flags & ESI_SKIPPING))
6370             {
6371             expand_string_message = US"first argument of \"listextract\" must "
6372               "not be empty";
6373             goto EXPAND_FAILED;
6374             }
6375
6376           if (*p == '-')
6377             {
6378             field_number = -1;
6379             p++;
6380             }
6381           while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
6382           if (*p)
6383             {
6384             expand_string_message = US"first argument of \"listextract\" must "
6385               "be numeric";
6386             goto EXPAND_FAILED;
6387             }
6388           field_number *= x;
6389           }
6390         }
6391
6392       /* Extract the numbered element into $value. If
6393       skipping, just pretend the extraction failed. */
6394
6395       lookup_value = flags & ESI_SKIPPING ? NULL : expand_getlistele(field_number, sub[1]);
6396
6397       /* If no string follows, $value gets substituted; otherwise there can
6398       be yes/no strings, as for lookup or if. */
6399
6400       switch(process_yesno(
6401                flags,                           /* were previously skipping */
6402                lookup_value != NULL,            /* success/failure indicator */
6403                save_lookup_value,               /* value to reset for string2 */
6404                &s,                              /* input pointer */
6405                &yield,                          /* output pointer */
6406                US"listextract",                 /* condition type */
6407                &resetok))
6408         {
6409         case 1: goto EXPAND_FAILED;          /* when all is well, the */
6410         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
6411         }
6412
6413       /* All done - restore numerical variables. */
6414
6415       restore_expand_strings(save_expand_nmax, save_expand_nstring,
6416         save_expand_nlength);
6417
6418       if (flags & ESI_SKIPPING) continue;
6419       break;
6420       }
6421
6422     case EITEM_LISTQUOTE:
6423       {
6424       uschar * sub[2];
6425       switch(read_subs(sub, 2, 2, &s, flags, TRUE, name, &resetok, NULL))
6426         {
6427         case -1: continue;      /* skipping */
6428         case 1: goto EXPAND_FAILED_CURLY;
6429         case 2:
6430         case 3: goto EXPAND_FAILED;
6431         }
6432       if (*sub[1]) for (uschar sep = *sub[0], c; c = *sub[1]; sub[1]++)
6433         {
6434         if (c == sep) yield = string_catn(yield, sub[1], 1);
6435         yield = string_catn(yield, sub[1], 1);
6436         }
6437       else yield = string_catn(yield, US" ", 1);
6438       break;
6439       }
6440
6441 #ifndef DISABLE_TLS
6442     case EITEM_CERTEXTRACT:
6443       {
6444       uschar * save_lookup_value = lookup_value, * sub[2];
6445       int save_expand_nmax =
6446         save_expand_strings(save_expand_nstring, save_expand_nlength);
6447
6448       /* Read the field argument */
6449       if (Uskip_whitespace(&s) != '{')                                  /*}*/
6450         {
6451         expand_string_message = US"missing '{' for field arg of certextract";
6452         goto EXPAND_FAILED_CURLY;                                       /*}*/
6453         }
6454       sub[0] = expand_string_internal(s+1,
6455                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6456       if (!sub[0])     goto EXPAND_FAILED;                              /*{{*/
6457       if (*s++ != '}')
6458         {
6459         expand_string_message = US"missing '}' closing field arg of certextract";
6460         goto EXPAND_FAILED_CURLY;
6461         }
6462       /* strip spaces fore & aft */
6463       {
6464       int len;
6465       uschar *p = sub[0];
6466
6467       Uskip_whitespace(&p);
6468       sub[0] = p;
6469
6470       len = Ustrlen(p);
6471       while (len > 0 && isspace(p[len-1])) len--;
6472       p[len] = 0;
6473       }
6474
6475       /* inspect the cert argument */
6476       if (Uskip_whitespace(&s) != '{')                                  /*}*/
6477         {
6478         expand_string_message = US"missing '{' for cert variable arg of certextract";
6479         goto EXPAND_FAILED_CURLY;                                       /*}*/
6480         }
6481       if (*++s != '$')
6482         {
6483         expand_string_message = US"second argument of \"certextract\" must "
6484           "be a certificate variable";
6485         goto EXPAND_FAILED;
6486         }
6487       sub[1] = expand_string_internal(s+1,
6488                 ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s, &resetok, NULL);
6489       if (!sub[1])     goto EXPAND_FAILED;                              /*{{*/
6490       if (*s++ != '}')
6491         {
6492         expand_string_message = US"missing '}' closing cert variable arg of certextract";
6493         goto EXPAND_FAILED_CURLY;
6494         }
6495
6496       if (flags & ESI_SKIPPING)
6497         lookup_value = NULL;
6498       else
6499         {
6500         lookup_value = expand_getcertele(sub[0], sub[1]);
6501         if (*expand_string_message) goto EXPAND_FAILED;
6502         }
6503       switch(process_yesno(
6504                flags,                           /* were previously skipping */
6505                lookup_value != NULL,            /* success/failure indicator */
6506                save_lookup_value,               /* value to reset for string2 */
6507                &s,                              /* input pointer */
6508                &yield,                          /* output pointer */
6509                US"certextract",                 /* condition type */
6510                &resetok))
6511         {
6512         case 1: goto EXPAND_FAILED;          /* when all is well, the */
6513         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
6514         }
6515
6516       restore_expand_strings(save_expand_nmax, save_expand_nstring,
6517         save_expand_nlength);
6518       if (flags & ESI_SKIPPING) continue;
6519       break;
6520       }
6521 #endif  /*DISABLE_TLS*/
6522
6523     /* Handle list operations */
6524
6525     case EITEM_FILTER:
6526     case EITEM_MAP:
6527     case EITEM_REDUCE:
6528       {
6529       int sep = 0, save_ptr = gstring_length(yield);
6530       uschar outsep[2] = { '\0', '\0' };
6531       const uschar *list, *expr, *temp;
6532       uschar * save_iterate_item = iterate_item;
6533       uschar * save_lookup_value = lookup_value;
6534
6535       Uskip_whitespace(&s);
6536       if (*s++ != '{')                                                  /*}*/
6537         {
6538         expand_string_message =
6539           string_sprintf("missing '{' for first arg of %s", name);
6540         goto EXPAND_FAILED_CURLY;                                       /*}*/
6541         }
6542
6543       if (!(list = expand_string_internal(s,
6544               ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
6545         goto EXPAND_FAILED;                                             /*{{*/
6546       if (*s++ != '}')
6547         {
6548         expand_string_message =
6549           string_sprintf("missing '}' closing first arg of %s", name);
6550         goto EXPAND_FAILED_CURLY;
6551         }
6552
6553       if (item_type == EITEM_REDUCE)
6554         {
6555         uschar * t;
6556         Uskip_whitespace(&s);
6557         if (*s++ != '{')                                                /*}*/
6558           {
6559           expand_string_message = US"missing '{' for second arg of reduce";
6560           goto EXPAND_FAILED_CURLY;                                     /*}*/
6561           }
6562         t = expand_string_internal(s,
6563               ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6564         if (!t) goto EXPAND_FAILED;
6565         lookup_value = t;                                               /*{{*/
6566         if (*s++ != '}')
6567           {
6568           expand_string_message = US"missing '}' closing second arg of reduce";
6569           goto EXPAND_FAILED_CURLY;
6570           }
6571         }
6572
6573       Uskip_whitespace(&s);
6574       if (*s++ != '{')                                                  /*}*/
6575         {
6576         expand_string_message =
6577           string_sprintf("missing '{' for last arg of %s", name);       /*}*/
6578         goto EXPAND_FAILED_CURLY;
6579         }
6580
6581       expr = s;
6582
6583       /* For EITEM_FILTER, call eval_condition once, with result discarded (as
6584       if scanning a "false" part). This allows us to find the end of the
6585       condition, because if the list is empty, we won't actually evaluate the
6586       condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
6587       the normal internal expansion function. */
6588
6589       if (item_type != EITEM_FILTER)
6590         temp = expand_string_internal(s,
6591           ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL);
6592       else
6593         if ((temp = eval_condition(expr, &resetok, NULL))) s = temp;
6594
6595       if (!temp)
6596         {
6597         expand_string_message = string_sprintf("%s inside \"%s\" item",
6598           expand_string_message, name);
6599         goto EXPAND_FAILED;
6600         }
6601
6602       Uskip_whitespace(&s);                                             /*{{{*/
6603       if (*s++ != '}')
6604         {
6605         expand_string_message = string_sprintf("missing } at end of condition "
6606           "or expression inside \"%s\"; could be an unquoted } in the content",
6607           name);
6608         goto EXPAND_FAILED;
6609         }
6610
6611       Uskip_whitespace(&s);                                             /*{{*/
6612       if (*s++ != '}')
6613         {
6614         expand_string_message = string_sprintf("missing } at end of \"%s\"",
6615           name);
6616         goto EXPAND_FAILED;
6617         }
6618
6619       /* If we are skipping, we can now just move on to the next item. When
6620       processing for real, we perform the iteration. */
6621
6622       if (flags & ESI_SKIPPING) continue;
6623       while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
6624         {
6625         *outsep = (uschar)sep;      /* Separator as a string */
6626
6627         DEBUG(D_expand) debug_printf_indent("%s: $item = '%s'  $value = '%s'\n",
6628                           name, iterate_item, lookup_value);
6629
6630         if (item_type == EITEM_FILTER)
6631           {
6632           BOOL condresult;
6633           /* the condition could modify $value, as a side-effect */
6634           uschar * save_value = lookup_value;
6635
6636           if (!eval_condition(expr, &resetok, &condresult))
6637             {
6638             iterate_item = save_iterate_item;
6639             lookup_value = save_lookup_value;
6640             expand_string_message = string_sprintf("%s inside \"%s\" condition",
6641               expand_string_message, name);
6642             goto EXPAND_FAILED;
6643             }
6644           lookup_value = save_value;
6645           DEBUG(D_expand) debug_printf_indent("%s: condition is %s\n", name,
6646             condresult? "true":"false");
6647           if (condresult)
6648             temp = iterate_item;    /* TRUE => include this item */
6649           else
6650             continue;               /* FALSE => skip this item */
6651           }
6652
6653         else                    /* EITEM_MAP and EITEM_REDUCE */
6654           {
6655           /* the expansion could modify $value, as a side-effect */
6656           uschar * t = expand_string_internal(expr,
6657             ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, NULL, &resetok, NULL);
6658           if (!(temp = t))
6659             {
6660             iterate_item = save_iterate_item;
6661             expand_string_message = string_sprintf("%s inside \"%s\" item",
6662               expand_string_message, name);
6663             goto EXPAND_FAILED;
6664             }
6665           if (item_type == EITEM_REDUCE)
6666             {
6667             lookup_value = t;         /* Update the value of $value */
6668             continue;                 /* and continue the iteration */
6669             }
6670           }
6671
6672         /* We reach here for FILTER if the condition is true, always for MAP,
6673         and never for REDUCE. The value in "temp" is to be added to the output
6674         list that is being created, ensuring that any occurrences of the
6675         separator character are doubled. Unless we are dealing with the first
6676         item of the output list, add in a space if the new item begins with the
6677         separator character, or is an empty string. */
6678
6679 /*XXX is there not a standard support function for this, appending to a list? */
6680 /* yes, string_append_listele(), but it depends on lack of text before the list */
6681
6682         if (  yield && yield->ptr != save_ptr
6683            && (temp[0] == *outsep || temp[0] == 0))
6684           yield = string_catn(yield, US" ", 1);
6685
6686         /* Add the string in "temp" to the output list that we are building,
6687         This is done in chunks by searching for the separator character. */
6688
6689         for (;;)
6690           {
6691           size_t seglen = Ustrcspn(temp, outsep);
6692
6693           yield = string_catn(yield, temp, seglen + 1);
6694
6695           /* If we got to the end of the string we output one character
6696           too many; backup and end the loop. Otherwise arrange to double the
6697           separator. */
6698
6699           if (!temp[seglen]) { yield->ptr--; break; }
6700           yield = string_catn(yield, outsep, 1);
6701           temp += seglen + 1;
6702           }
6703
6704         /* Output a separator after the string: we will remove the redundant
6705         final one at the end. */
6706
6707         yield = string_catn(yield, outsep, 1);
6708         }   /* End of iteration over the list loop */
6709
6710       /* REDUCE has generated no output above: output the final value of
6711       $value. */
6712
6713       if (item_type == EITEM_REDUCE)
6714         {
6715         yield = string_cat(yield, lookup_value);
6716         lookup_value = save_lookup_value;  /* Restore $value */
6717         }
6718
6719       /* FILTER and MAP generate lists: if they have generated anything, remove
6720       the redundant final separator. Even though an empty item at the end of a
6721       list does not count, this is tidier. */
6722
6723       else if (yield && yield->ptr != save_ptr) yield->ptr--;
6724
6725       /* Restore preserved $item */
6726
6727       iterate_item = save_iterate_item;
6728       if (flags & ESI_SKIPPING) continue;
6729       break;
6730       }
6731
6732     case EITEM_SORT:
6733       {
6734       int sep = 0, cond_type;
6735       const uschar * srclist, * cmp, * xtract;
6736       uschar * opname, * srcitem;
6737       const uschar * dstlist = NULL, * dstkeylist = NULL;
6738       uschar * tmp, * save_iterate_item = iterate_item;
6739
6740       Uskip_whitespace(&s);
6741       if (*s++ != '{')                                                  /*}*/
6742         {
6743         expand_string_message = US"missing '{' for list arg of sort";
6744         goto EXPAND_FAILED_CURLY;                                       /*}*/
6745         }
6746
6747       srclist = expand_string_internal(s,
6748               ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6749       if (!srclist) goto EXPAND_FAILED;                                 /*{{*/
6750       if (*s++ != '}')
6751         {
6752         expand_string_message = US"missing '}' closing list arg of sort";
6753         goto EXPAND_FAILED_CURLY;
6754         }
6755
6756       Uskip_whitespace(&s);
6757       if (*s++ != '{')                                                  /*}*/
6758         {
6759         expand_string_message = US"missing '{' for comparator arg of sort";
6760         goto EXPAND_FAILED_CURLY;                                       /*}*/
6761         }
6762
6763       cmp = expand_string_internal(s,
6764               ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s, &resetok, NULL);
6765       if (!cmp) goto EXPAND_FAILED;                                     /*{{*/
6766       if (*s++ != '}')
6767         {
6768         expand_string_message = US"missing '}' closing comparator arg of sort";
6769         goto EXPAND_FAILED_CURLY;
6770         }
6771
6772       if ((cond_type = identify_operator(&cmp, &opname)) == -1)
6773         {
6774         if (!expand_string_message)
6775           expand_string_message = string_sprintf("unknown condition \"%s\"", s);
6776         goto EXPAND_FAILED;
6777         }
6778       switch(cond_type)
6779         {
6780         case ECOND_NUM_L: case ECOND_NUM_LE:
6781         case ECOND_NUM_G: case ECOND_NUM_GE:
6782         case ECOND_STR_GE: case ECOND_STR_GEI: case ECOND_STR_GT: case ECOND_STR_GTI:
6783         case ECOND_STR_LE: case ECOND_STR_LEI: case ECOND_STR_LT: case ECOND_STR_LTI:
6784           break;
6785
6786         default:
6787           expand_string_message = US"comparator not handled for sort";
6788           goto EXPAND_FAILED;
6789         }
6790
6791       Uskip_whitespace(&s);
6792       if (*s++ != '{')                                                  /*}*/
6793         {
6794         expand_string_message = US"missing '{' for extractor arg of sort";
6795         goto EXPAND_FAILED_CURLY;                                       /*}*/
6796         }
6797
6798       xtract = s;
6799       if (!(tmp = expand_string_internal(s,
6800         ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL)))
6801         goto EXPAND_FAILED;
6802       xtract = string_copyn(xtract, s - xtract);
6803                                                                         /*{{*/
6804       if (*s++ != '}')
6805         {
6806         expand_string_message = US"missing '}' closing extractor arg of sort";
6807         goto EXPAND_FAILED_CURLY;
6808         }
6809                                                                         /*{{*/
6810       if (*s++ != '}')
6811         {
6812         expand_string_message = US"missing } at end of \"sort\"";
6813         goto EXPAND_FAILED;
6814         }
6815
6816       if (flags & ESI_SKIPPING) continue;
6817
6818       while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
6819         {
6820         uschar * srcfield, * dstitem;
6821         gstring * newlist = NULL, * newkeylist = NULL;
6822
6823         DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);
6824
6825         /* extract field for comparisons */
6826         iterate_item = srcitem;
6827         if (  !(srcfield = expand_string_internal(xtract,
6828                                   ESI_HONOR_DOLLAR, NULL, &resetok, NULL))
6829            || !*srcfield)
6830           {
6831           expand_string_message = string_sprintf(
6832               "field-extract in sort: \"%s\"", xtract);
6833           goto EXPAND_FAILED;
6834           }
6835
6836         /* Insertion sort */
6837
6838         /* copy output list until new-item < list-item */
6839         while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6840           {
6841           uschar * dstfield;
6842
6843           /* field for comparison */
6844           if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6845             goto SORT_MISMATCH;
6846
6847           /* String-comparator names start with a letter; numeric names do not */
6848
6849           if (sortsbefore(cond_type, isalpha(opname[0]),
6850               srcfield, dstfield))
6851             {
6852             /* New-item sorts before this dst-item.  Append new-item,
6853             then dst-item, then remainder of dst list. */
6854
6855             newlist = string_append_listele(newlist, sep, srcitem);
6856             newkeylist = string_append_listele(newkeylist, sep, srcfield);
6857             srcitem = NULL;
6858
6859             newlist = string_append_listele(newlist, sep, dstitem);
6860             newkeylist = string_append_listele(newkeylist, sep, dstfield);
6861
6862 /*XXX why field-at-a-time copy?  Why not just dup the rest of the list? */
6863             while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6864               {
6865               if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6866                 goto SORT_MISMATCH;
6867               newlist = string_append_listele(newlist, sep, dstitem);
6868               newkeylist = string_append_listele(newkeylist, sep, dstfield);
6869               }
6870
6871             break;
6872             }
6873
6874           newlist = string_append_listele(newlist, sep, dstitem);
6875           newkeylist = string_append_listele(newkeylist, sep, dstfield);
6876           }
6877
6878         /* If we ran out of dstlist without consuming srcitem, append it */
6879         if (srcitem)
6880           {
6881           newlist = string_append_listele(newlist, sep, srcitem);
6882           newkeylist = string_append_listele(newkeylist, sep, srcfield);
6883           }
6884
6885         dstlist = newlist->s;
6886         dstkeylist = newkeylist->s;
6887
6888         DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);
6889         DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6890         }
6891
6892       if (dstlist)
6893         yield = string_cat(yield, dstlist);
6894
6895       /* Restore preserved $item */
6896       iterate_item = save_iterate_item;
6897       break;
6898
6899       SORT_MISMATCH:
6900         expand_string_message = US"Internal error in sort (list mismatch)";
6901         goto EXPAND_FAILED;
6902       }
6903
6904
6905     /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6906     functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6907     or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6908     a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6909
6910     #define EXPAND_DLFUNC_MAX_ARGS 8
6911
6912     case EITEM_DLFUNC:
6913 #ifndef EXPAND_DLFUNC
6914       expand_string_message = US"\"${dlfunc\" encountered, but this facility "  /*}*/
6915         "is not included in this binary";
6916       goto EXPAND_FAILED;
6917
6918 #else   /* EXPAND_DLFUNC */
6919       {
6920       tree_node * t;
6921       exim_dlfunc_t * func;
6922       uschar * result;
6923       int status, argc;
6924       uschar * argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6925
6926       if (expand_forbid & RDO_DLFUNC)
6927         {
6928         expand_string_message =
6929           US"dynamically-loaded functions are not permitted";
6930         goto EXPAND_FAILED;
6931         }
6932
6933       switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, flags,
6934            TRUE, name, &resetok, NULL))
6935         {
6936         case -1: continue;      /* skipping */
6937         case 1: goto EXPAND_FAILED_CURLY;
6938         case 2:
6939         case 3: goto EXPAND_FAILED;
6940         }
6941
6942       /* Look up the dynamically loaded object handle in the tree. If it isn't
6943       found, dlopen() the file and put the handle in the tree for next time. */
6944
6945       if (!(t = tree_search(dlobj_anchor, argv[0])))
6946         {
6947         void * handle = dlopen(CS argv[0], RTLD_LAZY);
6948         if (!handle)
6949           {
6950           expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6951             argv[0], dlerror());
6952           log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6953           goto EXPAND_FAILED;
6954           }
6955         t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]), argv[0]);
6956         Ustrcpy(t->name, argv[0]);
6957         t->data.ptr = handle;
6958         (void)tree_insertnode(&dlobj_anchor, t);
6959         }
6960
6961       /* Having obtained the dynamically loaded object handle, look up the
6962       function pointer. */
6963
6964       if (!(func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1])))
6965         {
6966         expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
6967           "%s", argv[1], argv[0], dlerror());
6968         log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6969         goto EXPAND_FAILED;
6970         }
6971
6972       /* Call the function and work out what to do with the result. If it
6973       returns OK, we have a replacement string; if it returns DEFER then
6974       expansion has failed in a non-forced manner; if it returns FAIL then
6975       failure was forced; if it returns ERROR or any other value there's a
6976       problem, so panic slightly. In any case, assume that the function has
6977       side-effects on the store that must be preserved. */
6978
6979       resetok = FALSE;
6980       result = NULL;
6981       for (argc = 0; argv[argc]; argc++) ;
6982
6983       if ((status = func(&result, argc - 2, &argv[2])) != OK)
6984         {
6985         expand_string_message = result ? result : US"(no message)";
6986         if (status == FAIL_FORCED)
6987           f.expand_string_forcedfail = TRUE;
6988         else if (status != FAIL)
6989           log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
6990               argv[0], argv[1], status, expand_string_message);
6991         goto EXPAND_FAILED;
6992         }
6993
6994       if (result) yield = string_cat(yield, result);
6995       break;
6996       }
6997 #endif /* EXPAND_DLFUNC */
6998
6999     case EITEM_ENV:     /* ${env {name} {val_if_found} {val_if_unfound}} */
7000       {
7001       uschar * key;
7002       uschar *save_lookup_value = lookup_value;
7003
7004       if (Uskip_whitespace(&s) != '{')                                  /*}*/
7005         goto EXPAND_FAILED;
7006
7007       key = expand_string_internal(s+1,
7008               ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
7009       if (!key) goto EXPAND_FAILED;                                     /*{{*/
7010       if (*s++ != '}')
7011         {
7012         expand_string_message = US"missing '}' for name arg of env";
7013         goto EXPAND_FAILED_CURLY;
7014         }
7015
7016       lookup_value = US getenv(CS key);
7017
7018       switch(process_yesno(
7019                flags,                           /* were previously skipping */
7020                lookup_value != NULL,            /* success/failure indicator */
7021                save_lookup_value,               /* value to reset for string2 */
7022                &s,                              /* input pointer */
7023                &yield,                          /* output pointer */
7024                US"env",                         /* condition type */
7025                &resetok))
7026         {
7027         case 1: goto EXPAND_FAILED;          /* when all is well, the */
7028         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
7029         }
7030       if (flags & ESI_SKIPPING) continue;
7031       break;
7032       }
7033
7034 #ifdef SUPPORT_SRS
7035     case EITEM_SRS_ENCODE:
7036       /* ${srs_encode {secret} {return_path} {orig_domain}} */
7037       {
7038       uschar * sub[3];
7039       uschar cksum[4];
7040       gstring * g = NULL;
7041       BOOL quoted = FALSE;
7042
7043       switch (read_subs(sub, 3, 3, CUSS &s, flags, TRUE, name, &resetok, NULL))
7044         {
7045         case -1: continue;      /* skipping */
7046         case 1: goto EXPAND_FAILED_CURLY;
7047         case 2:
7048         case 3: goto EXPAND_FAILED;
7049         }
7050
7051       if (sub[1] && *(sub[1]))
7052         {
7053         g = string_catn(g, US"SRS0=", 5);
7054
7055         /* ${l_4:${hmac{md5}{SRS_SECRET}{${lc:$return_path}}}}= */
7056         hmac_md5(sub[0], string_copylc(sub[1]), cksum, sizeof(cksum));
7057         g = string_catn(g, cksum, sizeof(cksum));
7058         g = string_catn(g, US"=", 1);
7059
7060         /* ${base32:${eval:$tod_epoch/86400&0x3ff}}= */
7061           {
7062           struct timeval now;
7063           unsigned long i;
7064           gstring * h = NULL;
7065
7066           gettimeofday(&now, NULL);
7067           for (unsigned long i = (now.tv_sec / 86400) & 0x3ff; i; i >>= 5)
7068             h = string_catn(h, &base32_chars[i & 0x1f], 1);
7069           if (h) while (h->ptr > 0)
7070             g = string_catn(g, &h->s[--h->ptr], 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(n));
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 */