src/src/expand.c

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