src/src/expand.c

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