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