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