src/src/expand.c

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