src/src/expand.c

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