src/src/expand.c

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