src/src/expand.c

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