src/src/expand.c

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