src/src/expand.c

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