src/src/expand.c

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