src/src/expand.c

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