src/src/expand.c

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