src/src/expand.c

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