src/src/expand.c

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