src/src/expand.c

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