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 int64_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 int64_t eval_op_or(uschar **, BOOL, uschar **);
3073
3074
3075 static int64_t
3076 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
3077 {
3078 uschar *s = *sptr;
3079 int64_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 int64_t
3097 eval_number(uschar **sptr, BOOL decimal, uschar **error)
3098 {
3099 register int c;
3100 int64_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? "%lld%n" : "%lli%n"), &n, &count);
3108   s += count;
3109   if (tolower(*s) == 'k') { n *= 1024; s++; }
3110     else if (tolower(*s) == 'm') { n *= 1024*1024; s++; }
3111   while (isspace (*s)) s++;
3112   }
3113 else if (c == '(')
3114   {
3115   s++;
3116   n = eval_expr(&s, decimal, error, 1);
3117   }
3118 else
3119   {
3120   *error = US"expecting number or opening parenthesis";
3121   n = 0;
3122   }
3123 *sptr = s;
3124 return n;
3125 }
3126
3127
3128 static int64_t
3129 eval_op_unary(uschar **sptr, BOOL decimal, uschar **error)
3130 {
3131 uschar *s = *sptr;
3132 int64_t x;
3133 while (isspace(*s)) s++;
3134 if (*s == '+' || *s == '-' || *s == '~')
3135   {
3136   int op = *s++;
3137   x = eval_op_unary(&s, decimal, error);
3138   if (op == '-') x = -x;
3139     else if (op == '~') x = ~x;
3140   }
3141 else
3142   {
3143   x = eval_number(&s, decimal, error);
3144   }
3145 *sptr = s;
3146 return x;
3147 }
3148
3149
3150 static int64_t
3151 eval_op_mult(uschar **sptr, BOOL decimal, uschar **error)
3152 {
3153 uschar *s = *sptr;
3154 int64_t x = eval_op_unary(&s, decimal, error);
3155 if (*error == NULL)
3156   {
3157   while (*s == '*' || *s == '/' || *s == '%')
3158     {
3159     int op = *s++;
3160     int64_t y = eval_op_unary(&s, decimal, error);
3161     if (*error != NULL) break;
3162     /* SIGFPE both on div/mod by zero and on INT_MIN / -1, which would give
3163      * a value of INT_MAX+1. Note that INT_MIN * -1 gives INT_MIN for me, which
3164      * is a bug somewhere in [gcc 4.2.1, FreeBSD, amd64].  In fact, -N*-M where
3165      * -N*M is INT_MIN will yielf INT_MIN.
3166      * Since we don't support floating point, this is somewhat simpler.
3167      * Ideally, we'd return an error, but since we overflow for all other
3168      * arithmetic, consistency suggests otherwise, but what's the correct value
3169      * to use?  There is none.
3170      * The C standard guarantees overflow for unsigned arithmetic but signed
3171      * overflow invokes undefined behaviour; in practice, this is overflow
3172      * except for converting INT_MIN to INT_MAX+1.  We also can't guarantee
3173      * that long/longlong larger than int are available, or we could just work
3174      * with larger types.  We should consider whether to guarantee 32bit eval
3175      * and 64-bit working variables, with errors returned.  For now ...
3176      * So, the only SIGFPEs occur with a non-shrinking div/mod, thus -1; we
3177      * can just let the other invalid results occur otherwise, as they have
3178      * until now.  For this one case, we can coerce.
3179      */
3180     if (y == -1 && x == LLONG_MIN && op != '*')
3181       {
3182       DEBUG(D_expand)
3183         debug_printf("Integer exception dodging: %lld%c-1 coerced to %lld\n",
3184             LLONG_MIN, op, LLONG_MAX);
3185       x = LLONG_MAX;
3186       continue;
3187       }
3188     if (op == '*')
3189       x *= y;
3190     else
3191       {
3192       if (y == 0)
3193         {
3194         *error = (op == '/') ? US"divide by zero" : US"modulo by zero";
3195         x = 0;
3196         break;
3197         }
3198       if (op == '/')
3199         x /= y;
3200       else
3201         x %= y;
3202       }
3203     }
3204   }
3205 *sptr = s;
3206 return x;
3207 }
3208
3209
3210 static int64_t
3211 eval_op_sum(uschar **sptr, BOOL decimal, uschar **error)
3212 {
3213 uschar *s = *sptr;
3214 int64_t x = eval_op_mult(&s, decimal, error);
3215 if (*error == NULL)
3216   {
3217   while (*s == '+' || *s == '-')
3218     {
3219     int op = *s++;
3220     int64_t y = eval_op_mult(&s, decimal, error);
3221     if (*error != NULL) break;
3222     if (op == '+') x += y; else x -= y;
3223     }
3224   }
3225 *sptr = s;
3226 return x;
3227 }
3228
3229
3230 static int64_t
3231 eval_op_shift(uschar **sptr, BOOL decimal, uschar **error)
3232 {
3233 uschar *s = *sptr;
3234 int64_t x = eval_op_sum(&s, decimal, error);
3235 if (*error == NULL)
3236   {
3237   while ((*s == '<' || *s == '>') && s[1] == s[0])
3238     {
3239     int64_t y;
3240     int op = *s++;
3241     s++;
3242     y = eval_op_sum(&s, decimal, error);
3243     if (*error != NULL) break;
3244     if (op == '<') x <<= y; else x >>= y;
3245     }
3246   }
3247 *sptr = s;
3248 return x;
3249 }
3250
3251
3252 static int64_t
3253 eval_op_and(uschar **sptr, BOOL decimal, uschar **error)
3254 {
3255 uschar *s = *sptr;
3256 int64_t x = eval_op_shift(&s, decimal, error);
3257 if (*error == NULL)
3258   {
3259   while (*s == '&')
3260     {
3261     int64_t y;
3262     s++;
3263     y = eval_op_shift(&s, decimal, error);
3264     if (*error != NULL) break;
3265     x &= y;
3266     }
3267   }
3268 *sptr = s;
3269 return x;
3270 }
3271
3272
3273 static int64_t
3274 eval_op_xor(uschar **sptr, BOOL decimal, uschar **error)
3275 {
3276 uschar *s = *sptr;
3277 int64_t x = eval_op_and(&s, decimal, error);
3278 if (*error == NULL)
3279   {
3280   while (*s == '^')
3281     {
3282     int64_t y;
3283     s++;
3284     y = eval_op_and(&s, decimal, error);
3285     if (*error != NULL) break;
3286     x ^= y;
3287     }
3288   }
3289 *sptr = s;
3290 return x;
3291 }
3292
3293
3294 static int64_t
3295 eval_op_or(uschar **sptr, BOOL decimal, uschar **error)
3296 {
3297 uschar *s = *sptr;
3298 int64_t x = eval_op_xor(&s, decimal, error);
3299 if (*error == NULL)
3300   {
3301   while (*s == '|')
3302     {
3303     int64_t y;
3304     s++;
3305     y = eval_op_xor(&s, decimal, error);
3306     if (*error != NULL) break;
3307     x |= y;
3308     }
3309   }
3310 *sptr = s;
3311 return x;
3312 }
3313
3314
3315
3316 /*************************************************
3317 *                 Expand string                  *
3318 *************************************************/
3319
3320 /* Returns either an unchanged string, or the expanded string in stacking pool
3321 store. Interpreted sequences are:
3322
3323    \...                    normal escaping rules
3324    $name                   substitutes the variable
3325    ${name}                 ditto
3326    ${op:string}            operates on the expanded string value
3327    ${item{arg1}{arg2}...}  expands the args and then does the business
3328                              some literal args are not enclosed in {}
3329
3330 There are now far too many operators and item types to make it worth listing
3331 them here in detail any more.
3332
3333 We use an internal routine recursively to handle embedded substrings. The
3334 external function follows. The yield is NULL if the expansion failed, and there
3335 are two cases: if something collapsed syntactically, or if "fail" was given
3336 as the action on a lookup failure. These can be distinguised by looking at the
3337 variable expand_string_forcedfail, which is TRUE in the latter case.
3338
3339 The skipping flag is set true when expanding a substring that isn't actually
3340 going to be used (after "if" or "lookup") and it prevents lookups from
3341 happening lower down.
3342
3343 Store usage: At start, a store block of the length of the input plus 64
3344 is obtained. This is expanded as necessary by string_cat(), which might have to
3345 get a new block, or might be able to expand the original. At the end of the
3346 function we can release any store above that portion of the yield block that
3347 was actually used. In many cases this will be optimal.
3348
3349 However: if the first item in the expansion is a variable name or header name,
3350 we reset the store before processing it; if the result is in fresh store, we
3351 use that without copying. This is helpful for expanding strings like
3352 $message_headers which can get very long.
3353
3354 There's a problem if a ${dlfunc item has side-effects that cause allocation,
3355 since resetting the store at the end of the expansion will free store that was
3356 allocated by the plugin code as well as the slop after the expanded string. So
3357 we skip any resets if ${dlfunc has been used. This is an unfortunate
3358 consequence of string expansion becoming too powerful.
3359
3360 Arguments:
3361   string         the string to be expanded
3362   ket_ends       true if expansion is to stop at }
3363   left           if not NULL, a pointer to the first character after the
3364                  expansion is placed here (typically used with ket_ends)
3365   skipping       TRUE for recursive calls when the value isn't actually going
3366                  to be used (to allow for optimisation)
3367   honour_dollar  TRUE if $ is to be expanded,
3368                  FALSE if it's just another character
3369
3370 Returns:         NULL if expansion fails:
3371                    expand_string_forcedfail is set TRUE if failure was forced
3372                    expand_string_message contains a textual error message
3373                  a pointer to the expanded string on success
3374 */
3375
3376 static uschar *
3377 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
3378   BOOL skipping, BOOL honour_dollar)
3379 {
3380 int ptr = 0;
3381 int size = Ustrlen(string)+ 64;
3382 int item_type;
3383 uschar *yield = store_get(size);
3384 uschar *s = string;
3385 uschar *save_expand_nstring[EXPAND_MAXN+1];
3386 int save_expand_nlength[EXPAND_MAXN+1];
3387 BOOL resetok = TRUE;
3388
3389 expand_string_forcedfail = FALSE;
3390 expand_string_message = US"";
3391
3392 while (*s != 0)
3393   {
3394   uschar *value;
3395   uschar name[256];
3396
3397   /* \ escapes the next character, which must exist, or else
3398   the expansion fails. There's a special escape, \N, which causes
3399   copying of the subject verbatim up to the next \N. Otherwise,
3400   the escapes are the standard set. */
3401
3402   if (*s == '\\')
3403     {
3404     if (s[1] == 0)
3405       {
3406       expand_string_message = US"\\ at end of string";
3407       goto EXPAND_FAILED;
3408       }
3409
3410     if (s[1] == 'N')
3411       {
3412       uschar *t = s + 2;
3413       for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
3414       yield = string_cat(yield, &size, &ptr, t, s - t);
3415       if (*s != 0) s += 2;
3416       }
3417
3418     else
3419       {
3420       uschar ch[1];
3421       ch[0] = string_interpret_escape(&s);
3422       s++;
3423       yield = string_cat(yield, &size, &ptr, ch, 1);
3424       }
3425
3426     continue;
3427     }
3428
3429   /* Anything other than $ is just copied verbatim, unless we are
3430   looking for a terminating } character. */
3431
3432   if (ket_ends && *s == '}') break;
3433
3434   if (*s != '$' || !honour_dollar)
3435     {
3436     yield = string_cat(yield, &size, &ptr, s++, 1);
3437     continue;
3438     }
3439
3440   /* No { after the $ - must be a plain name or a number for string
3441   match variable. There has to be a fudge for variables that are the
3442   names of header fields preceded by "$header_" because header field
3443   names can contain any printing characters except space and colon.
3444   For those that don't like typing this much, "$h_" is a synonym for
3445   "$header_". A non-existent header yields a NULL value; nothing is
3446   inserted. */
3447
3448   if (isalpha((*(++s))))
3449     {
3450     int len;
3451     int newsize = 0;
3452
3453     s = read_name(name, sizeof(name), s, US"_");
3454
3455     /* If this is the first thing to be expanded, release the pre-allocated
3456     buffer. */
3457
3458     if (ptr == 0 && yield != NULL)
3459       {
3460       if (resetok) store_reset(yield);
3461       yield = NULL;
3462       size = 0;
3463       }
3464
3465     /* Header */
3466
3467     if (Ustrncmp(name, "h_", 2) == 0 ||
3468         Ustrncmp(name, "rh_", 3) == 0 ||
3469         Ustrncmp(name, "bh_", 3) == 0 ||
3470         Ustrncmp(name, "header_", 7) == 0 ||
3471         Ustrncmp(name, "rheader_", 8) == 0 ||
3472         Ustrncmp(name, "bheader_", 8) == 0)
3473       {
3474       BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
3475       uschar *charset = (name[0] == 'b')? NULL : headers_charset;
3476       s = read_header_name(name, sizeof(name), s);
3477       value = find_header(name, FALSE, &newsize, want_raw, charset);
3478
3479       /* If we didn't find the header, and the header contains a closing brace
3480       character, this may be a user error where the terminating colon
3481       has been omitted. Set a flag to adjust the error message in this case.
3482       But there is no error here - nothing gets inserted. */
3483
3484       if (value == NULL)
3485         {
3486         if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
3487         continue;
3488         }
3489       }
3490
3491     /* Variable */
3492
3493     else
3494       {
3495       value = find_variable(name, FALSE, skipping, &newsize);
3496       if (value == NULL)
3497         {
3498         expand_string_message =
3499           string_sprintf("unknown variable name \"%s\"", name);
3500           check_variable_error_message(name);
3501         goto EXPAND_FAILED;
3502         }
3503       }
3504
3505     /* If the data is known to be in a new buffer, newsize will be set to the
3506     size of that buffer. If this is the first thing in an expansion string,
3507     yield will be NULL; just point it at the new store instead of copying. Many
3508     expansion strings contain just one reference, so this is a useful
3509     optimization, especially for humungous headers. */
3510
3511     len = Ustrlen(value);
3512     if (yield == NULL && newsize != 0)
3513       {
3514       yield = value;
3515       size = newsize;
3516       ptr = len;
3517       }
3518     else yield = string_cat(yield, &size, &ptr, value, len);
3519
3520     continue;
3521     }
3522
3523   if (isdigit(*s))
3524     {
3525     int n;
3526     s = read_number(&n, s);
3527     if (n >= 0 && n <= expand_nmax)
3528       yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3529         expand_nlength[n]);
3530     continue;
3531     }
3532
3533   /* Otherwise, if there's no '{' after $ it's an error. */
3534
3535   if (*s != '{')
3536     {
3537     expand_string_message = US"$ not followed by letter, digit, or {";
3538     goto EXPAND_FAILED;
3539     }
3540
3541   /* After { there can be various things, but they all start with
3542   an initial word, except for a number for a string match variable. */
3543
3544   if (isdigit((*(++s))))
3545     {
3546     int n;
3547     s = read_number(&n, s);
3548     if (*s++ != '}')
3549       {
3550       expand_string_message = US"} expected after number";
3551       goto EXPAND_FAILED;
3552       }
3553     if (n >= 0 && n <= expand_nmax)
3554       yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3555         expand_nlength[n]);
3556     continue;
3557     }
3558
3559   if (!isalpha(*s))
3560     {
3561     expand_string_message = US"letter or digit expected after ${";
3562     goto EXPAND_FAILED;
3563     }
3564
3565   /* Allow "-" in names to cater for substrings with negative
3566   arguments. Since we are checking for known names after { this is
3567   OK. */
3568
3569   s = read_name(name, sizeof(name), s, US"_-");
3570   item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3571
3572   switch(item_type)
3573     {
3574     /* Handle conditionals - preserve the values of the numerical expansion
3575     variables in case they get changed by a regular expression match in the
3576     condition. If not, they retain their external settings. At the end
3577     of this "if" section, they get restored to their previous values. */
3578
3579     case EITEM_IF:
3580       {
3581       BOOL cond = FALSE;
3582       uschar *next_s;
3583       int save_expand_nmax =
3584         save_expand_strings(save_expand_nstring, save_expand_nlength);
3585
3586       while (isspace(*s)) s++;
3587       next_s = eval_condition(s, skipping? NULL : &cond);
3588       if (next_s == NULL) goto EXPAND_FAILED;  /* message already set */
3589
3590       DEBUG(D_expand)
3591         debug_printf("condition: %.*s\n   result: %s\n", (int)(next_s - s), s,
3592           cond? "true" : "false");
3593
3594       s = next_s;
3595
3596       /* The handling of "yes" and "no" result strings is now in a separate
3597       function that is also used by ${lookup} and ${extract} and ${run}. */
3598
3599       switch(process_yesno(
3600                skipping,                     /* were previously skipping */
3601                cond,                         /* success/failure indicator */
3602                lookup_value,                 /* value to reset for string2 */
3603                &s,                           /* input pointer */
3604                &yield,                       /* output pointer */
3605                &size,                        /* output size */
3606                &ptr,                         /* output current point */
3607                US"if"))                      /* condition type */
3608         {
3609         case 1: goto EXPAND_FAILED;          /* when all is well, the */
3610         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
3611         }
3612
3613       /* Restore external setting of expansion variables for continuation
3614       at this level. */
3615
3616       restore_expand_strings(save_expand_nmax, save_expand_nstring,
3617         save_expand_nlength);
3618       continue;
3619       }
3620
3621     /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
3622     expanding an internal string that isn't actually going to be used. All we
3623     need to do is check the syntax, so don't do a lookup at all. Preserve the
3624     values of the numerical expansion variables in case they get changed by a
3625     partial lookup. If not, they retain their external settings. At the end
3626     of this "lookup" section, they get restored to their previous values. */
3627
3628     case EITEM_LOOKUP:
3629       {
3630       int stype, partial, affixlen, starflags;
3631       int expand_setup = 0;
3632       int nameptr = 0;
3633       uschar *key, *filename, *affix;
3634       uschar *save_lookup_value = lookup_value;
3635       int save_expand_nmax =
3636         save_expand_strings(save_expand_nstring, save_expand_nlength);
3637
3638       if ((expand_forbid & RDO_LOOKUP) != 0)
3639         {
3640         expand_string_message = US"lookup expansions are not permitted";
3641         goto EXPAND_FAILED;
3642         }
3643
3644       /* Get the key we are to look up for single-key+file style lookups.
3645       Otherwise set the key NULL pro-tem. */
3646
3647       while (isspace(*s)) s++;
3648       if (*s == '{')
3649         {
3650         key = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
3651         if (key == NULL) goto EXPAND_FAILED;
3652         if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3653         while (isspace(*s)) s++;
3654         }
3655       else key = NULL;
3656
3657       /* Find out the type of database */
3658
3659       if (!isalpha(*s))
3660         {
3661         expand_string_message = US"missing lookup type";
3662         goto EXPAND_FAILED;
3663         }
3664
3665       /* The type is a string that may contain special characters of various
3666       kinds. Allow everything except space or { to appear; the actual content
3667       is checked by search_findtype_partial. */
3668
3669       while (*s != 0 && *s != '{' && !isspace(*s))
3670         {
3671         if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
3672         s++;
3673         }
3674       name[nameptr] = 0;
3675       while (isspace(*s)) s++;
3676
3677       /* Now check for the individual search type and any partial or default
3678       options. Only those types that are actually in the binary are valid. */
3679
3680       stype = search_findtype_partial(name, &partial, &affix, &affixlen,
3681         &starflags);
3682       if (stype < 0)
3683         {
3684         expand_string_message = search_error_message;
3685         goto EXPAND_FAILED;
3686         }
3687
3688       /* Check that a key was provided for those lookup types that need it,
3689       and was not supplied for those that use the query style. */
3690
3691       if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
3692         {
3693         if (key == NULL)
3694           {
3695           expand_string_message = string_sprintf("missing {key} for single-"
3696             "key \"%s\" lookup", name);
3697           goto EXPAND_FAILED;
3698           }
3699         }
3700       else
3701         {
3702         if (key != NULL)
3703           {
3704           expand_string_message = string_sprintf("a single key was given for "
3705             "lookup type \"%s\", which is not a single-key lookup type", name);
3706           goto EXPAND_FAILED;
3707           }
3708         }
3709
3710       /* Get the next string in brackets and expand it. It is the file name for
3711       single-key+file lookups, and the whole query otherwise. In the case of
3712       queries that also require a file name (e.g. sqlite), the file name comes
3713       first. */
3714
3715       if (*s != '{') goto EXPAND_FAILED_CURLY;
3716       filename = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
3717       if (filename == NULL) goto EXPAND_FAILED;
3718       if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3719       while (isspace(*s)) s++;
3720
3721       /* If this isn't a single-key+file lookup, re-arrange the variables
3722       to be appropriate for the search_ functions. For query-style lookups,
3723       there is just a "key", and no file name. For the special query-style +
3724       file types, the query (i.e. "key") starts with a file name. */
3725
3726       if (key == NULL)
3727         {
3728         while (isspace(*filename)) filename++;
3729         key = filename;
3730
3731         if (mac_islookup(stype, lookup_querystyle))
3732           {
3733           filename = NULL;
3734           }
3735         else
3736           {
3737           if (*filename != '/')
3738             {
3739             expand_string_message = string_sprintf(
3740               "absolute file name expected for \"%s\" lookup", name);
3741             goto EXPAND_FAILED;
3742             }
3743           while (*key != 0 && !isspace(*key)) key++;
3744           if (*key != 0) *key++ = 0;
3745           }
3746         }
3747
3748       /* If skipping, don't do the next bit - just lookup_value == NULL, as if
3749       the entry was not found. Note that there is no search_close() function.
3750       Files are left open in case of re-use. At suitable places in higher logic,
3751       search_tidyup() is called to tidy all open files. This can save opening
3752       the same file several times. However, files may also get closed when
3753       others are opened, if too many are open at once. The rule is that a
3754       handle should not be used after a second search_open().
3755
3756       Request that a partial search sets up $1 and maybe $2 by passing
3757       expand_setup containing zero. If its value changes, reset expand_nmax,
3758       since new variables will have been set. Note that at the end of this
3759       "lookup" section, the old numeric variables are restored. */
3760
3761       if (skipping)
3762         lookup_value = NULL;
3763       else
3764         {
3765         void *handle = search_open(filename, stype, 0, NULL, NULL);
3766         if (handle == NULL)
3767           {
3768           expand_string_message = search_error_message;
3769           goto EXPAND_FAILED;
3770           }
3771         lookup_value = search_find(handle, filename, key, partial, affix,
3772           affixlen, starflags, &expand_setup);
3773         if (search_find_defer)
3774           {
3775           expand_string_message =
3776             string_sprintf("lookup of \"%s\" gave DEFER: %s",
3777               string_printing2(key, FALSE), search_error_message);
3778           goto EXPAND_FAILED;
3779           }
3780         if (expand_setup > 0) expand_nmax = expand_setup;
3781         }
3782
3783       /* The handling of "yes" and "no" result strings is now in a separate
3784       function that is also used by ${if} and ${extract}. */
3785
3786       switch(process_yesno(
3787                skipping,                     /* were previously skipping */
3788                lookup_value != NULL,         /* success/failure indicator */
3789                save_lookup_value,            /* value to reset for string2 */
3790                &s,                           /* input pointer */
3791                &yield,                       /* output pointer */
3792                &size,                        /* output size */
3793                &ptr,                         /* output current point */
3794                US"lookup"))                  /* condition type */
3795         {
3796         case 1: goto EXPAND_FAILED;          /* when all is well, the */
3797         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
3798         }
3799
3800       /* Restore external setting of expansion variables for carrying on
3801       at this level, and continue. */
3802
3803       restore_expand_strings(save_expand_nmax, save_expand_nstring,
3804         save_expand_nlength);
3805       continue;
3806       }
3807
3808     /* If Perl support is configured, handle calling embedded perl subroutines,
3809     unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
3810     or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
3811     arguments (defined below). */
3812
3813     #define EXIM_PERL_MAX_ARGS 8
3814
3815     case EITEM_PERL:
3816     #ifndef EXIM_PERL
3817     expand_string_message = US"\"${perl\" encountered, but this facility "
3818       "is not included in this binary";
3819     goto EXPAND_FAILED;
3820
3821     #else   /* EXIM_PERL */
3822       {
3823       uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
3824       uschar *new_yield;
3825
3826       if ((expand_forbid & RDO_PERL) != 0)
3827         {
3828         expand_string_message = US"Perl calls are not permitted";
3829         goto EXPAND_FAILED;
3830         }
3831
3832       switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
3833            US"perl"))
3834         {
3835         case 1: goto EXPAND_FAILED_CURLY;
3836         case 2:
3837         case 3: goto EXPAND_FAILED;
3838         }
3839
3840       /* If skipping, we don't actually do anything */
3841
3842       if (skipping) continue;
3843
3844       /* Start the interpreter if necessary */
3845
3846       if (!opt_perl_started)
3847         {
3848         uschar *initerror;
3849         if (opt_perl_startup == NULL)
3850           {
3851           expand_string_message = US"A setting of perl_startup is needed when "
3852             "using the Perl interpreter";
3853           goto EXPAND_FAILED;
3854           }
3855         DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
3856         initerror = init_perl(opt_perl_startup);
3857         if (initerror != NULL)
3858           {
3859           expand_string_message =
3860             string_sprintf("error in perl_startup code: %s\n", initerror);
3861           goto EXPAND_FAILED;
3862           }
3863         opt_perl_started = TRUE;
3864         }
3865
3866       /* Call the function */
3867
3868       sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
3869       new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
3870         sub_arg[0], sub_arg + 1);
3871
3872       /* NULL yield indicates failure; if the message pointer has been set to
3873       NULL, the yield was undef, indicating a forced failure. Otherwise the
3874       message will indicate some kind of Perl error. */
3875
3876       if (new_yield == NULL)
3877         {
3878         if (expand_string_message == NULL)
3879           {
3880           expand_string_message =
3881             string_sprintf("Perl subroutine \"%s\" returned undef to force "
3882               "failure", sub_arg[0]);
3883           expand_string_forcedfail = TRUE;
3884           }
3885         goto EXPAND_FAILED;
3886         }
3887
3888       /* Yield succeeded. Ensure forcedfail is unset, just in case it got
3889       set during a callback from Perl. */
3890
3891       expand_string_forcedfail = FALSE;
3892       yield = new_yield;
3893       continue;
3894       }
3895     #endif /* EXIM_PERL */
3896
3897     /* Transform email address to "prvs" scheme to use
3898        as BATV-signed return path */
3899
3900     case EITEM_PRVS:
3901       {
3902       uschar *sub_arg[3];
3903       uschar *p,*domain;
3904
3905       switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs"))
3906         {
3907         case 1: goto EXPAND_FAILED_CURLY;
3908         case 2:
3909         case 3: goto EXPAND_FAILED;
3910         }
3911
3912       /* If skipping, we don't actually do anything */
3913       if (skipping) continue;
3914
3915       /* sub_arg[0] is the address */
3916       domain = Ustrrchr(sub_arg[0],'@');
3917       if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
3918         {
3919         expand_string_message = US"prvs first argument must be a qualified email address";
3920         goto EXPAND_FAILED;
3921         }
3922
3923       /* Calculate the hash. The second argument must be a single-digit
3924       key number, or unset. */
3925
3926       if (sub_arg[2] != NULL &&
3927           (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
3928         {
3929         expand_string_message = US"prvs second argument must be a single digit";
3930         goto EXPAND_FAILED;
3931         }
3932
3933       p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
3934       if (p == NULL)
3935         {
3936         expand_string_message = US"prvs hmac-sha1 conversion failed";
3937         goto EXPAND_FAILED;
3938         }
3939
3940       /* Now separate the domain from the local part */
3941       *domain++ = '\0';
3942
3943       yield = string_cat(yield,&size,&ptr,US"prvs=",5);
3944       string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
3945       string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
3946       string_cat(yield,&size,&ptr,p,6);
3947       string_cat(yield,&size,&ptr,US"=",1);
3948       string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
3949       string_cat(yield,&size,&ptr,US"@",1);
3950       string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
3951
3952       continue;
3953       }
3954
3955     /* Check a prvs-encoded address for validity */
3956
3957     case EITEM_PRVSCHECK:
3958       {
3959       uschar *sub_arg[3];
3960       int mysize = 0, myptr = 0;
3961       const pcre *re;
3962       uschar *p;
3963
3964       /* TF: Ugliness: We want to expand parameter 1 first, then set
3965          up expansion variables that are used in the expansion of
3966          parameter 2. So we clone the string for the first
3967          expansion, where we only expand parameter 1.
3968
3969          PH: Actually, that isn't necessary. The read_subs() function is
3970          designed to work this way for the ${if and ${lookup expansions. I've
3971          tidied the code.
3972       */
3973
3974       /* Reset expansion variables */
3975       prvscheck_result = NULL;
3976       prvscheck_address = NULL;
3977       prvscheck_keynum = NULL;
3978
3979       switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
3980         {
3981         case 1: goto EXPAND_FAILED_CURLY;
3982         case 2:
3983         case 3: goto EXPAND_FAILED;
3984         }
3985
3986       re = regex_must_compile(US"^prvs\\=([0-9])([0-9]{3})([A-F0-9]{6})\\=(.+)\\@(.+)$",
3987                               TRUE,FALSE);
3988
3989       if (regex_match_and_setup(re,sub_arg[0],0,-1))
3990         {
3991         uschar *local_part = string_copyn(expand_nstring[4],expand_nlength[4]);
3992         uschar *key_num = string_copyn(expand_nstring[1],expand_nlength[1]);
3993         uschar *daystamp = string_copyn(expand_nstring[2],expand_nlength[2]);
3994         uschar *hash = string_copyn(expand_nstring[3],expand_nlength[3]);
3995         uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
3996
3997         DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
3998         DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
3999         DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
4000         DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
4001         DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
4002
4003         /* Set up expansion variables */
4004         prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
4005         string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
4006         string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
4007         prvscheck_address[myptr] = '\0';
4008         prvscheck_keynum = string_copy(key_num);
4009
4010         /* Now expand the second argument */
4011         switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
4012           {
4013           case 1: goto EXPAND_FAILED_CURLY;
4014           case 2:
4015           case 3: goto EXPAND_FAILED;
4016           }
4017
4018         /* Now we have the key and can check the address. */
4019
4020         p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
4021           daystamp);
4022
4023         if (p == NULL)
4024           {
4025           expand_string_message = US"hmac-sha1 conversion failed";
4026           goto EXPAND_FAILED;
4027           }
4028
4029         DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
4030         DEBUG(D_expand) debug_printf("prvscheck:      own hash is %s\n", p);
4031
4032         if (Ustrcmp(p,hash) == 0)
4033           {
4034           /* Success, valid BATV address. Now check the expiry date. */
4035           uschar *now = prvs_daystamp(0);
4036           unsigned int inow = 0,iexpire = 1;
4037
4038           (void)sscanf(CS now,"%u",&inow);
4039           (void)sscanf(CS daystamp,"%u",&iexpire);
4040
4041           /* When "iexpire" is < 7, a "flip" has occured.
4042              Adjust "inow" accordingly. */
4043           if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
4044
4045           if (iexpire >= inow)
4046             {
4047             prvscheck_result = US"1";
4048             DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
4049             }
4050             else
4051             {
4052             prvscheck_result = NULL;
4053             DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
4054             }
4055           }
4056         else
4057           {
4058           prvscheck_result = NULL;
4059           DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
4060           }
4061
4062         /* Now expand the final argument. We leave this till now so that
4063         it can include $prvscheck_result. */
4064
4065         switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs"))
4066           {
4067           case 1: goto EXPAND_FAILED_CURLY;
4068           case 2:
4069           case 3: goto EXPAND_FAILED;
4070           }
4071
4072         if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
4073           yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
4074         else
4075           yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
4076
4077         /* Reset the "internal" variables afterwards, because they are in
4078         dynamic store that will be reclaimed if the expansion succeeded. */
4079
4080         prvscheck_address = NULL;
4081         prvscheck_keynum = NULL;
4082         }
4083       else
4084         {
4085         /* Does not look like a prvs encoded address, return the empty string.
4086            We need to make sure all subs are expanded first, so as to skip over
4087            the entire item. */
4088
4089         switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs"))
4090           {
4091           case 1: goto EXPAND_FAILED_CURLY;
4092           case 2:
4093           case 3: goto EXPAND_FAILED;
4094           }
4095         }
4096
4097       continue;
4098       }
4099
4100     /* Handle "readfile" to insert an entire file */
4101
4102     case EITEM_READFILE:
4103       {
4104       FILE *f;
4105       uschar *sub_arg[2];
4106
4107       if ((expand_forbid & RDO_READFILE) != 0)
4108         {
4109         expand_string_message = US"file insertions are not permitted";
4110         goto EXPAND_FAILED;
4111         }
4112
4113       switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile"))
4114         {
4115         case 1: goto EXPAND_FAILED_CURLY;
4116         case 2:
4117         case 3: goto EXPAND_FAILED;
4118         }
4119
4120       /* If skipping, we don't actually do anything */
4121
4122       if (skipping) continue;
4123
4124       /* Open the file and read it */
4125
4126       f = Ufopen(sub_arg[0], "rb");
4127       if (f == NULL)
4128         {
4129         expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
4130         goto EXPAND_FAILED;
4131         }
4132
4133       yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
4134       (void)fclose(f);
4135       continue;
4136       }
4137
4138     /* Handle "readsocket" to insert data from a Unix domain socket */
4139
4140     case EITEM_READSOCK:
4141       {
4142       int fd;
4143       int timeout = 5;
4144       int save_ptr = ptr;
4145       FILE *f;
4146       struct sockaddr_un sockun;         /* don't call this "sun" ! */
4147       uschar *arg;
4148       uschar *sub_arg[4];
4149
4150       if ((expand_forbid & RDO_READSOCK) != 0)
4151         {
4152         expand_string_message = US"socket insertions are not permitted";
4153         goto EXPAND_FAILED;
4154         }
4155
4156       /* Read up to 4 arguments, but don't do the end of item check afterwards,
4157       because there may be a string for expansion on failure. */
4158
4159       switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket"))
4160         {
4161         case 1: goto EXPAND_FAILED_CURLY;
4162         case 2:                             /* Won't occur: no end check */
4163         case 3: goto EXPAND_FAILED;
4164         }
4165
4166       /* Sort out timeout, if given */
4167
4168       if (sub_arg[2] != NULL)
4169         {
4170         timeout = readconf_readtime(sub_arg[2], 0, FALSE);
4171         if (timeout < 0)
4172           {
4173           expand_string_message = string_sprintf("bad time value %s",
4174             sub_arg[2]);
4175           goto EXPAND_FAILED;
4176           }
4177         }
4178       else sub_arg[3] = NULL;                     /* No eol if no timeout */
4179
4180       /* If skipping, we don't actually do anything. Otherwise, arrange to
4181       connect to either an IP or a Unix socket. */
4182
4183       if (!skipping)
4184         {
4185         /* Handle an IP (internet) domain */
4186
4187         if (Ustrncmp(sub_arg[0], "inet:", 5) == 0)
4188           {
4189           BOOL connected = FALSE;
4190           int namelen, port;
4191           host_item shost;
4192           host_item *h;
4193           uschar *server_name = sub_arg[0] + 5;
4194           uschar *port_name = Ustrrchr(server_name, ':');
4195
4196           /* Sort out the port */
4197
4198           if (port_name == NULL)
4199             {
4200             expand_string_message =
4201               string_sprintf("missing port for readsocket %s", sub_arg[0]);
4202             goto EXPAND_FAILED;
4203             }
4204           *port_name++ = 0;           /* Terminate server name */
4205
4206           if (isdigit(*port_name))
4207             {
4208             uschar *end;
4209             port = Ustrtol(port_name, &end, 0);
4210             if (end != port_name + Ustrlen(port_name))
4211               {
4212               expand_string_message =
4213                 string_sprintf("invalid port number %s", port_name);
4214               goto EXPAND_FAILED;
4215               }
4216             }
4217           else
4218             {
4219             struct servent *service_info = getservbyname(CS port_name, "tcp");
4220             if (service_info == NULL)
4221               {
4222               expand_string_message = string_sprintf("unknown port \"%s\"",
4223                 port_name);
4224               goto EXPAND_FAILED;
4225               }
4226             port = ntohs(service_info->s_port);
4227             }
4228
4229           /* Sort out the server. */
4230
4231           shost.next = NULL;
4232           shost.address = NULL;
4233           shost.port = port;
4234           shost.mx = -1;
4235
4236           namelen = Ustrlen(server_name);
4237
4238           /* Anything enclosed in [] must be an IP address. */
4239
4240           if (server_name[0] == '[' &&
4241               server_name[namelen - 1] == ']')
4242             {
4243             server_name[namelen - 1] = 0;
4244             server_name++;
4245             if (string_is_ip_address(server_name, NULL) == 0)
4246               {
4247               expand_string_message =
4248                 string_sprintf("malformed IP address \"%s\"", server_name);
4249               goto EXPAND_FAILED;
4250               }
4251             shost.name = shost.address = server_name;
4252             }
4253
4254           /* Otherwise check for an unadorned IP address */
4255
4256           else if (string_is_ip_address(server_name, NULL) != 0)
4257             shost.name = shost.address = server_name;
4258
4259           /* Otherwise lookup IP address(es) from the name */
4260
4261           else
4262             {
4263             shost.name = server_name;
4264             if (host_find_byname(&shost, NULL, HOST_FIND_QUALIFY_SINGLE, NULL,
4265                 FALSE) != HOST_FOUND)
4266               {
4267               expand_string_message =
4268                 string_sprintf("no IP address found for host %s", shost.name);
4269               goto EXPAND_FAILED;
4270               }
4271             }
4272
4273           /* Try to connect to the server - test each IP till one works */
4274
4275           for (h = &shost; h != NULL; h = h->next)
4276             {
4277             int af = (Ustrchr(h->address, ':') != 0)? AF_INET6 : AF_INET;
4278             if ((fd = ip_socket(SOCK_STREAM, af)) == -1)
4279               {
4280               expand_string_message = string_sprintf("failed to create socket: "
4281                 "%s", strerror(errno));
4282               goto SOCK_FAIL;
4283               }
4284
4285             if (ip_connect(fd, af, h->address, port, timeout) == 0)
4286               {
4287               connected = TRUE;
4288               break;
4289               }
4290             }
4291
4292           if (!connected)
4293             {
4294             expand_string_message = string_sprintf("failed to connect to "
4295               "socket %s: couldn't connect to any host", sub_arg[0],
4296               strerror(errno));
4297             goto SOCK_FAIL;
4298             }
4299           }
4300
4301         /* Handle a Unix domain socket */
4302
4303         else
4304           {
4305           int rc;
4306           if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
4307             {
4308             expand_string_message = string_sprintf("failed to create socket: %s",
4309               strerror(errno));
4310             goto SOCK_FAIL;
4311             }
4312
4313           sockun.sun_family = AF_UNIX;
4314           sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
4315             sub_arg[0]);
4316
4317           sigalrm_seen = FALSE;
4318           alarm(timeout);
4319           rc = connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun));
4320           alarm(0);
4321           if (sigalrm_seen)
4322             {
4323             expand_string_message = US "socket connect timed out";
4324             goto SOCK_FAIL;
4325             }
4326           if (rc < 0)
4327             {
4328             expand_string_message = string_sprintf("failed to connect to socket "
4329               "%s: %s", sub_arg[0], strerror(errno));
4330             goto SOCK_FAIL;
4331             }
4332           }
4333
4334         DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
4335
4336         /* Write the request string, if not empty */
4337
4338         if (sub_arg[1][0] != 0)
4339           {
4340           int len = Ustrlen(sub_arg[1]);
4341           DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
4342             sub_arg[1]);
4343           if (write(fd, sub_arg[1], len) != len)
4344             {
4345             expand_string_message = string_sprintf("request write to socket "
4346               "failed: %s", strerror(errno));
4347             goto SOCK_FAIL;
4348             }
4349           }
4350
4351         /* Shut down the sending side of the socket. This helps some servers to
4352         recognise that it is their turn to do some work. Just in case some
4353         system doesn't have this function, make it conditional. */
4354
4355         #ifdef SHUT_WR
4356         shutdown(fd, SHUT_WR);
4357         #endif
4358
4359         /* Now we need to read from the socket, under a timeout. The function
4360         that reads a file can be used. */
4361
4362         f = fdopen(fd, "rb");
4363         sigalrm_seen = FALSE;
4364         alarm(timeout);
4365         yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
4366         alarm(0);
4367         (void)fclose(f);
4368
4369         /* After a timeout, we restore the pointer in the result, that is,
4370         make sure we add nothing from the socket. */
4371
4372         if (sigalrm_seen)
4373           {
4374           ptr = save_ptr;
4375           expand_string_message = US "socket read timed out";
4376           goto SOCK_FAIL;
4377           }
4378         }
4379
4380       /* The whole thing has worked (or we were skipping). If there is a
4381       failure string following, we need to skip it. */
4382
4383       if (*s == '{')
4384         {
4385         if (expand_string_internal(s+1, TRUE, &s, TRUE, TRUE) == NULL)
4386           goto EXPAND_FAILED;
4387         if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4388         while (isspace(*s)) s++;
4389         }
4390       if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4391       continue;
4392
4393       /* Come here on failure to create socket, connect socket, write to the
4394       socket, or timeout on reading. If another substring follows, expand and
4395       use it. Otherwise, those conditions give expand errors. */
4396
4397       SOCK_FAIL:
4398       if (*s != '{') goto EXPAND_FAILED;
4399       DEBUG(D_any) debug_printf("%s\n", expand_string_message);
4400       arg = expand_string_internal(s+1, TRUE, &s, FALSE, TRUE);
4401       if (arg == NULL) goto EXPAND_FAILED;
4402       yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
4403       if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4404       while (isspace(*s)) s++;
4405       if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4406       continue;
4407       }
4408
4409     /* Handle "run" to execute a program. */
4410
4411     case EITEM_RUN:
4412       {
4413       FILE *f;
4414       uschar *arg;
4415       uschar **argv;
4416       pid_t pid;
4417       int fd_in, fd_out;
4418       int lsize = 0;
4419       int lptr = 0;
4420
4421       if ((expand_forbid & RDO_RUN) != 0)
4422         {
4423         expand_string_message = US"running a command is not permitted";
4424         goto EXPAND_FAILED;
4425         }
4426
4427       while (isspace(*s)) s++;
4428       if (*s != '{') goto EXPAND_FAILED_CURLY;
4429       arg = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
4430       if (arg == NULL) goto EXPAND_FAILED;
4431       while (isspace(*s)) s++;
4432       if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4433
4434       if (skipping)   /* Just pretend it worked when we're skipping */
4435         {
4436         runrc = 0;
4437         }
4438       else
4439         {
4440         if (!transport_set_up_command(&argv,    /* anchor for arg list */
4441             arg,                                /* raw command */
4442             FALSE,                              /* don't expand the arguments */
4443             0,                                  /* not relevant when... */
4444             NULL,                               /* no transporting address */
4445             US"${run} expansion",               /* for error messages */
4446             &expand_string_message))            /* where to put error message */
4447           {
4448           goto EXPAND_FAILED;
4449           }
4450
4451         /* Create the child process, making it a group leader. */
4452
4453         pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
4454
4455         if (pid < 0)
4456           {
4457           expand_string_message =
4458             string_sprintf("couldn't create child process: %s", strerror(errno));
4459           goto EXPAND_FAILED;
4460           }
4461
4462         /* Nothing is written to the standard input. */
4463
4464         (void)close(fd_in);
4465
4466         /* Read the pipe to get the command's output into $value (which is kept
4467         in lookup_value). Read during execution, so that if the output exceeds
4468         the OS pipe buffer limit, we don't block forever. */
4469
4470         f = fdopen(fd_out, "rb");
4471         sigalrm_seen = FALSE;
4472         alarm(60);
4473         lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
4474         alarm(0);
4475         (void)fclose(f);
4476
4477         /* Wait for the process to finish, applying the timeout, and inspect its
4478         return code for serious disasters. Simple non-zero returns are passed on.
4479         */
4480
4481         if (sigalrm_seen == TRUE || (runrc = child_close(pid, 30)) < 0)
4482           {
4483           if (sigalrm_seen == TRUE || runrc == -256)
4484             {
4485             expand_string_message = string_sprintf("command timed out");
4486             killpg(pid, SIGKILL);       /* Kill the whole process group */
4487             }
4488
4489           else if (runrc == -257)
4490             expand_string_message = string_sprintf("wait() failed: %s",
4491               strerror(errno));
4492
4493           else
4494             expand_string_message = string_sprintf("command killed by signal %d",
4495               -runrc);
4496
4497           goto EXPAND_FAILED;
4498           }
4499         }
4500
4501       /* Process the yes/no strings; $value may be useful in both cases */
4502
4503       switch(process_yesno(
4504                skipping,                     /* were previously skipping */
4505                runrc == 0,                   /* success/failure indicator */
4506                lookup_value,                 /* value to reset for string2 */
4507                &s,                           /* input pointer */
4508                &yield,                       /* output pointer */
4509                &size,                        /* output size */
4510                &ptr,                         /* output current point */
4511                US"run"))                     /* condition type */
4512         {
4513         case 1: goto EXPAND_FAILED;          /* when all is well, the */
4514         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
4515         }
4516
4517       continue;
4518       }
4519
4520     /* Handle character translation for "tr" */
4521
4522     case EITEM_TR:
4523       {
4524       int oldptr = ptr;
4525       int o2m;
4526       uschar *sub[3];
4527
4528       switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr"))
4529         {
4530         case 1: goto EXPAND_FAILED_CURLY;
4531         case 2:
4532         case 3: goto EXPAND_FAILED;
4533         }
4534
4535       yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
4536       o2m = Ustrlen(sub[2]) - 1;
4537
4538       if (o2m >= 0) for (; oldptr < ptr; oldptr++)
4539         {
4540         uschar *m = Ustrrchr(sub[1], yield[oldptr]);
4541         if (m != NULL)
4542           {
4543           int o = m - sub[1];
4544           yield[oldptr] = sub[2][(o < o2m)? o : o2m];
4545           }
4546         }
4547
4548       continue;
4549       }
4550
4551     /* Handle "hash", "length", "nhash", and "substr" when they are given with
4552     expanded arguments. */
4553
4554     case EITEM_HASH:
4555     case EITEM_LENGTH:
4556     case EITEM_NHASH:
4557     case EITEM_SUBSTR:
4558       {
4559       int i;
4560       int len;
4561       uschar *ret;
4562       int val[2] = { 0, -1 };
4563       uschar *sub[3];
4564
4565       /* "length" takes only 2 arguments whereas the others take 2 or 3.
4566       Ensure that sub[2] is set in the ${length case. */
4567
4568       sub[2] = NULL;
4569       switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
4570              TRUE, name))
4571         {
4572         case 1: goto EXPAND_FAILED_CURLY;
4573         case 2:
4574         case 3: goto EXPAND_FAILED;
4575         }
4576
4577       /* Juggle the arguments if there are only two of them: always move the
4578       string to the last position and make ${length{n}{str}} equivalent to
4579       ${substr{0}{n}{str}}. See the defaults for val[] above. */
4580
4581       if (sub[2] == NULL)
4582         {
4583         sub[2] = sub[1];
4584         sub[1] = NULL;
4585         if (item_type == EITEM_LENGTH)
4586           {
4587           sub[1] = sub[0];
4588           sub[0] = NULL;
4589           }
4590         }
4591
4592       for (i = 0; i < 2; i++)
4593         {
4594         if (sub[i] == NULL) continue;
4595         val[i] = (int)Ustrtol(sub[i], &ret, 10);
4596         if (*ret != 0 || (i != 0 && val[i] < 0))
4597           {
4598           expand_string_message = string_sprintf("\"%s\" is not a%s number "
4599             "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
4600           goto EXPAND_FAILED;
4601           }
4602         }
4603
4604       ret =
4605         (item_type == EITEM_HASH)?
4606           compute_hash(sub[2], val[0], val[1], &len) :
4607         (item_type == EITEM_NHASH)?
4608           compute_nhash(sub[2], val[0], val[1], &len) :
4609           extract_substr(sub[2], val[0], val[1], &len);
4610
4611       if (ret == NULL) goto EXPAND_FAILED;
4612       yield = string_cat(yield, &size, &ptr, ret, len);
4613       continue;
4614       }
4615
4616     /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
4617     This code originally contributed by Steve Haslam. It currently supports
4618     the use of MD5 and SHA-1 hashes.
4619
4620     We need some workspace that is large enough to handle all the supported
4621     hash types. Use macros to set the sizes rather than be too elaborate. */
4622
4623     #define MAX_HASHLEN      20
4624     #define MAX_HASHBLOCKLEN 64
4625
4626     case EITEM_HMAC:
4627       {
4628       uschar *sub[3];
4629       md5 md5_base;
4630       sha1 sha1_base;
4631       void *use_base;
4632       int type, i;
4633       int hashlen;      /* Number of octets for the hash algorithm's output */
4634       int hashblocklen; /* Number of octets the hash algorithm processes */
4635       uschar *keyptr, *p;
4636       unsigned int keylen;
4637
4638       uschar keyhash[MAX_HASHLEN];
4639       uschar innerhash[MAX_HASHLEN];
4640       uschar finalhash[MAX_HASHLEN];
4641       uschar finalhash_hex[2*MAX_HASHLEN];
4642       uschar innerkey[MAX_HASHBLOCKLEN];
4643       uschar outerkey[MAX_HASHBLOCKLEN];
4644
4645       switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name))
4646         {
4647         case 1: goto EXPAND_FAILED_CURLY;
4648         case 2:
4649         case 3: goto EXPAND_FAILED;
4650         }
4651
4652       if (Ustrcmp(sub[0], "md5") == 0)
4653         {
4654         type = HMAC_MD5;
4655         use_base = &md5_base;
4656         hashlen = 16;
4657         hashblocklen = 64;
4658         }
4659       else if (Ustrcmp(sub[0], "sha1") == 0)
4660         {
4661         type = HMAC_SHA1;
4662         use_base = &sha1_base;
4663         hashlen = 20;
4664         hashblocklen = 64;
4665         }
4666       else
4667         {
4668         expand_string_message =
4669           string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
4670         goto EXPAND_FAILED;
4671         }
4672
4673       keyptr = sub[1];
4674       keylen = Ustrlen(keyptr);
4675
4676       /* If the key is longer than the hash block length, then hash the key
4677       first */
4678
4679       if (keylen > hashblocklen)
4680         {
4681         chash_start(type, use_base);
4682         chash_end(type, use_base, keyptr, keylen, keyhash);
4683         keyptr = keyhash;
4684         keylen = hashlen;
4685         }
4686
4687       /* Now make the inner and outer key values */
4688
4689       memset(innerkey, 0x36, hashblocklen);
4690       memset(outerkey, 0x5c, hashblocklen);
4691
4692       for (i = 0; i < keylen; i++)
4693         {
4694         innerkey[i] ^= keyptr[i];
4695         outerkey[i] ^= keyptr[i];
4696         }
4697
4698       /* Now do the hashes */
4699
4700       chash_start(type, use_base);
4701       chash_mid(type, use_base, innerkey);
4702       chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
4703
4704       chash_start(type, use_base);
4705       chash_mid(type, use_base, outerkey);
4706       chash_end(type, use_base, innerhash, hashlen, finalhash);
4707
4708       /* Encode the final hash as a hex string */
4709
4710       p = finalhash_hex;
4711       for (i = 0; i < hashlen; i++)
4712         {
4713         *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
4714         *p++ = hex_digits[finalhash[i] & 0x0f];
4715         }
4716
4717       DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
4718         (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
4719
4720       yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
4721       }
4722
4723     continue;
4724
4725     /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
4726     We have to save the numerical variables and restore them afterwards. */
4727
4728     case EITEM_SG:
4729       {
4730       const pcre *re;
4731       int moffset, moffsetextra, slen;
4732       int roffset;
4733       int emptyopt;
4734       const uschar *rerror;
4735       uschar *subject;
4736       uschar *sub[3];
4737       int save_expand_nmax =
4738         save_expand_strings(save_expand_nstring, save_expand_nlength);
4739
4740       switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg"))
4741         {
4742         case 1: goto EXPAND_FAILED_CURLY;
4743         case 2:
4744         case 3: goto EXPAND_FAILED;
4745         }
4746
4747       /* Compile the regular expression */
4748
4749       re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
4750         NULL);
4751
4752       if (re == NULL)
4753         {
4754         expand_string_message = string_sprintf("regular expression error in "
4755           "\"%s\": %s at offset %d", sub[1], rerror, roffset);
4756         goto EXPAND_FAILED;
4757         }
4758
4759       /* Now run a loop to do the substitutions as often as necessary. It ends
4760       when there are no more matches. Take care over matches of the null string;
4761       do the same thing as Perl does. */
4762
4763       subject = sub[0];
4764       slen = Ustrlen(sub[0]);
4765       moffset = moffsetextra = 0;
4766       emptyopt = 0;
4767
4768       for (;;)
4769         {
4770         int ovector[3*(EXPAND_MAXN+1)];
4771         int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
4772           PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
4773         int nn;
4774         uschar *insert;
4775
4776         /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
4777         is not necessarily the end. We want to repeat the match from one
4778         character further along, but leaving the basic offset the same (for
4779         copying below). We can't be at the end of the string - that was checked
4780         before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
4781         finished; copy the remaining string and end the loop. */
4782
4783         if (n < 0)
4784           {
4785           if (emptyopt != 0)
4786             {
4787             moffsetextra = 1;
4788             emptyopt = 0;
4789             continue;
4790             }
4791           yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
4792           break;
4793           }
4794
4795         /* Match - set up for expanding the replacement. */
4796
4797         if (n == 0) n = EXPAND_MAXN + 1;
4798         expand_nmax = 0;
4799         for (nn = 0; nn < n*2; nn += 2)
4800           {
4801           expand_nstring[expand_nmax] = subject + ovector[nn];
4802           expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
4803           }
4804         expand_nmax--;
4805
4806         /* Copy the characters before the match, plus the expanded insertion. */
4807
4808         yield = string_cat(yield, &size, &ptr, subject + moffset,
4809           ovector[0] - moffset);
4810         insert = expand_string(sub[2]);
4811         if (insert == NULL) goto EXPAND_FAILED;
4812         yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
4813
4814         moffset = ovector[1];
4815         moffsetextra = 0;
4816         emptyopt = 0;
4817
4818         /* If we have matched an empty string, first check to see if we are at
4819         the end of the subject. If so, the loop is over. Otherwise, mimic
4820         what Perl's /g options does. This turns out to be rather cunning. First
4821         we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
4822         string at the same point. If this fails (picked up above) we advance to
4823         the next character. */
4824
4825         if (ovector[0] == ovector[1])
4826           {
4827           if (ovector[0] == slen) break;
4828           emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
4829           }
4830         }
4831
4832       /* All done - restore numerical variables. */
4833
4834       restore_expand_strings(save_expand_nmax, save_expand_nstring,
4835         save_expand_nlength);
4836       continue;
4837       }
4838
4839     /* Handle keyed and numbered substring extraction. If the first argument
4840     consists entirely of digits, then a numerical extraction is assumed. */
4841
4842     case EITEM_EXTRACT:
4843       {
4844       int i;
4845       int j = 2;
4846       int field_number = 1;
4847       BOOL field_number_set = FALSE;
4848       uschar *save_lookup_value = lookup_value;
4849       uschar *sub[3];
4850       int save_expand_nmax =
4851         save_expand_strings(save_expand_nstring, save_expand_nlength);
4852
4853       /* Read the arguments */
4854
4855       for (i = 0; i < j; i++)
4856         {
4857         while (isspace(*s)) s++;
4858         if (*s == '{')
4859           {
4860           sub[i] = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
4861           if (sub[i] == NULL) goto EXPAND_FAILED;
4862           if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4863
4864           /* After removal of leading and trailing white space, the first
4865           argument must not be empty; if it consists entirely of digits
4866           (optionally preceded by a minus sign), this is a numerical
4867           extraction, and we expect 3 arguments. */
4868
4869           if (i == 0)
4870             {
4871             int len;
4872             int x = 0;
4873             uschar *p = sub[0];
4874
4875             while (isspace(*p)) p++;
4876             sub[0] = p;
4877
4878             len = Ustrlen(p);
4879             while (len > 0 && isspace(p[len-1])) len--;
4880             p[len] = 0;
4881
4882             if (*p == 0 && !skipping)
4883               {
4884               expand_string_message = US"first argument of \"extract\" must "
4885                 "not be empty";
4886               goto EXPAND_FAILED;
4887               }
4888
4889             if (*p == '-')
4890               {
4891               field_number = -1;
4892               p++;
4893               }
4894             while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
4895             if (*p == 0)
4896               {
4897               field_number *= x;
4898               j = 3;               /* Need 3 args */
4899               field_number_set = TRUE;
4900               }
4901             }
4902           }
4903         else goto EXPAND_FAILED_CURLY;
4904         }
4905
4906       /* Extract either the numbered or the keyed substring into $value. If
4907       skipping, just pretend the extraction failed. */
4908
4909       lookup_value = skipping? NULL : field_number_set?
4910         expand_gettokened(field_number, sub[1], sub[2]) :
4911         expand_getkeyed(sub[0], sub[1]);
4912
4913       /* If no string follows, $value gets substituted; otherwise there can
4914       be yes/no strings, as for lookup or if. */
4915
4916       switch(process_yesno(
4917                skipping,                     /* were previously skipping */
4918                lookup_value != NULL,         /* success/failure indicator */
4919                save_lookup_value,            /* value to reset for string2 */
4920                &s,                           /* input pointer */
4921                &yield,                       /* output pointer */
4922                &size,                        /* output size */
4923                &ptr,                         /* output current point */
4924                US"extract"))                 /* condition type */
4925         {
4926         case 1: goto EXPAND_FAILED;          /* when all is well, the */
4927         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
4928         }
4929
4930       /* All done - restore numerical variables. */
4931
4932       restore_expand_strings(save_expand_nmax, save_expand_nstring,
4933         save_expand_nlength);
4934
4935       continue;
4936       }
4937
4938
4939     /* Handle list operations */
4940
4941     case EITEM_FILTER:
4942     case EITEM_MAP:
4943     case EITEM_REDUCE:
4944       {
4945       int sep = 0;
4946       int save_ptr = ptr;
4947       uschar outsep[2] = { '\0', '\0' };
4948       uschar *list, *expr, *temp;
4949       uschar *save_iterate_item = iterate_item;
4950       uschar *save_lookup_value = lookup_value;
4951
4952       while (isspace(*s)) s++;
4953       if (*s++ != '{') goto EXPAND_FAILED_CURLY;
4954
4955       list = expand_string_internal(s, TRUE, &s, skipping, TRUE);
4956       if (list == NULL) goto EXPAND_FAILED;
4957       if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4958
4959       if (item_type == EITEM_REDUCE)
4960         {
4961         while (isspace(*s)) s++;
4962         if (*s++ != '{') goto EXPAND_FAILED_CURLY;
4963         temp = expand_string_internal(s, TRUE, &s, skipping, TRUE);
4964         if (temp == NULL) goto EXPAND_FAILED;
4965         lookup_value = temp;
4966         if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4967         }
4968
4969       while (isspace(*s)) s++;
4970       if (*s++ != '{') goto EXPAND_FAILED_CURLY;
4971
4972       expr = s;
4973
4974       /* For EITEM_FILTER, call eval_condition once, with result discarded (as
4975       if scanning a "false" part). This allows us to find the end of the
4976       condition, because if the list is empty, we won't actually evaluate the
4977       condition for real. For EITEM_MAP and EITEM_REDUCE, do the same, using
4978       the normal internal expansion function. */
4979
4980       if (item_type == EITEM_FILTER)
4981         {
4982         temp = eval_condition(expr, NULL);
4983         if (temp != NULL) s = temp;
4984         }
4985       else
4986         {
4987         temp = expand_string_internal(s, TRUE, &s, TRUE, TRUE);
4988         }
4989
4990       if (temp == NULL)
4991         {
4992         expand_string_message = string_sprintf("%s inside \"%s\" item",
4993           expand_string_message, name);
4994         goto EXPAND_FAILED;
4995         }
4996
4997       while (isspace(*s)) s++;
4998       if (*s++ != '}')
4999         {
5000         expand_string_message = string_sprintf("missing } at end of condition "
5001           "or expression inside \"%s\"", name);
5002         goto EXPAND_FAILED;
5003         }
5004
5005       while (isspace(*s)) s++;
5006       if (*s++ != '}')
5007         {
5008         expand_string_message = string_sprintf("missing } at end of \"%s\"",
5009           name);
5010         goto EXPAND_FAILED;
5011         }
5012
5013       /* If we are skipping, we can now just move on to the next item. When
5014       processing for real, we perform the iteration. */
5015
5016       if (skipping) continue;
5017       while ((iterate_item = string_nextinlist(&list, &sep, NULL, 0)) != NULL)
5018         {
5019         *outsep = (uschar)sep;      /* Separator as a string */
5020
5021         DEBUG(D_expand) debug_printf("%s: $item = \"%s\"\n", name, iterate_item);
5022
5023         if (item_type == EITEM_FILTER)
5024           {
5025           BOOL condresult;
5026           if (eval_condition(expr, &condresult) == NULL)
5027             {
5028             iterate_item = save_iterate_item;
5029             lookup_value = save_lookup_value;
5030             expand_string_message = string_sprintf("%s inside \"%s\" condition",
5031               expand_string_message, name);
5032             goto EXPAND_FAILED;
5033             }
5034           DEBUG(D_expand) debug_printf("%s: condition is %s\n", name,
5035             condresult? "true":"false");
5036           if (condresult)
5037             temp = iterate_item;    /* TRUE => include this item */
5038           else
5039             continue;               /* FALSE => skip this item */
5040           }
5041
5042         /* EITEM_MAP and EITEM_REDUCE */
5043
5044         else
5045           {
5046           temp = expand_string_internal(expr, TRUE, NULL, skipping, TRUE);
5047           if (temp == NULL)
5048             {
5049             iterate_item = save_iterate_item;
5050             expand_string_message = string_sprintf("%s inside \"%s\" item",
5051               expand_string_message, name);
5052             goto EXPAND_FAILED;
5053             }
5054           if (item_type == EITEM_REDUCE)
5055             {
5056             lookup_value = temp;      /* Update the value of $value */
5057             continue;                 /* and continue the iteration */
5058             }
5059           }
5060
5061         /* We reach here for FILTER if the condition is true, always for MAP,
5062         and never for REDUCE. The value in "temp" is to be added to the output
5063         list that is being created, ensuring that any occurrences of the
5064         separator character are doubled. Unless we are dealing with the first
5065         item of the output list, add in a space if the new item begins with the
5066         separator character, or is an empty string. */
5067
5068         if (ptr != save_ptr && (temp[0] == *outsep || temp[0] == 0))
5069           yield = string_cat(yield, &size, &ptr, US" ", 1);
5070
5071         /* Add the string in "temp" to the output list that we are building,
5072         This is done in chunks by searching for the separator character. */
5073
5074         for (;;)
5075           {
5076           size_t seglen = Ustrcspn(temp, outsep);
5077             yield = string_cat(yield, &size, &ptr, temp, seglen + 1);
5078
5079           /* If we got to the end of the string we output one character
5080           too many; backup and end the loop. Otherwise arrange to double the
5081           separator. */
5082
5083           if (temp[seglen] == '\0') { ptr--; break; }
5084           yield = string_cat(yield, &size, &ptr, outsep, 1);
5085           temp += seglen + 1;
5086           }
5087
5088         /* Output a separator after the string: we will remove the redundant
5089         final one at the end. */
5090
5091         yield = string_cat(yield, &size, &ptr, outsep, 1);
5092         }   /* End of iteration over the list loop */
5093
5094       /* REDUCE has generated no output above: output the final value of
5095       $value. */
5096
5097       if (item_type == EITEM_REDUCE)
5098         {
5099         yield = string_cat(yield, &size, &ptr, lookup_value,
5100           Ustrlen(lookup_value));
5101         lookup_value = save_lookup_value;  /* Restore $value */
5102         }
5103
5104       /* FILTER and MAP generate lists: if they have generated anything, remove
5105       the redundant final separator. Even though an empty item at the end of a
5106       list does not count, this is tidier. */
5107
5108       else if (ptr != save_ptr) ptr--;
5109
5110       /* Restore preserved $item */
5111
5112       iterate_item = save_iterate_item;
5113       continue;
5114       }
5115
5116
5117     /* If ${dlfunc support is configured, handle calling dynamically-loaded
5118     functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
5119     or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
5120     a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
5121
5122     #define EXPAND_DLFUNC_MAX_ARGS 8
5123
5124     case EITEM_DLFUNC:
5125     #ifndef EXPAND_DLFUNC
5126     expand_string_message = US"\"${dlfunc\" encountered, but this facility "
5127       "is not included in this binary";
5128     goto EXPAND_FAILED;
5129
5130     #else   /* EXPAND_DLFUNC */
5131       {
5132       tree_node *t;
5133       exim_dlfunc_t *func;
5134       uschar *result;
5135       int status, argc;
5136       uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
5137
5138       if ((expand_forbid & RDO_DLFUNC) != 0)
5139         {
5140         expand_string_message =
5141           US"dynamically-loaded functions are not permitted";
5142         goto EXPAND_FAILED;
5143         }
5144
5145       switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
5146            TRUE, US"dlfunc"))
5147         {
5148         case 1: goto EXPAND_FAILED_CURLY;
5149         case 2:
5150         case 3: goto EXPAND_FAILED;
5151         }
5152
5153       /* If skipping, we don't actually do anything */
5154
5155       if (skipping) continue;
5156
5157       /* Look up the dynamically loaded object handle in the tree. If it isn't
5158       found, dlopen() the file and put the handle in the tree for next time. */
5159
5160       t = tree_search(dlobj_anchor, argv[0]);
5161       if (t == NULL)
5162         {
5163         void *handle = dlopen(CS argv[0], RTLD_LAZY);
5164         if (handle == NULL)
5165           {
5166           expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
5167             argv[0], dlerror());
5168           log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5169           goto EXPAND_FAILED;
5170           }
5171         t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
5172         Ustrcpy(t->name, argv[0]);
5173         t->data.ptr = handle;
5174         (void)tree_insertnode(&dlobj_anchor, t);
5175         }
5176
5177       /* Having obtained the dynamically loaded object handle, look up the
5178       function pointer. */
5179
5180       func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
5181       if (func == NULL)
5182         {
5183         expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
5184           "%s", argv[1], argv[0], dlerror());
5185         log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
5186         goto EXPAND_FAILED;
5187         }
5188
5189       /* Call the function and work out what to do with the result. If it
5190       returns OK, we have a replacement string; if it returns DEFER then
5191       expansion has failed in a non-forced manner; if it returns FAIL then
5192       failure was forced; if it returns ERROR or any other value there's a
5193       problem, so panic slightly. In any case, assume that the function has
5194       side-effects on the store that must be preserved. */
5195
5196       resetok = FALSE;
5197       result = NULL;
5198       for (argc = 0; argv[argc] != NULL; argc++);
5199       status = func(&result, argc - 2, &argv[2]);
5200       if(status == OK)
5201         {
5202         if (result == NULL) result = US"";
5203         yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
5204         continue;
5205         }
5206       else
5207         {
5208         expand_string_message = result == NULL ? US"(no message)" : result;
5209         if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
5210           else if(status != FAIL)
5211             log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
5212               argv[0], argv[1], status, expand_string_message);
5213         goto EXPAND_FAILED;
5214         }
5215       }
5216     #endif /* EXPAND_DLFUNC */
5217     }
5218
5219   /* Control reaches here if the name is not recognized as one of the more
5220   complicated expansion items. Check for the "operator" syntax (name terminated
5221   by a colon). Some of the operators have arguments, separated by _ from the
5222   name. */
5223
5224   if (*s == ':')
5225     {
5226     int c;
5227     uschar *arg = NULL;
5228     uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping, TRUE);
5229     if (sub == NULL) goto EXPAND_FAILED;
5230     s++;
5231
5232     /* Owing to an historical mis-design, an underscore may be part of the
5233     operator name, or it may introduce arguments.  We therefore first scan the
5234     table of names that contain underscores. If there is no match, we cut off
5235     the arguments and then scan the main table. */
5236
5237     c = chop_match(name, op_table_underscore,
5238       sizeof(op_table_underscore)/sizeof(uschar *));
5239
5240     if (c < 0)
5241       {
5242       arg = Ustrchr(name, '_');
5243       if (arg != NULL) *arg = 0;
5244       c = chop_match(name, op_table_main,
5245         sizeof(op_table_main)/sizeof(uschar *));
5246       if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
5247       if (arg != NULL) *arg++ = '_';   /* Put back for error messages */
5248       }
5249
5250     /* If we are skipping, we don't need to perform the operation at all.
5251     This matters for operations like "mask", because the data may not be
5252     in the correct format when skipping. For example, the expression may test
5253     for the existence of $sender_host_address before trying to mask it. For
5254     other operations, doing them may not fail, but it is a waste of time. */
5255
5256     if (skipping && c >= 0) continue;
5257
5258     /* Otherwise, switch on the operator type */
5259
5260     switch(c)
5261       {
5262       case EOP_BASE62:
5263         {
5264         uschar *t;
5265         unsigned long int n = Ustrtoul(sub, &t, 10);
5266         if (*t != 0)
5267           {
5268           expand_string_message = string_sprintf("argument for base62 "
5269             "operator is \"%s\", which is not a decimal number", sub);
5270           goto EXPAND_FAILED;
5271           }
5272         t = string_base62(n);
5273         yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5274         continue;
5275         }
5276
5277       /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
5278
5279       case EOP_BASE62D:
5280         {
5281         uschar buf[16];
5282         uschar *tt = sub;
5283         unsigned long int n = 0;
5284         while (*tt != 0)
5285           {
5286           uschar *t = Ustrchr(base62_chars, *tt++);
5287           if (t == NULL)
5288             {
5289             expand_string_message = string_sprintf("argument for base62d "
5290               "operator is \"%s\", which is not a base %d number", sub,
5291               BASE_62);
5292             goto EXPAND_FAILED;
5293             }
5294           n = n * BASE_62 + (t - base62_chars);
5295           }
5296         (void)sprintf(CS buf, "%ld", n);
5297         yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
5298         continue;
5299         }
5300
5301       case EOP_EXPAND:
5302         {
5303         uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping, TRUE);
5304         if (expanded == NULL)
5305           {
5306           expand_string_message =
5307             string_sprintf("internal expansion of \"%s\" failed: %s", sub,
5308               expand_string_message);
5309           goto EXPAND_FAILED;
5310           }
5311         yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
5312         continue;
5313         }
5314
5315       case EOP_LC:
5316         {
5317         int count = 0;
5318         uschar *t = sub - 1;
5319         while (*(++t) != 0) { *t = tolower(*t); count++; }
5320         yield = string_cat(yield, &size, &ptr, sub, count);
5321         continue;
5322         }
5323
5324       case EOP_UC:
5325         {
5326         int count = 0;
5327         uschar *t = sub - 1;
5328         while (*(++t) != 0) { *t = toupper(*t); count++; }
5329         yield = string_cat(yield, &size, &ptr, sub, count);
5330         continue;
5331         }
5332
5333       case EOP_MD5:
5334         {
5335         md5 base;
5336         uschar digest[16];
5337         int j;
5338         char st[33];
5339         md5_start(&base);
5340         md5_end(&base, sub, Ustrlen(sub), digest);
5341         for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
5342         yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5343         continue;
5344         }
5345
5346       case EOP_SHA1:
5347         {
5348         sha1 base;
5349         uschar digest[20];
5350         int j;
5351         char st[41];
5352         sha1_start(&base);
5353         sha1_end(&base, sub, Ustrlen(sub), digest);
5354         for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
5355         yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
5356         continue;
5357         }
5358
5359       /* Convert hex encoding to base64 encoding */
5360
5361       case EOP_HEX2B64:
5362         {
5363         int c = 0;
5364         int b = -1;
5365         uschar *in = sub;
5366         uschar *out = sub;
5367         uschar *enc;
5368
5369         for (enc = sub; *enc != 0; enc++)
5370           {
5371           if (!isxdigit(*enc))
5372             {
5373             expand_string_message = string_sprintf("\"%s\" is not a hex "
5374               "string", sub);
5375             goto EXPAND_FAILED;
5376             }
5377           c++;
5378           }
5379
5380         if ((c & 1) != 0)
5381           {
5382           expand_string_message = string_sprintf("\"%s\" contains an odd "
5383             "number of characters", sub);
5384           goto EXPAND_FAILED;
5385           }
5386
5387         while ((c = *in++) != 0)
5388           {
5389           if (isdigit(c)) c -= '0';
5390           else c = toupper(c) - 'A' + 10;
5391           if (b == -1)
5392             {
5393             b = c << 4;
5394             }
5395           else
5396             {
5397             *out++ = b | c;
5398             b = -1;
5399             }
5400           }
5401
5402         enc = auth_b64encode(sub, out - sub);
5403         yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
5404         continue;
5405         }
5406
5407       /* mask applies a mask to an IP address; for example the result of
5408       ${mask:131.111.10.206/28} is 131.111.10.192/28. */
5409
5410       case EOP_MASK:
5411         {
5412         int count;
5413         uschar *endptr;
5414         int binary[4];
5415         int mask, maskoffset;
5416         int type = string_is_ip_address(sub, &maskoffset);
5417         uschar buffer[64];
5418
5419         if (type == 0)
5420           {
5421           expand_string_message = string_sprintf("\"%s\" is not an IP address",
5422            sub);
5423           goto EXPAND_FAILED;
5424           }
5425
5426         if (maskoffset == 0)
5427           {
5428           expand_string_message = string_sprintf("missing mask value in \"%s\"",
5429             sub);
5430           goto EXPAND_FAILED;
5431           }
5432
5433         mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
5434
5435         if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
5436           {
5437           expand_string_message = string_sprintf("mask value too big in \"%s\"",
5438             sub);
5439           goto EXPAND_FAILED;
5440           }
5441
5442         /* Convert the address to binary integer(s) and apply the mask */
5443
5444         sub[maskoffset] = 0;
5445         count = host_aton(sub, binary);
5446         host_mask(count, binary, mask);
5447
5448         /* Convert to masked textual format and add to output. */
5449
5450         yield = string_cat(yield, &size, &ptr, buffer,
5451           host_nmtoa(count, binary, mask, buffer, '.'));
5452         continue;
5453         }
5454
5455       case EOP_ADDRESS:
5456       case EOP_LOCAL_PART:
5457       case EOP_DOMAIN:
5458         {
5459         uschar *error;
5460         int start, end, domain;
5461         uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
5462           FALSE);
5463         if (t != NULL)
5464           {
5465           if (c != EOP_DOMAIN)
5466             {
5467             if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
5468             yield = string_cat(yield, &size, &ptr, sub+start, end-start);
5469             }
5470           else if (domain != 0)
5471             {
5472             domain += start;
5473             yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
5474             }
5475           }
5476         continue;
5477         }
5478
5479       case EOP_ADDRESSES:
5480         {
5481         uschar outsep[2] = { ':', '\0' };
5482         uschar *address, *error;
5483         int save_ptr = ptr;
5484         int start, end, domain;  /* Not really used */
5485
5486         while (isspace(*sub)) sub++;
5487         if (*sub == '>') { *outsep = *++sub; ++sub; }
5488         parse_allow_group = TRUE;
5489
5490         for (;;)
5491           {
5492           uschar *p = parse_find_address_end(sub, FALSE);
5493           uschar saveend = *p;
5494           *p = '\0';
5495           address = parse_extract_address(sub, &error, &start, &end, &domain,
5496             FALSE);
5497           *p = saveend;
5498
5499           /* Add the address to the output list that we are building. This is
5500           done in chunks by searching for the separator character. At the
5501           start, unless we are dealing with the first address of the output
5502           list, add in a space if the new address begins with the separator
5503           character, or is an empty string. */
5504
5505           if (address != NULL)
5506             {
5507             if (ptr != save_ptr && address[0] == *outsep)
5508               yield = string_cat(yield, &size, &ptr, US" ", 1);
5509
5510             for (;;)
5511               {
5512               size_t seglen = Ustrcspn(address, outsep);
5513               yield = string_cat(yield, &size, &ptr, address, seglen + 1);
5514
5515               /* If we got to the end of the string we output one character
5516               too many. */
5517
5518               if (address[seglen] == '\0') { ptr--; break; }
5519               yield = string_cat(yield, &size, &ptr, outsep, 1);
5520               address += seglen + 1;
5521               }
5522
5523             /* Output a separator after the string: we will remove the
5524             redundant final one at the end. */
5525
5526             yield = string_cat(yield, &size, &ptr, outsep, 1);
5527             }
5528
5529           if (saveend == '\0') break;
5530           sub = p + 1;
5531           }
5532
5533         /* If we have generated anything, remove the redundant final
5534         separator. */
5535
5536         if (ptr != save_ptr) ptr--;
5537         parse_allow_group = FALSE;
5538         continue;
5539         }
5540
5541
5542       /* quote puts a string in quotes if it is empty or contains anything
5543       other than alphamerics, underscore, dot, or hyphen.
5544
5545       quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
5546       be quoted in order to be a valid local part.
5547
5548       In both cases, newlines and carriage returns are converted into \n and \r
5549       respectively */
5550
5551       case EOP_QUOTE:
5552       case EOP_QUOTE_LOCAL_PART:
5553       if (arg == NULL)
5554         {
5555         BOOL needs_quote = (*sub == 0);      /* TRUE for empty string */
5556         uschar *t = sub - 1;
5557
5558         if (c == EOP_QUOTE)
5559           {
5560           while (!needs_quote && *(++t) != 0)
5561             needs_quote = !isalnum(*t) && !strchr("_-.", *t);
5562           }
5563         else  /* EOP_QUOTE_LOCAL_PART */
5564           {
5565           while (!needs_quote && *(++t) != 0)
5566             needs_quote = !isalnum(*t) &&
5567               strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
5568               (*t != '.' || t == sub || t[1] == 0);
5569           }
5570
5571         if (needs_quote)
5572           {
5573           yield = string_cat(yield, &size, &ptr, US"\"", 1);
5574           t = sub - 1;
5575           while (*(++t) != 0)
5576             {
5577             if (*t == '\n')
5578               yield = string_cat(yield, &size, &ptr, US"\\n", 2);
5579             else if (*t == '\r')
5580               yield = string_cat(yield, &size, &ptr, US"\\r", 2);
5581             else
5582               {
5583               if (*t == '\\' || *t == '"')
5584                 yield = string_cat(yield, &size, &ptr, US"\\", 1);
5585               yield = string_cat(yield, &size, &ptr, t, 1);
5586               }
5587             }
5588           yield = string_cat(yield, &size, &ptr, US"\"", 1);
5589           }
5590         else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
5591         continue;
5592         }
5593
5594       /* quote_lookuptype does lookup-specific quoting */
5595
5596       else
5597         {
5598         int n;
5599         uschar *opt = Ustrchr(arg, '_');
5600
5601         if (opt != NULL) *opt++ = 0;
5602
5603         n = search_findtype(arg, Ustrlen(arg));
5604         if (n < 0)
5605           {
5606           expand_string_message = search_error_message;
5607           goto EXPAND_FAILED;
5608           }
5609
5610         if (lookup_list[n]->quote != NULL)
5611           sub = (lookup_list[n]->quote)(sub, opt);
5612         else if (opt != NULL) sub = NULL;
5613
5614         if (sub == NULL)
5615           {
5616           expand_string_message = string_sprintf(
5617             "\"%s\" unrecognized after \"${quote_%s\"",
5618             opt, arg);
5619           goto EXPAND_FAILED;
5620           }
5621
5622         yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
5623         continue;
5624         }
5625
5626       /* rx quote sticks in \ before any non-alphameric character so that
5627       the insertion works in a regular expression. */
5628
5629       case EOP_RXQUOTE:
5630         {
5631         uschar *t = sub - 1;
5632         while (*(++t) != 0)
5633           {
5634           if (!isalnum(*t))
5635             yield = string_cat(yield, &size, &ptr, US"\\", 1);
5636           yield = string_cat(yield, &size, &ptr, t, 1);
5637           }
5638         continue;
5639         }
5640
5641       /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
5642       prescribed by the RFC, if there are characters that need to be encoded */
5643
5644       case EOP_RFC2047:
5645         {
5646         uschar buffer[2048];
5647         uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
5648           buffer, sizeof(buffer), FALSE);
5649         yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
5650         continue;
5651         }
5652
5653       /* RFC 2047 decode */
5654
5655       case EOP_RFC2047D:
5656         {
5657         int len;
5658         uschar *error;
5659         uschar *decoded = rfc2047_decode(sub, check_rfc2047_length,
5660           headers_charset, '?', &len, &error);
5661         if (error != NULL)
5662           {
5663           expand_string_message = error;
5664           goto EXPAND_FAILED;
5665           }
5666         yield = string_cat(yield, &size, &ptr, decoded, len);
5667         continue;
5668         }
5669
5670       /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
5671       underscores */
5672
5673       case EOP_FROM_UTF8:
5674         {
5675         while (*sub != 0)
5676           {
5677           int c;
5678           uschar buff[4];
5679           GETUTF8INC(c, sub);
5680           if (c > 255) c = '_';
5681           buff[0] = c;
5682           yield = string_cat(yield, &size, &ptr, buff, 1);
5683           }
5684         continue;
5685         }
5686
5687       /* escape turns all non-printing characters into escape sequences. */
5688
5689       case EOP_ESCAPE:
5690         {
5691         uschar *t = string_printing(sub);
5692         yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5693         continue;
5694         }
5695
5696       /* Handle numeric expression evaluation */
5697
5698       case EOP_EVAL:
5699       case EOP_EVAL10:
5700         {
5701         uschar *save_sub = sub;
5702         uschar *error = NULL;
5703         int64_t n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
5704         if (error != NULL)
5705           {
5706           expand_string_message = string_sprintf("error in expression "
5707             "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
5708               save_sub);
5709           goto EXPAND_FAILED;
5710           }
5711         sprintf(CS var_buffer, "%lld", n);
5712         yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
5713         continue;
5714         }
5715
5716       /* Handle time period formating */
5717
5718       case EOP_TIME_EVAL:
5719         {
5720         int n = readconf_readtime(sub, 0, FALSE);
5721         if (n < 0)
5722           {
5723           expand_string_message = string_sprintf("string \"%s\" is not an "
5724             "Exim time interval in \"%s\" operator", sub, name);
5725           goto EXPAND_FAILED;
5726           }
5727         sprintf(CS var_buffer, "%d", n);
5728         yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
5729         continue;
5730         }
5731
5732       case EOP_TIME_INTERVAL:
5733         {
5734         int n;
5735         uschar *t = read_number(&n, sub);
5736         if (*t != 0) /* Not A Number*/
5737           {
5738           expand_string_message = string_sprintf("string \"%s\" is not a "
5739             "positive number in \"%s\" operator", sub, name);
5740           goto EXPAND_FAILED;
5741           }
5742         t = readconf_printtime(n);
5743         yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
5744         continue;
5745         }
5746
5747       /* Convert string to base64 encoding */
5748
5749       case EOP_STR2B64:
5750         {
5751         uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
5752         yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
5753         continue;
5754         }
5755
5756       /* strlen returns the length of the string */
5757
5758       case EOP_STRLEN:
5759         {
5760         uschar buff[24];
5761         (void)sprintf(CS buff, "%d", Ustrlen(sub));
5762         yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
5763         continue;
5764         }
5765
5766       /* length_n or l_n takes just the first n characters or the whole string,
5767       whichever is the shorter;
5768
5769       substr_m_n, and s_m_n take n characters from offset m; negative m take
5770       from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
5771       takes the rest, either to the right or to the left.
5772
5773       hash_n or h_n makes a hash of length n from the string, yielding n
5774       characters from the set a-z; hash_n_m makes a hash of length n, but
5775       uses m characters from the set a-zA-Z0-9.
5776
5777       nhash_n returns a single number between 0 and n-1 (in text form), while
5778       nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
5779       between 0 and n-1 and the second between 0 and m-1. */
5780
5781       case EOP_LENGTH:
5782       case EOP_L:
5783       case EOP_SUBSTR:
5784       case EOP_S:
5785       case EOP_HASH:
5786       case EOP_H:
5787       case EOP_NHASH:
5788       case EOP_NH:
5789         {
5790         int sign = 1;
5791         int value1 = 0;
5792         int value2 = -1;
5793         int *pn;
5794         int len;
5795         uschar *ret;
5796
5797         if (arg == NULL)
5798           {
5799           expand_string_message = string_sprintf("missing values after %s",
5800             name);
5801           goto EXPAND_FAILED;
5802           }
5803
5804         /* "length" has only one argument, effectively being synonymous with
5805         substr_0_n. */
5806
5807         if (c == EOP_LENGTH || c == EOP_L)
5808           {
5809           pn = &value2;
5810           value2 = 0;
5811           }
5812
5813         /* The others have one or two arguments; for "substr" the first may be
5814         negative. The second being negative means "not supplied". */
5815
5816         else
5817           {
5818           pn = &value1;
5819           if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
5820           }
5821
5822         /* Read up to two numbers, separated by underscores */
5823
5824         ret = arg;
5825         while (*arg != 0)
5826           {
5827           if (arg != ret && *arg == '_' && pn == &value1)
5828             {
5829             pn = &value2;
5830             value2 = 0;
5831             if (arg[1] != 0) arg++;
5832             }
5833           else if (!isdigit(*arg))
5834             {
5835             expand_string_message =
5836               string_sprintf("non-digit after underscore in \"%s\"", name);
5837             goto EXPAND_FAILED;
5838             }
5839           else *pn = (*pn)*10 + *arg++ - '0';
5840           }
5841         value1 *= sign;
5842
5843         /* Perform the required operation */
5844
5845         ret =
5846           (c == EOP_HASH || c == EOP_H)?
5847              compute_hash(sub, value1, value2, &len) :
5848           (c == EOP_NHASH || c == EOP_NH)?
5849              compute_nhash(sub, value1, value2, &len) :
5850              extract_substr(sub, value1, value2, &len);
5851
5852         if (ret == NULL) goto EXPAND_FAILED;
5853         yield = string_cat(yield, &size, &ptr, ret, len);
5854         continue;
5855         }
5856
5857       /* Stat a path */
5858
5859       case EOP_STAT:
5860         {
5861         uschar *s;
5862         uschar smode[12];
5863         uschar **modetable[3];
5864         int i;
5865         mode_t mode;
5866         struct stat st;
5867
5868         if ((expand_forbid & RDO_EXISTS) != 0)
5869           {
5870           expand_string_message = US"Use of the stat() expansion is not permitted";
5871           goto EXPAND_FAILED;
5872           }
5873
5874         if (stat(CS sub, &st) < 0)
5875           {
5876           expand_string_message = string_sprintf("stat(%s) failed: %s",
5877             sub, strerror(errno));
5878           goto EXPAND_FAILED;
5879           }
5880         mode = st.st_mode;
5881         switch (mode & S_IFMT)
5882           {
5883           case S_IFIFO: smode[0] = 'p'; break;
5884           case S_IFCHR: smode[0] = 'c'; break;
5885           case S_IFDIR: smode[0] = 'd'; break;
5886           case S_IFBLK: smode[0] = 'b'; break;
5887           case S_IFREG: smode[0] = '-'; break;
5888           default: smode[0] = '?'; break;
5889           }
5890
5891         modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
5892         modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
5893         modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
5894
5895         for (i = 0; i < 3; i++)
5896           {
5897           memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
5898           mode >>= 3;
5899           }
5900
5901         smode[10] = 0;
5902         s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
5903           "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
5904           (long)(st.st_mode & 077777), smode, (long)st.st_ino,
5905           (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
5906           (long)st.st_gid, st.st_size, (long)st.st_atime,
5907           (long)st.st_mtime, (long)st.st_ctime);
5908         yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
5909         continue;
5910         }
5911
5912       /* pseudo-random number less than N */
5913
5914       case EOP_RANDINT:
5915         {
5916         int64_t max;
5917         uschar *s;
5918
5919         max = expand_string_integer(sub, TRUE);
5920         if (expand_string_message != NULL)
5921           goto EXPAND_FAILED;
5922         s = string_sprintf("%d", pseudo_random_number((int)max));
5923         yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
5924         continue;
5925         }
5926
5927       /* Reverse IP, including IPv6 to dotted-nibble */
5928
5929       case EOP_REVERSE_IP:
5930         {
5931         int family, maskptr;
5932         uschar reversed[128];
5933
5934         family = string_is_ip_address(sub, &maskptr);
5935         if (family == 0)
5936           {
5937           expand_string_message = string_sprintf(
5938               "reverse_ip() not given an IP address [%s]", sub);
5939           goto EXPAND_FAILED;
5940           }
5941         invert_address(reversed, sub);
5942         yield = string_cat(yield, &size, &ptr, reversed, Ustrlen(reversed));
5943         continue;
5944         }
5945
5946       /* Unknown operator */
5947
5948       default:
5949       expand_string_message =
5950         string_sprintf("unknown expansion operator \"%s\"", name);
5951       goto EXPAND_FAILED;
5952       }
5953     }
5954
5955   /* Handle a plain name. If this is the first thing in the expansion, release
5956   the pre-allocated buffer. If the result data is known to be in a new buffer,
5957   newsize will be set to the size of that buffer, and we can just point at that
5958   store instead of copying. Many expansion strings contain just one reference,
5959   so this is a useful optimization, especially for humungous headers
5960   ($message_headers). */
5961
5962   if (*s++ == '}')
5963     {
5964     int len;
5965     int newsize = 0;
5966     if (ptr == 0)
5967       {
5968       if (resetok) store_reset(yield);
5969       yield = NULL;
5970       size = 0;
5971       }
5972     value = find_variable(name, FALSE, skipping, &newsize);
5973     if (value == NULL)
5974       {
5975       expand_string_message =
5976         string_sprintf("unknown variable in \"${%s}\"", name);
5977       check_variable_error_message(name);
5978       goto EXPAND_FAILED;
5979       }
5980     len = Ustrlen(value);
5981     if (yield == NULL && newsize != 0)
5982       {
5983       yield = value;
5984       size = newsize;
5985       ptr = len;
5986       }
5987     else yield = string_cat(yield, &size, &ptr, value, len);
5988     continue;
5989     }
5990
5991   /* Else there's something wrong */
5992
5993   expand_string_message =
5994     string_sprintf("\"${%s\" is not a known operator (or a } is missing "
5995     "in a variable reference)", name);
5996   goto EXPAND_FAILED;
5997   }
5998
5999 /* If we hit the end of the string when ket_ends is set, there is a missing
6000 terminating brace. */
6001
6002 if (ket_ends && *s == 0)
6003   {
6004   expand_string_message = malformed_header?
6005     US"missing } at end of string - could be header name not terminated by colon"
6006     :
6007     US"missing } at end of string";
6008   goto EXPAND_FAILED;
6009   }
6010
6011 /* Expansion succeeded; yield may still be NULL here if nothing was actually
6012 added to the string. If so, set up an empty string. Add a terminating zero. If
6013 left != NULL, return a pointer to the terminator. */
6014
6015 if (yield == NULL) yield = store_get(1);
6016 yield[ptr] = 0;
6017 if (left != NULL) *left = s;
6018
6019 /* Any stacking store that was used above the final string is no longer needed.
6020 In many cases the final string will be the first one that was got and so there
6021 will be optimal store usage. */
6022
6023 if (resetok) store_reset(yield + ptr + 1);
6024 DEBUG(D_expand)
6025   {
6026   debug_printf("expanding: %.*s\n   result: %s\n", (int)(s - string), string,
6027     yield);
6028   if (skipping) debug_printf("skipping: result is not used\n");
6029   }
6030 return yield;
6031
6032 /* This is the failure exit: easiest to program with a goto. We still need
6033 to update the pointer to the terminator, for cases of nested calls with "fail".
6034 */
6035
6036 EXPAND_FAILED_CURLY:
6037 expand_string_message = malformed_header?
6038   US"missing or misplaced { or } - could be header name not terminated by colon"
6039   :
6040   US"missing or misplaced { or }";
6041
6042 /* At one point, Exim reset the store to yield (if yield was not NULL), but
6043 that is a bad idea, because expand_string_message is in dynamic store. */
6044
6045 EXPAND_FAILED:
6046 if (left != NULL) *left = s;
6047 DEBUG(D_expand)
6048   {
6049   debug_printf("failed to expand: %s\n", string);
6050   debug_printf("   error message: %s\n", expand_string_message);
6051   if (expand_string_forcedfail) debug_printf("failure was forced\n");
6052   }
6053 return NULL;
6054 }
6055
6056
6057 /* This is the external function call. Do a quick check for any expansion
6058 metacharacters, and if there are none, just return the input string.
6059
6060 Argument: the string to be expanded
6061 Returns:  the expanded string, or NULL if expansion failed; if failure was
6062           due to a lookup deferring, search_find_defer will be TRUE
6063 */
6064
6065 uschar *
6066 expand_string(uschar *string)
6067 {
6068 search_find_defer = FALSE;
6069 malformed_header = FALSE;
6070 return (Ustrpbrk(string, "$\\") == NULL)? string :
6071   expand_string_internal(string, FALSE, NULL, FALSE, TRUE);
6072 }
6073
6074
6075
6076 /*************************************************
6077 *              Expand and copy                   *
6078 *************************************************/
6079
6080 /* Now and again we want to expand a string and be sure that the result is in a
6081 new bit of store. This function does that.
6082
6083 Argument: the string to be expanded
6084 Returns:  the expanded string, always in a new bit of store, or NULL
6085 */
6086
6087 uschar *
6088 expand_string_copy(uschar *string)
6089 {
6090 uschar *yield = expand_string(string);
6091 if (yield == string) yield = string_copy(string);
6092 return yield;
6093 }
6094
6095
6096
6097 /*************************************************
6098 *        Expand and interpret as an integer      *
6099 *************************************************/
6100
6101 /* Expand a string, and convert the result into an integer.
6102
6103 Arguments:
6104   string  the string to be expanded
6105   isplus  TRUE if a non-negative number is expected
6106
6107 Returns:  the integer value, or
6108           -1 for an expansion error               ) in both cases, message in
6109           -2 for an integer interpretation error  ) expand_string_message
6110           expand_string_message is set NULL for an OK integer
6111 */
6112
6113 int64_t
6114 expand_string_integer(uschar *string, BOOL isplus)
6115 {
6116 int64_t value;
6117 uschar *s = expand_string(string);
6118 uschar *msg = US"invalid integer \"%s\"";
6119 uschar *endptr;
6120
6121 /* If expansion failed, expand_string_message will be set. */
6122
6123 if (s == NULL) return -1;
6124
6125 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
6126 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
6127 systems, so we set it zero ourselves. */
6128
6129 errno = 0;
6130 expand_string_message = NULL;               /* Indicates no error */
6131
6132 /* Before Exim 4.64, strings consisting entirely of whitespace compared
6133 equal to 0.  Unfortunately, people actually relied upon that, so preserve
6134 the behaviour explicitly.  Stripping leading whitespace is a harmless
6135 noop change since strtol skips it anyway (provided that there is a number
6136 to find at all). */
6137 if (isspace(*s))
6138   {
6139   while (isspace(*s)) ++s;
6140   if (*s == '\0')
6141     {
6142       DEBUG(D_expand)
6143        debug_printf("treating blank string as number 0\n");
6144       return 0;
6145     }
6146   }
6147
6148 value = strtoll(CS s, CSS &endptr, 10);
6149
6150 if (endptr == s)
6151   {
6152   msg = US"integer expected but \"%s\" found";
6153   }
6154 else if (value < 0 && isplus)
6155   {
6156   msg = US"non-negative integer expected but \"%s\" found";
6157   }
6158 else
6159   {
6160   if (tolower(*endptr) == 'k')
6161     {
6162     if (value > LLONG_MAX/1024 || value < LLONG_MIN/1024) errno = ERANGE;
6163       else value *= 1024;
6164     endptr++;
6165     }
6166     else if (tolower(*endptr) == 'm')
6167     {
6168     if (value > LLONG_MAX/(1024*1024) || value < LLONG_MIN/(1024*1024))
6169       errno = ERANGE;
6170     else value *= 1024*1024;
6171     endptr++;
6172     }
6173   if (errno == ERANGE)
6174     msg = US"absolute value of integer \"%s\" is too large (overflow)";
6175   else
6176     {
6177     while (isspace(*endptr)) endptr++;
6178     if (*endptr == 0) return (int)value;
6179     }
6180   }
6181
6182 expand_string_message = string_sprintf(CS msg, s);
6183 return -2;
6184 }
6185
6186
6187 /*************************************************
6188 **************************************************
6189 *             Stand-alone test program           *
6190 **************************************************
6191 *************************************************/
6192
6193 #ifdef STAND_ALONE
6194
6195
6196 BOOL
6197 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
6198 {
6199 int ovector[3*(EXPAND_MAXN+1)];
6200 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
6201   ovector, sizeof(ovector)/sizeof(int));
6202 BOOL yield = n >= 0;
6203 if (n == 0) n = EXPAND_MAXN + 1;
6204 if (yield)
6205   {
6206   int nn;
6207   expand_nmax = (setup < 0)? 0 : setup + 1;
6208   for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
6209     {
6210     expand_nstring[expand_nmax] = subject + ovector[nn];
6211     expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
6212     }
6213   expand_nmax--;
6214   }
6215 return yield;
6216 }
6217
6218
6219 int main(int argc, uschar **argv)
6220 {
6221 int i;
6222 uschar buffer[1024];
6223
6224 debug_selector = D_v;
6225 debug_file = stderr;
6226 debug_fd = fileno(debug_file);
6227 big_buffer = malloc(big_buffer_size);
6228
6229 for (i = 1; i < argc; i++)
6230   {
6231   if (argv[i][0] == '+')
6232     {
6233     debug_trace_memory = 2;
6234     argv[i]++;
6235     }
6236   if (isdigit(argv[i][0]))
6237     debug_selector = Ustrtol(argv[i], NULL, 0);
6238   else
6239     if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
6240         Ustrlen(argv[i]))
6241       {
6242       #ifdef LOOKUP_LDAP
6243       eldap_default_servers = argv[i];
6244       #endif
6245       #ifdef LOOKUP_MYSQL
6246       mysql_servers = argv[i];
6247       #endif
6248       #ifdef LOOKUP_PGSQL
6249       pgsql_servers = argv[i];
6250       #endif
6251       }
6252   #ifdef EXIM_PERL
6253   else opt_perl_startup = argv[i];
6254   #endif
6255   }
6256
6257 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
6258
6259 expand_nstring[1] = US"string 1....";
6260 expand_nlength[1] = 8;
6261 expand_nmax = 1;
6262
6263 #ifdef EXIM_PERL
6264 if (opt_perl_startup != NULL)
6265   {
6266   uschar *errstr;
6267   printf("Starting Perl interpreter\n");
6268   errstr = init_perl(opt_perl_startup);
6269   if (errstr != NULL)
6270     {
6271     printf("** error in perl_startup code: %s\n", errstr);
6272     return EXIT_FAILURE;
6273     }
6274   }
6275 #endif /* EXIM_PERL */
6276
6277 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
6278   {
6279   void *reset_point = store_get(0);
6280   uschar *yield = expand_string(buffer);
6281   if (yield != NULL)
6282     {
6283     printf("%s\n", yield);
6284     store_reset(reset_point);
6285     }
6286   else
6287     {
6288     if (search_find_defer) printf("search_find deferred\n");
6289     printf("Failed: %s\n", expand_string_message);
6290     if (expand_string_forcedfail) printf("Forced failure\n");
6291     printf("\n");
6292     }
6293   }
6294
6295 search_tidyup();
6296
6297 return 0;
6298 }
6299
6300 #endif
6301
6302 /* End of expand.c */