src/src/expand.c

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