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