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