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     {
2767       const uschar *errp;
2768       const uschar **errpp;
2769       DEBUG(D_expand) errpp = &errp; else errpp = 0;
2770       if (0 == (rc = string_is_ip_addressX(sub[0], NULL, errpp)))
2771         DEBUG(D_expand) debug_printf("failed: %s\n", errp);
2772
2773       *yield = ( cond_type == ECOND_ISIP  ? rc != 0 :
2774                  cond_type == ECOND_ISIP4 ? rc == 4 : rc == 6) == testfor;
2775     }
2776
2777     break;
2778
2779     /* Various authentication tests - all optionally compiled */
2780
2781     case ECOND_PAM:
2782     #ifdef SUPPORT_PAM
2783     rc = auth_call_pam(sub[0], &expand_string_message);
2784     goto END_AUTH;
2785     #else
2786     goto COND_FAILED_NOT_COMPILED;
2787     #endif  /* SUPPORT_PAM */
2788
2789     case ECOND_RADIUS:
2790     #ifdef RADIUS_CONFIG_FILE
2791     rc = auth_call_radius(sub[0], &expand_string_message);
2792     goto END_AUTH;
2793     #else
2794     goto COND_FAILED_NOT_COMPILED;
2795     #endif  /* RADIUS_CONFIG_FILE */
2796
2797     case ECOND_LDAPAUTH:
2798     #ifdef LOOKUP_LDAP
2799       {
2800       /* Just to keep the interface the same */
2801       BOOL do_cache;
2802       int old_pool = store_pool;
2803       store_pool = POOL_SEARCH;
2804       rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2805         &expand_string_message, &do_cache);
2806       store_pool = old_pool;
2807       }
2808     goto END_AUTH;
2809     #else
2810     goto COND_FAILED_NOT_COMPILED;
2811     #endif  /* LOOKUP_LDAP */
2812
2813     case ECOND_PWCHECK:
2814     #ifdef CYRUS_PWCHECK_SOCKET
2815     rc = auth_call_pwcheck(sub[0], &expand_string_message);
2816     goto END_AUTH;
2817     #else
2818     goto COND_FAILED_NOT_COMPILED;
2819     #endif  /* CYRUS_PWCHECK_SOCKET */
2820
2821     #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2822         defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2823     END_AUTH:
2824     if (rc == ERROR || rc == DEFER) return NULL;
2825     *yield = (rc == OK) == testfor;
2826     #endif
2827     }
2828   return s;
2829
2830
2831   /* call ACL (in a conditional context).  Accept true, deny false.
2832   Defer is a forced-fail.  Anything set by message= goes to $value.
2833   Up to ten parameters are used; we use the braces round the name+args
2834   like the saslauthd condition does, to permit a variable number of args.
2835   See also the expansion-item version EITEM_ACL and the traditional
2836   acl modifier ACLC_ACL.
2837   Since the ACL may allocate new global variables, tell our caller to not
2838   reclaim memory.
2839   */
2840
2841   case ECOND_ACL:
2842     /* ${if acl {{name}{arg1}{arg2}...}  {yes}{no}} */
2843     {
2844     uschar *sub[10];
2845     uschar *user_msg;
2846     BOOL cond = FALSE;
2847
2848     Uskip_whitespace(&s);
2849     if (*s++ != '{') goto COND_FAILED_CURLY_START;      /*}*/
2850
2851     switch(read_subs(sub, nelem(sub), 1, &s,
2852         yield ? ESI_NOFLAGS : ESI_SKIPPING, TRUE, name, resetok, NULL))
2853       {
2854       case 1: expand_string_message = US"too few arguments or bracketing "
2855         "error for acl";
2856       case 2:
2857       case 3: return NULL;
2858       }
2859
2860     if (yield)
2861       {
2862       int rc;
2863       *resetok = FALSE; /* eval_acl() might allocate; do not reclaim */
2864       switch(rc = eval_acl(sub, nelem(sub), &user_msg))
2865         {
2866         case OK:
2867           cond = TRUE;
2868         case FAIL:
2869           lookup_value = NULL;
2870           if (user_msg)
2871             lookup_value = string_copy(user_msg);
2872           *yield = cond == testfor;
2873           break;
2874
2875         case DEFER:
2876           f.expand_string_forcedfail = TRUE;
2877           /*FALLTHROUGH*/
2878         default:
2879           expand_string_message = string_sprintf("%s from acl \"%s\"",
2880             rc_names[rc], sub[0]);
2881           return NULL;
2882         }
2883       }
2884     return s;
2885     }
2886
2887
2888   /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2889
2890      ${if saslauthd {{username}{password}{service}{realm}}  {yes}{no}}
2891
2892   However, the last two are optional. That is why the whole set is enclosed
2893   in their own set of braces. */
2894
2895   case ECOND_SASLAUTHD:
2896 #ifndef CYRUS_SASLAUTHD_SOCKET
2897     goto COND_FAILED_NOT_COMPILED;
2898 #else
2899     {
2900     uschar *sub[4];
2901     Uskip_whitespace(&s);
2902     if (*s++ != '{') goto COND_FAILED_CURLY_START;      /* }-for-text-editors */
2903     switch(read_subs(sub, nelem(sub), 2, &s,
2904         yield ? ESI_NOFLAGS : ESI_SKIPPING, TRUE, name, resetok, NULL))
2905       {
2906       case 1: expand_string_message = US"too few arguments or bracketing "
2907         "error for saslauthd";
2908       case 2:
2909       case 3: return NULL;
2910       }
2911     if (!sub[2]) sub[3] = NULL;  /* realm if no service */
2912     if (yield)
2913       {
2914       int rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2915         &expand_string_message);
2916       if (rc == ERROR || rc == DEFER) return NULL;
2917       *yield = (rc == OK) == testfor;
2918       }
2919     return s;
2920     }
2921 #endif /* CYRUS_SASLAUTHD_SOCKET */
2922
2923
2924   /* symbolic operators for numeric and string comparison, and a number of
2925   other operators, all requiring two arguments.
2926
2927   crypteq:           encrypts plaintext and compares against an encrypted text,
2928                        using crypt(), crypt16(), MD5 or SHA-1
2929   inlist/inlisti:    checks if first argument is in the list of the second
2930   match:             does a regular expression match and sets up the numerical
2931                        variables if it succeeds
2932   match_address:     matches in an address list
2933   match_domain:      matches in a domain list
2934   match_ip:          matches a host list that is restricted to IP addresses
2935   match_local_part:  matches in a local part list
2936   */
2937
2938   case ECOND_MATCH_ADDRESS:
2939   case ECOND_MATCH_DOMAIN:
2940   case ECOND_MATCH_IP:
2941   case ECOND_MATCH_LOCAL_PART:
2942 #ifndef EXPAND_LISTMATCH_RHS
2943     sub2_honour_dollar = FALSE;
2944 #endif
2945     /* FALLTHROUGH */
2946
2947   case ECOND_CRYPTEQ:
2948   case ECOND_INLIST:
2949   case ECOND_INLISTI:
2950   case ECOND_MATCH:
2951
2952   case ECOND_NUM_L:     /* Numerical comparisons */
2953   case ECOND_NUM_LE:
2954   case ECOND_NUM_E:
2955   case ECOND_NUM_EE:
2956   case ECOND_NUM_G:
2957   case ECOND_NUM_GE:
2958
2959   case ECOND_STR_LT:    /* String comparisons */
2960   case ECOND_STR_LTI:
2961   case ECOND_STR_LE:
2962   case ECOND_STR_LEI:
2963   case ECOND_STR_EQ:
2964   case ECOND_STR_EQI:
2965   case ECOND_STR_GT:
2966   case ECOND_STR_GTI:
2967   case ECOND_STR_GE:
2968   case ECOND_STR_GEI:
2969
2970   for (int i = 0; i < 2; i++)
2971     {
2972     BOOL textonly;
2973     /* Sometimes, we don't expand substrings; too many insecure configurations
2974     created using match_address{}{} and friends, where the second param
2975     includes information from untrustworthy sources. */
2976     /*XXX is this moot given taint-tracking? */
2977
2978     esi_flags flags = ESI_BRACE_ENDS;
2979
2980     if (!(i > 0 && !sub2_honour_dollar)) flags |= ESI_HONOR_DOLLAR;
2981     if (!yield) flags |= ESI_SKIPPING;
2982
2983     if (Uskip_whitespace(&s) != '{')
2984       {
2985       if (i == 0) goto COND_FAILED_CURLY_START;
2986       expand_string_message = string_sprintf("missing 2nd string in {} "
2987         "after \"%s\"", opname);
2988       return NULL;
2989       }
2990     if (!(sub[i] = expand_string_internal(s+1, flags, &s, resetok, &textonly)))
2991       return NULL;
2992     if (textonly) sub_textonly |= BIT(i);
2993     DEBUG(D_expand) if (i == 1 && !sub2_honour_dollar && Ustrchr(sub[1], '$'))
2994       debug_printf_indent("WARNING: the second arg is NOT expanded,"
2995                         " for security reasons\n");
2996     if (*s++ != '}') goto COND_FAILED_CURLY_END;
2997
2998     /* Convert to numerical if required; we know that the names of all the
2999     conditions that compare numbers do not start with a letter. This just saves
3000     checking for them individually. */
3001
3002     if (!isalpha(opname[0]) && yield)
3003       if (sub[i][0] == 0)
3004         {
3005         num[i] = 0;
3006         DEBUG(D_expand)
3007           debug_printf_indent("empty string cast to zero for numerical comparison\n");
3008         }
3009       else
3010         {
3011         num[i] = expanded_string_integer(sub[i], FALSE);
3012         if (expand_string_message) return NULL;
3013         }
3014     }
3015
3016   /* Result not required */
3017
3018   if (!yield) return s;
3019
3020   /* Do an appropriate comparison */
3021
3022   switch(cond_type)
3023     {
3024     case ECOND_NUM_E:
3025     case ECOND_NUM_EE:
3026       tempcond = (num[0] == num[1]); break;
3027
3028     case ECOND_NUM_G:
3029       tempcond = (num[0] > num[1]); break;
3030
3031     case ECOND_NUM_GE:
3032       tempcond = (num[0] >= num[1]); break;
3033
3034     case ECOND_NUM_L:
3035       tempcond = (num[0] < num[1]); break;
3036
3037     case ECOND_NUM_LE:
3038       tempcond = (num[0] <= num[1]); break;
3039
3040     case ECOND_STR_LT:
3041       tempcond = (Ustrcmp(sub[0], sub[1]) < 0); break;
3042
3043     case ECOND_STR_LTI:
3044       tempcond = (strcmpic(sub[0], sub[1]) < 0); break;
3045
3046     case ECOND_STR_LE:
3047       tempcond = (Ustrcmp(sub[0], sub[1]) <= 0); break;
3048
3049     case ECOND_STR_LEI:
3050       tempcond = (strcmpic(sub[0], sub[1]) <= 0); break;
3051
3052     case ECOND_STR_EQ:
3053       tempcond = (Ustrcmp(sub[0], sub[1]) == 0); break;
3054
3055     case ECOND_STR_EQI:
3056       tempcond = (strcmpic(sub[0], sub[1]) == 0); break;
3057
3058     case ECOND_STR_GT:
3059       tempcond = (Ustrcmp(sub[0], sub[1]) > 0); break;
3060
3061     case ECOND_STR_GTI:
3062       tempcond = (strcmpic(sub[0], sub[1]) > 0); break;
3063
3064     case ECOND_STR_GE:
3065       tempcond = (Ustrcmp(sub[0], sub[1]) >= 0); break;
3066
3067     case ECOND_STR_GEI:
3068       tempcond = (strcmpic(sub[0], sub[1]) >= 0); break;
3069
3070     case ECOND_MATCH:   /* Regular expression match */
3071       {
3072       const pcre2_code * re = regex_compile(sub[1],
3073                   sub_textonly & BIT(1) ? MCS_CACHEABLE : MCS_NOFLAGS,
3074                   &expand_string_message, pcre_gen_cmp_ctx);
3075       if (!re)
3076         return NULL;
3077
3078       tempcond = regex_match_and_setup(re, sub[0], 0, -1);
3079       break;
3080       }
3081
3082     case ECOND_MATCH_ADDRESS:  /* Match in an address list */
3083       rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0,
3084                               CUSS &lookup_value);
3085       goto MATCHED_SOMETHING;
3086
3087     case ECOND_MATCH_DOMAIN:   /* Match in a domain list */
3088       rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
3089         MCL_DOMAIN + MCL_NOEXPAND, TRUE, CUSS &lookup_value);
3090       goto MATCHED_SOMETHING;
3091
3092     case ECOND_MATCH_IP:       /* Match IP address in a host list */
3093       if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
3094         {
3095         expand_string_message = string_sprintf("\"%s\" is not an IP address",
3096           sub[0]);
3097         return NULL;
3098         }
3099       else
3100         {
3101         unsigned int *nullcache = NULL;
3102         check_host_block cb;
3103
3104         cb.host_name = US"";
3105         cb.host_address = sub[0];
3106
3107         /* If the host address starts off ::ffff: it is an IPv6 address in
3108         IPv4-compatible mode. Find the IPv4 part for checking against IPv4
3109         addresses. */
3110
3111         cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
3112           cb.host_address + 7 : cb.host_address;
3113
3114         rc = match_check_list(
3115                &sub[1],                   /* the list */
3116                0,                         /* separator character */
3117                &hostlist_anchor,          /* anchor pointer */
3118                &nullcache,                /* cache pointer */
3119                check_host,                /* function for testing */
3120                &cb,                       /* argument for function */
3121                MCL_HOST,                  /* type of check */
3122                sub[0],                    /* text for debugging */
3123                CUSS &lookup_value);       /* where to pass back data */
3124         }
3125       goto MATCHED_SOMETHING;
3126
3127     case ECOND_MATCH_LOCAL_PART:
3128       rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
3129         MCL_LOCALPART + MCL_NOEXPAND, TRUE, CUSS &lookup_value);
3130       /* Fall through */
3131       /* VVVVVVVVVVVV */
3132       MATCHED_SOMETHING:
3133       switch(rc)
3134         {
3135         case OK:   tempcond = TRUE;  break;
3136         case FAIL: tempcond = FALSE; break;
3137
3138         case DEFER:
3139           expand_string_message = string_sprintf("unable to complete match "
3140             "against \"%s\": %s", sub[1], search_error_message);
3141           return NULL;
3142         }
3143
3144       break;
3145
3146     /* Various "encrypted" comparisons. If the second string starts with
3147     "{" then an encryption type is given. Default to crypt() or crypt16()
3148     (build-time choice). */
3149     /* }-for-text-editors */
3150
3151     case ECOND_CRYPTEQ:
3152     #ifndef SUPPORT_CRYPTEQ
3153       goto COND_FAILED_NOT_COMPILED;
3154     #else
3155       if (strncmpic(sub[1], US"{md5}", 5) == 0)
3156         {
3157         int sublen = Ustrlen(sub[1]+5);
3158         md5 base;
3159         uschar digest[16];
3160
3161         md5_start(&base);
3162         md5_end(&base, sub[0], Ustrlen(sub[0]), digest);
3163
3164         /* If the length that we are comparing against is 24, the MD5 digest
3165         is expressed as a base64 string. This is the way LDAP does it. However,
3166         some other software uses a straightforward hex representation. We assume
3167         this if the length is 32. Other lengths fail. */
3168
3169         if (sublen == 24)
3170           {
3171           uschar *coded = b64encode(CUS digest, 16);
3172           DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
3173             "  subject=%s\n  crypted=%s\n", coded, sub[1]+5);
3174           tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
3175           }
3176         else if (sublen == 32)
3177           {
3178           uschar coded[36];
3179           for (int i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
3180           coded[32] = 0;
3181           DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
3182             "  subject=%s\n  crypted=%s\n", coded, sub[1]+5);
3183           tempcond = (strcmpic(coded, sub[1]+5) == 0);
3184           }
3185         else
3186           {
3187           DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
3188             "fail\n  crypted=%s\n", sub[1]+5);
3189           tempcond = FALSE;
3190           }
3191         }
3192
3193       else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
3194         {
3195         int sublen = Ustrlen(sub[1]+6);
3196         hctx h;
3197         uschar digest[20];
3198
3199         sha1_start(&h);
3200         sha1_end(&h, sub[0], Ustrlen(sub[0]), digest);
3201
3202         /* If the length that we are comparing against is 28, assume the SHA1
3203         digest is expressed as a base64 string. If the length is 40, assume a
3204         straightforward hex representation. Other lengths fail. */
3205
3206         if (sublen == 28)
3207           {
3208           uschar *coded = b64encode(CUS digest, 20);
3209           DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
3210             "  subject=%s\n  crypted=%s\n", coded, sub[1]+6);
3211           tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
3212           }
3213         else if (sublen == 40)
3214           {
3215           uschar coded[44];
3216           for (int i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
3217           coded[40] = 0;
3218           DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
3219             "  subject=%s\n  crypted=%s\n", coded, sub[1]+6);
3220           tempcond = (strcmpic(coded, sub[1]+6) == 0);
3221           }
3222         else
3223           {
3224           DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
3225             "fail\n  crypted=%s\n", sub[1]+6);
3226           tempcond = FALSE;
3227           }
3228         }
3229
3230       else   /* {crypt} or {crypt16} and non-{ at start */
3231              /* }-for-text-editors */
3232         {
3233         int which = 0;
3234         uschar *coded;
3235
3236         if (strncmpic(sub[1], US"{crypt}", 7) == 0)
3237           {
3238           sub[1] += 7;
3239           which = 1;
3240           }
3241         else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
3242           {
3243           sub[1] += 9;
3244           which = 2;
3245           }
3246         else if (sub[1][0] == '{')              /* }-for-text-editors */
3247           {
3248           expand_string_message = string_sprintf("unknown encryption mechanism "
3249             "in \"%s\"", sub[1]);
3250           return NULL;
3251           }
3252
3253         switch(which)
3254           {
3255           case 0:  coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
3256           case 1:  coded = US crypt(CS sub[0], CS sub[1]); break;
3257           default: coded = US crypt16(CS sub[0], CS sub[1]); break;
3258           }
3259
3260         #define STR(s) # s
3261         #define XSTR(s) STR(s)
3262         DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
3263           "  subject=%s\n  crypted=%s\n",
3264           which == 0 ? XSTR(DEFAULT_CRYPT) : which == 1 ? "crypt" : "crypt16",
3265           coded, sub[1]);
3266         #undef STR
3267         #undef XSTR
3268
3269         /* If the encrypted string contains fewer than two characters (for the
3270         salt), force failure. Otherwise we get false positives: with an empty
3271         string the yield of crypt() is an empty string! */
3272
3273         if (coded)
3274           tempcond = Ustrlen(sub[1]) < 2 ? FALSE : Ustrcmp(coded, sub[1]) == 0;
3275         else if (errno == EINVAL)
3276           tempcond = FALSE;
3277         else
3278           {
3279           expand_string_message = string_sprintf("crypt error: %s\n",
3280             US strerror(errno));
3281           return NULL;
3282           }
3283         }
3284       break;
3285     #endif  /* SUPPORT_CRYPTEQ */
3286
3287     case ECOND_INLIST:
3288     case ECOND_INLISTI:
3289       {
3290       const uschar * list = sub[1];
3291       int sep = 0;
3292       uschar *save_iterate_item = iterate_item;
3293       int (*compare)(const uschar *, const uschar *);
3294
3295       DEBUG(D_expand) debug_printf_indent("condition: %s  item: %s\n", opname, sub[0]);
3296
3297       tempcond = FALSE;
3298       compare = cond_type == ECOND_INLISTI
3299         ? strcmpic : (int (*)(const uschar *, const uschar *)) strcmp;
3300
3301       while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
3302         {
3303         DEBUG(D_expand) debug_printf_indent(" compare %s\n", iterate_item);
3304         if (compare(sub[0], iterate_item) == 0)
3305           {
3306           tempcond = TRUE;
3307           lookup_value = iterate_item;
3308           break;
3309           }
3310         }
3311       iterate_item = save_iterate_item;
3312       }
3313
3314     }   /* Switch for comparison conditions */
3315
3316   *yield = tempcond == testfor;
3317   return s;    /* End of comparison conditions */
3318
3319
3320   /* and/or: computes logical and/or of several conditions */
3321
3322   case ECOND_AND:
3323   case ECOND_OR:
3324   subcondptr = (yield == NULL) ? NULL : &tempcond;
3325   combined_cond = (cond_type == ECOND_AND);
3326
3327   Uskip_whitespace(&s);
3328   if (*s++ != '{') goto COND_FAILED_CURLY_START;        /* }-for-text-editors */
3329
3330   for (;;)
3331     {
3332     /* {-for-text-editors */
3333     if (Uskip_whitespace(&s) == '}') break;
3334     if (*s != '{')                                      /* }-for-text-editors */
3335       {
3336       expand_string_message = string_sprintf("each subcondition "
3337         "inside an \"%s{...}\" condition must be in its own {}", opname);
3338       return NULL;
3339       }
3340
3341     if (!(s = eval_condition(s+1, resetok, subcondptr)))
3342       {
3343       expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
3344         expand_string_message, opname);
3345       return NULL;
3346       }
3347     Uskip_whitespace(&s);
3348
3349     /* {-for-text-editors */
3350     if (*s++ != '}')
3351       {
3352       /* {-for-text-editors */
3353       expand_string_message = string_sprintf("missing } at end of condition "
3354         "inside \"%s\" group", opname);
3355       return NULL;
3356       }
3357
3358     if (yield)
3359       if (cond_type == ECOND_AND)
3360         {
3361         combined_cond &= tempcond;
3362         if (!combined_cond) subcondptr = NULL;  /* once false, don't */
3363         }                                       /* evaluate any more */
3364       else
3365         {
3366         combined_cond |= tempcond;
3367         if (combined_cond) subcondptr = NULL;   /* once true, don't */
3368         }                                       /* evaluate any more */
3369     }
3370
3371   if (yield) *yield = (combined_cond == testfor);
3372   return ++s;
3373
3374
3375   /* forall/forany: iterates a condition with different values */
3376
3377   case ECOND_FORALL:      is_forany = FALSE;  is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3378   case ECOND_FORANY:      is_forany = TRUE;   is_json = FALSE; is_jsons = FALSE; goto FORMANY;
3379   case ECOND_FORALL_JSON: is_forany = FALSE;  is_json = TRUE;  is_jsons = FALSE; goto FORMANY;
3380   case ECOND_FORANY_JSON: is_forany = TRUE;   is_json = TRUE;  is_jsons = FALSE; goto FORMANY;
3381   case ECOND_FORALL_JSONS: is_forany = FALSE; is_json = TRUE;  is_jsons = TRUE;  goto FORMANY;
3382   case ECOND_FORANY_JSONS: is_forany = TRUE;  is_json = TRUE;  is_jsons = TRUE;  goto FORMANY;
3383
3384   FORMANY:
3385     {
3386     const uschar * list;
3387     int sep = 0;
3388     uschar *save_iterate_item = iterate_item;
3389
3390     DEBUG(D_expand) debug_printf_indent("condition: %s\n", opname);
3391
3392     Uskip_whitespace(&s);
3393     if (*s++ != '{') goto COND_FAILED_CURLY_START;      /* }-for-text-editors */
3394     if (!(sub[0] = expand_string_internal(s,
3395       ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yield ? ESI_NOFLAGS : ESI_SKIPPING),
3396       &s, resetok, NULL)))
3397       return NULL;
3398     /* {-for-text-editors */
3399     if (*s++ != '}') goto COND_FAILED_CURLY_END;
3400
3401     Uskip_whitespace(&s);
3402     if (*s++ != '{') goto COND_FAILED_CURLY_START;      /* }-for-text-editors */
3403
3404     sub[1] = s;
3405
3406     /* Call eval_condition once, with result discarded (as if scanning a
3407     "false" part). This allows us to find the end of the condition, because if
3408     the list it empty, we won't actually evaluate the condition for real. */
3409
3410     if (!(s = eval_condition(sub[1], resetok, NULL)))
3411       {
3412       expand_string_message = string_sprintf("%s inside \"%s\" condition",
3413         expand_string_message, opname);
3414       return NULL;
3415       }
3416     Uskip_whitespace(&s);
3417
3418     /* {-for-text-editors */
3419     if (*s++ != '}')
3420       {
3421       /* {-for-text-editors */
3422       expand_string_message = string_sprintf("missing } at end of condition "
3423         "inside \"%s\"", opname);
3424       return NULL;
3425       }
3426
3427     if (yield) *yield = !testfor;
3428     list = sub[0];
3429     if (is_json) list = dewrap(string_copy(list), US"[]");
3430     while ((iterate_item = is_json
3431       ? json_nextinlist(&list) : string_nextinlist(&list, &sep, NULL, 0)))
3432       {
3433       if (is_jsons)
3434         if (!(iterate_item = dewrap(iterate_item, US"\"\"")))
3435           {
3436           expand_string_message =
3437             string_sprintf("%s wrapping string result for extract jsons",
3438               expand_string_message);
3439           iterate_item = save_iterate_item;
3440           return NULL;
3441           }
3442
3443       DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", opname, iterate_item);
3444       if (!eval_condition(sub[1], resetok, &tempcond))
3445         {
3446         expand_string_message = string_sprintf("%s inside \"%s\" condition",
3447           expand_string_message, opname);
3448         iterate_item = save_iterate_item;
3449         return NULL;
3450         }
3451       DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", opname,
3452         tempcond? "true":"false");
3453
3454       if (yield) *yield = (tempcond == testfor);
3455       if (tempcond == is_forany) break;
3456       }
3457
3458     iterate_item = save_iterate_item;
3459     return s;
3460     }
3461
3462
3463   /* The bool{} expansion condition maps a string to boolean.
3464   The values supported should match those supported by the ACL condition
3465   (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
3466   of true/false.  Note that Router "condition" rules have a different
3467   interpretation, where general data can be used and only a few values
3468   map to FALSE.
3469   Note that readconf.c boolean matching, for boolean configuration options,
3470   only matches true/yes/false/no.
3471   The bool_lax{} condition matches the Router logic, which is much more
3472   liberal. */
3473   case ECOND_BOOL:
3474   case ECOND_BOOL_LAX:
3475     {
3476     uschar *sub_arg[1];
3477     uschar *t, *t2;
3478     uschar *ourname;
3479     size_t len;
3480     BOOL boolvalue = FALSE;
3481
3482     if (Uskip_whitespace(&s) != '{') goto COND_FAILED_CURLY_START;      /* }-for-text-editors */
3483     ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
3484     switch(read_subs(sub_arg, 1, 1, &s,
3485             yield ? ESI_NOFLAGS : ESI_SKIPPING, FALSE, ourname, resetok, NULL))
3486       {
3487       case 1: expand_string_message = string_sprintf(
3488                   "too few arguments or bracketing error for %s",
3489                   ourname);
3490       /*FALLTHROUGH*/
3491       case 2:
3492       case 3: return NULL;
3493       }
3494     t = sub_arg[0];
3495     Uskip_whitespace(&t);
3496     if ((len = Ustrlen(t)))
3497       {
3498       /* trailing whitespace: seems like a good idea to ignore it too */
3499       t2 = t + len - 1;
3500       while (isspace(*t2)) t2--;
3501       if (t2 != (t + len))
3502         {
3503         *++t2 = '\0';
3504         len = t2 - t;
3505         }
3506       }
3507     DEBUG(D_expand)
3508       debug_printf_indent("considering %s: %s\n", ourname, len ? t : US"<empty>");
3509     /* logic for the lax case from expand_check_condition(), which also does
3510     expands, and the logic is both short and stable enough that there should
3511     be no maintenance burden from replicating it. */
3512     if (len == 0)
3513       boolvalue = FALSE;
3514     else if (*t == '-'
3515              ? Ustrspn(t+1, "0123456789") == len-1
3516              : Ustrspn(t,   "0123456789") == len)
3517       {
3518       boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
3519       /* expand_check_condition only does a literal string "0" check */
3520       if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
3521         boolvalue = TRUE;
3522       }
3523     else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
3524       boolvalue = TRUE;
3525     else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
3526       boolvalue = FALSE;
3527     else if (cond_type == ECOND_BOOL_LAX)
3528       boolvalue = TRUE;
3529     else
3530       {
3531       expand_string_message = string_sprintf("unrecognised boolean "
3532        "value \"%s\"", t);
3533       return NULL;
3534       }
3535     DEBUG(D_expand) debug_printf_indent("%s: condition evaluated to %s\n", ourname,
3536         boolvalue? "true":"false");
3537     if (yield) *yield = (boolvalue == testfor);
3538     return s;
3539     }
3540
3541 #ifdef SUPPORT_SRS
3542   case ECOND_INBOUND_SRS:
3543     /* ${if inbound_srs {local_part}{secret}  {yes}{no}} */
3544     {
3545     uschar * sub[2];
3546     const pcre2_code * re;
3547     pcre2_match_data * md;
3548     PCRE2_SIZE * ovec;
3549     int quoting = 0;
3550     uschar cksum[4];
3551     BOOL boolvalue = FALSE;
3552
3553     switch(read_subs(sub, 2, 2, CUSS &s,
3554             yield ? ESI_NOFLAGS : ESI_SKIPPING, FALSE, name, resetok, NULL))
3555       {
3556       case 1: expand_string_message = US"too few arguments or bracketing "
3557         "error for inbound_srs";
3558       case 2:
3559       case 3: return NULL;
3560       }
3561
3562     /* Match the given local_part against the SRS-encoded pattern */
3563
3564     re = regex_must_compile(US"^(?i)SRS0=([^=]+)=([A-Z2-7]{2})=([^=]*)=(.*)$",
3565                             MCS_CASELESS | MCS_CACHEABLE, FALSE);
3566     md = pcre2_match_data_create(4+1, pcre_gen_ctx);
3567     if (pcre2_match(re, sub[0], PCRE2_ZERO_TERMINATED, 0, PCRE_EOPT,
3568                     md, pcre_gen_mtc_ctx) < 0)
3569       {
3570       DEBUG(D_expand) debug_printf("no match for SRS'd local-part pattern\n");
3571       goto srs_result;
3572       }
3573     ovec = pcre2_get_ovector_pointer(md);
3574
3575     if (sub[0][0] == '"')
3576       quoting = 1;
3577     else for (uschar * s = sub[0]; *s; s++)
3578       if (!isalnum(*s) && Ustrchr(".!#$%&'*+-/=?^_`{|}~", *s) == NULL)
3579         { quoting = 1; break; }
3580     if (quoting)
3581       DEBUG(D_expand) debug_printf_indent("auto-quoting local part\n");
3582
3583     /* Record the (quoted, if needed) decoded recipient as $srs_recipient */
3584
3585     srs_recipient = string_sprintf("%.*s%.*S%.*s@%.*S",         /* lowercased */
3586                       quoting, "\"",
3587                       (int) (ovec[9]-ovec[8]), sub[0] + ovec[8],  /* substr 4 */
3588                       quoting, "\"",
3589                       (int) (ovec[7]-ovec[6]), sub[0] + ovec[6]); /* substr 3 */
3590
3591     /* If a zero-length secret was given, we're done.  Otherwise carry on
3592     and validate the given SRS local_part againt our secret. */
3593
3594     if (*sub[1])
3595       {
3596       /* check the timestamp */
3597         {
3598         struct timeval now;
3599         uschar * ss = sub[0] + ovec[4]; /* substring 2, the timestamp */
3600         long d;
3601         int n;
3602
3603         gettimeofday(&now, NULL);
3604         now.tv_sec /= 86400;                    /* days since epoch */
3605
3606         /* Decode substring 2 from base32 to a number */
3607
3608         for (d = 0, n = ovec[5]-ovec[4]; n; n--)
3609           {
3610           uschar * t = Ustrchr(base32_chars, *ss++);
3611           d = d * 32 + (t - base32_chars);
3612           }
3613
3614         if (((now.tv_sec - d) & 0x3ff) > 10)    /* days since SRS generated */
3615           {
3616           DEBUG(D_expand) debug_printf("SRS too old\n");
3617           goto srs_result;
3618           }
3619         }
3620
3621       /* check length of substring 1, the offered checksum */
3622
3623       if (ovec[3]-ovec[2] != 4)
3624         {
3625         DEBUG(D_expand) debug_printf("SRS checksum wrong size\n");
3626         goto srs_result;
3627         }
3628
3629       /* Hash the address with our secret, and compare that computed checksum
3630       with the one extracted from the arg */
3631
3632       hmac_md5(sub[1], srs_recipient, cksum, sizeof(cksum));
3633       if (Ustrncmp(cksum, sub[0] + ovec[2], 4) != 0)
3634         {
3635         DEBUG(D_expand) debug_printf("SRS checksum mismatch\n");
3636         goto srs_result;
3637         }
3638       }
3639     boolvalue = TRUE;
3640
3641 srs_result:
3642     /* pcre2_match_data_free(md);       gen ctx needs no free */
3643     if (yield) *yield = (boolvalue == testfor);
3644     return s;
3645     }
3646 #endif /*SUPPORT_SRS*/
3647
3648   /* Unknown condition */
3649
3650   default:
3651     if (!expand_string_message || !*expand_string_message)
3652       expand_string_message = string_sprintf("unknown condition \"%s\"", opname);
3653     return NULL;
3654   }   /* End switch on condition type */
3655
3656 /* Missing braces at start and end of data */
3657
3658 COND_FAILED_CURLY_START:
3659 expand_string_message = string_sprintf("missing { after \"%s\"", opname);
3660 return NULL;
3661
3662 COND_FAILED_CURLY_END:
3663 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
3664   opname);
3665 return NULL;
3666
3667 /* A condition requires code that is not compiled */
3668
3669 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
3670     !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
3671     !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
3672 COND_FAILED_NOT_COMPILED:
3673 expand_string_message = string_sprintf("support for \"%s\" not compiled",
3674   opname);
3675 return NULL;
3676 #endif
3677 }
3678
3679
3680
3681
3682 /*************************************************
3683 *          Save numerical variables              *
3684 *************************************************/
3685
3686 /* This function is called from items such as "if" that want to preserve and
3687 restore the numbered variables.
3688
3689 Arguments:
3690   save_expand_string    points to an array of pointers to set
3691   save_expand_nlength   points to an array of ints for the lengths
3692
3693 Returns:                the value of expand max to save
3694 */
3695
3696 static int
3697 save_expand_strings(const uschar **save_expand_nstring, int *save_expand_nlength)
3698 {
3699 for (int i = 0; i <= expand_nmax; i++)
3700   {
3701   save_expand_nstring[i] = expand_nstring[i];
3702   save_expand_nlength[i] = expand_nlength[i];
3703   }
3704 return expand_nmax;
3705 }
3706
3707
3708
3709 /*************************************************
3710 *           Restore numerical variables          *
3711 *************************************************/
3712
3713 /* This function restored saved values of numerical strings.
3714
3715 Arguments:
3716   save_expand_nmax      the number of strings to restore
3717   save_expand_string    points to an array of pointers
3718   save_expand_nlength   points to an array of ints
3719
3720 Returns:                nothing
3721 */
3722
3723 static void
3724 restore_expand_strings(int save_expand_nmax, const uschar **save_expand_nstring,
3725   int *save_expand_nlength)
3726 {
3727 expand_nmax = save_expand_nmax;
3728 for (int i = 0; i <= expand_nmax; i++)
3729   {
3730   expand_nstring[i] = save_expand_nstring[i];
3731   expand_nlength[i] = save_expand_nlength[i];
3732   }
3733 }
3734
3735
3736
3737
3738
3739 /*************************************************
3740 *            Handle yes/no substrings            *
3741 *************************************************/
3742
3743 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
3744 alternative substrings that depend on whether or not the condition was true,
3745 or the lookup or extraction succeeded. The substrings always have to be
3746 expanded, to check their syntax, but "skipping" is set when the result is not
3747 needed - this avoids unnecessary nested lookups.
3748
3749 Arguments:
3750   flags
3751    skipping       TRUE if we were skipping when this item was reached
3752   yes            TRUE if the first string is to be used, else use the second
3753   save_lookup    a value to put back into lookup_value before the 2nd expansion
3754   sptr           points to the input string pointer
3755   yieldptr       points to the output growable-string pointer
3756   type           "lookup", "if", "extract", "run", "env", "listextract" or
3757                  "certextract" for error message
3758   resetok        if not NULL, pointer to flag - write FALSE if unsafe to reset
3759                 the store.
3760
3761 Returns:         0 OK; lookup_value has been reset to save_lookup
3762                  1 expansion failed
3763                  2 expansion failed because of bracketing error
3764 */
3765
3766 static int
3767 process_yesno(esi_flags flags, BOOL yes, uschar *save_lookup, const uschar **sptr,
3768   gstring ** yieldptr, uschar *type, BOOL *resetok)
3769 {
3770 int rc = 0;
3771 const uschar *s = *sptr;    /* Local value */
3772 uschar *sub1, *sub2;
3773 const uschar * errwhere;
3774
3775 flags &= ESI_SKIPPING;          /* Ignore all buf the skipping flag */
3776
3777 /* If there are no following strings, we substitute the contents of $value for
3778 lookups and for extractions in the success case. For the ${if item, the string
3779 "true" is substituted. In the fail case, nothing is substituted for all three
3780 items. */
3781
3782 if (skip_whitespace(&s) == '}')
3783   {
3784   if (type[0] == 'i')
3785     {
3786     if (yes && !(flags & ESI_SKIPPING))
3787       *yieldptr = string_catn(*yieldptr, US"true", 4);
3788     }
3789   else
3790     {
3791     if (yes && lookup_value && !(flags & ESI_SKIPPING))
3792       *yieldptr = string_cat(*yieldptr, lookup_value);
3793     lookup_value = save_lookup;
3794     }
3795   s++;
3796   goto RETURN;
3797   }
3798
3799 /* The first following string must be braced. */
3800
3801 if (*s++ != '{')
3802   {
3803   errwhere = US"'yes' part did not start with '{'";             /*}}*/
3804   goto FAILED_CURLY;
3805   }
3806
3807 /* Expand the first substring. Forced failures are noticed only if we actually
3808 want this string. Set skipping in the call in the fail case (this will always
3809 be the case if we were already skipping). */
3810
3811 sub1 = expand_string_internal(s,
3812   ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | (yes ? ESI_NOFLAGS : ESI_SKIPPING),
3813   &s, resetok, NULL);
3814 if (sub1 == NULL && (yes || !f.expand_string_forcedfail)) goto FAILED;
3815 f.expand_string_forcedfail = FALSE;
3816                                                                 /*{{*/
3817 if (*s++ != '}')
3818   {
3819   errwhere = US"'yes' part did not end with '}'";
3820   goto FAILED_CURLY;
3821   }
3822
3823 /* If we want the first string, add it to the output */
3824
3825 if (yes)
3826   *yieldptr = string_cat(*yieldptr, sub1);
3827
3828 /* If this is called from a lookup/env or a (cert)extract, we want to restore
3829 $value to what it was at the start of the item, so that it has this value
3830 during the second string expansion. For the call from "if" or "run" to this
3831 function, save_lookup is set to lookup_value, so that this statement does
3832 nothing. */
3833
3834 lookup_value = save_lookup;
3835
3836 /* There now follows either another substring, or "fail", or nothing. This
3837 time, forced failures are noticed only if we want the second string. We must
3838 set skipping in the nested call if we don't want this string, or if we were
3839 already skipping. */
3840
3841 if (skip_whitespace(&s) == '{')                                 /*}*/
3842   {
3843   esi_flags s_flags = ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags;
3844   if (yes) s_flags |= ESI_SKIPPING;
3845   sub2 = expand_string_internal(s+1, s_flags, &s, resetok, NULL);
3846   if (!sub2 && (!yes || !f.expand_string_forcedfail)) goto FAILED;
3847   f.expand_string_forcedfail = FALSE;                           /*{*/
3848   if (*s++ != '}')
3849     {
3850     errwhere = US"'no' part did not start with '{'";            /*}*/
3851     goto FAILED_CURLY;
3852     }
3853
3854   /* If we want the second string, add it to the output */
3855
3856   if (!yes)
3857     *yieldptr = string_cat(*yieldptr, sub2);
3858   }
3859                                                                 /*{{*/
3860 /* If there is no second string, but the word "fail" is present when the use of
3861 the second string is wanted, set a flag indicating it was a forced failure
3862 rather than a syntactic error. Swallow the terminating } in case this is nested
3863 inside another lookup or if or extract. */
3864
3865 else if (*s != '}')
3866   {
3867   uschar name[256];
3868   /* deconst cast ok here as source is s anyway */
3869   s = US read_name(name, sizeof(name), s, US"_");
3870   if (Ustrcmp(name, "fail") == 0)
3871     {
3872     if (!yes && !(flags & ESI_SKIPPING))
3873       {
3874       Uskip_whitespace(&s);                                     /*{{*/
3875       if (*s++ != '}')
3876         {
3877         errwhere = US"did not close with '}' after forcedfail";
3878         goto FAILED_CURLY;
3879         }
3880       expand_string_message =
3881         string_sprintf("\"%s\" failed and \"fail\" requested", type);
3882       f.expand_string_forcedfail = TRUE;
3883       goto FAILED;
3884       }
3885     }
3886   else
3887     {
3888     expand_string_message =
3889       string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3890     goto FAILED;
3891     }
3892   }
3893
3894 /* All we have to do now is to check on the final closing brace. */
3895
3896 skip_whitespace(&s);                                            /*{{*/
3897 if (*s++ != '}')
3898   {
3899   errwhere = US"did not close with '}'";
3900   goto FAILED_CURLY;
3901   }
3902
3903
3904 RETURN:
3905 /* Update the input pointer value before returning */
3906 *sptr = s;
3907 return rc;
3908
3909 FAILED_CURLY:
3910   /* Get here if there is a bracketing failure */
3911   expand_string_message = string_sprintf(
3912     "curly-bracket problem in conditional yes/no parsing: %s\n"
3913     " remaining string is '%s'", errwhere, --s);
3914   rc = 2;
3915   goto RETURN;
3916
3917 FAILED:
3918   /* Get here for other failures */
3919   rc = 1;
3920   goto RETURN;
3921 }
3922
3923
3924
3925
3926 /********************************************************
3927 * prvs: Get last three digits of days since Jan 1, 1970 *
3928 ********************************************************/
3929
3930 /* This is needed to implement the "prvs" BATV reverse
3931    path signing scheme
3932
3933 Argument: integer "days" offset to add or substract to
3934           or from the current number of days.
3935
3936 Returns:  pointer to string containing the last three
3937           digits of the number of days since Jan 1, 1970,
3938           modified by the offset argument, NULL if there
3939           was an error in the conversion.
3940
3941 */
3942
3943 static uschar *
3944 prvs_daystamp(int day_offset)
3945 {
3946 uschar * days = store_get(32, GET_UNTAINTED);      /* Need at least 24 for cases */
3947 (void)string_format(days, 32, TIME_T_FMT,          /* where TIME_T_FMT is %lld */
3948   (time(NULL) + day_offset*86400)/86400);
3949 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3950 }
3951
3952
3953
3954 /********************************************************
3955 *   prvs: perform HMAC-SHA1 computation of prvs bits    *
3956 ********************************************************/
3957
3958 /* This is needed to implement the "prvs" BATV reverse
3959    path signing scheme
3960
3961 Arguments:
3962   address RFC2821 Address to use
3963       key The key to use (must be less than 64 characters
3964           in size)
3965   key_num Single-digit key number to use. Defaults to
3966           '0' when NULL.
3967
3968 Returns:  pointer to string containing the first three
3969           bytes of the final hash in hex format, NULL if
3970           there was an error in the process.
3971 */
3972
3973 static uschar *
3974 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3975 {
3976 gstring * hash_source;
3977 uschar * p;
3978 hctx h;
3979 uschar innerhash[20];
3980 uschar finalhash[20];
3981 uschar innerkey[64];
3982 uschar outerkey[64];
3983 uschar *finalhash_hex;
3984
3985 if (!key_num)
3986   key_num = US"0";
3987
3988 if (Ustrlen(key) > 64)
3989   return NULL;
3990
3991 hash_source = string_catn(NULL, key_num, 1);
3992 hash_source = string_catn(hash_source, daystamp, 3);
3993 hash_source = string_cat(hash_source, address);
3994
3995 DEBUG(D_expand)
3996   debug_printf_indent("prvs: hash source is '%Y'\n", hash_source);
3997
3998 memset(innerkey, 0x36, 64);
3999 memset(outerkey, 0x5c, 64);
4000
4001 for (int i = 0; i < Ustrlen(key); i++)
4002   {
4003   innerkey[i] ^= key[i];
4004   outerkey[i] ^= key[i];
4005   }
4006
4007 chash_start(HMAC_SHA1, &h);
4008 chash_mid(HMAC_SHA1, &h, innerkey);
4009 chash_end(HMAC_SHA1, &h, hash_source->s, hash_source->ptr, innerhash);
4010
4011 chash_start(HMAC_SHA1, &h);
4012 chash_mid(HMAC_SHA1, &h, outerkey);
4013 chash_end(HMAC_SHA1, &h, innerhash, 20, finalhash);
4014
4015 /* Hashing is deemed sufficient to de-taint any input data */
4016
4017 p = finalhash_hex = store_get(40, GET_UNTAINTED);
4018 for (int i = 0; i < 3; i++)
4019   {
4020   *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
4021   *p++ = hex_digits[finalhash[i] & 0x0f];
4022   }
4023 *p = '\0';
4024
4025 return finalhash_hex;
4026 }
4027
4028
4029
4030
4031 /*************************************************
4032 *        Join a file onto the output string      *
4033 *************************************************/
4034
4035 /* This is used for readfile/readsock and after a run expansion.
4036 It joins the contents of a file onto the output string, globally replacing
4037 newlines with a given string (optionally).
4038
4039 Arguments:
4040   f            the FILE
4041   yield        pointer to the expandable string struct
4042   eol          newline replacement string, or NULL
4043
4044 Returns:       new pointer for expandable string, terminated if non-null
4045 */
4046
4047 gstring *
4048 cat_file(FILE * f, gstring * yield, uschar * eol)
4049 {
4050 uschar buffer[1024];
4051
4052 while (Ufgets(buffer, sizeof(buffer), f))
4053   {
4054   int len = Ustrlen(buffer);
4055   if (eol && buffer[len-1] == '\n') len--;
4056   yield = string_catn(yield, buffer, len);
4057   if (eol && buffer[len])
4058     yield = string_cat(yield, eol);
4059   }
4060 return yield;
4061 }
4062
4063
4064 #ifndef DISABLE_TLS
4065 gstring *
4066 cat_file_tls(void * tls_ctx, gstring * yield, uschar * eol)
4067 {
4068 int rc;
4069 uschar buffer[1024];
4070
4071 /*XXX could we read direct into a pre-grown string? */
4072
4073 while ((rc = tls_read(tls_ctx, buffer, sizeof(buffer))) > 0)
4074   for (uschar * s = buffer; rc--; s++)
4075     yield = eol && *s == '\n'
4076       ? string_cat(yield, eol) : string_catn(yield, s, 1);
4077
4078 /* We assume that all errors, and any returns of zero bytes,
4079 are actually EOF. */
4080
4081 return yield;
4082 }
4083 #endif
4084
4085
4086 /*************************************************
4087 *          Evaluate numeric expression           *
4088 *************************************************/
4089
4090 /* This is a set of mutually recursive functions that evaluate an arithmetic
4091 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
4092 these functions that is called from elsewhere is eval_expr, whose interface is:
4093
4094 Arguments:
4095   sptr        pointer to the pointer to the string - gets updated
4096   decimal     TRUE if numbers are to be assumed decimal
4097   error       pointer to where to put an error message - must be NULL on input
4098   endket      TRUE if ')' must terminate - FALSE for external call
4099
4100 Returns:      on success: the value of the expression, with *error still NULL
4101               on failure: an undefined value, with *error = a message
4102 */
4103
4104 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
4105
4106
4107 static int_eximarith_t
4108 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
4109 {
4110 uschar *s = *sptr;
4111 int_eximarith_t x = eval_op_or(&s, decimal, error);
4112
4113 if (!*error)
4114   if (endket)
4115     if (*s != ')')
4116       *error = US"expecting closing parenthesis";
4117     else
4118       while (isspace(*++s));
4119   else if (*s)
4120     *error = US"expecting operator";
4121 *sptr = s;
4122 return x;
4123 }
4124
4125
4126 static int_eximarith_t
4127 eval_number(uschar **sptr, BOOL decimal, uschar **error)
4128 {
4129 int c;
4130 int_eximarith_t n;
4131 uschar *s = *sptr;
4132
4133 if (isdigit((c = Uskip_whitespace(&s))))
4134   {
4135   int count;
4136   (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
4137   s += count;
4138   switch (tolower(*s))
4139     {
4140     default: break;
4141     case 'k': n *= 1024; s++; break;
4142     case 'm': n *= 1024*1024; s++; break;
4143     case 'g': n *= 1024*1024*1024; s++; break;
4144     }
4145   Uskip_whitespace(&s);
4146   }
4147 else if (c == '(')
4148   {
4149   s++;
4150   n = eval_expr(&s, decimal, error, 1);
4151   }
4152 else
4153   {
4154   *error = US"expecting number or opening parenthesis";
4155   n = 0;
4156   }
4157 *sptr = s;
4158 return n;
4159 }
4160
4161
4162 static int_eximarith_t
4163 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
4164 {
4165 uschar *s = *sptr;
4166 int_eximarith_t x;
4167 Uskip_whitespace(&s);
4168 if (*s == '+' || *s == '-' || *s == '~')
4169   {
4170   int op = *s++;
4171   x = eval_op_unary(&s, decimal, error);
4172   if (op == '-') x = -x;
4173     else if (op == '~') x = ~x;
4174   }
4175 else
4176   x = eval_number(&s, decimal, error);
4177
4178 *sptr = s;
4179 return x;
4180 }
4181
4182
4183 static int_eximarith_t
4184 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
4185 {
4186 uschar *s = *sptr;
4187 int_eximarith_t x = eval_op_unary(&s, decimal, error);
4188 if (!*error)
4189   {
4190   while (*s == '*' || *s == '/' || *s == '%')
4191     {
4192     int op = *s++;
4193     int_eximarith_t y = eval_op_unary(&s, decimal, error);
4194     if (*error) break;
4195     /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
4196      * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
4197      * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64].  In fact, -N*-M where
4198      * -N*M is INT_MIN will yield INT_MIN.
4199      * Since we don't support floating point, this is somewhat simpler.
4200      * Ideally, we'd return an error, but since we overflow for all other
4201      * arithmetic, consistency suggests otherwise, but what's the correct value
4202      * to use?  There is none.
4203      * The C standard guarantees overflow for unsigned arithmetic but signed
4204      * overflow invokes undefined behaviour; in practice, this is overflow
4205      * except for converting INT_MIN to INT_MAX+1.  We also can't guarantee
4206      * that long/longlong larger than int are available, or we could just work
4207      * with larger types.  We should consider whether to guarantee 32bit eval
4208      * and 64-bit working variables, with errors returned.  For now ...
4209      * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
4210      * can just let the other invalid results occur otherwise, as they have
4211      * until now.  For this one case, we can coerce.
4212      */
4213     if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
4214       {
4215       DEBUG(D_expand)
4216         debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
4217             EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
4218       x = EXIM_ARITH_MAX;
4219       continue;
4220       }
4221     if (op == '*')
4222       x *= y;
4223     else
4224       {
4225       if (y == 0)
4226         {
4227         *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
4228         x = 0;
4229         break;
4230         }
4231       if (op == '/')
4232         x /= y;
4233       else
4234         x %= y;
4235       }
4236     }
4237   }
4238 *sptr = s;
4239 return x;
4240 }
4241
4242
4243 static int_eximarith_t
4244 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
4245 {
4246 uschar *s = *sptr;
4247 int_eximarith_t x = eval_op_mult(&s, decimal, error);
4248 if (!*error)
4249   {
4250   while (*s == '+' || *s == '-')
4251     {
4252     int op = *s++;
4253     int_eximarith_t y = eval_op_mult(&s, decimal, error);
4254     if (*error) break;
4255     if (  (x >=   EXIM_ARITH_MAX/2  && x >=   EXIM_ARITH_MAX/2)
4256        || (x <= -(EXIM_ARITH_MAX/2) && y <= -(EXIM_ARITH_MAX/2)))
4257       {                 /* over-conservative check */
4258       *error = op == '+'
4259         ? US"overflow in sum" : US"overflow in difference";
4260       break;
4261       }
4262     if (op == '+') x += y; else x -= y;
4263     }
4264   }
4265 *sptr = s;
4266 return x;
4267 }
4268
4269
4270 static int_eximarith_t
4271 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
4272 {
4273 uschar *s = *sptr;
4274 int_eximarith_t x = eval_op_sum(&s, decimal, error);
4275 if (!*error)
4276   {
4277   while ((*s == '<' || *s == '>') && s[1] == s[0])
4278     {
4279     int_eximarith_t y;
4280     int op = *s++;
4281     s++;
4282     y = eval_op_sum(&s, decimal, error);
4283     if (*error) break;
4284     if (op == '<') x <<= y; else x >>= y;
4285     }
4286   }
4287 *sptr = s;
4288 return x;
4289 }
4290
4291
4292 static int_eximarith_t
4293 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
4294 {
4295 uschar *s = *sptr;
4296 int_eximarith_t x = eval_op_shift(&s, decimal, error);
4297 if (!*error)
4298   {
4299   while (*s == '&')
4300     {
4301     int_eximarith_t y;
4302     s++;
4303     y = eval_op_shift(&s, decimal, error);
4304     if (*error) break;
4305     x &= y;
4306     }
4307   }
4308 *sptr = s;
4309 return x;
4310 }
4311
4312
4313 static int_eximarith_t
4314 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
4315 {
4316 uschar *s = *sptr;
4317 int_eximarith_t x = eval_op_and(&s, decimal, error);
4318 if (!*error)
4319   {
4320   while (*s == '^')
4321     {
4322     int_eximarith_t y;
4323     s++;
4324     y = eval_op_and(&s, decimal, error);
4325     if (*error) break;
4326     x ^= y;
4327     }
4328   }
4329 *sptr = s;
4330 return x;
4331 }
4332
4333
4334 static int_eximarith_t
4335 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
4336 {
4337 uschar *s = *sptr;
4338 int_eximarith_t x = eval_op_xor(&s, decimal, error);
4339 if (!*error)
4340   {
4341   while (*s == '|')
4342     {
4343     int_eximarith_t y;
4344     s++;
4345     y = eval_op_xor(&s, decimal, error);
4346     if (*error) break;
4347     x |= y;
4348     }
4349   }
4350 *sptr = s;
4351 return x;
4352 }
4353
4354
4355
4356 /************************************************/
4357 /* Comparison operation for sort expansion.  We need to avoid
4358 re-expanding the fields being compared, so need a custom routine.
4359
4360 Arguments:
4361  cond_type              Comparison operator code
4362  leftarg, rightarg      Arguments for comparison
4363
4364 Return true iff (leftarg compare rightarg)
4365 */
4366
4367 static BOOL
4368 sortsbefore(int cond_type, BOOL alpha_cond,
4369   const uschar * leftarg, const uschar * rightarg)
4370 {
4371 int_eximarith_t l_num, r_num;
4372
4373 if (!alpha_cond)
4374   {
4375   l_num = expanded_string_integer(leftarg, FALSE);
4376   if (expand_string_message) return FALSE;
4377   r_num = expanded_string_integer(rightarg, FALSE);
4378   if (expand_string_message) return FALSE;
4379
4380   switch (cond_type)
4381     {
4382     case ECOND_NUM_G:   return l_num >  r_num;
4383     case ECOND_NUM_GE:  return l_num >= r_num;
4384     case ECOND_NUM_L:   return l_num <  r_num;
4385     case ECOND_NUM_LE:  return l_num <= r_num;
4386     default: break;
4387     }
4388   }
4389 else
4390   switch (cond_type)
4391     {
4392     case ECOND_STR_LT:  return Ustrcmp (leftarg, rightarg) <  0;
4393     case ECOND_STR_LTI: return strcmpic(leftarg, rightarg) <  0;
4394     case ECOND_STR_LE:  return Ustrcmp (leftarg, rightarg) <= 0;
4395     case ECOND_STR_LEI: return strcmpic(leftarg, rightarg) <= 0;
4396     case ECOND_STR_GT:  return Ustrcmp (leftarg, rightarg) >  0;
4397     case ECOND_STR_GTI: return strcmpic(leftarg, rightarg) >  0;
4398     case ECOND_STR_GE:  return Ustrcmp (leftarg, rightarg) >= 0;
4399     case ECOND_STR_GEI: return strcmpic(leftarg, rightarg) >= 0;
4400     default: break;
4401     }
4402 return FALSE;   /* should not happen */
4403 }
4404
4405
4406 /* Expand a named list.  Return false on failure. */
4407 static gstring *
4408 expand_listnamed(gstring * yield, const uschar * name, const uschar * listtype)
4409 {
4410 tree_node *t = NULL;
4411 const uschar * list;
4412 int sep = 0;
4413 uschar * item;
4414 BOOL needsep = FALSE;
4415 #define LISTNAMED_BUF_SIZE 256
4416 uschar b[LISTNAMED_BUF_SIZE];
4417 uschar * buffer = b;
4418
4419 if (*name == '+') name++;
4420 if (!listtype)          /* no-argument version */
4421   {
4422   if (  !(t = tree_search(addresslist_anchor, name))
4423      && !(t = tree_search(domainlist_anchor,  name))
4424      && !(t = tree_search(hostlist_anchor,    name)))
4425     t = tree_search(localpartlist_anchor, name);
4426   }
4427 else switch(*listtype)  /* specific list-type version */
4428   {
4429   case 'a': t = tree_search(addresslist_anchor,   name); break;
4430   case 'd': t = tree_search(domainlist_anchor,    name); break;
4431   case 'h': t = tree_search(hostlist_anchor,      name); break;
4432   case 'l': t = tree_search(localpartlist_anchor, name); break;
4433   default:
4434     expand_string_message = US"bad suffix on \"list\" operator";
4435     return yield;
4436   }
4437
4438 if(!t)
4439   {
4440   expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
4441     name, !listtype?""
4442       : *listtype=='a'?"address "
4443       : *listtype=='d'?"domain "
4444       : *listtype=='h'?"host "
4445       : *listtype=='l'?"localpart "
4446       : 0);
4447   return yield;
4448   }
4449
4450 list = ((namedlist_block *)(t->data.ptr))->string;
4451
4452 /* The list could be quite long so we (re)use a buffer for each element
4453 rather than getting each in new memory */
4454
4455 if (is_tainted(list)) buffer = store_get(LISTNAMED_BUF_SIZE, GET_TAINTED);
4456 while ((item = string_nextinlist(&list, &sep, buffer, LISTNAMED_BUF_SIZE)))
4457   {
4458   uschar * buf = US" : ";
4459   if (needsep)
4460     yield = string_catn(yield, buf, 3);
4461   else
4462     needsep = TRUE;
4463
4464   if (*item == '+')     /* list item is itself a named list */
4465     {
4466     yield = expand_listnamed(yield, item, listtype);
4467     if (expand_string_message)
4468       return yield;
4469     }
4470
4471   else if (sep != ':')  /* item from non-colon-sep list, re-quote for colon list-separator */
4472     {
4473     char tok[3];
4474     tok[0] = sep; tok[1] = ':'; tok[2] = 0;
4475
4476     for(char * cp; cp = strpbrk(CCS item, tok); item = US cp)
4477       {
4478       yield = string_catn(yield, item, cp - CS item);
4479       if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
4480         yield = string_catn(yield, US"::", 2);
4481       else              /* sep in item; should already be doubled; emit once */
4482         {
4483         yield = string_catn(yield, US tok, 1);
4484         if (*cp == sep) cp++;
4485         }
4486       }
4487     yield = string_cat(yield, item);
4488     }
4489   else
4490     yield = string_cat(yield, item);
4491   }
4492 return yield;
4493 }
4494
4495
4496
4497 /************************************************/
4498 static void
4499 debug_expansion_interim(const uschar * what, const uschar * value, int nchar,
4500   BOOL skipping)
4501 {
4502 DEBUG(D_noutf8)
4503   debug_printf_indent("|");
4504 else
4505   debug_printf_indent(UTF8_VERT_RIGHT);
4506
4507 for (int fill = 11 - Ustrlen(what); fill > 0; fill--)
4508   DEBUG(D_noutf8)
4509     debug_printf("-");
4510   else
4511     debug_printf(UTF8_HORIZ);
4512
4513 debug_printf("%s: %.*s\n", what, nchar, value);
4514 if (is_tainted(value))
4515   {
4516   DEBUG(D_noutf8)
4517     debug_printf_indent("%s     \\__", skipping ? "|     " : "      ");
4518   else
4519     debug_printf_indent("%s",
4520       skipping
4521       ? UTF8_VERT "             " : "           " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
4522   debug_printf("(tainted)\n");
4523   }
4524 }
4525
4526
4527 /*************************************************
4528 *                 Expand string                  *
4529 *************************************************/
4530
4531 /* Returns either an unchanged string, or the expanded string in stacking pool
4532 store. Interpreted sequences are:
4533
4534    \...                    normal escaping rules
4535    $name                   substitutes the variable
4536    ${name}                 ditto
4537    ${op:string}            operates on the expanded string value
4538    ${item{arg1}{arg2}...}  expands the args and then does the business
4539                              some literal args are not enclosed in {}
4540
4541 There are now far too many operators and item types to make it worth listing
4542 them here in detail any more.
4543
4544 We use an internal routine recursively to handle embedded substrings. The
4545 external function follows. The yield is NULL if the expansion failed, and there
4546 are two cases: if something collapsed syntactically, or if "fail" was given
4547 as the action on a lookup failure. These can be distinguished by looking at the
4548 variable expand_string_forcedfail, which is TRUE in the latter case.
4549
4550 The skipping flag is set true when expanding a substring that isn't actually
4551 going to be used (after "if" or "lookup") and it prevents lookups from
4552 happening lower down.
4553
4554 Store usage: At start, a store block of the length of the input plus 64
4555 is obtained. This is expanded as necessary by string_cat(), which might have to
4556 get a new block, or might be able to expand the original. At the end of the
4557 function we can release any store above that portion of the yield block that
4558 was actually used. In many cases this will be optimal.
4559
4560 However: if the first item in the expansion is a variable name or header name,
4561 we reset the store before processing it; if the result is in fresh store, we
4562 use that without copying. This is helpful for expanding strings like
4563 $message_headers which can get very long.
4564
4565 There's a problem if a ${dlfunc item has side-effects that cause allocation,
4566 since resetting the store at the end of the expansion will free store that was
4567 allocated by the plugin code as well as the slop after the expanded string. So
4568 we skip any resets if ${dlfunc } has been used. The same applies for ${acl }
4569 and, given the acl condition, ${if }. This is an unfortunate consequence of
4570 string expansion becoming too powerful.
4571
4572 Arguments:
4573   string         the string to be expanded
4574   flags
4575    brace_ends     expansion is to stop at }
4576    honour_dollar  TRUE if $ is to be expanded,
4577                   FALSE if it's just another character
4578    skipping       TRUE for recursive calls when the value isn't actually going
4579                   to be used (to allow for optimisation)
4580   left           if not NULL, a pointer to the first character after the
4581                  expansion is placed here (typically used with brace_ends)
4582   resetok_p      if not NULL, pointer to flag - write FALSE if unsafe to reset
4583                  the store.
4584   textonly_p     if not NULL, pointer to flag - write bool for only-met-text
4585
4586 Returns:         NULL if expansion fails:
4587                    expand_string_forcedfail is set TRUE if failure was forced
4588                    expand_string_message contains a textual error message
4589                  a pointer to the expanded string on success
4590 */
4591
4592 static uschar *
4593 expand_string_internal(const uschar * string, esi_flags flags, const uschar ** left,
4594   BOOL *resetok_p, BOOL * textonly_p)
4595 {
4596 rmark reset_point = store_mark();
4597 gstring * yield = string_get(Ustrlen(string) + 64);
4598 int item_type;
4599 const uschar * s = string;
4600 const uschar * save_expand_nstring[EXPAND_MAXN+1];
4601 int save_expand_nlength[EXPAND_MAXN+1];
4602 BOOL resetok = TRUE, first = TRUE, textonly = TRUE;
4603
4604 expand_level++;
4605 f.expand_string_forcedfail = FALSE;
4606 expand_string_message = US"";
4607
4608 if (is_tainted(string))
4609   {
4610   expand_string_message =
4611     string_sprintf("attempt to expand tainted string '%s'", s);
4612   log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4613   goto EXPAND_FAILED;
4614   }
4615
4616 while (*s)
4617   {
4618   uschar name[256];
4619
4620   DEBUG(D_expand)
4621     {
4622     DEBUG(D_noutf8)
4623       debug_printf_indent("%c%s: %s\n",
4624         first ? '/' : '|',
4625         flags & ESI_SKIPPING ? "---scanning" : "considering", s);
4626     else
4627       debug_printf_indent("%s%s: %s\n",
4628         first ? UTF8_DOWN_RIGHT : UTF8_VERT_RIGHT,
4629         flags & ESI_SKIPPING
4630         ? UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ "scanning"
4631         : "considering",
4632         s);
4633     first = FALSE;
4634     }
4635
4636   /* \ escapes the next character, which must exist, or else
4637   the expansion fails. There's a special escape, \N, which causes
4638   copying of the subject verbatim up to the next \N. Otherwise,
4639   the escapes are the standard set. */
4640
4641   if (*s == '\\')
4642     {
4643     if (s[1] == 0)
4644       {
4645       expand_string_message = US"\\ at end of string";
4646       goto EXPAND_FAILED;
4647       }
4648
4649     if (s[1] == 'N')
4650       {
4651       const uschar * t = s + 2;
4652       for (s = t; *s ; s++) if (*s == '\\' && s[1] == 'N') break;
4653
4654       DEBUG(D_expand)
4655         debug_expansion_interim(US"protected", t, (int)(s - t), !!(flags & ESI_SKIPPING));
4656       yield = string_catn(yield, t, s - t);
4657       if (*s) s += 2;
4658       }
4659     else
4660       {
4661       uschar ch[1];
4662       DEBUG(D_expand)
4663         DEBUG(D_noutf8)
4664           debug_printf_indent("|backslashed: '\\%c'\n", s[1]);
4665         else
4666           debug_printf_indent(UTF8_VERT_RIGHT "backslashed: '\\%c'\n", s[1]);
4667       ch[0] = string_interpret_escape(&s);
4668       s++;
4669       yield = string_catn(yield, ch, 1);
4670       }
4671     continue;
4672     }
4673
4674                                                                         /*{{*/
4675   /* Anything other than $ is just copied verbatim, unless we are
4676   looking for a terminating } character. */
4677
4678   if (flags & ESI_BRACE_ENDS && *s == '}') break;
4679
4680   if (*s != '$' || !(flags & ESI_HONOR_DOLLAR))
4681     {
4682     int i = 1;                                                          /*{*/
4683     for (const uschar * t = s+1;
4684         *t && *t != '$' && *t != '}' && *t != '\\'; t++) i++;
4685
4686     DEBUG(D_expand) debug_expansion_interim(US"text", s, i, !!(flags & ESI_SKIPPING));
4687
4688     yield = string_catn(yield, s, i);
4689     s += i;
4690     continue;
4691     }
4692   textonly = FALSE;
4693
4694   /* No { after the $ - must be a plain name or a number for string
4695   match variable. There has to be a fudge for variables that are the
4696   names of header fields preceded by "$header_" because header field
4697   names can contain any printing characters except space and colon.
4698   For those that don't like typing this much, "$h_" is a synonym for
4699   "$header_". A non-existent header yields a NULL value; nothing is
4700   inserted. */  /*}*/
4701
4702   if (isalpha(*++s))
4703     {
4704     const uschar * value;
4705     int newsize = 0, len;
4706     gstring * g = NULL;
4707     uschar * t;
4708
4709     s = read_name(name, sizeof(name), s, US"_");
4710
4711     /* If this is the first thing to be expanded, release the pre-allocated
4712     buffer. */
4713
4714     if (!yield)
4715       g = store_get(sizeof(gstring), GET_UNTAINTED);
4716     else if (yield->ptr == 0)
4717       {
4718       if (resetok) reset_point = store_reset(reset_point);
4719       yield = NULL;
4720       reset_point = store_mark();
4721       g = store_get(sizeof(gstring), GET_UNTAINTED);    /* alloc _before_ calling find_variable() */
4722       }
4723
4724     /* Header */
4725
4726     if (  ( *(t = name) == 'h'
4727           || (*t == 'r' || *t == 'l' || *t == 'b') && *++t == 'h'
4728           )
4729        && (*++t == '_' || Ustrncmp(t, "eader_", 6) == 0)
4730        )
4731       {
4732       unsigned flags = *name == 'r' ? FH_WANT_RAW
4733                       : *name == 'l' ? FH_WANT_RAW|FH_WANT_LIST
4734                       : 0;
4735       const uschar * charset = *name == 'b' ? NULL : headers_charset;
4736
4737       s = read_header_name(name, sizeof(name), s);
4738       value = find_header(name, &newsize, flags, charset);
4739
4740       /* If we didn't find the header, and the header contains a closing brace
4741       character, this may be a user error where the terminating colon
4742       has been omitted. Set a flag to adjust the error message in this case.
4743       But there is no error here - nothing gets inserted. */
4744
4745       if (!value)
4746         {                                                               /*{*/
4747         if (Ustrchr(name, '}')) malformed_header = TRUE;
4748         continue;
4749         }
4750       }
4751
4752     /* Variable */
4753
4754     else if (!(value = find_variable(name, FALSE, !!(flags & ESI_SKIPPING), &newsize)))
4755       {
4756       expand_string_message =
4757         string_sprintf("unknown variable name \"%s\"", name);
4758         check_variable_error_message(name);
4759       goto EXPAND_FAILED;
4760       }
4761
4762     /* If the data is known to be in a new buffer, newsize will be set to the
4763     size of that buffer. If this is the first thing in an expansion string,
4764     yield will be NULL; just point it at the new store instead of copying. Many
4765     expansion strings contain just one reference, so this is a useful
4766     optimization, especially for humungous headers.  We need to use a gstring
4767     structure that is not allocated after that new-buffer, else a later store
4768     reset in the middle of the buffer will make it inaccessible. */
4769
4770     len = Ustrlen(value);
4771     DEBUG(D_expand) debug_expansion_interim(US"value", value, len, !!(flags & ESI_SKIPPING));
4772     if (!yield && newsize != 0)
4773       {
4774       yield = g;
4775       yield->size = newsize;
4776       yield->ptr = len;
4777       yield->s = US value; /* known to be in new store i.e. a copy, so deconst safe */
4778       }
4779     else
4780       yield = string_catn(yield, value, len);
4781
4782     continue;
4783     }
4784
4785   if (isdigit(*s))              /* A $<n> variable */
4786     {
4787     int n;
4788     s = read_cnumber(&n, s);
4789     if (n >= 0 && n <= expand_nmax)
4790       {
4791       DEBUG(D_expand) debug_expansion_interim(US"value", expand_nstring[n], expand_nlength[n], !!(flags & ESI_SKIPPING));
4792       yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4793       }
4794     continue;
4795     }
4796
4797   /* Otherwise, if there's no '{' after $ it's an error. */             /*}*/
4798
4799   if (*s != '{')                                                        /*}*/
4800     {
4801     expand_string_message = US"$ not followed by letter, digit, or {";  /*}*/
4802     goto EXPAND_FAILED;
4803     }
4804
4805   /* After { there can be various things, but they all start with
4806   an initial word, except for a number for a string match variable. */  /*}*/
4807
4808   if (isdigit(*++s))
4809     {
4810     int n;
4811     s = read_cnumber(&n, s);                                            /*{{*/
4812     if (*s++ != '}')
4813       {
4814       expand_string_message = US"} expected after number";
4815       goto EXPAND_FAILED;
4816       }
4817     if (n >= 0 && n <= expand_nmax)
4818       {
4819       DEBUG(D_expand) debug_expansion_interim(US"value", expand_nstring[n], expand_nlength[n], !!(flags & ESI_SKIPPING));
4820       yield = string_catn(yield, expand_nstring[n], expand_nlength[n]);
4821       }
4822     continue;
4823     }
4824
4825   if (!isalpha(*s))
4826     {
4827     expand_string_message = US"letter or digit expected after ${";      /*}*/
4828     goto EXPAND_FAILED;
4829     }
4830
4831   /* Allow "-" in names to cater for substrings with negative
4832   arguments. Since we are checking for known names after { this is
4833   OK. */                                                                /*}*/
4834
4835   s = read_name(name, sizeof(name), s, US"_-");
4836   item_type = chop_match(name, item_table, nelem(item_table));
4837
4838   /* Switch on item type.  All nondefault choices should "continue* when
4839   skipping, but "break" otherwise so we get debug output for the item
4840   expansion. */
4841   {
4842   int expansion_start = gstring_length(yield);
4843   switch(item_type)
4844     {
4845     /* Call an ACL from an expansion.  We feed data in via $acl_arg1 - $acl_arg9.
4846     If the ACL returns accept or reject we return content set by "message ="
4847     There is currently no limit on recursion; this would have us call
4848     acl_check_internal() directly and get a current level from somewhere.
4849     See also the acl expansion condition ECOND_ACL and the traditional
4850     acl modifier ACLC_ACL.
4851     Assume that the function has side-effects on the store that must be preserved.
4852     */
4853
4854     case EITEM_ACL:
4855       /* ${acl {name} {arg1}{arg2}...} */
4856       {
4857       uschar * sub[10]; /* name + arg1-arg9 (which must match number of acl_arg[]) */
4858       uschar * user_msg;
4859       int rc;
4860
4861       switch(read_subs(sub, nelem(sub), 1, &s, flags, TRUE, name, &resetok, NULL))
4862         {
4863         case -1: continue;              /* skipping */
4864         case 1: goto EXPAND_FAILED_CURLY;
4865         case 2:
4866         case 3: goto EXPAND_FAILED;
4867         }
4868
4869       resetok = FALSE;
4870       switch(rc = eval_acl(sub, nelem(sub), &user_msg))
4871         {
4872         case OK:
4873         case FAIL:
4874           DEBUG(D_expand)
4875             debug_printf_indent("acl expansion yield: %s\n", user_msg);
4876           if (user_msg)
4877             yield = string_cat(yield, user_msg);
4878           break;
4879
4880         case DEFER:
4881           f.expand_string_forcedfail = TRUE;
4882           /*FALLTHROUGH*/
4883         default:
4884           expand_string_message = string_sprintf("%s from acl \"%s\"",
4885             rc_names[rc], sub[0]);
4886           goto EXPAND_FAILED;
4887         }
4888       break;
4889       }
4890
4891     case EITEM_AUTHRESULTS:
4892       /* ${authresults {mysystemname}} */
4893       {
4894       uschar * sub_arg[1];
4895
4896       switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, flags, TRUE, name, &resetok, NULL))
4897         {
4898         case -1: continue;      /* If skipping, we don't actually do anything */
4899         case 1: goto EXPAND_FAILED_CURLY;
4900         case 2:
4901         case 3: goto EXPAND_FAILED;
4902         }
4903
4904       yield = string_append(yield, 3,
4905                         US"Authentication-Results: ", sub_arg[0], US"; none");
4906       yield->ptr -= 6;                  /* ignore tha ": none" for now */
4907
4908       yield = authres_local(yield, sub_arg[0]);
4909       yield = authres_iprev(yield);
4910       yield = authres_smtpauth(yield);
4911 #ifdef SUPPORT_SPF
4912       yield = authres_spf(yield);
4913 #endif
4914 #ifndef DISABLE_DKIM
4915       yield = authres_dkim(yield);
4916 #endif
4917 #ifdef SUPPORT_DMARC
4918       yield = authres_dmarc(yield);
4919 #endif
4920 #ifdef EXPERIMENTAL_ARC
4921       yield = authres_arc(yield);
4922 #endif
4923       break;
4924       }
4925
4926     /* Handle conditionals - preserve the values of the numerical expansion
4927     variables in case they get changed by a regular expression match in the
4928     condition. If not, they retain their external settings. At the end
4929     of this "if" section, they get restored to their previous values. */
4930
4931     case EITEM_IF:
4932       {
4933       BOOL cond = FALSE;
4934       const uschar *next_s;
4935       int save_expand_nmax =
4936         save_expand_strings(save_expand_nstring, save_expand_nlength);
4937       uschar * save_lookup_value = lookup_value;
4938
4939       Uskip_whitespace(&s);
4940       if (!(next_s = eval_condition(s, &resetok, flags & ESI_SKIPPING ? NULL : &cond)))
4941         goto EXPAND_FAILED;  /* message already set */
4942
4943       DEBUG(D_expand)
4944         {
4945         debug_expansion_interim(US"condition", s, (int)(next_s - s), !!(flags & ESI_SKIPPING));
4946         debug_expansion_interim(US"result",
4947           cond ? US"true" : US"false", cond ? 4 : 5, !!(flags & ESI_SKIPPING));
4948         }
4949
4950       s = next_s;
4951
4952       /* The handling of "yes" and "no" result strings is now in a separate
4953       function that is also used by ${lookup} and ${extract} and ${run}. */
4954
4955       switch(process_yesno(
4956                flags,                   /* were previously skipping */
4957                cond,                    /* success/failure indicator */
4958                lookup_value,                    /* value to reset for string2 */
4959                &s,                      /* input pointer */
4960                &yield,                  /* output pointer */
4961                US"if",                  /* condition type */
4962                &resetok))
4963         {
4964         case 1: goto EXPAND_FAILED;          /* when all is well, the */
4965         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
4966         }
4967
4968       /* Restore external setting of expansion variables for continuation
4969       at this level. */
4970
4971       lookup_value = save_lookup_value;
4972       restore_expand_strings(save_expand_nmax, save_expand_nstring,
4973         save_expand_nlength);
4974       break;
4975       }
4976
4977 #ifdef SUPPORT_I18N
4978     case EITEM_IMAPFOLDER:
4979       {                         /* ${imapfolder {name}{sep}{specials}} */
4980       uschar *sub_arg[3];
4981       uschar *encoded;
4982
4983       switch(read_subs(sub_arg, nelem(sub_arg), 1, &s, flags, TRUE, name, &resetok, NULL))
4984         {
4985         case 1: goto EXPAND_FAILED_CURLY;
4986         case 2:
4987         case 3: goto EXPAND_FAILED;
4988         }
4989
4990       if (!sub_arg[1])                  /* One argument */
4991         {
4992         sub_arg[1] = US"/";             /* default separator */
4993         sub_arg[2] = NULL;
4994         }
4995       else if (Ustrlen(sub_arg[1]) != 1)
4996         {
4997         expand_string_message =
4998           string_sprintf(
4999                 "IMAP folder separator must be one character, found \"%s\"",
5000                 sub_arg[1]);
5001         goto EXPAND_FAILED;
5002         }
5003
5004       if (flags & ESI_SKIPPING) continue;
5005
5006       if (!(encoded = imap_utf7_encode(sub_arg[0], headers_charset,
5007                           sub_arg[1][0], sub_arg[2], &expand_string_message)))
5008         goto EXPAND_FAILED;
5009       yield = string_cat(yield, encoded);
5010       break;
5011       }
5012 #endif
5013
5014     /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
5015     expanding an internal string that isn't actually going to be used. All we
5016     need to do is check the syntax, so don't do a lookup at all. Preserve the
5017     values of the numerical expansion variables in case they get changed by a
5018     partial lookup. If not, they retain their external settings. At the end
5019     of this "lookup" section, they get restored to their previous values. */
5020
5021     case EITEM_LOOKUP:
5022       {
5023       int stype, partial, affixlen, starflags;
5024       int expand_setup = 0;
5025       int nameptr = 0;
5026       uschar * key, * filename;
5027       const uschar * affix, * opts;
5028       uschar * save_lookup_value = lookup_value;
5029       int save_expand_nmax =
5030         save_expand_strings(save_expand_nstring, save_expand_nlength);
5031
5032       if (expand_forbid & RDO_LOOKUP)
5033         {
5034         expand_string_message = US"lookup expansions are not permitted";
5035         goto EXPAND_FAILED;
5036         }
5037
5038       /* Get the key we are to look up for single-key+file style lookups.
5039       Otherwise set the key NULL pro-tem. */
5040
5041       if (Uskip_whitespace(&s) == '{')                                  /*}*/
5042         {
5043         key = expand_string_internal(s+1,
5044                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
5045         if (!key) goto EXPAND_FAILED;                   /*{{*/
5046         if (*s++ != '}')
5047           {
5048           expand_string_message = US"missing '}' after lookup key";
5049           goto EXPAND_FAILED_CURLY;
5050           }
5051         Uskip_whitespace(&s);
5052         }
5053       else key = NULL;
5054
5055       /* Find out the type of database */
5056
5057       if (!isalpha(*s))
5058         {
5059         expand_string_message = US"missing lookup type";
5060         goto EXPAND_FAILED;
5061         }
5062
5063       /* The type is a string that may contain special characters of various
5064       kinds. Allow everything except space or { to appear; the actual content
5065       is checked by search_findtype_partial. */         /*}*/
5066
5067       while (*s && *s != '{' && !isspace(*s))           /*}*/
5068         {
5069         if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
5070         s++;
5071         }
5072       name[nameptr] = '\0';
5073       Uskip_whitespace(&s);
5074
5075       /* Now check for the individual search type and any partial or default
5076       options. Only those types that are actually in the binary are valid. */
5077
5078       if ((stype = search_findtype_partial(name, &partial, &affix, &affixlen,
5079           &starflags, &opts)) < 0)
5080         {
5081         expand_string_message = search_error_message;
5082         goto EXPAND_FAILED;
5083         }
5084
5085       /* Check that a key was provided for those lookup types that need it,
5086       and was not supplied for those that use the query style. */
5087
5088       if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
5089         {
5090         if (!key)
5091           {
5092           expand_string_message = string_sprintf("missing {key} for single-"
5093             "key \"%s\" lookup", name);
5094           goto EXPAND_FAILED;
5095           }
5096         }
5097       else if (key)
5098         {
5099         expand_string_message = string_sprintf("a single key was given for "
5100           "lookup type \"%s\", which is not a single-key lookup type", name);
5101         goto EXPAND_FAILED;
5102         }
5103
5104       /* Get the next string in brackets and expand it. It is the file name for
5105       single-key+file lookups, and the whole query otherwise. In the case of
5106       queries that also require a file name (e.g. sqlite), the file name comes
5107       first. */
5108
5109       if (*s != '{')
5110         {
5111         expand_string_message = US"missing '{' for lookup file-or-query arg";
5112         goto EXPAND_FAILED_CURLY;                                               /*}}*/
5113         }
5114       if (!(filename = expand_string_internal(s+1,
5115                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
5116         goto EXPAND_FAILED;
5117                                                                                 /*{{*/
5118       if (*s++ != '}')
5119         {
5120         expand_string_message = US"missing '}' closing lookup file-or-query arg";
5121         goto EXPAND_FAILED_CURLY;
5122         }
5123       Uskip_whitespace(&s);
5124
5125       /* If this isn't a single-key+file lookup, re-arrange the variables
5126       to be appropriate for the search_ functions. For query-style lookups,
5127       there is just a "key", and no file name. For the special query-style +
5128       file types, the query (i.e. "key") starts with a file name. */
5129
5130       if (!key)
5131         key = search_args(stype, name, filename, &filename, opts);
5132
5133       /* If skipping, don't do the next bit - just lookup_value == NULL, as if
5134       the entry was not found. Note that there is no search_close() function.
5135       Files are left open in case of re-use. At suitable places in higher logic,
5136       search_tidyup() is called to tidy all open files. This can save opening
5137       the same file several times. However, files may also get closed when
5138       others are opened, if too many are open at once. The rule is that a
5139       handle should not be used after a second search_open().
5140
5141       Request that a partial search sets up $1 and maybe $2 by passing
5142       expand_setup containing zero. If its value changes, reset expand_nmax,
5143       since new variables will have been set. Note that at the end of this
5144       "lookup" section, the old numeric variables are restored. */
5145
5146       if (flags & ESI_SKIPPING)
5147         lookup_value = NULL;
5148       else
5149         {
5150         void * handle = search_open(filename, stype, 0, NULL, NULL);
5151         if (!handle)
5152           {
5153           expand_string_message = search_error_message;
5154           goto EXPAND_FAILED;
5155           }
5156         lookup_value = search_find(handle, filename, key, partial, affix,
5157           affixlen, starflags, &expand_setup, opts);
5158         if (f.search_find_defer)
5159           {
5160           expand_string_message =
5161             string_sprintf("lookup of \"%s\" gave DEFER: %s",
5162               string_printing2(key, SP_TAB), search_error_message);
5163           goto EXPAND_FAILED;
5164           }
5165         if (expand_setup > 0) expand_nmax = expand_setup;
5166         }
5167
5168       /* The handling of "yes" and "no" result strings is now in a separate
5169       function that is also used by ${if} and ${extract}. */
5170
5171       switch(process_yesno(
5172                flags,                   /* were previously skipping */
5173                lookup_value != NULL,    /* success/failure indicator */
5174                save_lookup_value,       /* value to reset for string2 */
5175                &s,                      /* input pointer */
5176                &yield,                  /* output pointer */
5177                US"lookup",              /* condition type */
5178                &resetok))
5179         {
5180         case 1: goto EXPAND_FAILED;          /* when all is well, the */
5181         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
5182         }
5183
5184       /* Restore external setting of expansion variables for carrying on
5185       at this level, and continue. */
5186
5187       restore_expand_strings(save_expand_nmax, save_expand_nstring,
5188         save_expand_nlength);
5189
5190       if (flags & ESI_SKIPPING) continue;
5191       break;
5192       }
5193
5194     /* If Perl support is configured, handle calling embedded perl subroutines,
5195     unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
5196     or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
5197     arguments (defined below). */
5198
5199 #define EXIM_PERL_MAX_ARGS 8
5200
5201     case EITEM_PERL:
5202 #ifndef EXIM_PERL
5203       expand_string_message = US"\"${perl\" encountered, but this facility "    /*}*/
5204         "is not included in this binary";
5205       goto EXPAND_FAILED;
5206
5207 #else   /* EXIM_PERL */
5208       {
5209       uschar * sub_arg[EXIM_PERL_MAX_ARGS + 2];
5210       gstring * new_yield;
5211
5212       if (expand_forbid & RDO_PERL)
5213         {
5214         expand_string_message = US"Perl calls are not permitted";
5215         goto EXPAND_FAILED;
5216         }
5217
5218       switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, flags, TRUE,
5219            name, &resetok, NULL))
5220         {
5221         case -1: continue;      /* If skipping, we don't actually do anything */
5222         case 1: goto EXPAND_FAILED_CURLY;
5223         case 2:
5224         case 3: goto EXPAND_FAILED;
5225         }
5226
5227       /* Start the interpreter if necessary */
5228
5229       if (!opt_perl_started)
5230         {
5231         uschar * initerror;
5232         if (!opt_perl_startup)
5233           {
5234           expand_string_message = US"A setting of perl_startup is needed when "
5235             "using the Perl interpreter";
5236           goto EXPAND_FAILED;
5237           }
5238         DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
5239         if ((initerror = init_perl(opt_perl_startup)))
5240           {
5241           expand_string_message =
5242             string_sprintf("error in perl_startup code: %s\n", initerror);
5243           goto EXPAND_FAILED;
5244           }
5245         opt_perl_started = TRUE;
5246         }
5247
5248       /* Call the function */
5249
5250       sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
5251       new_yield = call_perl_cat(yield, &expand_string_message,
5252         sub_arg[0], sub_arg + 1);
5253
5254       /* NULL yield indicates failure; if the message pointer has been set to
5255       NULL, the yield was undef, indicating a forced failure. Otherwise the
5256       message will indicate some kind of Perl error. */
5257
5258       if (!new_yield)
5259         {
5260         if (!expand_string_message)
5261           {
5262           expand_string_message =
5263             string_sprintf("Perl subroutine \"%s\" returned undef to force "
5264               "failure", sub_arg[0]);
5265           f.expand_string_forcedfail = TRUE;
5266           }
5267         goto EXPAND_FAILED;
5268         }
5269
5270       /* Yield succeeded. Ensure forcedfail is unset, just in case it got
5271       set during a callback from Perl. */
5272
5273       f.expand_string_forcedfail = FALSE;
5274       yield = new_yield;
5275       break;
5276       }
5277 #endif /* EXIM_PERL */
5278
5279     /* Transform email address to "prvs" scheme to use
5280        as BATV-signed return path */
5281
5282     case EITEM_PRVS:
5283       {
5284       uschar * sub_arg[3], * p, * domain;
5285
5286       switch(read_subs(sub_arg, 3, 2, &s, flags, TRUE, name, &resetok, NULL))
5287         {
5288         case -1: continue;      /* If skipping, we don't actually do anything */
5289         case 1: goto EXPAND_FAILED_CURLY;
5290         case 2:
5291         case 3: goto EXPAND_FAILED;
5292         }
5293
5294       /* sub_arg[0] is the address */
5295       if (  !(domain = Ustrrchr(sub_arg[0],'@'))
5296          || domain == sub_arg[0] || Ustrlen(domain) == 1)
5297         {
5298         expand_string_message = US"prvs first argument must be a qualified email address";
5299         goto EXPAND_FAILED;
5300         }
5301
5302       /* Calculate the hash. The third argument must be a single-digit
5303       key number, or unset. */
5304
5305       if (  sub_arg[2]
5306          && (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
5307         {
5308         expand_string_message = US"prvs third argument must be a single digit";
5309         goto EXPAND_FAILED;
5310         }
5311
5312       p = prvs_hmac_sha1(sub_arg[0], sub_arg[1], sub_arg[2], prvs_daystamp(7));
5313       if (!p)
5314         {
5315         expand_string_message = US"prvs hmac-sha1 conversion failed";
5316         goto EXPAND_FAILED;
5317         }
5318
5319       /* Now separate the domain from the local part */
5320       *domain++ = '\0';
5321
5322       yield = string_catn(yield, US"prvs=", 5);
5323       yield = string_catn(yield, sub_arg[2] ? sub_arg[2] : US"0", 1);
5324       yield = string_catn(yield, prvs_daystamp(7), 3);
5325       yield = string_catn(yield, p, 6);
5326       yield = string_catn(yield, US"=", 1);
5327       yield = string_cat (yield, sub_arg[0]);
5328       yield = string_catn(yield, US"@", 1);
5329       yield = string_cat (yield, domain);
5330
5331       break;
5332       }
5333
5334     /* Check a prvs-encoded address for validity */
5335
5336     case EITEM_PRVSCHECK:
5337       {
5338       uschar * sub_arg[3], * p;
5339       gstring * g;
5340       const pcre2_code * re;
5341
5342       /* Reset expansion variables */
5343       prvscheck_result = NULL;
5344       prvscheck_address = NULL;
5345       prvscheck_keynum = NULL;
5346
5347       switch(read_subs(sub_arg, 1, 1, &s, flags, FALSE, name, &resetok, NULL))
5348         {
5349         case 1: goto EXPAND_FAILED_CURLY;
5350         case 2:
5351         case 3: goto EXPAND_FAILED;
5352         }
5353
5354       re = regex_must_compile(
5355         US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
5356         MCS_CASELESS | MCS_CACHEABLE, FALSE);
5357
5358       if (regex_match_and_setup(re,sub_arg[0],0,-1))
5359         {
5360         uschar * local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
5361         uschar * key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
5362         uschar * daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
5363         uschar * hash = string_copyn(expand_nstring[3],expand_nlength[3]);
5364         uschar * domain = string_copyn(expand_nstring[5],expand_nlength[5]);
5365
5366         DEBUG(D_expand)
5367           {
5368           debug_printf_indent("prvscheck localpart: %s\n", local_part);
5369           debug_printf_indent("prvscheck key number: %s\n", key_num);
5370           debug_printf_indent("prvscheck daystamp: %s\n", daystamp);
5371           debug_printf_indent("prvscheck hash: %s\n", hash);
5372           debug_printf_indent("prvscheck domain: %s\n", domain);
5373           }
5374
5375         /* Set up expansion variables */
5376         g = string_cat (NULL, local_part);
5377         g = string_catn(g, US"@", 1);
5378         g = string_cat (g, domain);
5379         prvscheck_address = string_from_gstring(g);
5380         prvscheck_keynum = string_copy(key_num);
5381
5382         /* Now expand the second argument */
5383         switch(read_subs(sub_arg, 1, 1, &s, flags, FALSE, name, &resetok, NULL))
5384           {
5385           case 1: goto EXPAND_FAILED_CURLY;
5386           case 2:
5387           case 3: goto EXPAND_FAILED;
5388           }
5389
5390         /* Now we have the key and can check the address. */
5391
5392         p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
5393           daystamp);
5394         if (!p)
5395           {
5396           expand_string_message = US"hmac-sha1 conversion failed";
5397           goto EXPAND_FAILED;
5398           }
5399
5400         DEBUG(D_expand) debug_printf_indent("prvscheck: received hash is %s\n", hash);
5401         DEBUG(D_expand) debug_printf_indent("prvscheck:      own hash is %s\n", p);
5402
5403         if (Ustrcmp(p,hash) == 0)
5404           {
5405           /* Success, valid BATV address. Now check the expiry date. */
5406           uschar *now = prvs_daystamp(0);
5407           unsigned int inow = 0,iexpire = 1;
5408
5409           (void)sscanf(CS now,"%u",&inow);
5410           (void)sscanf(CS daystamp,"%u",&iexpire);
5411
5412           /* When "iexpire" is < 7, a "flip" has occurred.
5413              Adjust "inow" accordingly. */
5414           if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
5415
5416           if (iexpire >= inow)
5417             {
5418             prvscheck_result = US"1";
5419             DEBUG(D_expand) debug_printf_indent("prvscheck: success, $prvscheck_result set to 1\n");
5420             }
5421           else
5422             {
5423             prvscheck_result = NULL;
5424             DEBUG(D_expand) debug_printf_indent("prvscheck: signature expired, $prvscheck_result unset\n");
5425             }
5426           }
5427         else
5428           {
5429           prvscheck_result = NULL;
5430           DEBUG(D_expand) debug_printf_indent("prvscheck: hash failure, $prvscheck_result unset\n");
5431           }
5432
5433         /* Now expand the final argument. We leave this till now so that
5434         it can include $prvscheck_result. */
5435
5436         switch(read_subs(sub_arg, 1, 0, &s, flags, TRUE, name, &resetok, NULL))
5437           {
5438           case 1: goto EXPAND_FAILED_CURLY;
5439           case 2:
5440           case 3: goto EXPAND_FAILED;
5441           }
5442
5443         yield = string_cat(yield,
5444           !sub_arg[0] || !*sub_arg[0] ? prvscheck_address : sub_arg[0]);
5445
5446         /* Reset the "internal" variables afterwards, because they are in
5447         dynamic store that will be reclaimed if the expansion succeeded. */
5448
5449         prvscheck_address = NULL;
5450         prvscheck_keynum = NULL;
5451         }
5452       else
5453         /* Does not look like a prvs encoded address, return the empty string.
5454            We need to make sure all subs are expanded first, so as to skip over
5455            the entire item. */
5456
5457         switch(read_subs(sub_arg, 2, 1, &s, flags, TRUE, name, &resetok, NULL))
5458           {
5459           case 1: goto EXPAND_FAILED_CURLY;
5460           case 2:
5461           case 3: goto EXPAND_FAILED;
5462           }
5463
5464       if (flags & ESI_SKIPPING) continue;
5465       break;
5466       }
5467
5468     /* Handle "readfile" to insert an entire file */
5469
5470     case EITEM_READFILE:
5471       {
5472       FILE * f;
5473       uschar * sub_arg[2];
5474
5475       if ((expand_forbid & RDO_READFILE) != 0)
5476         {
5477         expand_string_message = US"file insertions are not permitted";
5478         goto EXPAND_FAILED;
5479         }
5480
5481       switch(read_subs(sub_arg, 2, 1, &s, flags, TRUE, name, &resetok, NULL))
5482         {
5483         case -1: continue;      /* If skipping, we don't actually do anything */
5484         case 1: goto EXPAND_FAILED_CURLY;
5485         case 2:
5486         case 3: goto EXPAND_FAILED;
5487         }
5488
5489       /* Open the file and read it */
5490
5491       if (!(f = Ufopen(sub_arg[0], "rb")))
5492         {
5493         expand_string_message = string_open_failed("%s", sub_arg[0]);
5494         goto EXPAND_FAILED;
5495         }
5496
5497       yield = cat_file(f, yield, sub_arg[1]);
5498       (void)fclose(f);
5499       break;
5500       }
5501
5502     /* Handle "readsocket" to insert data from a socket, either
5503     Inet or Unix domain */
5504
5505     case EITEM_READSOCK:
5506       {
5507       uschar * arg;
5508       uschar * sub_arg[4];
5509
5510       if (expand_forbid & RDO_READSOCK)
5511         {
5512         expand_string_message = US"socket insertions are not permitted";
5513         goto EXPAND_FAILED;
5514         }
5515
5516       /* Read up to 4 arguments, but don't do the end of item check afterwards,
5517       because there may be a string for expansion on failure. */
5518
5519       switch(read_subs(sub_arg, 4, 2, &s, flags, FALSE, name, &resetok, NULL))
5520         {
5521         case 1: goto EXPAND_FAILED_CURLY;
5522         case 2:                             /* Won't occur: no end check */
5523         case 3: goto EXPAND_FAILED;
5524         }
5525
5526       /* If skipping, we don't actually do anything. Otherwise, arrange to
5527       connect to either an IP or a Unix socket. */
5528
5529       if (!(flags & ESI_SKIPPING))
5530         {
5531         int stype = search_findtype(US"readsock", 8);
5532         gstring * g = NULL;
5533         void * handle;
5534         int expand_setup = -1;
5535         uschar * s;
5536
5537         /* If the reqstr is empty, flag that and set a dummy */
5538
5539         if (!sub_arg[1][0])
5540           {
5541           g = string_append_listele(g, ',', US"send=no");
5542           sub_arg[1] = US"DUMMY";
5543           }
5544
5545         /* Re-marshall the options */
5546
5547         if (sub_arg[2])
5548           {
5549           const uschar * list = sub_arg[2];
5550           uschar * item;
5551           int sep = 0;
5552
5553           /* First option has no tag and is timeout */
5554           if ((item = string_nextinlist(&list, &sep, NULL, 0)))
5555             g = string_append_listele(g, ',',
5556                   string_sprintf("timeout=%s", item));
5557
5558           /* The rest of the options from the expansion */
5559           while ((item = string_nextinlist(&list, &sep, NULL, 0)))
5560             g = string_append_listele(g, ',', item);
5561
5562           /* possibly plus an EOL string.  Process with escapes, to protect
5563           from list-processing.  The only current user of eol= in search
5564           options is the readsock expansion. */
5565
5566           if (sub_arg[3] && *sub_arg[3])
5567             g = string_append_listele(g, ',',
5568                   string_sprintf("eol=%s",
5569                     string_printing2(sub_arg[3], SP_TAB|SP_SPACE)));
5570           }
5571
5572         /* Gat a (possibly cached) handle for the connection */
5573
5574         if (!(handle = search_open(sub_arg[0], stype, 0, NULL, NULL)))
5575           {
5576           if (*expand_string_message) goto EXPAND_FAILED;
5577           expand_string_message = search_error_message;
5578           search_error_message = NULL;
5579           goto SOCK_FAIL;
5580           }
5581
5582         /* Get (possibly cached) results for the lookup */
5583         /* sspec: sub_arg[0]  req: sub_arg[1]  opts: g */
5584
5585         if ((s = search_find(handle, sub_arg[0], sub_arg[1], -1, NULL, 0, 0,
5586                                     &expand_setup, string_from_gstring(g))))
5587           yield = string_cat(yield, s);
5588         else if (f.search_find_defer)
5589           {
5590           expand_string_message = search_error_message;
5591           search_error_message = NULL;
5592           goto SOCK_FAIL;
5593           }
5594         else
5595           {     /* should not happen, at present */
5596           expand_string_message = search_error_message;
5597           search_error_message = NULL;
5598           goto SOCK_FAIL;
5599           }
5600         }
5601
5602       /* The whole thing has worked (or we were skipping). If there is a
5603       failure string following, we need to skip it. */
5604
5605       if (*s == '{')                                                    /*}*/
5606         {
5607         if (!expand_string_internal(s+1,
5608           ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL))
5609           goto EXPAND_FAILED;                                           /*{*/
5610         if (*s++ != '}')
5611           {                                                             /*{*/
5612           expand_string_message = US"missing '}' closing failstring for readsocket";
5613           goto EXPAND_FAILED_CURLY;
5614           }
5615         Uskip_whitespace(&s);
5616         }
5617
5618     READSOCK_DONE:                                                      /*{*/
5619       if (*s++ != '}')
5620         {                                                               /*{*/
5621         expand_string_message = US"missing '}' closing readsocket";
5622         goto EXPAND_FAILED_CURLY;
5623         }
5624       if (flags & ESI_SKIPPING) continue;
5625       break;
5626
5627       /* Come here on failure to create socket, connect socket, write to the
5628       socket, or timeout on reading. If another substring follows, expand and
5629       use it. Otherwise, those conditions give expand errors. */
5630
5631     SOCK_FAIL:
5632       if (*s != '{') goto EXPAND_FAILED;                                /*}*/
5633       DEBUG(D_any) debug_printf("%s\n", expand_string_message);
5634       if (!(arg = expand_string_internal(s+1,
5635                     ESI_BRACE_ENDS | ESI_HONOR_DOLLAR, &s, &resetok, NULL)))
5636         goto EXPAND_FAILED;
5637       yield = string_cat(yield, arg);                                   /*{*/
5638       if (*s++ != '}')
5639         {                                                               /*{*/
5640         expand_string_message = US"missing '}' closing failstring for readsocket";
5641         goto EXPAND_FAILED_CURLY;
5642         }
5643       Uskip_whitespace(&s);
5644       goto READSOCK_DONE;
5645       }
5646
5647     /* Handle "run" to execute a program. */
5648
5649     case EITEM_RUN:
5650       {
5651       FILE * f;
5652       const uschar * arg, ** argv;
5653       unsigned late_expand = TSUC_EXPAND_ARGS | TSUC_ALLOW_TAINTED_ARGS | TSUC_ALLOW_RECIPIENTS;
5654
5655       if (expand_forbid & RDO_RUN)
5656         {
5657         expand_string_message = US"running a command is not permitted";
5658         goto EXPAND_FAILED;
5659         }
5660
5661       /* Handle options to the "run" */
5662
5663       while (*s == ',')
5664         if (Ustrncmp(++s, "preexpand", 9) == 0)
5665           { late_expand = 0; s += 9; }
5666         else
5667           {
5668           const uschar * t = s;
5669           while (isalpha(*++t)) ;
5670           expand_string_message = string_sprintf("bad option '%.*s' for run",
5671                                                   (int)(t-s), s);
5672           goto EXPAND_FAILED;
5673           }
5674       Uskip_whitespace(&s);
5675
5676       if (*s != '{')                                    /*}*/
5677         {
5678         expand_string_message = US"missing '{' for command arg of run";
5679         goto EXPAND_FAILED_CURLY;                       /*"}*/
5680         }
5681       s++;
5682
5683       if (late_expand)          /* this is the default case */
5684         {
5685         int n;
5686         const uschar * t;
5687         /* Locate the end of the args */
5688         (void) expand_string_internal(s,
5689           ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &t, NULL, NULL);
5690         n = t - s;
5691         arg = flags & ESI_SKIPPING ? NULL : string_copyn(s, n);
5692         s += n;
5693         }
5694       else
5695         {
5696         DEBUG(D_expand)
5697           debug_printf_indent("args string for ${run} expand before split\n");
5698         if (!(arg = expand_string_internal(s,
5699                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
5700           goto EXPAND_FAILED;
5701         Uskip_whitespace(&s);
5702         }
5703                                                         /*{*/
5704       if (*s++ != '}')
5705         {                                               /*{*/
5706         expand_string_message = US"missing '}' closing command arg of run";
5707         goto EXPAND_FAILED_CURLY;
5708         }
5709
5710       if (flags & ESI_SKIPPING)   /* Just pretend it worked when we're skipping */
5711         {
5712         runrc = 0;
5713         lookup_value = NULL;
5714         }
5715       else
5716         {
5717         int fd_in, fd_out;
5718         pid_t pid;
5719
5720         if (!transport_set_up_command(&argv,    /* anchor for arg list */
5721             arg,                                /* raw command */
5722             late_expand,                /* expand args if not already done */
5723             0,                          /* not relevant when... */
5724             NULL,                       /* no transporting address */
5725             US"${run} expansion",       /* for error messages */
5726             &expand_string_message))    /* where to put error message */
5727           goto EXPAND_FAILED;
5728
5729         /* Create the child process, making it a group leader. */
5730
5731         if ((pid = child_open(USS argv, NULL, 0077, &fd_in, &fd_out, TRUE,
5732                               US"expand-run")) < 0)
5733           {
5734           expand_string_message =
5735             string_sprintf("couldn't create child process: %s", strerror(errno));
5736           goto EXPAND_FAILED;
5737           }
5738
5739         /* Nothing is written to the standard input. */
5740
5741         (void)close(fd_in);
5742
5743         /* Read the pipe to get the command's output into $value (which is kept
5744         in lookup_value). Read during execution, so that if the output exceeds
5745         the OS pipe buffer limit, we don't block forever. Remember to not release
5746         memory just allocated for $value. */
5747
5748         resetok = FALSE;
5749         f = fdopen(fd_out, "rb");
5750         sigalrm_seen = FALSE;
5751         ALARM(60);
5752         lookup_value = string_from_gstring(cat_file(f, NULL, NULL));
5753         ALARM_CLR(0);
5754         (void)fclose(f);
5755
5756         /* Wait for the process to finish, applying the timeout, and inspect its
5757         return code for serious disasters. Simple non-zero returns are passed on.
5758         */
5759
5760         if (sigalrm_seen || (runrc = child_close(pid, 30)) < 0)
5761           {
5762           if (sigalrm_seen || runrc == -256)
5763             {
5764             expand_string_message = US"command timed out";
5765             killpg(pid, SIGKILL);       /* Kill the whole process group */
5766             }
5767
5768           else if (runrc == -257)
5769             expand_string_message = string_sprintf("wait() failed: %s",
5770               strerror(errno));
5771
5772           else
5773             expand_string_message = string_sprintf("command killed by signal %d",
5774               -runrc);
5775
5776           goto EXPAND_FAILED;
5777           }
5778         }
5779
5780       /* Process the yes/no strings; $value may be useful in both cases */
5781
5782       switch(process_yesno(
5783                flags,                   /* were previously skipping */
5784                runrc == 0,              /* success/failure indicator */
5785                lookup_value,            /* value to reset for string2 */
5786                &s,                      /* input pointer */
5787                &yield,                  /* output pointer */
5788                US"run",                 /* condition type */
5789                &resetok))
5790         {
5791         case 1: goto EXPAND_FAILED;          /* when all is well, the */
5792         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
5793         }
5794
5795       if (flags & ESI_SKIPPING) continue;
5796       break;
5797       }
5798
5799     /* Handle character translation for "tr" */
5800
5801     case EITEM_TR:
5802       {
5803       int oldptr = gstring_length(yield);
5804       int o2m;
5805       uschar * sub[3];
5806
5807       switch(read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, NULL))
5808         {
5809         case -1: continue;      /* skipping */
5810         case 1: goto EXPAND_FAILED_CURLY;
5811         case 2:
5812         case 3: goto EXPAND_FAILED;
5813         }
5814
5815       if (  (yield = string_cat(yield, sub[0]))
5816          && (o2m = Ustrlen(sub[2]) - 1) >= 0)
5817           for (; oldptr < yield->ptr; oldptr++)
5818         {
5819         uschar * m = Ustrrchr(sub[1], yield->s[oldptr]);
5820         if (m)
5821           {
5822           int o = m - sub[1];
5823           yield->s[oldptr] = sub[2][o < o2m ? o : o2m];
5824           }
5825         }
5826
5827       break;
5828       }
5829
5830     /* Handle "hash", "length", "nhash", and "substr" when they are given with
5831     expanded arguments. */
5832
5833     case EITEM_HASH:
5834     case EITEM_LENGTH:
5835     case EITEM_NHASH:
5836     case EITEM_SUBSTR:
5837       {
5838       int len;
5839       uschar *ret;
5840       int val[2] = { 0, -1 };
5841       uschar * sub[3];
5842
5843       /* "length" takes only 2 arguments whereas the others take 2 or 3.
5844       Ensure that sub[2] is set in the ${length } case. */
5845
5846       sub[2] = NULL;
5847       switch(read_subs(sub, item_type == EITEM_LENGTH ? 2:3, 2, &s, flags,
5848              TRUE, name, &resetok, NULL))
5849         {
5850         case -1: continue;      /* skipping */
5851         case 1: goto EXPAND_FAILED_CURLY;
5852         case 2:
5853         case 3: goto EXPAND_FAILED;
5854         }
5855
5856       /* Juggle the arguments if there are only two of them: always move the
5857       string to the last position and make ${length{n}{str}} equivalent to
5858       ${substr{0}{n}{str}}. See the defaults for val[] above. */
5859
5860       if (!sub[2])
5861         {
5862         sub[2] = sub[1];
5863         sub[1] = NULL;
5864         if (item_type == EITEM_LENGTH)
5865           {
5866           sub[1] = sub[0];
5867           sub[0] = NULL;
5868           }
5869         }
5870
5871       for (int i = 0; i < 2; i++) if (sub[i])
5872         {
5873         val[i] = (int)Ustrtol(sub[i], &ret, 10);
5874         if (*ret != 0 || (i != 0 && val[i] < 0))
5875           {
5876           expand_string_message = string_sprintf("\"%s\" is not a%s number "
5877             "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
5878           goto EXPAND_FAILED;
5879           }
5880         }
5881
5882       ret =
5883         item_type == EITEM_HASH
5884         ?  compute_hash(sub[2], val[0], val[1], &len)
5885         : item_type == EITEM_NHASH
5886         ? compute_nhash(sub[2], val[0], val[1], &len)
5887         : extract_substr(sub[2], val[0], val[1], &len);
5888       if (!ret)
5889         goto EXPAND_FAILED;
5890       yield = string_catn(yield, ret, len);
5891       break;
5892       }
5893
5894     /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
5895     This code originally contributed by Steve Haslam. It currently supports
5896     the use of MD5 and SHA-1 hashes.
5897
5898     We need some workspace that is large enough to handle all the supported
5899     hash types. Use macros to set the sizes rather than be too elaborate. */
5900
5901     #define MAX_HASHLEN      20
5902     #define MAX_HASHBLOCKLEN 64
5903
5904     case EITEM_HMAC:
5905       {
5906       uschar * sub[3];
5907       md5 md5_base;
5908       hctx sha1_ctx;
5909       void * use_base;
5910       int type;
5911       int hashlen;      /* Number of octets for the hash algorithm's output */
5912       int hashblocklen; /* Number of octets the hash algorithm processes */
5913       uschar * keyptr, * p;
5914       unsigned int keylen;
5915
5916       uschar keyhash[MAX_HASHLEN];
5917       uschar innerhash[MAX_HASHLEN];
5918       uschar finalhash[MAX_HASHLEN];
5919       uschar finalhash_hex[2*MAX_HASHLEN];
5920       uschar innerkey[MAX_HASHBLOCKLEN];
5921       uschar outerkey[MAX_HASHBLOCKLEN];
5922
5923       switch (read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, NULL))
5924         {
5925         case -1: continue;      /* skipping */
5926         case 1: goto EXPAND_FAILED_CURLY;
5927         case 2:
5928         case 3: goto EXPAND_FAILED;
5929         }
5930
5931       if (Ustrcmp(sub[0], "md5") == 0)
5932         {
5933         type = HMAC_MD5;
5934         use_base = &md5_base;
5935         hashlen = 16;
5936         hashblocklen = 64;
5937         }
5938       else if (Ustrcmp(sub[0], "sha1") == 0)
5939         {
5940         type = HMAC_SHA1;
5941         use_base = &sha1_ctx;
5942         hashlen = 20;
5943         hashblocklen = 64;
5944         }
5945       else
5946         {
5947         expand_string_message =
5948           string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
5949         goto EXPAND_FAILED;
5950         }
5951
5952       keyptr = sub[1];
5953       keylen = Ustrlen(keyptr);
5954
5955       /* If the key is longer than the hash block length, then hash the key
5956       first */
5957
5958       if (keylen > hashblocklen)
5959         {
5960         chash_start(type, use_base);
5961         chash_end(type, use_base, keyptr, keylen, keyhash);
5962         keyptr = keyhash;
5963         keylen = hashlen;
5964         }
5965
5966       /* Now make the inner and outer key values */
5967
5968       memset(innerkey, 0x36, hashblocklen);
5969       memset(outerkey, 0x5c, hashblocklen);
5970
5971       for (int i = 0; i < keylen; i++)
5972         {
5973         innerkey[i] ^= keyptr[i];
5974         outerkey[i] ^= keyptr[i];
5975         }
5976
5977       /* Now do the hashes */
5978
5979       chash_start(type, use_base);
5980       chash_mid(type, use_base, innerkey);
5981       chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
5982
5983       chash_start(type, use_base);
5984       chash_mid(type, use_base, outerkey);
5985       chash_end(type, use_base, innerhash, hashlen, finalhash);
5986
5987       /* Encode the final hash as a hex string */
5988
5989       p = finalhash_hex;
5990       for (int i = 0; i < hashlen; i++)
5991         {
5992         *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
5993         *p++ = hex_digits[finalhash[i] & 0x0f];
5994         }
5995
5996       DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%s)=%.*s\n",
5997         sub[0], (int)keylen, keyptr, sub[2], hashlen*2, finalhash_hex);
5998
5999       yield = string_catn(yield, finalhash_hex, hashlen*2);
6000       break;
6001       }
6002
6003     /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
6004     We have to save the numerical variables and restore them afterwards. */
6005
6006     case EITEM_SG:
6007       {
6008       const pcre2_code * re;
6009       int moffset, moffsetextra, slen;
6010       pcre2_match_data * md;
6011       int emptyopt;
6012       uschar * subject, * sub[3];
6013       int save_expand_nmax =
6014         save_expand_strings(save_expand_nstring, save_expand_nlength);
6015       unsigned sub_textonly = 0;
6016
6017       switch(read_subs(sub, 3, 3, &s, flags, TRUE, name, &resetok, &sub_textonly))
6018         {
6019         case -1: continue;      /* skipping */
6020         case 1: goto EXPAND_FAILED_CURLY;
6021         case 2:
6022         case 3: goto EXPAND_FAILED;
6023         }
6024
6025       /* Compile the regular expression */
6026
6027       re = regex_compile(sub[1],
6028               sub_textonly & BIT(1) ? MCS_CACHEABLE : MCS_NOFLAGS,
6029               &expand_string_message, pcre_gen_cmp_ctx);
6030       if (!re)
6031         goto EXPAND_FAILED;
6032
6033       md = pcre2_match_data_create(EXPAND_MAXN + 1, pcre_gen_ctx);
6034
6035       /* Now run a loop to do the substitutions as often as necessary. It ends
6036       when there are no more matches. Take care over matches of the null string;
6037       do the same thing as Perl does. */
6038
6039       subject = sub[0];
6040       slen = Ustrlen(sub[0]);
6041       moffset = moffsetextra = 0;
6042       emptyopt = 0;
6043
6044       for (;;)
6045         {
6046         PCRE2_SIZE * ovec = pcre2_get_ovector_pointer(md);
6047         int n = pcre2_match(re, (PCRE2_SPTR)subject, slen, moffset + moffsetextra,
6048           PCRE_EOPT | emptyopt, md, pcre_gen_mtc_ctx);
6049         uschar * insert;
6050
6051         /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
6052         is not necessarily the end. We want to repeat the match from one
6053         character further along, but leaving the basic offset the same (for
6054         copying below). We can't be at the end of the string - that was checked
6055         before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
6056         finished; copy the remaining string and end the loop. */
6057
6058         if (n < 0)
6059           {
6060           if (emptyopt != 0)
6061             {
6062             moffsetextra = 1;
6063             emptyopt = 0;
6064             continue;
6065             }
6066           yield = string_catn(yield, subject+moffset, slen-moffset);
6067           break;
6068           }
6069
6070         /* Match - set up for expanding the replacement. */
6071         DEBUG(D_expand) debug_printf_indent("%s: match\n", name);
6072
6073         if (n == 0) n = EXPAND_MAXN + 1;
6074         expand_nmax = 0;
6075         for (int nn = 0; nn < n*2; nn += 2)
6076           {
6077           expand_nstring[expand_nmax] = subject + ovec[nn];
6078           expand_nlength[expand_nmax++] = ovec[nn+1] - ovec[nn];
6079           }
6080         expand_nmax--;
6081
6082         /* Copy the characters before the match, plus the expanded insertion. */
6083
6084         yield = string_catn(yield, subject + moffset, ovec[0] - moffset);
6085
6086         if (!(insert = expand_string(sub[2])))
6087           goto EXPAND_FAILED;
6088         yield = string_cat(yield, insert);
6089
6090         moffset = ovec[1];
6091         moffsetextra = 0;
6092         emptyopt = 0;
6093
6094         /* If we have matched an empty string, first check to see if we are at
6095         the end of the subject. If so, the loop is over. Otherwise, mimic
6096         what Perl's /g options does. This turns out to be rather cunning. First
6097         we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
6098         string at the same point. If this fails (picked up above) we advance to
6099         the next character. */
6100
6101         if (ovec[0] == ovec[1])
6102           {
6103           if (ovec[0] == slen) break;
6104           emptyopt = PCRE2_NOTEMPTY | PCRE2_ANCHORED;
6105           }
6106         }
6107
6108       /* All done - restore numerical variables. */
6109
6110       /* pcre2_match_data_free(md);     gen ctx needs no free */
6111       restore_expand_strings(save_expand_nmax, save_expand_nstring,
6112         save_expand_nlength);
6113       break;
6114       }
6115
6116     /* Handle keyed and numbered substring extraction. If the first argument
6117     consists entirely of digits, then a numerical extraction is assumed. */
6118
6119     case EITEM_EXTRACT:
6120       {
6121       int field_number = 1;
6122       BOOL field_number_set = FALSE;
6123       uschar * save_lookup_value = lookup_value, * sub[3];
6124       int save_expand_nmax =
6125         save_expand_strings(save_expand_nstring, save_expand_nlength);
6126
6127       /* On reflection the original behaviour of extract-json for a string
6128       result, leaving it quoted, was a mistake.  But it was already published,
6129       hence the addition of jsons.  In a future major version, make json
6130       work like josons, and withdraw jsons. */
6131
6132       enum {extract_basic, extract_json, extract_jsons} fmt = extract_basic;
6133
6134       /* Check for a format-variant specifier */
6135
6136       if (Uskip_whitespace(&s) != '{')                                  /*}*/
6137         if (Ustrncmp(s, "json", 4) == 0)
6138           if (*(s += 4) == 's')
6139             {fmt = extract_jsons; s++;}
6140           else
6141             fmt = extract_json;
6142
6143       /* While skipping we cannot rely on the data for expansions being
6144       available (eg. $item) hence cannot decide on numeric vs. keyed.
6145       Read a maximum of 5 arguments (including the yes/no) */
6146
6147       if (flags & ESI_SKIPPING)
6148         {
6149         for (int j = 5; j > 0 && *s == '{'; j--)                        /*'}'*/
6150           {
6151           if (!expand_string_internal(s+1,
6152                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL))
6153             goto EXPAND_FAILED;                                 /*'{'*/
6154           if (*s++ != '}')
6155             {
6156             expand_string_message = US"missing '{' for arg of extract";
6157             goto EXPAND_FAILED_CURLY;
6158             }
6159           Uskip_whitespace(&s);
6160           }
6161         if (  Ustrncmp(s, "fail", 4) == 0                               /*'{'*/
6162            && (s[4] == '}' || s[4] == ' ' || s[4] == '\t' || !s[4])
6163            )
6164           {
6165           s += 4;
6166           Uskip_whitespace(&s);
6167           }                                                             /*'{'*/
6168         if (*s != '}')
6169           {
6170           expand_string_message = US"missing '}' closing extract";
6171           goto EXPAND_FAILED_CURLY;
6172           }
6173         }
6174
6175       else for (int i = 0, j = 2; i < j; i++) /* Read the proper number of arguments */
6176         {
6177         if (Uskip_whitespace(&s) == '{')                                /*'}'*/
6178           {
6179           if (!(sub[i] = expand_string_internal(s+1,
6180                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
6181             goto EXPAND_FAILED;                                         /*'{'*/
6182           if (*s++ != '}')
6183             {
6184             expand_string_message = string_sprintf(
6185               "missing '}' closing arg %d of extract", i+1);
6186             goto EXPAND_FAILED_CURLY;
6187             }
6188
6189           /* After removal of leading and trailing white space, the first
6190           argument must not be empty; if it consists entirely of digits
6191           (optionally preceded by a minus sign), this is a numerical
6192           extraction, and we expect 3 arguments (normal) or 2 (json). */
6193
6194           if (i == 0)
6195             {
6196             int len;
6197             int x = 0;
6198             uschar * p = sub[0];
6199
6200             Uskip_whitespace(&p);
6201             sub[0] = p;
6202
6203             len = Ustrlen(p);
6204             while (len > 0 && isspace(p[len-1])) len--;
6205             p[len] = 0;
6206
6207             if (!*p)
6208               {
6209               expand_string_message = US"first argument of \"extract\" must "
6210                 "not be empty";
6211               goto EXPAND_FAILED;
6212               }
6213
6214             if (*p == '-')
6215               {
6216               field_number = -1;
6217               p++;
6218               }
6219             while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
6220             if (!*p)
6221               {
6222               field_number *= x;
6223               if (fmt == extract_basic) j = 3;               /* Need 3 args */
6224               field_number_set = TRUE;
6225               }
6226             }
6227           }
6228         else
6229           {
6230           expand_string_message = string_sprintf(
6231             "missing '{' for arg %d of extract", i+1);
6232           goto EXPAND_FAILED_CURLY;
6233           }
6234         }
6235
6236       /* Extract either the numbered or the keyed substring into $value. If
6237       skipping, just pretend the extraction failed. */
6238
6239       if (flags & ESI_SKIPPING)
6240         lookup_value = NULL;
6241       else switch (fmt)
6242         {
6243         case extract_basic:
6244           lookup_value = field_number_set
6245             ? expand_gettokened(field_number, sub[1], sub[2])
6246             : expand_getkeyed(sub[0], sub[1]);
6247           break;
6248
6249         case extract_json:
6250         case extract_jsons:
6251           {
6252           uschar * s, * item;
6253           const uschar * list;
6254
6255           /* Array: Bracket-enclosed and comma-separated.
6256           Object: Brace-enclosed, comma-sep list of name:value pairs */
6257
6258           if (!(s = dewrap(sub[1], field_number_set ? US"[]" : US"{}")))
6259             {
6260             expand_string_message =
6261               string_sprintf("%s wrapping %s for extract json",
6262                 expand_string_message,
6263                 field_number_set ? "array" : "object");
6264             goto EXPAND_FAILED_CURLY;
6265             }
6266
6267           list = s;
6268           if (field_number_set)
6269             {
6270             if (field_number <= 0)
6271               {
6272               expand_string_message = US"first argument of \"extract\" must "
6273                 "be greater than zero";
6274               goto EXPAND_FAILED;
6275               }
6276             while (field_number > 0 && (item = json_nextinlist(&list)))
6277               field_number--;
6278             if ((lookup_value = s = item))
6279               {
6280               while (*s) s++;
6281               while (--s >= lookup_value && isspace(*s)) *s = '\0';
6282               }
6283             }
6284           else
6285             {
6286             lookup_value = NULL;
6287             while ((item = json_nextinlist(&list)))
6288               {
6289               /* Item is:  string name-sep value.  string is quoted.
6290               Dequote the string and compare with the search key. */
6291
6292               if (!(item = dewrap(item, US"\"\"")))
6293                 {
6294                 expand_string_message =
6295                   string_sprintf("%s wrapping string key for extract json",
6296                     expand_string_message);
6297                 goto EXPAND_FAILED_CURLY;
6298                 }
6299               if (Ustrcmp(item, sub[0]) == 0)   /*XXX should be a UTF8-compare */
6300                 {
6301                 s = item + Ustrlen(item) + 1;
6302                 if (Uskip_whitespace(&s) != ':')
6303                   {
6304                   expand_string_message =
6305                     US"missing object value-separator for extract json";
6306                   goto EXPAND_FAILED_CURLY;
6307                   }
6308                 s++;
6309                 Uskip_whitespace(&s);
6310                 lookup_value = s;
6311                 break;
6312                 }
6313               }
6314             }
6315           }
6316
6317           if (  fmt == extract_jsons
6318              && lookup_value
6319              && !(lookup_value = dewrap(lookup_value, US"\"\"")))
6320             {
6321             expand_string_message =
6322               string_sprintf("%s wrapping string result for extract jsons",
6323                 expand_string_message);
6324             goto EXPAND_FAILED_CURLY;
6325             }
6326           break;        /* json/s */
6327         }
6328
6329       /* If no string follows, $value gets substituted; otherwise there can
6330       be yes/no strings, as for lookup or if. */
6331
6332       switch(process_yesno(
6333                flags,                   /* were previously skipping */
6334                lookup_value != NULL,    /* success/failure indicator */
6335                save_lookup_value,       /* value to reset for string2 */
6336                &s,                      /* input pointer */
6337                &yield,                  /* output pointer */
6338                US"extract",             /* condition type */
6339                &resetok))
6340         {
6341         case 1: goto EXPAND_FAILED;          /* when all is well, the */
6342         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
6343         }
6344
6345       /* All done - restore numerical variables. */
6346
6347       restore_expand_strings(save_expand_nmax, save_expand_nstring,
6348         save_expand_nlength);
6349
6350       if (flags & ESI_SKIPPING) continue;
6351       break;
6352       }
6353
6354     /* return the Nth item from a list */
6355
6356     case EITEM_LISTEXTRACT:
6357       {
6358       int field_number = 1;
6359       uschar * save_lookup_value = lookup_value, * sub[2];
6360       int save_expand_nmax =
6361         save_expand_strings(save_expand_nstring, save_expand_nlength);
6362
6363       /* Read the field & list arguments */
6364       /*XXX Could we use read_subs here (and get better efficiency for skipping)? */
6365
6366       for (int i = 0; i < 2; i++)
6367         {
6368         if (Uskip_whitespace(&s) != '{')                                /*}*/
6369           {
6370           expand_string_message = string_sprintf(
6371             "missing '{' for arg %d of listextract", i+1);              /*}*/
6372           goto EXPAND_FAILED_CURLY;
6373           }
6374
6375         sub[i] = expand_string_internal(s+1,
6376               ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6377         if (!sub[i])     goto EXPAND_FAILED;                            /*{{*/
6378         if (*s++ != '}')
6379           {
6380           expand_string_message = string_sprintf(
6381             "missing '}' closing arg %d of listextract", i+1);
6382           goto EXPAND_FAILED_CURLY;
6383           }
6384
6385         /* After removal of leading and trailing white space, the first
6386         argument must be numeric and nonempty. */
6387
6388         if (i == 0)
6389           {
6390           int len;
6391           int x = 0;
6392           uschar *p = sub[0];
6393
6394           Uskip_whitespace(&p);
6395           sub[0] = p;
6396
6397           len = Ustrlen(p);
6398           while (len > 0 && isspace(p[len-1])) len--;
6399           p[len] = 0;
6400
6401           if (!*p && !(flags & ESI_SKIPPING))
6402             {
6403             expand_string_message = US"first argument of \"listextract\" must "
6404               "not be empty";
6405             goto EXPAND_FAILED;
6406             }
6407
6408           if (*p == '-')
6409             {
6410             field_number = -1;
6411             p++;
6412             }
6413           while (*p && isdigit(*p)) x = x * 10 + *p++ - '0';
6414           if (*p)
6415             {
6416             expand_string_message = US"first argument of \"listextract\" must "
6417               "be numeric";
6418             goto EXPAND_FAILED;
6419             }
6420           field_number *= x;
6421           }
6422         }
6423
6424       /* Extract the numbered element into $value. If
6425       skipping, just pretend the extraction failed. */
6426
6427       lookup_value = flags & ESI_SKIPPING ? NULL : expand_getlistele(field_number, sub[1]);
6428
6429       /* If no string follows, $value gets substituted; otherwise there can
6430       be yes/no strings, as for lookup or if. */
6431
6432       switch(process_yesno(
6433                flags,                           /* were previously skipping */
6434                lookup_value != NULL,            /* success/failure indicator */
6435                save_lookup_value,               /* value to reset for string2 */
6436                &s,                              /* input pointer */
6437                &yield,                          /* output pointer */
6438                US"listextract",                 /* condition type */
6439                &resetok))
6440         {
6441         case 1: goto EXPAND_FAILED;          /* when all is well, the */
6442         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
6443         }
6444
6445       /* All done - restore numerical variables. */
6446
6447       restore_expand_strings(save_expand_nmax, save_expand_nstring,
6448         save_expand_nlength);
6449
6450       if (flags & ESI_SKIPPING) continue;
6451       break;
6452       }
6453
6454     case EITEM_LISTQUOTE:
6455       {
6456       uschar * sub[2];
6457       switch(read_subs(sub, 2, 2, &s, flags, TRUE, name, &resetok, NULL))
6458         {
6459         case -1: continue;      /* skipping */
6460         case 1: goto EXPAND_FAILED_CURLY;
6461         case 2:
6462         case 3: goto EXPAND_FAILED;
6463         }
6464       if (*sub[1]) for (uschar sep = *sub[0], c; c = *sub[1]; sub[1]++)
6465         {
6466         if (c == sep) yield = string_catn(yield, sub[1], 1);
6467         yield = string_catn(yield, sub[1], 1);
6468         }
6469       else yield = string_catn(yield, US" ", 1);
6470       break;
6471       }
6472
6473 #ifndef DISABLE_TLS
6474     case EITEM_CERTEXTRACT:
6475       {
6476       uschar * save_lookup_value = lookup_value, * sub[2];
6477       int save_expand_nmax =
6478         save_expand_strings(save_expand_nstring, save_expand_nlength);
6479
6480       /* Read the field argument */
6481       if (Uskip_whitespace(&s) != '{')                                  /*}*/
6482         {
6483         expand_string_message = US"missing '{' for field arg of certextract";
6484         goto EXPAND_FAILED_CURLY;                                       /*}*/
6485         }
6486       sub[0] = expand_string_internal(s+1,
6487                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6488       if (!sub[0])     goto EXPAND_FAILED;                              /*{{*/
6489       if (*s++ != '}')
6490         {
6491         expand_string_message = US"missing '}' closing field arg of certextract";
6492         goto EXPAND_FAILED_CURLY;
6493         }
6494       /* strip spaces fore & aft */
6495       {
6496       int len;
6497       uschar *p = sub[0];
6498
6499       Uskip_whitespace(&p);
6500       sub[0] = p;
6501
6502       len = Ustrlen(p);
6503       while (len > 0 && isspace(p[len-1])) len--;
6504       p[len] = 0;
6505       }
6506
6507       /* inspect the cert argument */
6508       if (Uskip_whitespace(&s) != '{')                                  /*}*/
6509         {
6510         expand_string_message = US"missing '{' for cert variable arg of certextract";
6511         goto EXPAND_FAILED_CURLY;                                       /*}*/
6512         }
6513       if (*++s != '$')
6514         {
6515         expand_string_message = US"second argument of \"certextract\" must "
6516           "be a certificate variable";
6517         goto EXPAND_FAILED;
6518         }
6519       sub[1] = expand_string_internal(s+1,
6520                 ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s, &resetok, NULL);
6521       if (!sub[1])     goto EXPAND_FAILED;                              /*{{*/
6522       if (*s++ != '}')
6523         {
6524         expand_string_message = US"missing '}' closing cert variable arg of certextract";
6525         goto EXPAND_FAILED_CURLY;
6526         }
6527
6528       if (flags & ESI_SKIPPING)
6529         lookup_value = NULL;
6530       else
6531         {
6532         lookup_value = expand_getcertele(sub[0], sub[1]);
6533         if (*expand_string_message) goto EXPAND_FAILED;
6534         }
6535       switch(process_yesno(
6536                flags,                           /* were previously skipping */
6537                lookup_value != NULL,            /* success/failure indicator */
6538                save_lookup_value,               /* value to reset for string2 */
6539                &s,                              /* input pointer */
6540                &yield,                          /* output pointer */
6541                US"certextract",                 /* condition type */
6542                &resetok))
6543         {
6544         case 1: goto EXPAND_FAILED;          /* when all is well, the */
6545         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
6546         }
6547
6548       restore_expand_strings(save_expand_nmax, save_expand_nstring,
6549         save_expand_nlength);
6550       if (flags & ESI_SKIPPING) continue;
6551       break;
6552       }
6553 #endif  /*DISABLE_TLS*/
6554
6555     /* Handle list operations */
6556
6557     case EITEM_FILTER:
6558     case EITEM_MAP:
6559     case EITEM_REDUCE:
6560       {
6561       int sep = 0, save_ptr = gstring_length(yield);
6562       uschar outsep[2] = { '\0', '\0' };
6563       const uschar *list, *expr, *temp;
6564       uschar * save_iterate_item = iterate_item;
6565       uschar * save_lookup_value = lookup_value;
6566
6567       Uskip_whitespace(&s);
6568       if (*s++ != '{')                                                  /*}*/
6569         {
6570         expand_string_message =
6571           string_sprintf("missing '{' for first arg of %s", name);
6572         goto EXPAND_FAILED_CURLY;                                       /*}*/
6573         }
6574
6575       DEBUG(D_expand) debug_printf_indent("%s: evaluate input list list\n", name);
6576       if (!(list = expand_string_internal(s,
6577               ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL)))
6578         goto EXPAND_FAILED;                                             /*{{*/
6579       if (*s++ != '}')
6580         {
6581         expand_string_message =
6582           string_sprintf("missing '}' closing first arg of %s", name);
6583         goto EXPAND_FAILED_CURLY;
6584         }
6585
6586       if (item_type == EITEM_REDUCE)
6587         {
6588         uschar * t;
6589         Uskip_whitespace(&s);
6590         if (*s++ != '{')                                                /*}*/
6591           {
6592           expand_string_message = US"missing '{' for second arg of reduce";
6593           goto EXPAND_FAILED_CURLY;                                     /*}*/
6594           }
6595         DEBUG(D_expand) debug_printf_indent("reduce: initial result list\n");
6596         t = expand_string_internal(s,
6597               ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6598         if (!t) goto EXPAND_FAILED;
6599         lookup_value = t;                                               /*{{*/
6600         if (*s++ != '}')
6601           {
6602           expand_string_message = US"missing '}' closing second arg of reduce";
6603           goto EXPAND_FAILED_CURLY;
6604           }
6605         }
6606
6607       Uskip_whitespace(&s);
6608       if (*s++ != '{')                                                  /*}*/
6609         {
6610         expand_string_message =
6611           string_sprintf("missing '{' for last arg of %s", name);       /*}*/
6612         goto EXPAND_FAILED_CURLY;
6613         }
6614
6615       expr = s;
6616
6617       /* For EITEM_FILTER, call eval_condition once, with result discarded (as
6618       if scanning a "false" part). This allows us to find the end of the
6619       condition, because if the list is empty, we won't actually evaluate the
6620       condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
6621       the normal internal expansion function. */
6622
6623       DEBUG(D_expand) debug_printf_indent("%s: find end of conditionn\n", name);
6624       if (item_type != EITEM_FILTER)
6625         temp = expand_string_internal(s,
6626           ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL);
6627       else
6628         if ((temp = eval_condition(expr, &resetok, NULL))) s = temp;
6629
6630       if (!temp)
6631         {
6632         expand_string_message = string_sprintf("%s inside \"%s\" item",
6633           expand_string_message, name);
6634         goto EXPAND_FAILED;
6635         }
6636
6637       Uskip_whitespace(&s);                                             /*{{{*/
6638       if (*s++ != '}')
6639         {
6640         expand_string_message = string_sprintf("missing } at end of condition "
6641           "or expression inside \"%s\"; could be an unquoted } in the content",
6642           name);
6643         goto EXPAND_FAILED;
6644         }
6645
6646       Uskip_whitespace(&s);                                             /*{{*/
6647       if (*s++ != '}')
6648         {
6649         expand_string_message = string_sprintf("missing } at end of \"%s\"",
6650           name);
6651         goto EXPAND_FAILED;
6652         }
6653
6654       /* If we are skipping, we can now just move on to the next item. When
6655       processing for real, we perform the iteration. */
6656
6657       if (flags & ESI_SKIPPING) continue;
6658       while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)))
6659         {
6660         *outsep = (uschar)sep;      /* Separator as a string */
6661
6662         DEBUG(D_expand) debug_printf_indent("%s: $item = '%s'  $value = '%s'\n",
6663                           name, iterate_item, lookup_value);
6664
6665         if (item_type == EITEM_FILTER)
6666           {
6667           BOOL condresult;
6668           /* the condition could modify $value, as a side-effect */
6669           uschar * save_value = lookup_value;
6670
6671           if (!eval_condition(expr, &resetok, &condresult))
6672             {
6673             iterate_item = save_iterate_item;
6674             lookup_value = save_lookup_value;
6675             expand_string_message = string_sprintf("%s inside \"%s\" condition",
6676               expand_string_message, name);
6677             goto EXPAND_FAILED;
6678             }
6679           lookup_value = save_value;
6680           DEBUG(D_expand) debug_printf_indent("%s: condition is %s\n", name,
6681             condresult? "true":"false");
6682           if (condresult)
6683             temp = iterate_item;    /* TRUE => include this item */
6684           else
6685             continue;               /* FALSE => skip this item */
6686           }
6687
6688         else                    /* EITEM_MAP and EITEM_REDUCE */
6689           {
6690           /* the expansion could modify $value, as a side-effect */
6691           uschar * t = expand_string_internal(expr,
6692             ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, NULL, &resetok, NULL);
6693           if (!(temp = t))
6694             {
6695             iterate_item = save_iterate_item;
6696             expand_string_message = string_sprintf("%s inside \"%s\" item",
6697               expand_string_message, name);
6698             goto EXPAND_FAILED;
6699             }
6700           if (item_type == EITEM_REDUCE)
6701             {
6702             lookup_value = t;         /* Update the value of $value */
6703             continue;                 /* and continue the iteration */
6704             }
6705           }
6706
6707         /* We reach here for FILTER if the condition is true, always for MAP,
6708         and never for REDUCE. The value in "temp" is to be added to the output
6709         list that is being created, ensuring that any occurrences of the
6710         separator character are doubled. Unless we are dealing with the first
6711         item of the output list, add in a space if the new item begins with the
6712         separator character, or is an empty string. */
6713
6714 /*XXX is there not a standard support function for this, appending to a list? */
6715 /* yes, string_append_listele(), but it depends on lack of text before the list */
6716
6717         if (  yield && yield->ptr != save_ptr
6718            && (temp[0] == *outsep || temp[0] == 0))
6719           yield = string_catn(yield, US" ", 1);
6720
6721         /* Add the string in "temp" to the output list that we are building,
6722         This is done in chunks by searching for the separator character. */
6723
6724         for (;;)
6725           {
6726           size_t seglen = Ustrcspn(temp, outsep);
6727
6728           yield = string_catn(yield, temp, seglen + 1);
6729
6730           /* If we got to the end of the string we output one character
6731           too many; backup and end the loop. Otherwise arrange to double the
6732           separator. */
6733
6734           if (!temp[seglen]) { yield->ptr--; break; }
6735           yield = string_catn(yield, outsep, 1);
6736           temp += seglen + 1;
6737           }
6738
6739         /* Output a separator after the string: we will remove the redundant
6740         final one at the end. */
6741
6742         yield = string_catn(yield, outsep, 1);
6743         }   /* End of iteration over the list loop */
6744
6745       /* REDUCE has generated no output above: output the final value of
6746       $value. */
6747
6748       if (item_type == EITEM_REDUCE)
6749         {
6750         yield = string_cat(yield, lookup_value);
6751         lookup_value = save_lookup_value;  /* Restore $value */
6752         }
6753
6754       /* FILTER and MAP generate lists: if they have generated anything, remove
6755       the redundant final separator. Even though an empty item at the end of a
6756       list does not count, this is tidier. */
6757
6758       else if (yield && yield->ptr != save_ptr) yield->ptr--;
6759
6760       /* Restore preserved $item */
6761
6762       iterate_item = save_iterate_item;
6763       if (flags & ESI_SKIPPING) continue;
6764       break;
6765       }
6766
6767     case EITEM_SORT:
6768       {
6769       int sep = 0, cond_type;
6770       const uschar * srclist, * cmp, * xtract;
6771       uschar * opname, * srcitem;
6772       const uschar * dstlist = NULL, * dstkeylist = NULL;
6773       uschar * tmp, * save_iterate_item = iterate_item;
6774
6775       Uskip_whitespace(&s);
6776       if (*s++ != '{')                                                  /*}*/
6777         {
6778         expand_string_message = US"missing '{' for list arg of sort";
6779         goto EXPAND_FAILED_CURLY;                                       /*}*/
6780         }
6781
6782       srclist = expand_string_internal(s,
6783               ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
6784       if (!srclist) goto EXPAND_FAILED;                                 /*{{*/
6785       if (*s++ != '}')
6786         {
6787         expand_string_message = US"missing '}' closing list arg of sort";
6788         goto EXPAND_FAILED_CURLY;
6789         }
6790
6791       Uskip_whitespace(&s);
6792       if (*s++ != '{')                                                  /*}*/
6793         {
6794         expand_string_message = US"missing '{' for comparator arg of sort";
6795         goto EXPAND_FAILED_CURLY;                                       /*}*/
6796         }
6797
6798       cmp = expand_string_internal(s,
6799               ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s, &resetok, NULL);
6800       if (!cmp) goto EXPAND_FAILED;                                     /*{{*/
6801       if (*s++ != '}')
6802         {
6803         expand_string_message = US"missing '}' closing comparator arg of sort";
6804         goto EXPAND_FAILED_CURLY;
6805         }
6806
6807       if ((cond_type = identify_operator(&cmp, &opname)) == -1)
6808         {
6809         if (!expand_string_message)
6810           expand_string_message = string_sprintf("unknown condition \"%s\"", s);
6811         goto EXPAND_FAILED;
6812         }
6813       switch(cond_type)
6814         {
6815         case ECOND_NUM_L: case ECOND_NUM_LE:
6816         case ECOND_NUM_G: case ECOND_NUM_GE:
6817         case ECOND_STR_GE: case ECOND_STR_GEI: case ECOND_STR_GT: case ECOND_STR_GTI:
6818         case ECOND_STR_LE: case ECOND_STR_LEI: case ECOND_STR_LT: case ECOND_STR_LTI:
6819           break;
6820
6821         default:
6822           expand_string_message = US"comparator not handled for sort";
6823           goto EXPAND_FAILED;
6824         }
6825
6826       Uskip_whitespace(&s);
6827       if (*s++ != '{')                                                  /*}*/
6828         {
6829         expand_string_message = US"missing '{' for extractor arg of sort";
6830         goto EXPAND_FAILED_CURLY;                                       /*}*/
6831         }
6832
6833       xtract = s;
6834       if (!(tmp = expand_string_internal(s,
6835         ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | ESI_SKIPPING, &s, &resetok, NULL)))
6836         goto EXPAND_FAILED;
6837       xtract = string_copyn(xtract, s - xtract);
6838                                                                         /*{{*/
6839       if (*s++ != '}')
6840         {
6841         expand_string_message = US"missing '}' closing extractor arg of sort";
6842         goto EXPAND_FAILED_CURLY;
6843         }
6844                                                                         /*{{*/
6845       if (*s++ != '}')
6846         {
6847         expand_string_message = US"missing } at end of \"sort\"";
6848         goto EXPAND_FAILED;
6849         }
6850
6851       if (flags & ESI_SKIPPING) continue;
6852
6853       while ((srcitem = string_nextinlist(&srclist, &sep, NULL, 0)))
6854         {
6855         uschar * srcfield, * dstitem;
6856         gstring * newlist = NULL, * newkeylist = NULL;
6857
6858         DEBUG(D_expand) debug_printf_indent("%s: $item = \"%s\"\n", name, srcitem);
6859
6860         /* extract field for comparisons */
6861         iterate_item = srcitem;
6862         if (  !(srcfield = expand_string_internal(xtract,
6863                                   ESI_HONOR_DOLLAR, NULL, &resetok, NULL))
6864            || !*srcfield)
6865           {
6866           expand_string_message = string_sprintf(
6867               "field-extract in sort: \"%s\"", xtract);
6868           goto EXPAND_FAILED;
6869           }
6870
6871         /* Insertion sort */
6872
6873         /* copy output list until new-item < list-item */
6874         while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6875           {
6876           uschar * dstfield;
6877
6878           /* field for comparison */
6879           if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6880             goto SORT_MISMATCH;
6881
6882           /* String-comparator names start with a letter; numeric names do not */
6883
6884           if (sortsbefore(cond_type, isalpha(opname[0]),
6885               srcfield, dstfield))
6886             {
6887             /* New-item sorts before this dst-item.  Append new-item,
6888             then dst-item, then remainder of dst list. */
6889
6890             newlist = string_append_listele(newlist, sep, srcitem);
6891             newkeylist = string_append_listele(newkeylist, sep, srcfield);
6892             srcitem = NULL;
6893
6894             newlist = string_append_listele(newlist, sep, dstitem);
6895             newkeylist = string_append_listele(newkeylist, sep, dstfield);
6896
6897 /*XXX why field-at-a-time copy?  Why not just dup the rest of the list? */
6898             while ((dstitem = string_nextinlist(&dstlist, &sep, NULL, 0)))
6899               {
6900               if (!(dstfield = string_nextinlist(&dstkeylist, &sep, NULL, 0)))
6901                 goto SORT_MISMATCH;
6902               newlist = string_append_listele(newlist, sep, dstitem);
6903               newkeylist = string_append_listele(newkeylist, sep, dstfield);
6904               }
6905
6906             break;
6907             }
6908
6909           newlist = string_append_listele(newlist, sep, dstitem);
6910           newkeylist = string_append_listele(newkeylist, sep, dstfield);
6911           }
6912
6913         /* If we ran out of dstlist without consuming srcitem, append it */
6914         if (srcitem)
6915           {
6916           newlist = string_append_listele(newlist, sep, srcitem);
6917           newkeylist = string_append_listele(newkeylist, sep, srcfield);
6918           }
6919
6920         dstlist = newlist->s;
6921         dstkeylist = newkeylist->s;
6922
6923         DEBUG(D_expand) debug_printf_indent("%s: dstlist = \"%s\"\n", name, dstlist);
6924         DEBUG(D_expand) debug_printf_indent("%s: dstkeylist = \"%s\"\n", name, dstkeylist);
6925         }
6926
6927       if (dstlist)
6928         yield = string_cat(yield, dstlist);
6929
6930       /* Restore preserved $item */
6931       iterate_item = save_iterate_item;
6932       break;
6933
6934       SORT_MISMATCH:
6935         expand_string_message = US"Internal error in sort (list mismatch)";
6936         goto EXPAND_FAILED;
6937       }
6938
6939
6940     /* If ${dlfunc } support is configured, handle calling dynamically-loaded
6941     functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
6942     or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
6943     a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
6944
6945     #define EXPAND_DLFUNC_MAX_ARGS 8
6946
6947     case EITEM_DLFUNC:
6948 #ifndef EXPAND_DLFUNC
6949       expand_string_message = US"\"${dlfunc\" encountered, but this facility "  /*}*/
6950         "is not included in this binary";
6951       goto EXPAND_FAILED;
6952
6953 #else   /* EXPAND_DLFUNC */
6954       {
6955       tree_node * t;
6956       exim_dlfunc_t * func;
6957       uschar * result;
6958       int status, argc;
6959       uschar * argv[EXPAND_DLFUNC_MAX_ARGS + 3];
6960
6961       if (expand_forbid & RDO_DLFUNC)
6962         {
6963         expand_string_message =
6964           US"dynamically-loaded functions are not permitted";
6965         goto EXPAND_FAILED;
6966         }
6967
6968       switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, flags,
6969            TRUE, name, &resetok, NULL))
6970         {
6971         case -1: continue;      /* skipping */
6972         case 1: goto EXPAND_FAILED_CURLY;
6973         case 2:
6974         case 3: goto EXPAND_FAILED;
6975         }
6976
6977       /* Look up the dynamically loaded object handle in the tree. If it isn't
6978       found, dlopen() the file and put the handle in the tree for next time. */
6979
6980       if (!(t = tree_search(dlobj_anchor, argv[0])))
6981         {
6982         void * handle = dlopen(CS argv[0], RTLD_LAZY);
6983         if (!handle)
6984           {
6985           expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
6986             argv[0], dlerror());
6987           log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
6988           goto EXPAND_FAILED;
6989           }
6990         t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]), argv[0]);
6991         Ustrcpy(t->name, argv[0]);
6992         t->data.ptr = handle;
6993         (void)tree_insertnode(&dlobj_anchor, t);
6994         }
6995
6996       /* Having obtained the dynamically loaded object handle, look up the
6997       function pointer. */
6998
6999       if (!(func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1])))
7000         {
7001         expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
7002           "%s", argv[1], argv[0], dlerror());
7003         log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
7004         goto EXPAND_FAILED;
7005         }
7006
7007       /* Call the function and work out what to do with the result. If it
7008       returns OK, we have a replacement string; if it returns DEFER then
7009       expansion has failed in a non-forced manner; if it returns FAIL then
7010       failure was forced; if it returns ERROR or any other value there's a
7011       problem, so panic slightly. In any case, assume that the function has
7012       side-effects on the store that must be preserved. */
7013
7014       resetok = FALSE;
7015       result = NULL;
7016       for (argc = 0; argv[argc]; argc++) ;
7017
7018       if ((status = func(&result, argc - 2, &argv[2])) != OK)
7019         {
7020         expand_string_message = result ? result : US"(no message)";
7021         if (status == FAIL_FORCED)
7022           f.expand_string_forcedfail = TRUE;
7023         else if (status != FAIL)
7024           log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
7025               argv[0], argv[1], status, expand_string_message);
7026         goto EXPAND_FAILED;
7027         }
7028
7029       if (result) yield = string_cat(yield, result);
7030       break;
7031       }
7032 #endif /* EXPAND_DLFUNC */
7033
7034     case EITEM_ENV:     /* ${env {name} {val_if_found} {val_if_unfound}} */
7035       {
7036       uschar * key;
7037       uschar *save_lookup_value = lookup_value;
7038
7039       if (Uskip_whitespace(&s) != '{')                                  /*}*/
7040         goto EXPAND_FAILED;
7041
7042       key = expand_string_internal(s+1,
7043               ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
7044       if (!key) goto EXPAND_FAILED;                                     /*{{*/
7045       if (*s++ != '}')
7046         {
7047         expand_string_message = US"missing '}' for name arg of env";
7048         goto EXPAND_FAILED_CURLY;
7049         }
7050
7051       lookup_value = US getenv(CS key);
7052
7053       switch(process_yesno(
7054                flags,                           /* were previously skipping */
7055                lookup_value != NULL,            /* success/failure indicator */
7056                save_lookup_value,               /* value to reset for string2 */
7057                &s,                              /* input pointer */
7058                &yield,                          /* output pointer */
7059                US"env",                         /* condition type */
7060                &resetok))
7061         {
7062         case 1: goto EXPAND_FAILED;          /* when all is well, the */
7063         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
7064         }
7065       if (flags & ESI_SKIPPING) continue;
7066       break;
7067       }
7068
7069 #ifdef SUPPORT_SRS
7070     case EITEM_SRS_ENCODE:
7071       /* ${srs_encode {secret} {return_path} {orig_domain}} */
7072       {
7073       uschar * sub[3];
7074       uschar cksum[4];
7075       gstring * g = NULL;
7076       BOOL quoted = FALSE;
7077
7078       switch (read_subs(sub, 3, 3, CUSS &s, flags, TRUE, name, &resetok, NULL))
7079         {
7080         case -1: continue;      /* skipping */
7081         case 1: goto EXPAND_FAILED_CURLY;
7082         case 2:
7083         case 3: goto EXPAND_FAILED;
7084         }
7085       if (flags & ESI_SKIPPING) continue;
7086
7087       if (sub[1] && *(sub[1]))
7088         {
7089         g = string_catn(g, US"SRS0=", 5);
7090
7091         /* ${l_4:${hmac{md5}{SRS_SECRET}{${lc:$return_path}}}}= */
7092         hmac_md5(sub[0], string_copylc(sub[1]), cksum, sizeof(cksum));
7093         g = string_catn(g, cksum, sizeof(cksum));
7094         g = string_catn(g, US"=", 1);
7095
7096         /* ${base32:${eval:$tod_epoch/86400&0x3ff}}= */
7097           {
7098           struct timeval now;
7099           unsigned long i;
7100
7101           gettimeofday(&now, NULL);
7102           i = (now.tv_sec / 86400) & 0x3ff;
7103           g = string_catn(g, &base32_chars[i >> 5], 1);
7104           g = string_catn(g, &base32_chars[i & 0x1f], 1);
7105           }
7106         g = string_catn(g, US"=", 1);
7107
7108         /* ${domain:$return_path}=${local_part:$return_path} */
7109           {
7110           int start, end, domain;
7111           uschar * t = parse_extract_address(sub[1], &expand_string_message,
7112                                             &start, &end, &domain, FALSE);
7113           uschar * s;
7114
7115           if (!t)
7116             goto EXPAND_FAILED;
7117
7118           if (domain > 0) g = string_cat(g, t + domain);
7119           g = string_catn(g, US"=", 1);
7120
7121           s = domain > 0 ? string_copyn(t, domain - 1) : t;
7122           if ((quoted = Ustrchr(s, '"') != NULL))
7123             {
7124             gstring * h = NULL;
7125             DEBUG(D_expand) debug_printf_indent("auto-quoting local part\n");
7126             while (*s)          /* de-quote */
7127               {
7128               while (*s && *s != '"') h = string_catn(h, s++, 1);
7129               if (*s) s++;
7130               while (*s && *s != '"') h = string_catn(h, s++, 1);
7131               if (*s) s++;
7132               }
7133             gstring_release_unused(h);
7134             s = string_from_gstring(h);
7135             }
7136           g = string_cat(g, s);
7137           }
7138
7139         /* Assume that if the original local_part had quotes
7140         it was for good reason */
7141
7142         if (quoted) yield = string_catn(yield, US"\"", 1);
7143         yield = gstring_append(yield, g);
7144         if (quoted) yield = string_catn(yield, US"\"", 1);
7145
7146         /* @$original_domain */
7147         yield = string_catn(yield, US"@", 1);
7148         yield = string_cat(yield, sub[2]);
7149         }
7150       else
7151         DEBUG(D_expand) debug_printf_indent("null return_path for srs-encode\n");
7152
7153       break;
7154       }
7155 #endif /*SUPPORT_SRS*/
7156
7157     default:
7158       goto NOT_ITEM;
7159     }   /* EITEM_* switch */
7160     /*NOTREACHED*/
7161
7162   DEBUG(D_expand)               /* only if not the sole expansion of the line */
7163     if (yield && (expansion_start > 0 || *s))
7164       debug_expansion_interim(US"item-res",
7165           yield->s + expansion_start, yield->ptr - expansion_start,
7166           !!(flags & ESI_SKIPPING));
7167   continue;
7168
7169 NOT_ITEM: ;
7170   }
7171
7172   /* Control reaches here if the name is not recognized as one of the more
7173   complicated expansion items. Check for the "operator" syntax (name terminated
7174   by a colon). Some of the operators have arguments, separated by _ from the
7175   name. */
7176
7177   if (*s == ':')
7178     {
7179     int c;
7180     uschar * arg = NULL, * sub;
7181 #ifndef DISABLE_TLS
7182     var_entry * vp = NULL;
7183 #endif
7184
7185     /* Owing to an historical mis-design, an underscore may be part of the
7186     operator name, or it may introduce arguments.  We therefore first scan the
7187     table of names that contain underscores. If there is no match, we cut off
7188     the arguments and then scan the main table. */
7189
7190     if ((c = chop_match(name, op_table_underscore,
7191                         nelem(op_table_underscore))) < 0)
7192       {
7193       if ((arg = Ustrchr(name, '_')))
7194         *arg = 0;
7195       if ((c = chop_match(name, op_table_main, nelem(op_table_main))) >= 0)
7196         c += nelem(op_table_underscore);
7197       if (arg) *arg++ = '_';            /* Put back for error messages */
7198       }
7199
7200     /* Deal specially with operators that might take a certificate variable
7201     as we do not want to do the usual expansion. For most, expand the string.*/
7202
7203     switch(c)
7204       {
7205 #ifndef DISABLE_TLS
7206       case EOP_MD5:
7207       case EOP_SHA1:
7208       case EOP_SHA256:
7209       case EOP_BASE64:
7210         if (s[1] == '$')
7211           {
7212           const uschar * s1 = s;
7213           sub = expand_string_internal(s+2,
7214               ESI_BRACE_ENDS | flags & ESI_SKIPPING, &s1, &resetok, NULL);
7215           if (!sub)       goto EXPAND_FAILED;           /*{*/
7216           if (*s1 != '}')
7217             {                                           /*{*/
7218             expand_string_message =
7219               string_sprintf("missing '}' closing cert arg of %s", name);
7220             goto EXPAND_FAILED_CURLY;
7221             }
7222           if ((vp = find_var_ent(sub)) && vp->type == vtype_cert)
7223             {
7224             s = s1+1;
7225             break;
7226             }
7227           vp = NULL;
7228           }
7229         /*FALLTHROUGH*/
7230 #endif
7231       default:
7232         sub = expand_string_internal(s+1,
7233                 ESI_BRACE_ENDS | ESI_HONOR_DOLLAR | flags, &s, &resetok, NULL);
7234         if (!sub) goto EXPAND_FAILED;
7235         s++;
7236         break;
7237       }
7238
7239     /* If we are skipping, we don't need to perform the operation at all.
7240     This matters for operations like "mask", because the data may not be
7241     in the correct format when skipping. For example, the expression may test
7242     for the existence of $sender_host_address before trying to mask it. For
7243     other operations, doing them may not fail, but it is a waste of time. */
7244
7245     if (flags & ESI_SKIPPING && c >= 0) continue;
7246
7247     /* Otherwise, switch on the operator type.  After handling go back
7248     to the main loop top. */
7249
7250      {
7251      unsigned expansion_start = gstring_length(yield);
7252      switch(c)
7253       {
7254       case EOP_BASE32:
7255         {
7256         uschar * t;
7257         unsigned long int n = Ustrtoul(sub, &t, 10);
7258         gstring * g = NULL;
7259
7260         if (*t)
7261           {
7262           expand_string_message = string_sprintf("argument for base32 "
7263             "operator is \"%s\", which is not a decimal number", sub);
7264           goto EXPAND_FAILED;
7265           }
7266         for ( ; n; n >>= 5)
7267           g = string_catn(g, &base32_chars[n & 0x1f], 1);
7268
7269         if (g) while (g->ptr > 0) yield = string_catn(yield, &g->s[--g->ptr], 1);
7270         break;
7271         }
7272
7273       case EOP_BASE32D:
7274         {
7275         uschar *tt = sub;
7276         unsigned long int n = 0;
7277         while (*tt)
7278           {
7279           uschar * t = Ustrchr(base32_chars, *tt++);
7280           if (!t)
7281             {
7282             expand_string_message = string_sprintf("argument for base32d "
7283               "operator is \"%s\", which is not a base 32 number", sub);
7284             goto EXPAND_FAILED;
7285             }
7286           n = n * 32 + (t - base32_chars);
7287           }
7288         yield = string_fmt_append(yield, "%ld", n);
7289         break;
7290         }
7291
7292       case EOP_BASE62:
7293         {
7294         uschar *t;
7295         unsigned long int n = Ustrtoul(sub, &t, 10);
7296         if (*t)
7297           {
7298           expand_string_message = string_sprintf("argument for base62 "
7299             "operator is \"%s\", which is not a decimal number", sub);
7300           goto EXPAND_FAILED;
7301           }
7302         yield = string_cat(yield, string_base62_32(n));         /*XXX only handles 32b input range.  Need variants? */
7303         break;
7304         }
7305
7306       /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
7307
7308       case EOP_BASE62D:
7309         {
7310         uschar *tt = sub;
7311         unsigned long int n = 0;
7312         while (*tt)
7313           {
7314           uschar *t = Ustrchr(base62_chars, *tt++);
7315           if (!t)
7316             {
7317             expand_string_message = string_sprintf("argument for base62d "
7318               "operator is \"%s\", which is not a base %d number", sub,
7319               BASE_62);
7320             goto EXPAND_FAILED;
7321             }
7322           n = n * BASE_62 + (t - base62_chars);
7323           }
7324         yield = string_fmt_append(yield, "%ld", n);
7325         break;
7326         }
7327
7328       case EOP_EXPAND:
7329         {
7330         uschar *expanded = expand_string_internal(sub,
7331                 ESI_HONOR_DOLLAR | flags & ESI_SKIPPING, NULL, &resetok, NULL);
7332         if (!expanded)
7333           {
7334           expand_string_message =
7335             string_sprintf("internal expansion of \"%s\" failed: %s", sub,
7336               expand_string_message);
7337           goto EXPAND_FAILED;
7338           }
7339         yield = string_cat(yield, expanded);
7340         break;
7341         }
7342
7343       case EOP_LC:
7344         {
7345         int count = 0;
7346         uschar *t = sub - 1;
7347         while (*(++t) != 0) { *t = tolower(*t); count++; }
7348         yield = string_catn(yield, sub, count);
7349         break;
7350         }
7351
7352       case EOP_UC:
7353         {
7354         int count = 0;
7355         uschar *t = sub - 1;
7356         while (*(++t) != 0) { *t = toupper(*t); count++; }
7357         yield = string_catn(yield, sub, count);
7358         break;
7359         }
7360
7361       case EOP_MD5:
7362 #ifndef DISABLE_TLS
7363         if (vp && *(void **)vp->value)
7364           {
7365           uschar * cp = tls_cert_fprt_md5(*(void **)vp->value);
7366           yield = string_cat(yield, cp);
7367           }
7368         else
7369 #endif
7370           {
7371           md5 base;
7372           uschar digest[16];
7373           md5_start(&base);
7374           md5_end(&base, sub, Ustrlen(sub), digest);
7375           for (int j = 0; j < 16; j++)
7376             yield = string_fmt_append(yield, "%02x", digest[j]);
7377           }
7378         break;
7379
7380       case EOP_SHA1:
7381 #ifndef DISABLE_TLS
7382         if (vp && *(void **)vp->value)
7383           {
7384           uschar * cp = tls_cert_fprt_sha1(*(void **)vp->value);
7385           yield = string_cat(yield, cp);
7386           }
7387         else
7388 #endif
7389           {
7390           hctx h;
7391           uschar digest[20];
7392           sha1_start(&h);
7393           sha1_end(&h, sub, Ustrlen(sub), digest);
7394           for (int j = 0; j < 20; j++)
7395             yield = string_fmt_append(yield, "%02X", digest[j]);
7396           }
7397         break;
7398
7399       case EOP_SHA2:
7400       case EOP_SHA256:
7401 #ifdef EXIM_HAVE_SHA2
7402         if (vp && *(void **)vp->value)
7403           if (c == EOP_SHA256)
7404             yield = string_cat(yield, tls_cert_fprt_sha256(*(void **)vp->value));
7405           else
7406             expand_string_message = US"sha2_N not supported with certificates";
7407         else
7408           {
7409           hctx h;
7410           blob b;
7411           hashmethod m = !arg ? HASH_SHA2_256
7412             : Ustrcmp(arg, "256") == 0 ? HASH_SHA2_256
7413             : Ustrcmp(arg, "384") == 0 ? HASH_SHA2_384
7414             : Ustrcmp(arg, "512") == 0 ? HASH_SHA2_512
7415             : HASH_BADTYPE;
7416
7417           if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7418             {
7419             expand_string_message = US"unrecognised sha2 variant";
7420             goto EXPAND_FAILED;
7421             }
7422
7423           exim_sha_update_string(&h, sub);
7424           exim_sha_finish(&h, &b);
7425           while (b.len-- > 0)
7426             yield = string_fmt_append(yield, "%02X", *b.data++);
7427           }
7428 #else
7429           expand_string_message = US"sha256 only supported with TLS";
7430 #endif
7431         break;
7432
7433       case EOP_SHA3:
7434 #ifdef EXIM_HAVE_SHA3
7435         {
7436         hctx h;
7437         blob b;
7438         hashmethod m = !arg ? HASH_SHA3_256
7439           : Ustrcmp(arg, "224") == 0 ? HASH_SHA3_224
7440           : Ustrcmp(arg, "256") == 0 ? HASH_SHA3_256
7441           : Ustrcmp(arg, "384") == 0 ? HASH_SHA3_384
7442           : Ustrcmp(arg, "512") == 0 ? HASH_SHA3_512
7443           : HASH_BADTYPE;
7444
7445         if (m == HASH_BADTYPE || !exim_sha_init(&h, m))
7446           {
7447           expand_string_message = US"unrecognised sha3 variant";
7448           goto EXPAND_FAILED;
7449           }
7450
7451         exim_sha_update_string(&h, sub);
7452         exim_sha_finish(&h, &b);
7453         while (b.len-- > 0)
7454           yield = string_fmt_append(yield, "%02X", *b.data++);
7455         }
7456         break;
7457 #else
7458         expand_string_message = US"sha3 only supported with GnuTLS 3.5.0 + or OpenSSL 1.1.1 +";
7459         goto EXPAND_FAILED;
7460 #endif
7461
7462       /* Line-wrap a string as if it is a header line */
7463
7464       case EOP_HEADERWRAP:
7465         {
7466         unsigned col = 80, lim = 998;
7467         uschar * s;
7468
7469         if (arg)
7470           {
7471           const uschar * list = arg;
7472           int sep = '_';
7473           if ((s = string_nextinlist(&list, &sep, NULL, 0)))
7474             {
7475             col = atoi(CS s);
7476             if ((s = string_nextinlist(&list, &sep, NULL, 0)))
7477               lim = atoi(CS s);
7478             }
7479           }
7480           if ((s =  wrap_header(sub, col, lim, US"\t", 8)))
7481             yield = string_cat(yield, s);
7482         }
7483         break;
7484
7485       /* Convert hex encoding to base64 encoding */
7486
7487       case EOP_HEX2B64:
7488         {
7489         int c = 0;
7490         int b = -1;
7491         uschar *in = sub;
7492         uschar *out = sub;
7493         uschar *enc;
7494
7495         for (enc = sub; *enc; enc++)
7496           {
7497           if (!isxdigit(*enc))
7498             {
7499             expand_string_message = string_sprintf("\"%s\" is not a hex "
7500               "string", sub);
7501             goto EXPAND_FAILED;
7502             }
7503           c++;
7504           }
7505
7506         if ((c & 1) != 0)
7507           {
7508           expand_string_message = string_sprintf("\"%s\" contains an odd "
7509             "number of characters", sub);
7510           goto EXPAND_FAILED;
7511           }
7512
7513         while ((c = *in++) != 0)
7514           {
7515           if (isdigit(c)) c -= '0';
7516           else c = toupper(c) - 'A' + 10;
7517           if (b == -1)
7518             b = c << 4;
7519           else
7520             {
7521             *out++ = b | c;
7522             b = -1;
7523             }
7524           }
7525
7526         enc = b64encode(CUS sub, out - sub);
7527         yield = string_cat(yield, enc);
7528         break;
7529         }
7530
7531       /* Convert octets outside 0x21..0x7E to \xXX form */
7532
7533       case EOP_HEXQUOTE:
7534         {
7535         uschar *t = sub - 1;
7536         while (*(++t) != 0)
7537           {
7538           if (*t < 0x21 || 0x7E < *t)
7539             yield = string_fmt_append(yield, "\\x%02x", *t);
7540           else
7541             yield = string_catn(yield, t, 1);
7542           }
7543         break;
7544         }
7545
7546       /* count the number of list elements */
7547
7548       case EOP_LISTCOUNT:
7549         {
7550         int cnt = 0, sep = 0;
7551         uschar * buf = store_get(2, sub);
7552
7553         while (string_nextinlist(CUSS &sub, &sep, buf, 1)) cnt++;
7554         yield = string_fmt_append(yield, "%d", cnt);
7555         break;
7556         }
7557
7558       /* expand a named list given the name */
7559       /* handles nested named lists; requotes as colon-sep list */
7560
7561       case EOP_LISTNAMED:
7562         expand_string_message = NULL;
7563         yield = expand_listnamed(yield, sub, arg);
7564         if (expand_string_message)
7565           goto EXPAND_FAILED;
7566         break;
7567
7568       /* quote a list-item for the given list-separator */
7569
7570       /* mask applies a mask to an IP address; for example the result of
7571       ${mask:131.111.10.206/28} is 131.111.10.192/28. */
7572
7573       case EOP_MASK:
7574         {
7575         int count;
7576         uschar *endptr;
7577         int binary[4];
7578         int type, mask, maskoffset;
7579         BOOL normalised;
7580         uschar buffer[64];
7581
7582         if ((type = string_is_ip_address(sub, &maskoffset)) == 0)
7583           {
7584           expand_string_message = string_sprintf("\"%s\" is not an IP address",
7585            sub);
7586           goto EXPAND_FAILED;
7587           }
7588
7589         if (maskoffset == 0)
7590           {
7591           expand_string_message = string_sprintf("missing mask value in \"%s\"",
7592             sub);
7593           goto EXPAND_FAILED;
7594           }
7595
7596         mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
7597
7598         if (*endptr || mask < 0 || mask > (type == 4 ? 32 : 128))
7599           {
7600           expand_string_message = string_sprintf("mask value too big in \"%s\"",
7601             sub);
7602           goto EXPAND_FAILED;
7603           }
7604
7605         /* If an optional 'n' was given, ipv6 gets normalised output:
7606         colons rather than dots, and zero-compressed. */
7607
7608         normalised = arg && *arg == 'n';
7609
7610         /* Convert the address to binary integer(s) and apply the mask */
7611
7612         sub[maskoffset] = 0;
7613         count = host_aton(sub, binary);
7614         host_mask(count, binary, mask);
7615
7616         /* Convert to masked textual format and add to output. */
7617
7618         if (type == 4 || !normalised)
7619           yield = string_catn(yield, buffer,
7620             host_nmtoa(count, binary, mask, buffer, '.'));
7621         else
7622           {
7623           ipv6_nmtoa(binary, buffer);
7624           yield = string_fmt_append(yield, "%s/%d", buffer, mask);
7625           }
7626         break;
7627         }
7628
7629       case EOP_IPV6NORM:
7630       case EOP_IPV6DENORM:
7631         {
7632         int type = string_is_ip_address(sub, NULL);
7633         int binary[4];
7634         uschar buffer[44];
7635
7636         switch (type)
7637           {
7638           case 6:
7639             (void) host_aton(sub, binary);
7640             break;
7641
7642           case 4:       /* convert to IPv4-mapped IPv6 */
7643             binary[0] = binary[1] = 0;
7644             binary[2] = 0x0000ffff;
7645             (void) host_aton(sub, binary+3);
7646             break;
7647
7648           case 0:
7649             expand_string_message =
7650               string_sprintf("\"%s\" is not an IP address", sub);
7651             goto EXPAND_FAILED;
7652           }
7653
7654         yield = string_catn(yield, buffer, c == EOP_IPV6NORM
7655                     ? ipv6_nmtoa(binary, buffer)
7656                     : host_nmtoa(4, binary, -1, buffer, ':')
7657                   );
7658         break;
7659         }
7660
7661       case EOP_ADDRESS:
7662       case EOP_LOCAL_PART:
7663       case EOP_DOMAIN:
7664         {
7665         uschar * error;
7666         int start, end, domain;
7667         uschar * t = parse_extract_address(sub, &error, &start, &end, &domain,
7668           FALSE);
7669         if (t)
7670           if (c != EOP_DOMAIN)
7671             yield = c == EOP_LOCAL_PART && domain > 0
7672               ? string_catn(yield, t, domain - 1)
7673               : string_cat(yield, t);
7674           else if (domain > 0)
7675             yield = string_cat(yield, t + domain);
7676         break;
7677         }
7678
7679       case EOP_ADDRESSES:
7680         {
7681         uschar outsep[2] = { ':', '\0' };
7682         uschar *address, *error;
7683         int save_ptr = gstring_length(yield);
7684         int start, end, domain;  /* Not really used */
7685
7686         if (Uskip_whitespace(&sub) == '>')
7687           if (*outsep = *++sub) ++sub;
7688           else
7689             {
7690             expand_string_message = string_sprintf("output separator "
7691               "missing in expanding ${addresses:%s}", --sub);
7692             goto EXPAND_FAILED;
7693             }
7694         f.parse_allow_group = TRUE;
7695
7696         for (;;)
7697           {
7698           uschar * p = parse_find_address_end(sub, FALSE);
7699           uschar saveend = *p;
7700           *p = '\0';
7701           address = parse_extract_address(sub, &error, &start, &end, &domain,
7702             FALSE);
7703           *p = saveend;
7704
7705           /* Add the address to the output list that we are building. This is
7706           done in chunks by searching for the separator character. At the
7707           start, unless we are dealing with the first address of the output
7708           list, add in a space if the new address begins with the separator
7709           character, or is an empty string. */
7710
7711           if (address)
7712             {
7713             if (yield && yield->ptr != save_ptr && address[0] == *outsep)
7714               yield = string_catn(yield, US" ", 1);
7715
7716             for (;;)
7717               {
7718               size_t seglen = Ustrcspn(address, outsep);
7719               yield = string_catn(yield, address, seglen + 1);
7720
7721               /* If we got to the end of the string we output one character
7722               too many. */
7723
7724               if (address[seglen] == '\0') { yield->ptr--; break; }
7725               yield = string_catn(yield, outsep, 1);
7726               address += seglen + 1;
7727               }
7728
7729             /* Output a separator after the string: we will remove the
7730             redundant final one at the end. */
7731
7732             yield = string_catn(yield, outsep, 1);
7733             }
7734
7735           if (saveend == '\0') break;
7736           sub = p + 1;
7737           }
7738
7739         /* If we have generated anything, remove the redundant final
7740         separator. */
7741
7742         if (yield && yield->ptr != save_ptr) yield->ptr--;
7743         f.parse_allow_group = FALSE;
7744         break;
7745         }
7746
7747
7748       /* quote puts a string in quotes if it is empty or contains anything
7749       other than alphamerics, underscore, dot, or hyphen.
7750
7751       quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
7752       be quoted in order to be a valid local part.
7753
7754       In both cases, newlines and carriage returns are converted into \n and \r
7755       respectively */
7756
7757       case EOP_QUOTE:
7758       case EOP_QUOTE_LOCAL_PART:
7759         if (!arg)
7760           {
7761           BOOL needs_quote = (!*sub);      /* TRUE for empty string */
7762           uschar *t = sub - 1;
7763
7764           if (c == EOP_QUOTE)
7765             while (!needs_quote && *++t)
7766               needs_quote = !isalnum(*t) && !strchr("_-.", *t);
7767
7768           else  /* EOP_QUOTE_LOCAL_PART */
7769             while (!needs_quote && *++t)
7770               needs_quote = !isalnum(*t)
7771                 && strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL
7772                 && (*t != '.' || t == sub || !t[1]);
7773
7774           if (needs_quote)
7775             {
7776             yield = string_catn(yield, US"\"", 1);
7777             t = sub - 1;
7778             while (*++t)
7779               if (*t == '\n')
7780                 yield = string_catn(yield, US"\\n", 2);
7781               else if (*t == '\r')
7782                 yield = string_catn(yield, US"\\r", 2);
7783               else
7784                 {
7785                 if (*t == '\\' || *t == '"')
7786                   yield = string_catn(yield, US"\\", 1);
7787                 yield = string_catn(yield, t, 1);
7788                 }
7789             yield = string_catn(yield, US"\"", 1);
7790             }
7791           else
7792             yield = string_cat(yield, sub);
7793           break;
7794           }
7795
7796         /* quote_lookuptype does lookup-specific quoting */
7797
7798         else
7799           {
7800           int n;
7801           uschar * opt = Ustrchr(arg, '_');
7802
7803           if (opt) *opt++ = 0;
7804
7805           if ((n = search_findtype(arg, Ustrlen(arg))) < 0)
7806             {
7807             expand_string_message = search_error_message;
7808             goto EXPAND_FAILED;
7809             }
7810
7811           if (lookup_list[n]->quote)
7812             sub = (lookup_list[n]->quote)(sub, opt, (unsigned)n);
7813           else if (opt)
7814             sub = NULL;
7815
7816           if (!sub)
7817             {
7818             expand_string_message = string_sprintf(
7819               "\"%s\" unrecognized after \"${quote_%s\"",       /*}*/
7820               opt, arg);
7821             goto EXPAND_FAILED;
7822             }
7823
7824           yield = string_cat(yield, sub);
7825           break;
7826           }
7827
7828         /* rx quote sticks in \ before any non-alphameric character so that
7829         the insertion works in a regular expression. */
7830
7831         case EOP_RXQUOTE:
7832           {
7833           uschar *t = sub - 1;
7834           while (*(++t) != 0)
7835             {
7836             if (!isalnum(*t))
7837               yield = string_catn(yield, US"\\", 1);
7838             yield = string_catn(yield, t, 1);
7839             }
7840           break;
7841           }
7842
7843         /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
7844         prescribed by the RFC, if there are characters that need to be encoded */
7845
7846         case EOP_RFC2047:
7847           yield = string_cat(yield,
7848                               parse_quote_2047(sub, Ustrlen(sub), headers_charset,
7849                                 FALSE));
7850           break;
7851
7852         /* RFC 2047 decode */
7853
7854         case EOP_RFC2047D:
7855           {
7856           int len;
7857           uschar *error;
7858           uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
7859             headers_charset, '?', &len, &error);
7860           if (error)
7861             {
7862             expand_string_message = error;
7863             goto EXPAND_FAILED;
7864             }
7865           yield = string_catn(yield, decoded, len);
7866           break;
7867           }
7868
7869         /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
7870         underscores */
7871
7872         case EOP_FROM_UTF8:
7873           {
7874           uschar * buff = store_get(4, sub);
7875           while (*sub)
7876             {
7877             int c;
7878             GETUTF8INC(c, sub);
7879             if (c > 255) c = '_';
7880             buff[0] = c;
7881             yield = string_catn(yield, buff, 1);
7882             }
7883           break;
7884           }
7885
7886         /* replace illegal UTF-8 sequences by replacement character  */
7887
7888         #define UTF8_REPLACEMENT_CHAR US"?"
7889
7890         case EOP_UTF8CLEAN:
7891           {
7892           int seq_len = 0, index = 0, bytes_left = 0, complete;
7893           u_long codepoint = (u_long)-1;
7894           uschar seq_buff[4];                   /* accumulate utf-8 here */
7895
7896           /* Manually track tainting, as we deal in individual chars below */
7897
7898           if (!yield)
7899             yield = string_get_tainted(Ustrlen(sub), sub);
7900           else if (!yield->s || !yield->ptr)
7901             {
7902             yield->s = store_get(yield->size = Ustrlen(sub), sub);
7903             gstring_reset(yield);
7904             }
7905           else if (is_incompatible(yield->s, sub))
7906             gstring_rebuffer(yield, sub);
7907
7908           /* Check the UTF-8, byte-by-byte */
7909
7910           while (*sub)
7911             {
7912             complete = 0;
7913             uschar c = *sub++;
7914
7915             if (bytes_left)
7916               {
7917               if ((c & 0xc0) != 0x80)
7918                       /* wrong continuation byte; invalidate all bytes */
7919                 complete = 1; /* error */
7920               else
7921                 {
7922                 codepoint = (codepoint << 6) | (c & 0x3f);
7923                 seq_buff[index++] = c;
7924                 if (--bytes_left == 0)          /* codepoint complete */
7925                   if(codepoint > 0x10FFFF)      /* is it too large? */
7926                     complete = -1;      /* error (RFC3629 limit) */
7927                   else if ( (codepoint & 0x1FF800 ) == 0xD800 ) /* surrogate */
7928                     /* A UTF-16 surrogate (which should be one of a pair that
7929                     encode a Unicode codepoint that is outside the Basic
7930                     Multilingual Plane).  Error, not UTF8.
7931                     RFC2279.2 is slightly unclear on this, but
7932                     https://unicodebook.readthedocs.io/issues.html#strict-utf8-decoder
7933                     says "Surrogates characters are also invalid in UTF-8:
7934                     characters in U+D800—U+DFFF have to be rejected." */
7935                     complete = -1;
7936                   else
7937                     {           /* finished; output utf-8 sequence */
7938                     yield = string_catn(yield, seq_buff, seq_len);
7939                     index = 0;
7940                     }
7941                 }
7942               }
7943             else        /* no bytes left: new sequence */
7944               {
7945               if (!(c & 0x80))  /* 1-byte sequence, US-ASCII, keep it */
7946                 {
7947                 yield = string_catn(yield, &c, 1);
7948                 continue;
7949                 }
7950               if ((c & 0xe0) == 0xc0)           /* 2-byte sequence */
7951                 if (c == 0xc0 || c == 0xc1)     /* 0xc0 and 0xc1 are illegal */
7952                   complete = -1;
7953                 else
7954                   {
7955                   bytes_left = 1;
7956                   codepoint = c & 0x1f;
7957                   }
7958               else if ((c & 0xf0) == 0xe0)              /* 3-byte sequence */
7959                 {
7960                 bytes_left = 2;
7961                 codepoint = c & 0x0f;
7962                 }
7963               else if ((c & 0xf8) == 0xf0)              /* 4-byte sequence */
7964                 {
7965                 bytes_left = 3;
7966                 codepoint = c & 0x07;
7967                 }
7968               else      /* invalid or too long (RFC3629 allows only 4 bytes) */
7969                 complete = -1;
7970
7971               seq_buff[index++] = c;
7972               seq_len = bytes_left + 1;
7973               }         /* if(bytes_left) */
7974
7975             if (complete != 0)
7976               {
7977               bytes_left = index = 0;
7978               yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7979               }
7980             if ((complete == 1) && ((c & 0x80) == 0))
7981                           /* ASCII character follows incomplete sequence */
7982                 yield = string_catn(yield, &c, 1);
7983             }
7984           /* If given a sequence truncated mid-character, we also want to report ?
7985           Eg, ${length_1:フィル} is one byte, not one character, so we expect
7986           ${utf8clean:${length_1:フィル}} to yield '?' */
7987
7988           if (bytes_left != 0)
7989             yield = string_catn(yield, UTF8_REPLACEMENT_CHAR, 1);
7990
7991           break;
7992           }
7993
7994 #ifdef SUPPORT_I18N
7995         case EOP_UTF8_DOMAIN_TO_ALABEL:
7996           {
7997           uschar * error = NULL;
7998           uschar * s = string_domain_utf8_to_alabel(sub, &error);
7999           if (error)
8000             {
8001             expand_string_message = string_sprintf(
8002               "error converting utf8 (%s) to alabel: %s",
8003               string_printing(sub), error);
8004             goto EXPAND_FAILED;
8005             }
8006           yield = string_cat(yield, s);
8007           break;
8008           }
8009
8010         case EOP_UTF8_DOMAIN_FROM_ALABEL:
8011           {
8012           uschar * error = NULL;
8013           uschar * s = string_domain_alabel_to_utf8(sub, &error);
8014           if (error)
8015             {
8016             expand_string_message = string_sprintf(
8017               "error converting alabel (%s) to utf8: %s",
8018               string_printing(sub), error);
8019             goto EXPAND_FAILED;
8020             }
8021           yield = string_cat(yield, s);
8022           break;
8023           }
8024
8025         case EOP_UTF8_LOCALPART_TO_ALABEL:
8026           {
8027           uschar * error = NULL;
8028           uschar * s = string_localpart_utf8_to_alabel(sub, &error);
8029           if (error)
8030             {
8031             expand_string_message = string_sprintf(
8032               "error converting utf8 (%s) to alabel: %s",
8033               string_printing(sub), error);
8034             goto EXPAND_FAILED;
8035             }
8036           yield = string_cat(yield, s);
8037           DEBUG(D_expand) debug_printf_indent("yield: '%Y'\n", yield);
8038           break;
8039           }
8040
8041         case EOP_UTF8_LOCALPART_FROM_ALABEL:
8042           {
8043           uschar * error = NULL;
8044           uschar * s = string_localpart_alabel_to_utf8(sub, &error);
8045           if (error)
8046             {
8047             expand_string_message = string_sprintf(
8048               "error converting alabel (%s) to utf8: %s",
8049               string_printing(sub), error);
8050             goto EXPAND_FAILED;
8051             }
8052           yield = string_cat(yield, s);
8053           break;
8054           }
8055 #endif  /* EXPERIMENTAL_INTERNATIONAL */
8056
8057         /* escape turns all non-printing characters into escape sequences. */
8058
8059         case EOP_ESCAPE:
8060           {
8061           const uschar * t = string_printing(sub);
8062           yield = string_cat(yield, t);
8063           break;
8064           }
8065
8066         case EOP_ESCAPE8BIT:
8067           {
8068           uschar c;
8069
8070           for (const uschar * s = sub; (c = *s); s++)
8071             yield = c < 127 && c != '\\'
8072               ? string_catn(yield, s, 1)
8073               : string_fmt_append(yield, "\\%03o", c);
8074           break;
8075           }
8076
8077         /* Handle numeric expression evaluation */
8078
8079         case EOP_EVAL:
8080         case EOP_EVAL10:
8081           {
8082           uschar *save_sub = sub;
8083           uschar *error = NULL;
8084           int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
8085           if (error)
8086             {
8087             expand_string_message = string_sprintf("error in expression "
8088               "evaluation: %s (after processing \"%.*s\")", error,
8089               (int)(sub-save_sub), save_sub);
8090             goto EXPAND_FAILED;
8091             }
8092           yield = string_fmt_append(yield, PR_EXIM_ARITH, n);
8093           break;
8094           }
8095
8096         /* Handle time period formatting */
8097
8098         case EOP_TIME_EVAL:
8099           {
8100           int n = readconf_readtime(sub, 0, FALSE);
8101           if (n < 0)
8102             {
8103             expand_string_message = string_sprintf("string \"%s\" is not an "
8104               "Exim time interval in \"%s\" operator", sub, name);
8105             goto EXPAND_FAILED;
8106             }
8107           yield = string_fmt_append(yield, "%d", n);
8108           break;
8109           }
8110
8111         case EOP_TIME_INTERVAL:
8112           {
8113           int n;
8114           uschar *t = read_number(&n, sub);
8115           if (*t != 0) /* Not A Number*/
8116             {
8117             expand_string_message = string_sprintf("string \"%s\" is not a "
8118               "positive number in \"%s\" operator", sub, name);
8119             goto EXPAND_FAILED;
8120             }
8121           t = readconf_printtime(n);
8122           yield = string_cat(yield, t);
8123           break;
8124           }
8125
8126         /* Convert string to base64 encoding */
8127
8128         case EOP_STR2B64:
8129         case EOP_BASE64:
8130           {
8131 #ifndef DISABLE_TLS
8132           uschar * s = vp && *(void **)vp->value
8133             ? tls_cert_der_b64(*(void **)vp->value)
8134             : b64encode(CUS sub, Ustrlen(sub));
8135 #else
8136           uschar * s = b64encode(CUS sub, Ustrlen(sub));
8137 #endif
8138           yield = string_cat(yield, s);
8139           break;
8140           }
8141
8142         case EOP_BASE64D:
8143           {
8144           uschar * s;
8145           int len = b64decode(sub, &s, sub);
8146           if (len < 0)
8147             {
8148             expand_string_message = string_sprintf("string \"%s\" is not "
8149               "well-formed for \"%s\" operator", sub, name);
8150             goto EXPAND_FAILED;
8151             }
8152           yield = string_cat(yield, s);
8153           break;
8154           }
8155
8156         /* strlen returns the length of the string */
8157
8158         case EOP_STRLEN:
8159           yield = string_fmt_append(yield, "%d", Ustrlen(sub));
8160           break;
8161
8162         /* length_n or l_n takes just the first n characters or the whole string,
8163         whichever is the shorter;
8164
8165         substr_m_n, and s_m_n take n characters from offset m; negative m take
8166         from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
8167         takes the rest, either to the right or to the left.
8168
8169         hash_n or h_n makes a hash of length n from the string, yielding n
8170         characters from the set a-z; hash_n_m makes a hash of length n, but
8171         uses m characters from the set a-zA-Z0-9.
8172
8173         nhash_n returns a single number between 0 and n-1 (in text form), while
8174         nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
8175         between 0 and n-1 and the second between 0 and m-1. */
8176
8177         case EOP_LENGTH:
8178         case EOP_L:
8179         case EOP_SUBSTR:
8180         case EOP_S:
8181         case EOP_HASH:
8182         case EOP_H:
8183         case EOP_NHASH:
8184         case EOP_NH:
8185           {
8186           int sign = 1;
8187           int value1 = 0;
8188           int value2 = -1;
8189           int *pn;
8190           int len;
8191           uschar *ret;
8192
8193           if (!arg)
8194             {
8195             expand_string_message = string_sprintf("missing values after %s",
8196               name);
8197             goto EXPAND_FAILED;
8198             }
8199
8200           /* "length" has only one argument, effectively being synonymous with
8201           substr_0_n. */
8202
8203           if (c == EOP_LENGTH || c == EOP_L)
8204             {
8205             pn = &value2;
8206             value2 = 0;
8207             }
8208
8209           /* The others have one or two arguments; for "substr" the first may be
8210           negative. The second being negative means "not supplied". */
8211
8212           else
8213             {
8214             pn = &value1;
8215             if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
8216             }
8217
8218           /* Read up to two numbers, separated by underscores */
8219
8220           ret = arg;
8221           while (*arg != 0)
8222             {
8223             if (arg != ret && *arg == '_' && pn == &value1)
8224               {
8225               pn = &value2;
8226               value2 = 0;
8227               if (arg[1] != 0) arg++;
8228               }
8229             else if (!isdigit(*arg))
8230               {
8231               expand_string_message =
8232                 string_sprintf("non-digit after underscore in \"%s\"", name);
8233               goto EXPAND_FAILED;
8234               }
8235             else *pn = (*pn)*10 + *arg++ - '0';
8236             }
8237           value1 *= sign;
8238
8239           /* Perform the required operation */
8240
8241           ret = c == EOP_HASH || c == EOP_H
8242             ? compute_hash(sub, value1, value2, &len)
8243             : c == EOP_NHASH || c == EOP_NH
8244             ? compute_nhash(sub, value1, value2, &len)
8245             : extract_substr(sub, value1, value2, &len);
8246           if (!ret) goto EXPAND_FAILED;
8247
8248           yield = string_catn(yield, ret, len);
8249           break;
8250           }
8251
8252         /* Stat a path */
8253
8254         case EOP_STAT:
8255           {
8256           uschar smode[12];
8257           uschar **modetable[3];
8258           mode_t mode;
8259           struct stat st;
8260
8261           if (expand_forbid & RDO_EXISTS)
8262             {
8263             expand_string_message = US"Use of the stat() expansion is not permitted";
8264             goto EXPAND_FAILED;
8265             }
8266
8267           if (stat(CS sub, &st) < 0)
8268             {
8269             expand_string_message = string_sprintf("stat(%s) failed: %s",
8270               sub, strerror(errno));
8271             goto EXPAND_FAILED;
8272             }
8273           mode = st.st_mode;
8274           switch (mode & S_IFMT)
8275             {
8276             case S_IFIFO: smode[0] = 'p'; break;
8277             case S_IFCHR: smode[0] = 'c'; break;
8278             case S_IFDIR: smode[0] = 'd'; break;
8279             case S_IFBLK: smode[0] = 'b'; break;
8280             case S_IFREG: smode[0] = '-'; break;
8281             default: smode[0] = '?'; break;
8282             }
8283
8284           modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
8285           modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
8286           modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
8287
8288           for (int i = 0; i < 3; i++)
8289             {
8290             memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
8291             mode >>= 3;
8292             }
8293
8294           smode[10] = 0;
8295           yield = string_fmt_append(yield,
8296             "mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
8297             "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
8298             (long)(st.st_mode & 077777), smode, (long)st.st_ino,
8299             (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
8300             (long)st.st_gid, st.st_size, (long)st.st_atime,
8301             (long)st.st_mtime, (long)st.st_ctime);
8302           break;
8303           }
8304
8305         /* vaguely random number less than N */
8306
8307         case EOP_RANDINT:
8308           {
8309           int_eximarith_t max = expanded_string_integer(sub, TRUE);
8310
8311           if (expand_string_message)
8312             goto EXPAND_FAILED;
8313           yield = string_fmt_append(yield, "%d", vaguely_random_number((int)max));
8314           break;
8315           }
8316
8317         /* Reverse IP, including IPv6 to dotted-nibble */
8318
8319         case EOP_REVERSE_IP:
8320           {
8321           int family, maskptr;
8322           uschar reversed[128];
8323
8324           family = string_is_ip_address(sub, &maskptr);
8325           if (family == 0)
8326             {
8327             expand_string_message = string_sprintf(
8328                 "reverse_ip() not given an IP address [%s]", sub);
8329             goto EXPAND_FAILED;
8330             }
8331           invert_address(reversed, sub);
8332           yield = string_cat(yield, reversed);
8333           break;
8334           }
8335
8336         /* Unknown operator */
8337
8338         default:
8339           expand_string_message =
8340             string_sprintf("unknown expansion operator \"%s\"", name);
8341           goto EXPAND_FAILED;
8342         }       /* EOP_* switch */
8343
8344        DEBUG(D_expand)
8345         {
8346         const uschar * res = string_from_gstring(yield);
8347         const uschar * s = res + expansion_start;
8348         int i = gstring_length(yield) - expansion_start;
8349         BOOL tainted = is_tainted(s);
8350
8351         DEBUG(D_noutf8)
8352           {
8353           debug_printf_indent("|-----op-res: %.*s\n", i, s);
8354           if (tainted)
8355             {
8356             debug_printf_indent("%s     \\__", flags & ESI_SKIPPING ? "|     " : "      ");
8357             debug_print_taint(res);
8358             }
8359           }
8360         else
8361           {
8362           debug_printf_indent(UTF8_VERT_RIGHT
8363             UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8364             "op-res: %.*s\n", i, s);
8365           if (tainted)
8366             {
8367             debug_printf_indent("%s",
8368               flags & ESI_SKIPPING
8369               ? UTF8_VERT "             " : "           " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
8370             debug_print_taint(res);
8371             }
8372           }
8373         }
8374        continue;
8375        }
8376     }
8377
8378   /* Not an item or an operator */
8379   /* Handle a plain name. If this is the first thing in the expansion, release
8380   the pre-allocated buffer. If the result data is known to be in a new buffer,
8381   newsize will be set to the size of that buffer, and we can just point at that
8382   store instead of copying. Many expansion strings contain just one reference,
8383   so this is a useful optimization, especially for humungous headers
8384   ($message_headers). */
8385                                                 /*{*/
8386   if (*s++ == '}')
8387     {
8388     const uschar * value;
8389     int len;
8390     int newsize = 0;
8391     gstring * g = NULL;
8392
8393     if (!yield)
8394       g = store_get(sizeof(gstring), GET_UNTAINTED);
8395     else if (yield->ptr == 0)
8396       {
8397       if (resetok) reset_point = store_reset(reset_point);
8398       yield = NULL;
8399       reset_point = store_mark();
8400       g = store_get(sizeof(gstring), GET_UNTAINTED);    /* alloc _before_ calling find_variable() */
8401       }
8402     if (!(value = find_variable(name, FALSE, !!(flags & ESI_SKIPPING), &newsize)))
8403       {
8404       expand_string_message =
8405         string_sprintf("unknown variable in \"${%s}\"", name);
8406       check_variable_error_message(name);
8407       goto EXPAND_FAILED;
8408       }
8409     len = Ustrlen(value);
8410     if (!yield && newsize)
8411       {
8412       yield = g;
8413       yield->size = newsize;
8414       yield->ptr = len;
8415       yield->s = US value; /* known to be in new store i.e. a copy, so deconst safe */
8416       }
8417     else
8418       yield = string_catn(yield, value, len);
8419     continue;
8420     }
8421
8422   /* Else there's something wrong */
8423
8424   expand_string_message =
8425     string_sprintf("\"${%s\" is not a known operator (or a } is missing "
8426     "in a variable reference)", name);
8427   goto EXPAND_FAILED;
8428   }
8429
8430 /* If we hit the end of the string when brace_ends is set, there is a missing
8431 terminating brace. */
8432
8433 if (flags & ESI_BRACE_ENDS && !*s)
8434   {                                                     /*{{*/
8435   expand_string_message = malformed_header
8436     ? US"missing } at end of string - could be header name not terminated by colon"
8437     : US"missing } at end of string";
8438   goto EXPAND_FAILED;
8439   }
8440
8441 /* Expansion succeeded; yield may still be NULL here if nothing was actually
8442 added to the string. If so, set up an empty string. Add a terminating zero. If
8443 left != NULL, return a pointer to the terminator. */
8444
8445  {
8446   uschar * res;
8447
8448   if (!yield)
8449     yield = string_get(1);
8450   res = string_from_gstring(yield);
8451   if (left) *left = s;
8452
8453   /* Any stacking store that was used above the final string is no longer needed.
8454   In many cases the final string will be the first one that was got and so there
8455   will be optimal store usage. */
8456
8457   if (resetok) gstring_release_unused(yield);
8458   else if (resetok_p) *resetok_p = FALSE;
8459
8460   DEBUG(D_expand)
8461     {
8462     BOOL tainted = is_tainted(res);
8463     DEBUG(D_noutf8)
8464       {
8465       debug_printf_indent("|--expanding: %.*s\n", (int)(s - string), string);
8466       debug_printf_indent("%sresult: %s\n",
8467         flags & ESI_SKIPPING ? "|-----" : "\\_____", res);
8468       if (tainted)
8469         {
8470         debug_printf_indent("%s     \\__", flags & ESI_SKIPPING ? "|     " : "      ");
8471         debug_print_taint(res);
8472         }
8473       if (flags & ESI_SKIPPING)
8474         debug_printf_indent("\\___skipping: result is not used\n");
8475       }
8476     else
8477       {
8478       debug_printf_indent(UTF8_VERT_RIGHT UTF8_HORIZ UTF8_HORIZ
8479         "expanding: %.*s\n",
8480         (int)(s - string), string);
8481       debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8482         "result: %s\n",
8483         flags & ESI_SKIPPING ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8484         res);
8485       if (tainted)
8486         {
8487         debug_printf_indent("%s",
8488           flags & ESI_SKIPPING
8489           ? UTF8_VERT "             " : "           " UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ);
8490         debug_print_taint(res);
8491         }
8492       if (flags & ESI_SKIPPING)
8493         debug_printf_indent(UTF8_UP_RIGHT UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8494           "skipping: result is not used\n");
8495       }
8496     }
8497   if (textonly_p) *textonly_p = textonly;
8498   expand_level--;
8499   return res;
8500  }
8501
8502 /* This is the failure exit: easiest to program with a goto. We still need
8503 to update the pointer to the terminator, for cases of nested calls with "fail".
8504 */
8505
8506 EXPAND_FAILED_CURLY:
8507 if (malformed_header)
8508   expand_string_message =
8509     US"missing or misplaced { or } - could be header name not terminated by colon";
8510
8511 else if (!expand_string_message || !*expand_string_message)
8512   expand_string_message = US"missing or misplaced { or }";
8513
8514 /* At one point, Exim reset the store to yield (if yield was not NULL), but
8515 that is a bad idea, because expand_string_message is in dynamic store. */
8516
8517 EXPAND_FAILED:
8518 if (left) *left = s;
8519 DEBUG(D_expand)
8520   {
8521   DEBUG(D_noutf8)
8522     {
8523     debug_printf_indent("|failed to expand: %s\n", string);
8524     debug_printf_indent("%serror message: %s\n",
8525       f.expand_string_forcedfail ? "|---" : "\\___", expand_string_message);
8526     if (f.expand_string_forcedfail)
8527       debug_printf_indent("\\failure was forced\n");
8528     }
8529   else
8530     {
8531     debug_printf_indent(UTF8_VERT_RIGHT "failed to expand: %s\n",
8532       string);
8533     debug_printf_indent("%s" UTF8_HORIZ UTF8_HORIZ UTF8_HORIZ
8534       "error message: %s\n",
8535       f.expand_string_forcedfail ? UTF8_VERT_RIGHT : UTF8_UP_RIGHT,
8536       expand_string_message);
8537     if (f.expand_string_forcedfail)
8538       debug_printf_indent(UTF8_UP_RIGHT "failure was forced\n");
8539     }
8540   }
8541 if (resetok_p && !resetok) *resetok_p = FALSE;
8542 expand_level--;
8543 return NULL;
8544 }
8545
8546
8547
8548 /* This is the external function call. Do a quick check for any expansion
8549 metacharacters, and if there are none, just return the input string.
8550
8551 Arguments
8552         the string to be expanded
8553         optional pointer for return boolean indicating no-dynamic-expansions
8554
8555 Returns:  the expanded string, or NULL if expansion failed; if failure was
8556           due to a lookup deferring, search_find_defer will be TRUE
8557 */
8558
8559 const uschar *
8560 expand_string_2(const uschar * string, BOOL * textonly_p)
8561 {
8562 if (Ustrpbrk(string, "$\\") != NULL)
8563   {
8564   int old_pool = store_pool;
8565   uschar * s;
8566
8567   f.search_find_defer = FALSE;
8568   malformed_header = FALSE;
8569   store_pool = POOL_MAIN;
8570     s = expand_string_internal(string, ESI_HONOR_DOLLAR, NULL, NULL, textonly_p);
8571   store_pool = old_pool;
8572   return s;
8573   }
8574 if (textonly_p) *textonly_p = TRUE;
8575 return string;
8576 }
8577
8578 const uschar *
8579 expand_cstring(const uschar * string)
8580 { return expand_string_2(string, NULL); }
8581
8582 uschar *
8583 expand_string(uschar * string)
8584 { return US expand_string_2(CUS string, NULL); }
8585
8586
8587
8588
8589
8590
8591 /*************************************************
8592 *              Expand and copy                   *
8593 *************************************************/
8594
8595 /* Now and again we want to expand a string and be sure that the result is in a
8596 new bit of store. This function does that.
8597 Since we know it has been copied, the de-const cast is safe.
8598
8599 Argument: the string to be expanded
8600 Returns:  the expanded string, always in a new bit of store, or NULL
8601 */
8602
8603 uschar *
8604 expand_string_copy(const uschar *string)
8605 {
8606 const uschar *yield = expand_cstring(string);
8607 if (yield == string) yield = string_copy(string);
8608 return US yield;
8609 }
8610
8611
8612
8613 /*************************************************
8614 *        Expand and interpret as an integer      *
8615 *************************************************/
8616
8617 /* Expand a string, and convert the result into an integer.
8618
8619 Arguments:
8620   string  the string to be expanded
8621   isplus  TRUE if a non-negative number is expected
8622
8623 Returns:  the integer value, or
8624           -1 for an expansion error               ) in both cases, message in
8625           -2 for an integer interpretation error  ) expand_string_message
8626           expand_string_message is set NULL for an OK integer
8627 */
8628
8629 int_eximarith_t
8630 expand_string_integer(uschar *string, BOOL isplus)
8631 {
8632 return expanded_string_integer(expand_string(string), isplus);
8633 }
8634
8635
8636 /*************************************************
8637  *         Interpret string as an integer        *
8638  *************************************************/
8639
8640 /* Convert a string (that has already been expanded) into an integer.
8641
8642 This function is used inside the expansion code.
8643
8644 Arguments:
8645   s       the string to be expanded
8646   isplus  TRUE if a non-negative number is expected
8647
8648 Returns:  the integer value, or
8649           -1 if string is NULL (which implies an expansion error)
8650           -2 for an integer interpretation error
8651           expand_string_message is set NULL for an OK integer
8652 */
8653
8654 static int_eximarith_t
8655 expanded_string_integer(const uschar *s, BOOL isplus)
8656 {
8657 int_eximarith_t value;
8658 uschar *msg = US"invalid integer \"%s\"";
8659 uschar *endptr;
8660
8661 /* If expansion failed, expand_string_message will be set. */
8662
8663 if (!s) return -1;
8664
8665 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
8666 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
8667 systems, so we set it zero ourselves. */
8668
8669 errno = 0;
8670 expand_string_message = NULL;               /* Indicates no error */
8671
8672 /* Before Exim 4.64, strings consisting entirely of whitespace compared
8673 equal to 0.  Unfortunately, people actually relied upon that, so preserve
8674 the behaviour explicitly.  Stripping leading whitespace is a harmless
8675 noop change since strtol skips it anyway (provided that there is a number
8676 to find at all). */
8677 if (isspace(*s))
8678   if (Uskip_whitespace(&s) == '\0')
8679     {
8680       DEBUG(D_expand)
8681        debug_printf_indent("treating blank string as number 0\n");
8682       return 0;
8683     }
8684
8685 value = strtoll(CS s, CSS &endptr, 10);
8686
8687 if (endptr == s)
8688   msg = US"integer expected but \"%s\" found";
8689 else if (value < 0 && isplus)
8690   msg = US"non-negative integer expected but \"%s\" found";
8691 else
8692   {
8693   switch (tolower(*endptr))
8694     {
8695     default:
8696       break;
8697     case 'k':
8698       if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
8699       else value *= 1024;
8700       endptr++;
8701       break;
8702     case 'm':
8703       if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
8704       else value *= 1024*1024;
8705       endptr++;
8706       break;
8707     case 'g':
8708       if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
8709       else value *= 1024*1024*1024;
8710       endptr++;
8711       break;
8712     }
8713   if (errno == ERANGE)
8714     msg = US"absolute value of integer \"%s\" is too large (overflow)";
8715   else
8716     if (Uskip_whitespace(&endptr) == 0) return value;
8717   }
8718
8719 expand_string_message = string_sprintf(CS msg, s);
8720 return -2;
8721 }
8722
8723
8724 /* These values are usually fixed boolean values, but they are permitted to be
8725 expanded strings.
8726
8727 Arguments:
8728   addr       address being routed
8729   mtype      the module type
8730   mname      the module name
8731   dbg_opt    debug selectors
8732   oname      the option name
8733   bvalue     the router's boolean value
8734   svalue     the router's string value
8735   rvalue     where to put the returned value
8736
8737 Returns:     OK     value placed in rvalue
8738              DEFER  expansion failed
8739 */
8740
8741 int
8742 exp_bool(address_item *addr,
8743   uschar *mtype, uschar *mname, unsigned dbg_opt,
8744   uschar *oname, BOOL bvalue,
8745   uschar *svalue, BOOL *rvalue)
8746 {
8747 uschar *expanded;
8748 if (!svalue) { *rvalue = bvalue; return OK; }
8749
8750 if (!(expanded = expand_string(svalue)))
8751   {
8752   if (f.expand_string_forcedfail)
8753     {
8754     DEBUG(dbg_opt) debug_printf("expansion of \"%s\" forced failure\n", oname);
8755     *rvalue = bvalue;
8756     return OK;
8757     }
8758   addr->message = string_sprintf("failed to expand \"%s\" in %s %s: %s",
8759       oname, mname, mtype, expand_string_message);
8760   DEBUG(dbg_opt) debug_printf("%s\n", addr->message);
8761   return DEFER;
8762   }
8763
8764 DEBUG(dbg_opt) debug_printf("expansion of \"%s\" yields \"%s\"\n", oname,
8765   expanded);
8766
8767 if (strcmpic(expanded, US"true") == 0 || strcmpic(expanded, US"yes") == 0)
8768   *rvalue = TRUE;
8769 else if (strcmpic(expanded, US"false") == 0 || strcmpic(expanded, US"no") == 0)
8770   *rvalue = FALSE;
8771 else
8772   {
8773   addr->message = string_sprintf("\"%s\" is not a valid value for the "
8774     "\"%s\" option in the %s %s", expanded, oname, mname, mtype);
8775   return DEFER;
8776   }
8777
8778 return OK;
8779 }
8780
8781
8782
8783 /* Avoid potentially exposing a password in a string about to be logged */
8784
8785 uschar *
8786 expand_hide_passwords(uschar * s)
8787 {
8788 return (  (  Ustrstr(s, "failed to expand") != NULL
8789           || Ustrstr(s, "expansion of ")    != NULL
8790           )
8791        && (  Ustrstr(s, "mysql")   != NULL
8792           || Ustrstr(s, "pgsql")   != NULL
8793           || Ustrstr(s, "redis")   != NULL
8794           || Ustrstr(s, "sqlite")  != NULL
8795           || Ustrstr(s, "ldap:")   != NULL
8796           || Ustrstr(s, "ldaps:")  != NULL
8797           || Ustrstr(s, "ldapi:")  != NULL
8798           || Ustrstr(s, "ldapdn:") != NULL
8799           || Ustrstr(s, "ldapm:")  != NULL
8800        )  )
8801   ? US"Temporary internal error" : s;
8802 }
8803
8804
8805 /* Read given named file into big_buffer.  Use for keying material etc.
8806 The content will have an ascii NUL appended.
8807
8808 Arguments:
8809  filename       as it says
8810
8811 Return:  pointer to buffer, or NULL on error.
8812 */
8813
8814 uschar *
8815 expand_file_big_buffer(const uschar * filename)
8816 {
8817 int fd, off = 0, len;
8818
8819 if ((fd = exim_open2(CS filename, O_RDONLY)) < 0)
8820   {
8821   log_write(0, LOG_MAIN | LOG_PANIC, "unable to open file for reading: %s",
8822              filename);
8823   return NULL;
8824   }
8825
8826 do
8827   {
8828   if ((len = read(fd, big_buffer + off, big_buffer_size - 2 - off)) < 0)
8829     {
8830     (void) close(fd);
8831     log_write(0, LOG_MAIN|LOG_PANIC, "unable to read file: %s", filename);
8832     return NULL;
8833     }
8834   off += len;
8835   }
8836 while (len > 0);
8837
8838 (void) close(fd);
8839 big_buffer[off] = '\0';
8840 return big_buffer;
8841 }
8842
8843
8844
8845 /*************************************************
8846 * Error-checking for testsuite                   *
8847 *************************************************/
8848 typedef struct {
8849   uschar *      region_start;
8850   uschar *      region_end;
8851   const uschar *var_name;
8852   const uschar *var_data;
8853 } err_ctx;
8854
8855 /* Called via tree_walk, which allows nonconst name/data.  Our usage is const. */
8856 static void
8857 assert_variable_notin(uschar * var_name, uschar * var_data, void * ctx)
8858 {
8859 err_ctx * e = ctx;
8860 if (var_data >= e->region_start  &&  var_data < e->region_end)
8861   {
8862   e->var_name = CUS var_name;
8863   e->var_data = CUS var_data;
8864   }
8865 }
8866
8867 void
8868 assert_no_variables(void * ptr, int len, const char * filename, int linenumber)
8869 {
8870 err_ctx e = { .region_start = ptr, .region_end = US ptr + len,
8871               .var_name = NULL, .var_data = NULL };
8872
8873 /* check acl_ variables */
8874 tree_walk(acl_var_c, assert_variable_notin, &e);
8875 tree_walk(acl_var_m, assert_variable_notin, &e);
8876
8877 /* check auth<n> variables.
8878 assert_variable_notin() treats as const, so deconst is safe. */
8879 for (int i = 0; i < AUTH_VARS; i++) if (auth_vars[i])
8880   assert_variable_notin(US"auth<n>", US auth_vars[i], &e);
8881
8882 #ifdef WITH_CONTENT_SCAN
8883 /* check regex<n> variables. assert_variable_notin() treats as const. */
8884 for (int i = 0; i < REGEX_VARS; i++) if (regex_vars[i])
8885   assert_variable_notin(US"regex<n>", US regex_vars[i], &e);
8886 #endif
8887
8888 /* check known-name variables */
8889 for (var_entry * v = var_table; v < var_table + nelem(var_table); v++)
8890   if (v->type == vtype_stringptr)
8891     assert_variable_notin(US v->name, *(USS v->value), &e);
8892
8893 /* check dns and address trees */
8894 tree_walk(tree_dns_fails,     assert_variable_notin, &e);
8895 tree_walk(tree_duplicates,    assert_variable_notin, &e);
8896 tree_walk(tree_nonrecipients, assert_variable_notin, &e);
8897 tree_walk(tree_unusable,      assert_variable_notin, &e);
8898
8899 if (e.var_name)
8900   log_write(0, LOG_MAIN|LOG_PANIC_DIE,
8901     "live variable '%s' destroyed by reset_store at %s:%d\n- value '%.64s'",
8902     e.var_name, filename, linenumber, e.var_data);
8903 }
8904
8905
8906
8907 /*************************************************
8908 **************************************************
8909 *             Stand-alone test program           *
8910 **************************************************
8911 *************************************************/
8912
8913 #ifdef STAND_ALONE
8914
8915
8916 BOOL
8917 regex_match_and_setup(const pcre2_code *re, uschar *subject, int options, int setup)
8918 {
8919 int ovec[3*(EXPAND_MAXN+1)];
8920 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
8921   ovec, nelem(ovec));
8922 BOOL yield = n >= 0;
8923 if (n == 0) n = EXPAND_MAXN + 1;
8924 if (yield)
8925   {
8926   expand_nmax = setup < 0 ? 0 : setup + 1;
8927   for (int nn = setup < 0 ? 0 : 2; nn < n*2; nn += 2)
8928     {
8929     expand_nstring[expand_nmax] = subject + ovec[nn];
8930     expand_nlength[expand_nmax++] = ovec[nn+1] - ovec[nn];
8931     }
8932   expand_nmax--;
8933   }
8934 return yield;
8935 }
8936
8937
8938 int main(int argc, uschar **argv)
8939 {
8940 uschar buffer[1024];
8941
8942 debug_selector = D_v;
8943 debug_file = stderr;
8944 debug_fd = fileno(debug_file);
8945 big_buffer = malloc(big_buffer_size);
8946 store_init();
8947
8948 for (int i = 1; i < argc; i++)
8949   {
8950   if (argv[i][0] == '+')
8951     {
8952     debug_trace_memory = 2;
8953     argv[i]++;
8954     }
8955   if (isdigit(argv[i][0]))
8956     debug_selector = Ustrtol(argv[i], NULL, 0);
8957   else
8958     if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
8959         Ustrlen(argv[i]))
8960       {
8961 #ifdef LOOKUP_LDAP
8962       eldap_default_servers = argv[i];
8963 #endif
8964 #ifdef LOOKUP_MYSQL
8965       mysql_servers = argv[i];
8966 #endif
8967 #ifdef LOOKUP_PGSQL
8968       pgsql_servers = argv[i];
8969 #endif
8970 #ifdef LOOKUP_REDIS
8971       redis_servers = argv[i];
8972 #endif
8973       }
8974 #ifdef EXIM_PERL
8975   else opt_perl_startup = argv[i];
8976 #endif
8977   }
8978
8979 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
8980
8981 expand_nstring[1] = US"string 1....";
8982 expand_nlength[1] = 8;
8983 expand_nmax = 1;
8984
8985 #ifdef EXIM_PERL
8986 if (opt_perl_startup != NULL)
8987   {
8988   uschar *errstr;
8989   printf("Starting Perl interpreter\n");
8990   errstr = init_perl(opt_perl_startup);
8991   if (errstr != NULL)
8992     {
8993     printf("** error in perl_startup code: %s\n", errstr);
8994     return EXIT_FAILURE;
8995     }
8996   }
8997 #endif /* EXIM_PERL */
8998
8999 /* Thie deliberately regards the input as untainted, so that it can be
9000 expanded; only reasonable since this is a test for string-expansions. */
9001
9002 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
9003   {
9004   rmark reset_point = store_mark();
9005   uschar *yield = expand_string(buffer);
9006   if (yield)
9007     printf("%s\n", yield);
9008   else
9009     {
9010     if (f.search_find_defer) printf("search_find deferred\n");
9011     printf("Failed: %s\n", expand_string_message);
9012     if (f.expand_string_forcedfail) printf("Forced failure\n");
9013     printf("\n");
9014     }
9015   store_reset(reset_point);
9016   }
9017
9018 search_tidyup();
9019
9020 return 0;
9021 }
9022
9023 #endif  /*STAND_ALONE*/
9024
9025 #endif  /*!MACRO_PREDEF*/
9026 /* vi: aw ai sw=2
9027 */
9028 /* End of expand.c */