src/src/expand.c

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