src/src/expand.c

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