src/src/expand.c

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