src/src/expand.c

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) University of Cambridge 1995 - 2012 */
   6 /* See the file NOTICE for conditions of use and distribution. */
   7
   8
   9 /* Functions for handling string expansion. */
  10
  11
  12 #include "exim.h"
  13
  14 /* Recursively called function */
  15
  16 static uschar *expand_string_internal(uschar *, BOOL, uschar **, BOOL, BOOL);
  17
  18 #ifdef STAND_ALONE
  19 #ifndef SUPPORT_CRYPTEQ
  20 #define SUPPORT_CRYPTEQ
  21 #endif
  22 #endif
  23
  24 #ifdef LOOKUP_LDAP
  25 #include "lookups/ldap.h"
  26 #endif
  27
  28 #ifdef SUPPORT_CRYPTEQ
  29 #ifdef CRYPT_H
  30 #include <crypt.h>
  31 #endif
  32 #ifndef HAVE_CRYPT16
  33 extern char* crypt16(char*, char*);
  34 #endif
  35 #endif
  36
  37 /* The handling of crypt16() is a mess. I will record below the analysis of the
  38 mess that was sent to me. We decided, however, to make changing this very low
  39 priority, because in practice people are moving away from the crypt()
  40 algorithms nowadays, so it doesn't seem worth it.
  41
  42 <quote>
  43 There is an algorithm named "crypt16" in Ultrix and Tru64.  It crypts
  44 the first 8 characters of the password using a 20-round version of crypt
  45 (standard crypt does 25 rounds).  It then crypts the next 8 characters,
  46 or an empty block if the password is less than 9 characters, using a
  47 20-round version of crypt and the same salt as was used for the first
  48 block.  Charaters after the first 16 are ignored.  It always generates
  49 a 16-byte hash, which is expressed together with the salt as a string
  50 of 24 base 64 digits.  Here are some links to peruse:
  51
  52         http://cvs.pld.org.pl/pam/pamcrypt/crypt16.c?rev=1.2
  53         http://seclists.org/bugtraq/1999/Mar/0076.html
  54
  55 There's a different algorithm named "bigcrypt" in HP-UX, Digital Unix,
  56 and OSF/1.  This is the same as the standard crypt if given a password
  57 of 8 characters or less.  If given more, it first does the same as crypt
  58 using the first 8 characters, then crypts the next 8 (the 9th to 16th)
  59 using as salt the first two base 64 digits from the first hash block.
  60 If the password is more than 16 characters then it crypts the 17th to 24th
  61 characters using as salt the first two base 64 digits from the second hash
  62 block.  And so on: I've seen references to it cutting off the password at
  63 40 characters (5 blocks), 80 (10 blocks), or 128 (16 blocks).  Some links:
  64
  65         http://cvs.pld.org.pl/pam/pamcrypt/bigcrypt.c?rev=1.2
  66         http://seclists.org/bugtraq/1999/Mar/0109.html
  67         http://h30097.www3.hp.com/docs/base_doc/DOCUMENTATION/HTML/AA-Q0R2D-
  68              TET1_html/sec.c222.html#no_id_208
  69
  70 Exim has something it calls "crypt16".  It will either use a native
  71 crypt16 or its own implementation.  A native crypt16 will presumably
  72 be the one that I called "crypt16" above.  The internal "crypt16"
  73 function, however, is a two-block-maximum implementation of what I called
  74 "bigcrypt".  The documentation matches the internal code.
  75
  76 I suspect that whoever did the "crypt16" stuff for Exim didn't realise
  77 that crypt16 and bigcrypt were different things.
  78
  79 Exim uses the LDAP-style scheme identifier "{crypt16}" to refer
  80 to whatever it is using under that name.  This unfortunately sets a
  81 precedent for using "{crypt16}" to identify two incompatible algorithms
  82 whose output can't be distinguished.  With "{crypt16}" thus rendered
  83 ambiguous, I suggest you deprecate it and invent two new identifiers
  84 for the two algorithms.
  85
  86 Both crypt16 and bigcrypt are very poor algorithms, btw.  Hashing parts
  87 of the password separately means they can be cracked separately, so
  88 the double-length hash only doubles the cracking effort instead of
  89 squaring it.  I recommend salted SHA-1 ({SSHA}), or the Blowfish-based
  90 bcrypt ({CRYPT}$2a$).
  91 </quote>
  92 */
  93
  94
  95
  96
  97 /*************************************************
  98 *            Local statics and tables            *
  99 *************************************************/
 100
 101 /* Table of item names, and corresponding switch numbers. The names must be in
 102 alphabetical order. */
 103
 104 static uschar *item_table[] = {
 105   US"acl",
 106   US"dlfunc",
 107   US"extract",
 108   US"filter",
 109   US"hash",
 110   US"hmac",
 111   US"if",
 112   US"length",
 113   US"lookup",
 114   US"map",
 115   US"nhash",
 116   US"perl",
 117   US"prvs",
 118   US"prvscheck",
 119   US"readfile",
 120   US"readsocket",
 121   US"reduce",
 122   US"run",
 123   US"sg",
 124   US"substr",
 125   US"tr" };
 126
 127 enum {
 128   EITEM_ACL,
 129   EITEM_DLFUNC,
 130   EITEM_EXTRACT,
 131   EITEM_FILTER,
 132   EITEM_HASH,
 133   EITEM_HMAC,
 134   EITEM_IF,
 135   EITEM_LENGTH,
 136   EITEM_LOOKUP,
 137   EITEM_MAP,
 138   EITEM_NHASH,
 139   EITEM_PERL,
 140   EITEM_PRVS,
 141   EITEM_PRVSCHECK,
 142   EITEM_READFILE,
 143   EITEM_READSOCK,
 144   EITEM_REDUCE,
 145   EITEM_RUN,
 146   EITEM_SG,
 147   EITEM_SUBSTR,
 148   EITEM_TR };
 149
 150 /* Tables of operator names, and corresponding switch numbers. The names must be
 151 in alphabetical order. There are two tables, because underscore is used in some
 152 cases to introduce arguments, whereas for other it is part of the name. This is
 153 an historical mis-design. */
 154
 155 static uschar *op_table_underscore[] = {
 156   US"from_utf8",
 157   US"local_part",
 158   US"quote_local_part",
 159   US"reverse_ip",
 160   US"time_eval",
 161   US"time_interval"};
 162
 163 enum {
 164   EOP_FROM_UTF8,
 165   EOP_LOCAL_PART,
 166   EOP_QUOTE_LOCAL_PART,
 167   EOP_REVERSE_IP,
 168   EOP_TIME_EVAL,
 169   EOP_TIME_INTERVAL };
 170
 171 static uschar *op_table_main[] = {
 172   US"address",
 173   US"addresses",
 174   US"base62",
 175   US"base62d",
 176   US"domain",
 177   US"escape",
 178   US"eval",
 179   US"eval10",
 180   US"expand",
 181   US"h",
 182   US"hash",
 183   US"hex2b64",
 184   US"hexquote",
 185   US"l",
 186   US"lc",
 187   US"length",
 188   US"listcount",
 189   US"listnamed",
 190   US"mask",
 191   US"md5",
 192   US"nh",
 193   US"nhash",
 194   US"quote",
 195   US"randint",
 196   US"rfc2047",
 197   US"rfc2047d",
 198   US"rxquote",
 199   US"s",
 200   US"sha1",
 201   US"stat",
 202   US"str2b64",
 203   US"strlen",
 204   US"substr",
 205   US"uc" };
 206
 207 enum {
 208   EOP_ADDRESS =  sizeof(op_table_underscore)/sizeof(uschar *),
 209   EOP_ADDRESSES,
 210   EOP_BASE62,
 211   EOP_BASE62D,
 212   EOP_DOMAIN,
 213   EOP_ESCAPE,
 214   EOP_EVAL,
 215   EOP_EVAL10,
 216   EOP_EXPAND,
 217   EOP_H,
 218   EOP_HASH,
 219   EOP_HEX2B64,
 220   EOP_HEXQUOTE,
 221   EOP_L,
 222   EOP_LC,
 223   EOP_LENGTH,
 224   EOP_LISTCOUNT,
 225   EOP_LISTNAMED,
 226   EOP_MASK,
 227   EOP_MD5,
 228   EOP_NH,
 229   EOP_NHASH,
 230   EOP_QUOTE,
 231   EOP_RANDINT,
 232   EOP_RFC2047,
 233   EOP_RFC2047D,
 234   EOP_RXQUOTE,
 235   EOP_S,
 236   EOP_SHA1,
 237   EOP_STAT,
 238   EOP_STR2B64,
 239   EOP_STRLEN,
 240   EOP_SUBSTR,
 241   EOP_UC };
 242
 243
 244 /* Table of condition names, and corresponding switch numbers. The names must
 245 be in alphabetical order. */
 246
 247 static uschar *cond_table[] = {
 248   US"<",
 249   US"<=",
 250   US"=",
 251   US"==",     /* Backward compatibility */
 252   US">",
 253   US">=",
 254   US"acl",
 255   US"and",
 256   US"bool",
 257   US"bool_lax",
 258   US"crypteq",
 259   US"def",
 260   US"eq",
 261   US"eqi",
 262   US"exists",
 263   US"first_delivery",
 264   US"forall",
 265   US"forany",
 266   US"ge",
 267   US"gei",
 268   US"gt",
 269   US"gti",
 270   US"inlist",
 271   US"inlisti",
 272   US"isip",
 273   US"isip4",
 274   US"isip6",
 275   US"ldapauth",
 276   US"le",
 277   US"lei",
 278   US"lt",
 279   US"lti",
 280   US"match",
 281   US"match_address",
 282   US"match_domain",
 283   US"match_ip",
 284   US"match_local_part",
 285   US"or",
 286   US"pam",
 287   US"pwcheck",
 288   US"queue_running",
 289   US"radius",
 290   US"saslauthd"
 291 };
 292
 293 enum {
 294   ECOND_NUM_L,
 295   ECOND_NUM_LE,
 296   ECOND_NUM_E,
 297   ECOND_NUM_EE,
 298   ECOND_NUM_G,
 299   ECOND_NUM_GE,
 300   ECOND_ACL,
 301   ECOND_AND,
 302   ECOND_BOOL,
 303   ECOND_BOOL_LAX,
 304   ECOND_CRYPTEQ,
 305   ECOND_DEF,
 306   ECOND_STR_EQ,
 307   ECOND_STR_EQI,
 308   ECOND_EXISTS,
 309   ECOND_FIRST_DELIVERY,
 310   ECOND_FORALL,
 311   ECOND_FORANY,
 312   ECOND_STR_GE,
 313   ECOND_STR_GEI,
 314   ECOND_STR_GT,
 315   ECOND_STR_GTI,
 316   ECOND_INLIST,
 317   ECOND_INLISTI,
 318   ECOND_ISIP,
 319   ECOND_ISIP4,
 320   ECOND_ISIP6,
 321   ECOND_LDAPAUTH,
 322   ECOND_STR_LE,
 323   ECOND_STR_LEI,
 324   ECOND_STR_LT,
 325   ECOND_STR_LTI,
 326   ECOND_MATCH,
 327   ECOND_MATCH_ADDRESS,
 328   ECOND_MATCH_DOMAIN,
 329   ECOND_MATCH_IP,
 330   ECOND_MATCH_LOCAL_PART,
 331   ECOND_OR,
 332   ECOND_PAM,
 333   ECOND_PWCHECK,
 334   ECOND_QUEUE_RUNNING,
 335   ECOND_RADIUS,
 336   ECOND_SASLAUTHD
 337 };
 338
 339
 340 /* Type for main variable table */
 341
 342 typedef struct {
 343   const char *name;
 344   int         type;
 345   void       *value;
 346 } var_entry;
 347
 348 /* Type for entries pointing to address/length pairs. Not currently
 349 in use. */
 350
 351 typedef struct {
 352   uschar **address;
 353   int  *length;
 354 } alblock;
 355
 356 /* Types of table entry */
 357
 358 enum {
 359   vtype_int,            /* value is address of int */
 360   vtype_filter_int,     /* ditto, but recognized only when filtering */
 361   vtype_ino,            /* value is address of ino_t (not always an int) */
 362   vtype_uid,            /* value is address of uid_t (not always an int) */
 363   vtype_gid,            /* value is address of gid_t (not always an int) */
 364   vtype_bool,           /* value is address of bool */
 365   vtype_stringptr,      /* value is address of pointer to string */
 366   vtype_msgbody,        /* as stringptr, but read when first required */
 367   vtype_msgbody_end,    /* ditto, the end of the message */
 368   vtype_msgheaders,     /* the message's headers, processed */
 369   vtype_msgheaders_raw, /* the message's headers, unprocessed */
 370   vtype_localpart,      /* extract local part from string */
 371   vtype_domain,         /* extract domain from string */
 372   vtype_string_func,    /* value is string returned by given function */
 373   vtype_todbsdin,       /* value not used; generate BSD inbox tod */
 374   vtype_tode,           /* value not used; generate tod in epoch format */
 375   vtype_todel,          /* value not used; generate tod in epoch/usec format */
 376   vtype_todf,           /* value not used; generate full tod */
 377   vtype_todl,           /* value not used; generate log tod */
 378   vtype_todlf,          /* value not used; generate log file datestamp tod */
 379   vtype_todzone,        /* value not used; generate time zone only */
 380   vtype_todzulu,        /* value not used; generate zulu tod */
 381   vtype_reply,          /* value not used; get reply from headers */
 382   vtype_pid,            /* value not used; result is pid */
 383   vtype_host_lookup,    /* value not used; get host name */
 384   vtype_load_avg,       /* value not used; result is int from os_getloadavg */
 385   vtype_pspace,         /* partition space; value is T/F for spool/log */
 386   vtype_pinodes         /* partition inodes; value is T/F for spool/log */
 387   #ifndef DISABLE_DKIM
 388   ,vtype_dkim           /* Lookup of value in DKIM signature */
 389   #endif
 390   };
 391
 392 static uschar * fn_recipients(void);
 393
 394 /* This table must be kept in alphabetical order. */
 395
 396 static var_entry var_table[] = {
 397   /* WARNING: Do not invent variables whose names start acl_c or acl_m because
 398      they will be confused with user-creatable ACL variables. */
 399   { "acl_arg1",            vtype_stringptr,   &acl_arg[0] },
 400   { "acl_arg2",            vtype_stringptr,   &acl_arg[1] },
 401   { "acl_arg3",            vtype_stringptr,   &acl_arg[2] },
 402   { "acl_arg4",            vtype_stringptr,   &acl_arg[3] },
 403   { "acl_arg5",            vtype_stringptr,   &acl_arg[4] },
 404   { "acl_arg6",            vtype_stringptr,   &acl_arg[5] },
 405   { "acl_arg7",            vtype_stringptr,   &acl_arg[6] },
 406   { "acl_arg8",            vtype_stringptr,   &acl_arg[7] },
 407   { "acl_arg9",            vtype_stringptr,   &acl_arg[8] },
 408   { "acl_narg",            vtype_int,         &acl_narg },
 409   { "acl_verify_message",  vtype_stringptr,   &acl_verify_message },
 410   { "address_data",        vtype_stringptr,   &deliver_address_data },
 411   { "address_file",        vtype_stringptr,   &address_file },
 412   { "address_pipe",        vtype_stringptr,   &address_pipe },
 413   { "authenticated_id",    vtype_stringptr,   &authenticated_id },
 414   { "authenticated_sender",vtype_stringptr,   &authenticated_sender },
 415   { "authentication_failed",vtype_int,        &authentication_failed },
 416 #ifdef WITH_CONTENT_SCAN
 417   { "av_failed",           vtype_int,         &av_failed },
 418 #endif
 419 #ifdef EXPERIMENTAL_BRIGHTMAIL
 420   { "bmi_alt_location",    vtype_stringptr,   &bmi_alt_location },
 421   { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
 422   { "bmi_base64_verdict",  vtype_stringptr,   &bmi_base64_verdict },
 423   { "bmi_deliver",         vtype_int,         &bmi_deliver },
 424 #endif
 425   { "body_linecount",      vtype_int,         &body_linecount },
 426   { "body_zerocount",      vtype_int,         &body_zerocount },
 427   { "bounce_recipient",    vtype_stringptr,   &bounce_recipient },
 428   { "bounce_return_size_limit", vtype_int,    &bounce_return_size_limit },
 429   { "caller_gid",          vtype_gid,         &real_gid },
 430   { "caller_uid",          vtype_uid,         &real_uid },
 431   { "compile_date",        vtype_stringptr,   &version_date },
 432   { "compile_number",      vtype_stringptr,   &version_cnumber },
 433   { "csa_status",          vtype_stringptr,   &csa_status },
 434 #ifdef EXPERIMENTAL_DCC
 435   { "dcc_header",          vtype_stringptr,   &dcc_header },
 436   { "dcc_result",          vtype_stringptr,   &dcc_result },
 437 #endif
 438 #ifdef WITH_OLD_DEMIME
 439   { "demime_errorlevel",   vtype_int,         &demime_errorlevel },
 440   { "demime_reason",       vtype_stringptr,   &demime_reason },
 441 #endif
 442 #ifndef DISABLE_DKIM
 443   { "dkim_algo",           vtype_dkim,        (void *)DKIM_ALGO },
 444   { "dkim_bodylength",     vtype_dkim,        (void *)DKIM_BODYLENGTH },
 445   { "dkim_canon_body",     vtype_dkim,        (void *)DKIM_CANON_BODY },
 446   { "dkim_canon_headers",  vtype_dkim,        (void *)DKIM_CANON_HEADERS },
 447   { "dkim_copiedheaders",  vtype_dkim,        (void *)DKIM_COPIEDHEADERS },
 448   { "dkim_created",        vtype_dkim,        (void *)DKIM_CREATED },
 449   { "dkim_cur_signer",     vtype_stringptr,   &dkim_cur_signer },
 450   { "dkim_domain",         vtype_stringptr,   &dkim_signing_domain },
 451   { "dkim_expires",        vtype_dkim,        (void *)DKIM_EXPIRES },
 452   { "dkim_headernames",    vtype_dkim,        (void *)DKIM_HEADERNAMES },
 453   { "dkim_identity",       vtype_dkim,        (void *)DKIM_IDENTITY },
 454   { "dkim_key_granularity",vtype_dkim,        (void *)DKIM_KEY_GRANULARITY },
 455   { "dkim_key_nosubdomains",vtype_dkim,       (void *)DKIM_NOSUBDOMAINS },
 456   { "dkim_key_notes",      vtype_dkim,        (void *)DKIM_KEY_NOTES },
 457   { "dkim_key_srvtype",    vtype_dkim,        (void *)DKIM_KEY_SRVTYPE },
 458   { "dkim_key_testing",    vtype_dkim,        (void *)DKIM_KEY_TESTING },
 459   { "dkim_selector",       vtype_stringptr,   &dkim_signing_selector },
 460   { "dkim_signers",        vtype_stringptr,   &dkim_signers },
 461   { "dkim_verify_reason",  vtype_dkim,        (void *)DKIM_VERIFY_REASON },
 462   { "dkim_verify_status",  vtype_dkim,        (void *)DKIM_VERIFY_STATUS},
 463 #endif
 464 #ifdef EXPERIMENTAL_DMARC
 465   { "dmarc_ar_header",     vtype_stringptr,   &dmarc_ar_header },
 466   { "dmarc_status",        vtype_stringptr,   &dmarc_status },
 467   { "dmarc_status_text",   vtype_stringptr,   &dmarc_status_text },
 468   { "dmarc_used_domain",   vtype_stringptr,   &dmarc_used_domain },
 469 #endif
 470   { "dnslist_domain",      vtype_stringptr,   &dnslist_domain },
 471   { "dnslist_matched",     vtype_stringptr,   &dnslist_matched },
 472   { "dnslist_text",        vtype_stringptr,   &dnslist_text },
 473   { "dnslist_value",       vtype_stringptr,   &dnslist_value },
 474   { "domain",              vtype_stringptr,   &deliver_domain },
 475   { "domain_data",         vtype_stringptr,   &deliver_domain_data },
 476   { "exim_gid",            vtype_gid,         &exim_gid },
 477   { "exim_path",           vtype_stringptr,   &exim_path },
 478   { "exim_uid",            vtype_uid,         &exim_uid },
 479 #ifdef WITH_OLD_DEMIME
 480   { "found_extension",     vtype_stringptr,   &found_extension },
 481 #endif
 482   { "headers_added",       vtype_string_func, &fn_hdrs_added },
 483   { "home",                vtype_stringptr,   &deliver_home },
 484   { "host",                vtype_stringptr,   &deliver_host },
 485   { "host_address",        vtype_stringptr,   &deliver_host_address },
 486   { "host_data",           vtype_stringptr,   &host_data },
 487   { "host_lookup_deferred",vtype_int,         &host_lookup_deferred },
 488   { "host_lookup_failed",  vtype_int,         &host_lookup_failed },
 489   { "inode",               vtype_ino,         &deliver_inode },
 490   { "interface_address",   vtype_stringptr,   &interface_address },
 491   { "interface_port",      vtype_int,         &interface_port },
 492   { "item",                vtype_stringptr,   &iterate_item },
 493   #ifdef LOOKUP_LDAP
 494   { "ldap_dn",             vtype_stringptr,   &eldap_dn },
 495   #endif
 496   { "load_average",        vtype_load_avg,    NULL },
 497   { "local_part",          vtype_stringptr,   &deliver_localpart },
 498   { "local_part_data",     vtype_stringptr,   &deliver_localpart_data },
 499   { "local_part_prefix",   vtype_stringptr,   &deliver_localpart_prefix },
 500   { "local_part_suffix",   vtype_stringptr,   &deliver_localpart_suffix },
 501   { "local_scan_data",     vtype_stringptr,   &local_scan_data },
 502   { "local_user_gid",      vtype_gid,         &local_user_gid },
 503   { "local_user_uid",      vtype_uid,         &local_user_uid },
 504   { "localhost_number",    vtype_int,         &host_number },
 505   { "log_inodes",          vtype_pinodes,     (void *)FALSE },
 506   { "log_space",           vtype_pspace,      (void *)FALSE },
 507   { "mailstore_basename",  vtype_stringptr,   &mailstore_basename },
 508 #ifdef WITH_CONTENT_SCAN
 509   { "malware_name",        vtype_stringptr,   &malware_name },
 510 #endif
 511   { "max_received_linelength", vtype_int,     &max_received_linelength },
 512   { "message_age",         vtype_int,         &message_age },
 513   { "message_body",        vtype_msgbody,     &message_body },
 514   { "message_body_end",    vtype_msgbody_end, &message_body_end },
 515   { "message_body_size",   vtype_int,         &message_body_size },
 516   { "message_exim_id",     vtype_stringptr,   &message_id },
 517   { "message_headers",     vtype_msgheaders,  NULL },
 518   { "message_headers_raw", vtype_msgheaders_raw, NULL },
 519   { "message_id",          vtype_stringptr,   &message_id },
 520   { "message_linecount",   vtype_int,         &message_linecount },
 521   { "message_size",        vtype_int,         &message_size },
 522 #ifdef WITH_CONTENT_SCAN
 523   { "mime_anomaly_level",  vtype_int,         &mime_anomaly_level },
 524   { "mime_anomaly_text",   vtype_stringptr,   &mime_anomaly_text },
 525   { "mime_boundary",       vtype_stringptr,   &mime_boundary },
 526   { "mime_charset",        vtype_stringptr,   &mime_charset },
 527   { "mime_content_description", vtype_stringptr, &mime_content_description },
 528   { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
 529   { "mime_content_id",     vtype_stringptr,   &mime_content_id },
 530   { "mime_content_size",   vtype_int,         &mime_content_size },
 531   { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
 532   { "mime_content_type",   vtype_stringptr,   &mime_content_type },
 533   { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
 534   { "mime_filename",       vtype_stringptr,   &mime_filename },
 535   { "mime_is_coverletter", vtype_int,         &mime_is_coverletter },
 536   { "mime_is_multipart",   vtype_int,         &mime_is_multipart },
 537   { "mime_is_rfc822",      vtype_int,         &mime_is_rfc822 },
 538   { "mime_part_count",     vtype_int,         &mime_part_count },
 539 #endif
 540   { "n0",                  vtype_filter_int,  &filter_n[0] },
 541   { "n1",                  vtype_filter_int,  &filter_n[1] },
 542   { "n2",                  vtype_filter_int,  &filter_n[2] },
 543   { "n3",                  vtype_filter_int,  &filter_n[3] },
 544   { "n4",                  vtype_filter_int,  &filter_n[4] },
 545   { "n5",                  vtype_filter_int,  &filter_n[5] },
 546   { "n6",                  vtype_filter_int,  &filter_n[6] },
 547   { "n7",                  vtype_filter_int,  &filter_n[7] },
 548   { "n8",                  vtype_filter_int,  &filter_n[8] },
 549   { "n9",                  vtype_filter_int,  &filter_n[9] },
 550   { "original_domain",     vtype_stringptr,   &deliver_domain_orig },
 551   { "original_local_part", vtype_stringptr,   &deliver_localpart_orig },
 552   { "originator_gid",      vtype_gid,         &originator_gid },
 553   { "originator_uid",      vtype_uid,         &originator_uid },
 554   { "parent_domain",       vtype_stringptr,   &deliver_domain_parent },
 555   { "parent_local_part",   vtype_stringptr,   &deliver_localpart_parent },
 556   { "pid",                 vtype_pid,         NULL },
 557   { "primary_hostname",    vtype_stringptr,   &primary_hostname },
 558   { "prvscheck_address",   vtype_stringptr,   &prvscheck_address },
 559   { "prvscheck_keynum",    vtype_stringptr,   &prvscheck_keynum },
 560   { "prvscheck_result",    vtype_stringptr,   &prvscheck_result },
 561   { "qualify_domain",      vtype_stringptr,   &qualify_domain_sender },
 562   { "qualify_recipient",   vtype_stringptr,   &qualify_domain_recipient },
 563   { "rcpt_count",          vtype_int,         &rcpt_count },
 564   { "rcpt_defer_count",    vtype_int,         &rcpt_defer_count },
 565   { "rcpt_fail_count",     vtype_int,         &rcpt_fail_count },
 566   { "received_count",      vtype_int,         &received_count },
 567   { "received_for",        vtype_stringptr,   &received_for },
 568   { "received_ip_address", vtype_stringptr,   &interface_address },
 569   { "received_port",       vtype_int,         &interface_port },
 570   { "received_protocol",   vtype_stringptr,   &received_protocol },
 571   { "received_time",       vtype_int,         &received_time },
 572   { "recipient_data",      vtype_stringptr,   &recipient_data },
 573   { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
 574   { "recipients",          vtype_string_func, &fn_recipients },
 575   { "recipients_count",    vtype_int,         &recipients_count },
 576 #ifdef WITH_CONTENT_SCAN
 577   { "regex_match_string",  vtype_stringptr,   &regex_match_string },
 578 #endif
 579   { "reply_address",       vtype_reply,       NULL },
 580   { "return_path",         vtype_stringptr,   &return_path },
 581   { "return_size_limit",   vtype_int,         &bounce_return_size_limit },
 582   { "router_name",         vtype_stringptr,   &router_name },
 583   { "runrc",               vtype_int,         &runrc },
 584   { "self_hostname",       vtype_stringptr,   &self_hostname },
 585   { "sender_address",      vtype_stringptr,   &sender_address },
 586   { "sender_address_data", vtype_stringptr,   &sender_address_data },
 587   { "sender_address_domain", vtype_domain,    &sender_address },
 588   { "sender_address_local_part", vtype_localpart, &sender_address },
 589   { "sender_data",         vtype_stringptr,   &sender_data },
 590   { "sender_fullhost",     vtype_stringptr,   &sender_fullhost },
 591   { "sender_helo_name",    vtype_stringptr,   &sender_helo_name },
 592   { "sender_host_address", vtype_stringptr,   &sender_host_address },
 593   { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
 594   { "sender_host_dnssec",  vtype_bool,        &sender_host_dnssec },
 595   { "sender_host_name",    vtype_host_lookup, NULL },
 596   { "sender_host_port",    vtype_int,         &sender_host_port },
 597   { "sender_ident",        vtype_stringptr,   &sender_ident },
 598   { "sender_rate",         vtype_stringptr,   &sender_rate },
 599   { "sender_rate_limit",   vtype_stringptr,   &sender_rate_limit },
 600   { "sender_rate_period",  vtype_stringptr,   &sender_rate_period },
 601   { "sender_rcvhost",      vtype_stringptr,   &sender_rcvhost },
 602   { "sender_verify_failure",vtype_stringptr,  &sender_verify_failure },
 603   { "sending_ip_address",  vtype_stringptr,   &sending_ip_address },
 604   { "sending_port",        vtype_int,         &sending_port },
 605   { "smtp_active_hostname", vtype_stringptr,  &smtp_active_hostname },
 606   { "smtp_command",        vtype_stringptr,   &smtp_cmd_buffer },
 607   { "smtp_command_argument", vtype_stringptr, &smtp_cmd_argument },
 608   { "smtp_count_at_connection_start", vtype_int, &smtp_accept_count },
 609   { "smtp_notquit_reason", vtype_stringptr,   &smtp_notquit_reason },
 610   { "sn0",                 vtype_filter_int,  &filter_sn[0] },
 611   { "sn1",                 vtype_filter_int,  &filter_sn[1] },
 612   { "sn2",                 vtype_filter_int,  &filter_sn[2] },
 613   { "sn3",                 vtype_filter_int,  &filter_sn[3] },
 614   { "sn4",                 vtype_filter_int,  &filter_sn[4] },
 615   { "sn5",                 vtype_filter_int,  &filter_sn[5] },
 616   { "sn6",                 vtype_filter_int,  &filter_sn[6] },
 617   { "sn7",                 vtype_filter_int,  &filter_sn[7] },
 618   { "sn8",                 vtype_filter_int,  &filter_sn[8] },
 619   { "sn9",                 vtype_filter_int,  &filter_sn[9] },
 620 #ifdef WITH_CONTENT_SCAN
 621   { "spam_bar",            vtype_stringptr,   &spam_bar },
 622   { "spam_report",         vtype_stringptr,   &spam_report },
 623   { "spam_score",          vtype_stringptr,   &spam_score },
 624   { "spam_score_int",      vtype_stringptr,   &spam_score_int },
 625 #endif
 626 #ifdef EXPERIMENTAL_SPF
 627   { "spf_guess",           vtype_stringptr,   &spf_guess },
 628   { "spf_header_comment",  vtype_stringptr,   &spf_header_comment },
 629   { "spf_received",        vtype_stringptr,   &spf_received },
 630   { "spf_result",          vtype_stringptr,   &spf_result },
 631   { "spf_smtp_comment",    vtype_stringptr,   &spf_smtp_comment },
 632 #endif
 633   { "spool_directory",     vtype_stringptr,   &spool_directory },
 634   { "spool_inodes",        vtype_pinodes,     (void *)TRUE },
 635   { "spool_space",         vtype_pspace,      (void *)TRUE },
 636 #ifdef EXPERIMENTAL_SRS
 637   { "srs_db_address",      vtype_stringptr,   &srs_db_address },
 638   { "srs_db_key",          vtype_stringptr,   &srs_db_key },
 639   { "srs_orig_recipient",  vtype_stringptr,   &srs_orig_recipient },
 640   { "srs_orig_sender",     vtype_stringptr,   &srs_orig_sender },
 641   { "srs_recipient",       vtype_stringptr,   &srs_recipient },
 642   { "srs_status",          vtype_stringptr,   &srs_status },
 643 #endif
 644   { "thisaddress",         vtype_stringptr,   &filter_thisaddress },
 645
 646   /* The non-(in,out) variables are now deprecated */
 647   { "tls_bits",            vtype_int,         &tls_in.bits },
 648   { "tls_certificate_verified", vtype_int,    &tls_in.certificate_verified },
 649   { "tls_cipher",          vtype_stringptr,   &tls_in.cipher },
 650
 651   { "tls_in_bits",         vtype_int,         &tls_in.bits },
 652   { "tls_in_certificate_verified", vtype_int, &tls_in.certificate_verified },
 653   { "tls_in_cipher",       vtype_stringptr,   &tls_in.cipher },
 654   { "tls_in_peerdn",       vtype_stringptr,   &tls_in.peerdn },
 655 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
 656   { "tls_in_sni",          vtype_stringptr,   &tls_in.sni },
 657 #endif
 658   { "tls_out_bits",        vtype_int,         &tls_out.bits },
 659   { "tls_out_certificate_verified", vtype_int,&tls_out.certificate_verified },
 660   { "tls_out_cipher",      vtype_stringptr,   &tls_out.cipher },
 661   { "tls_out_peerdn",      vtype_stringptr,   &tls_out.peerdn },
 662 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
 663   { "tls_out_sni",         vtype_stringptr,   &tls_out.sni },
 664 #endif
 665
 666   { "tls_peerdn",          vtype_stringptr,   &tls_in.peerdn }, /* mind the alphabetical order! */
 667 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
 668   { "tls_sni",             vtype_stringptr,   &tls_in.sni },    /* mind the alphabetical order! */
 669 #endif
 670
 671   { "tod_bsdinbox",        vtype_todbsdin,    NULL },
 672   { "tod_epoch",           vtype_tode,        NULL },
 673   { "tod_epoch_l",         vtype_todel,       NULL },
 674   { "tod_full",            vtype_todf,        NULL },
 675   { "tod_log",             vtype_todl,        NULL },
 676   { "tod_logfile",         vtype_todlf,       NULL },
 677   { "tod_zone",            vtype_todzone,     NULL },
 678   { "tod_zulu",            vtype_todzulu,     NULL },
 679 #ifdef EXPERIMENTAL_TPDA
 680   { "tpda_defer_errno",     vtype_int,         &tpda_defer_errno },
 681   { "tpda_defer_errstr",    vtype_stringptr,   &tpda_defer_errstr },
 682   { "tpda_delivery_confirmation", vtype_stringptr,   &tpda_delivery_confirmation },
 683   { "tpda_delivery_domain", vtype_stringptr,   &tpda_delivery_domain },
 684   { "tpda_delivery_fqdn",   vtype_stringptr,   &tpda_delivery_fqdn },
 685   { "tpda_delivery_ip",     vtype_stringptr,   &tpda_delivery_ip },
 686   { "tpda_delivery_local_part",vtype_stringptr,&tpda_delivery_local_part },
 687   { "tpda_delivery_port",   vtype_int,         &tpda_delivery_port },
 688 #endif
 689   { "transport_name",      vtype_stringptr,   &transport_name },
 690   { "value",               vtype_stringptr,   &lookup_value },
 691   { "version_number",      vtype_stringptr,   &version_string },
 692   { "warn_message_delay",  vtype_stringptr,   &warnmsg_delay },
 693   { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
 694   { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
 695   { "warnmsg_delay",       vtype_stringptr,   &warnmsg_delay },
 696   { "warnmsg_recipient",   vtype_stringptr,   &warnmsg_recipients },
 697   { "warnmsg_recipients",  vtype_stringptr,   &warnmsg_recipients }
 698 };
 699
 700 static int var_table_size = sizeof(var_table)/sizeof(var_entry);
 701 static uschar var_buffer[256];
 702 static BOOL malformed_header;
 703
 704 /* For textual hashes */
 705
 706 static const char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
 707                                "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
 708                                "0123456789";
 709
 710 enum { HMAC_MD5, HMAC_SHA1 };
 711
 712 /* For numeric hashes */
 713
 714 static unsigned int prime[] = {
 715   2,   3,   5,   7,  11,  13,  17,  19,  23,  29,
 716  31,  37,  41,  43,  47,  53,  59,  61,  67,  71,
 717  73,  79,  83,  89,  97, 101, 103, 107, 109, 113};
 718
 719 /* For printing modes in symbolic form */
 720
 721 static uschar *mtable_normal[] =
 722   { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
 723
 724 static uschar *mtable_setid[] =
 725   { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
 726
 727 static uschar *mtable_sticky[] =
 728   { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
 729
 730
 731
 732 /*************************************************
 733 *           Tables for UTF-8 support             *
 734 *************************************************/
 735
 736 /* Table of the number of extra characters, indexed by the first character
 737 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
 738 0x3d. */
 739
 740 static uschar utf8_table1[] = {
 741   1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
 742   1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
 743   2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
 744   3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
 745
 746 /* These are the masks for the data bits in the first byte of a character,
 747 indexed by the number of additional bytes. */
 748
 749 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
 750
 751 /* Get the next UTF-8 character, advancing the pointer. */
 752
 753 #define GETUTF8INC(c, ptr) \
 754   c = *ptr++; \
 755   if ((c & 0xc0) == 0xc0) \
 756     { \
 757     int a = utf8_table1[c & 0x3f];  /* Number of additional bytes */ \
 758     int s = 6*a; \
 759     c = (c & utf8_table2[a]) << s; \
 760     while (a-- > 0) \
 761       { \
 762       s -= 6; \
 763       c |= (*ptr++ & 0x3f) << s; \
 764       } \
 765     }
 766
 767
 768 /*************************************************
 769 *           Binary chop search on a table        *
 770 *************************************************/
 771
 772 /* This is used for matching expansion items and operators.
 773
 774 Arguments:
 775   name        the name that is being sought
 776   table       the table to search
 777   table_size  the number of items in the table
 778
 779 Returns:      the offset in the table, or -1
 780 */
 781
 782 static int
 783 chop_match(uschar *name, uschar **table, int table_size)
 784 {
 785 uschar **bot = table;
 786 uschar **top = table + table_size;
 787
 788 while (top > bot)
 789   {
 790   uschar **mid = bot + (top - bot)/2;
 791   int c = Ustrcmp(name, *mid);
 792   if (c == 0) return mid - table;
 793   if (c > 0) bot = mid + 1; else top = mid;
 794   }
 795
 796 return -1;
 797 }
 798
 799
 800
 801 /*************************************************
 802 *          Check a condition string              *
 803 *************************************************/
 804
 805 /* This function is called to expand a string, and test the result for a "true"
 806 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
 807 forced fail or lookup defer.
 808
 809 We used to release all store used, but this is not not safe due
 810 to ${dlfunc } and ${acl }.  In any case expand_string_internal()
 811 is reasonably careful to release what it can.
 812
 813 The actual false-value tests should be replicated for ECOND_BOOL_LAX.
 814
 815 Arguments:
 816   condition     the condition string
 817   m1            text to be incorporated in panic error
 818   m2            ditto
 819
 820 Returns:        TRUE if condition is met, FALSE if not
 821 */
 822
 823 BOOL
 824 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
 825 {
 826 int rc;
 827 uschar *ss = expand_string(condition);
 828 if (ss == NULL)
 829   {
 830   if (!expand_string_forcedfail && !search_find_defer)
 831     log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
 832       "for %s %s: %s", condition, m1, m2, expand_string_message);
 833   return FALSE;
 834   }
 835 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
 836   strcmpic(ss, US"false") != 0;
 837 return rc;
 838 }
 839
 840
 841
 842
 843 /*************************************************
 844 *        Pseudo-random number generation         *
 845 *************************************************/
 846
 847 /* Pseudo-random number generation.  The result is not "expected" to be
 848 cryptographically strong but not so weak that someone will shoot themselves
 849 in the foot using it as a nonce in some email header scheme or whatever
 850 weirdness they'll twist this into.  The result should ideally handle fork().
 851
 852 However, if we're stuck unable to provide this, then we'll fall back to
 853 appallingly bad randomness.
 854
 855 If SUPPORT_TLS is defined then this will not be used except as an emergency
 856 fallback.
 857
 858 Arguments:
 859   max       range maximum
 860 Returns     a random number in range [0, max-1]
 861 */
 862
 863 #ifdef SUPPORT_TLS
 864 # define vaguely_random_number vaguely_random_number_fallback
 865 #endif
 866 int
 867 vaguely_random_number(int max)
 868 {
 869 #ifdef SUPPORT_TLS
 870 # undef vaguely_random_number
 871 #endif
 872   static pid_t pid = 0;
 873   pid_t p2;
 874 #if defined(HAVE_SRANDOM) && !defined(HAVE_SRANDOMDEV)
 875   struct timeval tv;
 876 #endif
 877
 878   p2 = getpid();
 879   if (p2 != pid)
 880     {
 881     if (pid != 0)
 882       {
 883
 884 #ifdef HAVE_ARC4RANDOM
 885       /* cryptographically strong randomness, common on *BSD platforms, not
 886       so much elsewhere.  Alas. */
 887       arc4random_stir();
 888 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
 889 #ifdef HAVE_SRANDOMDEV
 890       /* uses random(4) for seeding */
 891       srandomdev();
 892 #else
 893       gettimeofday(&tv, NULL);
 894       srandom(tv.tv_sec | tv.tv_usec | getpid());
 895 #endif
 896 #else
 897       /* Poor randomness and no seeding here */
 898 #endif
 899
 900       }
 901     pid = p2;
 902     }
 903
 904 #ifdef HAVE_ARC4RANDOM
 905   return arc4random() % max;
 906 #elif defined(HAVE_SRANDOM) || defined(HAVE_SRANDOMDEV)
 907   return random() % max;
 908 #else
 909   /* This one returns a 16-bit number, definitely not crypto-strong */
 910   return random_number(max);
 911 #endif
 912 }
 913
 914
 915
 916
 917 /*************************************************
 918 *             Pick out a name from a string      *
 919 *************************************************/
 920
 921 /* If the name is too long, it is silently truncated.
 922
 923 Arguments:
 924   name      points to a buffer into which to put the name
 925   max       is the length of the buffer
 926   s         points to the first alphabetic character of the name
 927   extras    chars other than alphanumerics to permit
 928
 929 Returns:    pointer to the first character after the name
 930
 931 Note: The test for *s != 0 in the while loop is necessary because
 932 Ustrchr() yields non-NULL if the character is zero (which is not something
 933 I expected). */
 934
 935 static uschar *
 936 read_name(uschar *name, int max, uschar *s, uschar *extras)
 937 {
 938 int ptr = 0;
 939 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
 940   {
 941   if (ptr < max-1) name[ptr++] = *s;
 942   s++;
 943   }
 944 name[ptr] = 0;
 945 return s;
 946 }
 947
 948
 949
 950 /*************************************************
 951 *     Pick out the rest of a header name         *
 952 *************************************************/
 953
 954 /* A variable name starting $header_ (or just $h_ for those who like
 955 abbreviations) might not be the complete header name because headers can
 956 contain any printing characters in their names, except ':'. This function is
 957 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
 958 on the end, if the name was terminated by white space.
 959
 960 Arguments:
 961   name      points to a buffer in which the name read so far exists
 962   max       is the length of the buffer
 963   s         points to the first character after the name so far, i.e. the
 964             first non-alphameric character after $header_xxxxx
 965
 966 Returns:    a pointer to the first character after the header name
 967 */
 968
 969 static uschar *
 970 read_header_name(uschar *name, int max, uschar *s)
 971 {
 972 int prelen = Ustrchr(name, '_') - name + 1;
 973 int ptr = Ustrlen(name) - prelen;
 974 if (ptr > 0) memmove(name, name+prelen, ptr);
 975 while (mac_isgraph(*s) && *s != ':')
 976   {
 977   if (ptr < max-1) name[ptr++] = *s;
 978   s++;
 979   }
 980 if (*s == ':') s++;
 981 name[ptr++] = ':';
 982 name[ptr] = 0;
 983 return s;
 984 }
 985
 986
 987
 988 /*************************************************
 989 *           Pick out a number from a string      *
 990 *************************************************/
 991
 992 /* Arguments:
 993   n     points to an integer into which to put the number
 994   s     points to the first digit of the number
 995
 996 Returns:  a pointer to the character after the last digit
 997 */
 998
 999 static uschar *
1000 read_number(int *n, uschar *s)
1001 {
1002 *n = 0;
1003 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
1004 return s;
1005 }
1006
1007
1008
1009 /*************************************************
1010 *        Extract keyed subfield from a string    *
1011 *************************************************/
1012
1013 /* The yield is in dynamic store; NULL means that the key was not found.
1014
1015 Arguments:
1016   key       points to the name of the key
1017   s         points to the string from which to extract the subfield
1018
1019 Returns:    NULL if the subfield was not found, or
1020             a pointer to the subfield's data
1021 */
1022
1023 static uschar *
1024 expand_getkeyed(uschar *key, uschar *s)
1025 {
1026 int length = Ustrlen(key);
1027 while (isspace(*s)) s++;
1028
1029 /* Loop to search for the key */
1030
1031 while (*s != 0)
1032   {
1033   int dkeylength;
1034   uschar *data;
1035   uschar *dkey = s;
1036
1037   while (*s != 0 && *s != '=' && !isspace(*s)) s++;
1038   dkeylength = s - dkey;
1039   while (isspace(*s)) s++;
1040   if (*s == '=') while (isspace((*(++s))));
1041
1042   data = string_dequote(&s);
1043   if (length == dkeylength && strncmpic(key, dkey, length) == 0)
1044     return data;
1045
1046   while (isspace(*s)) s++;
1047   }
1048
1049 return NULL;
1050 }
1051
1052
1053
1054
1055 /*************************************************
1056 *   Extract numbered subfield from string        *
1057 *************************************************/
1058
1059 /* Extracts a numbered field from a string that is divided by tokens - for
1060 example a line from /etc/passwd is divided by colon characters.  First field is
1061 numbered one.  Negative arguments count from the right. Zero returns the whole
1062 string. Returns NULL if there are insufficient tokens in the string
1063
1064 ***WARNING***
1065 Modifies final argument - this is a dynamically generated string, so that's OK.
1066
1067 Arguments:
1068   field       number of field to be extracted,
1069                 first field = 1, whole string = 0, last field = -1
1070   separators  characters that are used to break string into tokens
1071   s           points to the string from which to extract the subfield
1072
1073 Returns:      NULL if the field was not found,
1074               a pointer to the field's data inside s (modified to add 0)
1075 */
1076
1077 static uschar *
1078 expand_gettokened (int field, uschar *separators, uschar *s)
1079 {
1080 int sep = 1;
1081 int count;
1082 uschar *ss = s;
1083 uschar *fieldtext = NULL;
1084
1085 if (field == 0) return s;
1086
1087 /* Break the line up into fields in place; for field > 0 we stop when we have
1088 done the number of fields we want. For field < 0 we continue till the end of
1089 the string, counting the number of fields. */
1090
1091 count = (field > 0)? field : INT_MAX;
1092
1093 while (count-- > 0)
1094   {
1095   size_t len;
1096
1097   /* Previous field was the last one in the string. For a positive field
1098   number, this means there are not enough fields. For a negative field number,
1099   check that there are enough, and scan back to find the one that is wanted. */
1100
1101   if (sep == 0)
1102     {
1103     if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
1104     if ((-field) == (INT_MAX - count - 1)) return s;
1105     while (field++ < 0)
1106       {
1107       ss--;
1108       while (ss[-1] != 0) ss--;
1109       }
1110     fieldtext = ss;
1111     break;
1112     }
1113
1114   /* Previous field was not last in the string; save its start and put a
1115   zero at its end. */
1116
1117   fieldtext = ss;
1118   len = Ustrcspn(ss, separators);
1119   sep = ss[len];
1120   ss[len] = 0;
1121   ss += len + 1;
1122   }
1123
1124 return fieldtext;
1125 }
1126
1127
1128
1129 /*************************************************
1130 *        Extract a substring from a string       *
1131 *************************************************/
1132
1133 /* Perform the ${substr or ${length expansion operations.
1134
1135 Arguments:
1136   subject     the input string
1137   value1      the offset from the start of the input string to the start of
1138                 the output string; if negative, count from the right.
1139   value2      the length of the output string, or negative (-1) for unset
1140                 if value1 is positive, unset means "all after"
1141                 if value1 is negative, unset means "all before"
1142   len         set to the length of the returned string
1143
1144 Returns:      pointer to the output string, or NULL if there is an error
1145 */
1146
1147 static uschar *
1148 extract_substr(uschar *subject, int value1, int value2, int *len)
1149 {
1150 int sublen = Ustrlen(subject);
1151
1152 if (value1 < 0)    /* count from right */
1153   {
1154   value1 += sublen;
1155
1156   /* If the position is before the start, skip to the start, and adjust the
1157   length. If the length ends up negative, the substring is null because nothing
1158   can precede. This falls out naturally when the length is unset, meaning "all
1159   to the left". */
1160
1161   if (value1 < 0)
1162     {
1163     value2 += value1;
1164     if (value2 < 0) value2 = 0;
1165     value1 = 0;
1166     }
1167
1168   /* Otherwise an unset length => characters before value1 */
1169
1170   else if (value2 < 0)
1171     {
1172     value2 = value1;
1173     value1 = 0;
1174     }
1175   }
1176
1177 /* For a non-negative offset, if the starting position is past the end of the
1178 string, the result will be the null string. Otherwise, an unset length means
1179 "rest"; just set it to the maximum - it will be cut down below if necessary. */
1180
1181 else
1182   {
1183   if (value1 > sublen)
1184     {
1185     value1 = sublen;
1186     value2 = 0;
1187     }
1188   else if (value2 < 0) value2 = sublen;
1189   }
1190
1191 /* Cut the length down to the maximum possible for the offset value, and get
1192 the required characters. */
1193
1194 if (value1 + value2 > sublen) value2 = sublen - value1;
1195 *len = value2;
1196 return subject + value1;
1197 }
1198
1199
1200
1201
1202 /*************************************************
1203 *            Old-style hash of a string          *
1204 *************************************************/
1205
1206 /* Perform the ${hash expansion operation.
1207
1208 Arguments:
1209   subject     the input string (an expanded substring)
1210   value1      the length of the output string; if greater or equal to the
1211                 length of the input string, the input string is returned
1212   value2      the number of hash characters to use, or 26 if negative
1213   len         set to the length of the returned string
1214
1215 Returns:      pointer to the output string, or NULL if there is an error
1216 */
1217
1218 static uschar *
1219 compute_hash(uschar *subject, int value1, int value2, int *len)
1220 {
1221 int sublen = Ustrlen(subject);
1222
1223 if (value2 < 0) value2 = 26;
1224 else if (value2 > Ustrlen(hashcodes))
1225   {
1226   expand_string_message =
1227     string_sprintf("hash count \"%d\" too big", value2);
1228   return NULL;
1229   }
1230
1231 /* Calculate the hash text. We know it is shorter than the original string, so
1232 can safely place it in subject[] (we know that subject is always itself an
1233 expanded substring). */
1234
1235 if (value1 < sublen)
1236   {
1237   int c;
1238   int i = 0;
1239   int j = value1;
1240   while ((c = (subject[j])) != 0)
1241     {
1242     int shift = (c + j++) & 7;
1243     subject[i] ^= (c << shift) | (c >> (8-shift));
1244     if (++i >= value1) i = 0;
1245     }
1246   for (i = 0; i < value1; i++)
1247     subject[i] = hashcodes[(subject[i]) % value2];
1248   }
1249 else value1 = sublen;
1250
1251 *len = value1;
1252 return subject;
1253 }
1254
1255
1256
1257
1258 /*************************************************
1259 *             Numeric hash of a string           *
1260 *************************************************/
1261
1262 /* Perform the ${nhash expansion operation. The first characters of the
1263 string are treated as most important, and get the highest prime numbers.
1264
1265 Arguments:
1266   subject     the input string
1267   value1      the maximum value of the first part of the result
1268   value2      the maximum value of the second part of the result,
1269                 or negative to produce only a one-part result
1270   len         set to the length of the returned string
1271
1272 Returns:  pointer to the output string, or NULL if there is an error.
1273 */
1274
1275 static uschar *
1276 compute_nhash (uschar *subject, int value1, int value2, int *len)
1277 {
1278 uschar *s = subject;
1279 int i = 0;
1280 unsigned long int total = 0; /* no overflow */
1281
1282 while (*s != 0)
1283   {
1284   if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
1285   total += prime[i--] * (unsigned int)(*s++);
1286   }
1287
1288 /* If value2 is unset, just compute one number */
1289
1290 if (value2 < 0)
1291   {
1292   s = string_sprintf("%d", total % value1);
1293   }
1294
1295 /* Otherwise do a div/mod hash */
1296
1297 else
1298   {
1299   total = total % (value1 * value2);
1300   s = string_sprintf("%d/%d", total/value2, total % value2);
1301   }
1302
1303 *len = Ustrlen(s);
1304 return s;
1305 }
1306
1307
1308
1309
1310
1311 /*************************************************
1312 *     Find the value of a header or headers      *
1313 *************************************************/
1314
1315 /* Multiple instances of the same header get concatenated, and this function
1316 can also return a concatenation of all the header lines. When concatenating
1317 specific headers that contain lists of addresses, a comma is inserted between
1318 them. Otherwise we use a straight concatenation. Because some messages can have
1319 pathologically large number of lines, there is a limit on the length that is
1320 returned. Also, to avoid massive store use which would result from using
1321 string_cat() as it copies and extends strings, we do a preliminary pass to find
1322 out exactly how much store will be needed. On "normal" messages this will be
1323 pretty trivial.
1324
1325 Arguments:
1326   name          the name of the header, without the leading $header_ or $h_,
1327                 or NULL if a concatenation of all headers is required
1328   exists_only   TRUE if called from a def: test; don't need to build a string;
1329                 just return a string that is not "" and not "0" if the header
1330                 exists
1331   newsize       return the size of memory block that was obtained; may be NULL
1332                 if exists_only is TRUE
1333   want_raw      TRUE if called for $rh_ or $rheader_ variables; no processing,
1334                 other than concatenating, will be done on the header. Also used
1335                 for $message_headers_raw.
1336   charset       name of charset to translate MIME words to; used only if
1337                 want_raw is false; if NULL, no translation is done (this is
1338                 used for $bh_ and $bheader_)
1339
1340 Returns:        NULL if the header does not exist, else a pointer to a new
1341                 store block
1342 */
1343
1344 static uschar *
1345 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1346   uschar *charset)
1347 {
1348 BOOL found = name == NULL;
1349 int comma = 0;
1350 int len = found? 0 : Ustrlen(name);
1351 int i;
1352 uschar *yield = NULL;
1353 uschar *ptr = NULL;
1354
1355 /* Loop for two passes - saves code repetition */
1356
1357 for (i = 0; i < 2; i++)
1358   {
1359   int size = 0;
1360   header_line *h;
1361
1362   for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1363     {
1364     if (h->type != htype_old && h->text != NULL)  /* NULL => Received: placeholder */
1365       {
1366       if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1367         {
1368         int ilen;
1369         uschar *t;
1370
1371         if (exists_only) return US"1";      /* don't need actual string */
1372         found = TRUE;
1373         t = h->text + len;                  /* text to insert */
1374         if (!want_raw)                      /* unless wanted raw, */
1375           while (isspace(*t)) t++;          /* remove leading white space */
1376         ilen = h->slen - (t - h->text);     /* length to insert */
1377
1378         /* Unless wanted raw, remove trailing whitespace, including the
1379         newline. */
1380
1381         if (!want_raw)
1382           while (ilen > 0 && isspace(t[ilen-1])) ilen--;
1383
1384         /* Set comma = 1 if handling a single header and it's one of those
1385         that contains an address list, except when asked for raw headers. Only
1386         need to do this once. */
1387
1388         if (!want_raw && name != NULL && comma == 0 &&
1389             Ustrchr("BCFRST", h->type) != NULL)
1390           comma = 1;
1391
1392         /* First pass - compute total store needed; second pass - compute
1393         total store used, including this header. */
1394
1395         size += ilen + comma + 1;  /* +1 for the newline */
1396
1397         /* Second pass - concatentate the data, up to a maximum. Note that
1398         the loop stops when size hits the limit. */
1399
1400         if (i != 0)
1401           {
1402           if (size > header_insert_maxlen)
1403             {
1404             ilen -= size - header_insert_maxlen - 1;
1405             comma = 0;
1406             }
1407           Ustrncpy(ptr, t, ilen);
1408           ptr += ilen;
1409
1410           /* For a non-raw header, put in the comma if needed, then add
1411           back the newline we removed above, provided there was some text in
1412           the header. */
1413
1414           if (!want_raw && ilen > 0)
1415             {
1416             if (comma != 0) *ptr++ = ',';
1417             *ptr++ = '\n';
1418             }
1419           }
1420         }
1421       }
1422     }
1423
1424   /* At end of first pass, return NULL if no header found. Then truncate size
1425   if necessary, and get the buffer to hold the data, returning the buffer size.
1426   */
1427
1428   if (i == 0)
1429     {
1430     if (!found) return NULL;
1431     if (size > header_insert_maxlen) size = header_insert_maxlen;
1432     *newsize = size + 1;
1433     ptr = yield = store_get(*newsize);
1434     }
1435   }
1436
1437 /* That's all we do for raw header expansion. */
1438
1439 if (want_raw)
1440   {
1441   *ptr = 0;
1442   }
1443
1444 /* Otherwise, remove a final newline and a redundant added comma. Then we do
1445 RFC 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1446 function can return an error with decoded data if the charset translation
1447 fails. If decoding fails, it returns NULL. */
1448
1449 else
1450   {
1451   uschar *decoded, *error;
1452   if (ptr > yield && ptr[-1] == '\n') ptr--;
1453   if (ptr > yield && comma != 0 && ptr[-1] == ',') ptr--;
1454   *ptr = 0;
1455   decoded = rfc2047_decode2(yield, check_rfc2047_length, charset, '?', NULL,
1456     newsize, &error);
1457   if (error != NULL)
1458     {
1459     DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1460       "    input was: %s\n", error, yield);
1461     }
1462   if (decoded != NULL) yield = decoded;
1463   }
1464
1465 return yield;
1466 }
1467
1468
1469
1470
1471 /*************************************************
1472 *               Return list of recipients        *
1473 *************************************************/
1474 /* A recipients list is available only during system message filtering,
1475 during ACL processing after DATA, and while expanding pipe commands
1476 generated from a system filter, but not elsewhere. */
1477
1478 static uschar *
1479 fn_recipients(void)
1480 {
1481 if (!enable_dollar_recipients) return NULL; else
1482   {
1483   int size = 128;
1484   int ptr = 0;
1485   int i;
1486   uschar * s = store_get(size);
1487   for (i = 0; i < recipients_count; i++)
1488     {
1489     if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1490     s = string_cat(s, &size, &ptr, recipients_list[i].address,
1491       Ustrlen(recipients_list[i].address));
1492     }
1493   s[ptr] = 0;     /* string_cat() leaves room */
1494   return s;
1495   }
1496 }
1497
1498
1499 /*************************************************
1500 *               Find value of a variable         *
1501 *************************************************/
1502
1503 /* The table of variables is kept in alphabetic order, so we can search it
1504 using a binary chop. The "choplen" variable is nothing to do with the binary
1505 chop.
1506
1507 Arguments:
1508   name          the name of the variable being sought
1509   exists_only   TRUE if this is a def: test; passed on to find_header()
1510   skipping      TRUE => skip any processing evaluation; this is not the same as
1511                   exists_only because def: may test for values that are first
1512                   evaluated here
1513   newsize       pointer to an int which is initially zero; if the answer is in
1514                 a new memory buffer, *newsize is set to its size
1515
1516 Returns:        NULL if the variable does not exist, or
1517                 a pointer to the variable's contents, or
1518                 something non-NULL if exists_only is TRUE
1519 */
1520
1521 static uschar *
1522 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1523 {
1524 int first = 0;
1525 int last = var_table_size;
1526
1527 /* Handle ACL variables, whose names are of the form acl_cxxx or acl_mxxx.
1528 Originally, xxx had to be a number in the range 0-9 (later 0-19), but from
1529 release 4.64 onwards arbitrary names are permitted, as long as the first 5
1530 characters are acl_c or acl_m and the sixth is either a digit or an underscore
1531 (this gave backwards compatibility at the changeover). There may be built-in
1532 variables whose names start acl_ but they should never start in this way. This
1533 slightly messy specification is a consequence of the history, needless to say.
1534
1535 If an ACL variable does not exist, treat it as empty, unless strict_acl_vars is
1536 set, in which case give an error. */
1537
1538 if ((Ustrncmp(name, "acl_c", 5) == 0 || Ustrncmp(name, "acl_m", 5) == 0) &&
1539      !isalpha(name[5]))
1540   {
1541   tree_node *node =
1542     tree_search((name[4] == 'c')? acl_var_c : acl_var_m, name + 4);
1543   return (node == NULL)? (strict_acl_vars? NULL : US"") : node->data.ptr;
1544   }
1545
1546 /* Handle $auth<n> variables. */
1547
1548 if (Ustrncmp(name, "auth", 4) == 0)
1549   {
1550   uschar *endptr;
1551   int n = Ustrtoul(name + 4, &endptr, 10);
1552   if (*endptr == 0 && n != 0 && n <= AUTH_VARS)
1553     return (auth_vars[n-1] == NULL)? US"" : auth_vars[n-1];
1554   }
1555
1556 /* For all other variables, search the table */
1557
1558 while (last > first)
1559   {
1560   uschar *s, *domain;
1561   uschar **ss;
1562   int middle = (first + last)/2;
1563   int c = Ustrcmp(name, var_table[middle].name);
1564
1565   if (c > 0) { first = middle + 1; continue; }
1566   if (c < 0) { last = middle; continue; }
1567
1568   /* Found an existing variable. If in skipping state, the value isn't needed,
1569   and we want to avoid processing (such as looking up the host name). */
1570
1571   if (skipping) return US"";
1572
1573   switch (var_table[middle].type)
1574     {
1575     case vtype_filter_int:
1576     if (!filter_running) return NULL;
1577     /* Fall through */
1578     /* VVVVVVVVVVVV */
1579     case vtype_int:
1580     sprintf(CS var_buffer, "%d", *(int *)(var_table[middle].value)); /* Integer */
1581     return var_buffer;
1582
1583     case vtype_ino:
1584     sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(var_table[middle].value))); /* Inode */
1585     return var_buffer;
1586
1587     case vtype_gid:
1588     sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(var_table[middle].value))); /* gid */
1589     return var_buffer;
1590
1591     case vtype_uid:
1592     sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(var_table[middle].value))); /* uid */
1593     return var_buffer;
1594
1595     case vtype_bool:
1596     sprintf(CS var_buffer, "%s", *(BOOL *)(var_table[middle].value) ? "yes" : "no"); /* bool */
1597     return var_buffer;
1598
1599     case vtype_stringptr:                      /* Pointer to string */
1600     s = *((uschar **)(var_table[middle].value));
1601     return (s == NULL)? US"" : s;
1602
1603     case vtype_pid:
1604     sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1605     return var_buffer;
1606
1607     case vtype_load_avg:
1608     sprintf(CS var_buffer, "%d", OS_GETLOADAVG()); /* load_average */
1609     return var_buffer;
1610
1611     case vtype_host_lookup:                    /* Lookup if not done so */
1612     if (sender_host_name == NULL && sender_host_address != NULL &&
1613         !host_lookup_failed && host_name_lookup() == OK)
1614       host_build_sender_fullhost();
1615     return (sender_host_name == NULL)? US"" : sender_host_name;
1616
1617     case vtype_localpart:                      /* Get local part from address */
1618     s = *((uschar **)(var_table[middle].value));
1619     if (s == NULL) return US"";
1620     domain = Ustrrchr(s, '@');
1621     if (domain == NULL) return s;
1622     if (domain - s > sizeof(var_buffer) - 1)
1623       log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than " SIZE_T_FMT
1624           " in string expansion", sizeof(var_buffer));
1625     Ustrncpy(var_buffer, s, domain - s);
1626     var_buffer[domain - s] = 0;
1627     return var_buffer;
1628
1629     case vtype_domain:                         /* Get domain from address */
1630     s = *((uschar **)(var_table[middle].value));
1631     if (s == NULL) return US"";
1632     domain = Ustrrchr(s, '@');
1633     return (domain == NULL)? US"" : domain + 1;
1634
1635     case vtype_msgheaders:
1636     return find_header(NULL, exists_only, newsize, FALSE, NULL);
1637
1638     case vtype_msgheaders_raw:
1639     return find_header(NULL, exists_only, newsize, TRUE, NULL);
1640
1641     case vtype_msgbody:                        /* Pointer to msgbody string */
1642     case vtype_msgbody_end:                    /* Ditto, the end of the msg */
1643     ss = (uschar **)(var_table[middle].value);
1644     if (*ss == NULL && deliver_datafile >= 0)  /* Read body when needed */
1645       {
1646       uschar *body;
1647       off_t start_offset = SPOOL_DATA_START_OFFSET;
1648       int len = message_body_visible;
1649       if (len > message_size) len = message_size;
1650       *ss = body = store_malloc(len+1);
1651       body[0] = 0;
1652       if (var_table[middle].type == vtype_msgbody_end)
1653         {
1654         struct stat statbuf;
1655         if (fstat(deliver_datafile, &statbuf) == 0)
1656           {
1657           start_offset = statbuf.st_size - len;
1658           if (start_offset < SPOOL_DATA_START_OFFSET)
1659             start_offset = SPOOL_DATA_START_OFFSET;
1660           }
1661         }
1662       lseek(deliver_datafile, start_offset, SEEK_SET);
1663       len = read(deliver_datafile, body, len);
1664       if (len > 0)
1665         {
1666         body[len] = 0;
1667         if (message_body_newlines)   /* Separate loops for efficiency */
1668           {
1669           while (len > 0)
1670             { if (body[--len] == 0) body[len] = ' '; }
1671           }
1672         else
1673           {
1674           while (len > 0)
1675             { if (body[--len] == '\n' || body[len] == 0) body[len] = ' '; }
1676           }
1677         }
1678       }
1679     return (*ss == NULL)? US"" : *ss;
1680
1681     case vtype_todbsdin:                       /* BSD inbox time of day */
1682     return tod_stamp(tod_bsdin);
1683
1684     case vtype_tode:                           /* Unix epoch time of day */
1685     return tod_stamp(tod_epoch);
1686
1687     case vtype_todel:                          /* Unix epoch/usec time of day */
1688     return tod_stamp(tod_epoch_l);
1689
1690     case vtype_todf:                           /* Full time of day */
1691     return tod_stamp(tod_full);
1692
1693     case vtype_todl:                           /* Log format time of day */
1694     return tod_stamp(tod_log_bare);            /* (without timezone) */
1695
1696     case vtype_todzone:                        /* Time zone offset only */
1697     return tod_stamp(tod_zone);
1698
1699     case vtype_todzulu:                        /* Zulu time */
1700     return tod_stamp(tod_zulu);
1701
1702     case vtype_todlf:                          /* Log file datestamp tod */
1703     return tod_stamp(tod_log_datestamp_daily);
1704
1705     case vtype_reply:                          /* Get reply address */
1706     s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1707       headers_charset);
1708     if (s != NULL) while (isspace(*s)) s++;
1709     if (s == NULL || *s == 0)
1710       {
1711       *newsize = 0;                            /* For the *s==0 case */
1712       s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1713       }
1714     if (s != NULL)
1715       {
1716       uschar *t;
1717       while (isspace(*s)) s++;
1718       for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1719       while (t > s && isspace(t[-1])) t--;
1720       *t = 0;
1721       }
1722     return (s == NULL)? US"" : s;
1723
1724     case vtype_string_func:
1725       {
1726       uschar * (*fn)() = var_table[middle].value;
1727       return fn();
1728       }
1729
1730     case vtype_pspace:
1731       {
1732       int inodes;
1733       sprintf(CS var_buffer, "%d",
1734         receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes));
1735       }
1736     return var_buffer;
1737
1738     case vtype_pinodes:
1739       {
1740       int inodes;
1741       (void) receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes);
1742       sprintf(CS var_buffer, "%d", inodes);
1743       }
1744     return var_buffer;
1745
1746     #ifndef DISABLE_DKIM
1747     case vtype_dkim:
1748     return dkim_exim_expand_query((int)(long)var_table[middle].value);
1749     #endif
1750
1751     }
1752   }
1753
1754 return NULL;          /* Unknown variable name */
1755 }
1756
1757
1758
1759
1760 void
1761 modify_variable(uschar *name, void * value)
1762 {
1763 int first = 0;
1764 int last = var_table_size;
1765
1766 while (last > first)
1767   {
1768   int middle = (first + last)/2;
1769   int c = Ustrcmp(name, var_table[middle].name);
1770
1771   if (c > 0) { first = middle + 1; continue; }
1772   if (c < 0) { last = middle; continue; }
1773
1774   /* Found an existing variable; change the item it refers to */
1775   var_table[middle].value = value;
1776   return;
1777   }
1778 return;          /* Unknown variable name, fail silently */
1779 }
1780
1781
1782
1783
1784
1785 /*************************************************
1786 *           Read and expand substrings           *
1787 *************************************************/
1788
1789 /* This function is called to read and expand argument substrings for various
1790 expansion items. Some have a minimum requirement that is less than the maximum;
1791 in these cases, the first non-present one is set to NULL.
1792
1793 Arguments:
1794   sub        points to vector of pointers to set
1795   n          maximum number of substrings
1796   m          minimum required
1797   sptr       points to current string pointer
1798   skipping   the skipping flag
1799   check_end  if TRUE, check for final '}'
1800   name       name of item, for error message
1801
1802 Returns:     0 OK; string pointer updated
1803              1 curly bracketing error (too few arguments)
1804              2 too many arguments (only if check_end is set); message set
1805              3 other error (expansion failure)
1806 */
1807
1808 static int
1809 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1810   BOOL check_end, uschar *name)
1811 {
1812 int i;
1813 uschar *s = *sptr;
1814
1815 while (isspace(*s)) s++;
1816 for (i = 0; i < n; i++)
1817   {
1818   if (*s != '{')
1819     {
1820     if (i < m) return 1;
1821     sub[i] = NULL;
1822     break;
1823     }
1824   sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
1825   if (sub[i] == NULL) return 3;
1826   if (*s++ != '}') return 1;
1827   while (isspace(*s)) s++;
1828   }
1829 if (check_end && *s++ != '}')
1830   {
1831   if (s[-1] == '{')
1832     {
1833     expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1834       "(max is %d)", name, n);
1835     return 2;
1836     }
1837   return 1;
1838   }
1839
1840 *sptr = s;
1841 return 0;
1842 }
1843
1844
1845
1846
1847 /*************************************************
1848 *     Elaborate message for bad variable         *
1849 *************************************************/
1850
1851 /* For the "unknown variable" message, take a look at the variable's name, and
1852 give additional information about possible ACL variables. The extra information
1853 is added on to expand_string_message.
1854
1855 Argument:   the name of the variable
1856 Returns:    nothing
1857 */
1858
1859 static void
1860 check_variable_error_message(uschar *name)
1861 {
1862 if (Ustrncmp(name, "acl_", 4) == 0)
1863   expand_string_message = string_sprintf("%s (%s)", expand_string_message,
1864     (name[4] == 'c' || name[4] == 'm')?
1865       (isalpha(name[5])?
1866         US"6th character of a user-defined ACL variable must be a digit or underscore" :
1867         US"strict_acl_vars is set"    /* Syntax is OK, it has to be this */
1868       ) :
1869       US"user-defined ACL variables must start acl_c or acl_m");
1870 }
1871
1872
1873
1874 /*
1875 Load args from sub array to globals, and call acl_check().
1876 Sub array will be corrupted on return.
1877
1878 Returns:       OK         access is granted by an ACCEPT verb
1879                DISCARD    access is granted by a DISCARD verb
1880                FAIL       access is denied
1881                FAIL_DROP  access is denied; drop the connection
1882                DEFER      can't tell at the moment
1883                ERROR      disaster
1884 */
1885 static int
1886 eval_acl(uschar ** sub, int nsub, uschar ** user_msgp)
1887 {
1888 int i;
1889 uschar *tmp;
1890 int sav_narg = acl_narg;
1891 int ret;
1892 extern int acl_where;
1893
1894 if(--nsub > sizeof(acl_arg)/sizeof(*acl_arg)) nsub = sizeof(acl_arg)/sizeof(*acl_arg);
1895 for (i = 0; i < nsub && sub[i+1]; i++)
1896   {
1897   tmp = acl_arg[i];
1898   acl_arg[i] = sub[i+1];        /* place callers args in the globals */
1899   sub[i+1] = tmp;               /* stash the old args using our caller's storage */
1900   }
1901 acl_narg = i;
1902 while (i < nsub)
1903   {
1904   sub[i+1] = acl_arg[i];
1905   acl_arg[i++] = NULL;
1906   }
1907
1908 DEBUG(D_expand)
1909   debug_printf("expanding: acl: %s  arg: %s%s\n",
1910     sub[0],
1911     acl_narg>0 ? acl_arg[0] : US"<none>",
1912     acl_narg>1 ? " +more"   : "");
1913
1914 ret = acl_eval(acl_where, sub[0], user_msgp, &tmp);
1915
1916 for (i = 0; i < nsub; i++)
1917   acl_arg[i] = sub[i+1];        /* restore old args */
1918 acl_narg = sav_narg;
1919
1920 return ret;
1921 }
1922
1923
1924
1925
1926 /*************************************************
1927 *        Read and evaluate a condition           *
1928 *************************************************/
1929
1930 /*
1931 Arguments:
1932   s        points to the start of the condition text
1933   yield    points to a BOOL to hold the result of the condition test;
1934            if NULL, we are just reading through a condition that is
1935            part of an "or" combination to check syntax, or in a state
1936            where the answer isn't required
1937
1938 Returns:   a pointer to the first character after the condition, or
1939            NULL after an error
1940 */
1941
1942 static uschar *
1943 eval_condition(uschar *s, BOOL *yield)
1944 {
1945 BOOL testfor = TRUE;
1946 BOOL tempcond, combined_cond;
1947 BOOL *subcondptr;
1948 BOOL sub2_honour_dollar = TRUE;
1949 int i, rc, cond_type, roffset;
1950 int_eximarith_t num[2];
1951 struct stat statbuf;
1952 uschar name[256];
1953 uschar *sub[10];
1954
1955 const pcre *re;
1956 const uschar *rerror;
1957
1958 for (;;)
1959   {
1960   while (isspace(*s)) s++;
1961   if (*s == '!') { testfor = !testfor; s++; } else break;
1962   }
1963
1964 /* Numeric comparisons are symbolic */
1965
1966 if (*s == '=' || *s == '>' || *s == '<')
1967   {
1968   int p = 0;
1969   name[p++] = *s++;
1970   if (*s == '=')
1971     {
1972     name[p++] = '=';
1973     s++;
1974     }
1975   name[p] = 0;
1976   }
1977
1978 /* All other conditions are named */
1979
1980 else s = read_name(name, 256, s, US"_");
1981
1982 /* If we haven't read a name, it means some non-alpha character is first. */
1983
1984 if (name[0] == 0)
1985   {
1986   expand_string_message = string_sprintf("condition name expected, "
1987     "but found \"%.16s\"", s);
1988   return NULL;
1989   }
1990
1991 /* Find which condition we are dealing with, and switch on it */
1992
1993 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
1994 switch(cond_type)
1995   {
1996   /* def: tests for a non-empty variable, or for the existence of a header. If
1997   yield == NULL we are in a skipping state, and don't care about the answer. */
1998
1999   case ECOND_DEF:
2000   if (*s != ':')
2001     {
2002     expand_string_message = US"\":\" expected after \"def\"";
2003     return NULL;
2004     }
2005
2006   s = read_name(name, 256, s+1, US"_");
2007
2008   /* Test for a header's existence. If the name contains a closing brace
2009   character, this may be a user error where the terminating colon has been
2010   omitted. Set a flag to adjust a subsequent error message in this case. */
2011
2012   if (Ustrncmp(name, "h_", 2) == 0 ||
2013       Ustrncmp(name, "rh_", 3) == 0 ||
2014       Ustrncmp(name, "bh_", 3) == 0 ||
2015       Ustrncmp(name, "header_", 7) == 0 ||
2016       Ustrncmp(name, "rheader_", 8) == 0 ||
2017       Ustrncmp(name, "bheader_", 8) == 0)
2018     {
2019     s = read_header_name(name, 256, s);
2020     /* {-for-text-editors */
2021     if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2022     if (yield != NULL) *yield =
2023       (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
2024     }
2025
2026   /* Test for a variable's having a non-empty value. A non-existent variable
2027   causes an expansion failure. */
2028
2029   else
2030     {
2031     uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
2032     if (value == NULL)
2033       {
2034       expand_string_message = (name[0] == 0)?
2035         string_sprintf("variable name omitted after \"def:\"") :
2036         string_sprintf("unknown variable \"%s\" after \"def:\"", name);
2037       check_variable_error_message(name);
2038       return NULL;
2039       }
2040     if (yield != NULL) *yield = (value[0] != 0) == testfor;
2041     }
2042
2043   return s;
2044
2045
2046   /* first_delivery tests for first delivery attempt */
2047
2048   case ECOND_FIRST_DELIVERY:
2049   if (yield != NULL) *yield = deliver_firsttime == testfor;
2050   return s;
2051
2052
2053   /* queue_running tests for any process started by a queue runner */
2054
2055   case ECOND_QUEUE_RUNNING:
2056   if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
2057   return s;
2058
2059
2060   /* exists:  tests for file existence
2061        isip:  tests for any IP address
2062       isip4:  tests for an IPv4 address
2063       isip6:  tests for an IPv6 address
2064         pam:  does PAM authentication
2065      radius:  does RADIUS authentication
2066    ldapauth:  does LDAP authentication
2067     pwcheck:  does Cyrus SASL pwcheck authentication
2068   */
2069
2070   case ECOND_EXISTS:
2071   case ECOND_ISIP:
2072   case ECOND_ISIP4:
2073   case ECOND_ISIP6:
2074   case ECOND_PAM:
2075   case ECOND_RADIUS:
2076   case ECOND_LDAPAUTH:
2077   case ECOND_PWCHECK:
2078
2079   while (isspace(*s)) s++;
2080   if (*s != '{') goto COND_FAILED_CURLY_START;          /* }-for-text-editors */
2081
2082   sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL, TRUE);
2083   if (sub[0] == NULL) return NULL;
2084   /* {-for-text-editors */
2085   if (*s++ != '}') goto COND_FAILED_CURLY_END;
2086
2087   if (yield == NULL) return s;   /* No need to run the test if skipping */
2088
2089   switch(cond_type)
2090     {
2091     case ECOND_EXISTS:
2092     if ((expand_forbid & RDO_EXISTS) != 0)
2093       {
2094       expand_string_message = US"File existence tests are not permitted";
2095       return NULL;
2096       }
2097     *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
2098     break;
2099
2100     case ECOND_ISIP:
2101     case ECOND_ISIP4:
2102     case ECOND_ISIP6:
2103     rc = string_is_ip_address(sub[0], NULL);
2104     *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
2105              (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
2106     break;
2107
2108     /* Various authentication tests - all optionally compiled */
2109
2110     case ECOND_PAM:
2111     #ifdef SUPPORT_PAM
2112     rc = auth_call_pam(sub[0], &expand_string_message);
2113     goto END_AUTH;
2114     #else
2115     goto COND_FAILED_NOT_COMPILED;
2116     #endif  /* SUPPORT_PAM */
2117
2118     case ECOND_RADIUS:
2119     #ifdef RADIUS_CONFIG_FILE
2120     rc = auth_call_radius(sub[0], &expand_string_message);
2121     goto END_AUTH;
2122     #else
2123     goto COND_FAILED_NOT_COMPILED;
2124     #endif  /* RADIUS_CONFIG_FILE */
2125
2126     case ECOND_LDAPAUTH:
2127     #ifdef LOOKUP_LDAP
2128       {
2129       /* Just to keep the interface the same */
2130       BOOL do_cache;
2131       int old_pool = store_pool;
2132       store_pool = POOL_SEARCH;
2133       rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
2134         &expand_string_message, &do_cache);
2135       store_pool = old_pool;
2136       }
2137     goto END_AUTH;
2138     #else
2139     goto COND_FAILED_NOT_COMPILED;
2140     #endif  /* LOOKUP_LDAP */
2141
2142     case ECOND_PWCHECK:
2143     #ifdef CYRUS_PWCHECK_SOCKET
2144     rc = auth_call_pwcheck(sub[0], &expand_string_message);
2145     goto END_AUTH;
2146     #else
2147     goto COND_FAILED_NOT_COMPILED;
2148     #endif  /* CYRUS_PWCHECK_SOCKET */
2149
2150     #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
2151         defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
2152     END_AUTH:
2153     if (rc == ERROR || rc == DEFER) return NULL;
2154     *yield = (rc == OK) == testfor;
2155     #endif
2156     }
2157   return s;
2158
2159
2160   /* call ACL (in a conditional context).  Accept true, deny false.
2161   Defer is a forced-fail.  Anything set by message= goes to $value.
2162   Up to ten parameters are used; we use the braces round the name+args
2163   like the saslauthd condition does, to permit a variable number of args.
2164   See also the expansion-item version EITEM_ACL and the traditional
2165   acl modifier ACLC_ACL.
2166   */
2167
2168   case ECOND_ACL:
2169     /* ${if acl {{name}{arg1}{arg2}...}  {yes}{no}} */
2170     {
2171     uschar *user_msg;
2172     BOOL cond = FALSE;
2173     int size = 0;
2174     int ptr = 0;
2175
2176     while (isspace(*s)) s++;
2177     if (*s++ != '{') goto COND_FAILED_CURLY_START;      /*}*/
2178
2179     switch(read_subs(sub, sizeof(sub)/sizeof(*sub), 1,
2180       &s, yield == NULL, TRUE, US"acl"))
2181       {
2182       case 1: expand_string_message = US"too few arguments or bracketing "
2183         "error for acl";
2184       case 2:
2185       case 3: return NULL;
2186       }
2187
2188     if (yield != NULL) switch(eval_acl(sub, sizeof(sub)/sizeof(*sub), &user_msg))
2189         {
2190         case OK:
2191           cond = TRUE;
2192         case FAIL:
2193           lookup_value = NULL;
2194           if (user_msg)
2195             {
2196             lookup_value = string_cat(NULL, &size, &ptr, user_msg, Ustrlen(user_msg));
2197             lookup_value[ptr] = '\0';
2198             }
2199           *yield = cond == testfor;
2200           break;
2201
2202         case DEFER:
2203           expand_string_forcedfail = TRUE;
2204         default:
2205           expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
2206           return NULL;
2207         }
2208     return s;
2209     }
2210
2211
2212   /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
2213
2214      ${if saslauthd {{username}{password}{service}{realm}}  {yes}[no}}
2215
2216   However, the last two are optional. That is why the whole set is enclosed
2217   in their own set of braces. */
2218
2219   case ECOND_SASLAUTHD:
2220   #ifndef CYRUS_SASLAUTHD_SOCKET
2221   goto COND_FAILED_NOT_COMPILED;
2222   #else
2223   while (isspace(*s)) s++;
2224   if (*s++ != '{') goto COND_FAILED_CURLY_START;        /* }-for-text-editors */
2225   switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd"))
2226     {
2227     case 1: expand_string_message = US"too few arguments or bracketing "
2228       "error for saslauthd";
2229     case 2:
2230     case 3: return NULL;
2231     }
2232   if (sub[2] == NULL) sub[3] = NULL;  /* realm if no service */
2233   if (yield != NULL)
2234     {
2235     int rc;
2236     rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
2237       &expand_string_message);
2238     if (rc == ERROR || rc == DEFER) return NULL;
2239     *yield = (rc == OK) == testfor;
2240     }
2241   return s;
2242   #endif /* CYRUS_SASLAUTHD_SOCKET */
2243
2244
2245   /* symbolic operators for numeric and string comparison, and a number of
2246   other operators, all requiring two arguments.
2247
2248   crypteq:           encrypts plaintext and compares against an encrypted text,
2249                        using crypt(), crypt16(), MD5 or SHA-1
2250   inlist/inlisti:    checks if first argument is in the list of the second
2251   match:             does a regular expression match and sets up the numerical
2252                        variables if it succeeds
2253   match_address:     matches in an address list
2254   match_domain:      matches in a domain list
2255   match_ip:          matches a host list that is restricted to IP addresses
2256   match_local_part:  matches in a local part list
2257   */
2258
2259   case ECOND_MATCH_ADDRESS:
2260   case ECOND_MATCH_DOMAIN:
2261   case ECOND_MATCH_IP:
2262   case ECOND_MATCH_LOCAL_PART:
2263 #ifndef EXPAND_LISTMATCH_RHS
2264     sub2_honour_dollar = FALSE;
2265 #endif
2266     /* FALLTHROUGH */
2267
2268   case ECOND_CRYPTEQ:
2269   case ECOND_INLIST:
2270   case ECOND_INLISTI:
2271   case ECOND_MATCH:
2272
2273   case ECOND_NUM_L:     /* Numerical comparisons */
2274   case ECOND_NUM_LE:
2275   case ECOND_NUM_E:
2276   case ECOND_NUM_EE:
2277   case ECOND_NUM_G:
2278   case ECOND_NUM_GE:
2279
2280   case ECOND_STR_LT:    /* String comparisons */
2281   case ECOND_STR_LTI:
2282   case ECOND_STR_LE:
2283   case ECOND_STR_LEI:
2284   case ECOND_STR_EQ:
2285   case ECOND_STR_EQI:
2286   case ECOND_STR_GT:
2287   case ECOND_STR_GTI:
2288   case ECOND_STR_GE:
2289   case ECOND_STR_GEI:
2290
2291   for (i = 0; i < 2; i++)
2292     {
2293     /* Sometimes, we don't expand substrings; too many insecure configurations
2294     created using match_address{}{} and friends, where the second param
2295     includes information from untrustworthy sources. */
2296     BOOL honour_dollar = TRUE;
2297     if ((i > 0) && !sub2_honour_dollar)
2298       honour_dollar = FALSE;
2299
2300     while (isspace(*s)) s++;
2301     if (*s != '{')
2302       {
2303       if (i == 0) goto COND_FAILED_CURLY_START;
2304       expand_string_message = string_sprintf("missing 2nd string in {} "
2305         "after \"%s\"", name);
2306       return NULL;
2307       }
2308     sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL,
2309         honour_dollar);
2310     if (sub[i] == NULL) return NULL;
2311     if (*s++ != '}') goto COND_FAILED_CURLY_END;
2312
2313     /* Convert to numerical if required; we know that the names of all the
2314     conditions that compare numbers do not start with a letter. This just saves
2315     checking for them individually. */
2316
2317     if (!isalpha(name[0]) && yield != NULL)
2318       {
2319       if (sub[i][0] == 0)
2320         {
2321         num[i] = 0;
2322         DEBUG(D_expand)
2323           debug_printf("empty string cast to zero for numerical comparison\n");
2324         }
2325       else
2326         {
2327         num[i] = expand_string_integer(sub[i], FALSE);
2328         if (expand_string_message != NULL) return NULL;
2329         }
2330       }
2331     }
2332
2333   /* Result not required */
2334
2335   if (yield == NULL) return s;
2336
2337   /* Do an appropriate comparison */
2338
2339   switch(cond_type)
2340     {
2341     case ECOND_NUM_E:
2342     case ECOND_NUM_EE:
2343     tempcond = (num[0] == num[1]);
2344     break;
2345
2346     case ECOND_NUM_G:
2347     tempcond = (num[0] > num[1]);
2348     break;
2349
2350     case ECOND_NUM_GE:
2351     tempcond = (num[0] >= num[1]);
2352     break;
2353
2354     case ECOND_NUM_L:
2355     tempcond = (num[0] < num[1]);
2356     break;
2357
2358     case ECOND_NUM_LE:
2359     tempcond = (num[0] <= num[1]);
2360     break;
2361
2362     case ECOND_STR_LT:
2363     tempcond = (Ustrcmp(sub[0], sub[1]) < 0);
2364     break;
2365
2366     case ECOND_STR_LTI:
2367     tempcond = (strcmpic(sub[0], sub[1]) < 0);
2368     break;
2369
2370     case ECOND_STR_LE:
2371     tempcond = (Ustrcmp(sub[0], sub[1]) <= 0);
2372     break;
2373
2374     case ECOND_STR_LEI:
2375     tempcond = (strcmpic(sub[0], sub[1]) <= 0);
2376     break;
2377
2378     case ECOND_STR_EQ:
2379     tempcond = (Ustrcmp(sub[0], sub[1]) == 0);
2380     break;
2381
2382     case ECOND_STR_EQI:
2383     tempcond = (strcmpic(sub[0], sub[1]) == 0);
2384     break;
2385
2386     case ECOND_STR_GT:
2387     tempcond = (Ustrcmp(sub[0], sub[1]) > 0);
2388     break;
2389
2390     case ECOND_STR_GTI:
2391     tempcond = (strcmpic(sub[0], sub[1]) > 0);
2392     break;
2393
2394     case ECOND_STR_GE:
2395     tempcond = (Ustrcmp(sub[0], sub[1]) >= 0);
2396     break;
2397
2398     case ECOND_STR_GEI:
2399     tempcond = (strcmpic(sub[0], sub[1]) >= 0);
2400     break;
2401
2402     case ECOND_MATCH:   /* Regular expression match */
2403     re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
2404       NULL);
2405     if (re == NULL)
2406       {
2407       expand_string_message = string_sprintf("regular expression error in "
2408         "\"%s\": %s at offset %d", sub[1], rerror, roffset);
2409       return NULL;
2410       }
2411     tempcond = regex_match_and_setup(re, sub[0], 0, -1);
2412     break;
2413
2414     case ECOND_MATCH_ADDRESS:  /* Match in an address list */
2415     rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
2416     goto MATCHED_SOMETHING;
2417
2418     case ECOND_MATCH_DOMAIN:   /* Match in a domain list */
2419     rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
2420       MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
2421     goto MATCHED_SOMETHING;
2422
2423     case ECOND_MATCH_IP:       /* Match IP address in a host list */
2424     if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
2425       {
2426       expand_string_message = string_sprintf("\"%s\" is not an IP address",
2427         sub[0]);
2428       return NULL;
2429       }
2430     else
2431       {
2432       unsigned int *nullcache = NULL;
2433       check_host_block cb;
2434
2435       cb.host_name = US"";
2436       cb.host_address = sub[0];
2437
2438       /* If the host address starts off ::ffff: it is an IPv6 address in
2439       IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2440       addresses. */
2441
2442       cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2443         cb.host_address + 7 : cb.host_address;
2444
2445       rc = match_check_list(
2446              &sub[1],                   /* the list */
2447              0,                         /* separator character */
2448              &hostlist_anchor,          /* anchor pointer */
2449              &nullcache,                /* cache pointer */
2450              check_host,                /* function for testing */
2451              &cb,                       /* argument for function */
2452              MCL_HOST,                  /* type of check */
2453              sub[0],                    /* text for debugging */
2454              NULL);                     /* where to pass back data */
2455       }
2456     goto MATCHED_SOMETHING;
2457
2458     case ECOND_MATCH_LOCAL_PART:
2459     rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2460       MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2461     /* Fall through */
2462     /* VVVVVVVVVVVV */
2463     MATCHED_SOMETHING:
2464     switch(rc)
2465       {
2466       case OK:
2467       tempcond = TRUE;
2468       break;
2469
2470       case FAIL:
2471       tempcond = FALSE;
2472       break;
2473
2474       case DEFER:
2475       expand_string_message = string_sprintf("unable to complete match "
2476         "against \"%s\": %s", sub[1], search_error_message);
2477       return NULL;
2478       }
2479
2480     break;
2481
2482     /* Various "encrypted" comparisons. If the second string starts with
2483     "{" then an encryption type is given. Default to crypt() or crypt16()
2484     (build-time choice). */
2485     /* }-for-text-editors */
2486
2487     case ECOND_CRYPTEQ:
2488     #ifndef SUPPORT_CRYPTEQ
2489     goto COND_FAILED_NOT_COMPILED;
2490     #else
2491     if (strncmpic(sub[1], US"{md5}", 5) == 0)
2492       {
2493       int sublen = Ustrlen(sub[1]+5);
2494       md5 base;
2495       uschar digest[16];
2496
2497       md5_start(&base);
2498       md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2499
2500       /* If the length that we are comparing against is 24, the MD5 digest
2501       is expressed as a base64 string. This is the way LDAP does it. However,
2502       some other software uses a straightforward hex representation. We assume
2503       this if the length is 32. Other lengths fail. */
2504
2505       if (sublen == 24)
2506         {
2507         uschar *coded = auth_b64encode((uschar *)digest, 16);
2508         DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2509           "  subject=%s\n  crypted=%s\n", coded, sub[1]+5);
2510         tempcond = (Ustrcmp(coded, sub[1]+5) == 0);
2511         }
2512       else if (sublen == 32)
2513         {
2514         int i;
2515         uschar coded[36];
2516         for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2517         coded[32] = 0;
2518         DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2519           "  subject=%s\n  crypted=%s\n", coded, sub[1]+5);
2520         tempcond = (strcmpic(coded, sub[1]+5) == 0);
2521         }
2522       else
2523         {
2524         DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2525           "fail\n  crypted=%s\n", sub[1]+5);
2526         tempcond = FALSE;
2527         }
2528       }
2529
2530     else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2531       {
2532       int sublen = Ustrlen(sub[1]+6);
2533       sha1 base;
2534       uschar digest[20];
2535
2536       sha1_start(&base);
2537       sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2538
2539       /* If the length that we are comparing against is 28, assume the SHA1
2540       digest is expressed as a base64 string. If the length is 40, assume a
2541       straightforward hex representation. Other lengths fail. */
2542
2543       if (sublen == 28)
2544         {
2545         uschar *coded = auth_b64encode((uschar *)digest, 20);
2546         DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2547           "  subject=%s\n  crypted=%s\n", coded, sub[1]+6);
2548         tempcond = (Ustrcmp(coded, sub[1]+6) == 0);
2549         }
2550       else if (sublen == 40)
2551         {
2552         int i;
2553         uschar coded[44];
2554         for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2555         coded[40] = 0;
2556         DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2557           "  subject=%s\n  crypted=%s\n", coded, sub[1]+6);
2558         tempcond = (strcmpic(coded, sub[1]+6) == 0);
2559         }
2560       else
2561         {
2562         DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2563           "fail\n  crypted=%s\n", sub[1]+6);
2564         tempcond = FALSE;
2565         }
2566       }
2567
2568     else   /* {crypt} or {crypt16} and non-{ at start */
2569            /* }-for-text-editors */
2570       {
2571       int which = 0;
2572       uschar *coded;
2573
2574       if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2575         {
2576         sub[1] += 7;
2577         which = 1;
2578         }
2579       else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2580         {
2581         sub[1] += 9;
2582         which = 2;
2583         }
2584       else if (sub[1][0] == '{')                /* }-for-text-editors */
2585         {
2586         expand_string_message = string_sprintf("unknown encryption mechanism "
2587           "in \"%s\"", sub[1]);
2588         return NULL;
2589         }
2590
2591       switch(which)
2592         {
2593         case 0:  coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2594         case 1:  coded = US crypt(CS sub[0], CS sub[1]); break;
2595         default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2596         }
2597
2598       #define STR(s) # s
2599       #define XSTR(s) STR(s)
2600       DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2601         "  subject=%s\n  crypted=%s\n",
2602         (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2603         coded, sub[1]);
2604       #undef STR
2605       #undef XSTR
2606
2607       /* If the encrypted string contains fewer than two characters (for the
2608       salt), force failure. Otherwise we get false positives: with an empty
2609       string the yield of crypt() is an empty string! */
2610
2611       tempcond = (Ustrlen(sub[1]) < 2)? FALSE :
2612         (Ustrcmp(coded, sub[1]) == 0);
2613       }
2614     break;
2615     #endif  /* SUPPORT_CRYPTEQ */
2616
2617     case ECOND_INLIST:
2618     case ECOND_INLISTI:
2619       {
2620       int sep = 0;
2621       uschar *save_iterate_item = iterate_item;
2622       int (*compare)(const uschar *, const uschar *);
2623
2624       tempcond = FALSE;
2625       if (cond_type == ECOND_INLISTI)
2626         compare = strcmpic;
2627       else
2628         compare = (int (*)(const uschar *, const uschar *)) strcmp;
2629
2630       while ((iterate_item = string_nextinlist(&sub[1], &sep, NULL, 0)) != NULL)
2631         if (compare(sub[0], iterate_item) == 0)
2632           {
2633           tempcond = TRUE;
2634           break;
2635           }
2636       iterate_item = save_iterate_item;
2637       }
2638
2639     }   /* Switch for comparison conditions */
2640
2641   *yield = tempcond == testfor;
2642   return s;    /* End of comparison conditions */
2643
2644
2645   /* and/or: computes logical and/or of several conditions */
2646
2647   case ECOND_AND:
2648   case ECOND_OR:
2649   subcondptr = (yield == NULL)? NULL : &tempcond;
2650   combined_cond = (cond_type == ECOND_AND);
2651
2652   while (isspace(*s)) s++;
2653   if (*s++ != '{') goto COND_FAILED_CURLY_START;        /* }-for-text-editors */
2654
2655   for (;;)
2656     {
2657     while (isspace(*s)) s++;
2658     /* {-for-text-editors */
2659     if (*s == '}') break;
2660     if (*s != '{')                                      /* }-for-text-editors */
2661       {
2662       expand_string_message = string_sprintf("each subcondition "
2663         "inside an \"%s{...}\" condition must be in its own {}", name);
2664       return NULL;
2665       }
2666
2667     s = eval_condition(s+1, subcondptr);
2668     if (s == NULL)
2669       {
2670       expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2671         expand_string_message, name);
2672       return NULL;
2673       }
2674     while (isspace(*s)) s++;
2675
2676     /* {-for-text-editors */
2677     if (*s++ != '}')
2678       {
2679       /* {-for-text-editors */
2680       expand_string_message = string_sprintf("missing } at end of condition "
2681         "inside \"%s\" group", name);
2682       return NULL;
2683       }
2684
2685     if (yield != NULL)
2686       {
2687       if (cond_type == ECOND_AND)
2688         {
2689         combined_cond &= tempcond;
2690         if (!combined_cond) subcondptr = NULL;  /* once false, don't */
2691         }                                       /* evaluate any more */
2692       else
2693         {
2694         combined_cond |= tempcond;
2695         if (combined_cond) subcondptr = NULL;   /* once true, don't */
2696         }                                       /* evaluate any more */
2697       }
2698     }
2699
2700   if (yield != NULL) *yield = (combined_cond == testfor);
2701   return ++s;
2702
2703
2704   /* forall/forany: iterates a condition with different values */
2705
2706   case ECOND_FORALL:
2707   case ECOND_FORANY:
2708     {
2709     int sep = 0;
2710     uschar *save_iterate_item = iterate_item;
2711
2712     while (isspace(*s)) s++;
2713     if (*s++ != '{') goto COND_FAILED_CURLY_START;      /* }-for-text-editors */
2714     sub[0] = expand_string_internal(s, TRUE, &s, (yield == NULL), TRUE);
2715     if (sub[0] == NULL) return NULL;
2716     /* {-for-text-editors */
2717     if (*s++ != '}') goto COND_FAILED_CURLY_END;
2718
2719     while (isspace(*s)) s++;
2720     if (*s++ != '{') goto COND_FAILED_CURLY_START;      /* }-for-text-editors */
2721
2722     sub[1] = s;
2723
2724     /* Call eval_condition once, with result discarded (as if scanning a
2725     "false" part). This allows us to find the end of the condition, because if
2726     the list it empty, we won't actually evaluate the condition for real. */
2727
2728     s = eval_condition(sub[1], NULL);
2729     if (s == NULL)
2730       {
2731       expand_string_message = string_sprintf("%s inside \"%s\" condition",
2732         expand_string_message, name);
2733       return NULL;
2734       }
2735     while (isspace(*s)) s++;
2736
2737     /* {-for-text-editors */
2738     if (*s++ != '}')
2739       {
2740       /* {-for-text-editors */
2741       expand_string_message = string_sprintf("missing } at end of condition "
2742         "inside \"%s\"", name);
2743       return NULL;
2744       }
2745
2746     if (yield != NULL) *yield = !testfor;
2747     while ((iterate_item = string_nextinlist(&sub[0], &sep, NULL, 0)) != NULL)
2748       {
2749       DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
2750       if (eval_condition(sub[1], &tempcond) == NULL)
2751         {
2752         expand_string_message = string_sprintf("%s inside \"%s\" condition",
2753           expand_string_message, name);
2754         iterate_item = save_iterate_item;
2755         return NULL;
2756         }
2757       DEBUG(D_expand) debug_printf("%s: condition evaluated to %s\n", name,
2758         tempcond? "true":"false");
2759
2760       if (yield != NULL) *yield = (tempcond == testfor);
2761       if (tempcond == (cond_type == ECOND_FORANY)) break;
2762       }
2763
2764     iterate_item = save_iterate_item;
2765     return s;
2766     }
2767
2768
2769   /* The bool{} expansion condition maps a string to boolean.
2770   The values supported should match those supported by the ACL condition
2771   (acl.c, ACLC_CONDITION) so that we keep to a minimum the different ideas
2772   of true/false.  Note that Router "condition" rules have a different
2773   interpretation, where general data can be used and only a few values
2774   map to FALSE.
2775   Note that readconf.c boolean matching, for boolean configuration options,
2776   only matches true/yes/false/no.
2777   The bool_lax{} condition matches the Router logic, which is much more
2778   liberal. */
2779   case ECOND_BOOL:
2780   case ECOND_BOOL_LAX:
2781     {
2782     uschar *sub_arg[1];
2783     uschar *t, *t2;
2784     uschar *ourname;
2785     size_t len;
2786     BOOL boolvalue = FALSE;
2787     while (isspace(*s)) s++;
2788     if (*s != '{') goto COND_FAILED_CURLY_START;        /* }-for-text-editors */
2789     ourname = cond_type == ECOND_BOOL_LAX ? US"bool_lax" : US"bool";
2790     switch(read_subs(sub_arg, 1, 1, &s, yield == NULL, FALSE, ourname))
2791       {
2792       case 1: expand_string_message = string_sprintf(
2793                   "too few arguments or bracketing error for %s",
2794                   ourname);
2795       /*FALLTHROUGH*/
2796       case 2:
2797       case 3: return NULL;
2798       }
2799     t = sub_arg[0];
2800     while (isspace(*t)) t++;
2801     len = Ustrlen(t);
2802     if (len)
2803       {
2804       /* trailing whitespace: seems like a good idea to ignore it too */
2805       t2 = t + len - 1;
2806       while (isspace(*t2)) t2--;
2807       if (t2 != (t + len))
2808         {
2809         *++t2 = '\0';
2810         len = t2 - t;
2811         }
2812       }
2813     DEBUG(D_expand)
2814       debug_printf("considering %s: %s\n", ourname, len ? t : US"<empty>");
2815     /* logic for the lax case from expand_check_condition(), which also does
2816     expands, and the logic is both short and stable enough that there should
2817     be no maintenance burden from replicating it. */
2818     if (len == 0)
2819       boolvalue = FALSE;
2820     else if (Ustrspn(t, "0123456789") == len)
2821       {
2822       boolvalue = (Uatoi(t) == 0) ? FALSE : TRUE;
2823       /* expand_check_condition only does a literal string "0" check */
2824       if ((cond_type == ECOND_BOOL_LAX) && (len > 1))
2825         boolvalue = TRUE;
2826       }
2827     else if (strcmpic(t, US"true") == 0 || strcmpic(t, US"yes") == 0)
2828       boolvalue = TRUE;
2829     else if (strcmpic(t, US"false") == 0 || strcmpic(t, US"no") == 0)
2830       boolvalue = FALSE;
2831     else if (cond_type == ECOND_BOOL_LAX)
2832       boolvalue = TRUE;
2833     else
2834       {
2835       expand_string_message = string_sprintf("unrecognised boolean "
2836        "value \"%s\"", t);
2837       return NULL;
2838       }
2839     if (yield != NULL) *yield = (boolvalue == testfor);
2840     return s;
2841     }
2842
2843   /* Unknown condition */
2844
2845   default:
2846   expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2847   return NULL;
2848   }   /* End switch on condition type */
2849
2850 /* Missing braces at start and end of data */
2851
2852 COND_FAILED_CURLY_START:
2853 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2854 return NULL;
2855
2856 COND_FAILED_CURLY_END:
2857 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2858   name);
2859 return NULL;
2860
2861 /* A condition requires code that is not compiled */
2862
2863 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2864     !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2865     !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2866 COND_FAILED_NOT_COMPILED:
2867 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2868   name);
2869 return NULL;
2870 #endif
2871 }
2872
2873
2874
2875
2876 /*************************************************
2877 *          Save numerical variables              *
2878 *************************************************/
2879
2880 /* This function is called from items such as "if" that want to preserve and
2881 restore the numbered variables.
2882
2883 Arguments:
2884   save_expand_string    points to an array of pointers to set
2885   save_expand_nlength   points to an array of ints for the lengths
2886
2887 Returns:                the value of expand max to save
2888 */
2889
2890 static int
2891 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2892 {
2893 int i;
2894 for (i = 0; i <= expand_nmax; i++)
2895   {
2896   save_expand_nstring[i] = expand_nstring[i];
2897   save_expand_nlength[i] = expand_nlength[i];
2898   }
2899 return expand_nmax;
2900 }
2901
2902
2903
2904 /*************************************************
2905 *           Restore numerical variables          *
2906 *************************************************/
2907
2908 /* This function restored saved values of numerical strings.
2909
2910 Arguments:
2911   save_expand_nmax      the number of strings to restore
2912   save_expand_string    points to an array of pointers
2913   save_expand_nlength   points to an array of ints
2914
2915 Returns:                nothing
2916 */
2917
2918 static void
2919 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2920   int *save_expand_nlength)
2921 {
2922 int i;
2923 expand_nmax = save_expand_nmax;
2924 for (i = 0; i <= expand_nmax; i++)
2925   {
2926   expand_nstring[i] = save_expand_nstring[i];
2927   expand_nlength[i] = save_expand_nlength[i];
2928   }
2929 }
2930
2931
2932
2933
2934
2935 /*************************************************
2936 *            Handle yes/no substrings            *
2937 *************************************************/
2938
2939 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2940 alternative substrings that depend on whether or not the condition was true,
2941 or the lookup or extraction succeeded. The substrings always have to be
2942 expanded, to check their syntax, but "skipping" is set when the result is not
2943 needed - this avoids unnecessary nested lookups.
2944
2945 Arguments:
2946   skipping       TRUE if we were skipping when this item was reached
2947   yes            TRUE if the first string is to be used, else use the second
2948   save_lookup    a value to put back into lookup_value before the 2nd expansion
2949   sptr           points to the input string pointer
2950   yieldptr       points to the output string pointer
2951   sizeptr        points to the output string size
2952   ptrptr         points to the output string pointer
2953   type           "lookup" or "if" or "extract" or "run", for error message
2954
2955 Returns:         0 OK; lookup_value has been reset to save_lookup
2956                  1 expansion failed
2957                  2 expansion failed because of bracketing error
2958 */
2959
2960 static int
2961 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2962   uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type)
2963 {
2964 int rc = 0;
2965 uschar *s = *sptr;    /* Local value */
2966 uschar *sub1, *sub2;
2967
2968 /* If there are no following strings, we substitute the contents of $value for
2969 lookups and for extractions in the success case. For the ${if item, the string
2970 "true" is substituted. In the fail case, nothing is substituted for all three
2971 items. */
2972
2973 while (isspace(*s)) s++;
2974 if (*s == '}')
2975   {
2976   if (type[0] == 'i')
2977     {
2978     if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
2979     }
2980   else
2981     {
2982     if (yes && lookup_value != NULL)
2983       *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
2984         Ustrlen(lookup_value));
2985     lookup_value = save_lookup;
2986     }
2987   s++;
2988   goto RETURN;
2989   }
2990
2991 /* The first following string must be braced. */
2992
2993 if (*s++ != '{') goto FAILED_CURLY;
2994
2995 /* Expand the first substring. Forced failures are noticed only if we actually
2996 want this string. Set skipping in the call in the fail case (this will always
2997 be the case if we were already skipping). */
2998
2999 sub1 = expand_string_internal(s, TRUE, &s, !yes, TRUE);
3000 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
3001 expand_string_forcedfail = FALSE;
3002 if (*s++ != '}') goto FAILED_CURLY;
3003
3004 /* If we want the first string, add it to the output */
3005
3006 if (yes)
3007   *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
3008
3009 /* If this is called from a lookup or an extract, we want to restore $value to
3010 what it was at the start of the item, so that it has this value during the
3011 second string expansion. For the call from "if" or "run" to this function,
3012 save_lookup is set to lookup_value, so that this statement does nothing. */
3013
3014 lookup_value = save_lookup;
3015
3016 /* There now follows either another substring, or "fail", or nothing. This
3017 time, forced failures are noticed only if we want the second string. We must
3018 set skipping in the nested call if we don't want this string, or if we were
3019 already skipping. */
3020
3021 while (isspace(*s)) s++;
3022 if (*s == '{')
3023   {
3024   sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping, TRUE);
3025   if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
3026   expand_string_forcedfail = FALSE;
3027   if (*s++ != '}') goto FAILED_CURLY;
3028
3029   /* If we want the second string, add it to the output */
3030
3031   if (!yes)
3032     *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
3033   }
3034
3035 /* If there is no second string, but the word "fail" is present when the use of
3036 the second string is wanted, set a flag indicating it was a forced failure
3037 rather than a syntactic error. Swallow the terminating } in case this is nested
3038 inside another lookup or if or extract. */
3039
3040 else if (*s != '}')
3041   {
3042   uschar name[256];
3043   s = read_name(name, sizeof(name), s, US"_");
3044   if (Ustrcmp(name, "fail") == 0)
3045     {
3046     if (!yes && !skipping)
3047       {
3048       while (isspace(*s)) s++;
3049       if (*s++ != '}') goto FAILED_CURLY;
3050       expand_string_message =
3051         string_sprintf("\"%s\" failed and \"fail\" requested", type);
3052       expand_string_forcedfail = TRUE;
3053       goto FAILED;
3054       }
3055     }
3056   else
3057     {
3058     expand_string_message =
3059       string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
3060     goto FAILED;
3061     }
3062   }
3063
3064 /* All we have to do now is to check on the final closing brace. */
3065
3066 while (isspace(*s)) s++;
3067 if (*s++ == '}') goto RETURN;
3068
3069 /* Get here if there is a bracketing failure */
3070
3071 FAILED_CURLY:
3072 rc++;
3073
3074 /* Get here for other failures */
3075
3076 FAILED:
3077 rc++;
3078
3079 /* Update the input pointer value before returning */
3080
3081 RETURN:
3082 *sptr = s;
3083 return rc;
3084 }
3085
3086
3087
3088
3089 /*************************************************
3090 *    Handle MD5 or SHA-1 computation for HMAC    *
3091 *************************************************/
3092
3093 /* These are some wrapping functions that enable the HMAC code to be a bit
3094 cleaner. A good compiler will spot the tail recursion.
3095
3096 Arguments:
3097   type         HMAC_MD5 or HMAC_SHA1
3098   remaining    are as for the cryptographic hash functions
3099
3100 Returns:       nothing
3101 */
3102
3103 static void
3104 chash_start(int type, void *base)
3105 {
3106 if (type == HMAC_MD5)
3107   md5_start((md5 *)base);
3108 else
3109   sha1_start((sha1 *)base);
3110 }
3111
3112 static void
3113 chash_mid(int type, void *base, uschar *string)
3114 {
3115 if (type == HMAC_MD5)
3116   md5_mid((md5 *)base, string);
3117 else
3118   sha1_mid((sha1 *)base, string);
3119 }
3120
3121 static void
3122 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
3123 {
3124 if (type == HMAC_MD5)
3125   md5_end((md5 *)base, string, length, digest);
3126 else
3127   sha1_end((sha1 *)base, string, length, digest);
3128 }
3129
3130
3131
3132
3133
3134 /********************************************************
3135 * prvs: Get last three digits of days since Jan 1, 1970 *
3136 ********************************************************/
3137
3138 /* This is needed to implement the "prvs" BATV reverse
3139    path signing scheme
3140
3141 Argument: integer "days" offset to add or substract to
3142           or from the current number of days.
3143
3144 Returns:  pointer to string containing the last three
3145           digits of the number of days since Jan 1, 1970,
3146           modified by the offset argument, NULL if there
3147           was an error in the conversion.
3148
3149 */
3150
3151 static uschar *
3152 prvs_daystamp(int day_offset)
3153 {
3154 uschar *days = store_get(32);                /* Need at least 24 for cases */
3155 (void)string_format(days, 32, TIME_T_FMT,    /* where TIME_T_FMT is %lld */
3156   (time(NULL) + day_offset*86400)/86400);
3157 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
3158 }
3159
3160
3161
3162 /********************************************************
3163 *   prvs: perform HMAC-SHA1 computation of prvs bits    *
3164 ********************************************************/
3165
3166 /* This is needed to implement the "prvs" BATV reverse
3167    path signing scheme
3168
3169 Arguments:
3170   address RFC2821 Address to use
3171       key The key to use (must be less than 64 characters
3172           in size)
3173   key_num Single-digit key number to use. Defaults to
3174           '0' when NULL.
3175
3176 Returns:  pointer to string containing the first three
3177           bytes of the final hash in hex format, NULL if
3178           there was an error in the process.
3179 */
3180
3181 static uschar *
3182 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
3183 {
3184 uschar *hash_source, *p;
3185 int size = 0,offset = 0,i;
3186 sha1 sha1_base;
3187 void *use_base = &sha1_base;
3188 uschar innerhash[20];
3189 uschar finalhash[20];
3190 uschar innerkey[64];
3191 uschar outerkey[64];
3192 uschar *finalhash_hex = store_get(40);
3193
3194 if (key_num == NULL)
3195   key_num = US"0";
3196
3197 if (Ustrlen(key) > 64)
3198   return NULL;
3199
3200 hash_source = string_cat(NULL,&size,&offset,key_num,1);
3201 string_cat(hash_source,&size,&offset,daystamp,3);
3202 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
3203 hash_source[offset] = '\0';
3204
3205 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
3206
3207 memset(innerkey, 0x36, 64);
3208 memset(outerkey, 0x5c, 64);
3209
3210 for (i = 0; i < Ustrlen(key); i++)
3211   {
3212   innerkey[i] ^= key[i];
3213   outerkey[i] ^= key[i];
3214   }
3215
3216 chash_start(HMAC_SHA1, use_base);
3217 chash_mid(HMAC_SHA1, use_base, innerkey);
3218 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
3219
3220 chash_start(HMAC_SHA1, use_base);
3221 chash_mid(HMAC_SHA1, use_base, outerkey);
3222 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
3223
3224 p = finalhash_hex;
3225 for (i = 0; i < 3; i++)
3226   {
3227   *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3228   *p++ = hex_digits[finalhash[i] & 0x0f];
3229   }
3230 *p = '\0';
3231
3232 return finalhash_hex;
3233 }
3234
3235
3236
3237
3238 /*************************************************
3239 *        Join a file onto the output string      *
3240 *************************************************/
3241
3242 /* This is used for readfile and after a run expansion. It joins the contents
3243 of a file onto the output string, globally replacing newlines with a given
3244 string (optionally). The file is closed at the end.
3245
3246 Arguments:
3247   f            the FILE
3248   yield        pointer to the expandable string
3249   sizep        pointer to the current size
3250   ptrp         pointer to the current position
3251   eol          newline replacement string, or NULL
3252
3253 Returns:       new value of string pointer
3254 */
3255
3256 static uschar *
3257 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
3258 {
3259 int eollen;
3260 uschar buffer[1024];
3261
3262 eollen = (eol == NULL)? 0 : Ustrlen(eol);
3263
3264 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
3265   {
3266   int len = Ustrlen(buffer);
3267   if (eol != NULL && buffer[len-1] == '\n') len--;
3268   yield = string_cat(yield, sizep, ptrp, buffer, len);
3269   if (buffer[len] != 0)
3270     yield = string_cat(yield, sizep, ptrp, eol, eollen);
3271   }
3272
3273 if (yield != NULL) yield[*ptrp] = 0;
3274
3275 return yield;
3276 }
3277
3278
3279
3280
3281 /*************************************************
3282 *          Evaluate numeric expression           *
3283 *************************************************/
3284
3285 /* This is a set of mutually recursive functions that evaluate an arithmetic
3286 expression involving + - * / % & | ^ ~ << >> and parentheses. The only one of
3287 these functions that is called from elsewhere is eval_expr, whose interface is:
3288
3289 Arguments:
3290   sptr        pointer to the pointer to the string - gets updated
3291   decimal     TRUE if numbers are to be assumed decimal
3292   error       pointer to where to put an error message - must be NULL on input
3293   endket      TRUE if ')' must terminate - FALSE for external call
3294
3295 Returns:      on success: the value of the expression, with *error still NULL
3296               on failure: an undefined value, with *error = a message
3297 */
3298
3299 static int_eximarith_t eval_op_or(uschar **, BOOL, uschar **);
3300
3301
3302 static int_eximarith_t
3303 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3304 {
3305 uschar *s = *sptr;
3306 int_eximarith_t x = eval_op_or(&s, decimal, error);
3307 if (*error == NULL)
3308   {
3309   if (endket)
3310     {
3311     if (*s != ')')
3312       *error = US"expecting closing parenthesis";
3313     else
3314       while (isspace(*(++s)));
3315     }
3316   else if (*s != 0) *error = US"expecting operator";
3317   }
3318 *sptr = s;
3319 return x;
3320 }
3321
3322
3323 static int_eximarith_t
3324 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3325 {
3326 register int c;
3327 int_eximarith_t n;
3328 uschar *s = *sptr;
3329 while (isspace(*s)) s++;
3330 c = *s;
3331 if (isdigit(c))
3332   {
3333   int count;
3334   (void)sscanf(CS s, (decimal? SC_EXIM_DEC "%n" : SC_EXIM_ARITH "%n"), &n, &count);
3335   s += count;
3336   switch (tolower(*s))
3337     {
3338     default: break;
3339     case 'k': n *= 1024; s++; break;
3340     case 'm': n *= 1024*1024; s++; break;
3341     case 'g': n *= 1024*1024*1024; s++; break;
3342     }
3343   while (isspace (*s)) s++;
3344   }
3345 else if (c == '(')
3346   {
3347   s++;
3348   n = eval_expr(&s, decimal, error, 1);
3349   }
3350 else
3351   {
3352   *error = US"expecting number or opening parenthesis";
3353   n = 0;
3354   }
3355 *sptr = s;
3356 return n;
3357 }
3358
3359
3360 static int_eximarith_t
3361 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3362 {
3363 uschar *s = *sptr;
3364 int_eximarith_t x;
3365 while (isspace(*s)) s++;
3366 if (*s == '+' || *s == '-' || *s == '~')
3367   {
3368   int op = *s++;
3369   x = eval_op_unary(&s, decimal, error);
3370   if (op == '-') x = -x;
3371     else if (op == '~') x = ~x;
3372   }
3373 else
3374   {
3375   x = eval_number(&s, decimal, error);
3376   }
3377 *sptr = s;
3378 return x;
3379 }
3380
3381
3382 static int_eximarith_t
3383 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3384 {
3385 uschar *s = *sptr;
3386 int_eximarith_t x = eval_op_unary(&s, decimal, error);
3387 if (*error == NULL)
3388   {
3389   while (*s == '*' || *s == '/' || *s == '%')
3390     {
3391     int op = *s++;
3392     int_eximarith_t y = eval_op_unary(&s, decimal, error);
3393     if (*error != NULL) break;
3394     /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3395      * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3396      * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64].  In fact, -N*-M where
3397      * -N*M is INT_MIN will yielf INT_MIN.
3398      * Since we don't support floating point, this is somewhat simpler.
3399      * Ideally, we'd return an error, but since we overflow for all other
3400      * arithmetic, consistency suggests otherwise, but what's the correct value
3401      * to use?  There is none.
3402      * The C standard guarantees overflow for unsigned arithmetic but signed
3403      * overflow invokes undefined behaviour; in practice, this is overflow
3404      * except for converting INT_MIN to INT_MAX+1.  We also can't guarantee
3405      * that long/longlong larger than int are available, or we could just work
3406      * with larger types.  We should consider whether to guarantee 32bit eval
3407      * and 64-bit working variables, with errors returned.  For now ...
3408      * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3409      * can just let the other invalid results occur otherwise, as they have
3410      * until now.  For this one case, we can coerce.
3411      */
3412     if (y == -1 && x == EXIM_ARITH_MIN && op != '*')
3413       {
3414       DEBUG(D_expand)
3415         debug_printf("Integer exception dodging: " PR_EXIM_ARITH "%c-1 coerced to " PR_EXIM_ARITH "\n",
3416             EXIM_ARITH_MIN, op, EXIM_ARITH_MAX);
3417       x = EXIM_ARITH_MAX;
3418       continue;
3419       }
3420     if (op == '*')
3421       x *= y;
3422     else
3423       {
3424       if (y == 0)
3425         {
3426         *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3427         x = 0;
3428         break;
3429         }
3430       if (op == '/')
3431         x /= y;
3432       else
3433         x %= y;
3434       }
3435     }
3436   }
3437 *sptr = s;
3438 return x;
3439 }
3440
3441
3442 static int_eximarith_t
3443 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3444 {
3445 uschar *s = *sptr;
3446 int_eximarith_t x = eval_op_mult(&s, decimal, error);
3447 if (*error == NULL)
3448   {
3449   while (*s == '+' || *s == '-')
3450     {
3451     int op = *s++;
3452     int_eximarith_t y = eval_op_mult(&s, decimal, error);
3453     if (*error != NULL) break;
3454     if (op == '+') x += y; else x -= y;
3455     }
3456   }
3457 *sptr = s;
3458 return x;
3459 }
3460
3461
3462 static int_eximarith_t
3463 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3464 {
3465 uschar *s = *sptr;
3466 int_eximarith_t x = eval_op_sum(&s, decimal, error);
3467 if (*error == NULL)
3468   {
3469   while ((*s == '<' || *s == '>') && s[1] == s[0])
3470     {
3471     int_eximarith_t y;
3472     int op = *s++;
3473     s++;
3474     y = eval_op_sum(&s, decimal, error);
3475     if (*error != NULL) break;
3476     if (op == '<') x <<= y; else x >>= y;
3477     }
3478   }
3479 *sptr = s;
3480 return x;
3481 }
3482
3483
3484 static int_eximarith_t
3485 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3486 {
3487 uschar *s = *sptr;
3488 int_eximarith_t x = eval_op_shift(&s, decimal, error);
3489 if (*error == NULL)
3490   {
3491   while (*s == '&')
3492     {
3493     int_eximarith_t y;
3494     s++;
3495     y = eval_op_shift(&s, decimal, error);
3496     if (*error != NULL) break;
3497     x &= y;
3498     }
3499   }
3500 *sptr = s;
3501 return x;
3502 }
3503
3504
3505 static int_eximarith_t
3506 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3507 {
3508 uschar *s = *sptr;
3509 int_eximarith_t x = eval_op_and(&s, decimal, error);
3510 if (*error == NULL)
3511   {
3512   while (*s == '^')
3513     {
3514     int_eximarith_t y;
3515     s++;
3516     y = eval_op_and(&s, decimal, error);
3517     if (*error != NULL) break;
3518     x ^= y;
3519     }
3520   }
3521 *sptr = s;
3522 return x;
3523 }
3524
3525
3526 static int_eximarith_t
3527 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3528 {
3529 uschar *s = *sptr;
3530 int_eximarith_t x = eval_op_xor(&s, decimal, error);
3531 if (*error == NULL)
3532   {
3533   while (*s == '|')
3534     {
3535     int_eximarith_t y;
3536     s++;
3537     y = eval_op_xor(&s, decimal, error);
3538     if (*error != NULL) break;
3539     x |= y;
3540     }
3541   }
3542 *sptr = s;
3543 return x;
3544 }
3545
3546
3547
3548 /*************************************************
3549 *                 Expand string                  *
3550 *************************************************/
3551
3552 /* Returns either an unchanged string, or the expanded string in stacking pool
3553 store. Interpreted sequences are:
3554
3555    \...                    normal escaping rules
3556    $name                   substitutes the variable
3557    ${name}                 ditto
3558    ${op:string}            operates on the expanded string value
3559    ${item{arg1}{arg2}...}  expands the args and then does the business
3560                              some literal args are not enclosed in {}
3561
3562 There are now far too many operators and item types to make it worth listing
3563 them here in detail any more.
3564
3565 We use an internal routine recursively to handle embedded substrings. The
3566 external function follows. The yield is NULL if the expansion failed, and there
3567 are two cases: if something collapsed syntactically, or if "fail" was given
3568 as the action on a lookup failure. These can be distinguised by looking at the
3569 variable expand_string_forcedfail, which is TRUE in the latter case.
3570
3571 The skipping flag is set true when expanding a substring that isn't actually
3572 going to be used (after "if" or "lookup") and it prevents lookups from
3573 happening lower down.
3574
3575 Store usage: At start, a store block of the length of the input plus 64
3576 is obtained. This is expanded as necessary by string_cat(), which might have to
3577 get a new block, or might be able to expand the original. At the end of the
3578 function we can release any store above that portion of the yield block that
3579 was actually used. In many cases this will be optimal.
3580
3581 However: if the first item in the expansion is a variable name or header name,
3582 we reset the store before processing it; if the result is in fresh store, we
3583 use that without copying. This is helpful for expanding strings like
3584 $message_headers which can get very long.
3585
3586 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3587 since resetting the store at the end of the expansion will free store that was
3588 allocated by the plugin code as well as the slop after the expanded string. So
3589 we skip any resets if ${dlfunc has been used. The same applies for ${acl. This
3590 is an unfortunate consequence of string expansion becoming too powerful.
3591
3592 Arguments:
3593   string         the string to be expanded
3594   ket_ends       true if expansion is to stop at }
3595   left           if not NULL, a pointer to the first character after the
3596                  expansion is placed here (typically used with ket_ends)
3597   skipping       TRUE for recursive calls when the value isn't actually going
3598                  to be used (to allow for optimisation)
3599   honour_dollar  TRUE if $ is to be expanded,
3600                  FALSE if it's just another character
3601
3602 Returns:         NULL if expansion fails:
3603                    expand_string_forcedfail is set TRUE if failure was forced
3604                    expand_string_message contains a textual error message
3605                  a pointer to the expanded string on success
3606 */
3607
3608 static uschar *
3609 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
3610   BOOL skipping, BOOL honour_dollar)
3611 {
3612 int ptr = 0;
3613 int size = Ustrlen(string)+ 64;
3614 int item_type;
3615 uschar *yield = store_get(size);
3616 uschar *s = string;
3617 uschar *save_expand_nstring[EXPAND_MAXN+1];
3618 int save_expand_nlength[EXPAND_MAXN+1];
3619 BOOL resetok = TRUE;
3620
3621 expand_string_forcedfail = FALSE;
3622 expand_string_message = US"";
3623
3624 while (*s != 0)
3625   {
3626   uschar *value;
3627   uschar name[256];
3628
3629   /* \ escapes the next character, which must exist, or else
3630   the expansion fails. There's a special escape, \N, which causes
3631   copying of the subject verbatim up to the next \N. Otherwise,
3632   the escapes are the standard set. */
3633
3634   if (*s == '\\')
3635     {
3636     if (s[1] == 0)
3637       {
3638       expand_string_message = US"\\ at end of string";
3639       goto EXPAND_FAILED;
3640       }
3641
3642     if (s[1] == 'N')
3643       {
3644       uschar *t = s + 2;
3645       for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3646       yield = string_cat(yield, &size, &ptr, t, s - t);
3647       if (*s != 0) s += 2;
3648       }
3649
3650     else
3651       {
3652       uschar ch[1];
3653       ch[0] = string_interpret_escape(&s);
3654       s++;
3655       yield = string_cat(yield, &size, &ptr, ch, 1);
3656       }
3657
3658     continue;
3659     }
3660
3661   /* Anything other than $ is just copied verbatim, unless we are
3662   looking for a terminating } character. */
3663
3664   if (ket_ends && *s == '}') break;
3665
3666   if (*s != '$' || !honour_dollar)
3667     {
3668     yield = string_cat(yield, &size, &ptr, s++, 1);
3669     continue;
3670     }
3671
3672   /* No { after the $ - must be a plain name or a number for string
3673   match variable. There has to be a fudge for variables that are the
3674   names of header fields preceded by "$header_" because header field
3675   names can contain any printing characters except space and colon.
3676   For those that don't like typing this much, "$h_" is a synonym for
3677   "$header_". A non-existent header yields a NULL value; nothing is
3678   inserted. */
3679
3680   if (isalpha((*(++s))))
3681     {
3682     int len;
3683     int newsize = 0;
3684
3685     s = read_name(name, sizeof(name), s, US"_");
3686
3687     /* If this is the first thing to be expanded, release the pre-allocated
3688     buffer. */
3689
3690     if (ptr == 0 && yield != NULL)
3691       {
3692       if (resetok) store_reset(yield);
3693       yield = NULL;
3694       size = 0;
3695       }
3696
3697     /* Header */
3698
3699     if (Ustrncmp(name, "h_", 2) == 0 ||
3700         Ustrncmp(name, "rh_", 3) == 0 ||
3701         Ustrncmp(name, "bh_", 3) == 0 ||
3702         Ustrncmp(name, "header_", 7) == 0 ||
3703         Ustrncmp(name, "rheader_", 8) == 0 ||
3704         Ustrncmp(name, "bheader_", 8) == 0)
3705       {
3706       BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3707       uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3708       s = read_header_name(name, sizeof(name), s);
3709       value = find_header(name, FALSE, &newsize, want_raw, charset);
3710
3711       /* If we didn't find the header, and the header contains a closing brace
3712       character, this may be a user error where the terminating colon
3713       has been omitted. Set a flag to adjust the error message in this case.
3714       But there is no error here - nothing gets inserted. */
3715
3716       if (value == NULL)
3717         {
3718         if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3719         continue;
3720         }
3721       }
3722
3723     /* Variable */
3724
3725     else
3726       {
3727       value = find_variable(name, FALSE, skipping, &newsize);
3728       if (value == NULL)
3729         {
3730         expand_string_message =
3731           string_sprintf("unknown variable name \"%s\"", name);
3732           check_variable_error_message(name);
3733         goto EXPAND_FAILED;
3734         }
3735       }
3736
3737     /* If the data is known to be in a new buffer, newsize will be set to the
3738     size of that buffer. If this is the first thing in an expansion string,
3739     yield will be NULL; just point it at the new store instead of copying. Many
3740     expansion strings contain just one reference, so this is a useful
3741     optimization, especially for humungous headers. */
3742
3743     len = Ustrlen(value);
3744     if (yield == NULL && newsize != 0)
3745       {
3746       yield = value;
3747       size = newsize;
3748       ptr = len;
3749       }
3750     else yield = string_cat(yield, &size, &ptr, value, len);
3751
3752     continue;
3753     }
3754
3755   if (isdigit(*s))
3756     {
3757     int n;
3758     s = read_number(&n, s);
3759     if (n >= 0 && n <= expand_nmax)
3760       yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3761         expand_nlength[n]);
3762     continue;
3763     }
3764
3765   /* Otherwise, if there's no '{' after $ it's an error. */
3766
3767   if (*s != '{')
3768     {
3769     expand_string_message = US"$ not followed by letter, digit, or {";
3770     goto EXPAND_FAILED;
3771     }
3772
3773   /* After { there can be various things, but they all start with
3774   an initial word, except for a number for a string match variable. */
3775
3776   if (isdigit((*(++s))))
3777     {
3778     int n;
3779     s = read_number(&n, s);
3780     if (*s++ != '}')
3781       {
3782       expand_string_message = US"} expected after number";
3783       goto EXPAND_FAILED;
3784       }
3785     if (n >= 0 && n <= expand_nmax)
3786       yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3787         expand_nlength[n]);
3788     continue;
3789     }
3790
3791   if (!isalpha(*s))
3792     {
3793     expand_string_message = US"letter or digit expected after ${";
3794     goto EXPAND_FAILED;
3795     }
3796
3797   /* Allow "-" in names to cater for substrings with negative
3798   arguments. Since we are checking for known names after { this is
3799   OK. */
3800
3801   s = read_name(name, sizeof(name), s, US"_-");
3802   item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3803
3804   switch(item_type)
3805     {
3806     /* Call an ACL from an expansion.  We feed data in via $acl_arg1 - $acl_arg9.
3807     If the ACL returns accept or reject we return content set by "message ="
3808     There is currently no limit on recursion; this would have us call
3809     acl_check_internal() directly and get a current level from somewhere.
3810     See also the acl expansion condition ECOND_ACL and the traditional
3811     acl modifier ACLC_ACL.
3812     Assume that the function has side-effects on the store that must be preserved.
3813     */
3814
3815     case EITEM_ACL:
3816       /* ${acl {name} {arg1}{arg2}...} */
3817       {
3818       uschar *sub[10];  /* name + arg1-arg9 (which must match number of acl_arg[]) */
3819       uschar *user_msg;
3820
3821       switch(read_subs(sub, 10, 1, &s, skipping, TRUE, US"acl"))
3822         {
3823         case 1: goto EXPAND_FAILED_CURLY;
3824         case 2:
3825         case 3: goto EXPAND_FAILED;
3826         }
3827       if (skipping) continue;
3828
3829       resetok = FALSE;
3830       switch(eval_acl(sub, sizeof(sub)/sizeof(*sub), &user_msg))
3831         {
3832         case OK:
3833         case FAIL:
3834           if (user_msg)
3835             yield = string_cat(yield, &size, &ptr, user_msg, Ustrlen(user_msg));
3836           continue;
3837
3838         case DEFER:
3839           expand_string_forcedfail = TRUE;
3840         default:
3841           expand_string_message = string_sprintf("error from acl \"%s\"", sub[0]);
3842           goto EXPAND_FAILED;
3843         }
3844       }
3845
3846     /* Handle conditionals - preserve the values of the numerical expansion
3847     variables in case they get changed by a regular expression match in the
3848     condition. If not, they retain their external settings. At the end
3849     of this "if" section, they get restored to their previous values. */
3850
3851     case EITEM_IF:
3852       {
3853       BOOL cond = FALSE;
3854       uschar *next_s;
3855       int save_expand_nmax =
3856         save_expand_strings(save_expand_nstring, save_expand_nlength);
3857
3858       while (isspace(*s)) s++;
3859       next_s = eval_condition(s, skipping? NULL : &cond);
3860       if (next_s == NULL) goto EXPAND_FAILED;  /* message already set */
3861
3862       DEBUG(D_expand)
3863         debug_printf("condition: %.*s\n   result: %s\n", (int)(next_s - s), s,
3864           cond? "true" : "false");
3865
3866       s = next_s;
3867
3868       /* The handling of "yes" and "no" result strings is now in a separate
3869       function that is also used by ${lookup} and ${extract} and ${run}. */
3870
3871       switch(process_yesno(
3872                skipping,                     /* were previously skipping */
3873                cond,                         /* success/failure indicator */
3874                lookup_value,                 /* value to reset for string2 */
3875                &s,                           /* input pointer */
3876                &yield,                       /* output pointer */
3877                &size,                        /* output size */
3878                &ptr,                         /* output current point */
3879                US"if"))                      /* condition type */
3880         {
3881         case 1: goto EXPAND_FAILED;          /* when all is well, the */
3882         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
3883         }
3884
3885       /* Restore external setting of expansion variables for continuation
3886       at this level. */
3887
3888       restore_expand_strings(save_expand_nmax, save_expand_nstring,
3889         save_expand_nlength);
3890       continue;
3891       }
3892
3893     /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
3894     expanding an internal string that isn't actually going to be used. All we
3895     need to do is check the syntax, so don't do a lookup at all. Preserve the
3896     values of the numerical expansion variables in case they get changed by a
3897     partial lookup. If not, they retain their external settings. At the end
3898     of this "lookup" section, they get restored to their previous values. */
3899
3900     case EITEM_LOOKUP:
3901       {
3902       int stype, partial, affixlen, starflags;
3903       int expand_setup = 0;
3904       int nameptr = 0;
3905       uschar *key, *filename, *affix;
3906       uschar *save_lookup_value = lookup_value;
3907       int save_expand_nmax =
3908         save_expand_strings(save_expand_nstring, save_expand_nlength);
3909
3910       if ((expand_forbid & RDO_LOOKUP) != 0)
3911         {
3912         expand_string_message = US"lookup expansions are not permitted";
3913         goto EXPAND_FAILED;
3914         }
3915
3916       /* Get the key we are to look up for single-key+file style lookups.
3917       Otherwise set the key NULL pro-tem. */
3918
3919       while (isspace(*s)) s++;
3920       if (*s == '{')
3921         {
3922         key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
3923         if (key == NULL) goto EXPAND_FAILED;
3924         if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3925         while (isspace(*s)) s++;
3926         }
3927       else key = NULL;
3928
3929       /* Find out the type of database */
3930
3931       if (!isalpha(*s))
3932         {
3933         expand_string_message = US"missing lookup type";
3934         goto EXPAND_FAILED;
3935         }
3936
3937       /* The type is a string that may contain special characters of various
3938       kinds. Allow everything except space or { to appear; the actual content
3939       is checked by search_findtype_partial. */
3940
3941       while (*s != 0 && *s != '{' && !isspace(*s))
3942         {
3943         if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
3944         s++;
3945         }
3946       name[nameptr] = 0;
3947       while (isspace(*s)) s++;
3948
3949       /* Now check for the individual search type and any partial or default
3950       options. Only those types that are actually in the binary are valid. */
3951
3952       stype = search_findtype_partial(name, &partial, &affix, &affixlen,
3953         &starflags);
3954       if (stype < 0)
3955         {
3956         expand_string_message = search_error_message;
3957         goto EXPAND_FAILED;
3958         }
3959
3960       /* Check that a key was provided for those lookup types that need it,
3961       and was not supplied for those that use the query style. */
3962
3963       if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
3964         {
3965         if (key == NULL)
3966           {
3967           expand_string_message = string_sprintf("missing {key} for single-"
3968             "key \"%s\" lookup", name);
3969           goto EXPAND_FAILED;
3970           }
3971         }
3972       else
3973         {
3974         if (key != NULL)
3975           {
3976           expand_string_message = string_sprintf("a single key was given for "
3977             "lookup type \"%s\", which is not a single-key lookup type", name);
3978           goto EXPAND_FAILED;
3979           }
3980         }
3981
3982       /* Get the next string in brackets and expand it. It is the file name for
3983       single-key+file lookups, and the whole query otherwise. In the case of
3984       queries that also require a file name (e.g. sqlite), the file name comes
3985       first. */
3986
3987       if (*s != '{') goto EXPAND_FAILED_CURLY;
3988       filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
3989       if (filename == NULL) goto EXPAND_FAILED;
3990       if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3991       while (isspace(*s)) s++;
3992
3993       /* If this isn't a single-key+file lookup, re-arrange the variables
3994       to be appropriate for the search_ functions. For query-style lookups,
3995       there is just a "key", and no file name. For the special query-style +
3996       file types, the query (i.e. "key") starts with a file name. */
3997
3998       if (key == NULL)
3999         {
4000         while (isspace(*filename)) filename++;
4001         key = filename;
4002
4003         if (mac_islookup(stype, lookup_querystyle))
4004           {
4005           filename = NULL;
4006           }
4007         else
4008           {
4009           if (*filename != '/')
4010             {
4011             expand_string_message = string_sprintf(
4012               "absolute file name expected for \"%s\" lookup", name);
4013             goto EXPAND_FAILED;
4014             }
4015           while (*key != 0 && !isspace(*key)) key++;
4016           if (*key != 0) *key++ = 0;
4017           }
4018         }
4019
4020       /* If skipping, don't do the next bit - just lookup_value == NULL, as if
4021       the entry was not found. Note that there is no search_close() function.
4022       Files are left open in case of re-use. At suitable places in higher logic,
4023       search_tidyup() is called to tidy all open files. This can save opening
4024       the same file several times. However, files may also get closed when
4025       others are opened, if too many are open at once. The rule is that a
4026       handle should not be used after a second search_open().
4027
4028       Request that a partial search sets up $1 and maybe $2 by passing
4029       expand_setup containing zero. If its value changes, reset expand_nmax,
4030       since new variables will have been set. Note that at the end of this
4031       "lookup" section, the old numeric variables are restored. */
4032
4033       if (skipping)
4034         lookup_value = NULL;
4035       else
4036         {
4037         void *handle = search_open(filename, stype, 0, NULL, NULL);
4038         if (handle == NULL)
4039           {
4040           expand_string_message = search_error_message;
4041           goto EXPAND_FAILED;
4042           }
4043         lookup_value = search_find(handle, filename, key, partial, affix,
4044           affixlen, starflags, &expand_setup);
4045         if (search_find_defer)
4046           {
4047           expand_string_message =
4048             string_sprintf("lookup of \"%s\" gave DEFER: %s",
4049               string_printing2(key, FALSE), search_error_message);
4050           goto EXPAND_FAILED;
4051           }
4052         if (expand_setup > 0) expand_nmax = expand_setup;
4053         }
4054
4055       /* The handling of "yes" and "no" result strings is now in a separate
4056       function that is also used by ${if} and ${extract}. */
4057
4058       switch(process_yesno(
4059                skipping,                     /* were previously skipping */
4060                lookup_value != NULL,         /* success/failure indicator */
4061                save_lookup_value,            /* value to reset for string2 */
4062                &s,                           /* input pointer */
4063                &yield,                       /* output pointer */
4064                &size,                        /* output size */
4065                &ptr,                         /* output current point */
4066                US"lookup"))                  /* condition type */
4067         {
4068         case 1: goto EXPAND_FAILED;          /* when all is well, the */
4069         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
4070         }
4071
4072       /* Restore external setting of expansion variables for carrying on
4073       at this level, and continue. */
4074
4075       restore_expand_strings(save_expand_nmax, save_expand_nstring,
4076         save_expand_nlength);
4077       continue;
4078       }
4079
4080     /* If Perl support is configured, handle calling embedded perl subroutines,
4081     unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
4082     or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
4083     arguments (defined below). */
4084
4085     #define EXIM_PERL_MAX_ARGS 8
4086
4087     case EITEM_PERL:
4088     #ifndef EXIM_PERL
4089     expand_string_message = US"\"${perl\" encountered, but this facility "
4090       "is not included in this binary";
4091     goto EXPAND_FAILED;
4092
4093     #else   /* EXIM_PERL */
4094       {
4095       uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
4096       uschar *new_yield;
4097
4098       if ((expand_forbid & RDO_PERL) != 0)
4099         {
4100         expand_string_message = US"Perl calls are not permitted";
4101         goto EXPAND_FAILED;
4102         }
4103
4104       switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
4105            US"perl"))
4106         {
4107         case 1: goto EXPAND_FAILED_CURLY;
4108         case 2:
4109         case 3: goto EXPAND_FAILED;
4110         }
4111
4112       /* If skipping, we don't actually do anything */
4113
4114       if (skipping) continue;
4115
4116       /* Start the interpreter if necessary */
4117
4118       if (!opt_perl_started)
4119         {
4120         uschar *initerror;
4121         if (opt_perl_startup == NULL)
4122           {
4123           expand_string_message = US"A setting of perl_startup is needed when "
4124             "using the Perl interpreter";
4125           goto EXPAND_FAILED;
4126           }
4127         DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
4128         initerror = init_perl(opt_perl_startup);
4129         if (initerror != NULL)
4130           {
4131           expand_string_message =
4132             string_sprintf("error in perl_startup code: %s\n", initerror);
4133           goto EXPAND_FAILED;
4134           }
4135         opt_perl_started = TRUE;
4136         }
4137
4138       /* Call the function */
4139
4140       sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
4141       new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
4142         sub_arg[0], sub_arg + 1);
4143
4144       /* NULL yield indicates failure; if the message pointer has been set to
4145       NULL, the yield was undef, indicating a forced failure. Otherwise the
4146       message will indicate some kind of Perl error. */
4147
4148       if (new_yield == NULL)
4149         {
4150         if (expand_string_message == NULL)
4151           {
4152           expand_string_message =
4153             string_sprintf("Perl subroutine \"%s\" returned undef to force "
4154               "failure", sub_arg[0]);
4155           expand_string_forcedfail = TRUE;
4156           }
4157         goto EXPAND_FAILED;
4158         }
4159
4160       /* Yield succeeded. Ensure forcedfail is unset, just in case it got
4161       set during a callback from Perl. */
4162
4163       expand_string_forcedfail = FALSE;
4164       yield = new_yield;
4165       continue;
4166       }
4167     #endif /* EXIM_PERL */
4168
4169     /* Transform email address to "prvs" scheme to use
4170        as BATV-signed return path */
4171
4172     case EITEM_PRVS:
4173       {
4174       uschar *sub_arg[3];
4175       uschar *p,*domain;
4176
4177       switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs"))
4178         {
4179         case 1: goto EXPAND_FAILED_CURLY;
4180         case 2:
4181         case 3: goto EXPAND_FAILED;
4182         }
4183
4184       /* If skipping, we don't actually do anything */
4185       if (skipping) continue;
4186
4187       /* sub_arg[0] is the address */
4188       domain = Ustrrchr(sub_arg[0],'@');
4189       if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
4190         {
4191         expand_string_message = US"prvs first argument must be a qualified email address";
4192         goto EXPAND_FAILED;
4193         }
4194
4195       /* Calculate the hash. The second argument must be a single-digit
4196       key number, or unset. */
4197
4198       if (sub_arg[2] != NULL &&
4199           (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
4200         {
4201         expand_string_message = US"prvs second argument must be a single digit";
4202         goto EXPAND_FAILED;
4203         }
4204
4205       p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
4206       if (p == NULL)
4207         {
4208         expand_string_message = US"prvs hmac-sha1 conversion failed";
4209         goto EXPAND_FAILED;
4210         }
4211
4212       /* Now separate the domain from the local part */
4213       *domain++ = '\0';
4214
4215       yield = string_cat(yield,&size,&ptr,US"prvs=",5);
4216       string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
4217       string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
4218       string_cat(yield,&size,&ptr,p,6);
4219       string_cat(yield,&size,&ptr,US"=",1);
4220       string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4221       string_cat(yield,&size,&ptr,US"@",1);
4222       string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
4223
4224       continue;
4225       }
4226
4227     /* Check a prvs-encoded address for validity */
4228
4229     case EITEM_PRVSCHECK:
4230       {
4231       uschar *sub_arg[3];
4232       int mysize = 0, myptr = 0;
4233       const pcre *re;
4234       uschar *p;
4235
4236       /* TF: Ugliness: We want to expand parameter 1 first, then set
4237          up expansion variables that are used in the expansion of
4238          parameter 2. So we clone the string for the first
4239          expansion, where we only expand parameter 1.
4240
4241          PH: Actually, that isn't necessary. The read_subs() function is
4242          designed to work this way for the ${if and ${lookup expansions. I've
4243          tidied the code.
4244       */
4245
4246       /* Reset expansion variables */
4247       prvscheck_result = NULL;
4248       prvscheck_address = NULL;
4249       prvscheck_keynum = NULL;
4250
4251       switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
4252         {
4253         case 1: goto EXPAND_FAILED_CURLY;
4254         case 2:
4255         case 3: goto EXPAND_FAILED;
4256         }
4257
4258       re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
4259                               TRUE,FALSE);
4260
4261       if (regex_match_and_setup(re,sub_arg[0],0,-1))
4262         {
4263         uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
4264         uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
4265         uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
4266         uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
4267         uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
4268
4269         DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
4270         DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
4271         DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
4272         DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
4273         DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
4274
4275         /* Set up expansion variables */
4276         prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
4277         string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
4278         string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
4279         prvscheck_address[myptr] = '\0';
4280         prvscheck_keynum = string_copy(key_num);
4281
4282         /* Now expand the second argument */
4283         switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
4284           {
4285           case 1: goto EXPAND_FAILED_CURLY;
4286           case 2:
4287           case 3: goto EXPAND_FAILED;
4288           }
4289
4290         /* Now we have the key and can check the address. */
4291
4292         p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4293           daystamp);
4294
4295         if (p == NULL)
4296           {
4297           expand_string_message = US"hmac-sha1 conversion failed";
4298           goto EXPAND_FAILED;
4299           }
4300
4301         DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
4302         DEBUG(D_expand) debug_printf("prvscheck:      own hash is %s\n", p);
4303
4304         if (Ustrcmp(p,hash) == 0)
4305           {
4306           /* Success, valid BATV address. Now check the expiry date. */
4307           uschar *now = prvs_daystamp(0);
4308           unsigned int inow = 0,iexpire = 1;
4309
4310           (void)sscanf(CS now,"%u",&inow);
4311           (void)sscanf(CS daystamp,"%u",&iexpire);
4312
4313           /* When "iexpire" is < 7, a "flip" has occured.
4314              Adjust "inow" accordingly. */
4315           if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4316
4317           if (iexpire >= inow)
4318             {
4319             prvscheck_result = US"1";
4320             DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
4321             }
4322             else
4323             {
4324             prvscheck_result = NULL;
4325             DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
4326             }
4327           }
4328         else
4329           {
4330           prvscheck_result = NULL;
4331           DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4332           }
4333
4334         /* Now expand the final argument. We leave this till now so that
4335         it can include $prvscheck_result. */
4336
4337         switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs"))
4338           {
4339           case 1: goto EXPAND_FAILED_CURLY;
4340           case 2:
4341           case 3: goto EXPAND_FAILED;
4342           }
4343
4344         if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
4345           yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
4346         else
4347           yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4348
4349         /* Reset the "internal" variables afterwards, because they are in
4350         dynamic store that will be reclaimed if the expansion succeeded. */
4351
4352         prvscheck_address = NULL;
4353         prvscheck_keynum = NULL;
4354         }
4355       else
4356         {
4357         /* Does not look like a prvs encoded address, return the empty string.
4358            We need to make sure all subs are expanded first, so as to skip over
4359            the entire item. */
4360
4361         switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs"))
4362           {
4363           case 1: goto EXPAND_FAILED_CURLY;
4364           case 2:
4365           case 3: goto EXPAND_FAILED;
4366           }
4367         }
4368
4369       continue;
4370       }
4371
4372     /* Handle "readfile" to insert an entire file */
4373
4374     case EITEM_READFILE:
4375       {
4376       FILE *f;
4377       uschar *sub_arg[2];
4378
4379       if ((expand_forbid & RDO_READFILE) != 0)
4380         {
4381         expand_string_message = US"file insertions are not permitted";
4382         goto EXPAND_FAILED;
4383         }
4384
4385       switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile"))
4386         {
4387         case 1: goto EXPAND_FAILED_CURLY;
4388         case 2:
4389         case 3: goto EXPAND_FAILED;
4390         }
4391
4392       /* If skipping, we don't actually do anything */
4393
4394       if (skipping) continue;
4395
4396       /* Open the file and read it */
4397
4398       f = Ufopen(sub_arg[0], "rb");
4399       if (f == NULL)
4400         {
4401         expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4402         goto EXPAND_FAILED;
4403         }
4404
4405       yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4406       (void)fclose(f);
4407       continue;
4408       }
4409
4410     /* Handle "readsocket" to insert data from a Unix domain socket */
4411
4412     case EITEM_READSOCK:
4413       {
4414       int fd;
4415       int timeout = 5;
4416       int save_ptr = ptr;
4417       FILE *f;
4418       struct sockaddr_un sockun;         /* don't call this "sun" ! */
4419       uschar *arg;
4420       uschar *sub_arg[4];
4421
4422       if ((expand_forbid & RDO_READSOCK) != 0)
4423         {
4424         expand_string_message = US"socket insertions are not permitted";
4425         goto EXPAND_FAILED;
4426         }
4427
4428       /* Read up to 4 arguments, but don't do the end of item check afterwards,
4429       because there may be a string for expansion on failure. */
4430
4431       switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket"))
4432         {
4433         case 1: goto EXPAND_FAILED_CURLY;
4434         case 2:                             /* Won't occur: no end check */
4435         case 3: goto EXPAND_FAILED;
4436         }
4437
4438       /* Sort out timeout, if given */
4439
4440       if (sub_arg[2] != NULL)
4441         {
4442         timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4443         if (timeout < 0)
4444           {
4445           expand_string_message = string_sprintf("bad time value %s",
4446             sub_arg[2]);
4447           goto EXPAND_FAILED;
4448           }
4449         }
4450       else sub_arg[3] = NULL;                     /* No eol if no timeout */
4451
4452       /* If skipping, we don't actually do anything. Otherwise, arrange to
4453       connect to either an IP or a Unix socket. */
4454
4455       if (!skipping)
4456         {
4457         /* Handle an IP (internet) domain */
4458
4459         if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4460           {
4461           BOOL connected = FALSE;
4462           int namelen, port;
4463           host_item shost;
4464           host_item *h;
4465           uschar *server_name = sub_arg[0] + 5;
4466           uschar *port_name = Ustrrchr(server_name, ':');
4467
4468           /* Sort out the port */
4469
4470           if (port_name == NULL)
4471             {
4472             expand_string_message =
4473               string_sprintf("missing port for readsocket %s", sub_arg[0]);
4474             goto EXPAND_FAILED;
4475             }
4476           *port_name++ = 0;           /* Terminate server name */
4477
4478           if (isdigit(*port_name))
4479             {
4480             uschar *end;
4481             port = Ustrtol(port_name, &end, 0);
4482             if (end != port_name + Ustrlen(port_name))
4483               {
4484               expand_string_message =
4485                 string_sprintf("invalid port number %s", port_name);
4486               goto EXPAND_FAILED;
4487               }
4488             }
4489           else
4490             {
4491             struct servent *service_info = getservbyname(CS port_name, "tcp");
4492             if (service_info == NULL)
4493               {
4494               expand_string_message = string_sprintf("unknown port \"%s\"",
4495                 port_name);
4496               goto EXPAND_FAILED;
4497               }
4498             port = ntohs(service_info->s_port);
4499             }
4500
4501           /* Sort out the server. */
4502
4503           shost.next = NULL;
4504           shost.address = NULL;
4505           shost.port = port;
4506           shost.mx = -1;
4507
4508           namelen = Ustrlen(server_name);
4509
4510           /* Anything enclosed in [] must be an IP address. */
4511
4512           if (server_name[0] == '[' &&
4513               server_name[namelen - 1] == ']')
4514             {
4515             server_name[namelen - 1] = 0;
4516             server_name++;
4517             if (string_is_ip_address(server_name, NULL) == 0)
4518               {
4519               expand_string_message =
4520                 string_sprintf("malformed IP address \"%s\"", server_name);
4521               goto EXPAND_FAILED;
4522               }
4523             shost.name = shost.address = server_name;
4524             }
4525
4526           /* Otherwise check for an unadorned IP address */
4527
4528           else if (string_is_ip_address(server_name, NULL) != 0)
4529             shost.name = shost.address = server_name;
4530
4531           /* Otherwise lookup IP address(es) from the name */
4532
4533           else
4534             {
4535             shost.name = server_name;
4536             if (host_find_byname(&shost, NULL, HOST_FIND_QUALIFY_SINGLE, NULL,
4537                 FALSE) != HOST_FOUND)
4538               {
4539               expand_string_message =
4540                 string_sprintf("no IP address found for host %s", shost.name);
4541               goto EXPAND_FAILED;
4542               }
4543             }
4544
4545           /* Try to connect to the server - test each IP till one works */
4546
4547           for (h = &shost; h != NULL; h = h->next)
4548             {
4549             int af = (Ustrchr(h->address, ':') != 0)? AF_INET6 : AF_INET;
4550             if ((fd = ip_socket(SOCK_STREAM, af)) == -1)
4551               {
4552               expand_string_message = string_sprintf("failed to create socket: "
4553                 "%s", strerror(errno));
4554               goto SOCK_FAIL;
4555               }
4556
4557             if (ip_connect(fd, af, h->address, port, timeout) == 0)
4558               {
4559               connected = TRUE;
4560               break;
4561               }
4562             }
4563
4564           if (!connected)
4565             {
4566             expand_string_message = string_sprintf("failed to connect to "
4567               "socket %s: couldn't connect to any host", sub_arg[0],
4568               strerror(errno));
4569             goto SOCK_FAIL;
4570             }
4571           }
4572
4573         /* Handle a Unix domain socket */
4574
4575         else
4576           {
4577           int rc;
4578           if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4579             {
4580             expand_string_message = string_sprintf("failed to create socket: %s",
4581               strerror(errno));
4582             goto SOCK_FAIL;
4583             }
4584
4585           sockun.sun_family = AF_UNIX;
4586           sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4587             sub_arg[0]);
4588
4589           sigalrm_seen = FALSE;
4590           alarm(timeout);
4591           rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4592           alarm(0);
4593           if (sigalrm_seen)
4594             {
4595             expand_string_message = US "socket connect timed out";
4596             goto SOCK_FAIL;
4597             }
4598           if (rc < 0)
4599             {
4600             expand_string_message = string_sprintf("failed to connect to socket "
4601               "%s: %s", sub_arg[0], strerror(errno));
4602             goto SOCK_FAIL;
4603             }
4604           }
4605
4606         DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4607
4608         /* Write the request string, if not empty */
4609
4610         if (sub_arg[1][0] != 0)
4611           {
4612           int len = Ustrlen(sub_arg[1]);
4613           DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4614             sub_arg[1]);
4615           if (write(fd, sub_arg[1], len) != len)
4616             {
4617             expand_string_message = string_sprintf("request write to socket "
4618               "failed: %s", strerror(errno));
4619             goto SOCK_FAIL;
4620             }
4621           }
4622
4623         /* Shut down the sending side of the socket. This helps some servers to
4624         recognise that it is their turn to do some work. Just in case some
4625         system doesn't have this function, make it conditional. */
4626
4627         #ifdef SHUT_WR
4628         shutdown(fd, SHUT_WR);
4629         #endif
4630
4631         /* Now we need to read from the socket, under a timeout. The function
4632         that reads a file can be used. */
4633
4634         f = fdopen(fd, "rb");
4635         sigalrm_seen = FALSE;
4636         alarm(timeout);
4637         yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4638         alarm(0);
4639         (void)fclose(f);
4640
4641         /* After a timeout, we restore the pointer in the result, that is,
4642         make sure we add nothing from the socket. */
4643
4644         if (sigalrm_seen)
4645           {
4646           ptr = save_ptr;
4647           expand_string_message = US "socket read timed out";
4648           goto SOCK_FAIL;
4649           }
4650         }
4651
4652       /* The whole thing has worked (or we were skipping). If there is a
4653       failure string following, we need to skip it. */
4654
4655       if (*s == '{')
4656         {
4657         if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE) == NULL)
4658           goto EXPAND_FAILED;
4659         if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4660         while (isspace(*s)) s++;
4661         }
4662       if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4663       continue;
4664
4665       /* Come here on failure to create socket, connect socket, write to the
4666       socket, or timeout on reading. If another substring follows, expand and
4667       use it. Otherwise, those conditions give expand errors. */
4668
4669       SOCK_FAIL:
4670       if (*s != '{') goto EXPAND_FAILED;
4671       DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4672       arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE);
4673       if (arg == NULL) goto EXPAND_FAILED;
4674       yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4675       if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4676       while (isspace(*s)) s++;
4677       if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4678       continue;
4679       }
4680
4681     /* Handle "run" to execute a program. */
4682
4683     case EITEM_RUN:
4684       {
4685       FILE *f;
4686       uschar *arg;
4687       uschar **argv;
4688       pid_t pid;
4689       int fd_in, fd_out;
4690       int lsize = 0;
4691       int lptr = 0;
4692
4693       if ((expand_forbid & RDO_RUN) != 0)
4694         {
4695         expand_string_message = US"running a command is not permitted";
4696         goto EXPAND_FAILED;
4697         }
4698
4699       while (isspace(*s)) s++;
4700       if (*s != '{') goto EXPAND_FAILED_CURLY;
4701       arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
4702       if (arg == NULL) goto EXPAND_FAILED;
4703       while (isspace(*s)) s++;
4704       if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4705
4706       if (skipping)   /* Just pretend it worked when we're skipping */
4707         {
4708         runrc = 0;
4709         }
4710       else
4711         {
4712         if (!transport_set_up_command(&argv,    /* anchor for arg list */
4713             arg,                                /* raw command */
4714             FALSE,                              /* don't expand the arguments */
4715             0,                                  /* not relevant when... */
4716             NULL,                               /* no transporting address */
4717             US"${run} expansion",               /* for error messages */
4718             &expand_string_message))            /* where to put error message */
4719           {
4720           goto EXPAND_FAILED;
4721           }
4722
4723         /* Create the child process, making it a group leader. */
4724
4725         pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
4726
4727         if (pid < 0)
4728           {
4729           expand_string_message =
4730             string_sprintf("couldn't create child process: %s", strerror(errno));
4731           goto EXPAND_FAILED;
4732           }
4733
4734         /* Nothing is written to the standard input. */
4735
4736         (void)close(fd_in);
4737
4738         /* Read the pipe to get the command's output into $value (which is kept
4739         in lookup_value). Read during execution, so that if the output exceeds
4740         the OS pipe buffer limit, we don't block forever. */
4741
4742         f = fdopen(fd_out, "rb");
4743         sigalrm_seen = FALSE;
4744         alarm(60);
4745         lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
4746         alarm(0);
4747         (void)fclose(f);
4748
4749         /* Wait for the process to finish, applying the timeout, and inspect its
4750         return code for serious disasters. Simple non-zero returns are passed on.
4751         */
4752
4753         if (sigalrm_seen == TRUE || (runrc = child_close(pid, 30)) < 0)
4754           {
4755           if (sigalrm_seen == TRUE || runrc == -256)
4756             {
4757             expand_string_message = string_sprintf("command timed out");
4758             killpg(pid, SIGKILL);       /* Kill the whole process group */
4759             }
4760
4761           else if (runrc == -257)
4762             expand_string_message = string_sprintf("wait() failed: %s",
4763               strerror(errno));
4764
4765           else
4766             expand_string_message = string_sprintf("command killed by signal %d",
4767               -runrc);
4768
4769           goto EXPAND_FAILED;
4770           }
4771         }
4772
4773       /* Process the yes/no strings; $value may be useful in both cases */
4774
4775       switch(process_yesno(
4776                skipping,                     /* were previously skipping */
4777                runrc == 0,                   /* success/failure indicator */
4778                lookup_value,                 /* value to reset for string2 */
4779                &s,                           /* input pointer */
4780                &yield,                       /* output pointer */
4781                &size,                        /* output size */
4782                &ptr,                         /* output current point */
4783                US"run"))                     /* condition type */
4784         {
4785         case 1: goto EXPAND_FAILED;          /* when all is well, the */
4786         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
4787         }
4788
4789       continue;
4790       }
4791
4792     /* Handle character translation for "tr" */
4793
4794     case EITEM_TR:
4795       {
4796       int oldptr = ptr;
4797       int o2m;
4798       uschar *sub[3];
4799
4800       switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr"))
4801         {
4802         case 1: goto EXPAND_FAILED_CURLY;
4803         case 2:
4804         case 3: goto EXPAND_FAILED;
4805         }
4806
4807       yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4808       o2m = Ustrlen(sub[2]) - 1;
4809
4810       if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4811         {
4812         uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4813         if (m != NULL)
4814           {
4815           int o = m - sub[1];
4816           yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4817           }
4818         }
4819
4820       continue;
4821       }
4822
4823     /* Handle "hash", "length", "nhash", and "substr" when they are given with
4824     expanded arguments. */
4825
4826     case EITEM_HASH:
4827     case EITEM_LENGTH:
4828     case EITEM_NHASH:
4829     case EITEM_SUBSTR:
4830       {
4831       int i;
4832       int len;
4833       uschar *ret;
4834       int val[2] = { 0, -1 };
4835       uschar *sub[3];
4836
4837       /* "length" takes only 2 arguments whereas the others take 2 or 3.
4838       Ensure that sub[2] is set in the ${length case. */
4839
4840       sub[2] = NULL;
4841       switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
4842              TRUE, name))
4843         {
4844         case 1: goto EXPAND_FAILED_CURLY;
4845         case 2:
4846         case 3: goto EXPAND_FAILED;
4847         }
4848
4849       /* Juggle the arguments if there are only two of them: always move the
4850       string to the last position and make ${length{n}{str}} equivalent to
4851       ${substr{0}{n}{str}}. See the defaults for val[] above. */
4852
4853       if (sub[2] == NULL)
4854         {
4855         sub[2] = sub[1];
4856         sub[1] = NULL;
4857         if (item_type == EITEM_LENGTH)
4858           {
4859           sub[1] = sub[0];
4860           sub[0] = NULL;
4861           }
4862         }
4863
4864       for (i = 0; i < 2; i++)
4865         {
4866         if (sub[i] == NULL) continue;
4867         val[i] = (int)Ustrtol(sub[i], &ret, 10);
4868         if (*ret != 0 || (i != 0 && val[i] < 0))
4869           {
4870           expand_string_message = string_sprintf("\"%s\" is not a%s number "
4871             "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
4872           goto EXPAND_FAILED;
4873           }
4874         }
4875
4876       ret =
4877         (item_type == EITEM_HASH)?
4878           compute_hash(sub[2], val[0], val[1], &len) :
4879         (item_type == EITEM_NHASH)?
4880           compute_nhash(sub[2], val[0], val[1], &len) :
4881           extract_substr(sub[2], val[0], val[1], &len);
4882
4883       if (ret == NULL) goto EXPAND_FAILED;
4884       yield = string_cat(yield, &size, &ptr, ret, len);
4885       continue;
4886       }
4887
4888     /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
4889     This code originally contributed by Steve Haslam. It currently supports
4890     the use of MD5 and SHA-1 hashes.
4891
4892     We need some workspace that is large enough to handle all the supported
4893     hash types. Use macros to set the sizes rather than be too elaborate. */
4894
4895     #define MAX_HASHLEN      20
4896     #define MAX_HASHBLOCKLEN 64
4897
4898     case EITEM_HMAC:
4899       {
4900       uschar *sub[3];
4901       md5 md5_base;
4902       sha1 sha1_base;
4903       void *use_base;
4904       int type, i;
4905       int hashlen;      /* Number of octets for the hash algorithm's output */
4906       int hashblocklen; /* Number of octets the hash algorithm processes */
4907       uschar *keyptr, *p;
4908       unsigned int keylen;
4909
4910       uschar keyhash[MAX_HASHLEN];
4911       uschar innerhash[MAX_HASHLEN];
4912       uschar finalhash[MAX_HASHLEN];
4913       uschar finalhash_hex[2*MAX_HASHLEN];
4914       uschar innerkey[MAX_HASHBLOCKLEN];
4915       uschar outerkey[MAX_HASHBLOCKLEN];
4916
4917       switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name))
4918         {
4919         case 1: goto EXPAND_FAILED_CURLY;
4920         case 2:
4921         case 3: goto EXPAND_FAILED;
4922         }
4923
4924       if (Ustrcmp(sub[0], "md5") == 0)
4925         {
4926         type = HMAC_MD5;
4927         use_base = &md5_base;
4928         hashlen = 16;
4929         hashblocklen = 64;
4930         }
4931       else if (Ustrcmp(sub[0], "sha1") == 0)
4932         {
4933         type = HMAC_SHA1;
4934         use_base = &sha1_base;
4935         hashlen = 20;
4936         hashblocklen = 64;
4937         }
4938       else
4939         {
4940         expand_string_message =
4941           string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
4942         goto EXPAND_FAILED;
4943         }
4944
4945       keyptr = sub[1];
4946       keylen = Ustrlen(keyptr);
4947
4948       /* If the key is longer than the hash block length, then hash the key
4949       first */
4950
4951       if (keylen > hashblocklen)
4952         {
4953         chash_start(type, use_base);
4954         chash_end(type, use_base, keyptr, keylen, keyhash);
4955         keyptr = keyhash;
4956         keylen = hashlen;
4957         }
4958
4959       /* Now make the inner and outer key values */
4960
4961       memset(innerkey, 0x36, hashblocklen);
4962       memset(outerkey, 0x5c, hashblocklen);
4963
4964       for (i = 0; i < keylen; i++)
4965         {
4966         innerkey[i] ^= keyptr[i];
4967         outerkey[i] ^= keyptr[i];
4968         }
4969
4970       /* Now do the hashes */
4971
4972       chash_start(type, use_base);
4973       chash_mid(type, use_base, innerkey);
4974       chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
4975
4976       chash_start(type, use_base);
4977       chash_mid(type, use_base, outerkey);
4978       chash_end(type, use_base, innerhash, hashlen, finalhash);
4979
4980       /* Encode the final hash as a hex string */
4981
4982       p = finalhash_hex;
4983       for (i = 0; i < hashlen; i++)
4984         {
4985         *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
4986         *p++ = hex_digits[finalhash[i] & 0x0f];
4987         }
4988
4989       DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
4990         (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
4991
4992       yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
4993       }
4994
4995     continue;
4996
4997     /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
4998     We have to save the numerical variables and restore them afterwards. */
4999
5000     case EITEM_SG:
5001       {
5002       const pcre *re;
5003       int moffset, moffsetextra, slen;
5004       int roffset;
5005       int emptyopt;
5006       const uschar *rerror;
5007       uschar *subject;
5008       uschar *sub[3];
5009       int save_expand_nmax =
5010         save_expand_strings(save_expand_nstring, save_expand_nlength);
5011
5012       switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg"))
5013         {
5014         case 1: goto EXPAND_FAILED_CURLY;
5015         case 2:
5016         case 3: goto EXPAND_FAILED;
5017         }
5018
5019       /* Compile the regular expression */
5020
5021       re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
5022         NULL);
5023
5024       if (re == NULL)
5025         {
5026         expand_string_message = string_sprintf("regular expression error in "
5027           "\"%s\": %s at offset %d", sub[1], rerror, roffset);
5028         goto EXPAND_FAILED;
5029         }
5030
5031       /* Now run a loop to do the substitutions as often as necessary. It ends
5032       when there are no more matches. Take care over matches of the null string;
5033       do the same thing as Perl does. */
5034
5035       subject = sub[0];
5036       slen = Ustrlen(sub[0]);
5037       moffset = moffsetextra = 0;
5038       emptyopt = 0;
5039
5040       for (;;)
5041         {
5042         int ovector[3*(EXPAND_MAXN+1)];
5043         int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
5044           PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
5045         int nn;
5046         uschar *insert;
5047
5048         /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
5049         is not necessarily the end. We want to repeat the match from one
5050         character further along, but leaving the basic offset the same (for
5051         copying below). We can't be at the end of the string - that was checked
5052         before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
5053         finished; copy the remaining string and end the loop. */
5054
5055         if (n < 0)
5056           {
5057           if (emptyopt != 0)
5058             {
5059             moffsetextra = 1;
5060             emptyopt = 0;
5061             continue;
5062             }
5063           yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
5064           break;
5065           }
5066
5067         /* Match - set up for expanding the replacement. */
5068
5069         if (n == 0) n = EXPAND_MAXN + 1;
5070         expand_nmax = 0;
5071         for (nn = 0; nn < n*2; nn += 2)
5072           {
5073           expand_nstring[expand_nmax] = subject + ovector[nn];
5074           expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5075           }
5076         expand_nmax--;
5077
5078         /* Copy the characters before the match, plus the expanded insertion. */
5079
5080         yield = string_cat(yield, &size, &ptr, subject + moffset,
5081           ovector[0] - moffset);
5082         insert = expand_string(sub[2]);
5083         if (insert == NULL) goto EXPAND_FAILED;
5084         yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
5085
5086         moffset = ovector[1];
5087         moffsetextra = 0;
5088         emptyopt = 0;
5089
5090         /* If we have matched an empty string, first check to see if we are at
5091         the end of the subject. If so, the loop is over. Otherwise, mimic
5092         what Perl's /g options does. This turns out to be rather cunning. First
5093         we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
5094         string at the same point. If this fails (picked up above) we advance to
5095         the next character. */
5096
5097         if (ovector[0] == ovector[1])
5098           {
5099           if (ovector[0] == slen) break;
5100           emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
5101           }
5102         }
5103
5104       /* All done - restore numerical variables. */
5105
5106       restore_expand_strings(save_expand_nmax, save_expand_nstring,
5107         save_expand_nlength);
5108       continue;
5109       }
5110
5111     /* Handle keyed and numbered substring extraction. If the first argument
5112     consists entirely of digits, then a numerical extraction is assumed. */
5113
5114     case EITEM_EXTRACT:
5115       {
5116       int i;
5117       int j = 2;
5118       int field_number = 1;
5119       BOOL field_number_set = FALSE;
5120       uschar *save_lookup_value = lookup_value;
5121       uschar *sub[3];
5122       int save_expand_nmax =
5123         save_expand_strings(save_expand_nstring, save_expand_nlength);
5124
5125       /* Read the arguments */
5126
5127       for (i = 0; i < j; i++)
5128         {
5129         while (isspace(*s)) s++;
5130         if (*s == '{')
5131           {
5132           sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
5133           if (sub[i] == NULL) goto EXPAND_FAILED;
5134           if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5135
5136           /* After removal of leading and trailing white space, the first
5137           argument must not be empty; if it consists entirely of digits
5138           (optionally preceded by a minus sign), this is a numerical
5139           extraction, and we expect 3 arguments. */
5140
5141           if (i == 0)
5142             {
5143             int len;
5144             int x = 0;
5145             uschar *p = sub[0];
5146
5147             while (isspace(*p)) p++;
5148             sub[0] = p;
5149
5150             len = Ustrlen(p);
5151             while (len > 0 && isspace(p[len-1])) len--;
5152             p[len] = 0;
5153
5154             if (*p == 0 && !skipping)
5155               {
5156               expand_string_message = US"first argument of \"extract\" must "
5157                 "not be empty";
5158               goto EXPAND_FAILED;
5159               }
5160
5161             if (*p == '-')
5162               {
5163               field_number = -1;
5164               p++;
5165               }
5166             while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
5167             if (*p == 0)
5168               {
5169               field_number *= x;
5170               j = 3;               /* Need 3 args */
5171               field_number_set = TRUE;
5172               }
5173             }
5174           }
5175         else goto EXPAND_FAILED_CURLY;
5176         }
5177
5178       /* Extract either the numbered or the keyed substring into $value. If
5179       skipping, just pretend the extraction failed. */
5180
5181       lookup_value = skipping? NULL : field_number_set?
5182         expand_gettokened(field_number, sub[1], sub[2]) :
5183         expand_getkeyed(sub[0], sub[1]);
5184
5185       /* If no string follows, $value gets substituted; otherwise there can
5186       be yes/no strings, as for lookup or if. */
5187
5188       switch(process_yesno(
5189                skipping,                     /* were previously skipping */
5190                lookup_value != NULL,         /* success/failure indicator */
5191                save_lookup_value,            /* value to reset for string2 */
5192                &s,                           /* input pointer */
5193                &yield,                       /* output pointer */
5194                &size,                        /* output size */
5195                &ptr,                         /* output current point */
5196                US"extract"))                 /* condition type */
5197         {
5198         case 1: goto EXPAND_FAILED;          /* when all is well, the */
5199         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
5200         }
5201
5202       /* All done - restore numerical variables. */
5203
5204       restore_expand_strings(save_expand_nmax, save_expand_nstring,
5205         save_expand_nlength);
5206
5207       continue;
5208       }
5209
5210
5211     /* Handle list operations */
5212
5213     case EITEM_FILTER:
5214     case EITEM_MAP:
5215     case EITEM_REDUCE:
5216       {
5217       int sep = 0;
5218       int save_ptr = ptr;
5219       uschar outsep[2] = { '\0', '\0' };
5220       uschar *list, *expr, *temp;
5221       uschar *save_iterate_item = iterate_item;
5222       uschar *save_lookup_value = lookup_value;
5223
5224       while (isspace(*s)) s++;
5225       if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5226
5227       list = expand_string_internal(s, TRUE, &s, skipping, TRUE);
5228       if (list == NULL) goto EXPAND_FAILED;
5229       if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5230
5231       if (item_type == EITEM_REDUCE)
5232         {
5233         while (isspace(*s)) s++;
5234         if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5235         temp = expand_string_internal(s, TRUE, &s, skipping, TRUE);
5236         if (temp == NULL) goto EXPAND_FAILED;
5237         lookup_value = temp;
5238         if (*s++ != '}') goto EXPAND_FAILED_CURLY;
5239         }
5240
5241       while (isspace(*s)) s++;
5242       if (*s++ != '{') goto EXPAND_FAILED_CURLY;
5243
5244       expr = s;
5245
5246       /* For EITEM_FILTER, call eval_condition once, with result discarded (as
5247       if scanning a "false" part). This allows us to find the end of the
5248       condition, because if the list is empty, we won't actually evaluate the
5249       condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
5250       the normal internal expansion function. */
5251
5252       if (item_type == EITEM_FILTER)
5253         {
5254         temp = eval_condition(expr, NULL);
5255         if (temp != NULL) s = temp;
5256         }
5257       else
5258         {
5259         temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE);
5260         }
5261
5262       if (temp == NULL)
5263         {
5264         expand_string_message = string_sprintf("%s inside \"%s\" item",
5265           expand_string_message, name);
5266         goto EXPAND_FAILED;
5267         }
5268
5269       while (isspace(*s)) s++;
5270       if (*s++ != '}')
5271         {
5272         expand_string_message = string_sprintf("missing } at end of condition "
5273           "or expression inside \"%s\"", name);
5274         goto EXPAND_FAILED;
5275         }
5276
5277       while (isspace(*s)) s++;
5278       if (*s++ != '}')
5279         {
5280         expand_string_message = string_sprintf("missing } at end of \"%s\"",
5281           name);
5282         goto EXPAND_FAILED;
5283         }
5284
5285       /* If we are skipping, we can now just move on to the next item. When
5286       processing for real, we perform the iteration. */
5287
5288       if (skipping) continue;
5289       while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
5290         {
5291         *outsep = (uschar)sep;      /* Separator as a string */
5292
5293         DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
5294
5295         if (item_type == EITEM_FILTER)
5296           {
5297           BOOL condresult;
5298           if (eval_condition(expr, &condresult) == NULL)
5299             {
5300             iterate_item = save_iterate_item;
5301             lookup_value = save_lookup_value;
5302             expand_string_message = string_sprintf("%s inside \"%s\" condition",
5303               expand_string_message, name);
5304             goto EXPAND_FAILED;
5305             }
5306           DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
5307             condresult? "true":"false");
5308           if (condresult)
5309             temp = iterate_item;    /* TRUE => include this item */
5310           else
5311             continue;               /* FALSE => skip this item */
5312           }
5313
5314         /* EITEM_MAP and EITEM_REDUCE */
5315
5316         else
5317           {
5318           temp = expand_string_internal(expr, TRUE, NULL, skipping, TRUE);
5319           if (temp == NULL)
5320             {
5321             iterate_item = save_iterate_item;
5322             expand_string_message = string_sprintf("%s inside \"%s\" item",
5323               expand_string_message, name);
5324             goto EXPAND_FAILED;
5325             }
5326           if (item_type == EITEM_REDUCE)
5327             {
5328             lookup_value = temp;      /* Update the value of $value */
5329             continue;                 /* and continue the iteration */
5330             }
5331           }
5332
5333         /* We reach here for FILTER if the condition is true, always for MAP,
5334         and never for REDUCE. The value in "temp" is to be added to the output
5335         list that is being created, ensuring that any occurrences of the
5336         separator character are doubled. Unless we are dealing with the first
5337         item of the output list, add in a space if the new item begins with the
5338         separator character, or is an empty string. */
5339
5340         if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5341           yield = string_cat(yield, &size, &ptr, US" ", 1);
5342
5343         /* Add the string in "temp" to the output list that we are building,
5344         This is done in chunks by searching for the separator character. */
5345
5346         for (;;)
5347           {
5348           size_t seglen = Ustrcspn(temp, outsep);
5349             yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
5350
5351           /* If we got to the end of the string we output one character
5352           too many; backup and end the loop. Otherwise arrange to double the
5353           separator. */
5354
5355           if (temp[seglen] == '\0') { ptr--; break; }
5356           yield = string_cat(yield, &size, &ptr, outsep, 1);
5357           temp += seglen + 1;
5358           }
5359
5360         /* Output a separator after the string: we will remove the redundant
5361         final one at the end. */
5362
5363         yield = string_cat(yield, &size, &ptr, outsep, 1);
5364         }   /* End of iteration over the list loop */
5365
5366       /* REDUCE has generated no output above: output the final value of
5367       $value. */
5368
5369       if (item_type == EITEM_REDUCE)
5370         {
5371         yield = string_cat(yield, &size, &ptr, lookup_value,
5372           Ustrlen(lookup_value));
5373         lookup_value = save_lookup_value;  /* Restore $value */
5374         }
5375
5376       /* FILTER and MAP generate lists: if they have generated anything, remove
5377       the redundant final separator. Even though an empty item at the end of a
5378       list does not count, this is tidier. */
5379
5380       else if (ptr != save_ptr) ptr--;
5381
5382       /* Restore preserved $item */
5383
5384       iterate_item = save_iterate_item;
5385       continue;
5386       }
5387
5388
5389     /* If ${dlfunc support is configured, handle calling dynamically-loaded
5390     functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
5391     or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
5392     a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
5393
5394     #define EXPAND_DLFUNC_MAX_ARGS 8
5395
5396     case EITEM_DLFUNC:
5397     #ifndef EXPAND_DLFUNC
5398     expand_string_message = US"\"${dlfunc\" encountered, but this facility "
5399       "is not included in this binary";
5400     goto EXPAND_FAILED;
5401
5402     #else   /* EXPAND_DLFUNC */
5403       {
5404       tree_node *t;
5405       exim_dlfunc_t *func;
5406       uschar *result;
5407       int status, argc;
5408       uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
5409
5410       if ((expand_forbid & RDO_DLFUNC) != 0)
5411         {
5412         expand_string_message =
5413           US"dynamically-loaded functions are not permitted";
5414         goto EXPAND_FAILED;
5415         }
5416
5417       switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
5418            TRUE, US"dlfunc"))
5419         {
5420         case 1: goto EXPAND_FAILED_CURLY;
5421         case 2:
5422         case 3: goto EXPAND_FAILED;
5423         }
5424
5425       /* If skipping, we don't actually do anything */
5426
5427       if (skipping) continue;
5428
5429       /* Look up the dynamically loaded object handle in the tree. If it isn't
5430       found, dlopen() the file and put the handle in the tree for next time. */
5431
5432       t = tree_search(dlobj_anchor, argv[0]);
5433       if (t == NULL)
5434         {
5435         void *handle = dlopen(CS argv[0], RTLD_LAZY);
5436         if (handle == NULL)
5437           {
5438           expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
5439             argv[0], dlerror());
5440           log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5441           goto EXPAND_FAILED;
5442           }
5443         t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
5444         Ustrcpy(t->name, argv[0]);
5445         t->data.ptr = handle;
5446         (void)tree_insertnode(&dlobj_anchor, t);
5447         }
5448
5449       /* Having obtained the dynamically loaded object handle, look up the
5450       function pointer. */
5451
5452       func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
5453       if (func == NULL)
5454         {
5455         expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5456           "%s", argv[1], argv[0], dlerror());
5457         log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5458         goto EXPAND_FAILED;
5459         }
5460
5461       /* Call the function and work out what to do with the result. If it
5462       returns OK, we have a replacement string; if it returns DEFER then
5463       expansion has failed in a non-forced manner; if it returns FAIL then
5464       failure was forced; if it returns ERROR or any other value there's a
5465       problem, so panic slightly. In any case, assume that the function has
5466       side-effects on the store that must be preserved. */
5467
5468       resetok = FALSE;
5469       result = NULL;
5470       for (argc = 0; argv[argc] != NULL; argc++);
5471       status = func(&result, argc - 2, &argv[2]);
5472       if(status == OK)
5473         {
5474         if (result == NULL) result = US"";
5475         yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
5476         continue;
5477         }
5478       else
5479         {
5480         expand_string_message = result == NULL ? US"(no message)" : result;
5481         if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
5482           else if(status != FAIL)
5483             log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
5484               argv[0], argv[1], status, expand_string_message);
5485         goto EXPAND_FAILED;
5486         }
5487       }
5488     #endif /* EXPAND_DLFUNC */
5489     }
5490
5491   /* Control reaches here if the name is not recognized as one of the more
5492   complicated expansion items. Check for the "operator" syntax (name terminated
5493   by a colon). Some of the operators have arguments, separated by _ from the
5494   name. */
5495
5496   if (*s == ':')
5497     {
5498     int c;
5499     uschar *arg = NULL;
5500     uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
5501     if (sub == NULL) goto EXPAND_FAILED;
5502     s++;
5503
5504     /* Owing to an historical mis-design, an underscore may be part of the
5505     operator name, or it may introduce arguments.  We therefore first scan the
5506     table of names that contain underscores. If there is no match, we cut off
5507     the arguments and then scan the main table. */
5508
5509     c = chop_match(name, op_table_underscore,
5510       sizeof(op_table_underscore)/sizeof(uschar *));
5511
5512     if (c < 0)
5513       {
5514       arg = Ustrchr(name, '_');
5515       if (arg != NULL) *arg = 0;
5516       c = chop_match(name, op_table_main,
5517         sizeof(op_table_main)/sizeof(uschar *));
5518       if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
5519       if (arg != NULL) *arg++ = '_';   /* Put back for error messages */
5520       }
5521
5522     /* If we are skipping, we don't need to perform the operation at all.
5523     This matters for operations like "mask", because the data may not be
5524     in the correct format when skipping. For example, the expression may test
5525     for the existence of $sender_host_address before trying to mask it. For
5526     other operations, doing them may not fail, but it is a waste of time. */
5527
5528     if (skipping && c >= 0) continue;
5529
5530     /* Otherwise, switch on the operator type */
5531
5532     switch(c)
5533       {
5534       case EOP_BASE62:
5535         {
5536         uschar *t;
5537         unsigned long int n = Ustrtoul(sub, &t, 10);
5538         if (*t != 0)
5539           {
5540           expand_string_message = string_sprintf("argument for base62 "
5541             "operator is \"%s\", which is not a decimal number", sub);
5542           goto EXPAND_FAILED;
5543           }
5544         t = string_base62(n);
5545         yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5546         continue;
5547         }
5548
5549       /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
5550
5551       case EOP_BASE62D:
5552         {
5553         uschar buf[16];
5554         uschar *tt = sub;
5555         unsigned long int n = 0;
5556         while (*tt != 0)
5557           {
5558           uschar *t = Ustrchr(base62_chars, *tt++);
5559           if (t == NULL)
5560             {
5561             expand_string_message = string_sprintf("argument for base62d "
5562               "operator is \"%s\", which is not a base %d number", sub,
5563               BASE_62);
5564             goto EXPAND_FAILED;
5565             }
5566           n = n * BASE_62 + (t - base62_chars);
5567           }
5568         (void)sprintf(CS buf, "%ld", n);
5569         yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
5570         continue;
5571         }
5572
5573       case EOP_EXPAND:
5574         {
5575         uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE);
5576         if (expanded == NULL)
5577           {
5578           expand_string_message =
5579             string_sprintf("internal expansion of \"%s\" failed: %s", sub,
5580               expand_string_message);
5581           goto EXPAND_FAILED;
5582           }
5583         yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
5584         continue;
5585         }
5586
5587       case EOP_LC:
5588         {
5589         int count = 0;
5590         uschar *t = sub - 1;
5591         while (*(++t) != 0) { *t = tolower(*t); count++; }
5592         yield = string_cat(yield, &size, &ptr, sub, count);
5593         continue;
5594         }
5595
5596       case EOP_UC:
5597         {
5598         int count = 0;
5599         uschar *t = sub - 1;
5600         while (*(++t) != 0) { *t = toupper(*t); count++; }
5601         yield = string_cat(yield, &size, &ptr, sub, count);
5602         continue;
5603         }
5604
5605       case EOP_MD5:
5606         {
5607         md5 base;
5608         uschar digest[16];
5609         int j;
5610         char st[33];
5611         md5_start(&base);
5612         md5_end(&base, sub, Ustrlen(sub), digest);
5613         for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
5614         yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5615         continue;
5616         }
5617
5618       case EOP_SHA1:
5619         {
5620         sha1 base;
5621         uschar digest[20];
5622         int j;
5623         char st[41];
5624         sha1_start(&base);
5625         sha1_end(&base, sub, Ustrlen(sub), digest);
5626         for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
5627         yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5628         continue;
5629         }
5630
5631       /* Convert hex encoding to base64 encoding */
5632
5633       case EOP_HEX2B64:
5634         {
5635         int c = 0;
5636         int b = -1;
5637         uschar *in = sub;
5638         uschar *out = sub;
5639         uschar *enc;
5640
5641         for (enc = sub; *enc != 0; enc++)
5642           {
5643           if (!isxdigit(*enc))
5644             {
5645             expand_string_message = string_sprintf("\"%s\" is not a hex "
5646               "string", sub);
5647             goto EXPAND_FAILED;
5648             }
5649           c++;
5650           }
5651
5652         if ((c & 1) != 0)
5653           {
5654           expand_string_message = string_sprintf("\"%s\" contains an odd "
5655             "number of characters", sub);
5656           goto EXPAND_FAILED;
5657           }
5658
5659         while ((c = *in++) != 0)
5660           {
5661           if (isdigit(c)) c -= '0';
5662           else c = toupper(c) - 'A' + 10;
5663           if (b == -1)
5664             {
5665             b = c << 4;
5666             }
5667           else
5668             {
5669             *out++ = b | c;
5670             b = -1;
5671             }
5672           }
5673
5674         enc = auth_b64encode(sub, out - sub);
5675         yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
5676         continue;
5677         }
5678
5679       /* Convert octets outside 0x21..0x7E to \xXX form */
5680
5681       case EOP_HEXQUOTE:
5682         {
5683         uschar *t = sub - 1;
5684         while (*(++t) != 0)
5685           {
5686           if (*t < 0x21 || 0x7E < *t)
5687             yield = string_cat(yield, &size, &ptr,
5688               string_sprintf("\\x%02x", *t), 4);
5689           else
5690             yield = string_cat(yield, &size, &ptr, t, 1);
5691           }
5692         continue;
5693         }
5694
5695       /* count the number of list elements */
5696
5697       case EOP_LISTCOUNT:
5698         {
5699         int cnt = 0;
5700         int sep = 0;
5701         uschar * cp;
5702         uschar buffer[256];
5703
5704         while (string_nextinlist(&sub, &sep, buffer, sizeof(buffer)) != NULL) cnt++;
5705         cp = string_sprintf("%d", cnt);
5706         yield = string_cat(yield, &size, &ptr, cp, Ustrlen(cp));
5707         continue;
5708         }
5709
5710       /* expand a named list given the name */
5711       /* handles nested named lists; requotes as colon-sep list */
5712
5713       case EOP_LISTNAMED:
5714         {
5715         tree_node *t = NULL;
5716         uschar * list;
5717         int sep = 0;
5718         uschar * item;
5719         uschar * suffix = US"";
5720         BOOL needsep = FALSE;
5721         uschar buffer[256];
5722
5723         if (*sub == '+') sub++;
5724         if (arg == NULL)        /* no-argument version */
5725           {
5726           if (!(t = tree_search(addresslist_anchor, sub)) &&
5727               !(t = tree_search(domainlist_anchor,  sub)) &&
5728               !(t = tree_search(hostlist_anchor,    sub)))
5729             t = tree_search(localpartlist_anchor, sub);
5730           }
5731         else switch(*arg)       /* specific list-type version */
5732           {
5733           case 'a': t = tree_search(addresslist_anchor,   sub); suffix = US"_a"; break;
5734           case 'd': t = tree_search(domainlist_anchor,    sub); suffix = US"_d"; break;
5735           case 'h': t = tree_search(hostlist_anchor,      sub); suffix = US"_h"; break;
5736           case 'l': t = tree_search(localpartlist_anchor, sub); suffix = US"_l"; break;
5737           default:
5738             expand_string_message = string_sprintf("bad suffix on \"list\" operator");
5739             goto EXPAND_FAILED;
5740           }
5741
5742         if(!t)
5743           {
5744           expand_string_message = string_sprintf("\"%s\" is not a %snamed list",
5745             sub, !arg?""
5746               : *arg=='a'?"address "
5747               : *arg=='d'?"domain "
5748               : *arg=='h'?"host "
5749               : *arg=='l'?"localpart "
5750               : 0);
5751           goto EXPAND_FAILED;
5752           }
5753
5754         list = ((namedlist_block *)(t->data.ptr))->string;
5755
5756         while ((item = string_nextinlist(&list, &sep, buffer, sizeof(buffer))) != NULL)
5757           {
5758           uschar * buf = US" : ";
5759           if (needsep)
5760             yield = string_cat(yield, &size, &ptr, buf, 3);
5761           else
5762             needsep = TRUE;
5763
5764           if (*item == '+')     /* list item is itself a named list */
5765             {
5766             uschar * sub = string_sprintf("${listnamed%s:%s}", suffix, item);
5767             item = expand_string_internal(sub, FALSE, NULL, FALSE, TRUE);
5768             }
5769           else if (sep != ':')  /* item from non-colon-sep list, re-quote for colon list-separator */
5770             {
5771             char * cp;
5772             char tok[3];
5773             tok[0] = sep; tok[1] = ':'; tok[2] = 0;
5774             while ((cp= strpbrk((const char *)item, tok)))
5775               {
5776               yield = string_cat(yield, &size, &ptr, item, cp-(char *)item);
5777               if (*cp++ == ':') /* colon in a non-colon-sep list item, needs doubling */
5778                 {
5779                 yield = string_cat(yield, &size, &ptr, US"::", 2);
5780                 item = (uschar *)cp;
5781                 }
5782               else              /* sep in item; should already be doubled; emit once */
5783                 {
5784                 yield = string_cat(yield, &size, &ptr, (uschar *)tok, 1);
5785                 if (*cp == sep) cp++;
5786                 item = (uschar *)cp;
5787                 }
5788               }
5789             }
5790           yield = string_cat(yield, &size, &ptr, item, Ustrlen(item));
5791           }
5792         continue;
5793         }
5794
5795       /* mask applies a mask to an IP address; for example the result of
5796       ${mask:131.111.10.206/28} is 131.111.10.192/28. */
5797
5798       case EOP_MASK:
5799         {
5800         int count;
5801         uschar *endptr;
5802         int binary[4];
5803         int mask, maskoffset;
5804         int type = string_is_ip_address(sub, &maskoffset);
5805         uschar buffer[64];
5806
5807         if (type == 0)
5808           {
5809           expand_string_message = string_sprintf("\"%s\" is not an IP address",
5810            sub);
5811           goto EXPAND_FAILED;
5812           }
5813
5814         if (maskoffset == 0)
5815           {
5816           expand_string_message = string_sprintf("missing mask value in \"%s\"",
5817             sub);
5818           goto EXPAND_FAILED;
5819           }
5820
5821         mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
5822
5823         if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
5824           {
5825           expand_string_message = string_sprintf("mask value too big in \"%s\"",
5826             sub);
5827           goto EXPAND_FAILED;
5828           }
5829
5830         /* Convert the address to binary integer(s) and apply the mask */
5831
5832         sub[maskoffset] = 0;
5833         count = host_aton(sub, binary);
5834         host_mask(count, binary, mask);
5835
5836         /* Convert to masked textual format and add to output. */
5837
5838         yield = string_cat(yield, &size, &ptr, buffer,
5839           host_nmtoa(count, binary, mask, buffer, '.'));
5840         continue;
5841         }
5842
5843       case EOP_ADDRESS:
5844       case EOP_LOCAL_PART:
5845       case EOP_DOMAIN:
5846         {
5847         uschar *error;
5848         int start, end, domain;
5849         uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
5850           FALSE);
5851         if (t != NULL)
5852           {
5853           if (c != EOP_DOMAIN)
5854             {
5855             if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
5856             yield = string_cat(yield, &size, &ptr, sub+start, end-start);
5857             }
5858           else if (domain != 0)
5859             {
5860             domain += start;
5861             yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
5862             }
5863           }
5864         continue;
5865         }
5866
5867       case EOP_ADDRESSES:
5868         {
5869         uschar outsep[2] = { ':', '\0' };
5870         uschar *address, *error;
5871         int save_ptr = ptr;
5872         int start, end, domain;  /* Not really used */
5873
5874         while (isspace(*sub)) sub++;
5875         if (*sub == '>') { *outsep = *++sub; ++sub; }
5876         parse_allow_group = TRUE;
5877
5878         for (;;)
5879           {
5880           uschar *p = parse_find_address_end(sub, FALSE);
5881           uschar saveend = *p;
5882           *p = '\0';
5883           address = parse_extract_address(sub, &error, &start, &end, &domain,
5884             FALSE);
5885           *p = saveend;
5886
5887           /* Add the address to the output list that we are building. This is
5888           done in chunks by searching for the separator character. At the
5889           start, unless we are dealing with the first address of the output
5890           list, add in a space if the new address begins with the separator
5891           character, or is an empty string. */
5892
5893           if (address != NULL)
5894             {
5895             if (ptr != save_ptr && address[0] == *outsep)
5896               yield = string_cat(yield, &size, &ptr, US" ", 1);
5897
5898             for (;;)
5899               {
5900               size_t seglen = Ustrcspn(address, outsep);
5901               yield = string_cat(yield, &size, &ptr, address, seglen + 1);
5902
5903               /* If we got to the end of the string we output one character
5904               too many. */
5905
5906               if (address[seglen] == '\0') { ptr--; break; }
5907               yield = string_cat(yield, &size, &ptr, outsep, 1);
5908               address += seglen + 1;
5909               }
5910
5911             /* Output a separator after the string: we will remove the
5912             redundant final one at the end. */
5913
5914             yield = string_cat(yield, &size, &ptr, outsep, 1);
5915             }
5916
5917           if (saveend == '\0') break;
5918           sub = p + 1;
5919           }
5920
5921         /* If we have generated anything, remove the redundant final
5922         separator. */
5923
5924         if (ptr != save_ptr) ptr--;
5925         parse_allow_group = FALSE;
5926         continue;
5927         }
5928
5929
5930       /* quote puts a string in quotes if it is empty or contains anything
5931       other than alphamerics, underscore, dot, or hyphen.
5932
5933       quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
5934       be quoted in order to be a valid local part.
5935
5936       In both cases, newlines and carriage returns are converted into \n and \r
5937       respectively */
5938
5939       case EOP_QUOTE:
5940       case EOP_QUOTE_LOCAL_PART:
5941       if (arg == NULL)
5942         {
5943         BOOL needs_quote = (*sub == 0);      /* TRUE for empty string */
5944         uschar *t = sub - 1;
5945
5946         if (c == EOP_QUOTE)
5947           {
5948           while (!needs_quote && *(++t) != 0)
5949             needs_quote = !isalnum(*t) && !strchr("_-.", *t);
5950           }
5951         else  /* EOP_QUOTE_LOCAL_PART */
5952           {
5953           while (!needs_quote && *(++t) != 0)
5954             needs_quote = !isalnum(*t) &&
5955               strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
5956               (*t != '.' || t == sub || t[1] == 0);
5957           }
5958
5959         if (needs_quote)
5960           {
5961           yield = string_cat(yield, &size, &ptr, US"\"", 1);
5962           t = sub - 1;
5963           while (*(++t) != 0)
5964             {
5965             if (*t == '\n')
5966               yield = string_cat(yield, &size, &ptr, US"\\n", 2);
5967             else if (*t == '\r')
5968               yield = string_cat(yield, &size, &ptr, US"\\r", 2);
5969             else
5970               {
5971               if (*t == '\\' || *t == '"')
5972                 yield = string_cat(yield, &size, &ptr, US"\\", 1);
5973               yield = string_cat(yield, &size, &ptr, t, 1);
5974               }
5975             }
5976           yield = string_cat(yield, &size, &ptr, US"\"", 1);
5977           }
5978         else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
5979         continue;
5980         }
5981
5982       /* quote_lookuptype does lookup-specific quoting */
5983
5984       else
5985         {
5986         int n;
5987         uschar *opt = Ustrchr(arg, '_');
5988
5989         if (opt != NULL) *opt++ = 0;
5990
5991         n = search_findtype(arg, Ustrlen(arg));
5992         if (n < 0)
5993           {
5994           expand_string_message = search_error_message;
5995           goto EXPAND_FAILED;
5996           }
5997
5998         if (lookup_list[n]->quote != NULL)
5999           sub = (lookup_list[n]->quote)(sub, opt);
6000         else if (opt != NULL) sub = NULL;
6001
6002         if (sub == NULL)
6003           {
6004           expand_string_message = string_sprintf(
6005             "\"%s\" unrecognized after \"${quote_%s\"",
6006             opt, arg);
6007           goto EXPAND_FAILED;
6008           }
6009
6010         yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
6011         continue;
6012         }
6013
6014       /* rx quote sticks in \ before any non-alphameric character so that
6015       the insertion works in a regular expression. */
6016
6017       case EOP_RXQUOTE:
6018         {
6019         uschar *t = sub - 1;
6020         while (*(++t) != 0)
6021           {
6022           if (!isalnum(*t))
6023             yield = string_cat(yield, &size, &ptr, US"\\", 1);
6024           yield = string_cat(yield, &size, &ptr, t, 1);
6025           }
6026         continue;
6027         }
6028
6029       /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
6030       prescribed by the RFC, if there are characters that need to be encoded */
6031
6032       case EOP_RFC2047:
6033         {
6034         uschar buffer[2048];
6035         uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
6036           buffer, sizeof(buffer), FALSE);
6037         yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
6038         continue;
6039         }
6040
6041       /* RFC 2047 decode */
6042
6043       case EOP_RFC2047D:
6044         {
6045         int len;
6046         uschar *error;
6047         uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
6048           headers_charset, '?', &len, &error);
6049         if (error != NULL)
6050           {
6051           expand_string_message = error;
6052           goto EXPAND_FAILED;
6053           }
6054         yield = string_cat(yield, &size, &ptr, decoded, len);
6055         continue;
6056         }
6057
6058       /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
6059       underscores */
6060
6061       case EOP_FROM_UTF8:
6062         {
6063         while (*sub != 0)
6064           {
6065           int c;
6066           uschar buff[4];
6067           GETUTF8INC(c, sub);
6068           if (c > 255) c = '_';
6069           buff[0] = c;
6070           yield = string_cat(yield, &size, &ptr, buff, 1);
6071           }
6072         continue;
6073         }
6074
6075       /* escape turns all non-printing characters into escape sequences. */
6076
6077       case EOP_ESCAPE:
6078         {
6079         uschar *t = string_printing(sub);
6080         yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6081         continue;
6082         }
6083
6084       /* Handle numeric expression evaluation */
6085
6086       case EOP_EVAL:
6087       case EOP_EVAL10:
6088         {
6089         uschar *save_sub = sub;
6090         uschar *error = NULL;
6091         int_eximarith_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
6092         if (error != NULL)
6093           {
6094           expand_string_message = string_sprintf("error in expression "
6095             "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
6096               save_sub);
6097           goto EXPAND_FAILED;
6098           }
6099         sprintf(CS var_buffer, PR_EXIM_ARITH, n);
6100         yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6101         continue;
6102         }
6103
6104       /* Handle time period formating */
6105
6106       case EOP_TIME_EVAL:
6107         {
6108         int n = readconf_readtime(sub, 0, FALSE);
6109         if (n < 0)
6110           {
6111           expand_string_message = string_sprintf("string \"%s\" is not an "
6112             "Exim time interval in \"%s\" operator", sub, name);
6113           goto EXPAND_FAILED;
6114           }
6115         sprintf(CS var_buffer, "%d", n);
6116         yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
6117         continue;
6118         }
6119
6120       case EOP_TIME_INTERVAL:
6121         {
6122         int n;
6123         uschar *t = read_number(&n, sub);
6124         if (*t != 0) /* Not A Number*/
6125           {
6126           expand_string_message = string_sprintf("string \"%s\" is not a "
6127             "positive number in \"%s\" operator", sub, name);
6128           goto EXPAND_FAILED;
6129           }
6130         t = readconf_printtime(n);
6131         yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
6132         continue;
6133         }
6134
6135       /* Convert string to base64 encoding */
6136
6137       case EOP_STR2B64:
6138         {
6139         uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
6140         yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
6141         continue;
6142         }
6143
6144       /* strlen returns the length of the string */
6145
6146       case EOP_STRLEN:
6147         {
6148         uschar buff[24];
6149         (void)sprintf(CS buff, "%d", Ustrlen(sub));
6150         yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
6151         continue;
6152         }
6153
6154       /* length_n or l_n takes just the first n characters or the whole string,
6155       whichever is the shorter;
6156
6157       substr_m_n, and s_m_n take n characters from offset m; negative m take
6158       from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
6159       takes the rest, either to the right or to the left.
6160
6161       hash_n or h_n makes a hash of length n from the string, yielding n
6162       characters from the set a-z; hash_n_m makes a hash of length n, but
6163       uses m characters from the set a-zA-Z0-9.
6164
6165       nhash_n returns a single number between 0 and n-1 (in text form), while
6166       nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
6167       between 0 and n-1 and the second between 0 and m-1. */
6168
6169       case EOP_LENGTH:
6170       case EOP_L:
6171       case EOP_SUBSTR:
6172       case EOP_S:
6173       case EOP_HASH:
6174       case EOP_H:
6175       case EOP_NHASH:
6176       case EOP_NH:
6177         {
6178         int sign = 1;
6179         int value1 = 0;
6180         int value2 = -1;
6181         int *pn;
6182         int len;
6183         uschar *ret;
6184
6185         if (arg == NULL)
6186           {
6187           expand_string_message = string_sprintf("missing values after %s",
6188             name);
6189           goto EXPAND_FAILED;
6190           }
6191
6192         /* "length" has only one argument, effectively being synonymous with
6193         substr_0_n. */
6194
6195         if (c == EOP_LENGTH || c == EOP_L)
6196           {
6197           pn = &value2;
6198           value2 = 0;
6199           }
6200
6201         /* The others have one or two arguments; for "substr" the first may be
6202         negative. The second being negative means "not supplied". */
6203
6204         else
6205           {
6206           pn = &value1;
6207           if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
6208           }
6209
6210         /* Read up to two numbers, separated by underscores */
6211
6212         ret = arg;
6213         while (*arg != 0)
6214           {
6215           if (arg != ret && *arg == '_' && pn == &value1)
6216             {
6217             pn = &value2;
6218             value2 = 0;
6219             if (arg[1] != 0) arg++;
6220             }
6221           else if (!isdigit(*arg))
6222             {
6223             expand_string_message =
6224               string_sprintf("non-digit after underscore in \"%s\"", name);
6225             goto EXPAND_FAILED;
6226             }
6227           else *pn = (*pn)*10 + *arg++ - '0';
6228           }
6229         value1 *= sign;
6230
6231         /* Perform the required operation */
6232
6233         ret =
6234           (c == EOP_HASH || c == EOP_H)?
6235              compute_hash(sub, value1, value2, &len) :
6236           (c == EOP_NHASH || c == EOP_NH)?
6237              compute_nhash(sub, value1, value2, &len) :
6238              extract_substr(sub, value1, value2, &len);
6239
6240         if (ret == NULL) goto EXPAND_FAILED;
6241         yield = string_cat(yield, &size, &ptr, ret, len);
6242         continue;
6243         }
6244
6245       /* Stat a path */
6246
6247       case EOP_STAT:
6248         {
6249         uschar *s;
6250         uschar smode[12];
6251         uschar **modetable[3];
6252         int i;
6253         mode_t mode;
6254         struct stat st;
6255
6256         if ((expand_forbid & RDO_EXISTS) != 0)
6257           {
6258           expand_string_message = US"Use of the stat() expansion is not permitted";
6259           goto EXPAND_FAILED;
6260           }
6261
6262         if (stat(CS sub, &st) < 0)
6263           {
6264           expand_string_message = string_sprintf("stat(%s) failed: %s",
6265             sub, strerror(errno));
6266           goto EXPAND_FAILED;
6267           }
6268         mode = st.st_mode;
6269         switch (mode & S_IFMT)
6270           {
6271           case S_IFIFO: smode[0] = 'p'; break;
6272           case S_IFCHR: smode[0] = 'c'; break;
6273           case S_IFDIR: smode[0] = 'd'; break;
6274           case S_IFBLK: smode[0] = 'b'; break;
6275           case S_IFREG: smode[0] = '-'; break;
6276           default: smode[0] = '?'; break;
6277           }
6278
6279         modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
6280         modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
6281         modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
6282
6283         for (i = 0; i < 3; i++)
6284           {
6285           memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
6286           mode >>= 3;
6287           }
6288
6289         smode[10] = 0;
6290         s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
6291           "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
6292           (long)(st.st_mode & 077777), smode, (long)st.st_ino,
6293           (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
6294           (long)st.st_gid, st.st_size, (long)st.st_atime,
6295           (long)st.st_mtime, (long)st.st_ctime);
6296         yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6297         continue;
6298         }
6299
6300       /* vaguely random number less than N */
6301
6302       case EOP_RANDINT:
6303         {
6304         int_eximarith_t max;
6305         uschar *s;
6306
6307         max = expand_string_integer(sub, TRUE);
6308         if (expand_string_message != NULL)
6309           goto EXPAND_FAILED;
6310         s = string_sprintf("%d", vaguely_random_number((int)max));
6311         yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
6312         continue;
6313         }
6314
6315       /* Reverse IP, including IPv6 to dotted-nibble */
6316
6317       case EOP_REVERSE_IP:
6318         {
6319         int family, maskptr;
6320         uschar reversed[128];
6321
6322         family = string_is_ip_address(sub, &maskptr);
6323         if (family == 0)
6324           {
6325           expand_string_message = string_sprintf(
6326               "reverse_ip() not given an IP address [%s]", sub);
6327           goto EXPAND_FAILED;
6328           }
6329         invert_address(reversed, sub);
6330         yield = string_cat(yield, &size, &ptr, reversed, Ustrlen(reversed));
6331         continue;
6332         }
6333
6334       /* Unknown operator */
6335
6336       default:
6337       expand_string_message =
6338         string_sprintf("unknown expansion operator \"%s\"", name);
6339       goto EXPAND_FAILED;
6340       }
6341     }
6342
6343   /* Handle a plain name. If this is the first thing in the expansion, release
6344   the pre-allocated buffer. If the result data is known to be in a new buffer,
6345   newsize will be set to the size of that buffer, and we can just point at that
6346   store instead of copying. Many expansion strings contain just one reference,
6347   so this is a useful optimization, especially for humungous headers
6348   ($message_headers). */
6349
6350   if (*s++ == '}')
6351     {
6352     int len;
6353     int newsize = 0;
6354     if (ptr == 0)
6355       {
6356       if (resetok) store_reset(yield);
6357       yield = NULL;
6358       size = 0;
6359       }
6360     value = find_variable(name, FALSE, skipping, &newsize);
6361     if (value == NULL)
6362       {
6363       expand_string_message =
6364         string_sprintf("unknown variable in \"${%s}\"", name);
6365       check_variable_error_message(name);
6366       goto EXPAND_FAILED;
6367       }
6368     len = Ustrlen(value);
6369     if (yield == NULL && newsize != 0)
6370       {
6371       yield = value;
6372       size = newsize;
6373       ptr = len;
6374       }
6375     else yield = string_cat(yield, &size, &ptr, value, len);
6376     continue;
6377     }
6378
6379   /* Else there's something wrong */
6380
6381   expand_string_message =
6382     string_sprintf("\"${%s\" is not a known operator (or a } is missing "
6383     "in a variable reference)", name);
6384   goto EXPAND_FAILED;
6385   }
6386
6387 /* If we hit the end of the string when ket_ends is set, there is a missing
6388 terminating brace. */
6389
6390 if (ket_ends && *s == 0)
6391   {
6392   expand_string_message = malformed_header?
6393     US"missing } at end of string - could be header name not terminated by colon"
6394     :
6395     US"missing } at end of string";
6396   goto EXPAND_FAILED;
6397   }
6398
6399 /* Expansion succeeded; yield may still be NULL here if nothing was actually
6400 added to the string. If so, set up an empty string. Add a terminating zero. If
6401 left != NULL, return a pointer to the terminator. */
6402
6403 if (yield == NULL) yield = store_get(1);
6404 yield[ptr] = 0;
6405 if (left != NULL) *left = s;
6406
6407 /* Any stacking store that was used above the final string is no longer needed.
6408 In many cases the final string will be the first one that was got and so there
6409 will be optimal store usage. */
6410
6411 if (resetok) store_reset(yield + ptr + 1);
6412 DEBUG(D_expand)
6413   {
6414   debug_printf("expanding: %.*s\n   result: %s\n", (int)(s - string), string,
6415     yield);
6416   if (skipping) debug_printf("skipping: result is not used\n");
6417   }
6418 return yield;
6419
6420 /* This is the failure exit: easiest to program with a goto. We still need
6421 to update the pointer to the terminator, for cases of nested calls with "fail".
6422 */
6423
6424 EXPAND_FAILED_CURLY:
6425 expand_string_message = malformed_header?
6426   US"missing or misplaced { or } - could be header name not terminated by colon"
6427   :
6428   US"missing or misplaced { or }";
6429
6430 /* At one point, Exim reset the store to yield (if yield was not NULL), but
6431 that is a bad idea, because expand_string_message is in dynamic store. */
6432
6433 EXPAND_FAILED:
6434 if (left != NULL) *left = s;
6435 DEBUG(D_expand)
6436   {
6437   debug_printf("failed to expand: %s\n", string);
6438   debug_printf("   error message: %s\n", expand_string_message);
6439   if (expand_string_forcedfail) debug_printf("failure was forced\n");
6440   }
6441 return NULL;
6442 }
6443
6444
6445 /* This is the external function call. Do a quick check for any expansion
6446 metacharacters, and if there are none, just return the input string.
6447
6448 Argument: the string to be expanded
6449 Returns:  the expanded string, or NULL if expansion failed; if failure was
6450           due to a lookup deferring, search_find_defer will be TRUE
6451 */
6452
6453 uschar *
6454 expand_string(uschar *string)
6455 {
6456 search_find_defer = FALSE;
6457 malformed_header = FALSE;
6458 return (Ustrpbrk(string, "$\\") == NULL)? string :
6459   expand_string_internal(string, FALSE, NULL, FALSE, TRUE);
6460 }
6461
6462
6463
6464 /*************************************************
6465 *              Expand and copy                   *
6466 *************************************************/
6467
6468 /* Now and again we want to expand a string and be sure that the result is in a
6469 new bit of store. This function does that.
6470
6471 Argument: the string to be expanded
6472 Returns:  the expanded string, always in a new bit of store, or NULL
6473 */
6474
6475 uschar *
6476 expand_string_copy(uschar *string)
6477 {
6478 uschar *yield = expand_string(string);
6479 if (yield == string) yield = string_copy(string);
6480 return yield;
6481 }
6482
6483
6484
6485 /*************************************************
6486 *        Expand and interpret as an integer      *
6487 *************************************************/
6488
6489 /* Expand a string, and convert the result into an integer.
6490
6491 Arguments:
6492   string  the string to be expanded
6493   isplus  TRUE if a non-negative number is expected
6494
6495 Returns:  the integer value, or
6496           -1 for an expansion error               ) in both cases, message in
6497           -2 for an integer interpretation error  ) expand_string_message
6498           expand_string_message is set NULL for an OK integer
6499 */
6500
6501 int_eximarith_t
6502 expand_string_integer(uschar *string, BOOL isplus)
6503 {
6504 int_eximarith_t value;
6505 uschar *s = expand_string(string);
6506 uschar *msg = US"invalid integer \"%s\"";
6507 uschar *endptr;
6508
6509 /* If expansion failed, expand_string_message will be set. */
6510
6511 if (s == NULL) return -1;
6512
6513 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
6514 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
6515 systems, so we set it zero ourselves. */
6516
6517 errno = 0;
6518 expand_string_message = NULL;               /* Indicates no error */
6519
6520 /* Before Exim 4.64, strings consisting entirely of whitespace compared
6521 equal to 0.  Unfortunately, people actually relied upon that, so preserve
6522 the behaviour explicitly.  Stripping leading whitespace is a harmless
6523 noop change since strtol skips it anyway (provided that there is a number
6524 to find at all). */
6525 if (isspace(*s))
6526   {
6527   while (isspace(*s)) ++s;
6528   if (*s == '\0')
6529     {
6530       DEBUG(D_expand)
6531        debug_printf("treating blank string as number 0\n");
6532       return 0;
6533     }
6534   }
6535
6536 value = strtoll(CS s, CSS &endptr, 10);
6537
6538 if (endptr == s)
6539   {
6540   msg = US"integer expected but \"%s\" found";
6541   }
6542 else if (value < 0 && isplus)
6543   {
6544   msg = US"non-negative integer expected but \"%s\" found";
6545   }
6546 else
6547   {
6548   switch (tolower(*endptr))
6549     {
6550     default:
6551       break;
6552     case 'k':
6553       if (value > EXIM_ARITH_MAX/1024 || value < EXIM_ARITH_MIN/1024) errno = ERANGE;
6554       else value *= 1024;
6555       endptr++;
6556       break;
6557     case 'm':
6558       if (value > EXIM_ARITH_MAX/(1024*1024) || value < EXIM_ARITH_MIN/(1024*1024)) errno = ERANGE;
6559       else value *= 1024*1024;
6560       endptr++;
6561       break;
6562     case 'g':
6563       if (value > EXIM_ARITH_MAX/(1024*1024*1024) || value < EXIM_ARITH_MIN/(1024*1024*1024)) errno = ERANGE;
6564       else value *= 1024*1024*1024;
6565       endptr++;
6566       break;
6567     }
6568   if (errno == ERANGE)
6569     msg = US"absolute value of integer \"%s\" is too large (overflow)";
6570   else
6571     {
6572     while (isspace(*endptr)) endptr++;
6573     if (*endptr == 0) return (int)value;
6574     }
6575   }
6576
6577 expand_string_message = string_sprintf(CS msg, s);
6578 return -2;
6579 }
6580
6581
6582 /*************************************************
6583 **************************************************
6584 *             Stand-alone test program           *
6585 **************************************************
6586 *************************************************/
6587
6588 #ifdef STAND_ALONE
6589
6590
6591 BOOL
6592 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
6593 {
6594 int ovector[3*(EXPAND_MAXN+1)];
6595 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
6596   ovector, sizeof(ovector)/sizeof(int));
6597 BOOL yield = n >= 0;
6598 if (n == 0) n = EXPAND_MAXN + 1;
6599 if (yield)
6600   {
6601   int nn;
6602   expand_nmax = (setup < 0)? 0 : setup + 1;
6603   for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
6604     {
6605     expand_nstring[expand_nmax] = subject + ovector[nn];
6606     expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
6607     }
6608   expand_nmax--;
6609   }
6610 return yield;
6611 }
6612
6613
6614 int main(int argc, uschar **argv)
6615 {
6616 int i;
6617 uschar buffer[1024];
6618
6619 debug_selector = D_v;
6620 debug_file = stderr;
6621 debug_fd = fileno(debug_file);
6622 big_buffer = malloc(big_buffer_size);
6623
6624 for (i = 1; i < argc; i++)
6625   {
6626   if (argv[i][0] == '+')
6627     {
6628     debug_trace_memory = 2;
6629     argv[i]++;
6630     }
6631   if (isdigit(argv[i][0]))
6632     debug_selector = Ustrtol(argv[i], NULL, 0);
6633   else
6634     if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
6635         Ustrlen(argv[i]))
6636       {
6637       #ifdef LOOKUP_LDAP
6638       eldap_default_servers = argv[i];
6639       #endif
6640       #ifdef LOOKUP_MYSQL
6641       mysql_servers = argv[i];
6642       #endif
6643       #ifdef LOOKUP_PGSQL
6644       pgsql_servers = argv[i];
6645       #endif
6646       }
6647   #ifdef EXIM_PERL
6648   else opt_perl_startup = argv[i];
6649   #endif
6650   }
6651
6652 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
6653
6654 expand_nstring[1] = US"string 1....";
6655 expand_nlength[1] = 8;
6656 expand_nmax = 1;
6657
6658 #ifdef EXIM_PERL
6659 if (opt_perl_startup != NULL)
6660   {
6661   uschar *errstr;
6662   printf("Starting Perl interpreter\n");
6663   errstr = init_perl(opt_perl_startup);
6664   if (errstr != NULL)
6665     {
6666     printf("** error in perl_startup code: %s\n", errstr);
6667     return EXIT_FAILURE;
6668     }
6669   }
6670 #endif /* EXIM_PERL */
6671
6672 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
6673   {
6674   void *reset_point = store_get(0);
6675   uschar *yield = expand_string(buffer);
6676   if (yield != NULL)
6677     {
6678     printf("%s\n", yield);
6679     store_reset(reset_point);
6680     }
6681   else
6682     {
6683     if (search_find_defer) printf("search_find deferred\n");
6684     printf("Failed: %s\n", expand_string_message);
6685     if (expand_string_forcedfail) printf("Forced failure\n");
6686     printf("\n");
6687     }
6688   }
6689
6690 search_tidyup();
6691
6692 return 0;
6693 }
6694
6695 #endif
6696
6697 /* End of expand.c */