src/src/expand.c

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