src/src/expand.c

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