src/src/expand.c

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