src/src/expand.c

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