src/src/expand.c

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