src/src/expand.c

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