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