src/src/expand.c

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