src/src/expand.c

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