src/src/expand.c

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