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