src/src/expand.c

   1 /* $Cambridge: exim/src/src/expand.c,v 1.41 2005/08/23 08:46:33 ph10 Exp $ */
   2
   3 /*************************************************
   4 *     Exim - an Internet mail transport agent    *
   5 *************************************************/
   6
   7 /* Copyright (c) University of Cambridge 1995 - 2005 */
   8 /* See the file NOTICE for conditions of use and distribution. */
   9
  10
  11 /* Functions for handling string expansion. */
  12
  13
  14 #include "exim.h"
  15
  16 #ifdef STAND_ALONE
  17 #ifndef SUPPORT_CRYPTEQ
  18 #define SUPPORT_CRYPTEQ
  19 #endif
  20 #endif
  21
  22 #ifdef SUPPORT_CRYPTEQ
  23 #ifdef CRYPT_H
  24 #include <crypt.h>
  25 #endif
  26 #ifndef HAVE_CRYPT16
  27 extern char* crypt16(char*, char*);
  28 #endif
  29 #endif
  30
  31 #ifdef LOOKUP_LDAP
  32 #include "lookups/ldap.h"
  33 #endif
  34
  35
  36
  37 /* Recursively called function */
  38
  39 static uschar *expand_string_internal(uschar *, BOOL, uschar **, BOOL);
  40
  41
  42
  43 /*************************************************
  44 *            Local statics and tables            *
  45 *************************************************/
  46
  47 /* Table of item names, and corresponding switch numbers. The names must be in
  48 alphabetical order. */
  49
  50 static uschar *item_table[] = {
  51   US"dlfunc",
  52   US"extract",
  53   US"hash",
  54   US"hmac",
  55   US"if",
  56   US"length",
  57   US"lookup",
  58   US"nhash",
  59   US"perl",
  60   US"prvs",
  61   US"prvscheck",
  62   US"readfile",
  63   US"readsocket",
  64   US"run",
  65   US"sg",
  66   US"substr",
  67   US"tr" };
  68
  69 enum {
  70   EITEM_DLFUNC,
  71   EITEM_EXTRACT,
  72   EITEM_HASH,
  73   EITEM_HMAC,
  74   EITEM_IF,
  75   EITEM_LENGTH,
  76   EITEM_LOOKUP,
  77   EITEM_NHASH,
  78   EITEM_PERL,
  79   EITEM_PRVS,
  80   EITEM_PRVSCHECK,
  81   EITEM_READFILE,
  82   EITEM_READSOCK,
  83   EITEM_RUN,
  84   EITEM_SG,
  85   EITEM_SUBSTR,
  86   EITEM_TR };
  87
  88 /* Tables of operator names, and corresponding switch numbers. The names must be
  89 in alphabetical order. There are two tables, because underscore is used in some
  90 cases to introduce arguments, whereas for other it is part of the name. This is
  91 an historical mis-design. */
  92
  93 static uschar *op_table_underscore[] = {
  94   US"from_utf8",
  95   US"local_part",
  96   US"quote_local_part",
  97   US"time_interval"};
  98
  99 enum {
 100   EOP_FROM_UTF8,
 101   EOP_LOCAL_PART,
 102   EOP_QUOTE_LOCAL_PART,
 103   EOP_TIME_INTERVAL };
 104
 105 static uschar *op_table_main[] = {
 106   US"address",
 107   US"base62",
 108   US"base62d",
 109   US"domain",
 110   US"escape",
 111   US"eval",
 112   US"eval10",
 113   US"expand",
 114   US"h",
 115   US"hash",
 116   US"hex2b64",
 117   US"l",
 118   US"lc",
 119   US"length",
 120   US"mask",
 121   US"md5",
 122   US"nh",
 123   US"nhash",
 124   US"quote",
 125   US"rfc2047",
 126   US"rxquote",
 127   US"s",
 128   US"sha1",
 129   US"stat",
 130   US"str2b64",
 131   US"strlen",
 132   US"substr",
 133   US"uc" };
 134
 135 enum {
 136   EOP_ADDRESS =  sizeof(op_table_underscore)/sizeof(uschar *),
 137   EOP_BASE62,
 138   EOP_BASE62D,
 139   EOP_DOMAIN,
 140   EOP_ESCAPE,
 141   EOP_EVAL,
 142   EOP_EVAL10,
 143   EOP_EXPAND,
 144   EOP_H,
 145   EOP_HASH,
 146   EOP_HEX2B64,
 147   EOP_L,
 148   EOP_LC,
 149   EOP_LENGTH,
 150   EOP_MASK,
 151   EOP_MD5,
 152   EOP_NH,
 153   EOP_NHASH,
 154   EOP_QUOTE,
 155   EOP_RFC2047,
 156   EOP_RXQUOTE,
 157   EOP_S,
 158   EOP_SHA1,
 159   EOP_STAT,
 160   EOP_STR2B64,
 161   EOP_STRLEN,
 162   EOP_SUBSTR,
 163   EOP_UC };
 164
 165
 166 /* Table of condition names, and corresponding switch numbers. The names must
 167 be in alphabetical order. */
 168
 169 static uschar *cond_table[] = {
 170   US"<",
 171   US"<=",
 172   US"=",
 173   US"==",     /* Backward compatibility */
 174   US">",
 175   US">=",
 176   US"and",
 177   US"crypteq",
 178   US"def",
 179   US"eq",
 180   US"eqi",
 181   US"exists",
 182   US"first_delivery",
 183   US"ge",
 184   US"gei",
 185   US"gt",
 186   US"gti",
 187   US"isip",
 188   US"isip4",
 189   US"isip6",
 190   US"ldapauth",
 191   US"le",
 192   US"lei",
 193   US"lt",
 194   US"lti",
 195   US"match",
 196   US"match_address",
 197   US"match_domain",
 198   US"match_ip",
 199   US"match_local_part",
 200   US"or",
 201   US"pam",
 202   US"pwcheck",
 203   US"queue_running",
 204   US"radius",
 205   US"saslauthd"
 206 };
 207
 208 enum {
 209   ECOND_NUM_L,
 210   ECOND_NUM_LE,
 211   ECOND_NUM_E,
 212   ECOND_NUM_EE,
 213   ECOND_NUM_G,
 214   ECOND_NUM_GE,
 215   ECOND_AND,
 216   ECOND_CRYPTEQ,
 217   ECOND_DEF,
 218   ECOND_STR_EQ,
 219   ECOND_STR_EQI,
 220   ECOND_EXISTS,
 221   ECOND_FIRST_DELIVERY,
 222   ECOND_STR_GE,
 223   ECOND_STR_GEI,
 224   ECOND_STR_GT,
 225   ECOND_STR_GTI,
 226   ECOND_ISIP,
 227   ECOND_ISIP4,
 228   ECOND_ISIP6,
 229   ECOND_LDAPAUTH,
 230   ECOND_STR_LE,
 231   ECOND_STR_LEI,
 232   ECOND_STR_LT,
 233   ECOND_STR_LTI,
 234   ECOND_MATCH,
 235   ECOND_MATCH_ADDRESS,
 236   ECOND_MATCH_DOMAIN,
 237   ECOND_MATCH_IP,
 238   ECOND_MATCH_LOCAL_PART,
 239   ECOND_OR,
 240   ECOND_PAM,
 241   ECOND_PWCHECK,
 242   ECOND_QUEUE_RUNNING,
 243   ECOND_RADIUS,
 244   ECOND_SASLAUTHD
 245 };
 246
 247
 248 /* Type for main variable table */
 249
 250 typedef struct {
 251   char *name;
 252   int   type;
 253   void *value;
 254 } var_entry;
 255
 256 /* Type for entries pointing to address/length pairs. Not currently
 257 in use. */
 258
 259 typedef struct {
 260   uschar **address;
 261   int  *length;
 262 } alblock;
 263
 264 /* Types of table entry */
 265
 266 enum {
 267   vtype_int,            /* value is address of int */
 268   vtype_filter_int,     /* ditto, but recognized only when filtering */
 269   vtype_ino,            /* value is address of ino_t (not always an int) */
 270   vtype_uid,            /* value is address of uid_t (not always an int) */
 271   vtype_gid,            /* value is address of gid_t (not always an int) */
 272   vtype_stringptr,      /* value is address of pointer to string */
 273   vtype_msgbody,        /* as stringptr, but read when first required */
 274   vtype_msgbody_end,    /* ditto, the end of the message */
 275   vtype_msgheaders,     /* the message's headers */
 276   vtype_localpart,      /* extract local part from string */
 277   vtype_domain,         /* extract domain from string */
 278   vtype_recipients,     /* extract recipients from recipients list */
 279                         /* (enabled only during system filtering */
 280   vtype_todbsdin,       /* value not used; generate BSD inbox tod */
 281   vtype_tode,           /* value not used; generate tod in epoch format */
 282   vtype_todf,           /* value not used; generate full tod */
 283   vtype_todl,           /* value not used; generate log tod */
 284   vtype_todlf,          /* value not used; generate log file datestamp tod */
 285   vtype_todzone,        /* value not used; generate time zone only */
 286   vtype_todzulu,        /* value not used; generate zulu tod */
 287   vtype_reply,          /* value not used; get reply from headers */
 288   vtype_pid,            /* value not used; result is pid */
 289   vtype_host_lookup,    /* value not used; get host name */
 290   vtype_load_avg,       /* value not used; result is int from os_getloadavg */
 291   vtype_pspace,         /* partition space; value is T/F for spool/log */
 292   vtype_pinodes         /* partition inodes; value is T/F for spool/log */
 293 #ifdef EXPERIMENTAL_DOMAINKEYS
 294  ,vtype_dk_verify       /* Serve request out of DomainKeys verification structure */
 295 #endif
 296   };
 297
 298 /* This table must be kept in alphabetical order. */
 299
 300 static var_entry var_table[] = {
 301   { "acl_c0",              vtype_stringptr,   &acl_var[0] },
 302   { "acl_c1",              vtype_stringptr,   &acl_var[1] },
 303   { "acl_c2",              vtype_stringptr,   &acl_var[2] },
 304   { "acl_c3",              vtype_stringptr,   &acl_var[3] },
 305   { "acl_c4",              vtype_stringptr,   &acl_var[4] },
 306   { "acl_c5",              vtype_stringptr,   &acl_var[5] },
 307   { "acl_c6",              vtype_stringptr,   &acl_var[6] },
 308   { "acl_c7",              vtype_stringptr,   &acl_var[7] },
 309   { "acl_c8",              vtype_stringptr,   &acl_var[8] },
 310   { "acl_c9",              vtype_stringptr,   &acl_var[9] },
 311   { "acl_m0",              vtype_stringptr,   &acl_var[10] },
 312   { "acl_m1",              vtype_stringptr,   &acl_var[11] },
 313   { "acl_m2",              vtype_stringptr,   &acl_var[12] },
 314   { "acl_m3",              vtype_stringptr,   &acl_var[13] },
 315   { "acl_m4",              vtype_stringptr,   &acl_var[14] },
 316   { "acl_m5",              vtype_stringptr,   &acl_var[15] },
 317   { "acl_m6",              vtype_stringptr,   &acl_var[16] },
 318   { "acl_m7",              vtype_stringptr,   &acl_var[17] },
 319   { "acl_m8",              vtype_stringptr,   &acl_var[18] },
 320   { "acl_m9",              vtype_stringptr,   &acl_var[19] },
 321   { "acl_verify_message",  vtype_stringptr,   &acl_verify_message },
 322   { "address_data",        vtype_stringptr,   &deliver_address_data },
 323   { "address_file",        vtype_stringptr,   &address_file },
 324   { "address_pipe",        vtype_stringptr,   &address_pipe },
 325   { "authenticated_id",    vtype_stringptr,   &authenticated_id },
 326   { "authenticated_sender",vtype_stringptr,   &authenticated_sender },
 327   { "authentication_failed",vtype_int,        &authentication_failed },
 328 #ifdef EXPERIMENTAL_BRIGHTMAIL
 329   { "bmi_alt_location",    vtype_stringptr,   &bmi_alt_location },
 330   { "bmi_base64_tracker_verdict", vtype_stringptr, &bmi_base64_tracker_verdict },
 331   { "bmi_base64_verdict",  vtype_stringptr,   &bmi_base64_verdict },
 332   { "bmi_deliver",         vtype_int,         &bmi_deliver },
 333 #endif
 334   { "body_linecount",      vtype_int,         &body_linecount },
 335   { "body_zerocount",      vtype_int,         &body_zerocount },
 336   { "bounce_recipient",    vtype_stringptr,   &bounce_recipient },
 337   { "bounce_return_size_limit", vtype_int,    &bounce_return_size_limit },
 338   { "caller_gid",          vtype_gid,         &real_gid },
 339   { "caller_uid",          vtype_uid,         &real_uid },
 340   { "compile_date",        vtype_stringptr,   &version_date },
 341   { "compile_number",      vtype_stringptr,   &version_cnumber },
 342   { "csa_status",          vtype_stringptr,   &csa_status },
 343 #ifdef WITH_OLD_DEMIME
 344   { "demime_errorlevel",   vtype_int,         &demime_errorlevel },
 345   { "demime_reason",       vtype_stringptr,   &demime_reason },
 346 #endif
 347 #ifdef EXPERIMENTAL_DOMAINKEYS
 348   { "dk_domain",           vtype_stringptr,   &dk_signing_domain },
 349   { "dk_is_signed",        vtype_dk_verify,   NULL },
 350   { "dk_result",           vtype_dk_verify,   NULL },
 351   { "dk_selector",         vtype_stringptr,   &dk_signing_selector },
 352   { "dk_sender",           vtype_dk_verify,   NULL },
 353   { "dk_sender_domain",    vtype_dk_verify,   NULL },
 354   { "dk_sender_local_part",vtype_dk_verify,   NULL },
 355   { "dk_sender_source",    vtype_dk_verify,   NULL },
 356   { "dk_signsall",         vtype_dk_verify,   NULL },
 357   { "dk_status",           vtype_dk_verify,   NULL },
 358   { "dk_testing",          vtype_dk_verify,   NULL },
 359 #endif
 360   { "dnslist_domain",      vtype_stringptr,   &dnslist_domain },
 361   { "dnslist_text",        vtype_stringptr,   &dnslist_text },
 362   { "dnslist_value",       vtype_stringptr,   &dnslist_value },
 363   { "domain",              vtype_stringptr,   &deliver_domain },
 364   { "domain_data",         vtype_stringptr,   &deliver_domain_data },
 365   { "exim_gid",            vtype_gid,         &exim_gid },
 366   { "exim_path",           vtype_stringptr,   &exim_path },
 367   { "exim_uid",            vtype_uid,         &exim_uid },
 368 #ifdef WITH_OLD_DEMIME
 369   { "found_extension",     vtype_stringptr,   &found_extension },
 370 #endif
 371   { "home",                vtype_stringptr,   &deliver_home },
 372   { "host",                vtype_stringptr,   &deliver_host },
 373   { "host_address",        vtype_stringptr,   &deliver_host_address },
 374   { "host_data",           vtype_stringptr,   &host_data },
 375   { "host_lookup_deferred",vtype_int,         &host_lookup_deferred },
 376   { "host_lookup_failed",  vtype_int,         &host_lookup_failed },
 377   { "inode",               vtype_ino,         &deliver_inode },
 378   { "interface_address",   vtype_stringptr,   &interface_address },
 379   { "interface_port",      vtype_int,         &interface_port },
 380   #ifdef LOOKUP_LDAP
 381   { "ldap_dn",             vtype_stringptr,   &eldap_dn },
 382   #endif
 383   { "load_average",        vtype_load_avg,    NULL },
 384   { "local_part",          vtype_stringptr,   &deliver_localpart },
 385   { "local_part_data",     vtype_stringptr,   &deliver_localpart_data },
 386   { "local_part_prefix",   vtype_stringptr,   &deliver_localpart_prefix },
 387   { "local_part_suffix",   vtype_stringptr,   &deliver_localpart_suffix },
 388   { "local_scan_data",     vtype_stringptr,   &local_scan_data },
 389   { "local_user_gid",      vtype_gid,         &local_user_gid },
 390   { "local_user_uid",      vtype_uid,         &local_user_uid },
 391   { "localhost_number",    vtype_int,         &host_number },
 392   { "log_inodes",          vtype_pinodes,     (void *)FALSE },
 393   { "log_space",           vtype_pspace,      (void *)FALSE },
 394   { "mailstore_basename",  vtype_stringptr,   &mailstore_basename },
 395 #ifdef WITH_CONTENT_SCAN
 396   { "malware_name",        vtype_stringptr,   &malware_name },
 397 #endif
 398   { "message_age",         vtype_int,         &message_age },
 399   { "message_body",        vtype_msgbody,     &message_body },
 400   { "message_body_end",    vtype_msgbody_end, &message_body_end },
 401   { "message_body_size",   vtype_int,         &message_body_size },
 402   { "message_exim_id",     vtype_stringptr,   &message_id },
 403   { "message_headers",     vtype_msgheaders,  NULL },
 404   { "message_id",          vtype_stringptr,   &message_id },
 405   { "message_linecount",   vtype_int,         &message_linecount },
 406   { "message_size",        vtype_int,         &message_size },
 407 #ifdef WITH_CONTENT_SCAN
 408   { "mime_anomaly_level",  vtype_int,         &mime_anomaly_level },
 409   { "mime_anomaly_text",   vtype_stringptr,   &mime_anomaly_text },
 410   { "mime_boundary",       vtype_stringptr,   &mime_boundary },
 411   { "mime_charset",        vtype_stringptr,   &mime_charset },
 412   { "mime_content_description", vtype_stringptr, &mime_content_description },
 413   { "mime_content_disposition", vtype_stringptr, &mime_content_disposition },
 414   { "mime_content_id",     vtype_stringptr,   &mime_content_id },
 415   { "mime_content_size",   vtype_int,         &mime_content_size },
 416   { "mime_content_transfer_encoding",vtype_stringptr, &mime_content_transfer_encoding },
 417   { "mime_content_type",   vtype_stringptr,   &mime_content_type },
 418   { "mime_decoded_filename", vtype_stringptr, &mime_decoded_filename },
 419   { "mime_filename",       vtype_stringptr,   &mime_filename },
 420   { "mime_is_coverletter", vtype_int,         &mime_is_coverletter },
 421   { "mime_is_multipart",   vtype_int,         &mime_is_multipart },
 422   { "mime_is_rfc822",      vtype_int,         &mime_is_rfc822 },
 423   { "mime_part_count",     vtype_int,         &mime_part_count },
 424 #endif
 425   { "n0",                  vtype_filter_int,  &filter_n[0] },
 426   { "n1",                  vtype_filter_int,  &filter_n[1] },
 427   { "n2",                  vtype_filter_int,  &filter_n[2] },
 428   { "n3",                  vtype_filter_int,  &filter_n[3] },
 429   { "n4",                  vtype_filter_int,  &filter_n[4] },
 430   { "n5",                  vtype_filter_int,  &filter_n[5] },
 431   { "n6",                  vtype_filter_int,  &filter_n[6] },
 432   { "n7",                  vtype_filter_int,  &filter_n[7] },
 433   { "n8",                  vtype_filter_int,  &filter_n[8] },
 434   { "n9",                  vtype_filter_int,  &filter_n[9] },
 435   { "original_domain",     vtype_stringptr,   &deliver_domain_orig },
 436   { "original_local_part", vtype_stringptr,   &deliver_localpart_orig },
 437   { "originator_gid",      vtype_gid,         &originator_gid },
 438   { "originator_uid",      vtype_uid,         &originator_uid },
 439   { "parent_domain",       vtype_stringptr,   &deliver_domain_parent },
 440   { "parent_local_part",   vtype_stringptr,   &deliver_localpart_parent },
 441   { "pid",                 vtype_pid,         NULL },
 442   { "primary_hostname",    vtype_stringptr,   &primary_hostname },
 443   { "prvscheck_address",   vtype_stringptr,   &prvscheck_address },
 444   { "prvscheck_keynum",    vtype_stringptr,   &prvscheck_keynum },
 445   { "prvscheck_result",    vtype_stringptr,   &prvscheck_result },
 446   { "qualify_domain",      vtype_stringptr,   &qualify_domain_sender },
 447   { "qualify_recipient",   vtype_stringptr,   &qualify_domain_recipient },
 448   { "rcpt_count",          vtype_int,         &rcpt_count },
 449   { "rcpt_defer_count",    vtype_int,         &rcpt_defer_count },
 450   { "rcpt_fail_count",     vtype_int,         &rcpt_fail_count },
 451   { "received_count",      vtype_int,         &received_count },
 452   { "received_for",        vtype_stringptr,   &received_for },
 453   { "received_protocol",   vtype_stringptr,   &received_protocol },
 454   { "received_time",       vtype_int,         &received_time },
 455   { "recipient_data",      vtype_stringptr,   &recipient_data },
 456   { "recipient_verify_failure",vtype_stringptr,&recipient_verify_failure },
 457   { "recipients",          vtype_recipients,  NULL },
 458   { "recipients_count",    vtype_int,         &recipients_count },
 459 #ifdef WITH_CONTENT_SCAN
 460   { "regex_match_string",  vtype_stringptr,   &regex_match_string },
 461 #endif
 462   { "reply_address",       vtype_reply,       NULL },
 463   { "return_path",         vtype_stringptr,   &return_path },
 464   { "return_size_limit",   vtype_int,         &bounce_return_size_limit },
 465   { "runrc",               vtype_int,         &runrc },
 466   { "self_hostname",       vtype_stringptr,   &self_hostname },
 467   { "sender_address",      vtype_stringptr,   &sender_address },
 468   { "sender_address_data", vtype_stringptr,   &sender_address_data },
 469   { "sender_address_domain", vtype_domain,    &sender_address },
 470   { "sender_address_local_part", vtype_localpart, &sender_address },
 471   { "sender_data",         vtype_stringptr,   &sender_data },
 472   { "sender_fullhost",     vtype_stringptr,   &sender_fullhost },
 473   { "sender_helo_name",    vtype_stringptr,   &sender_helo_name },
 474   { "sender_host_address", vtype_stringptr,   &sender_host_address },
 475   { "sender_host_authenticated",vtype_stringptr, &sender_host_authenticated },
 476   { "sender_host_name",    vtype_host_lookup, NULL },
 477   { "sender_host_port",    vtype_int,         &sender_host_port },
 478   { "sender_ident",        vtype_stringptr,   &sender_ident },
 479   { "sender_rate",         vtype_stringptr,   &sender_rate },
 480   { "sender_rate_limit",   vtype_stringptr,   &sender_rate_limit },
 481   { "sender_rate_period",  vtype_stringptr,   &sender_rate_period },
 482   { "sender_rcvhost",      vtype_stringptr,   &sender_rcvhost },
 483   { "sender_verify_failure",vtype_stringptr,  &sender_verify_failure },
 484   { "smtp_active_hostname", vtype_stringptr,  &smtp_active_hostname },
 485   { "smtp_command_argument", vtype_stringptr, &smtp_command_argument },
 486   { "sn0",                 vtype_filter_int,  &filter_sn[0] },
 487   { "sn1",                 vtype_filter_int,  &filter_sn[1] },
 488   { "sn2",                 vtype_filter_int,  &filter_sn[2] },
 489   { "sn3",                 vtype_filter_int,  &filter_sn[3] },
 490   { "sn4",                 vtype_filter_int,  &filter_sn[4] },
 491   { "sn5",                 vtype_filter_int,  &filter_sn[5] },
 492   { "sn6",                 vtype_filter_int,  &filter_sn[6] },
 493   { "sn7",                 vtype_filter_int,  &filter_sn[7] },
 494   { "sn8",                 vtype_filter_int,  &filter_sn[8] },
 495   { "sn9",                 vtype_filter_int,  &filter_sn[9] },
 496 #ifdef WITH_CONTENT_SCAN
 497   { "spam_bar",            vtype_stringptr,   &spam_bar },
 498   { "spam_report",         vtype_stringptr,   &spam_report },
 499   { "spam_score",          vtype_stringptr,   &spam_score },
 500   { "spam_score_int",      vtype_stringptr,   &spam_score_int },
 501 #endif
 502 #ifdef EXPERIMENTAL_SPF
 503   { "spf_header_comment",  vtype_stringptr,   &spf_header_comment },
 504   { "spf_received",        vtype_stringptr,   &spf_received },
 505   { "spf_result",          vtype_stringptr,   &spf_result },
 506   { "spf_smtp_comment",    vtype_stringptr,   &spf_smtp_comment },
 507 #endif
 508   { "spool_directory",     vtype_stringptr,   &spool_directory },
 509   { "spool_inodes",        vtype_pinodes,     (void *)TRUE },
 510   { "spool_space",         vtype_pspace,      (void *)TRUE },
 511 #ifdef EXPERIMENTAL_SRS
 512   { "srs_db_address",      vtype_stringptr,   &srs_db_address },
 513   { "srs_db_key",          vtype_stringptr,   &srs_db_key },
 514   { "srs_orig_recipient",  vtype_stringptr,   &srs_orig_recipient },
 515   { "srs_orig_sender",     vtype_stringptr,   &srs_orig_sender },
 516   { "srs_recipient",       vtype_stringptr,   &srs_recipient },
 517   { "srs_status",          vtype_stringptr,   &srs_status },
 518 #endif
 519   { "thisaddress",         vtype_stringptr,   &filter_thisaddress },
 520   { "tls_certificate_verified", vtype_int,    &tls_certificate_verified },
 521   { "tls_cipher",          vtype_stringptr,   &tls_cipher },
 522   { "tls_peerdn",          vtype_stringptr,   &tls_peerdn },
 523   { "tod_bsdinbox",        vtype_todbsdin,    NULL },
 524   { "tod_epoch",           vtype_tode,        NULL },
 525   { "tod_full",            vtype_todf,        NULL },
 526   { "tod_log",             vtype_todl,        NULL },
 527   { "tod_logfile",         vtype_todlf,       NULL },
 528   { "tod_zone",            vtype_todzone,     NULL },
 529   { "tod_zulu",            vtype_todzulu,     NULL },
 530   { "value",               vtype_stringptr,   &lookup_value },
 531   { "version_number",      vtype_stringptr,   &version_string },
 532   { "warn_message_delay",  vtype_stringptr,   &warnmsg_delay },
 533   { "warn_message_recipient",vtype_stringptr, &warnmsg_recipients },
 534   { "warn_message_recipients",vtype_stringptr,&warnmsg_recipients },
 535   { "warnmsg_delay",       vtype_stringptr,   &warnmsg_delay },
 536   { "warnmsg_recipient",   vtype_stringptr,   &warnmsg_recipients },
 537   { "warnmsg_recipients",  vtype_stringptr,   &warnmsg_recipients }
 538 };
 539
 540 static int var_table_size = sizeof(var_table)/sizeof(var_entry);
 541 static uschar var_buffer[256];
 542 static BOOL malformed_header;
 543
 544 /* For textual hashes */
 545
 546 static char *hashcodes = "abcdefghijklmnopqrtsuvwxyz"
 547                          "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
 548                          "0123456789";
 549
 550 enum { HMAC_MD5, HMAC_SHA1 };
 551
 552 /* For numeric hashes */
 553
 554 static unsigned int prime[] = {
 555   2,   3,   5,   7,  11,  13,  17,  19,  23,  29,
 556  31,  37,  41,  43,  47,  53,  59,  61,  67,  71,
 557  73,  79,  83,  89,  97, 101, 103, 107, 109, 113};
 558
 559 /* For printing modes in symbolic form */
 560
 561 static uschar *mtable_normal[] =
 562   { US"---", US"--x", US"-w-", US"-wx", US"r--", US"r-x", US"rw-", US"rwx" };
 563
 564 static uschar *mtable_setid[] =
 565   { US"--S", US"--s", US"-wS", US"-ws", US"r-S", US"r-s", US"rwS", US"rws" };
 566
 567 static uschar *mtable_sticky[] =
 568   { US"--T", US"--t", US"-wT", US"-wt", US"r-T", US"r-t", US"rwT", US"rwt" };
 569
 570
 571
 572 /*************************************************
 573 *           Tables for UTF-8 support             *
 574 *************************************************/
 575
 576 /* Table of the number of extra characters, indexed by the first character
 577 masked with 0x3f. The highest number for a valid UTF-8 character is in fact
 578 0x3d. */
 579
 580 static uschar utf8_table1[] = {
 581   1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
 582   1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,
 583   2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,
 584   3,3,3,3,3,3,3,3,4,4,4,4,5,5,5,5 };
 585
 586 /* These are the masks for the data bits in the first byte of a character,
 587 indexed by the number of additional bytes. */
 588
 589 static int utf8_table2[] = { 0xff, 0x1f, 0x0f, 0x07, 0x03, 0x01};
 590
 591 /* Get the next UTF-8 character, advancing the pointer. */
 592
 593 #define GETUTF8INC(c, ptr) \
 594   c = *ptr++; \
 595   if ((c & 0xc0) == 0xc0) \
 596     { \
 597     int a = utf8_table1[c & 0x3f];  /* Number of additional bytes */ \
 598     int s = 6*a; \
 599     c = (c & utf8_table2[a]) << s; \
 600     while (a-- > 0) \
 601       { \
 602       s -= 6; \
 603       c |= (*ptr++ & 0x3f) << s; \
 604       } \
 605     }
 606
 607
 608 /*************************************************
 609 *           Binary chop search on a table        *
 610 *************************************************/
 611
 612 /* This is used for matching expansion items and operators.
 613
 614 Arguments:
 615   name        the name that is being sought
 616   table       the table to search
 617   table_size  the number of items in the table
 618
 619 Returns:      the offset in the table, or -1
 620 */
 621
 622 static int
 623 chop_match(uschar *name, uschar **table, int table_size)
 624 {
 625 uschar **bot = table;
 626 uschar **top = table + table_size;
 627
 628 while (top > bot)
 629   {
 630   uschar **mid = bot + (top - bot)/2;
 631   int c = Ustrcmp(name, *mid);
 632   if (c == 0) return mid - table;
 633   if (c > 0) bot = mid + 1; else top = mid;
 634   }
 635
 636 return -1;
 637 }
 638
 639
 640
 641 /*************************************************
 642 *          Check a condition string              *
 643 *************************************************/
 644
 645 /* This function is called to expand a string, and test the result for a "true"
 646 or "false" value. Failure of the expansion yields FALSE; logged unless it was a
 647 forced fail or lookup defer. All store used by the function can be released on
 648 exit.
 649
 650 Arguments:
 651   condition     the condition string
 652   m1            text to be incorporated in panic error
 653   m2            ditto
 654
 655 Returns:        TRUE if condition is met, FALSE if not
 656 */
 657
 658 BOOL
 659 expand_check_condition(uschar *condition, uschar *m1, uschar *m2)
 660 {
 661 int rc;
 662 void *reset_point = store_get(0);
 663 uschar *ss = expand_string(condition);
 664 if (ss == NULL)
 665   {
 666   if (!expand_string_forcedfail && !search_find_defer)
 667     log_write(0, LOG_MAIN|LOG_PANIC, "failed to expand condition \"%s\" "
 668       "for %s %s: %s", condition, m1, m2, expand_string_message);
 669   return FALSE;
 670   }
 671 rc = ss[0] != 0 && Ustrcmp(ss, "0") != 0 && strcmpic(ss, US"no") != 0 &&
 672   strcmpic(ss, US"false") != 0;
 673 store_reset(reset_point);
 674 return rc;
 675 }
 676
 677
 678
 679 /*************************************************
 680 *             Pick out a name from a string      *
 681 *************************************************/
 682
 683 /* If the name is too long, it is silently truncated.
 684
 685 Arguments:
 686   name      points to a buffer into which to put the name
 687   max       is the length of the buffer
 688   s         points to the first alphabetic character of the name
 689   extras    chars other than alphanumerics to permit
 690
 691 Returns:    pointer to the first character after the name
 692
 693 Note: The test for *s != 0 in the while loop is necessary because
 694 Ustrchr() yields non-NULL if the character is zero (which is not something
 695 I expected). */
 696
 697 static uschar *
 698 read_name(uschar *name, int max, uschar *s, uschar *extras)
 699 {
 700 int ptr = 0;
 701 while (*s != 0 && (isalnum(*s) || Ustrchr(extras, *s) != NULL))
 702   {
 703   if (ptr < max-1) name[ptr++] = *s;
 704   s++;
 705   }
 706 name[ptr] = 0;
 707 return s;
 708 }
 709
 710
 711
 712 /*************************************************
 713 *     Pick out the rest of a header name         *
 714 *************************************************/
 715
 716 /* A variable name starting $header_ (or just $h_ for those who like
 717 abbreviations) might not be the complete header name because headers can
 718 contain any printing characters in their names, except ':'. This function is
 719 called to read the rest of the name, chop h[eader]_ off the front, and put ':'
 720 on the end, if the name was terminated by white space.
 721
 722 Arguments:
 723   name      points to a buffer in which the name read so far exists
 724   max       is the length of the buffer
 725   s         points to the first character after the name so far, i.e. the
 726             first non-alphameric character after $header_xxxxx
 727
 728 Returns:    a pointer to the first character after the header name
 729 */
 730
 731 static uschar *
 732 read_header_name(uschar *name, int max, uschar *s)
 733 {
 734 int prelen = Ustrchr(name, '_') - name + 1;
 735 int ptr = Ustrlen(name) - prelen;
 736 if (ptr > 0) memmove(name, name+prelen, ptr);
 737 while (mac_isgraph(*s) && *s != ':')
 738   {
 739   if (ptr < max-1) name[ptr++] = *s;
 740   s++;
 741   }
 742 if (*s == ':') s++;
 743 name[ptr++] = ':';
 744 name[ptr] = 0;
 745 return s;
 746 }
 747
 748
 749
 750 /*************************************************
 751 *           Pick out a number from a string      *
 752 *************************************************/
 753
 754 /* Arguments:
 755   n     points to an integer into which to put the number
 756   s     points to the first digit of the number
 757
 758 Returns:  a pointer to the character after the last digit
 759 */
 760
 761 static uschar *
 762 read_number(int *n, uschar *s)
 763 {
 764 *n = 0;
 765 while (isdigit(*s)) *n = *n * 10 + (*s++ - '0');
 766 return s;
 767 }
 768
 769
 770
 771 /*************************************************
 772 *        Extract keyed subfield from a string    *
 773 *************************************************/
 774
 775 /* The yield is in dynamic store; NULL means that the key was not found.
 776
 777 Arguments:
 778   key       points to the name of the key
 779   s         points to the string from which to extract the subfield
 780
 781 Returns:    NULL if the subfield was not found, or
 782             a pointer to the subfield's data
 783 */
 784
 785 static uschar *
 786 expand_getkeyed(uschar *key, uschar *s)
 787 {
 788 int length = Ustrlen(key);
 789 while (isspace(*s)) s++;
 790
 791 /* Loop to search for the key */
 792
 793 while (*s != 0)
 794   {
 795   int dkeylength;
 796   uschar *data;
 797   uschar *dkey = s;
 798
 799   while (*s != 0 && *s != '=' && !isspace(*s)) s++;
 800   dkeylength = s - dkey;
 801   while (isspace(*s)) s++;
 802   if (*s == '=') while (isspace((*(++s))));
 803
 804   data = string_dequote(&s);
 805   if (length == dkeylength && strncmpic(key, dkey, length) == 0)
 806     return data;
 807
 808   while (isspace(*s)) s++;
 809   }
 810
 811 return NULL;
 812 }
 813
 814
 815
 816
 817 /*************************************************
 818 *   Extract numbered subfield from string        *
 819 *************************************************/
 820
 821 /* Extracts a numbered field from a string that is divided by tokens - for
 822 example a line from /etc/passwd is divided by colon characters.  First field is
 823 numbered one.  Negative arguments count from the right. Zero returns the whole
 824 string. Returns NULL if there are insufficient tokens in the string
 825
 826 ***WARNING***
 827 Modifies final argument - this is a dynamically generated string, so that's OK.
 828
 829 Arguments:
 830   field       number of field to be extracted,
 831                 first field = 1, whole string = 0, last field = -1
 832   separators  characters that are used to break string into tokens
 833   s           points to the string from which to extract the subfield
 834
 835 Returns:      NULL if the field was not found,
 836               a pointer to the field's data inside s (modified to add 0)
 837 */
 838
 839 static uschar *
 840 expand_gettokened (int field, uschar *separators, uschar *s)
 841 {
 842 int sep = 1;
 843 int count;
 844 uschar *ss = s;
 845 uschar *fieldtext = NULL;
 846
 847 if (field == 0) return s;
 848
 849 /* Break the line up into fields in place; for field > 0 we stop when we have
 850 done the number of fields we want. For field < 0 we continue till the end of
 851 the string, counting the number of fields. */
 852
 853 count = (field > 0)? field : INT_MAX;
 854
 855 while (count-- > 0)
 856   {
 857   size_t len;
 858
 859   /* Previous field was the last one in the string. For a positive field
 860   number, this means there are not enough fields. For a negative field number,
 861   check that there are enough, and scan back to find the one that is wanted. */
 862
 863   if (sep == 0)
 864     {
 865     if (field > 0 || (-field) > (INT_MAX - count - 1)) return NULL;
 866     if ((-field) == (INT_MAX - count - 1)) return s;
 867     while (field++ < 0)
 868       {
 869       ss--;
 870       while (ss[-1] != 0) ss--;
 871       }
 872     fieldtext = ss;
 873     break;
 874     }
 875
 876   /* Previous field was not last in the string; save its start and put a
 877   zero at its end. */
 878
 879   fieldtext = ss;
 880   len = Ustrcspn(ss, separators);
 881   sep = ss[len];
 882   ss[len] = 0;
 883   ss += len + 1;
 884   }
 885
 886 return fieldtext;
 887 }
 888
 889
 890
 891 /*************************************************
 892 *        Extract a substring from a string       *
 893 *************************************************/
 894
 895 /* Perform the ${substr or ${length expansion operations.
 896
 897 Arguments:
 898   subject     the input string
 899   value1      the offset from the start of the input string to the start of
 900                 the output string; if negative, count from the right.
 901   value2      the length of the output string, or negative (-1) for unset
 902                 if value1 is positive, unset means "all after"
 903                 if value1 is negative, unset means "all before"
 904   len         set to the length of the returned string
 905
 906 Returns:      pointer to the output string, or NULL if there is an error
 907 */
 908
 909 static uschar *
 910 extract_substr(uschar *subject, int value1, int value2, int *len)
 911 {
 912 int sublen = Ustrlen(subject);
 913
 914 if (value1 < 0)    /* count from right */
 915   {
 916   value1 += sublen;
 917
 918   /* If the position is before the start, skip to the start, and adjust the
 919   length. If the length ends up negative, the substring is null because nothing
 920   can precede. This falls out naturally when the length is unset, meaning "all
 921   to the left". */
 922
 923   if (value1 < 0)
 924     {
 925     value2 += value1;
 926     if (value2 < 0) value2 = 0;
 927     value1 = 0;
 928     }
 929
 930   /* Otherwise an unset length => characters before value1 */
 931
 932   else if (value2 < 0)
 933     {
 934     value2 = value1;
 935     value1 = 0;
 936     }
 937   }
 938
 939 /* For a non-negative offset, if the starting position is past the end of the
 940 string, the result will be the null string. Otherwise, an unset length means
 941 "rest"; just set it to the maximum - it will be cut down below if necessary. */
 942
 943 else
 944   {
 945   if (value1 > sublen)
 946     {
 947     value1 = sublen;
 948     value2 = 0;
 949     }
 950   else if (value2 < 0) value2 = sublen;
 951   }
 952
 953 /* Cut the length down to the maximum possible for the offset value, and get
 954 the required characters. */
 955
 956 if (value1 + value2 > sublen) value2 = sublen - value1;
 957 *len = value2;
 958 return subject + value1;
 959 }
 960
 961
 962
 963
 964 /*************************************************
 965 *            Old-style hash of a string          *
 966 *************************************************/
 967
 968 /* Perform the ${hash expansion operation.
 969
 970 Arguments:
 971   subject     the input string (an expanded substring)
 972   value1      the length of the output string; if greater or equal to the
 973                 length of the input string, the input string is returned
 974   value2      the number of hash characters to use, or 26 if negative
 975   len         set to the length of the returned string
 976
 977 Returns:      pointer to the output string, or NULL if there is an error
 978 */
 979
 980 static uschar *
 981 compute_hash(uschar *subject, int value1, int value2, int *len)
 982 {
 983 int sublen = Ustrlen(subject);
 984
 985 if (value2 < 0) value2 = 26;
 986 else if (value2 > Ustrlen(hashcodes))
 987   {
 988   expand_string_message =
 989     string_sprintf("hash count \"%d\" too big", value2);
 990   return NULL;
 991   }
 992
 993 /* Calculate the hash text. We know it is shorter than the original string, so
 994 can safely place it in subject[] (we know that subject is always itself an
 995 expanded substring). */
 996
 997 if (value1 < sublen)
 998   {
 999   int c;
1000   int i = 0;
1001   int j = value1;
1002   while ((c = (subject[j])) != 0)
1003     {
1004     int shift = (c + j++) & 7;
1005     subject[i] ^= (c << shift) | (c >> (8-shift));
1006     if (++i >= value1) i = 0;
1007     }
1008   for (i = 0; i < value1; i++)
1009     subject[i] = hashcodes[(subject[i]) % value2];
1010   }
1011 else value1 = sublen;
1012
1013 *len = value1;
1014 return subject;
1015 }
1016
1017
1018
1019
1020 /*************************************************
1021 *             Numeric hash of a string           *
1022 *************************************************/
1023
1024 /* Perform the ${nhash expansion operation. The first characters of the
1025 string are treated as most important, and get the highest prime numbers.
1026
1027 Arguments:
1028   subject     the input string
1029   value1      the maximum value of the first part of the result
1030   value2      the maximum value of the second part of the result,
1031                 or negative to produce only a one-part result
1032   len         set to the length of the returned string
1033
1034 Returns:  pointer to the output string, or NULL if there is an error.
1035 */
1036
1037 static uschar *
1038 compute_nhash (uschar *subject, int value1, int value2, int *len)
1039 {
1040 uschar *s = subject;
1041 int i = 0;
1042 unsigned long int total = 0; /* no overflow */
1043
1044 while (*s != 0)
1045   {
1046   if (i == 0) i = sizeof(prime)/sizeof(int) - 1;
1047   total += prime[i--] * (unsigned int)(*s++);
1048   }
1049
1050 /* If value2 is unset, just compute one number */
1051
1052 if (value2 < 0)
1053   {
1054   s = string_sprintf("%d", total % value1);
1055   }
1056
1057 /* Otherwise do a div/mod hash */
1058
1059 else
1060   {
1061   total = total % (value1 * value2);
1062   s = string_sprintf("%d/%d", total/value2, total % value2);
1063   }
1064
1065 *len = Ustrlen(s);
1066 return s;
1067 }
1068
1069
1070
1071
1072
1073 /*************************************************
1074 *     Find the value of a header or headers      *
1075 *************************************************/
1076
1077 /* Multiple instances of the same header get concatenated, and this function
1078 can also return a concatenation of all the header lines. When concatenating
1079 specific headers that contain lists of addresses, a comma is inserted between
1080 them. Otherwise we use a straight concatenation. Because some messages can have
1081 pathologically large number of lines, there is a limit on the length that is
1082 returned. Also, to avoid massive store use which would result from using
1083 string_cat() as it copies and extends strings, we do a preliminary pass to find
1084 out exactly how much store will be needed. On "normal" messages this will be
1085 pretty trivial.
1086
1087 Arguments:
1088   name          the name of the header, without the leading $header_ or $h_,
1089                 or NULL if a concatenation of all headers is required
1090   exists_only   TRUE if called from a def: test; don't need to build a string;
1091                 just return a string that is not "" and not "0" if the header
1092                 exists
1093   newsize       return the size of memory block that was obtained; may be NULL
1094                 if exists_only is TRUE
1095   want_raw      TRUE if called for $rh_ or $rheader_ variables; no processing,
1096                 other than concatenating, will be done on the header
1097   charset       name of charset to translate MIME words to; used only if
1098                 want_raw is false; if NULL, no translation is done (this is
1099                 used for $bh_ and $bheader_)
1100
1101 Returns:        NULL if the header does not exist, else a pointer to a new
1102                 store block
1103 */
1104
1105 static uschar *
1106 find_header(uschar *name, BOOL exists_only, int *newsize, BOOL want_raw,
1107   uschar *charset)
1108 {
1109 BOOL found = name == NULL;
1110 int comma = 0;
1111 int len = found? 0 : Ustrlen(name);
1112 int i;
1113 uschar *yield = NULL;
1114 uschar *ptr = NULL;
1115
1116 /* Loop for two passes - saves code repetition */
1117
1118 for (i = 0; i < 2; i++)
1119   {
1120   int size = 0;
1121   header_line *h;
1122
1123   for (h = header_list; size < header_insert_maxlen && h != NULL; h = h->next)
1124     {
1125     if (h->type != htype_old && h->text != NULL)  /* NULL => Received: placeholder */
1126       {
1127       if (name == NULL || (len <= h->slen && strncmpic(name, h->text, len) == 0))
1128         {
1129         int ilen;
1130         uschar *t;
1131
1132         if (exists_only) return US"1";      /* don't need actual string */
1133         found = TRUE;
1134         t = h->text + len;                  /* text to insert */
1135         if (!want_raw)                      /* unless wanted raw, */
1136           while (isspace(*t)) t++;          /* remove leading white space */
1137         ilen = h->slen - (t - h->text);     /* length to insert */
1138
1139         /* Set comma = 1 if handling a single header and it's one of those
1140         that contains an address list, except when asked for raw headers. Only
1141         need to do this once. */
1142
1143         if (!want_raw && name != NULL && comma == 0 &&
1144             Ustrchr("BCFRST", h->type) != NULL)
1145           comma = 1;
1146
1147         /* First pass - compute total store needed; second pass - compute
1148         total store used, including this header. */
1149
1150         size += ilen + comma;
1151
1152         /* Second pass - concatentate the data, up to a maximum. Note that
1153         the loop stops when size hits the limit. */
1154
1155         if (i != 0)
1156           {
1157           if (size > header_insert_maxlen)
1158             {
1159             ilen -= size - header_insert_maxlen;
1160             comma = 0;
1161             }
1162           Ustrncpy(ptr, t, ilen);
1163           ptr += ilen;
1164           if (comma != 0 && ilen > 0)
1165             {
1166             ptr[-1] = ',';
1167             *ptr++ = '\n';
1168             }
1169           }
1170         }
1171       }
1172     }
1173
1174   /* At end of first pass, truncate size if necessary, and get the buffer
1175   to hold the data, returning the buffer size. */
1176
1177   if (i == 0)
1178     {
1179     if (!found) return NULL;
1180     if (size > header_insert_maxlen) size = header_insert_maxlen;
1181     *newsize = size + 1;
1182     ptr = yield = store_get(*newsize);
1183     }
1184   }
1185
1186 /* Remove a redundant added comma if present */
1187
1188 if (comma != 0 && ptr > yield) ptr -= 2;
1189
1190 /* That's all we do for raw header expansion. */
1191
1192 if (want_raw)
1193   {
1194   *ptr = 0;
1195   }
1196
1197 /* Otherwise, we remove trailing whitespace, including newlines. Then we do RFC
1198 2047 decoding, translating the charset if requested. The rfc2047_decode2()
1199 function can return an error with decoded data if the charset translation
1200 fails. If decoding fails, it returns NULL. */
1201
1202 else
1203   {
1204   uschar *decoded, *error;
1205   while (ptr > yield && isspace(ptr[-1])) ptr--;
1206   *ptr = 0;
1207   decoded = rfc2047_decode2(yield, TRUE, charset, '?', NULL, newsize, &error);
1208   if (error != NULL)
1209     {
1210     DEBUG(D_any) debug_printf("*** error in RFC 2047 decoding: %s\n"
1211       "    input was: %s\n", error, yield);
1212     }
1213   if (decoded != NULL) yield = decoded;
1214   }
1215
1216 return yield;
1217 }
1218
1219
1220
1221
1222 /*************************************************
1223 *               Find value of a variable         *
1224 *************************************************/
1225
1226 /* The table of variables is kept in alphabetic order, so we can search it
1227 using a binary chop. The "choplen" variable is nothing to do with the binary
1228 chop.
1229
1230 Arguments:
1231   name          the name of the variable being sought
1232   exists_only   TRUE if this is a def: test; passed on to find_header()
1233   skipping      TRUE => skip any processing evaluation; this is not the same as
1234                   exists_only because def: may test for values that are first
1235                   evaluated here
1236   newsize       pointer to an int which is initially zero; if the answer is in
1237                 a new memory buffer, *newsize is set to its size
1238
1239 Returns:        NULL if the variable does not exist, or
1240                 a pointer to the variable's contents, or
1241                 something non-NULL if exists_only is TRUE
1242 */
1243
1244 static uschar *
1245 find_variable(uschar *name, BOOL exists_only, BOOL skipping, int *newsize)
1246 {
1247 int first = 0;
1248 int last = var_table_size;
1249
1250 while (last > first)
1251   {
1252   uschar *s, *domain;
1253   uschar **ss;
1254   int middle = (first + last)/2;
1255   int c = Ustrcmp(name, var_table[middle].name);
1256
1257   if (c > 0) { first = middle + 1; continue; }
1258   if (c < 0) { last = middle; continue; }
1259
1260   /* Found an existing variable. If in skipping state, the value isn't needed,
1261   and we want to avoid processing (such as looking up up the host name). */
1262
1263   if (skipping) return US"";
1264
1265   switch (var_table[middle].type)
1266     {
1267 #ifdef EXPERIMENTAL_DOMAINKEYS
1268
1269     case vtype_dk_verify:
1270     if (dk_verify_block == NULL) return US"";
1271     s = NULL;
1272     if (Ustrcmp(var_table[middle].name, "dk_result") == 0)
1273       s = dk_verify_block->result_string;
1274     if (Ustrcmp(var_table[middle].name, "dk_sender") == 0)
1275       s = dk_verify_block->address;
1276     if (Ustrcmp(var_table[middle].name, "dk_sender_domain") == 0)
1277       s = dk_verify_block->domain;
1278     if (Ustrcmp(var_table[middle].name, "dk_sender_local_part") == 0)
1279       s = dk_verify_block->local_part;
1280
1281     if (Ustrcmp(var_table[middle].name, "dk_sender_source") == 0)
1282       switch(dk_verify_block->address_source) {
1283         case DK_EXIM_ADDRESS_NONE: s = US"0"; break;
1284         case DK_EXIM_ADDRESS_FROM_FROM: s = US"from"; break;
1285         case DK_EXIM_ADDRESS_FROM_SENDER: s = US"sender"; break;
1286       }
1287
1288     if (Ustrcmp(var_table[middle].name, "dk_status") == 0)
1289       switch(dk_verify_block->result) {
1290         case DK_EXIM_RESULT_ERR: s = US"error"; break;
1291         case DK_EXIM_RESULT_BAD_FORMAT: s = US"bad format"; break;
1292         case DK_EXIM_RESULT_NO_KEY: s = US"no key"; break;
1293         case DK_EXIM_RESULT_NO_SIGNATURE: s = US"no signature"; break;
1294         case DK_EXIM_RESULT_REVOKED: s = US"revoked"; break;
1295         case DK_EXIM_RESULT_NON_PARTICIPANT: s = US"non-participant"; break;
1296         case DK_EXIM_RESULT_GOOD: s = US"good"; break;
1297         case DK_EXIM_RESULT_BAD: s = US"bad"; break;
1298       }
1299
1300     if (Ustrcmp(var_table[middle].name, "dk_signsall") == 0)
1301       s = (dk_verify_block->signsall)? US"1" : US"0";
1302
1303     if (Ustrcmp(var_table[middle].name, "dk_testing") == 0)
1304       s = (dk_verify_block->testing)? US"1" : US"0";
1305
1306     if (Ustrcmp(var_table[middle].name, "dk_is_signed") == 0)
1307       s = (dk_verify_block->is_signed)? US"1" : US"0";
1308
1309     return (s == NULL)? US"" : s;
1310 #endif
1311
1312     case vtype_filter_int:
1313     if (!filter_running) return NULL;
1314     /* Fall through */
1315     /* VVVVVVVVVVVV */
1316     case vtype_int:
1317     sprintf(CS var_buffer, "%d", *(int *)(var_table[middle].value)); /* Integer */
1318     return var_buffer;
1319
1320     case vtype_ino:
1321     sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(var_table[middle].value))); /* Inode */
1322     return var_buffer;
1323
1324     case vtype_gid:
1325     sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(var_table[middle].value))); /* gid */
1326     return var_buffer;
1327
1328     case vtype_uid:
1329     sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(var_table[middle].value))); /* uid */
1330     return var_buffer;
1331
1332     case vtype_stringptr:                      /* Pointer to string */
1333     s = *((uschar **)(var_table[middle].value));
1334     return (s == NULL)? US"" : s;
1335
1336     case vtype_pid:
1337     sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1338     return var_buffer;
1339
1340     case vtype_load_avg:
1341     sprintf(CS var_buffer, "%d", os_getloadavg()); /* load_average */
1342     return var_buffer;
1343
1344     case vtype_host_lookup:                    /* Lookup if not done so */
1345     if (sender_host_name == NULL && sender_host_address != NULL &&
1346         !host_lookup_failed && host_name_lookup() == OK)
1347       host_build_sender_fullhost();
1348     return (sender_host_name == NULL)? US"" : sender_host_name;
1349
1350     case vtype_localpart:                      /* Get local part from address */
1351     s = *((uschar **)(var_table[middle].value));
1352     if (s == NULL) return US"";
1353     domain = Ustrrchr(s, '@');
1354     if (domain == NULL) return s;
1355     if (domain - s > sizeof(var_buffer) - 1)
1356       log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than %d in "
1357         "string expansion", sizeof(var_buffer));
1358     Ustrncpy(var_buffer, s, domain - s);
1359     var_buffer[domain - s] = 0;
1360     return var_buffer;
1361
1362     case vtype_domain:                         /* Get domain from address */
1363     s = *((uschar **)(var_table[middle].value));
1364     if (s == NULL) return US"";
1365     domain = Ustrrchr(s, '@');
1366     return (domain == NULL)? US"" : domain + 1;
1367
1368     case vtype_msgheaders:
1369     return find_header(NULL, exists_only, newsize, FALSE, NULL);
1370
1371     case vtype_msgbody:                        /* Pointer to msgbody string */
1372     case vtype_msgbody_end:                    /* Ditto, the end of the msg */
1373     ss = (uschar **)(var_table[middle].value);
1374     if (*ss == NULL && deliver_datafile >= 0)  /* Read body when needed */
1375       {
1376       uschar *body;
1377       off_t start_offset = SPOOL_DATA_START_OFFSET;
1378       int len = message_body_visible;
1379       if (len > message_size) len = message_size;
1380       *ss = body = store_malloc(len+1);
1381       body[0] = 0;
1382       if (var_table[middle].type == vtype_msgbody_end)
1383         {
1384         struct stat statbuf;
1385         if (fstat(deliver_datafile, &statbuf) == 0)
1386           {
1387           start_offset = statbuf.st_size - len;
1388           if (start_offset < SPOOL_DATA_START_OFFSET)
1389             start_offset = SPOOL_DATA_START_OFFSET;
1390           }
1391         }
1392       lseek(deliver_datafile, start_offset, SEEK_SET);
1393       len = read(deliver_datafile, body, len);
1394       if (len > 0)
1395         {
1396         body[len] = 0;
1397         while (len > 0)
1398           {
1399           if (body[--len] == '\n' || body[len] == 0) body[len] = ' ';
1400           }
1401         }
1402       }
1403     return (*ss == NULL)? US"" : *ss;
1404
1405     case vtype_todbsdin:                       /* BSD inbox time of day */
1406     return tod_stamp(tod_bsdin);
1407
1408     case vtype_tode:                           /* Unix epoch time of day */
1409     return tod_stamp(tod_epoch);
1410
1411     case vtype_todf:                           /* Full time of day */
1412     return tod_stamp(tod_full);
1413
1414     case vtype_todl:                           /* Log format time of day */
1415     return tod_stamp(tod_log_bare);            /* (without timezone) */
1416
1417     case vtype_todzone:                        /* Time zone offset only */
1418     return tod_stamp(tod_zone);
1419
1420     case vtype_todzulu:                        /* Zulu time */
1421     return tod_stamp(tod_zulu);
1422
1423     case vtype_todlf:                          /* Log file datestamp tod */
1424     return tod_stamp(tod_log_datestamp);
1425
1426     case vtype_reply:                          /* Get reply address */
1427     s = find_header(US"reply-to:", exists_only, newsize, FALSE,
1428       headers_charset);
1429     if (s == NULL || *s == 0)
1430       {
1431       *newsize = 0;                            /* For the *s==0 case */
1432       s = find_header(US"from:", exists_only, newsize, FALSE, headers_charset);
1433       }
1434     return (s == NULL)? US"" : s;
1435
1436     /* A recipients list is available only during system message filtering,
1437     during ACL processing after DATA, and while expanding pipe commands
1438     generated from a system filter, but not elsewhere. */
1439
1440     case vtype_recipients:
1441     if (!enable_dollar_recipients) return NULL; else
1442       {
1443       int size = 128;
1444       int ptr = 0;
1445       int i;
1446       s = store_get(size);
1447       for (i = 0; i < recipients_count; i++)
1448         {
1449         if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1450         s = string_cat(s, &size, &ptr, recipients_list[i].address,
1451           Ustrlen(recipients_list[i].address));
1452         }
1453       s[ptr] = 0;     /* string_cat() leaves room */
1454       }
1455     return s;
1456
1457     case vtype_pspace:
1458       {
1459       int inodes;
1460       sprintf(CS var_buffer, "%d",
1461         receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes));
1462       }
1463     return var_buffer;
1464
1465     case vtype_pinodes:
1466       {
1467       int inodes;
1468       (void) receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes);
1469       sprintf(CS var_buffer, "%d", inodes);
1470       }
1471     return var_buffer;
1472     }
1473   }
1474
1475 return NULL;          /* Unknown variable name */
1476 }
1477
1478
1479
1480
1481 /*************************************************
1482 *           Read and expand substrings           *
1483 *************************************************/
1484
1485 /* This function is called to read and expand argument substrings for various
1486 expansion items. Some have a minimum requirement that is less than the maximum;
1487 in these cases, the first non-present one is set to NULL.
1488
1489 Arguments:
1490   sub        points to vector of pointers to set
1491   n          maximum number of substrings
1492   m          minimum required
1493   sptr       points to current string pointer
1494   skipping   the skipping flag
1495   check_end  if TRUE, check for final '}'
1496   name       name of item, for error message
1497
1498 Returns:     0 OK; string pointer updated
1499              1 curly bracketing error (too few arguments)
1500              2 too many arguments (only if check_end is set); message set
1501              3 other error (expansion failure)
1502 */
1503
1504 static int
1505 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1506   BOOL check_end, uschar *name)
1507 {
1508 int i;
1509 uschar *s = *sptr;
1510
1511 while (isspace(*s)) s++;
1512 for (i = 0; i < n; i++)
1513   {
1514   if (*s != '{')
1515     {
1516     if (i < m) return 1;
1517     sub[i] = NULL;
1518     break;
1519     }
1520   sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
1521   if (sub[i] == NULL) return 3;
1522   if (*s++ != '}') return 1;
1523   while (isspace(*s)) s++;
1524   }
1525 if (check_end && *s++ != '}')
1526   {
1527   if (s[-1] == '{')
1528     {
1529     expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1530       "(max is %d)", name, n);
1531     return 2;
1532     }
1533   return 1;
1534   }
1535
1536 *sptr = s;
1537 return 0;
1538 }
1539
1540
1541
1542
1543 /*************************************************
1544 *        Read and evaluate a condition           *
1545 *************************************************/
1546
1547 /*
1548 Arguments:
1549   s        points to the start of the condition text
1550   yield    points to a BOOL to hold the result of the condition test;
1551            if NULL, we are just reading through a condition that is
1552            part of an "or" combination to check syntax, or in a state
1553            where the answer isn't required
1554
1555 Returns:   a pointer to the first character after the condition, or
1556            NULL after an error
1557 */
1558
1559 static uschar *
1560 eval_condition(uschar *s, BOOL *yield)
1561 {
1562 BOOL testfor = TRUE;
1563 BOOL tempcond, combined_cond;
1564 BOOL *subcondptr;
1565 int i, rc, cond_type, roffset;
1566 int num[2];
1567 struct stat statbuf;
1568 uschar name[256];
1569 uschar *sub[4];
1570
1571 const pcre *re;
1572 const uschar *rerror;
1573
1574 for (;;)
1575   {
1576   while (isspace(*s)) s++;
1577   if (*s == '!') { testfor = !testfor; s++; } else break;
1578   }
1579
1580 /* Numeric comparisons are symbolic */
1581
1582 if (*s == '=' || *s == '>' || *s == '<')
1583   {
1584   int p = 0;
1585   name[p++] = *s++;
1586   if (*s == '=')
1587     {
1588     name[p++] = '=';
1589     s++;
1590     }
1591   name[p] = 0;
1592   }
1593
1594 /* All other conditions are named */
1595
1596 else s = read_name(name, 256, s, US"_");
1597
1598 /* If we haven't read a name, it means some non-alpha character is first. */
1599
1600 if (name[0] == 0)
1601   {
1602   expand_string_message = string_sprintf("condition name expected, "
1603     "but found \"%.16s\"", s);
1604   return NULL;
1605   }
1606
1607 /* Find which condition we are dealing with, and switch on it */
1608
1609 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
1610 switch(cond_type)
1611   {
1612   /* def: tests for a non-empty variable, or for the existence of a header. If
1613   yield == NULL we are in a skipping state, and don't care about the answer. */
1614
1615   case ECOND_DEF:
1616   if (*s != ':')
1617     {
1618     expand_string_message = US"\":\" expected after \"def\"";
1619     return NULL;
1620     }
1621
1622   s = read_name(name, 256, s+1, US"_");
1623
1624   /* Test for a header's existence */
1625
1626   if (Ustrncmp(name, "h_", 2) == 0 ||
1627       Ustrncmp(name, "rh_", 3) == 0 ||
1628       Ustrncmp(name, "bh_", 3) == 0 ||
1629       Ustrncmp(name, "header_", 7) == 0 ||
1630       Ustrncmp(name, "rheader_", 8) == 0 ||
1631       Ustrncmp(name, "bheader_", 8) == 0)
1632     {
1633     s = read_header_name(name, 256, s);
1634     if (yield != NULL) *yield =
1635       (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
1636     }
1637
1638   /* Test for a variable's having a non-empty value. A non-existent variable
1639   causes an expansion failure. */
1640
1641   else
1642     {
1643     uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
1644     if (value == NULL)
1645       {
1646       expand_string_message = (name[0] == 0)?
1647         string_sprintf("variable name omitted after \"def:\"") :
1648         string_sprintf("unknown variable \"%s\" after \"def:\"", name);
1649       return NULL;
1650       }
1651     if (yield != NULL) *yield = (value[0] != 0) == testfor;
1652     }
1653
1654   return s;
1655
1656
1657   /* first_delivery tests for first delivery attempt */
1658
1659   case ECOND_FIRST_DELIVERY:
1660   if (yield != NULL) *yield = deliver_firsttime == testfor;
1661   return s;
1662
1663
1664   /* queue_running tests for any process started by a queue runner */
1665
1666   case ECOND_QUEUE_RUNNING:
1667   if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
1668   return s;
1669
1670
1671   /* exists:  tests for file existence
1672        isip:  tests for any IP address
1673       isip4:  tests for an IPv4 address
1674       isip6:  tests for an IPv6 address
1675         pam:  does PAM authentication
1676      radius:  does RADIUS authentication
1677    ldapauth:  does LDAP authentication
1678     pwcheck:  does Cyrus SASL pwcheck authentication
1679   */
1680
1681   case ECOND_EXISTS:
1682   case ECOND_ISIP:
1683   case ECOND_ISIP4:
1684   case ECOND_ISIP6:
1685   case ECOND_PAM:
1686   case ECOND_RADIUS:
1687   case ECOND_LDAPAUTH:
1688   case ECOND_PWCHECK:
1689
1690   while (isspace(*s)) s++;
1691   if (*s != '{') goto COND_FAILED_CURLY_START;
1692
1693   sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1694   if (sub[0] == NULL) return NULL;
1695   if (*s++ != '}') goto COND_FAILED_CURLY_END;
1696
1697   if (yield == NULL) return s;   /* No need to run the test if skipping */
1698
1699   switch(cond_type)
1700     {
1701     case ECOND_EXISTS:
1702     if ((expand_forbid & RDO_EXISTS) != 0)
1703       {
1704       expand_string_message = US"File existence tests are not permitted";
1705       return NULL;
1706       }
1707     *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
1708     break;
1709
1710     case ECOND_ISIP:
1711     case ECOND_ISIP4:
1712     case ECOND_ISIP6:
1713     rc = string_is_ip_address(sub[0], NULL);
1714     *yield = ((cond_type == ECOND_ISIP)? (rc > 0) :
1715              (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
1716     break;
1717
1718     /* Various authentication tests - all optionally compiled */
1719
1720     case ECOND_PAM:
1721     #ifdef SUPPORT_PAM
1722     rc = auth_call_pam(sub[0], &expand_string_message);
1723     goto END_AUTH;
1724     #else
1725     goto COND_FAILED_NOT_COMPILED;
1726     #endif  /* SUPPORT_PAM */
1727
1728     case ECOND_RADIUS:
1729     #ifdef RADIUS_CONFIG_FILE
1730     rc = auth_call_radius(sub[0], &expand_string_message);
1731     goto END_AUTH;
1732     #else
1733     goto COND_FAILED_NOT_COMPILED;
1734     #endif  /* RADIUS_CONFIG_FILE */
1735
1736     case ECOND_LDAPAUTH:
1737     #ifdef LOOKUP_LDAP
1738       {
1739       /* Just to keep the interface the same */
1740       BOOL do_cache;
1741       int old_pool = store_pool;
1742       store_pool = POOL_SEARCH;
1743       rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
1744         &expand_string_message, &do_cache);
1745       store_pool = old_pool;
1746       }
1747     goto END_AUTH;
1748     #else
1749     goto COND_FAILED_NOT_COMPILED;
1750     #endif  /* LOOKUP_LDAP */
1751
1752     case ECOND_PWCHECK:
1753     #ifdef CYRUS_PWCHECK_SOCKET
1754     rc = auth_call_pwcheck(sub[0], &expand_string_message);
1755     goto END_AUTH;
1756     #else
1757     goto COND_FAILED_NOT_COMPILED;
1758     #endif  /* CYRUS_PWCHECK_SOCKET */
1759
1760     #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
1761         defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
1762     END_AUTH:
1763     if (rc == ERROR || rc == DEFER) return NULL;
1764     *yield = (rc == OK) == testfor;
1765     #endif
1766     }
1767   return s;
1768
1769
1770   /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
1771
1772      ${if saslauthd {{username}{password}{service}{realm}}  {yes}[no}}
1773
1774   However, the last two are optional. That is why the whole set is enclosed
1775   in their own set or braces. */
1776
1777   case ECOND_SASLAUTHD:
1778   #ifndef CYRUS_SASLAUTHD_SOCKET
1779   goto COND_FAILED_NOT_COMPILED;
1780   #else
1781   while (isspace(*s)) s++;
1782   if (*s++ != '{') goto COND_FAILED_CURLY_START;
1783   switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd"))
1784     {
1785     case 1: expand_string_message = US"too few arguments or bracketing "
1786       "error for saslauthd";
1787     case 2:
1788     case 3: return NULL;
1789     }
1790   if (sub[2] == NULL) sub[3] = NULL;  /* realm if no service */
1791   if (yield != NULL)
1792     {
1793     int rc;
1794     rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
1795       &expand_string_message);
1796     if (rc == ERROR || rc == DEFER) return NULL;
1797     *yield = (rc == OK) == testfor;
1798     }
1799   return s;
1800   #endif /* CYRUS_SASLAUTHD_SOCKET */
1801
1802
1803   /* symbolic operators for numeric and string comparison, and a number of
1804   other operators, all requiring two arguments.
1805
1806   match:             does a regular expression match and sets up the numerical
1807                        variables if it succeeds
1808   match_address:     matches in an address list
1809   match_domain:      matches in a domain list
1810   match_ip:          matches a host list that is restricted to IP addresses
1811   match_local_part:  matches in a local part list
1812   crypteq:           encrypts plaintext and compares against an encrypted text,
1813                        using crypt(), crypt16(), MD5 or SHA-1
1814   */
1815
1816   case ECOND_MATCH:
1817   case ECOND_MATCH_ADDRESS:
1818   case ECOND_MATCH_DOMAIN:
1819   case ECOND_MATCH_IP:
1820   case ECOND_MATCH_LOCAL_PART:
1821   case ECOND_CRYPTEQ:
1822
1823   case ECOND_NUM_L:     /* Numerical comparisons */
1824   case ECOND_NUM_LE:
1825   case ECOND_NUM_E:
1826   case ECOND_NUM_EE:
1827   case ECOND_NUM_G:
1828   case ECOND_NUM_GE:
1829
1830   case ECOND_STR_LT:    /* String comparisons */
1831   case ECOND_STR_LTI:
1832   case ECOND_STR_LE:
1833   case ECOND_STR_LEI:
1834   case ECOND_STR_EQ:
1835   case ECOND_STR_EQI:
1836   case ECOND_STR_GT:
1837   case ECOND_STR_GTI:
1838   case ECOND_STR_GE:
1839   case ECOND_STR_GEI:
1840
1841   for (i = 0; i < 2; i++)
1842     {
1843     while (isspace(*s)) s++;
1844     if (*s != '{')
1845       {
1846       if (i == 0) goto COND_FAILED_CURLY_START;
1847       expand_string_message = string_sprintf("missing 2nd string in {} "
1848         "after \"%s\"", name);
1849       return NULL;
1850       }
1851     sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1852     if (sub[i] == NULL) return NULL;
1853     if (*s++ != '}') goto COND_FAILED_CURLY_END;
1854
1855     /* Convert to numerical if required; we know that the names of all the
1856     conditions that compare numbers do not start with a letter. This just saves
1857     checking for them individually. */
1858
1859     if (!isalpha(name[0]))
1860       {
1861       uschar *endptr;
1862       num[i] = (int)Ustrtol((const uschar *)sub[i], &endptr, 10);
1863       if (tolower(*endptr) == 'k')
1864         {
1865         num[i] *= 1024;
1866         endptr++;
1867         }
1868       else if (tolower(*endptr) == 'm')
1869         {
1870         num[i] *= 1024*1024;
1871         endptr++;
1872         }
1873       while (isspace(*endptr)) endptr++;
1874       if (*endptr != 0)
1875         {
1876         expand_string_message = string_sprintf("\"%s\" is not a number",
1877           sub[i]);
1878         return NULL;
1879         }
1880       }
1881     }
1882
1883   /* Result not required */
1884
1885   if (yield == NULL) return s;
1886
1887   /* Do an appropriate comparison */
1888
1889   switch(cond_type)
1890     {
1891     case ECOND_NUM_E:
1892     case ECOND_NUM_EE:
1893     *yield = (num[0] == num[1]) == testfor;
1894     break;
1895
1896     case ECOND_NUM_G:
1897     *yield = (num[0] > num[1]) == testfor;
1898     break;
1899
1900     case ECOND_NUM_GE:
1901     *yield = (num[0] >= num[1]) == testfor;
1902     break;
1903
1904     case ECOND_NUM_L:
1905     *yield = (num[0] < num[1]) == testfor;
1906     break;
1907
1908     case ECOND_NUM_LE:
1909     *yield = (num[0] <= num[1]) == testfor;
1910     break;
1911
1912     case ECOND_STR_LT:
1913     *yield = (Ustrcmp(sub[0], sub[1]) < 0) == testfor;
1914     break;
1915
1916     case ECOND_STR_LTI:
1917     *yield = (strcmpic(sub[0], sub[1]) < 0) == testfor;
1918     break;
1919
1920     case ECOND_STR_LE:
1921     *yield = (Ustrcmp(sub[0], sub[1]) <= 0) == testfor;
1922     break;
1923
1924     case ECOND_STR_LEI:
1925     *yield = (strcmpic(sub[0], sub[1]) <= 0) == testfor;
1926     break;
1927
1928     case ECOND_STR_EQ:
1929     *yield = (Ustrcmp(sub[0], sub[1]) == 0) == testfor;
1930     break;
1931
1932     case ECOND_STR_EQI:
1933     *yield = (strcmpic(sub[0], sub[1]) == 0) == testfor;
1934     break;
1935
1936     case ECOND_STR_GT:
1937     *yield = (Ustrcmp(sub[0], sub[1]) > 0) == testfor;
1938     break;
1939
1940     case ECOND_STR_GTI:
1941     *yield = (strcmpic(sub[0], sub[1]) > 0) == testfor;
1942     break;
1943
1944     case ECOND_STR_GE:
1945     *yield = (Ustrcmp(sub[0], sub[1]) >= 0) == testfor;
1946     break;
1947
1948     case ECOND_STR_GEI:
1949     *yield = (strcmpic(sub[0], sub[1]) >= 0) == testfor;
1950     break;
1951
1952     case ECOND_MATCH:   /* Regular expression match */
1953     re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
1954       NULL);
1955     if (re == NULL)
1956       {
1957       expand_string_message = string_sprintf("regular expression error in "
1958         "\"%s\": %s at offset %d", sub[1], rerror, roffset);
1959       return NULL;
1960       }
1961     *yield = regex_match_and_setup(re, sub[0], 0, -1) == testfor;
1962     break;
1963
1964     case ECOND_MATCH_ADDRESS:  /* Match in an address list */
1965     rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
1966     goto MATCHED_SOMETHING;
1967
1968     case ECOND_MATCH_DOMAIN:   /* Match in a domain list */
1969     rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
1970       MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
1971     goto MATCHED_SOMETHING;
1972
1973     case ECOND_MATCH_IP:       /* Match IP address in a host list */
1974     if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) <= 0)
1975       {
1976       expand_string_message = string_sprintf("\"%s\" is not an IP address",
1977         sub[0]);
1978       return NULL;
1979       }
1980     else
1981       {
1982       unsigned int *nullcache = NULL;
1983       check_host_block cb;
1984
1985       cb.host_name = US"";
1986       cb.host_address = sub[0];
1987
1988       /* If the host address starts off ::ffff: it is an IPv6 address in
1989       IPv4-compatible mode. Find the IPv4 part for checking against IPv4
1990       addresses. */
1991
1992       cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
1993         cb.host_address + 7 : cb.host_address;
1994
1995       rc = match_check_list(
1996              &sub[1],                   /* the list */
1997              0,                         /* separator character */
1998              &hostlist_anchor,          /* anchor pointer */
1999              &nullcache,                /* cache pointer */
2000              check_host,                /* function for testing */
2001              &cb,                       /* argument for function */
2002              MCL_HOST,                  /* type of check */
2003              sub[0],                    /* text for debugging */
2004              NULL);                     /* where to pass back data */
2005       }
2006     goto MATCHED_SOMETHING;
2007
2008     case ECOND_MATCH_LOCAL_PART:
2009     rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2010       MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2011     /* Fall through */
2012     /* VVVVVVVVVVVV */
2013     MATCHED_SOMETHING:
2014     switch(rc)
2015       {
2016       case OK:
2017       *yield = testfor;
2018       break;
2019
2020       case FAIL:
2021       *yield = !testfor;
2022       break;
2023
2024       case DEFER:
2025       expand_string_message = string_sprintf("unable to complete match "
2026         "against \"%s\": %s", sub[1], search_error_message);
2027       return NULL;
2028       }
2029
2030     break;
2031
2032     /* Various "encrypted" comparisons. If the second string starts with
2033     "{" then an encryption type is given. Default to crypt() or crypt16()
2034     (build-time choice). */
2035
2036     case ECOND_CRYPTEQ:
2037     #ifndef SUPPORT_CRYPTEQ
2038     goto COND_FAILED_NOT_COMPILED;
2039     #else
2040     if (strncmpic(sub[1], US"{md5}", 5) == 0)
2041       {
2042       int sublen = Ustrlen(sub[1]+5);
2043       md5 base;
2044       uschar digest[16];
2045
2046       md5_start(&base);
2047       md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2048
2049       /* If the length that we are comparing against is 24, the MD5 digest
2050       is expressed as a base64 string. This is the way LDAP does it. However,
2051       some other software uses a straightforward hex representation. We assume
2052       this if the length is 32. Other lengths fail. */
2053
2054       if (sublen == 24)
2055         {
2056         uschar *coded = auth_b64encode((uschar *)digest, 16);
2057         DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2058           "  subject=%s\n  crypted=%s\n", coded, sub[1]+5);
2059         *yield = (Ustrcmp(coded, sub[1]+5) == 0) == testfor;
2060         }
2061       else if (sublen == 32)
2062         {
2063         int i;
2064         uschar coded[36];
2065         for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2066         coded[32] = 0;
2067         DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2068           "  subject=%s\n  crypted=%s\n", coded, sub[1]+5);
2069         *yield = (strcmpic(coded, sub[1]+5) == 0) == testfor;
2070         }
2071       else
2072         {
2073         DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2074           "fail\n  crypted=%s\n", sub[1]+5);
2075         *yield = !testfor;
2076         }
2077       }
2078
2079     else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2080       {
2081       int sublen = Ustrlen(sub[1]+6);
2082       sha1 base;
2083       uschar digest[20];
2084
2085       sha1_start(&base);
2086       sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2087
2088       /* If the length that we are comparing against is 28, assume the SHA1
2089       digest is expressed as a base64 string. If the length is 40, assume a
2090       straightforward hex representation. Other lengths fail. */
2091
2092       if (sublen == 28)
2093         {
2094         uschar *coded = auth_b64encode((uschar *)digest, 20);
2095         DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2096           "  subject=%s\n  crypted=%s\n", coded, sub[1]+6);
2097         *yield = (Ustrcmp(coded, sub[1]+6) == 0) == testfor;
2098         }
2099       else if (sublen == 40)
2100         {
2101         int i;
2102         uschar coded[44];
2103         for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2104         coded[40] = 0;
2105         DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2106           "  subject=%s\n  crypted=%s\n", coded, sub[1]+6);
2107         *yield = (strcmpic(coded, sub[1]+6) == 0) == testfor;
2108         }
2109       else
2110         {
2111         DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2112           "fail\n  crypted=%s\n", sub[1]+6);
2113         *yield = !testfor;
2114         }
2115       }
2116
2117     else   /* {crypt} or {crypt16} and non-{ at start */
2118       {
2119       int which = 0;
2120       uschar *coded;
2121
2122       if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2123         {
2124         sub[1] += 7;
2125         which = 1;
2126         }
2127       else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2128         {
2129         sub[1] += 9;
2130         which = 2;
2131         }
2132       else if (sub[1][0] == '{')
2133         {
2134         expand_string_message = string_sprintf("unknown encryption mechanism "
2135           "in \"%s\"", sub[1]);
2136         return NULL;
2137         }
2138
2139       switch(which)
2140         {
2141         case 0:  coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2142         case 1:  coded = US crypt(CS sub[0], CS sub[1]); break;
2143         default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2144         }
2145
2146       #define STR(s) # s
2147       #define XSTR(s) STR(s)
2148       DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2149         "  subject=%s\n  crypted=%s\n",
2150         (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2151         coded, sub[1]);
2152       #undef STR
2153       #undef XSTR
2154
2155       /* If the encrypted string contains fewer than two characters (for the
2156       salt), force failure. Otherwise we get false positives: with an empty
2157       string the yield of crypt() is an empty string! */
2158
2159       *yield = (Ustrlen(sub[1]) < 2)? !testfor :
2160         (Ustrcmp(coded, sub[1]) == 0) == testfor;
2161       }
2162     break;
2163     #endif  /* SUPPORT_CRYPTEQ */
2164     }   /* Switch for comparison conditions */
2165
2166   return s;    /* End of comparison conditions */
2167
2168
2169   /* and/or: computes logical and/or of several conditions */
2170
2171   case ECOND_AND:
2172   case ECOND_OR:
2173   subcondptr = (yield == NULL)? NULL : &tempcond;
2174   combined_cond = (cond_type == ECOND_AND);
2175
2176   while (isspace(*s)) s++;
2177   if (*s++ != '{') goto COND_FAILED_CURLY_START;
2178
2179   for (;;)
2180     {
2181     while (isspace(*s)) s++;
2182     if (*s == '}') break;
2183     if (*s != '{')
2184       {
2185       expand_string_message = string_sprintf("each subcondition "
2186         "inside an \"%s{...}\" condition must be in its own {}", name);
2187       return NULL;
2188       }
2189
2190     s = eval_condition(s+1, subcondptr);
2191     if (s == NULL)
2192       {
2193       expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2194         expand_string_message, name);
2195       return NULL;
2196       }
2197     while (isspace(*s)) s++;
2198
2199     if (*s++ != '}')
2200       {
2201       expand_string_message = string_sprintf("missing } at end of condition "
2202         "inside \"%s\" group", name);
2203       return NULL;
2204       }
2205
2206     if (yield != NULL)
2207       {
2208       if (cond_type == ECOND_AND)
2209         {
2210         combined_cond &= tempcond;
2211         if (!combined_cond) subcondptr = NULL;  /* once false, don't */
2212         }                                       /* evaluate any more */
2213       else
2214         {
2215         combined_cond |= tempcond;
2216         if (combined_cond) subcondptr = NULL;   /* once true, don't */
2217         }                                       /* evaluate any more */
2218       }
2219     }
2220
2221   if (yield != NULL) *yield = (combined_cond == testfor);
2222   return ++s;
2223
2224
2225   /* Unknown condition */
2226
2227   default:
2228   expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2229   return NULL;
2230   }   /* End switch on condition type */
2231
2232 /* Missing braces at start and end of data */
2233
2234 COND_FAILED_CURLY_START:
2235 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2236 return NULL;
2237
2238 COND_FAILED_CURLY_END:
2239 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2240   name);
2241 return NULL;
2242
2243 /* A condition requires code that is not compiled */
2244
2245 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2246     !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2247     !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2248 COND_FAILED_NOT_COMPILED:
2249 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2250   name);
2251 return NULL;
2252 #endif
2253 }
2254
2255
2256
2257
2258 /*************************************************
2259 *          Save numerical variables              *
2260 *************************************************/
2261
2262 /* This function is called from items such as "if" that want to preserve and
2263 restore the numbered variables.
2264
2265 Arguments:
2266   save_expand_string    points to an array of pointers to set
2267   save_expand_nlength   points to an array of ints for the lengths
2268
2269 Returns:                the value of expand max to save
2270 */
2271
2272 static int
2273 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2274 {
2275 int i;
2276 for (i = 0; i <= expand_nmax; i++)
2277   {
2278   save_expand_nstring[i] = expand_nstring[i];
2279   save_expand_nlength[i] = expand_nlength[i];
2280   }
2281 return expand_nmax;
2282 }
2283
2284
2285
2286 /*************************************************
2287 *           Restore numerical variables          *
2288 *************************************************/
2289
2290 /* This function restored saved values of numerical strings.
2291
2292 Arguments:
2293   save_expand_nmax      the number of strings to restore
2294   save_expand_string    points to an array of pointers
2295   save_expand_nlength   points to an array of ints
2296
2297 Returns:                nothing
2298 */
2299
2300 static void
2301 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2302   int *save_expand_nlength)
2303 {
2304 int i;
2305 expand_nmax = save_expand_nmax;
2306 for (i = 0; i <= expand_nmax; i++)
2307   {
2308   expand_nstring[i] = save_expand_nstring[i];
2309   expand_nlength[i] = save_expand_nlength[i];
2310   }
2311 }
2312
2313
2314
2315
2316
2317 /*************************************************
2318 *            Handle yes/no substrings            *
2319 *************************************************/
2320
2321 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2322 alternative substrings that depend on whether or not the condition was true,
2323 or the lookup or extraction succeeded. The substrings always have to be
2324 expanded, to check their syntax, but "skipping" is set when the result is not
2325 needed - this avoids unnecessary nested lookups.
2326
2327 Arguments:
2328   skipping       TRUE if we were skipping when this item was reached
2329   yes            TRUE if the first string is to be used, else use the second
2330   save_lookup    a value to put back into lookup_value before the 2nd expansion
2331   sptr           points to the input string pointer
2332   yieldptr       points to the output string pointer
2333   sizeptr        points to the output string size
2334   ptrptr         points to the output string pointer
2335   type           "lookup" or "if" or "extract" or "run", for error message
2336
2337 Returns:         0 OK; lookup_value has been reset to save_lookup
2338                  1 expansion failed
2339                  2 expansion failed because of bracketing error
2340 */
2341
2342 static int
2343 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2344   uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type)
2345 {
2346 int rc = 0;
2347 uschar *s = *sptr;    /* Local value */
2348 uschar *sub1, *sub2;
2349
2350 /* If there are no following strings, we substitute the contents of $value for
2351 lookups and for extractions in the success case. For the ${if item, the string
2352 "true" is substituted. In the fail case, nothing is substituted for all three
2353 items. */
2354
2355 while (isspace(*s)) s++;
2356 if (*s == '}')
2357   {
2358   if (type[0] == 'i')
2359     {
2360     if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
2361     }
2362   else
2363     {
2364     if (yes && lookup_value != NULL)
2365       *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
2366         Ustrlen(lookup_value));
2367     lookup_value = save_lookup;
2368     }
2369   s++;
2370   goto RETURN;
2371   }
2372
2373 /* The first following string must be braced. */
2374
2375 if (*s++ != '{') goto FAILED_CURLY;
2376
2377 /* Expand the first substring. Forced failures are noticed only if we actually
2378 want this string. Set skipping in the call in the fail case (this will always
2379 be the case if we were already skipping). */
2380
2381 sub1 = expand_string_internal(s, TRUE, &s, !yes);
2382 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
2383 expand_string_forcedfail = FALSE;
2384 if (*s++ != '}') goto FAILED_CURLY;
2385
2386 /* If we want the first string, add it to the output */
2387
2388 if (yes)
2389   *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
2390
2391 /* If this is called from a lookup or an extract, we want to restore $value to
2392 what it was at the start of the item, so that it has this value during the
2393 second string expansion. For the call from "if" or "run" to this function,
2394 save_lookup is set to lookup_value, so that this statement does nothing. */
2395
2396 lookup_value = save_lookup;
2397
2398 /* There now follows either another substring, or "fail", or nothing. This
2399 time, forced failures are noticed only if we want the second string. We must
2400 set skipping in the nested call if we don't want this string, or if we were
2401 already skipping. */
2402
2403 while (isspace(*s)) s++;
2404 if (*s == '{')
2405   {
2406   sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping);
2407   if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
2408   expand_string_forcedfail = FALSE;
2409   if (*s++ != '}') goto FAILED_CURLY;
2410
2411   /* If we want the second string, add it to the output */
2412
2413   if (!yes)
2414     *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
2415   }
2416
2417 /* If there is no second string, but the word "fail" is present when the use of
2418 the second string is wanted, set a flag indicating it was a forced failure
2419 rather than a syntactic error. Swallow the terminating } in case this is nested
2420 inside another lookup or if or extract. */
2421
2422 else if (*s != '}')
2423   {
2424   uschar name[256];
2425   s = read_name(name, sizeof(name), s, US"_");
2426   if (Ustrcmp(name, "fail") == 0)
2427     {
2428     if (!yes && !skipping)
2429       {
2430       while (isspace(*s)) s++;
2431       if (*s++ != '}') goto FAILED_CURLY;
2432       expand_string_message =
2433         string_sprintf("\"%s\" failed and \"fail\" requested", type);
2434       expand_string_forcedfail = TRUE;
2435       goto FAILED;
2436       }
2437     }
2438   else
2439     {
2440     expand_string_message =
2441       string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
2442     goto FAILED;
2443     }
2444   }
2445
2446 /* All we have to do now is to check on the final closing brace. */
2447
2448 while (isspace(*s)) s++;
2449 if (*s++ == '}') goto RETURN;
2450
2451 /* Get here if there is a bracketing failure */
2452
2453 FAILED_CURLY:
2454 rc++;
2455
2456 /* Get here for other failures */
2457
2458 FAILED:
2459 rc++;
2460
2461 /* Update the input pointer value before returning */
2462
2463 RETURN:
2464 *sptr = s;
2465 return rc;
2466 }
2467
2468
2469
2470
2471 /*************************************************
2472 *    Handle MD5 or SHA-1 computation for HMAC    *
2473 *************************************************/
2474
2475 /* These are some wrapping functions that enable the HMAC code to be a bit
2476 cleaner. A good compiler will spot the tail recursion.
2477
2478 Arguments:
2479   type         HMAC_MD5 or HMAC_SHA1
2480   remaining    are as for the cryptographic hash functions
2481
2482 Returns:       nothing
2483 */
2484
2485 static void
2486 chash_start(int type, void *base)
2487 {
2488 if (type == HMAC_MD5)
2489   md5_start((md5 *)base);
2490 else
2491   sha1_start((sha1 *)base);
2492 }
2493
2494 static void
2495 chash_mid(int type, void *base, uschar *string)
2496 {
2497 if (type == HMAC_MD5)
2498   md5_mid((md5 *)base, string);
2499 else
2500   sha1_mid((sha1 *)base, string);
2501 }
2502
2503 static void
2504 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
2505 {
2506 if (type == HMAC_MD5)
2507   md5_end((md5 *)base, string, length, digest);
2508 else
2509   sha1_end((sha1 *)base, string, length, digest);
2510 }
2511
2512
2513
2514
2515
2516 /********************************************************
2517 * prvs: Get last three digits of days since Jan 1, 1970 *
2518 ********************************************************/
2519
2520 /* This is needed to implement the "prvs" BATV reverse
2521    path signing scheme
2522
2523 Argument: integer "days" offset to add or substract to
2524           or from the current number of days.
2525
2526 Returns:  pointer to string containing the last three
2527           digits of the number of days since Jan 1, 1970,
2528           modified by the offset argument, NULL if there
2529           was an error in the conversion.
2530
2531 */
2532
2533 static uschar *
2534 prvs_daystamp(int day_offset)
2535 {
2536 uschar *days = store_get(16);
2537 (void)string_format(days, 16, TIME_T_FMT,
2538   (time(NULL) + day_offset*86400)/86400);
2539 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
2540 }
2541
2542
2543
2544 /********************************************************
2545 *   prvs: perform HMAC-SHA1 computation of prvs bits    *
2546 ********************************************************/
2547
2548 /* This is needed to implement the "prvs" BATV reverse
2549    path signing scheme
2550
2551 Arguments:
2552   address RFC2821 Address to use
2553       key The key to use (must be less than 64 characters
2554           in size)
2555   key_num Single-digit key number to use. Defaults to
2556           '0' when NULL.
2557
2558 Returns:  pointer to string containing the first three
2559           bytes of the final hash in hex format, NULL if
2560           there was an error in the process.
2561 */
2562
2563 static uschar *
2564 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
2565 {
2566 uschar *hash_source, *p;
2567 int size = 0,offset = 0,i;
2568 sha1 sha1_base;
2569 void *use_base = &sha1_base;
2570 uschar innerhash[20];
2571 uschar finalhash[20];
2572 uschar innerkey[64];
2573 uschar outerkey[64];
2574 uschar *finalhash_hex = store_get(40);
2575
2576 if (key_num == NULL)
2577   key_num = US"0";
2578
2579 if (Ustrlen(key) > 64)
2580   return NULL;
2581
2582 hash_source = string_cat(NULL,&size,&offset,key_num,1);
2583 string_cat(hash_source,&size,&offset,daystamp,3);
2584 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
2585 hash_source[offset] = '\0';
2586
2587 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
2588
2589 memset(innerkey, 0x36, 64);
2590 memset(outerkey, 0x5c, 64);
2591
2592 for (i = 0; i < Ustrlen(key); i++)
2593   {
2594   innerkey[i] ^= key[i];
2595   outerkey[i] ^= key[i];
2596   }
2597
2598 chash_start(HMAC_SHA1, use_base);
2599 chash_mid(HMAC_SHA1, use_base, innerkey);
2600 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
2601
2602 chash_start(HMAC_SHA1, use_base);
2603 chash_mid(HMAC_SHA1, use_base, outerkey);
2604 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
2605
2606 p = finalhash_hex;
2607 for (i = 0; i < 3; i++)
2608   {
2609   *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
2610   *p++ = hex_digits[finalhash[i] & 0x0f];
2611   }
2612 *p = '\0';
2613
2614 return finalhash_hex;
2615 }
2616
2617
2618
2619
2620 /*************************************************
2621 *        Join a file onto the output string      *
2622 *************************************************/
2623
2624 /* This is used for readfile and after a run expansion. It joins the contents
2625 of a file onto the output string, globally replacing newlines with a given
2626 string (optionally). The file is closed at the end.
2627
2628 Arguments:
2629   f            the FILE
2630   yield        pointer to the expandable string
2631   sizep        pointer to the current size
2632   ptrp         pointer to the current position
2633   eol          newline replacement string, or NULL
2634
2635 Returns:       new value of string pointer
2636 */
2637
2638 static uschar *
2639 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
2640 {
2641 int eollen;
2642 uschar buffer[1024];
2643
2644 eollen = (eol == NULL)? 0 : Ustrlen(eol);
2645
2646 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
2647   {
2648   int len = Ustrlen(buffer);
2649   if (eol != NULL && buffer[len-1] == '\n') len--;
2650   yield = string_cat(yield, sizep, ptrp, buffer, len);
2651   if (buffer[len] != 0)
2652     yield = string_cat(yield, sizep, ptrp, eol, eollen);
2653   }
2654
2655 if (yield != NULL) yield[*ptrp] = 0;
2656
2657 return yield;
2658 }
2659
2660
2661
2662
2663 /*************************************************
2664 *          Evaluate numeric expression           *
2665 *************************************************/
2666
2667 /* This is a set of mutually recursive functions that evaluate a simple
2668 arithmetic expression involving only + - * / and parentheses. The only one that
2669 is called from elsewhere is eval_expr, whose interface is:
2670
2671 Arguments:
2672   sptr          pointer to the pointer to the string - gets updated
2673   decimal       TRUE if numbers are to be assumed decimal
2674   error         pointer to where to put an error message - must be NULL on input
2675   endket        TRUE if ')' must terminate - FALSE for external call
2676
2677
2678 Returns:        on success: the value of the expression, with *error still NULL
2679                 on failure: an undefined value, with *error = a message
2680 */
2681
2682 static int eval_sumterm(uschar **, BOOL, uschar **);
2683
2684 static int
2685 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
2686 {
2687 uschar *s = *sptr;
2688 int x = eval_sumterm(&s, decimal, error);
2689 if (*error == NULL)
2690   {
2691   while (*s == '+' || *s == '-')
2692     {
2693     int op = *s++;
2694     int y = eval_sumterm(&s, decimal, error);
2695     if (*error != NULL) break;
2696     if (op == '+') x += y; else x -= y;
2697     }
2698   if (*error == NULL)
2699     {
2700     if (endket)
2701       {
2702       if (*s != ')')
2703         *error = US"expecting closing parenthesis";
2704       else
2705         while (isspace(*(++s)));
2706       }
2707     else if (*s != 0) *error = US"expecting + or -";
2708     }
2709   }
2710
2711 *sptr = s;
2712 return x;
2713 }
2714
2715 static int
2716 eval_term(uschar **sptr, BOOL decimal, uschar **error)
2717 {
2718 register int c;
2719 int n;
2720 uschar *s = *sptr;
2721 while (isspace(*s)) s++;
2722 c = *s;
2723 if (isdigit(c) || ((c == '-' || c == '+') && isdigit(s[1])))
2724   {
2725   int count;
2726   (void)sscanf(CS s, (decimal? "%d%n" : "%i%n"), &n, &count);
2727   s += count;
2728   if (tolower(*s) == 'k') { n *= 1024; s++; }
2729     else if (tolower(*s) == 'm') { n *= 1024*1024; s++; }
2730   while (isspace (*s)) s++;
2731   }
2732 else if (c == '(')
2733   {
2734   s++;
2735   n = eval_expr(&s, decimal, error, 1);
2736   }
2737 else
2738   {
2739   *error = US"expecting number or opening parenthesis";
2740   n = 0;
2741   }
2742 *sptr = s;
2743 return n;
2744 }
2745
2746 static int eval_sumterm(uschar **sptr, BOOL decimal, uschar **error)
2747 {
2748 uschar *s = *sptr;
2749 int x = eval_term(&s, decimal, error);
2750 if (*error == NULL)
2751   {
2752   while (*s == '*' || *s == '/' || *s == '%')
2753     {
2754     int op = *s++;
2755     int y = eval_term(&s, decimal, error);
2756     if (*error != NULL) break;
2757     if (op == '*') x *= y;
2758       else if (op == '/') x /= y;
2759       else x %= y;
2760     }
2761   }
2762 *sptr = s;
2763 return x;
2764 }
2765
2766
2767
2768
2769 /*************************************************
2770 *                 Expand string                  *
2771 *************************************************/
2772
2773 /* Returns either an unchanged string, or the expanded string in stacking pool
2774 store. Interpreted sequences are:
2775
2776    \...                    normal escaping rules
2777    $name                   substitutes the variable
2778    ${name}                 ditto
2779    ${op:string}            operates on the expanded string value
2780    ${item{arg1}{arg2}...}  expands the args and then does the business
2781                              some literal args are not enclosed in {}
2782
2783 There are now far too many operators and item types to make it worth listing
2784 them here in detail any more.
2785
2786 We use an internal routine recursively to handle embedded substrings. The
2787 external function follows. The yield is NULL if the expansion failed, and there
2788 are two cases: if something collapsed syntactically, or if "fail" was given
2789 as the action on a lookup failure. These can be distinguised by looking at the
2790 variable expand_string_forcedfail, which is TRUE in the latter case.
2791
2792 The skipping flag is set true when expanding a substring that isn't actually
2793 going to be used (after "if" or "lookup") and it prevents lookups from
2794 happening lower down.
2795
2796 Store usage: At start, a store block of the length of the input plus 64
2797 is obtained. This is expanded as necessary by string_cat(), which might have to
2798 get a new block, or might be able to expand the original. At the end of the
2799 function we can release any store above that portion of the yield block that
2800 was actually used. In many cases this will be optimal.
2801
2802 However: if the first item in the expansion is a variable name or header name,
2803 we reset the store before processing it; if the result is in fresh store, we
2804 use that without copying. This is helpful for expanding strings like
2805 $message_headers which can get very long.
2806
2807 Arguments:
2808   string         the string to be expanded
2809   ket_ends       true if expansion is to stop at }
2810   left           if not NULL, a pointer to the first character after the
2811                  expansion is placed here (typically used with ket_ends)
2812   skipping       TRUE for recursive calls when the value isn't actually going
2813                  to be used (to allow for optimisation)
2814
2815 Returns:         NULL if expansion fails:
2816                    expand_string_forcedfail is set TRUE if failure was forced
2817                    expand_string_message contains a textual error message
2818                  a pointer to the expanded string on success
2819 */
2820
2821 static uschar *
2822 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
2823   BOOL skipping)
2824 {
2825 int ptr = 0;
2826 int size = Ustrlen(string)+ 64;
2827 int item_type;
2828 uschar *yield = store_get(size);
2829 uschar *s = string;
2830 uschar *save_expand_nstring[EXPAND_MAXN+1];
2831 int save_expand_nlength[EXPAND_MAXN+1];
2832
2833 expand_string_forcedfail = FALSE;
2834 expand_string_message = US"";
2835
2836 while (*s != 0)
2837   {
2838   uschar *value;
2839   uschar name[256];
2840
2841   /* \ escapes the next character, which must exist, or else
2842   the expansion fails. There's a special escape, \N, which causes
2843   copying of the subject verbatim up to the next \N. Otherwise,
2844   the escapes are the standard set. */
2845
2846   if (*s == '\\')
2847     {
2848     if (s[1] == 0)
2849       {
2850       expand_string_message = US"\\ at end of string";
2851       goto EXPAND_FAILED;
2852       }
2853
2854     if (s[1] == 'N')
2855       {
2856       uschar *t = s + 2;
2857       for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
2858       yield = string_cat(yield, &size, &ptr, t, s - t);
2859       if (*s != 0) s += 2;
2860       }
2861
2862     else
2863       {
2864       uschar ch[1];
2865       ch[0] = string_interpret_escape(&s);
2866       s++;
2867       yield = string_cat(yield, &size, &ptr, ch, 1);
2868       }
2869
2870     continue;
2871     }
2872
2873   /* Anything other than $ is just copied verbatim, unless we are
2874   looking for a terminating } character. */
2875
2876   if (ket_ends && *s == '}') break;
2877
2878   if (*s != '$')
2879     {
2880     yield = string_cat(yield, &size, &ptr, s++, 1);
2881     continue;
2882     }
2883
2884   /* No { after the $ - must be a plain name or a number for string
2885   match variable. There has to be a fudge for variables that are the
2886   names of header fields preceded by "$header_" because header field
2887   names can contain any printing characters except space and colon.
2888   For those that don't like typing this much, "$h_" is a synonym for
2889   "$header_". A non-existent header yields a NULL value; nothing is
2890   inserted. */
2891
2892   if (isalpha((*(++s))))
2893     {
2894     int len;
2895     int newsize = 0;
2896
2897     s = read_name(name, sizeof(name), s, US"_");
2898
2899     /* If this is the first thing to be expanded, release the pre-allocated
2900     buffer. */
2901
2902     if (ptr == 0 && yield != NULL)
2903       {
2904       store_reset(yield);
2905       yield = NULL;
2906       size = 0;
2907       }
2908
2909     /* Header */
2910
2911     if (Ustrncmp(name, "h_", 2) == 0 ||
2912         Ustrncmp(name, "rh_", 3) == 0 ||
2913         Ustrncmp(name, "bh_", 3) == 0 ||
2914         Ustrncmp(name, "header_", 7) == 0 ||
2915         Ustrncmp(name, "rheader_", 8) == 0 ||
2916         Ustrncmp(name, "bheader_", 8) == 0)
2917       {
2918       BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
2919       uschar *charset = (name[0] == 'b')? NULL : headers_charset;
2920       s = read_header_name(name, sizeof(name), s);
2921       value = find_header(name, FALSE, &newsize, want_raw, charset);
2922
2923       /* If we didn't find the header, and the header contains a closing brace
2924       characters, this may be a user error where the terminating colon
2925       has been omitted. Set a flag to adjust the error message in this case.
2926       But there is no error here - nothing gets inserted. */
2927
2928       if (value == NULL)
2929         {
2930         if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2931         continue;
2932         }
2933       }
2934
2935     /* Variable */
2936
2937     else
2938       {
2939       value = find_variable(name, FALSE, skipping, &newsize);
2940       if (value == NULL)
2941         {
2942         expand_string_message =
2943           string_sprintf("unknown variable name \"%s\"", name);
2944         goto EXPAND_FAILED;
2945         }
2946       }
2947
2948     /* If the data is known to be in a new buffer, newsize will be set to the
2949     size of that buffer. If this is the first thing in an expansion string,
2950     yield will be NULL; just point it at the new store instead of copying. Many
2951     expansion strings contain just one reference, so this is a useful
2952     optimization, especially for humungous headers. */
2953
2954     len = Ustrlen(value);
2955     if (yield == NULL && newsize != 0)
2956       {
2957       yield = value;
2958       size = newsize;
2959       ptr = len;
2960       }
2961     else yield = string_cat(yield, &size, &ptr, value, len);
2962
2963     continue;
2964     }
2965
2966   if (isdigit(*s))
2967     {
2968     int n;
2969     s = read_number(&n, s);
2970     if (n >= 0 && n <= expand_nmax)
2971       yield = string_cat(yield, &size, &ptr, expand_nstring[n],
2972         expand_nlength[n]);
2973     continue;
2974     }
2975
2976   /* Otherwise, if there's no '{' after $ it's an error. */
2977
2978   if (*s != '{')
2979     {
2980     expand_string_message = US"$ not followed by letter, digit, or {";
2981     goto EXPAND_FAILED;
2982     }
2983
2984   /* After { there can be various things, but they all start with
2985   an initial word, except for a number for a string match variable. */
2986
2987   if (isdigit((*(++s))))
2988     {
2989     int n;
2990     s = read_number(&n, s);
2991     if (*s++ != '}')
2992       {
2993       expand_string_message = US"} expected after number";
2994       goto EXPAND_FAILED;
2995       }
2996     if (n >= 0 && n <= expand_nmax)
2997       yield = string_cat(yield, &size, &ptr, expand_nstring[n],
2998         expand_nlength[n]);
2999     continue;
3000     }
3001
3002   if (!isalpha(*s))
3003     {
3004     expand_string_message = US"letter or digit expected after ${";
3005     goto EXPAND_FAILED;
3006     }
3007
3008   /* Allow "-" in names to cater for substrings with negative
3009   arguments. Since we are checking for known names after { this is
3010   OK. */
3011
3012   s = read_name(name, sizeof(name), s, US"_-");
3013   item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3014
3015   switch(item_type)
3016     {
3017     /* Handle conditionals - preserve the values of the numerical expansion
3018     variables in case they get changed by a regular expression match in the
3019     condition. If not, they retain their external settings. At the end
3020     of this "if" section, they get restored to their previous values. */
3021
3022     case EITEM_IF:
3023       {
3024       BOOL cond = FALSE;
3025       uschar *next_s;
3026       int save_expand_nmax =
3027         save_expand_strings(save_expand_nstring, save_expand_nlength);
3028
3029       while (isspace(*s)) s++;
3030       next_s = eval_condition(s, skipping? NULL : &cond);
3031       if (next_s == NULL) goto EXPAND_FAILED;  /* message already set */
3032
3033       DEBUG(D_expand)
3034         debug_printf("condition: %.*s\n   result: %s\n", (int)(next_s - s), s,
3035           cond? "true" : "false");
3036
3037       s = next_s;
3038
3039       /* The handling of "yes" and "no" result strings is now in a separate
3040       function that is also used by ${lookup} and ${extract} and ${run}. */
3041
3042       switch(process_yesno(
3043                skipping,                     /* were previously skipping */
3044                cond,                         /* success/failure indicator */
3045                lookup_value,                 /* value to reset for string2 */
3046                &s,                           /* input pointer */
3047                &yield,                       /* output pointer */
3048                &size,                        /* output size */
3049                &ptr,                         /* output current point */
3050                US"if"))                      /* condition type */
3051         {
3052         case 1: goto EXPAND_FAILED;          /* when all is well, the */
3053         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
3054         }
3055
3056       /* Restore external setting of expansion variables for continuation
3057       at this level. */
3058
3059       restore_expand_strings(save_expand_nmax, save_expand_nstring,
3060         save_expand_nlength);
3061       continue;
3062       }
3063
3064     /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
3065     expanding an internal string that isn't actually going to be used. All we
3066     need to do is check the syntax, so don't do a lookup at all. Preserve the
3067     values of the numerical expansion variables in case they get changed by a
3068     partial lookup. If not, they retain their external settings. At the end
3069     of this "lookup" section, they get restored to their previous values. */
3070
3071     case EITEM_LOOKUP:
3072       {
3073       int stype, partial, affixlen, starflags;
3074       int expand_setup = 0;
3075       int nameptr = 0;
3076       uschar *key, *filename, *affix;
3077       uschar *save_lookup_value = lookup_value;
3078       int save_expand_nmax =
3079         save_expand_strings(save_expand_nstring, save_expand_nlength);
3080
3081       if ((expand_forbid & RDO_LOOKUP) != 0)
3082         {
3083         expand_string_message = US"lookup expansions are not permitted";
3084         goto EXPAND_FAILED;
3085         }
3086
3087       /* Get the key we are to look up for single-key+file style lookups.
3088       Otherwise set the key NULL pro-tem. */
3089
3090       while (isspace(*s)) s++;
3091       if (*s == '{')
3092         {
3093         key = expand_string_internal(s+1, TRUE, &s, skipping);
3094         if (key == NULL) goto EXPAND_FAILED;
3095         if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3096         while (isspace(*s)) s++;
3097         }
3098       else key = NULL;
3099
3100       /* Find out the type of database */
3101
3102       if (!isalpha(*s))
3103         {
3104         expand_string_message = US"missing lookup type";
3105         goto EXPAND_FAILED;
3106         }
3107
3108       /* The type is a string that may contain special characters of various
3109       kinds. Allow everything except space or { to appear; the actual content
3110       is checked by search_findtype_partial. */
3111
3112       while (*s != 0 && *s != '{' && !isspace(*s))
3113         {
3114         if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
3115         s++;
3116         }
3117       name[nameptr] = 0;
3118       while (isspace(*s)) s++;
3119
3120       /* Now check for the individual search type and any partial or default
3121       options. Only those types that are actually in the binary are valid. */
3122
3123       stype = search_findtype_partial(name, &partial, &affix, &affixlen,
3124         &starflags);
3125       if (stype < 0)
3126         {
3127         expand_string_message = search_error_message;
3128         goto EXPAND_FAILED;
3129         }
3130
3131       /* Check that a key was provided for those lookup types that need it,
3132       and was not supplied for those that use the query style. */
3133
3134       if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
3135         {
3136         if (key == NULL)
3137           {
3138           expand_string_message = string_sprintf("missing {key} for single-"
3139             "key \"%s\" lookup", name);
3140           goto EXPAND_FAILED;
3141           }
3142         }
3143       else
3144         {
3145         if (key != NULL)
3146           {
3147           expand_string_message = string_sprintf("a single key was given for "
3148             "lookup type \"%s\", which is not a single-key lookup type", name);
3149           goto EXPAND_FAILED;
3150           }
3151         }
3152
3153       /* Get the next string in brackets and expand it. It is the file name for
3154       single-key+file lookups, and the whole query otherwise. In the case of
3155       queries that also require a file name (e.g. sqlite), the file name comes
3156       first. */
3157
3158       if (*s != '{') goto EXPAND_FAILED_CURLY;
3159       filename = expand_string_internal(s+1, TRUE, &s, skipping);
3160       if (filename == NULL) goto EXPAND_FAILED;
3161       if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3162       while (isspace(*s)) s++;
3163
3164       /* If this isn't a single-key+file lookup, re-arrange the variables
3165       to be appropriate for the search_ functions. For query-style lookups,
3166       there is just a "key", and no file name. For the special query-style +
3167       file types, the query (i.e. "key") starts with a file name. */
3168
3169       if (key == NULL)
3170         {
3171         while (isspace(*filename)) filename++;
3172         key = filename;
3173
3174         if (mac_islookup(stype, lookup_querystyle))
3175           {
3176           filename = NULL;
3177           }
3178         else
3179           {
3180           if (*filename != '/')
3181             {
3182             expand_string_message = string_sprintf(
3183               "absolute file name expected for \"%s\" lookup", name);
3184             goto EXPAND_FAILED;
3185             }
3186           while (*key != 0 && !isspace(*key)) key++;
3187           if (*key != 0) *key++ = 0;
3188           }
3189         }
3190
3191       /* If skipping, don't do the next bit - just lookup_value == NULL, as if
3192       the entry was not found. Note that there is no search_close() function.
3193       Files are left open in case of re-use. At suitable places in higher logic,
3194       search_tidyup() is called to tidy all open files. This can save opening
3195       the same file several times. However, files may also get closed when
3196       others are opened, if too many are open at once. The rule is that a
3197       handle should not be used after a second search_open().
3198
3199       Request that a partial search sets up $1 and maybe $2 by passing
3200       expand_setup containing zero. If its value changes, reset expand_nmax,
3201       since new variables will have been set. Note that at the end of this
3202       "lookup" section, the old numeric variables are restored. */
3203
3204       if (skipping)
3205         lookup_value = NULL;
3206       else
3207         {
3208         void *handle = search_open(filename, stype, 0, NULL, NULL);
3209         if (handle == NULL)
3210           {
3211           expand_string_message = search_error_message;
3212           goto EXPAND_FAILED;
3213           }
3214         lookup_value = search_find(handle, filename, key, partial, affix,
3215           affixlen, starflags, &expand_setup);
3216         if (search_find_defer)
3217           {
3218           expand_string_message =
3219             string_sprintf("lookup of \"%s\" gave DEFER: %s", key,
3220               search_error_message);
3221           goto EXPAND_FAILED;
3222           }
3223         if (expand_setup > 0) expand_nmax = expand_setup;
3224         }
3225
3226       /* The handling of "yes" and "no" result strings is now in a separate
3227       function that is also used by ${if} and ${extract}. */
3228
3229       switch(process_yesno(
3230                skipping,                     /* were previously skipping */
3231                lookup_value != NULL,         /* success/failure indicator */
3232                save_lookup_value,            /* value to reset for string2 */
3233                &s,                           /* input pointer */
3234                &yield,                       /* output pointer */
3235                &size,                        /* output size */
3236                &ptr,                         /* output current point */
3237                US"lookup"))                  /* condition type */
3238         {
3239         case 1: goto EXPAND_FAILED;          /* when all is well, the */
3240         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
3241         }
3242
3243       /* Restore external setting of expansion variables for carrying on
3244       at this level, and continue. */
3245
3246       restore_expand_strings(save_expand_nmax, save_expand_nstring,
3247         save_expand_nlength);
3248       continue;
3249       }
3250
3251     /* If Perl support is configured, handle calling embedded perl subroutines,
3252     unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
3253     or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
3254     arguments (defined below). */
3255
3256     #define EXIM_PERL_MAX_ARGS 8
3257
3258     case EITEM_PERL:
3259     #ifndef EXIM_PERL
3260     expand_string_message = US"\"${perl\" encountered, but this facility "
3261       "is not included in this binary";
3262     goto EXPAND_FAILED;
3263
3264     #else   /* EXIM_PERL */
3265       {
3266       uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
3267       uschar *new_yield;
3268
3269       if ((expand_forbid & RDO_PERL) != 0)
3270         {
3271         expand_string_message = US"Perl calls are not permitted";
3272         goto EXPAND_FAILED;
3273         }
3274
3275       switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
3276            US"perl"))
3277         {
3278         case 1: goto EXPAND_FAILED_CURLY;
3279         case 2:
3280         case 3: goto EXPAND_FAILED;
3281         }
3282
3283       /* If skipping, we don't actually do anything */
3284
3285       if (skipping) continue;
3286
3287       /* Start the interpreter if necessary */
3288
3289       if (!opt_perl_started)
3290         {
3291         uschar *initerror;
3292         if (opt_perl_startup == NULL)
3293           {
3294           expand_string_message = US"A setting of perl_startup is needed when "
3295             "using the Perl interpreter";
3296           goto EXPAND_FAILED;
3297           }
3298         DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
3299         initerror = init_perl(opt_perl_startup);
3300         if (initerror != NULL)
3301           {
3302           expand_string_message =
3303             string_sprintf("error in perl_startup code: %s\n", initerror);
3304           goto EXPAND_FAILED;
3305           }
3306         opt_perl_started = TRUE;
3307         }
3308
3309       /* Call the function */
3310
3311       sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
3312       new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
3313         sub_arg[0], sub_arg + 1);
3314
3315       /* NULL yield indicates failure; if the message pointer has been set to
3316       NULL, the yield was undef, indicating a forced failure. Otherwise the
3317       message will indicate some kind of Perl error. */
3318
3319       if (new_yield == NULL)
3320         {
3321         if (expand_string_message == NULL)
3322           {
3323           expand_string_message =
3324             string_sprintf("Perl subroutine \"%s\" returned undef to force "
3325               "failure", sub_arg[0]);
3326           expand_string_forcedfail = TRUE;
3327           }
3328         goto EXPAND_FAILED;
3329         }
3330
3331       /* Yield succeeded. Ensure forcedfail is unset, just in case it got
3332       set during a callback from Perl. */
3333
3334       expand_string_forcedfail = FALSE;
3335       yield = new_yield;
3336       continue;
3337       }
3338     #endif /* EXIM_PERL */
3339
3340     /* Transform email address to "prvs" scheme to use
3341        as BATV-signed return path */
3342
3343     case EITEM_PRVS:
3344       {
3345       uschar *sub_arg[3];
3346       uschar *p,*domain;
3347
3348       switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs"))
3349         {
3350         case 1: goto EXPAND_FAILED_CURLY;
3351         case 2:
3352         case 3: goto EXPAND_FAILED;
3353         }
3354
3355       /* If skipping, we don't actually do anything */
3356       if (skipping) continue;
3357
3358       /* sub_arg[0] is the address */
3359       domain = Ustrrchr(sub_arg[0],'@');
3360       if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
3361         {
3362         expand_string_message = US"first parameter must be a qualified email address";
3363         goto EXPAND_FAILED;
3364         }
3365
3366       /* Calculate the hash */
3367       p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
3368       if (p == NULL)
3369         {
3370         expand_string_message = US"hmac-sha1 conversion failed";
3371         goto EXPAND_FAILED;
3372         }
3373
3374       /* Now separate the domain from the local part */
3375       *domain++ = '\0';
3376
3377       yield = string_cat(yield,&size,&ptr,US"prvs=",5);
3378       string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
3379       string_cat(yield,&size,&ptr,US"/",1);
3380       string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
3381       string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
3382       string_cat(yield,&size,&ptr,p,6);
3383       string_cat(yield,&size,&ptr,US"@",1);
3384       string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
3385
3386       continue;
3387       }
3388
3389     /* Check a prvs-encoded address for validity */
3390
3391     case EITEM_PRVSCHECK:
3392       {
3393       uschar *sub_arg[3];
3394       int mysize = 0, myptr = 0;
3395       const pcre *re;
3396       uschar *p;
3397       /* Ugliness: We want to expand parameter 1 first, then set
3398          up expansion variables that are used in the expansion of
3399          parameter 2. So we clone the string for the first
3400          expansion, where we only expand paramter 1. */
3401       uschar *s_backup = string_copy(s);
3402
3403       /* Reset expansion variables */
3404       prvscheck_result = NULL;
3405       prvscheck_address = NULL;
3406       prvscheck_keynum = NULL;
3407
3408       switch(read_subs(sub_arg, 1, 1, &s_backup, skipping, FALSE, US"prvs"))
3409         {
3410         case 1: goto EXPAND_FAILED_CURLY;
3411         case 2:
3412         case 3: goto EXPAND_FAILED;
3413         }
3414
3415       re = regex_must_compile(US"^prvs\\=(.+)\\/([0-9])([0-9]{3})([A-F0-9]{6})\\@(.+)$",
3416                               TRUE,FALSE);
3417
3418       if (regex_match_and_setup(re,sub_arg[0],0,-1)) {
3419         uschar *local_part = string_copyn(expand_nstring[1],expand_nlength[1]);
3420         uschar *key_num = string_copyn(expand_nstring[2],expand_nlength[2]);
3421         uschar *daystamp = string_copyn(expand_nstring[3],expand_nlength[3]);
3422         uschar *hash = string_copyn(expand_nstring[4],expand_nlength[4]);
3423         uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
3424
3425         DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
3426         DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
3427         DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
3428         DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
3429         DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
3430
3431         /* Set up expansion variables */
3432         prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
3433         string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
3434         string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
3435         prvscheck_address[myptr] = '\0';
3436         prvscheck_keynum = string_copy(key_num);
3437
3438         /* Now re-expand all arguments in the usual manner */
3439         switch(read_subs(sub_arg, 3, 3, &s, skipping, TRUE, US"prvs"))
3440           {
3441           case 1: goto EXPAND_FAILED_CURLY;
3442           case 2:
3443           case 3: goto EXPAND_FAILED;
3444           }
3445
3446         if (*sub_arg[2] == '\0')
3447           yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
3448         else
3449           yield = string_cat(yield,&size,&ptr,sub_arg[2],Ustrlen(sub_arg[2]));
3450
3451         /* Now we have the key and can check the address. */
3452         p = prvs_hmac_sha1(prvscheck_address, sub_arg[1], prvscheck_keynum, daystamp);
3453         if (p == NULL)
3454           {
3455           expand_string_message = US"hmac-sha1 conversion failed";
3456           goto EXPAND_FAILED;
3457           }
3458
3459         DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
3460         DEBUG(D_expand) debug_printf("prvscheck:      own hash is %s\n", p);
3461         if (Ustrcmp(p,hash) == 0)
3462           {
3463           /* Success, valid BATV address. Now check the expiry date. */
3464           uschar *now = prvs_daystamp(0);
3465           unsigned int inow = 0,iexpire = 1;
3466
3467           (void)sscanf(CS now,"%u",&inow);
3468           (void)sscanf(CS daystamp,"%u",&iexpire);
3469
3470           /* When "iexpire" is < 7, a "flip" has occured.
3471              Adjust "inow" accordingly. */
3472           if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
3473
3474           if (iexpire > inow)
3475             {
3476             prvscheck_result = US"1";
3477             DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
3478             }
3479             else
3480             {
3481             prvscheck_result = NULL;
3482             DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
3483             }
3484           }
3485         else
3486           {
3487           prvscheck_result = NULL;
3488           DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
3489           }
3490       }
3491       else
3492         {
3493         /* Does not look like a prvs encoded address, return the empty string.
3494            We need to make sure all subs are expanded first. */
3495         switch(read_subs(sub_arg, 3, 3, &s, skipping, TRUE, US"prvs"))
3496           {
3497           case 1: goto EXPAND_FAILED_CURLY;
3498           case 2:
3499           case 3: goto EXPAND_FAILED;
3500           }
3501         }
3502
3503       continue;
3504       }
3505
3506     /* Handle "readfile" to insert an entire file */
3507
3508     case EITEM_READFILE:
3509       {
3510       FILE *f;
3511       uschar *sub_arg[2];
3512
3513       if ((expand_forbid & RDO_READFILE) != 0)
3514         {
3515         expand_string_message = US"file insertions are not permitted";
3516         goto EXPAND_FAILED;
3517         }
3518
3519       switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile"))
3520         {
3521         case 1: goto EXPAND_FAILED_CURLY;
3522         case 2:
3523         case 3: goto EXPAND_FAILED;
3524         }
3525
3526       /* If skipping, we don't actually do anything */
3527
3528       if (skipping) continue;
3529
3530       /* Open the file and read it */
3531
3532       f = Ufopen(sub_arg[0], "rb");
3533       if (f == NULL)
3534         {
3535         expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
3536         goto EXPAND_FAILED;
3537         }
3538
3539       yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
3540       (void)fclose(f);
3541       continue;
3542       }
3543
3544     /* Handle "readsocket" to insert data from a Unix domain socket */
3545
3546     case EITEM_READSOCK:
3547       {
3548       int fd;
3549       int timeout = 5;
3550       int save_ptr = ptr;
3551       FILE *f;
3552       struct sockaddr_un sockun;         /* don't call this "sun" ! */
3553       uschar *arg;
3554       uschar *sub_arg[4];
3555
3556       if ((expand_forbid & RDO_READSOCK) != 0)
3557         {
3558         expand_string_message = US"socket insertions are not permitted";
3559         goto EXPAND_FAILED;
3560         }
3561
3562       /* Read up to 4 arguments, but don't do the end of item check afterwards,
3563       because there may be a string for expansion on failure. */
3564
3565       switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket"))
3566         {
3567         case 1: goto EXPAND_FAILED_CURLY;
3568         case 2:                             /* Won't occur: no end check */
3569         case 3: goto EXPAND_FAILED;
3570         }
3571
3572       /* Sort out timeout, if given */
3573
3574       if (sub_arg[2] != NULL)
3575         {
3576         timeout = readconf_readtime(sub_arg[2], 0, FALSE);
3577         if (timeout < 0)
3578           {
3579           expand_string_message = string_sprintf("bad time value %s",
3580             sub_arg[2]);
3581           goto EXPAND_FAILED;
3582           }
3583         }
3584       else sub_arg[3] = NULL;                     /* No eol if no timeout */
3585
3586       /* If skipping, we don't actually do anything */
3587
3588       if (!skipping)
3589         {
3590         /* Make a connection to the socket */
3591
3592         if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
3593           {
3594           expand_string_message = string_sprintf("failed to create socket: %s",
3595             strerror(errno));
3596           goto SOCK_FAIL;
3597           }
3598
3599         sockun.sun_family = AF_UNIX;
3600         sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
3601           sub_arg[0]);
3602         if(connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun)) == -1)
3603           {
3604           expand_string_message = string_sprintf("failed to connect to socket "
3605             "%s: %s", sub_arg[0], strerror(errno));
3606           goto SOCK_FAIL;
3607           }
3608         DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
3609
3610         /* Write the request string, if not empty */
3611
3612         if (sub_arg[1][0] != 0)
3613           {
3614           int len = Ustrlen(sub_arg[1]);
3615           DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
3616             sub_arg[1]);
3617           if (write(fd, sub_arg[1], len) != len)
3618             {
3619             expand_string_message = string_sprintf("request write to socket "
3620               "failed: %s", strerror(errno));
3621             goto SOCK_FAIL;
3622             }
3623           }
3624
3625         /* Now we need to read from the socket, under a timeout. The function
3626         that reads a file can be used. */
3627
3628         f = fdopen(fd, "rb");
3629         sigalrm_seen = FALSE;
3630         alarm(timeout);
3631         yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
3632         alarm(0);
3633         (void)fclose(f);
3634
3635         /* After a timeout, we restore the pointer in the result, that is,
3636         make sure we add nothing from the socket. */
3637
3638         if (sigalrm_seen)
3639           {
3640           ptr = save_ptr;
3641           expand_string_message = US"socket read timed out";
3642           goto SOCK_FAIL;
3643           }
3644         }
3645
3646       /* The whole thing has worked (or we were skipping). If there is a
3647       failure string following, we need to skip it. */
3648
3649       if (*s == '{')
3650         {
3651         if (expand_string_internal(s+1, TRUE, &s, TRUE) == NULL)
3652           goto EXPAND_FAILED;
3653         if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3654         while (isspace(*s)) s++;
3655         }
3656       if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3657       continue;
3658
3659       /* Come here on failure to create socket, connect socket, write to the
3660       socket, or timeout on reading. If another substring follows, expand and
3661       use it. Otherwise, those conditions give expand errors. */
3662
3663       SOCK_FAIL:
3664       if (*s != '{') goto EXPAND_FAILED;
3665       DEBUG(D_any) debug_printf("%s\n", expand_string_message);
3666       arg = expand_string_internal(s+1, TRUE, &s, FALSE);
3667       if (arg == NULL) goto EXPAND_FAILED;
3668       yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
3669       if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3670       while (isspace(*s)) s++;
3671       if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3672       continue;
3673       }
3674
3675     /* Handle "run" to execute a program. */
3676
3677     case EITEM_RUN:
3678       {
3679       FILE *f;
3680       uschar *arg;
3681       uschar **argv;
3682       pid_t pid;
3683       int fd_in, fd_out;
3684       int lsize = 0;
3685       int lptr = 0;
3686
3687       if ((expand_forbid & RDO_RUN) != 0)
3688         {
3689         expand_string_message = US"running a command is not permitted";
3690         goto EXPAND_FAILED;
3691         }
3692
3693       while (isspace(*s)) s++;
3694       if (*s != '{') goto EXPAND_FAILED_CURLY;
3695       arg = expand_string_internal(s+1, TRUE, &s, skipping);
3696       if (arg == NULL) goto EXPAND_FAILED;
3697       while (isspace(*s)) s++;
3698       if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3699
3700       if (skipping)   /* Just pretend it worked when we're skipping */
3701         {
3702         runrc = 0;
3703         }
3704       else
3705         {
3706         if (!transport_set_up_command(&argv,    /* anchor for arg list */
3707             arg,                                /* raw command */
3708             FALSE,                              /* don't expand the arguments */
3709             0,                                  /* not relevant when... */
3710             NULL,                               /* no transporting address */
3711             US"${run} expansion",               /* for error messages */
3712             &expand_string_message))            /* where to put error message */
3713           {
3714           goto EXPAND_FAILED;
3715           }
3716
3717         /* Create the child process, making it a group leader. */
3718
3719         pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
3720
3721         if (pid < 0)
3722           {
3723           expand_string_message =
3724             string_sprintf("couldn't create child process: %s", strerror(errno));
3725           goto EXPAND_FAILED;
3726           }
3727
3728         /* Nothing is written to the standard input. */
3729
3730         (void)close(fd_in);
3731
3732         /* Wait for the process to finish, applying the timeout, and inspect its
3733         return code for serious disasters. Simple non-zero returns are passed on.
3734         */
3735
3736         if ((runrc = child_close(pid, 60)) < 0)
3737           {
3738           if (runrc == -256)
3739             {
3740             expand_string_message = string_sprintf("command timed out");
3741             killpg(pid, SIGKILL);       /* Kill the whole process group */
3742             }
3743
3744           else if (runrc == -257)
3745             expand_string_message = string_sprintf("wait() failed: %s",
3746               strerror(errno));
3747
3748           else
3749             expand_string_message = string_sprintf("command killed by signal %d",
3750               -runrc);
3751
3752           goto EXPAND_FAILED;
3753           }
3754
3755         /* Read the pipe to get the command's output into $value (which is kept
3756         in lookup_value). */
3757
3758         f = fdopen(fd_out, "rb");
3759         lookup_value = NULL;
3760         lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
3761         (void)fclose(f);
3762         }
3763
3764       /* Process the yes/no strings; $value may be useful in both cases */
3765
3766       switch(process_yesno(
3767                skipping,                     /* were previously skipping */
3768                runrc == 0,                   /* success/failure indicator */
3769                lookup_value,                 /* value to reset for string2 */
3770                &s,                           /* input pointer */
3771                &yield,                       /* output pointer */
3772                &size,                        /* output size */
3773                &ptr,                         /* output current point */
3774                US"run"))                     /* condition type */
3775         {
3776         case 1: goto EXPAND_FAILED;          /* when all is well, the */
3777         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
3778         }
3779
3780       continue;
3781       }
3782
3783     /* Handle character translation for "tr" */
3784
3785     case EITEM_TR:
3786       {
3787       int oldptr = ptr;
3788       int o2m;
3789       uschar *sub[3];
3790
3791       switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr"))
3792         {
3793         case 1: goto EXPAND_FAILED_CURLY;
3794         case 2:
3795         case 3: goto EXPAND_FAILED;
3796         }
3797
3798       yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
3799       o2m = Ustrlen(sub[2]) - 1;
3800
3801       if (o2m >= 0) for (; oldptr < ptr; oldptr++)
3802         {
3803         uschar *m = Ustrrchr(sub[1], yield[oldptr]);
3804         if (m != NULL)
3805           {
3806           int o = m - sub[1];
3807           yield[oldptr] = sub[2][(o < o2m)? o : o2m];
3808           }
3809         }
3810
3811       continue;
3812       }
3813
3814     /* Handle "hash", "length", "nhash", and "substr" when they are given with
3815     expanded arguments. */
3816
3817     case EITEM_HASH:
3818     case EITEM_LENGTH:
3819     case EITEM_NHASH:
3820     case EITEM_SUBSTR:
3821       {
3822       int i;
3823       int len;
3824       uschar *ret;
3825       int val[2] = { 0, -1 };
3826       uschar *sub[3];
3827
3828       /* "length" takes only 2 arguments whereas the others take 2 or 3.
3829       Ensure that sub[2] is set in the ${length case. */
3830
3831       sub[2] = NULL;
3832       switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
3833              TRUE, name))
3834         {
3835         case 1: goto EXPAND_FAILED_CURLY;
3836         case 2:
3837         case 3: goto EXPAND_FAILED;
3838         }
3839
3840       /* Juggle the arguments if there are only two of them: always move the
3841       string to the last position and make ${length{n}{str}} equivalent to
3842       ${substr{0}{n}{str}}. See the defaults for val[] above. */
3843
3844       if (sub[2] == NULL)
3845         {
3846         sub[2] = sub[1];
3847         sub[1] = NULL;
3848         if (item_type == EITEM_LENGTH)
3849           {
3850           sub[1] = sub[0];
3851           sub[0] = NULL;
3852           }
3853         }
3854
3855       for (i = 0; i < 2; i++)
3856         {
3857         if (sub[i] == NULL) continue;
3858         val[i] = (int)Ustrtol(sub[i], &ret, 10);
3859         if (*ret != 0 || (i != 0 && val[i] < 0))
3860           {
3861           expand_string_message = string_sprintf("\"%s\" is not a%s number "
3862             "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
3863           goto EXPAND_FAILED;
3864           }
3865         }
3866
3867       ret =
3868         (item_type == EITEM_HASH)?
3869           compute_hash(sub[2], val[0], val[1], &len) :
3870         (item_type == EITEM_NHASH)?
3871           compute_nhash(sub[2], val[0], val[1], &len) :
3872           extract_substr(sub[2], val[0], val[1], &len);
3873
3874       if (ret == NULL) goto EXPAND_FAILED;
3875       yield = string_cat(yield, &size, &ptr, ret, len);
3876       continue;
3877       }
3878
3879     /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
3880     This code originally contributed by Steve Haslam. It currently supports
3881     the use of MD5 and SHA-1 hashes.
3882
3883     We need some workspace that is large enough to handle all the supported
3884     hash types. Use macros to set the sizes rather than be too elaborate. */
3885
3886     #define MAX_HASHLEN      20
3887     #define MAX_HASHBLOCKLEN 64
3888
3889     case EITEM_HMAC:
3890       {
3891       uschar *sub[3];
3892       md5 md5_base;
3893       sha1 sha1_base;
3894       void *use_base;
3895       int type, i;
3896       int hashlen;      /* Number of octets for the hash algorithm's output */
3897       int hashblocklen; /* Number of octets the hash algorithm processes */
3898       uschar *keyptr, *p;
3899       unsigned int keylen;
3900
3901       uschar keyhash[MAX_HASHLEN];
3902       uschar innerhash[MAX_HASHLEN];
3903       uschar finalhash[MAX_HASHLEN];
3904       uschar finalhash_hex[2*MAX_HASHLEN];
3905       uschar innerkey[MAX_HASHBLOCKLEN];
3906       uschar outerkey[MAX_HASHBLOCKLEN];
3907
3908       switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name))
3909         {
3910         case 1: goto EXPAND_FAILED_CURLY;
3911         case 2:
3912         case 3: goto EXPAND_FAILED;
3913         }
3914
3915       if (Ustrcmp(sub[0], "md5") == 0)
3916         {
3917         type = HMAC_MD5;
3918         use_base = &md5_base;
3919         hashlen = 16;
3920         hashblocklen = 64;
3921         }
3922       else if (Ustrcmp(sub[0], "sha1") == 0)
3923         {
3924         type = HMAC_SHA1;
3925         use_base = &sha1_base;
3926         hashlen = 20;
3927         hashblocklen = 64;
3928         }
3929       else
3930         {
3931         expand_string_message =
3932           string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
3933         goto EXPAND_FAILED;
3934         }
3935
3936       keyptr = sub[1];
3937       keylen = Ustrlen(keyptr);
3938
3939       /* If the key is longer than the hash block length, then hash the key
3940       first */
3941
3942       if (keylen > hashblocklen)
3943         {
3944         chash_start(type, use_base);
3945         chash_end(type, use_base, keyptr, keylen, keyhash);
3946         keyptr = keyhash;
3947         keylen = hashlen;
3948         }
3949
3950       /* Now make the inner and outer key values */
3951
3952       memset(innerkey, 0x36, hashblocklen);
3953       memset(outerkey, 0x5c, hashblocklen);
3954
3955       for (i = 0; i < keylen; i++)
3956         {
3957         innerkey[i] ^= keyptr[i];
3958         outerkey[i] ^= keyptr[i];
3959         }
3960
3961       /* Now do the hashes */
3962
3963       chash_start(type, use_base);
3964       chash_mid(type, use_base, innerkey);
3965       chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
3966
3967       chash_start(type, use_base);
3968       chash_mid(type, use_base, outerkey);
3969       chash_end(type, use_base, innerhash, hashlen, finalhash);
3970
3971       /* Encode the final hash as a hex string */
3972
3973       p = finalhash_hex;
3974       for (i = 0; i < hashlen; i++)
3975         {
3976         *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
3977         *p++ = hex_digits[finalhash[i] & 0x0f];
3978         }
3979
3980       DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
3981         (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
3982
3983       yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
3984       }
3985
3986     continue;
3987
3988     /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
3989     We have to save the numerical variables and restore them afterwards. */
3990
3991     case EITEM_SG:
3992       {
3993       const pcre *re;
3994       int moffset, moffsetextra, slen;
3995       int roffset;
3996       int emptyopt;
3997       const uschar *rerror;
3998       uschar *subject;
3999       uschar *sub[3];
4000       int save_expand_nmax =
4001         save_expand_strings(save_expand_nstring, save_expand_nlength);
4002
4003       switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg"))
4004         {
4005         case 1: goto EXPAND_FAILED_CURLY;
4006         case 2:
4007         case 3: goto EXPAND_FAILED;
4008         }
4009
4010       /* Compile the regular expression */
4011
4012       re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
4013         NULL);
4014
4015       if (re == NULL)
4016         {
4017         expand_string_message = string_sprintf("regular expression error in "
4018           "\"%s\": %s at offset %d", sub[1], rerror, roffset);
4019         goto EXPAND_FAILED;
4020         }
4021
4022       /* Now run a loop to do the substitutions as often as necessary. It ends
4023       when there are no more matches. Take care over matches of the null string;
4024       do the same thing as Perl does. */
4025
4026       subject = sub[0];
4027       slen = Ustrlen(sub[0]);
4028       moffset = moffsetextra = 0;
4029       emptyopt = 0;
4030
4031       for (;;)
4032         {
4033         int ovector[3*(EXPAND_MAXN+1)];
4034         int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
4035           PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
4036         int nn;
4037         uschar *insert;
4038
4039         /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
4040         is not necessarily the end. We want to repeat the match from one
4041         character further along, but leaving the basic offset the same (for
4042         copying below). We can't be at the end of the string - that was checked
4043         before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
4044         finished; copy the remaining string and end the loop. */
4045
4046         if (n < 0)
4047           {
4048           if (emptyopt != 0)
4049             {
4050             moffsetextra = 1;
4051             emptyopt = 0;
4052             continue;
4053             }
4054           yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
4055           break;
4056           }
4057
4058         /* Match - set up for expanding the replacement. */
4059
4060         if (n == 0) n = EXPAND_MAXN + 1;
4061         expand_nmax = 0;
4062         for (nn = 0; nn < n*2; nn += 2)
4063           {
4064           expand_nstring[expand_nmax] = subject + ovector[nn];
4065           expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
4066           }
4067         expand_nmax--;
4068
4069         /* Copy the characters before the match, plus the expanded insertion. */
4070
4071         yield = string_cat(yield, &size, &ptr, subject + moffset,
4072           ovector[0] - moffset);
4073         insert = expand_string(sub[2]);
4074         if (insert == NULL) goto EXPAND_FAILED;
4075         yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
4076
4077         moffset = ovector[1];
4078         moffsetextra = 0;
4079         emptyopt = 0;
4080
4081         /* If we have matched an empty string, first check to see if we are at
4082         the end of the subject. If so, the loop is over. Otherwise, mimic
4083         what Perl's /g options does. This turns out to be rather cunning. First
4084         we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
4085         string at the same point. If this fails (picked up above) we advance to
4086         the next character. */
4087
4088         if (ovector[0] == ovector[1])
4089           {
4090           if (ovector[0] == slen) break;
4091           emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
4092           }
4093         }
4094
4095       /* All done - restore numerical variables. */
4096
4097       restore_expand_strings(save_expand_nmax, save_expand_nstring,
4098         save_expand_nlength);
4099       continue;
4100       }
4101
4102     /* Handle keyed and numbered substring extraction. If the first argument
4103     consists entirely of digits, then a numerical extraction is assumed. */
4104
4105     case EITEM_EXTRACT:
4106       {
4107       int i;
4108       int j = 2;
4109       int field_number = 1;
4110       BOOL field_number_set = FALSE;
4111       uschar *save_lookup_value = lookup_value;
4112       uschar *sub[3];
4113       int save_expand_nmax =
4114         save_expand_strings(save_expand_nstring, save_expand_nlength);
4115
4116       /* Read the arguments */
4117
4118       for (i = 0; i < j; i++)
4119         {
4120         while (isspace(*s)) s++;
4121         if (*s == '{')
4122           {
4123           sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
4124           if (sub[i] == NULL) goto EXPAND_FAILED;
4125           if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4126
4127           /* After removal of leading and trailing white space, the first
4128           argument must not be empty; if it consists entirely of digits
4129           (optionally preceded by a minus sign), this is a numerical
4130           extraction, and we expect 3 arguments. */
4131
4132           if (i == 0)
4133             {
4134             int len;
4135             int x = 0;
4136             uschar *p = sub[0];
4137
4138             while (isspace(*p)) p++;
4139             sub[0] = p;
4140
4141             len = Ustrlen(p);
4142             while (len > 0 && isspace(p[len-1])) len--;
4143             p[len] = 0;
4144
4145             if (*p == 0)
4146               {
4147               expand_string_message = US"first argument of \"extract\" must "
4148                 "not be empty";
4149               goto EXPAND_FAILED;
4150               }
4151
4152             if (*p == '-')
4153               {
4154               field_number = -1;
4155               p++;
4156               }
4157             while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
4158             if (*p == 0)
4159               {
4160               field_number *= x;
4161               j = 3;               /* Need 3 args */
4162               field_number_set = TRUE;
4163               }
4164             }
4165           }
4166         else goto EXPAND_FAILED_CURLY;
4167         }
4168
4169       /* Extract either the numbered or the keyed substring into $value. If
4170       skipping, just pretend the extraction failed. */
4171
4172       lookup_value = skipping? NULL : field_number_set?
4173         expand_gettokened(field_number, sub[1], sub[2]) :
4174         expand_getkeyed(sub[0], sub[1]);
4175
4176       /* If no string follows, $value gets substituted; otherwise there can
4177       be yes/no strings, as for lookup or if. */
4178
4179       switch(process_yesno(
4180                skipping,                     /* were previously skipping */
4181                lookup_value != NULL,         /* success/failure indicator */
4182                save_lookup_value,            /* value to reset for string2 */
4183                &s,                           /* input pointer */
4184                &yield,                       /* output pointer */
4185                &size,                        /* output size */
4186                &ptr,                         /* output current point */
4187                US"extract"))                 /* condition type */
4188         {
4189         case 1: goto EXPAND_FAILED;          /* when all is well, the */
4190         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
4191         }
4192
4193       /* All done - restore numerical variables. */
4194
4195       restore_expand_strings(save_expand_nmax, save_expand_nstring,
4196         save_expand_nlength);
4197
4198       continue;
4199       }
4200
4201
4202     /* If ${dlfunc support is configured, handle calling dynamically-loaded
4203     functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
4204     or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
4205     a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
4206
4207     #define EXPAND_DLFUNC_MAX_ARGS 8
4208
4209     case EITEM_DLFUNC:
4210     #ifndef EXPAND_DLFUNC
4211     expand_string_message = US"\"${dlfunc\" encountered, but this facility "
4212       "is not included in this binary";
4213     goto EXPAND_FAILED;
4214
4215     #else   /* EXPAND_DLFUNC */
4216       {
4217       tree_node *t;
4218       exim_dlfunc_t *func;
4219       uschar *result;
4220       int status, argc;
4221       uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
4222
4223       if ((expand_forbid & RDO_DLFUNC) != 0)
4224         {
4225         expand_string_message =
4226           US"dynamically-loaded functions are not permitted";
4227         goto EXPAND_FAILED;
4228         }
4229
4230       switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
4231            TRUE, US"dlfunc"))
4232         {
4233         case 1: goto EXPAND_FAILED_CURLY;
4234         case 2:
4235         case 3: goto EXPAND_FAILED;
4236         }
4237
4238       /* If skipping, we don't actually do anything */
4239
4240       if (skipping) continue;
4241
4242       /* Look up the dynamically loaded object handle in the tree. If it isn't
4243       found, dlopen() the file and put the handle in the tree for next time. */
4244
4245       t = tree_search(dlobj_anchor, argv[0]);
4246       if (t == NULL)
4247         {
4248         void *handle = dlopen(CS argv[0], RTLD_LAZY);
4249         if (handle == NULL)
4250           {
4251           expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
4252             argv[0], dlerror());
4253           log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4254           goto EXPAND_FAILED;
4255           }
4256         t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
4257         Ustrcpy(t->name, argv[0]);
4258         t->data.ptr = handle;
4259         (void)tree_insertnode(&dlobj_anchor, t);
4260         }
4261
4262       /* Having obtained the dynamically loaded object handle, look up the
4263       function pointer. */
4264
4265       func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
4266       if (func == NULL)
4267         {
4268         expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
4269           "%s", argv[1], argv[0], dlerror());
4270         log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4271         goto EXPAND_FAILED;
4272         }
4273
4274       /* Call the function and work out what to do with the result. If it
4275       returns OK, we have a replacement string; if it returns DEFER then
4276       expansion has failed in a non-forced manner; if it returns FAIL then
4277       failure was forced; if it returns ERROR or any other value there's a
4278       problem, so panic slightly. */
4279
4280       result = NULL;
4281       for (argc = 0; argv[argc] != NULL; argc++);
4282       status = func(&result, argc - 2, &argv[2]);
4283       if(status == OK)
4284         {
4285         if (result == NULL) result = US"";
4286         yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
4287         continue;
4288         }
4289       else
4290         {
4291         expand_string_message = result == NULL ? US"(no message)" : result;
4292         if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
4293           else if(status != FAIL)
4294             log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
4295               argv[0], argv[1], status, expand_string_message);
4296         goto EXPAND_FAILED;
4297         }
4298       }
4299     #endif /* EXPAND_DLFUNC */
4300     }
4301
4302   /* Control reaches here if the name is not recognized as one of the more
4303   complicated expansion items. Check for the "operator" syntax (name terminated
4304   by a colon). Some of the operators have arguments, separated by _ from the
4305   name. */
4306
4307   if (*s == ':')
4308     {
4309     int c;
4310     uschar *arg = NULL;
4311     uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping);
4312     if (sub == NULL) goto EXPAND_FAILED;
4313     s++;
4314
4315     /* Owing to an historical mis-design, an underscore may be part of the
4316     operator name, or it may introduce arguments.  We therefore first scan the
4317     table of names that contain underscores. If there is no match, we cut off
4318     the arguments and then scan the main table. */
4319
4320     c = chop_match(name, op_table_underscore,
4321       sizeof(op_table_underscore)/sizeof(uschar *));
4322
4323     if (c < 0)
4324       {
4325       arg = Ustrchr(name, '_');
4326       if (arg != NULL) *arg = 0;
4327       c = chop_match(name, op_table_main,
4328         sizeof(op_table_main)/sizeof(uschar *));
4329       if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
4330       if (arg != NULL) *arg++ = '_';   /* Put back for error messages */
4331       }
4332
4333     /* If we are skipping, we don't need to perform the operation at all.
4334     This matters for operations like "mask", because the data may not be
4335     in the correct format when skipping. For example, the expression may test
4336     for the existence of $sender_host_address before trying to mask it. For
4337     other operations, doing them may not fail, but it is a waste of time. */
4338
4339     if (skipping && c >= 0) continue;
4340
4341     /* Otherwise, switch on the operator type */
4342
4343     switch(c)
4344       {
4345       case EOP_BASE62:
4346         {
4347         uschar *t;
4348         unsigned long int n = Ustrtoul(sub, &t, 10);
4349         if (*t != 0)
4350           {
4351           expand_string_message = string_sprintf("argument for base62 "
4352             "operator is \"%s\", which is not a decimal number", sub);
4353           goto EXPAND_FAILED;
4354           }
4355         t = string_base62(n);
4356         yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4357         continue;
4358         }
4359
4360       case EOP_BASE62D:
4361         {
4362         uschar buf[16];
4363         uschar *tt = sub;
4364         unsigned long int n = 0;
4365         while (*tt != 0)
4366           {
4367           uschar *t = Ustrchr(base62_chars, *tt++);
4368           if (t == NULL)
4369             {
4370             expand_string_message = string_sprintf("argument for base62d "
4371               "operator is \"%s\", which is not a base 62 number", sub);
4372             goto EXPAND_FAILED;
4373             }
4374           n = n * 62 + (t - base62_chars);
4375           }
4376         (void)sprintf(CS buf, "%ld", n);
4377         yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
4378         continue;
4379         }
4380
4381       case EOP_EXPAND:
4382         {
4383         uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping);
4384         if (expanded == NULL)
4385           {
4386           expand_string_message =
4387             string_sprintf("internal expansion of \"%s\" failed: %s", sub,
4388               expand_string_message);
4389           goto EXPAND_FAILED;
4390           }
4391         yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
4392         continue;
4393         }
4394
4395       case EOP_LC:
4396         {
4397         int count = 0;
4398         uschar *t = sub - 1;
4399         while (*(++t) != 0) { *t = tolower(*t); count++; }
4400         yield = string_cat(yield, &size, &ptr, sub, count);
4401         continue;
4402         }
4403
4404       case EOP_UC:
4405         {
4406         int count = 0;
4407         uschar *t = sub - 1;
4408         while (*(++t) != 0) { *t = toupper(*t); count++; }
4409         yield = string_cat(yield, &size, &ptr, sub, count);
4410         continue;
4411         }
4412
4413       case EOP_MD5:
4414         {
4415         md5 base;
4416         uschar digest[16];
4417         int j;
4418         char st[33];
4419         md5_start(&base);
4420         md5_end(&base, sub, Ustrlen(sub), digest);
4421         for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
4422         yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
4423         continue;
4424         }
4425
4426       case EOP_SHA1:
4427         {
4428         sha1 base;
4429         uschar digest[20];
4430         int j;
4431         char st[41];
4432         sha1_start(&base);
4433         sha1_end(&base, sub, Ustrlen(sub), digest);
4434         for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
4435         yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
4436         continue;
4437         }
4438
4439       /* Convert hex encoding to base64 encoding */
4440
4441       case EOP_HEX2B64:
4442         {
4443         int c = 0;
4444         int b = -1;
4445         uschar *in = sub;
4446         uschar *out = sub;
4447         uschar *enc;
4448
4449         for (enc = sub; *enc != 0; enc++)
4450           {
4451           if (!isxdigit(*enc))
4452             {
4453             expand_string_message = string_sprintf("\"%s\" is not a hex "
4454               "string", sub);
4455             goto EXPAND_FAILED;
4456             }
4457           c++;
4458           }
4459
4460         if ((c & 1) != 0)
4461           {
4462           expand_string_message = string_sprintf("\"%s\" contains an odd "
4463             "number of characters", sub);
4464           goto EXPAND_FAILED;
4465           }
4466
4467         while ((c = *in++) != 0)
4468           {
4469           if (isdigit(c)) c -= '0';
4470           else c = toupper(c) - 'A' + 10;
4471           if (b == -1)
4472             {
4473             b = c << 4;
4474             }
4475           else
4476             {
4477             *out++ = b | c;
4478             b = -1;
4479             }
4480           }
4481
4482         enc = auth_b64encode(sub, out - sub);
4483         yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
4484         continue;
4485         }
4486
4487       /* mask applies a mask to an IP address; for example the result of
4488       ${mask:131.111.10.206/28} is 131.111.10.192/28. */
4489
4490       case EOP_MASK:
4491         {
4492         int count;
4493         uschar *endptr;
4494         int binary[4];
4495         int mask, maskoffset;
4496         int type = string_is_ip_address(sub, &maskoffset);
4497         uschar buffer[64];
4498
4499         if (type == 0)
4500           {
4501           expand_string_message = string_sprintf("\"%s\" is not an IP address",
4502            sub);
4503           goto EXPAND_FAILED;
4504           }
4505
4506         if (maskoffset == 0)
4507           {
4508           expand_string_message = string_sprintf("missing mask value in \"%s\"",
4509             sub);
4510           goto EXPAND_FAILED;
4511           }
4512
4513         mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
4514
4515         if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
4516           {
4517           expand_string_message = string_sprintf("mask value too big in \"%s\"",
4518             sub);
4519           goto EXPAND_FAILED;
4520           }
4521
4522         /* Convert the address to binary integer(s) and apply the mask */
4523
4524         sub[maskoffset] = 0;
4525         count = host_aton(sub, binary);
4526         host_mask(count, binary, mask);
4527
4528         /* Convert to masked textual format and add to output. */
4529
4530         yield = string_cat(yield, &size, &ptr, buffer,
4531           host_nmtoa(count, binary, mask, buffer, '.'));
4532         continue;
4533         }
4534
4535       case EOP_ADDRESS:
4536       case EOP_LOCAL_PART:
4537       case EOP_DOMAIN:
4538         {
4539         uschar *error;
4540         int start, end, domain;
4541         uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
4542           FALSE);
4543         if (t != NULL)
4544           {
4545           if (c != EOP_DOMAIN)
4546             {
4547             if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
4548             yield = string_cat(yield, &size, &ptr, sub+start, end-start);
4549             }
4550           else if (domain != 0)
4551             {
4552             domain += start;
4553             yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
4554             }
4555           }
4556         continue;
4557         }
4558
4559       /* quote puts a string in quotes if it is empty or contains anything
4560       other than alphamerics, underscore, dot, or hyphen.
4561
4562       quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
4563       be quoted in order to be a valid local part.
4564
4565       In both cases, newlines and carriage returns are converted into \n and \r
4566       respectively */
4567
4568       case EOP_QUOTE:
4569       case EOP_QUOTE_LOCAL_PART:
4570       if (arg == NULL)
4571         {
4572         BOOL needs_quote = (*sub == 0);      /* TRUE for empty string */
4573         uschar *t = sub - 1;
4574
4575         if (c == EOP_QUOTE)
4576           {
4577           while (!needs_quote && *(++t) != 0)
4578             needs_quote = !isalnum(*t) && !strchr("_-.", *t);
4579           }
4580         else  /* EOP_QUOTE_LOCAL_PART */
4581           {
4582           while (!needs_quote && *(++t) != 0)
4583             needs_quote = !isalnum(*t) &&
4584               strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
4585               (*t != '.' || t == sub || t[1] == 0);
4586           }
4587
4588         if (needs_quote)
4589           {
4590           yield = string_cat(yield, &size, &ptr, US"\"", 1);
4591           t = sub - 1;
4592           while (*(++t) != 0)
4593             {
4594             if (*t == '\n')
4595               yield = string_cat(yield, &size, &ptr, US"\\n", 2);
4596             else if (*t == '\r')
4597               yield = string_cat(yield, &size, &ptr, US"\\r", 2);
4598             else
4599               {
4600               if (*t == '\\' || *t == '"')
4601                 yield = string_cat(yield, &size, &ptr, US"\\", 1);
4602               yield = string_cat(yield, &size, &ptr, t, 1);
4603               }
4604             }
4605           yield = string_cat(yield, &size, &ptr, US"\"", 1);
4606           }
4607         else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
4608         continue;
4609         }
4610
4611       /* quote_lookuptype does lookup-specific quoting */
4612
4613       else
4614         {
4615         int n;
4616         uschar *opt = Ustrchr(arg, '_');
4617
4618         if (opt != NULL) *opt++ = 0;
4619
4620         n = search_findtype(arg, Ustrlen(arg));
4621         if (n < 0)
4622           {
4623           expand_string_message = search_error_message;
4624           goto EXPAND_FAILED;
4625           }
4626
4627         if (lookup_list[n].quote != NULL)
4628           sub = (lookup_list[n].quote)(sub, opt);
4629         else if (opt != NULL) sub = NULL;
4630
4631         if (sub == NULL)
4632           {
4633           expand_string_message = string_sprintf(
4634             "\"%s\" unrecognized after \"${quote_%s\"",
4635             opt, arg);
4636           goto EXPAND_FAILED;
4637           }
4638
4639         yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
4640         continue;
4641         }
4642
4643       /* rx quote sticks in \ before any non-alphameric character so that
4644       the insertion works in a regular expression. */
4645
4646       case EOP_RXQUOTE:
4647         {
4648         uschar *t = sub - 1;
4649         while (*(++t) != 0)
4650           {
4651           if (!isalnum(*t))
4652             yield = string_cat(yield, &size, &ptr, US"\\", 1);
4653           yield = string_cat(yield, &size, &ptr, t, 1);
4654           }
4655         continue;
4656         }
4657
4658       /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
4659       prescribed by the RFC, if there are characters that need to be encoded */
4660
4661       case EOP_RFC2047:
4662         {
4663         uschar buffer[2048];
4664         uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
4665           buffer, sizeof(buffer));
4666         yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
4667         continue;
4668         }
4669
4670       /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
4671       underscores */
4672
4673       case EOP_FROM_UTF8:
4674         {
4675         while (*sub != 0)
4676           {
4677           int c;
4678           uschar buff[4];
4679           GETUTF8INC(c, sub);
4680           if (c > 255) c = '_';
4681           buff[0] = c;
4682           yield = string_cat(yield, &size, &ptr, buff, 1);
4683           }
4684         continue;
4685         }
4686
4687       /* escape turns all non-printing characters into escape sequences. */
4688
4689       case EOP_ESCAPE:
4690         {
4691         uschar *t = string_printing(sub);
4692         yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4693         continue;
4694         }
4695
4696       /* Handle numeric expression evaluation */
4697
4698       case EOP_EVAL:
4699       case EOP_EVAL10:
4700         {
4701         uschar *save_sub = sub;
4702         uschar *error = NULL;
4703         int n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
4704         if (error != NULL)
4705           {
4706           expand_string_message = string_sprintf("error in expression "
4707             "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
4708               save_sub);
4709           goto EXPAND_FAILED;
4710           }
4711         sprintf(CS var_buffer, "%d", n);
4712         yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
4713         continue;
4714         }
4715
4716       /* Handle time period formating */
4717
4718       case EOP_TIME_INTERVAL:
4719         {
4720         int n;
4721         uschar *t = read_number(&n, sub);
4722         if (*t != 0) /* Not A Number*/
4723           {
4724           expand_string_message = string_sprintf("string \"%s\" is not a "
4725             "positive number in \"%s\" operator", sub, name);
4726           goto EXPAND_FAILED;
4727           }
4728         t = readconf_printtime(n);
4729         yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4730         continue;
4731         }
4732
4733       /* Convert string to base64 encoding */
4734
4735       case EOP_STR2B64:
4736         {
4737         uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
4738         yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
4739         continue;
4740         }
4741
4742       /* strlen returns the length of the string */
4743
4744       case EOP_STRLEN:
4745         {
4746         uschar buff[24];
4747         (void)sprintf(CS buff, "%d", Ustrlen(sub));
4748         yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
4749         continue;
4750         }
4751
4752       /* length_n or l_n takes just the first n characters or the whole string,
4753       whichever is the shorter;
4754
4755       substr_m_n, and s_m_n take n characters from offset m; negative m take
4756       from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
4757       takes the rest, either to the right or to the left.
4758
4759       hash_n or h_n makes a hash of length n from the string, yielding n
4760       characters from the set a-z; hash_n_m makes a hash of length n, but
4761       uses m characters from the set a-zA-Z0-9.
4762
4763       nhash_n returns a single number between 0 and n-1 (in text form), while
4764       nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
4765       between 0 and n-1 and the second between 0 and m-1. */
4766
4767       case EOP_LENGTH:
4768       case EOP_L:
4769       case EOP_SUBSTR:
4770       case EOP_S:
4771       case EOP_HASH:
4772       case EOP_H:
4773       case EOP_NHASH:
4774       case EOP_NH:
4775         {
4776         int sign = 1;
4777         int value1 = 0;
4778         int value2 = -1;
4779         int *pn;
4780         int len;
4781         uschar *ret;
4782
4783         if (arg == NULL)
4784           {
4785           expand_string_message = string_sprintf("missing values after %s",
4786             name);
4787           goto EXPAND_FAILED;
4788           }
4789
4790         /* "length" has only one argument, effectively being synonymous with
4791         substr_0_n. */
4792
4793         if (c == EOP_LENGTH || c == EOP_L)
4794           {
4795           pn = &value2;
4796           value2 = 0;
4797           }
4798
4799         /* The others have one or two arguments; for "substr" the first may be
4800         negative. The second being negative means "not supplied". */
4801
4802         else
4803           {
4804           pn = &value1;
4805           if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
4806           }
4807
4808         /* Read up to two numbers, separated by underscores */
4809
4810         ret = arg;
4811         while (*arg != 0)
4812           {
4813           if (arg != ret && *arg == '_' && pn == &value1)
4814             {
4815             pn = &value2;
4816             value2 = 0;
4817             if (arg[1] != 0) arg++;
4818             }
4819           else if (!isdigit(*arg))
4820             {
4821             expand_string_message =
4822               string_sprintf("non-digit after underscore in \"%s\"", name);
4823             goto EXPAND_FAILED;
4824             }
4825           else *pn = (*pn)*10 + *arg++ - '0';
4826           }
4827         value1 *= sign;
4828
4829         /* Perform the required operation */
4830
4831         ret =
4832           (c == EOP_HASH || c == EOP_H)?
4833              compute_hash(sub, value1, value2, &len) :
4834           (c == EOP_NHASH || c == EOP_NH)?
4835              compute_nhash(sub, value1, value2, &len) :
4836              extract_substr(sub, value1, value2, &len);
4837
4838         if (ret == NULL) goto EXPAND_FAILED;
4839         yield = string_cat(yield, &size, &ptr, ret, len);
4840         continue;
4841         }
4842
4843       /* Stat a path */
4844
4845       case EOP_STAT:
4846         {
4847         uschar *s;
4848         uschar smode[12];
4849         uschar **modetable[3];
4850         int i;
4851         mode_t mode;
4852         struct stat st;
4853
4854         if ((expand_forbid & RDO_EXISTS) != 0)
4855           {
4856           expand_string_message = US"Use of the stat() expansion is not permitted";
4857           goto EXPAND_FAILED;
4858           }
4859
4860         if (stat(CS sub, &st) < 0)
4861           {
4862           expand_string_message = string_sprintf("stat(%s) failed: %s",
4863             sub, strerror(errno));
4864           goto EXPAND_FAILED;
4865           }
4866         mode = st.st_mode;
4867         switch (mode & S_IFMT)
4868           {
4869           case S_IFIFO: smode[0] = 'p'; break;
4870           case S_IFCHR: smode[0] = 'c'; break;
4871           case S_IFDIR: smode[0] = 'd'; break;
4872           case S_IFBLK: smode[0] = 'b'; break;
4873           case S_IFREG: smode[0] = '-'; break;
4874           default: smode[0] = '?'; break;
4875           }
4876
4877         modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
4878         modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
4879         modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
4880
4881         for (i = 0; i < 3; i++)
4882           {
4883           memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
4884           mode >>= 3;
4885           }
4886
4887         smode[10] = 0;
4888         s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
4889           "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
4890           (long)(st.st_mode & 077777), smode, (long)st.st_ino,
4891           (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
4892           (long)st.st_gid, st.st_size, (long)st.st_atime,
4893           (long)st.st_mtime, (long)st.st_ctime);
4894         yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
4895         continue;
4896         }
4897
4898       /* Unknown operator */
4899
4900       default:
4901       expand_string_message =
4902         string_sprintf("unknown expansion operator \"%s\"", name);
4903       goto EXPAND_FAILED;
4904       }
4905     }
4906
4907   /* Handle a plain name. If this is the first thing in the expansion, release
4908   the pre-allocated buffer. If the result data is known to be in a new buffer,
4909   newsize will be set to the size of that buffer, and we can just point at that
4910   store instead of copying. Many expansion strings contain just one reference,
4911   so this is a useful optimization, especially for humungous headers
4912   ($message_headers). */
4913
4914   if (*s++ == '}')
4915     {
4916     int len;
4917     int newsize = 0;
4918     if (ptr == 0)
4919       {
4920       store_reset(yield);
4921       yield = NULL;
4922       size = 0;
4923       }
4924     value = find_variable(name, FALSE, skipping, &newsize);
4925     if (value == NULL)
4926       {
4927       expand_string_message =
4928         string_sprintf("unknown variable in \"${%s}\"", name);
4929       goto EXPAND_FAILED;
4930       }
4931     len = Ustrlen(value);
4932     if (yield == NULL && newsize != 0)
4933       {
4934       yield = value;
4935       size = newsize;
4936       ptr = len;
4937       }
4938     else yield = string_cat(yield, &size, &ptr, value, len);
4939     continue;
4940     }
4941
4942   /* Else there's something wrong */
4943
4944   expand_string_message =
4945     string_sprintf("\"${%s\" is not a known operator (or a } is missing "
4946     "in a variable reference)", name);
4947   goto EXPAND_FAILED;
4948   }
4949
4950 /* If we hit the end of the string when ket_ends is set, there is a missing
4951 terminating brace. */
4952
4953 if (ket_ends && *s == 0)
4954   {
4955   expand_string_message = malformed_header?
4956     US"missing } at end of string - could be header name not terminated by colon"
4957     :
4958     US"missing } at end of string";
4959   goto EXPAND_FAILED;
4960   }
4961
4962 /* Expansion succeeded; yield may still be NULL here if nothing was actually
4963 added to the string. If so, set up an empty string. Add a terminating zero. If
4964 left != NULL, return a pointer to the terminator. */
4965
4966 if (yield == NULL) yield = store_get(1);
4967 yield[ptr] = 0;
4968 if (left != NULL) *left = s;
4969
4970 /* Any stacking store that was used above the final string is no longer needed.
4971 In many cases the final string will be the first one that was got and so there
4972 will be optimal store usage. */
4973
4974 store_reset(yield + ptr + 1);
4975 DEBUG(D_expand)
4976   {
4977   debug_printf("expanding: %.*s\n   result: %s\n", (int)(s - string), string,
4978     yield);
4979   if (skipping) debug_printf("skipping: result is not used\n");
4980   }
4981 return yield;
4982
4983 /* This is the failure exit: easiest to program with a goto. We still need
4984 to update the pointer to the terminator, for cases of nested calls with "fail".
4985 */
4986
4987 EXPAND_FAILED_CURLY:
4988 expand_string_message = malformed_header?
4989   US"missing or misplaced { or } - could be header name not terminated by colon"
4990   :
4991   US"missing or misplaced { or }";
4992
4993 /* At one point, Exim reset the store to yield (if yield was not NULL), but
4994 that is a bad idea, because expand_string_message is in dynamic store. */
4995
4996 EXPAND_FAILED:
4997 if (left != NULL) *left = s;
4998 DEBUG(D_expand)
4999   {
5000   debug_printf("failed to expand: %s\n", string);
5001   debug_printf("   error message: %s\n", expand_string_message);
5002   if (expand_string_forcedfail) debug_printf("failure was forced\n");
5003   }
5004 return NULL;
5005 }
5006
5007
5008 /* This is the external function call. Do a quick check for any expansion
5009 metacharacters, and if there are none, just return the input string.
5010
5011 Argument: the string to be expanded
5012 Returns:  the expanded string, or NULL if expansion failed; if failure was
5013           due to a lookup deferring, search_find_defer will be TRUE
5014 */
5015
5016 uschar *
5017 expand_string(uschar *string)
5018 {
5019 search_find_defer = FALSE;
5020 malformed_header = FALSE;
5021 return (Ustrpbrk(string, "$\\") == NULL)? string :
5022   expand_string_internal(string, FALSE, NULL, FALSE);
5023 }
5024
5025
5026
5027 /*************************************************
5028 *              Expand and copy                   *
5029 *************************************************/
5030
5031 /* Now and again we want to expand a string and be sure that the result is in a
5032 new bit of store. This function does that.
5033
5034 Argument: the string to be expanded
5035 Returns:  the expanded string, always in a new bit of store, or NULL
5036 */
5037
5038 uschar *
5039 expand_string_copy(uschar *string)
5040 {
5041 uschar *yield = expand_string(string);
5042 if (yield == string) yield = string_copy(string);
5043 return yield;
5044 }
5045
5046
5047
5048 /*************************************************
5049 *        Expand and interpret as an integer      *
5050 *************************************************/
5051
5052 /* Expand a string, and convert the result into an integer.
5053
5054 Argument: the string to be expanded
5055
5056 Returns:  the integer value, or
5057           -1 for an expansion error               ) in both cases, message in
5058           -2 for an integer interpretation error  ) expand_string_message
5059
5060 */
5061
5062 int
5063 expand_string_integer(uschar *string)
5064 {
5065 long int value;
5066 uschar *s = expand_string(string);
5067 uschar *msg = US"invalid integer \"%s\"";
5068 uschar *endptr;
5069
5070 if (s == NULL) return -1;
5071
5072 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
5073 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
5074 systems, so we set it zero ourselves. */
5075
5076 errno = 0;
5077 value = strtol(CS s, CSS &endptr, 0);
5078
5079 if (endptr == s)
5080   {
5081   msg = US"integer expected but \"%s\" found";
5082   }
5083 else
5084   {
5085   /* Ensure we can cast this down to an int */
5086   if (value > INT_MAX  || value < INT_MIN) errno = ERANGE;
5087
5088   if (errno != ERANGE)
5089     {
5090     if (tolower(*endptr) == 'k')
5091       {
5092       if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
5093         else value *= 1024;
5094       endptr++;
5095       }
5096     else if (tolower(*endptr) == 'm')
5097       {
5098       if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
5099         errno = ERANGE;
5100       else value *= 1024*1024;
5101       endptr++;
5102       }
5103     }
5104   if (errno == ERANGE)
5105     msg = US"absolute value of integer \"%s\" is too large (overflow)";
5106   else
5107     {
5108     while (isspace(*endptr)) endptr++;
5109     if (*endptr == 0) return (int)value;
5110     }
5111   }
5112
5113 expand_string_message = string_sprintf(CS msg, s);
5114 return -2;
5115 }
5116
5117
5118 /*************************************************
5119 **************************************************
5120 *             Stand-alone test program           *
5121 **************************************************
5122 *************************************************/
5123
5124 #ifdef STAND_ALONE
5125
5126
5127 BOOL
5128 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
5129 {
5130 int ovector[3*(EXPAND_MAXN+1)];
5131 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
5132   ovector, sizeof(ovector)/sizeof(int));
5133 BOOL yield = n >= 0;
5134 if (n == 0) n = EXPAND_MAXN + 1;
5135 if (yield)
5136   {
5137   int nn;
5138   expand_nmax = (setup < 0)? 0 : setup + 1;
5139   for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
5140     {
5141     expand_nstring[expand_nmax] = subject + ovector[nn];
5142     expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5143     }
5144   expand_nmax--;
5145   }
5146 return yield;
5147 }
5148
5149
5150 int main(int argc, uschar **argv)
5151 {
5152 int i;
5153 uschar buffer[1024];
5154
5155 debug_selector = D_v;
5156 debug_file = stderr;
5157 debug_fd = fileno(debug_file);
5158 big_buffer = malloc(big_buffer_size);
5159
5160 for (i = 1; i < argc; i++)
5161   {
5162   if (argv[i][0] == '+')
5163     {
5164     debug_trace_memory = 2;
5165     argv[i]++;
5166     }
5167   if (isdigit(argv[i][0]))
5168     debug_selector = Ustrtol(argv[i], NULL, 0);
5169   else
5170     if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
5171         Ustrlen(argv[i]))
5172       {
5173       #ifdef LOOKUP_LDAP
5174       eldap_default_servers = argv[i];
5175       #endif
5176       #ifdef LOOKUP_MYSQL
5177       mysql_servers = argv[i];
5178       #endif
5179       #ifdef LOOKUP_PGSQL
5180       pgsql_servers = argv[i];
5181       #endif
5182       }
5183   #ifdef EXIM_PERL
5184   else opt_perl_startup = argv[i];
5185   #endif
5186   }
5187
5188 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
5189
5190 expand_nstring[1] = US"string 1....";
5191 expand_nlength[1] = 8;
5192 expand_nmax = 1;
5193
5194 #ifdef EXIM_PERL
5195 if (opt_perl_startup != NULL)
5196   {
5197   uschar *errstr;
5198   printf("Starting Perl interpreter\n");
5199   errstr = init_perl(opt_perl_startup);
5200   if (errstr != NULL)
5201     {
5202     printf("** error in perl_startup code: %s\n", errstr);
5203     return EXIT_FAILURE;
5204     }
5205   }
5206 #endif /* EXIM_PERL */
5207
5208 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
5209   {
5210   void *reset_point = store_get(0);
5211   uschar *yield = expand_string(buffer);
5212   if (yield != NULL)
5213     {
5214     printf("%s\n", yield);
5215     store_reset(reset_point);
5216     }
5217   else
5218     {
5219     if (search_find_defer) printf("search_find deferred\n");
5220     printf("Failed: %s\n", expand_string_message);
5221     if (expand_string_forcedfail) printf("Forced failure\n");
5222     printf("\n");
5223     }
5224   }
5225
5226 search_tidyup();
5227
5228 return 0;
5229 }
5230
5231 #endif
5232
5233 /* End of expand.c */