src/src/expand.c

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