src/src/expand.c

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