src/src/expand.c

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