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