src/src/expand.c

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