src/src/expand.c

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