src/src/expand.c

   1 /* $Cambridge: exim/src/src/expand.c,v 1.51 2005/12/12 15:58:53 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. */
1234
1235 if (Ustrncmp(name, "acl_", 4) == 0)
1236   {
1237   int offset, max, n;
1238   uschar *endptr;
1239
1240   if (name[4] == 'm')
1241     {
1242     offset = ACL_CVARS;
1243     max = ACL_MVARS;
1244     }
1245   else if (name[4] == 'c')
1246     {
1247     offset = 0;
1248     max = ACL_CVARS;
1249     }
1250   else return NULL;
1251
1252   n = Ustrtoul(name + 5, &endptr, 10);
1253   if (*endptr != 0 || n >= max) return NULL;
1254   return (acl_var[offset + n] == NULL)? US"" : acl_var[offset + n];
1255   }
1256
1257 /* For all other variables, search the table */
1258
1259 while (last > first)
1260   {
1261   uschar *s, *domain;
1262   uschar **ss;
1263   int middle = (first + last)/2;
1264   int c = Ustrcmp(name, var_table[middle].name);
1265
1266   if (c > 0) { first = middle + 1; continue; }
1267   if (c < 0) { last = middle; continue; }
1268
1269   /* Found an existing variable. If in skipping state, the value isn't needed,
1270   and we want to avoid processing (such as looking up the host name). */
1271
1272   if (skipping) return US"";
1273
1274   switch (var_table[middle].type)
1275     {
1276 #ifdef EXPERIMENTAL_DOMAINKEYS
1277
1278     case vtype_dk_verify:
1279     if (dk_verify_block == NULL) return US"";
1280     s = NULL;
1281     if (Ustrcmp(var_table[middle].name, "dk_result") == 0)
1282       s = dk_verify_block->result_string;
1283     if (Ustrcmp(var_table[middle].name, "dk_sender") == 0)
1284       s = dk_verify_block->address;
1285     if (Ustrcmp(var_table[middle].name, "dk_sender_domain") == 0)
1286       s = dk_verify_block->domain;
1287     if (Ustrcmp(var_table[middle].name, "dk_sender_local_part") == 0)
1288       s = dk_verify_block->local_part;
1289
1290     if (Ustrcmp(var_table[middle].name, "dk_sender_source") == 0)
1291       switch(dk_verify_block->address_source) {
1292         case DK_EXIM_ADDRESS_NONE: s = US"0"; break;
1293         case DK_EXIM_ADDRESS_FROM_FROM: s = US"from"; break;
1294         case DK_EXIM_ADDRESS_FROM_SENDER: s = US"sender"; break;
1295       }
1296
1297     if (Ustrcmp(var_table[middle].name, "dk_status") == 0)
1298       switch(dk_verify_block->result) {
1299         case DK_EXIM_RESULT_ERR: s = US"error"; break;
1300         case DK_EXIM_RESULT_BAD_FORMAT: s = US"bad format"; break;
1301         case DK_EXIM_RESULT_NO_KEY: s = US"no key"; break;
1302         case DK_EXIM_RESULT_NO_SIGNATURE: s = US"no signature"; break;
1303         case DK_EXIM_RESULT_REVOKED: s = US"revoked"; break;
1304         case DK_EXIM_RESULT_NON_PARTICIPANT: s = US"non-participant"; break;
1305         case DK_EXIM_RESULT_GOOD: s = US"good"; break;
1306         case DK_EXIM_RESULT_BAD: s = US"bad"; break;
1307       }
1308
1309     if (Ustrcmp(var_table[middle].name, "dk_signsall") == 0)
1310       s = (dk_verify_block->signsall)? US"1" : US"0";
1311
1312     if (Ustrcmp(var_table[middle].name, "dk_testing") == 0)
1313       s = (dk_verify_block->testing)? US"1" : US"0";
1314
1315     if (Ustrcmp(var_table[middle].name, "dk_is_signed") == 0)
1316       s = (dk_verify_block->is_signed)? US"1" : US"0";
1317
1318     return (s == NULL)? US"" : s;
1319 #endif
1320
1321     case vtype_filter_int:
1322     if (!filter_running) return NULL;
1323     /* Fall through */
1324     /* VVVVVVVVVVVV */
1325     case vtype_int:
1326     sprintf(CS var_buffer, "%d", *(int *)(var_table[middle].value)); /* Integer */
1327     return var_buffer;
1328
1329     case vtype_ino:
1330     sprintf(CS var_buffer, "%ld", (long int)(*(ino_t *)(var_table[middle].value))); /* Inode */
1331     return var_buffer;
1332
1333     case vtype_gid:
1334     sprintf(CS var_buffer, "%ld", (long int)(*(gid_t *)(var_table[middle].value))); /* gid */
1335     return var_buffer;
1336
1337     case vtype_uid:
1338     sprintf(CS var_buffer, "%ld", (long int)(*(uid_t *)(var_table[middle].value))); /* uid */
1339     return var_buffer;
1340
1341     case vtype_stringptr:                      /* Pointer to string */
1342     s = *((uschar **)(var_table[middle].value));
1343     return (s == NULL)? US"" : s;
1344
1345     case vtype_pid:
1346     sprintf(CS var_buffer, "%d", (int)getpid()); /* pid */
1347     return var_buffer;
1348
1349     case vtype_load_avg:
1350     sprintf(CS var_buffer, "%d", os_getloadavg()); /* load_average */
1351     return var_buffer;
1352
1353     case vtype_host_lookup:                    /* Lookup if not done so */
1354     if (sender_host_name == NULL && sender_host_address != NULL &&
1355         !host_lookup_failed && host_name_lookup() == OK)
1356       host_build_sender_fullhost();
1357     return (sender_host_name == NULL)? US"" : sender_host_name;
1358
1359     case vtype_localpart:                      /* Get local part from address */
1360     s = *((uschar **)(var_table[middle].value));
1361     if (s == NULL) return US"";
1362     domain = Ustrrchr(s, '@');
1363     if (domain == NULL) return s;
1364     if (domain - s > sizeof(var_buffer) - 1)
1365       log_write(0, LOG_MAIN|LOG_PANIC_DIE, "local part longer than %d in "
1366         "string expansion", sizeof(var_buffer));
1367     Ustrncpy(var_buffer, s, domain - s);
1368     var_buffer[domain - s] = 0;
1369     return var_buffer;
1370
1371     case vtype_domain:                         /* Get domain from address */
1372     s = *((uschar **)(var_table[middle].value));
1373     if (s == NULL) return US"";
1374     domain = Ustrrchr(s, '@');
1375     return (domain == NULL)? US"" : domain + 1;
1376
1377     case vtype_msgheaders:
1378     return find_header(NULL, exists_only, newsize, FALSE, NULL);
1379
1380     case vtype_msgbody:                        /* Pointer to msgbody string */
1381     case vtype_msgbody_end:                    /* Ditto, the end of the msg */
1382     ss = (uschar **)(var_table[middle].value);
1383     if (*ss == NULL && deliver_datafile >= 0)  /* Read body when needed */
1384       {
1385       uschar *body;
1386       off_t start_offset = SPOOL_DATA_START_OFFSET;
1387       int len = message_body_visible;
1388       if (len > message_size) len = message_size;
1389       *ss = body = store_malloc(len+1);
1390       body[0] = 0;
1391       if (var_table[middle].type == vtype_msgbody_end)
1392         {
1393         struct stat statbuf;
1394         if (fstat(deliver_datafile, &statbuf) == 0)
1395           {
1396           start_offset = statbuf.st_size - len;
1397           if (start_offset < SPOOL_DATA_START_OFFSET)
1398             start_offset = SPOOL_DATA_START_OFFSET;
1399           }
1400         }
1401       lseek(deliver_datafile, start_offset, SEEK_SET);
1402       len = read(deliver_datafile, body, len);
1403       if (len > 0)
1404         {
1405         body[len] = 0;
1406         while (len > 0)
1407           {
1408           if (body[--len] == '\n' || body[len] == 0) body[len] = ' ';
1409           }
1410         }
1411       }
1412     return (*ss == NULL)? US"" : *ss;
1413
1414     case vtype_todbsdin:                       /* BSD inbox time of day */
1415     return tod_stamp(tod_bsdin);
1416
1417     case vtype_tode:                           /* Unix epoch time of day */
1418     return tod_stamp(tod_epoch);
1419
1420     case vtype_todf:                           /* Full time of day */
1421     return tod_stamp(tod_full);
1422
1423     case vtype_todl:                           /* Log format time of day */
1424     return tod_stamp(tod_log_bare);            /* (without timezone) */
1425
1426     case vtype_todzone:                        /* Time zone offset only */
1427     return tod_stamp(tod_zone);
1428
1429     case vtype_todzulu:                        /* Zulu time */
1430     return tod_stamp(tod_zulu);
1431
1432     case vtype_todlf:                          /* Log file datestamp tod */
1433     return tod_stamp(tod_log_datestamp);
1434
1435     case vtype_reply:                          /* Get reply address */
1436     s = find_header(US"reply-to:", exists_only, newsize, TRUE,
1437       headers_charset);
1438     if (s != NULL) while (isspace(*s)) s++;
1439     if (s == NULL || *s == 0)
1440       {
1441       *newsize = 0;                            /* For the *s==0 case */
1442       s = find_header(US"from:", exists_only, newsize, TRUE, headers_charset);
1443       }
1444     if (s != NULL)
1445       {
1446       uschar *t;
1447       while (isspace(*s)) s++;
1448       for (t = s; *t != 0; t++) if (*t == '\n') *t = ' ';
1449       while (t > s && isspace(t[-1])) t--;
1450       *t = 0;
1451       }
1452     return (s == NULL)? US"" : s;
1453
1454     /* A recipients list is available only during system message filtering,
1455     during ACL processing after DATA, and while expanding pipe commands
1456     generated from a system filter, but not elsewhere. */
1457
1458     case vtype_recipients:
1459     if (!enable_dollar_recipients) return NULL; else
1460       {
1461       int size = 128;
1462       int ptr = 0;
1463       int i;
1464       s = store_get(size);
1465       for (i = 0; i < recipients_count; i++)
1466         {
1467         if (i != 0) s = string_cat(s, &size, &ptr, US", ", 2);
1468         s = string_cat(s, &size, &ptr, recipients_list[i].address,
1469           Ustrlen(recipients_list[i].address));
1470         }
1471       s[ptr] = 0;     /* string_cat() leaves room */
1472       }
1473     return s;
1474
1475     case vtype_pspace:
1476       {
1477       int inodes;
1478       sprintf(CS var_buffer, "%d",
1479         receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes));
1480       }
1481     return var_buffer;
1482
1483     case vtype_pinodes:
1484       {
1485       int inodes;
1486       (void) receive_statvfs(var_table[middle].value == (void *)TRUE, &inodes);
1487       sprintf(CS var_buffer, "%d", inodes);
1488       }
1489     return var_buffer;
1490     }
1491   }
1492
1493 return NULL;          /* Unknown variable name */
1494 }
1495
1496
1497
1498
1499 /*************************************************
1500 *           Read and expand substrings           *
1501 *************************************************/
1502
1503 /* This function is called to read and expand argument substrings for various
1504 expansion items. Some have a minimum requirement that is less than the maximum;
1505 in these cases, the first non-present one is set to NULL.
1506
1507 Arguments:
1508   sub        points to vector of pointers to set
1509   n          maximum number of substrings
1510   m          minimum required
1511   sptr       points to current string pointer
1512   skipping   the skipping flag
1513   check_end  if TRUE, check for final '}'
1514   name       name of item, for error message
1515
1516 Returns:     0 OK; string pointer updated
1517              1 curly bracketing error (too few arguments)
1518              2 too many arguments (only if check_end is set); message set
1519              3 other error (expansion failure)
1520 */
1521
1522 static int
1523 read_subs(uschar **sub, int n, int m, uschar **sptr, BOOL skipping,
1524   BOOL check_end, uschar *name)
1525 {
1526 int i;
1527 uschar *s = *sptr;
1528
1529 while (isspace(*s)) s++;
1530 for (i = 0; i < n; i++)
1531   {
1532   if (*s != '{')
1533     {
1534     if (i < m) return 1;
1535     sub[i] = NULL;
1536     break;
1537     }
1538   sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
1539   if (sub[i] == NULL) return 3;
1540   if (*s++ != '}') return 1;
1541   while (isspace(*s)) s++;
1542   }
1543 if (check_end && *s++ != '}')
1544   {
1545   if (s[-1] == '{')
1546     {
1547     expand_string_message = string_sprintf("Too many arguments for \"%s\" "
1548       "(max is %d)", name, n);
1549     return 2;
1550     }
1551   return 1;
1552   }
1553
1554 *sptr = s;
1555 return 0;
1556 }
1557
1558
1559
1560
1561 /*************************************************
1562 *        Read and evaluate a condition           *
1563 *************************************************/
1564
1565 /*
1566 Arguments:
1567   s        points to the start of the condition text
1568   yield    points to a BOOL to hold the result of the condition test;
1569            if NULL, we are just reading through a condition that is
1570            part of an "or" combination to check syntax, or in a state
1571            where the answer isn't required
1572
1573 Returns:   a pointer to the first character after the condition, or
1574            NULL after an error
1575 */
1576
1577 static uschar *
1578 eval_condition(uschar *s, BOOL *yield)
1579 {
1580 BOOL testfor = TRUE;
1581 BOOL tempcond, combined_cond;
1582 BOOL *subcondptr;
1583 int i, rc, cond_type, roffset;
1584 int num[2];
1585 struct stat statbuf;
1586 uschar name[256];
1587 uschar *sub[4];
1588
1589 const pcre *re;
1590 const uschar *rerror;
1591
1592 for (;;)
1593   {
1594   while (isspace(*s)) s++;
1595   if (*s == '!') { testfor = !testfor; s++; } else break;
1596   }
1597
1598 /* Numeric comparisons are symbolic */
1599
1600 if (*s == '=' || *s == '>' || *s == '<')
1601   {
1602   int p = 0;
1603   name[p++] = *s++;
1604   if (*s == '=')
1605     {
1606     name[p++] = '=';
1607     s++;
1608     }
1609   name[p] = 0;
1610   }
1611
1612 /* All other conditions are named */
1613
1614 else s = read_name(name, 256, s, US"_");
1615
1616 /* If we haven't read a name, it means some non-alpha character is first. */
1617
1618 if (name[0] == 0)
1619   {
1620   expand_string_message = string_sprintf("condition name expected, "
1621     "but found \"%.16s\"", s);
1622   return NULL;
1623   }
1624
1625 /* Find which condition we are dealing with, and switch on it */
1626
1627 cond_type = chop_match(name, cond_table, sizeof(cond_table)/sizeof(uschar *));
1628 switch(cond_type)
1629   {
1630   /* def: tests for a non-empty variable, or for the existence of a header. If
1631   yield == NULL we are in a skipping state, and don't care about the answer. */
1632
1633   case ECOND_DEF:
1634   if (*s != ':')
1635     {
1636     expand_string_message = US"\":\" expected after \"def\"";
1637     return NULL;
1638     }
1639
1640   s = read_name(name, 256, s+1, US"_");
1641
1642   /* Test for a header's existence */
1643
1644   if (Ustrncmp(name, "h_", 2) == 0 ||
1645       Ustrncmp(name, "rh_", 3) == 0 ||
1646       Ustrncmp(name, "bh_", 3) == 0 ||
1647       Ustrncmp(name, "header_", 7) == 0 ||
1648       Ustrncmp(name, "rheader_", 8) == 0 ||
1649       Ustrncmp(name, "bheader_", 8) == 0)
1650     {
1651     s = read_header_name(name, 256, s);
1652     if (yield != NULL) *yield =
1653       (find_header(name, TRUE, NULL, FALSE, NULL) != NULL) == testfor;
1654     }
1655
1656   /* Test for a variable's having a non-empty value. A non-existent variable
1657   causes an expansion failure. */
1658
1659   else
1660     {
1661     uschar *value = find_variable(name, TRUE, yield == NULL, NULL);
1662     if (value == NULL)
1663       {
1664       expand_string_message = (name[0] == 0)?
1665         string_sprintf("variable name omitted after \"def:\"") :
1666         string_sprintf("unknown variable \"%s\" after \"def:\"", name);
1667       return NULL;
1668       }
1669     if (yield != NULL) *yield = (value[0] != 0) == testfor;
1670     }
1671
1672   return s;
1673
1674
1675   /* first_delivery tests for first delivery attempt */
1676
1677   case ECOND_FIRST_DELIVERY:
1678   if (yield != NULL) *yield = deliver_firsttime == testfor;
1679   return s;
1680
1681
1682   /* queue_running tests for any process started by a queue runner */
1683
1684   case ECOND_QUEUE_RUNNING:
1685   if (yield != NULL) *yield = (queue_run_pid != (pid_t)0) == testfor;
1686   return s;
1687
1688
1689   /* exists:  tests for file existence
1690        isip:  tests for any IP address
1691       isip4:  tests for an IPv4 address
1692       isip6:  tests for an IPv6 address
1693         pam:  does PAM authentication
1694      radius:  does RADIUS authentication
1695    ldapauth:  does LDAP authentication
1696     pwcheck:  does Cyrus SASL pwcheck authentication
1697   */
1698
1699   case ECOND_EXISTS:
1700   case ECOND_ISIP:
1701   case ECOND_ISIP4:
1702   case ECOND_ISIP6:
1703   case ECOND_PAM:
1704   case ECOND_RADIUS:
1705   case ECOND_LDAPAUTH:
1706   case ECOND_PWCHECK:
1707
1708   while (isspace(*s)) s++;
1709   if (*s != '{') goto COND_FAILED_CURLY_START;
1710
1711   sub[0] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1712   if (sub[0] == NULL) return NULL;
1713   if (*s++ != '}') goto COND_FAILED_CURLY_END;
1714
1715   if (yield == NULL) return s;   /* No need to run the test if skipping */
1716
1717   switch(cond_type)
1718     {
1719     case ECOND_EXISTS:
1720     if ((expand_forbid & RDO_EXISTS) != 0)
1721       {
1722       expand_string_message = US"File existence tests are not permitted";
1723       return NULL;
1724       }
1725     *yield = (Ustat(sub[0], &statbuf) == 0) == testfor;
1726     break;
1727
1728     case ECOND_ISIP:
1729     case ECOND_ISIP4:
1730     case ECOND_ISIP6:
1731     rc = string_is_ip_address(sub[0], NULL);
1732     *yield = ((cond_type == ECOND_ISIP)? (rc != 0) :
1733              (cond_type == ECOND_ISIP4)? (rc == 4) : (rc == 6)) == testfor;
1734     break;
1735
1736     /* Various authentication tests - all optionally compiled */
1737
1738     case ECOND_PAM:
1739     #ifdef SUPPORT_PAM
1740     rc = auth_call_pam(sub[0], &expand_string_message);
1741     goto END_AUTH;
1742     #else
1743     goto COND_FAILED_NOT_COMPILED;
1744     #endif  /* SUPPORT_PAM */
1745
1746     case ECOND_RADIUS:
1747     #ifdef RADIUS_CONFIG_FILE
1748     rc = auth_call_radius(sub[0], &expand_string_message);
1749     goto END_AUTH;
1750     #else
1751     goto COND_FAILED_NOT_COMPILED;
1752     #endif  /* RADIUS_CONFIG_FILE */
1753
1754     case ECOND_LDAPAUTH:
1755     #ifdef LOOKUP_LDAP
1756       {
1757       /* Just to keep the interface the same */
1758       BOOL do_cache;
1759       int old_pool = store_pool;
1760       store_pool = POOL_SEARCH;
1761       rc = eldapauth_find((void *)(-1), NULL, sub[0], Ustrlen(sub[0]), NULL,
1762         &expand_string_message, &do_cache);
1763       store_pool = old_pool;
1764       }
1765     goto END_AUTH;
1766     #else
1767     goto COND_FAILED_NOT_COMPILED;
1768     #endif  /* LOOKUP_LDAP */
1769
1770     case ECOND_PWCHECK:
1771     #ifdef CYRUS_PWCHECK_SOCKET
1772     rc = auth_call_pwcheck(sub[0], &expand_string_message);
1773     goto END_AUTH;
1774     #else
1775     goto COND_FAILED_NOT_COMPILED;
1776     #endif  /* CYRUS_PWCHECK_SOCKET */
1777
1778     #if defined(SUPPORT_PAM) || defined(RADIUS_CONFIG_FILE) || \
1779         defined(LOOKUP_LDAP) || defined(CYRUS_PWCHECK_SOCKET)
1780     END_AUTH:
1781     if (rc == ERROR || rc == DEFER) return NULL;
1782     *yield = (rc == OK) == testfor;
1783     #endif
1784     }
1785   return s;
1786
1787
1788   /* saslauthd: does Cyrus saslauthd authentication. Four parameters are used:
1789
1790      ${if saslauthd {{username}{password}{service}{realm}}  {yes}[no}}
1791
1792   However, the last two are optional. That is why the whole set is enclosed
1793   in their own set or braces. */
1794
1795   case ECOND_SASLAUTHD:
1796   #ifndef CYRUS_SASLAUTHD_SOCKET
1797   goto COND_FAILED_NOT_COMPILED;
1798   #else
1799   while (isspace(*s)) s++;
1800   if (*s++ != '{') goto COND_FAILED_CURLY_START;
1801   switch(read_subs(sub, 4, 2, &s, yield == NULL, TRUE, US"saslauthd"))
1802     {
1803     case 1: expand_string_message = US"too few arguments or bracketing "
1804       "error for saslauthd";
1805     case 2:
1806     case 3: return NULL;
1807     }
1808   if (sub[2] == NULL) sub[3] = NULL;  /* realm if no service */
1809   if (yield != NULL)
1810     {
1811     int rc;
1812     rc = auth_call_saslauthd(sub[0], sub[1], sub[2], sub[3],
1813       &expand_string_message);
1814     if (rc == ERROR || rc == DEFER) return NULL;
1815     *yield = (rc == OK) == testfor;
1816     }
1817   return s;
1818   #endif /* CYRUS_SASLAUTHD_SOCKET */
1819
1820
1821   /* symbolic operators for numeric and string comparison, and a number of
1822   other operators, all requiring two arguments.
1823
1824   match:             does a regular expression match and sets up the numerical
1825                        variables if it succeeds
1826   match_address:     matches in an address list
1827   match_domain:      matches in a domain list
1828   match_ip:          matches a host list that is restricted to IP addresses
1829   match_local_part:  matches in a local part list
1830   crypteq:           encrypts plaintext and compares against an encrypted text,
1831                        using crypt(), crypt16(), MD5 or SHA-1
1832   */
1833
1834   case ECOND_MATCH:
1835   case ECOND_MATCH_ADDRESS:
1836   case ECOND_MATCH_DOMAIN:
1837   case ECOND_MATCH_IP:
1838   case ECOND_MATCH_LOCAL_PART:
1839   case ECOND_CRYPTEQ:
1840
1841   case ECOND_NUM_L:     /* Numerical comparisons */
1842   case ECOND_NUM_LE:
1843   case ECOND_NUM_E:
1844   case ECOND_NUM_EE:
1845   case ECOND_NUM_G:
1846   case ECOND_NUM_GE:
1847
1848   case ECOND_STR_LT:    /* String comparisons */
1849   case ECOND_STR_LTI:
1850   case ECOND_STR_LE:
1851   case ECOND_STR_LEI:
1852   case ECOND_STR_EQ:
1853   case ECOND_STR_EQI:
1854   case ECOND_STR_GT:
1855   case ECOND_STR_GTI:
1856   case ECOND_STR_GE:
1857   case ECOND_STR_GEI:
1858
1859   for (i = 0; i < 2; i++)
1860     {
1861     while (isspace(*s)) s++;
1862     if (*s != '{')
1863       {
1864       if (i == 0) goto COND_FAILED_CURLY_START;
1865       expand_string_message = string_sprintf("missing 2nd string in {} "
1866         "after \"%s\"", name);
1867       return NULL;
1868       }
1869     sub[i] = expand_string_internal(s+1, TRUE, &s, yield == NULL);
1870     if (sub[i] == NULL) return NULL;
1871     if (*s++ != '}') goto COND_FAILED_CURLY_END;
1872
1873     /* Convert to numerical if required; we know that the names of all the
1874     conditions that compare numbers do not start with a letter. This just saves
1875     checking for them individually. */
1876
1877     if (!isalpha(name[0]))
1878       {
1879       uschar *endptr;
1880       num[i] = (int)Ustrtol((const uschar *)sub[i], &endptr, 10);
1881       if (tolower(*endptr) == 'k')
1882         {
1883         num[i] *= 1024;
1884         endptr++;
1885         }
1886       else if (tolower(*endptr) == 'm')
1887         {
1888         num[i] *= 1024*1024;
1889         endptr++;
1890         }
1891       while (isspace(*endptr)) endptr++;
1892       if (*endptr != 0)
1893         {
1894         expand_string_message = string_sprintf("\"%s\" is not a number",
1895           sub[i]);
1896         return NULL;
1897         }
1898       }
1899     }
1900
1901   /* Result not required */
1902
1903   if (yield == NULL) return s;
1904
1905   /* Do an appropriate comparison */
1906
1907   switch(cond_type)
1908     {
1909     case ECOND_NUM_E:
1910     case ECOND_NUM_EE:
1911     *yield = (num[0] == num[1]) == testfor;
1912     break;
1913
1914     case ECOND_NUM_G:
1915     *yield = (num[0] > num[1]) == testfor;
1916     break;
1917
1918     case ECOND_NUM_GE:
1919     *yield = (num[0] >= num[1]) == testfor;
1920     break;
1921
1922     case ECOND_NUM_L:
1923     *yield = (num[0] < num[1]) == testfor;
1924     break;
1925
1926     case ECOND_NUM_LE:
1927     *yield = (num[0] <= num[1]) == testfor;
1928     break;
1929
1930     case ECOND_STR_LT:
1931     *yield = (Ustrcmp(sub[0], sub[1]) < 0) == testfor;
1932     break;
1933
1934     case ECOND_STR_LTI:
1935     *yield = (strcmpic(sub[0], sub[1]) < 0) == testfor;
1936     break;
1937
1938     case ECOND_STR_LE:
1939     *yield = (Ustrcmp(sub[0], sub[1]) <= 0) == testfor;
1940     break;
1941
1942     case ECOND_STR_LEI:
1943     *yield = (strcmpic(sub[0], sub[1]) <= 0) == testfor;
1944     break;
1945
1946     case ECOND_STR_EQ:
1947     *yield = (Ustrcmp(sub[0], sub[1]) == 0) == testfor;
1948     break;
1949
1950     case ECOND_STR_EQI:
1951     *yield = (strcmpic(sub[0], sub[1]) == 0) == testfor;
1952     break;
1953
1954     case ECOND_STR_GT:
1955     *yield = (Ustrcmp(sub[0], sub[1]) > 0) == testfor;
1956     break;
1957
1958     case ECOND_STR_GTI:
1959     *yield = (strcmpic(sub[0], sub[1]) > 0) == testfor;
1960     break;
1961
1962     case ECOND_STR_GE:
1963     *yield = (Ustrcmp(sub[0], sub[1]) >= 0) == testfor;
1964     break;
1965
1966     case ECOND_STR_GEI:
1967     *yield = (strcmpic(sub[0], sub[1]) >= 0) == testfor;
1968     break;
1969
1970     case ECOND_MATCH:   /* Regular expression match */
1971     re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
1972       NULL);
1973     if (re == NULL)
1974       {
1975       expand_string_message = string_sprintf("regular expression error in "
1976         "\"%s\": %s at offset %d", sub[1], rerror, roffset);
1977       return NULL;
1978       }
1979     *yield = regex_match_and_setup(re, sub[0], 0, -1) == testfor;
1980     break;
1981
1982     case ECOND_MATCH_ADDRESS:  /* Match in an address list */
1983     rc = match_address_list(sub[0], TRUE, FALSE, &(sub[1]), NULL, -1, 0, NULL);
1984     goto MATCHED_SOMETHING;
1985
1986     case ECOND_MATCH_DOMAIN:   /* Match in a domain list */
1987     rc = match_isinlist(sub[0], &(sub[1]), 0, &domainlist_anchor, NULL,
1988       MCL_DOMAIN + MCL_NOEXPAND, TRUE, NULL);
1989     goto MATCHED_SOMETHING;
1990
1991     case ECOND_MATCH_IP:       /* Match IP address in a host list */
1992     if (sub[0][0] != 0 && string_is_ip_address(sub[0], NULL) == 0)
1993       {
1994       expand_string_message = string_sprintf("\"%s\" is not an IP address",
1995         sub[0]);
1996       return NULL;
1997       }
1998     else
1999       {
2000       unsigned int *nullcache = NULL;
2001       check_host_block cb;
2002
2003       cb.host_name = US"";
2004       cb.host_address = sub[0];
2005
2006       /* If the host address starts off ::ffff: it is an IPv6 address in
2007       IPv4-compatible mode. Find the IPv4 part for checking against IPv4
2008       addresses. */
2009
2010       cb.host_ipv4 = (Ustrncmp(cb.host_address, "::ffff:", 7) == 0)?
2011         cb.host_address + 7 : cb.host_address;
2012
2013       rc = match_check_list(
2014              &sub[1],                   /* the list */
2015              0,                         /* separator character */
2016              &hostlist_anchor,          /* anchor pointer */
2017              &nullcache,                /* cache pointer */
2018              check_host,                /* function for testing */
2019              &cb,                       /* argument for function */
2020              MCL_HOST,                  /* type of check */
2021              sub[0],                    /* text for debugging */
2022              NULL);                     /* where to pass back data */
2023       }
2024     goto MATCHED_SOMETHING;
2025
2026     case ECOND_MATCH_LOCAL_PART:
2027     rc = match_isinlist(sub[0], &(sub[1]), 0, &localpartlist_anchor, NULL,
2028       MCL_LOCALPART + MCL_NOEXPAND, TRUE, NULL);
2029     /* Fall through */
2030     /* VVVVVVVVVVVV */
2031     MATCHED_SOMETHING:
2032     switch(rc)
2033       {
2034       case OK:
2035       *yield = testfor;
2036       break;
2037
2038       case FAIL:
2039       *yield = !testfor;
2040       break;
2041
2042       case DEFER:
2043       expand_string_message = string_sprintf("unable to complete match "
2044         "against \"%s\": %s", sub[1], search_error_message);
2045       return NULL;
2046       }
2047
2048     break;
2049
2050     /* Various "encrypted" comparisons. If the second string starts with
2051     "{" then an encryption type is given. Default to crypt() or crypt16()
2052     (build-time choice). */
2053
2054     case ECOND_CRYPTEQ:
2055     #ifndef SUPPORT_CRYPTEQ
2056     goto COND_FAILED_NOT_COMPILED;
2057     #else
2058     if (strncmpic(sub[1], US"{md5}", 5) == 0)
2059       {
2060       int sublen = Ustrlen(sub[1]+5);
2061       md5 base;
2062       uschar digest[16];
2063
2064       md5_start(&base);
2065       md5_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2066
2067       /* If the length that we are comparing against is 24, the MD5 digest
2068       is expressed as a base64 string. This is the way LDAP does it. However,
2069       some other software uses a straightforward hex representation. We assume
2070       this if the length is 32. Other lengths fail. */
2071
2072       if (sublen == 24)
2073         {
2074         uschar *coded = auth_b64encode((uschar *)digest, 16);
2075         DEBUG(D_auth) debug_printf("crypteq: using MD5+B64 hashing\n"
2076           "  subject=%s\n  crypted=%s\n", coded, sub[1]+5);
2077         *yield = (Ustrcmp(coded, sub[1]+5) == 0) == testfor;
2078         }
2079       else if (sublen == 32)
2080         {
2081         int i;
2082         uschar coded[36];
2083         for (i = 0; i < 16; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2084         coded[32] = 0;
2085         DEBUG(D_auth) debug_printf("crypteq: using MD5+hex hashing\n"
2086           "  subject=%s\n  crypted=%s\n", coded, sub[1]+5);
2087         *yield = (strcmpic(coded, sub[1]+5) == 0) == testfor;
2088         }
2089       else
2090         {
2091         DEBUG(D_auth) debug_printf("crypteq: length for MD5 not 24 or 32: "
2092           "fail\n  crypted=%s\n", sub[1]+5);
2093         *yield = !testfor;
2094         }
2095       }
2096
2097     else if (strncmpic(sub[1], US"{sha1}", 6) == 0)
2098       {
2099       int sublen = Ustrlen(sub[1]+6);
2100       sha1 base;
2101       uschar digest[20];
2102
2103       sha1_start(&base);
2104       sha1_end(&base, (uschar *)sub[0], Ustrlen(sub[0]), digest);
2105
2106       /* If the length that we are comparing against is 28, assume the SHA1
2107       digest is expressed as a base64 string. If the length is 40, assume a
2108       straightforward hex representation. Other lengths fail. */
2109
2110       if (sublen == 28)
2111         {
2112         uschar *coded = auth_b64encode((uschar *)digest, 20);
2113         DEBUG(D_auth) debug_printf("crypteq: using SHA1+B64 hashing\n"
2114           "  subject=%s\n  crypted=%s\n", coded, sub[1]+6);
2115         *yield = (Ustrcmp(coded, sub[1]+6) == 0) == testfor;
2116         }
2117       else if (sublen == 40)
2118         {
2119         int i;
2120         uschar coded[44];
2121         for (i = 0; i < 20; i++) sprintf(CS (coded+2*i), "%02X", digest[i]);
2122         coded[40] = 0;
2123         DEBUG(D_auth) debug_printf("crypteq: using SHA1+hex hashing\n"
2124           "  subject=%s\n  crypted=%s\n", coded, sub[1]+6);
2125         *yield = (strcmpic(coded, sub[1]+6) == 0) == testfor;
2126         }
2127       else
2128         {
2129         DEBUG(D_auth) debug_printf("crypteq: length for SHA-1 not 28 or 40: "
2130           "fail\n  crypted=%s\n", sub[1]+6);
2131         *yield = !testfor;
2132         }
2133       }
2134
2135     else   /* {crypt} or {crypt16} and non-{ at start */
2136       {
2137       int which = 0;
2138       uschar *coded;
2139
2140       if (strncmpic(sub[1], US"{crypt}", 7) == 0)
2141         {
2142         sub[1] += 7;
2143         which = 1;
2144         }
2145       else if (strncmpic(sub[1], US"{crypt16}", 9) == 0)
2146         {
2147         sub[1] += 9;
2148         which = 2;
2149         }
2150       else if (sub[1][0] == '{')
2151         {
2152         expand_string_message = string_sprintf("unknown encryption mechanism "
2153           "in \"%s\"", sub[1]);
2154         return NULL;
2155         }
2156
2157       switch(which)
2158         {
2159         case 0:  coded = US DEFAULT_CRYPT(CS sub[0], CS sub[1]); break;
2160         case 1:  coded = US crypt(CS sub[0], CS sub[1]); break;
2161         default: coded = US crypt16(CS sub[0], CS sub[1]); break;
2162         }
2163
2164       #define STR(s) # s
2165       #define XSTR(s) STR(s)
2166       DEBUG(D_auth) debug_printf("crypteq: using %s()\n"
2167         "  subject=%s\n  crypted=%s\n",
2168         (which == 0)? XSTR(DEFAULT_CRYPT) : (which == 1)? "crypt" : "crypt16",
2169         coded, sub[1]);
2170       #undef STR
2171       #undef XSTR
2172
2173       /* If the encrypted string contains fewer than two characters (for the
2174       salt), force failure. Otherwise we get false positives: with an empty
2175       string the yield of crypt() is an empty string! */
2176
2177       *yield = (Ustrlen(sub[1]) < 2)? !testfor :
2178         (Ustrcmp(coded, sub[1]) == 0) == testfor;
2179       }
2180     break;
2181     #endif  /* SUPPORT_CRYPTEQ */
2182     }   /* Switch for comparison conditions */
2183
2184   return s;    /* End of comparison conditions */
2185
2186
2187   /* and/or: computes logical and/or of several conditions */
2188
2189   case ECOND_AND:
2190   case ECOND_OR:
2191   subcondptr = (yield == NULL)? NULL : &tempcond;
2192   combined_cond = (cond_type == ECOND_AND);
2193
2194   while (isspace(*s)) s++;
2195   if (*s++ != '{') goto COND_FAILED_CURLY_START;
2196
2197   for (;;)
2198     {
2199     while (isspace(*s)) s++;
2200     if (*s == '}') break;
2201     if (*s != '{')
2202       {
2203       expand_string_message = string_sprintf("each subcondition "
2204         "inside an \"%s{...}\" condition must be in its own {}", name);
2205       return NULL;
2206       }
2207
2208     s = eval_condition(s+1, subcondptr);
2209     if (s == NULL)
2210       {
2211       expand_string_message = string_sprintf("%s inside \"%s{...}\" condition",
2212         expand_string_message, name);
2213       return NULL;
2214       }
2215     while (isspace(*s)) s++;
2216
2217     if (*s++ != '}')
2218       {
2219       expand_string_message = string_sprintf("missing } at end of condition "
2220         "inside \"%s\" group", name);
2221       return NULL;
2222       }
2223
2224     if (yield != NULL)
2225       {
2226       if (cond_type == ECOND_AND)
2227         {
2228         combined_cond &= tempcond;
2229         if (!combined_cond) subcondptr = NULL;  /* once false, don't */
2230         }                                       /* evaluate any more */
2231       else
2232         {
2233         combined_cond |= tempcond;
2234         if (combined_cond) subcondptr = NULL;   /* once true, don't */
2235         }                                       /* evaluate any more */
2236       }
2237     }
2238
2239   if (yield != NULL) *yield = (combined_cond == testfor);
2240   return ++s;
2241
2242
2243   /* Unknown condition */
2244
2245   default:
2246   expand_string_message = string_sprintf("unknown condition \"%s\"", name);
2247   return NULL;
2248   }   /* End switch on condition type */
2249
2250 /* Missing braces at start and end of data */
2251
2252 COND_FAILED_CURLY_START:
2253 expand_string_message = string_sprintf("missing { after \"%s\"", name);
2254 return NULL;
2255
2256 COND_FAILED_CURLY_END:
2257 expand_string_message = string_sprintf("missing } at end of \"%s\" condition",
2258   name);
2259 return NULL;
2260
2261 /* A condition requires code that is not compiled */
2262
2263 #if !defined(SUPPORT_PAM) || !defined(RADIUS_CONFIG_FILE) || \
2264     !defined(LOOKUP_LDAP) || !defined(CYRUS_PWCHECK_SOCKET) || \
2265     !defined(SUPPORT_CRYPTEQ) || !defined(CYRUS_SASLAUTHD_SOCKET)
2266 COND_FAILED_NOT_COMPILED:
2267 expand_string_message = string_sprintf("support for \"%s\" not compiled",
2268   name);
2269 return NULL;
2270 #endif
2271 }
2272
2273
2274
2275
2276 /*************************************************
2277 *          Save numerical variables              *
2278 *************************************************/
2279
2280 /* This function is called from items such as "if" that want to preserve and
2281 restore the numbered variables.
2282
2283 Arguments:
2284   save_expand_string    points to an array of pointers to set
2285   save_expand_nlength   points to an array of ints for the lengths
2286
2287 Returns:                the value of expand max to save
2288 */
2289
2290 static int
2291 save_expand_strings(uschar **save_expand_nstring, int *save_expand_nlength)
2292 {
2293 int i;
2294 for (i = 0; i <= expand_nmax; i++)
2295   {
2296   save_expand_nstring[i] = expand_nstring[i];
2297   save_expand_nlength[i] = expand_nlength[i];
2298   }
2299 return expand_nmax;
2300 }
2301
2302
2303
2304 /*************************************************
2305 *           Restore numerical variables          *
2306 *************************************************/
2307
2308 /* This function restored saved values of numerical strings.
2309
2310 Arguments:
2311   save_expand_nmax      the number of strings to restore
2312   save_expand_string    points to an array of pointers
2313   save_expand_nlength   points to an array of ints
2314
2315 Returns:                nothing
2316 */
2317
2318 static void
2319 restore_expand_strings(int save_expand_nmax, uschar **save_expand_nstring,
2320   int *save_expand_nlength)
2321 {
2322 int i;
2323 expand_nmax = save_expand_nmax;
2324 for (i = 0; i <= expand_nmax; i++)
2325   {
2326   expand_nstring[i] = save_expand_nstring[i];
2327   expand_nlength[i] = save_expand_nlength[i];
2328   }
2329 }
2330
2331
2332
2333
2334
2335 /*************************************************
2336 *            Handle yes/no substrings            *
2337 *************************************************/
2338
2339 /* This function is used by ${if}, ${lookup} and ${extract} to handle the
2340 alternative substrings that depend on whether or not the condition was true,
2341 or the lookup or extraction succeeded. The substrings always have to be
2342 expanded, to check their syntax, but "skipping" is set when the result is not
2343 needed - this avoids unnecessary nested lookups.
2344
2345 Arguments:
2346   skipping       TRUE if we were skipping when this item was reached
2347   yes            TRUE if the first string is to be used, else use the second
2348   save_lookup    a value to put back into lookup_value before the 2nd expansion
2349   sptr           points to the input string pointer
2350   yieldptr       points to the output string pointer
2351   sizeptr        points to the output string size
2352   ptrptr         points to the output string pointer
2353   type           "lookup" or "if" or "extract" or "run", for error message
2354
2355 Returns:         0 OK; lookup_value has been reset to save_lookup
2356                  1 expansion failed
2357                  2 expansion failed because of bracketing error
2358 */
2359
2360 static int
2361 process_yesno(BOOL skipping, BOOL yes, uschar *save_lookup, uschar **sptr,
2362   uschar **yieldptr, int *sizeptr, int *ptrptr, uschar *type)
2363 {
2364 int rc = 0;
2365 uschar *s = *sptr;    /* Local value */
2366 uschar *sub1, *sub2;
2367
2368 /* If there are no following strings, we substitute the contents of $value for
2369 lookups and for extractions in the success case. For the ${if item, the string
2370 "true" is substituted. In the fail case, nothing is substituted for all three
2371 items. */
2372
2373 while (isspace(*s)) s++;
2374 if (*s == '}')
2375   {
2376   if (type[0] == 'i')
2377     {
2378     if (yes) *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, US"true", 4);
2379     }
2380   else
2381     {
2382     if (yes && lookup_value != NULL)
2383       *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, lookup_value,
2384         Ustrlen(lookup_value));
2385     lookup_value = save_lookup;
2386     }
2387   s++;
2388   goto RETURN;
2389   }
2390
2391 /* The first following string must be braced. */
2392
2393 if (*s++ != '{') goto FAILED_CURLY;
2394
2395 /* Expand the first substring. Forced failures are noticed only if we actually
2396 want this string. Set skipping in the call in the fail case (this will always
2397 be the case if we were already skipping). */
2398
2399 sub1 = expand_string_internal(s, TRUE, &s, !yes);
2400 if (sub1 == NULL && (yes || !expand_string_forcedfail)) goto FAILED;
2401 expand_string_forcedfail = FALSE;
2402 if (*s++ != '}') goto FAILED_CURLY;
2403
2404 /* If we want the first string, add it to the output */
2405
2406 if (yes)
2407   *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub1, Ustrlen(sub1));
2408
2409 /* If this is called from a lookup or an extract, we want to restore $value to
2410 what it was at the start of the item, so that it has this value during the
2411 second string expansion. For the call from "if" or "run" to this function,
2412 save_lookup is set to lookup_value, so that this statement does nothing. */
2413
2414 lookup_value = save_lookup;
2415
2416 /* There now follows either another substring, or "fail", or nothing. This
2417 time, forced failures are noticed only if we want the second string. We must
2418 set skipping in the nested call if we don't want this string, or if we were
2419 already skipping. */
2420
2421 while (isspace(*s)) s++;
2422 if (*s == '{')
2423   {
2424   sub2 = expand_string_internal(s+1, TRUE, &s, yes || skipping);
2425   if (sub2 == NULL && (!yes || !expand_string_forcedfail)) goto FAILED;
2426   expand_string_forcedfail = FALSE;
2427   if (*s++ != '}') goto FAILED_CURLY;
2428
2429   /* If we want the second string, add it to the output */
2430
2431   if (!yes)
2432     *yieldptr = string_cat(*yieldptr, sizeptr, ptrptr, sub2, Ustrlen(sub2));
2433   }
2434
2435 /* If there is no second string, but the word "fail" is present when the use of
2436 the second string is wanted, set a flag indicating it was a forced failure
2437 rather than a syntactic error. Swallow the terminating } in case this is nested
2438 inside another lookup or if or extract. */
2439
2440 else if (*s != '}')
2441   {
2442   uschar name[256];
2443   s = read_name(name, sizeof(name), s, US"_");
2444   if (Ustrcmp(name, "fail") == 0)
2445     {
2446     if (!yes && !skipping)
2447       {
2448       while (isspace(*s)) s++;
2449       if (*s++ != '}') goto FAILED_CURLY;
2450       expand_string_message =
2451         string_sprintf("\"%s\" failed and \"fail\" requested", type);
2452       expand_string_forcedfail = TRUE;
2453       goto FAILED;
2454       }
2455     }
2456   else
2457     {
2458     expand_string_message =
2459       string_sprintf("syntax error in \"%s\" item - \"fail\" expected", type);
2460     goto FAILED;
2461     }
2462   }
2463
2464 /* All we have to do now is to check on the final closing brace. */
2465
2466 while (isspace(*s)) s++;
2467 if (*s++ == '}') goto RETURN;
2468
2469 /* Get here if there is a bracketing failure */
2470
2471 FAILED_CURLY:
2472 rc++;
2473
2474 /* Get here for other failures */
2475
2476 FAILED:
2477 rc++;
2478
2479 /* Update the input pointer value before returning */
2480
2481 RETURN:
2482 *sptr = s;
2483 return rc;
2484 }
2485
2486
2487
2488
2489 /*************************************************
2490 *    Handle MD5 or SHA-1 computation for HMAC    *
2491 *************************************************/
2492
2493 /* These are some wrapping functions that enable the HMAC code to be a bit
2494 cleaner. A good compiler will spot the tail recursion.
2495
2496 Arguments:
2497   type         HMAC_MD5 or HMAC_SHA1
2498   remaining    are as for the cryptographic hash functions
2499
2500 Returns:       nothing
2501 */
2502
2503 static void
2504 chash_start(int type, void *base)
2505 {
2506 if (type == HMAC_MD5)
2507   md5_start((md5 *)base);
2508 else
2509   sha1_start((sha1 *)base);
2510 }
2511
2512 static void
2513 chash_mid(int type, void *base, uschar *string)
2514 {
2515 if (type == HMAC_MD5)
2516   md5_mid((md5 *)base, string);
2517 else
2518   sha1_mid((sha1 *)base, string);
2519 }
2520
2521 static void
2522 chash_end(int type, void *base, uschar *string, int length, uschar *digest)
2523 {
2524 if (type == HMAC_MD5)
2525   md5_end((md5 *)base, string, length, digest);
2526 else
2527   sha1_end((sha1 *)base, string, length, digest);
2528 }
2529
2530
2531
2532
2533
2534 /********************************************************
2535 * prvs: Get last three digits of days since Jan 1, 1970 *
2536 ********************************************************/
2537
2538 /* This is needed to implement the "prvs" BATV reverse
2539    path signing scheme
2540
2541 Argument: integer "days" offset to add or substract to
2542           or from the current number of days.
2543
2544 Returns:  pointer to string containing the last three
2545           digits of the number of days since Jan 1, 1970,
2546           modified by the offset argument, NULL if there
2547           was an error in the conversion.
2548
2549 */
2550
2551 static uschar *
2552 prvs_daystamp(int day_offset)
2553 {
2554 uschar *days = store_get(16);
2555 (void)string_format(days, 16, TIME_T_FMT,
2556   (time(NULL) + day_offset*86400)/86400);
2557 return (Ustrlen(days) >= 3) ? &days[Ustrlen(days)-3] : US"100";
2558 }
2559
2560
2561
2562 /********************************************************
2563 *   prvs: perform HMAC-SHA1 computation of prvs bits    *
2564 ********************************************************/
2565
2566 /* This is needed to implement the "prvs" BATV reverse
2567    path signing scheme
2568
2569 Arguments:
2570   address RFC2821 Address to use
2571       key The key to use (must be less than 64 characters
2572           in size)
2573   key_num Single-digit key number to use. Defaults to
2574           '0' when NULL.
2575
2576 Returns:  pointer to string containing the first three
2577           bytes of the final hash in hex format, NULL if
2578           there was an error in the process.
2579 */
2580
2581 static uschar *
2582 prvs_hmac_sha1(uschar *address, uschar *key, uschar *key_num, uschar *daystamp)
2583 {
2584 uschar *hash_source, *p;
2585 int size = 0,offset = 0,i;
2586 sha1 sha1_base;
2587 void *use_base = &sha1_base;
2588 uschar innerhash[20];
2589 uschar finalhash[20];
2590 uschar innerkey[64];
2591 uschar outerkey[64];
2592 uschar *finalhash_hex = store_get(40);
2593
2594 if (key_num == NULL)
2595   key_num = US"0";
2596
2597 if (Ustrlen(key) > 64)
2598   return NULL;
2599
2600 hash_source = string_cat(NULL,&size,&offset,key_num,1);
2601 string_cat(hash_source,&size,&offset,daystamp,3);
2602 string_cat(hash_source,&size,&offset,address,Ustrlen(address));
2603 hash_source[offset] = '\0';
2604
2605 DEBUG(D_expand) debug_printf("prvs: hash source is '%s'\n", hash_source);
2606
2607 memset(innerkey, 0x36, 64);
2608 memset(outerkey, 0x5c, 64);
2609
2610 for (i = 0; i < Ustrlen(key); i++)
2611   {
2612   innerkey[i] ^= key[i];
2613   outerkey[i] ^= key[i];
2614   }
2615
2616 chash_start(HMAC_SHA1, use_base);
2617 chash_mid(HMAC_SHA1, use_base, innerkey);
2618 chash_end(HMAC_SHA1, use_base, hash_source, offset, innerhash);
2619
2620 chash_start(HMAC_SHA1, use_base);
2621 chash_mid(HMAC_SHA1, use_base, outerkey);
2622 chash_end(HMAC_SHA1, use_base, innerhash, 20, finalhash);
2623
2624 p = finalhash_hex;
2625 for (i = 0; i < 3; i++)
2626   {
2627   *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
2628   *p++ = hex_digits[finalhash[i] & 0x0f];
2629   }
2630 *p = '\0';
2631
2632 return finalhash_hex;
2633 }
2634
2635
2636
2637
2638 /*************************************************
2639 *        Join a file onto the output string      *
2640 *************************************************/
2641
2642 /* This is used for readfile and after a run expansion. It joins the contents
2643 of a file onto the output string, globally replacing newlines with a given
2644 string (optionally). The file is closed at the end.
2645
2646 Arguments:
2647   f            the FILE
2648   yield        pointer to the expandable string
2649   sizep        pointer to the current size
2650   ptrp         pointer to the current position
2651   eol          newline replacement string, or NULL
2652
2653 Returns:       new value of string pointer
2654 */
2655
2656 static uschar *
2657 cat_file(FILE *f, uschar *yield, int *sizep, int *ptrp, uschar *eol)
2658 {
2659 int eollen;
2660 uschar buffer[1024];
2661
2662 eollen = (eol == NULL)? 0 : Ustrlen(eol);
2663
2664 while (Ufgets(buffer, sizeof(buffer), f) != NULL)
2665   {
2666   int len = Ustrlen(buffer);
2667   if (eol != NULL && buffer[len-1] == '\n') len--;
2668   yield = string_cat(yield, sizep, ptrp, buffer, len);
2669   if (buffer[len] != 0)
2670     yield = string_cat(yield, sizep, ptrp, eol, eollen);
2671   }
2672
2673 if (yield != NULL) yield[*ptrp] = 0;
2674
2675 return yield;
2676 }
2677
2678
2679
2680
2681 /*************************************************
2682 *          Evaluate numeric expression           *
2683 *************************************************/
2684
2685 /* This is a set of mutually recursive functions that evaluate a simple
2686 arithmetic expression involving only + - * / and parentheses. The only one that
2687 is called from elsewhere is eval_expr, whose interface is:
2688
2689 Arguments:
2690   sptr          pointer to the pointer to the string - gets updated
2691   decimal       TRUE if numbers are to be assumed decimal
2692   error         pointer to where to put an error message - must be NULL on input
2693   endket        TRUE if ')' must terminate - FALSE for external call
2694
2695
2696 Returns:        on success: the value of the expression, with *error still NULL
2697                 on failure: an undefined value, with *error = a message
2698 */
2699
2700 static int eval_sumterm(uschar **, BOOL, uschar **);
2701
2702 static int
2703 eval_expr(uschar **sptr, BOOL decimal, uschar **error, BOOL endket)
2704 {
2705 uschar *s = *sptr;
2706 int x = eval_sumterm(&s, decimal, error);
2707 if (*error == NULL)
2708   {
2709   while (*s == '+' || *s == '-')
2710     {
2711     int op = *s++;
2712     int y = eval_sumterm(&s, decimal, error);
2713     if (*error != NULL) break;
2714     if (op == '+') x += y; else x -= y;
2715     }
2716   if (*error == NULL)
2717     {
2718     if (endket)
2719       {
2720       if (*s != ')')
2721         *error = US"expecting closing parenthesis";
2722       else
2723         while (isspace(*(++s)));
2724       }
2725     else if (*s != 0) *error = US"expecting + or -";
2726     }
2727   }
2728
2729 *sptr = s;
2730 return x;
2731 }
2732
2733 static int
2734 eval_term(uschar **sptr, BOOL decimal, uschar **error)
2735 {
2736 register int c;
2737 int n;
2738 uschar *s = *sptr;
2739 while (isspace(*s)) s++;
2740 c = *s;
2741 if (isdigit(c) || ((c == '-' || c == '+') && isdigit(s[1])))
2742   {
2743   int count;
2744   (void)sscanf(CS s, (decimal? "%d%n" : "%i%n"), &n, &count);
2745   s += count;
2746   if (tolower(*s) == 'k') { n *= 1024; s++; }
2747     else if (tolower(*s) == 'm') { n *= 1024*1024; s++; }
2748   while (isspace (*s)) s++;
2749   }
2750 else if (c == '(')
2751   {
2752   s++;
2753   n = eval_expr(&s, decimal, error, 1);
2754   }
2755 else
2756   {
2757   *error = US"expecting number or opening parenthesis";
2758   n = 0;
2759   }
2760 *sptr = s;
2761 return n;
2762 }
2763
2764 static int eval_sumterm(uschar **sptr, BOOL decimal, uschar **error)
2765 {
2766 uschar *s = *sptr;
2767 int x = eval_term(&s, decimal, error);
2768 if (*error == NULL)
2769   {
2770   while (*s == '*' || *s == '/' || *s == '%')
2771     {
2772     int op = *s++;
2773     int y = eval_term(&s, decimal, error);
2774     if (*error != NULL) break;
2775     if (op == '*') x *= y;
2776       else if (op == '/') x /= y;
2777       else x %= y;
2778     }
2779   }
2780 *sptr = s;
2781 return x;
2782 }
2783
2784
2785
2786
2787 /*************************************************
2788 *                 Expand string                  *
2789 *************************************************/
2790
2791 /* Returns either an unchanged string, or the expanded string in stacking pool
2792 store. Interpreted sequences are:
2793
2794    \...                    normal escaping rules
2795    $name                   substitutes the variable
2796    ${name}                 ditto
2797    ${op:string}            operates on the expanded string value
2798    ${item{arg1}{arg2}...}  expands the args and then does the business
2799                              some literal args are not enclosed in {}
2800
2801 There are now far too many operators and item types to make it worth listing
2802 them here in detail any more.
2803
2804 We use an internal routine recursively to handle embedded substrings. The
2805 external function follows. The yield is NULL if the expansion failed, and there
2806 are two cases: if something collapsed syntactically, or if "fail" was given
2807 as the action on a lookup failure. These can be distinguised by looking at the
2808 variable expand_string_forcedfail, which is TRUE in the latter case.
2809
2810 The skipping flag is set true when expanding a substring that isn't actually
2811 going to be used (after "if" or "lookup") and it prevents lookups from
2812 happening lower down.
2813
2814 Store usage: At start, a store block of the length of the input plus 64
2815 is obtained. This is expanded as necessary by string_cat(), which might have to
2816 get a new block, or might be able to expand the original. At the end of the
2817 function we can release any store above that portion of the yield block that
2818 was actually used. In many cases this will be optimal.
2819
2820 However: if the first item in the expansion is a variable name or header name,
2821 we reset the store before processing it; if the result is in fresh store, we
2822 use that without copying. This is helpful for expanding strings like
2823 $message_headers which can get very long.
2824
2825 Arguments:
2826   string         the string to be expanded
2827   ket_ends       true if expansion is to stop at }
2828   left           if not NULL, a pointer to the first character after the
2829                  expansion is placed here (typically used with ket_ends)
2830   skipping       TRUE for recursive calls when the value isn't actually going
2831                  to be used (to allow for optimisation)
2832
2833 Returns:         NULL if expansion fails:
2834                    expand_string_forcedfail is set TRUE if failure was forced
2835                    expand_string_message contains a textual error message
2836                  a pointer to the expanded string on success
2837 */
2838
2839 static uschar *
2840 expand_string_internal(uschar *string, BOOL ket_ends, uschar **left,
2841   BOOL skipping)
2842 {
2843 int ptr = 0;
2844 int size = Ustrlen(string)+ 64;
2845 int item_type;
2846 uschar *yield = store_get(size);
2847 uschar *s = string;
2848 uschar *save_expand_nstring[EXPAND_MAXN+1];
2849 int save_expand_nlength[EXPAND_MAXN+1];
2850
2851 expand_string_forcedfail = FALSE;
2852 expand_string_message = US"";
2853
2854 while (*s != 0)
2855   {
2856   uschar *value;
2857   uschar name[256];
2858
2859   /* \ escapes the next character, which must exist, or else
2860   the expansion fails. There's a special escape, \N, which causes
2861   copying of the subject verbatim up to the next \N. Otherwise,
2862   the escapes are the standard set. */
2863
2864   if (*s == '\\')
2865     {
2866     if (s[1] == 0)
2867       {
2868       expand_string_message = US"\\ at end of string";
2869       goto EXPAND_FAILED;
2870       }
2871
2872     if (s[1] == 'N')
2873       {
2874       uschar *t = s + 2;
2875       for (s = t; *s != 0; s++) if (*s == '\\' && s[1] == 'N') break;
2876       yield = string_cat(yield, &size, &ptr, t, s - t);
2877       if (*s != 0) s += 2;
2878       }
2879
2880     else
2881       {
2882       uschar ch[1];
2883       ch[0] = string_interpret_escape(&s);
2884       s++;
2885       yield = string_cat(yield, &size, &ptr, ch, 1);
2886       }
2887
2888     continue;
2889     }
2890
2891   /* Anything other than $ is just copied verbatim, unless we are
2892   looking for a terminating } character. */
2893
2894   if (ket_ends && *s == '}') break;
2895
2896   if (*s != '$')
2897     {
2898     yield = string_cat(yield, &size, &ptr, s++, 1);
2899     continue;
2900     }
2901
2902   /* No { after the $ - must be a plain name or a number for string
2903   match variable. There has to be a fudge for variables that are the
2904   names of header fields preceded by "$header_" because header field
2905   names can contain any printing characters except space and colon.
2906   For those that don't like typing this much, "$h_" is a synonym for
2907   "$header_". A non-existent header yields a NULL value; nothing is
2908   inserted. */
2909
2910   if (isalpha((*(++s))))
2911     {
2912     int len;
2913     int newsize = 0;
2914
2915     s = read_name(name, sizeof(name), s, US"_");
2916
2917     /* If this is the first thing to be expanded, release the pre-allocated
2918     buffer. */
2919
2920     if (ptr == 0 && yield != NULL)
2921       {
2922       store_reset(yield);
2923       yield = NULL;
2924       size = 0;
2925       }
2926
2927     /* Header */
2928
2929     if (Ustrncmp(name, "h_", 2) == 0 ||
2930         Ustrncmp(name, "rh_", 3) == 0 ||
2931         Ustrncmp(name, "bh_", 3) == 0 ||
2932         Ustrncmp(name, "header_", 7) == 0 ||
2933         Ustrncmp(name, "rheader_", 8) == 0 ||
2934         Ustrncmp(name, "bheader_", 8) == 0)
2935       {
2936       BOOL want_raw = (name[0] == 'r')? TRUE : FALSE;
2937       uschar *charset = (name[0] == 'b')? NULL : headers_charset;
2938       s = read_header_name(name, sizeof(name), s);
2939       value = find_header(name, FALSE, &newsize, want_raw, charset);
2940
2941       /* If we didn't find the header, and the header contains a closing brace
2942       characters, this may be a user error where the terminating colon
2943       has been omitted. Set a flag to adjust the error message in this case.
2944       But there is no error here - nothing gets inserted. */
2945
2946       if (value == NULL)
2947         {
2948         if (Ustrchr(name, '}') != NULL) malformed_header = TRUE;
2949         continue;
2950         }
2951       }
2952
2953     /* Variable */
2954
2955     else
2956       {
2957       value = find_variable(name, FALSE, skipping, &newsize);
2958       if (value == NULL)
2959         {
2960         expand_string_message =
2961           string_sprintf("unknown variable name \"%s\"", name);
2962         goto EXPAND_FAILED;
2963         }
2964       }
2965
2966     /* If the data is known to be in a new buffer, newsize will be set to the
2967     size of that buffer. If this is the first thing in an expansion string,
2968     yield will be NULL; just point it at the new store instead of copying. Many
2969     expansion strings contain just one reference, so this is a useful
2970     optimization, especially for humungous headers. */
2971
2972     len = Ustrlen(value);
2973     if (yield == NULL && newsize != 0)
2974       {
2975       yield = value;
2976       size = newsize;
2977       ptr = len;
2978       }
2979     else yield = string_cat(yield, &size, &ptr, value, len);
2980
2981     continue;
2982     }
2983
2984   if (isdigit(*s))
2985     {
2986     int n;
2987     s = read_number(&n, s);
2988     if (n >= 0 && n <= expand_nmax)
2989       yield = string_cat(yield, &size, &ptr, expand_nstring[n],
2990         expand_nlength[n]);
2991     continue;
2992     }
2993
2994   /* Otherwise, if there's no '{' after $ it's an error. */
2995
2996   if (*s != '{')
2997     {
2998     expand_string_message = US"$ not followed by letter, digit, or {";
2999     goto EXPAND_FAILED;
3000     }
3001
3002   /* After { there can be various things, but they all start with
3003   an initial word, except for a number for a string match variable. */
3004
3005   if (isdigit((*(++s))))
3006     {
3007     int n;
3008     s = read_number(&n, s);
3009     if (*s++ != '}')
3010       {
3011       expand_string_message = US"} expected after number";
3012       goto EXPAND_FAILED;
3013       }
3014     if (n >= 0 && n <= expand_nmax)
3015       yield = string_cat(yield, &size, &ptr, expand_nstring[n],
3016         expand_nlength[n]);
3017     continue;
3018     }
3019
3020   if (!isalpha(*s))
3021     {
3022     expand_string_message = US"letter or digit expected after ${";
3023     goto EXPAND_FAILED;
3024     }
3025
3026   /* Allow "-" in names to cater for substrings with negative
3027   arguments. Since we are checking for known names after { this is
3028   OK. */
3029
3030   s = read_name(name, sizeof(name), s, US"_-");
3031   item_type = chop_match(name, item_table, sizeof(item_table)/sizeof(uschar *));
3032
3033   switch(item_type)
3034     {
3035     /* Handle conditionals - preserve the values of the numerical expansion
3036     variables in case they get changed by a regular expression match in the
3037     condition. If not, they retain their external settings. At the end
3038     of this "if" section, they get restored to their previous values. */
3039
3040     case EITEM_IF:
3041       {
3042       BOOL cond = FALSE;
3043       uschar *next_s;
3044       int save_expand_nmax =
3045         save_expand_strings(save_expand_nstring, save_expand_nlength);
3046
3047       while (isspace(*s)) s++;
3048       next_s = eval_condition(s, skipping? NULL : &cond);
3049       if (next_s == NULL) goto EXPAND_FAILED;  /* message already set */
3050
3051       DEBUG(D_expand)
3052         debug_printf("condition: %.*s\n   result: %s\n", (int)(next_s - s), s,
3053           cond? "true" : "false");
3054
3055       s = next_s;
3056
3057       /* The handling of "yes" and "no" result strings is now in a separate
3058       function that is also used by ${lookup} and ${extract} and ${run}. */
3059
3060       switch(process_yesno(
3061                skipping,                     /* were previously skipping */
3062                cond,                         /* success/failure indicator */
3063                lookup_value,                 /* value to reset for string2 */
3064                &s,                           /* input pointer */
3065                &yield,                       /* output pointer */
3066                &size,                        /* output size */
3067                &ptr,                         /* output current point */
3068                US"if"))                      /* condition type */
3069         {
3070         case 1: goto EXPAND_FAILED;          /* when all is well, the */
3071         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
3072         }
3073
3074       /* Restore external setting of expansion variables for continuation
3075       at this level. */
3076
3077       restore_expand_strings(save_expand_nmax, save_expand_nstring,
3078         save_expand_nlength);
3079       continue;
3080       }
3081
3082     /* Handle database lookups unless locked out. If "skipping" is TRUE, we are
3083     expanding an internal string that isn't actually going to be used. All we
3084     need to do is check the syntax, so don't do a lookup at all. Preserve the
3085     values of the numerical expansion variables in case they get changed by a
3086     partial lookup. If not, they retain their external settings. At the end
3087     of this "lookup" section, they get restored to their previous values. */
3088
3089     case EITEM_LOOKUP:
3090       {
3091       int stype, partial, affixlen, starflags;
3092       int expand_setup = 0;
3093       int nameptr = 0;
3094       uschar *key, *filename, *affix;
3095       uschar *save_lookup_value = lookup_value;
3096       int save_expand_nmax =
3097         save_expand_strings(save_expand_nstring, save_expand_nlength);
3098
3099       if ((expand_forbid & RDO_LOOKUP) != 0)
3100         {
3101         expand_string_message = US"lookup expansions are not permitted";
3102         goto EXPAND_FAILED;
3103         }
3104
3105       /* Get the key we are to look up for single-key+file style lookups.
3106       Otherwise set the key NULL pro-tem. */
3107
3108       while (isspace(*s)) s++;
3109       if (*s == '{')
3110         {
3111         key = expand_string_internal(s+1, TRUE, &s, skipping);
3112         if (key == NULL) goto EXPAND_FAILED;
3113         if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3114         while (isspace(*s)) s++;
3115         }
3116       else key = NULL;
3117
3118       /* Find out the type of database */
3119
3120       if (!isalpha(*s))
3121         {
3122         expand_string_message = US"missing lookup type";
3123         goto EXPAND_FAILED;
3124         }
3125
3126       /* The type is a string that may contain special characters of various
3127       kinds. Allow everything except space or { to appear; the actual content
3128       is checked by search_findtype_partial. */
3129
3130       while (*s != 0 && *s != '{' && !isspace(*s))
3131         {
3132         if (nameptr < sizeof(name) - 1) name[nameptr++] = *s;
3133         s++;
3134         }
3135       name[nameptr] = 0;
3136       while (isspace(*s)) s++;
3137
3138       /* Now check for the individual search type and any partial or default
3139       options. Only those types that are actually in the binary are valid. */
3140
3141       stype = search_findtype_partial(name, &partial, &affix, &affixlen,
3142         &starflags);
3143       if (stype < 0)
3144         {
3145         expand_string_message = search_error_message;
3146         goto EXPAND_FAILED;
3147         }
3148
3149       /* Check that a key was provided for those lookup types that need it,
3150       and was not supplied for those that use the query style. */
3151
3152       if (!mac_islookup(stype, lookup_querystyle|lookup_absfilequery))
3153         {
3154         if (key == NULL)
3155           {
3156           expand_string_message = string_sprintf("missing {key} for single-"
3157             "key \"%s\" lookup", name);
3158           goto EXPAND_FAILED;
3159           }
3160         }
3161       else
3162         {
3163         if (key != NULL)
3164           {
3165           expand_string_message = string_sprintf("a single key was given for "
3166             "lookup type \"%s\", which is not a single-key lookup type", name);
3167           goto EXPAND_FAILED;
3168           }
3169         }
3170
3171       /* Get the next string in brackets and expand it. It is the file name for
3172       single-key+file lookups, and the whole query otherwise. In the case of
3173       queries that also require a file name (e.g. sqlite), the file name comes
3174       first. */
3175
3176       if (*s != '{') goto EXPAND_FAILED_CURLY;
3177       filename = expand_string_internal(s+1, TRUE, &s, skipping);
3178       if (filename == NULL) goto EXPAND_FAILED;
3179       if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3180       while (isspace(*s)) s++;
3181
3182       /* If this isn't a single-key+file lookup, re-arrange the variables
3183       to be appropriate for the search_ functions. For query-style lookups,
3184       there is just a "key", and no file name. For the special query-style +
3185       file types, the query (i.e. "key") starts with a file name. */
3186
3187       if (key == NULL)
3188         {
3189         while (isspace(*filename)) filename++;
3190         key = filename;
3191
3192         if (mac_islookup(stype, lookup_querystyle))
3193           {
3194           filename = NULL;
3195           }
3196         else
3197           {
3198           if (*filename != '/')
3199             {
3200             expand_string_message = string_sprintf(
3201               "absolute file name expected for \"%s\" lookup", name);
3202             goto EXPAND_FAILED;
3203             }
3204           while (*key != 0 && !isspace(*key)) key++;
3205           if (*key != 0) *key++ = 0;
3206           }
3207         }
3208
3209       /* If skipping, don't do the next bit - just lookup_value == NULL, as if
3210       the entry was not found. Note that there is no search_close() function.
3211       Files are left open in case of re-use. At suitable places in higher logic,
3212       search_tidyup() is called to tidy all open files. This can save opening
3213       the same file several times. However, files may also get closed when
3214       others are opened, if too many are open at once. The rule is that a
3215       handle should not be used after a second search_open().
3216
3217       Request that a partial search sets up $1 and maybe $2 by passing
3218       expand_setup containing zero. If its value changes, reset expand_nmax,
3219       since new variables will have been set. Note that at the end of this
3220       "lookup" section, the old numeric variables are restored. */
3221
3222       if (skipping)
3223         lookup_value = NULL;
3224       else
3225         {
3226         void *handle = search_open(filename, stype, 0, NULL, NULL);
3227         if (handle == NULL)
3228           {
3229           expand_string_message = search_error_message;
3230           goto EXPAND_FAILED;
3231           }
3232         lookup_value = search_find(handle, filename, key, partial, affix,
3233           affixlen, starflags, &expand_setup);
3234         if (search_find_defer)
3235           {
3236           expand_string_message =
3237             string_sprintf("lookup of \"%s\" gave DEFER: %s", key,
3238               search_error_message);
3239           goto EXPAND_FAILED;
3240           }
3241         if (expand_setup > 0) expand_nmax = expand_setup;
3242         }
3243
3244       /* The handling of "yes" and "no" result strings is now in a separate
3245       function that is also used by ${if} and ${extract}. */
3246
3247       switch(process_yesno(
3248                skipping,                     /* were previously skipping */
3249                lookup_value != NULL,         /* success/failure indicator */
3250                save_lookup_value,            /* value to reset for string2 */
3251                &s,                           /* input pointer */
3252                &yield,                       /* output pointer */
3253                &size,                        /* output size */
3254                &ptr,                         /* output current point */
3255                US"lookup"))                  /* condition type */
3256         {
3257         case 1: goto EXPAND_FAILED;          /* when all is well, the */
3258         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
3259         }
3260
3261       /* Restore external setting of expansion variables for carrying on
3262       at this level, and continue. */
3263
3264       restore_expand_strings(save_expand_nmax, save_expand_nstring,
3265         save_expand_nlength);
3266       continue;
3267       }
3268
3269     /* If Perl support is configured, handle calling embedded perl subroutines,
3270     unless locked out at this time. Syntax is ${perl{sub}} or ${perl{sub}{arg}}
3271     or ${perl{sub}{arg1}{arg2}} or up to a maximum of EXIM_PERL_MAX_ARGS
3272     arguments (defined below). */
3273
3274     #define EXIM_PERL_MAX_ARGS 8
3275
3276     case EITEM_PERL:
3277     #ifndef EXIM_PERL
3278     expand_string_message = US"\"${perl\" encountered, but this facility "
3279       "is not included in this binary";
3280     goto EXPAND_FAILED;
3281
3282     #else   /* EXIM_PERL */
3283       {
3284       uschar *sub_arg[EXIM_PERL_MAX_ARGS + 2];
3285       uschar *new_yield;
3286
3287       if ((expand_forbid & RDO_PERL) != 0)
3288         {
3289         expand_string_message = US"Perl calls are not permitted";
3290         goto EXPAND_FAILED;
3291         }
3292
3293       switch(read_subs(sub_arg, EXIM_PERL_MAX_ARGS + 1, 1, &s, skipping, TRUE,
3294            US"perl"))
3295         {
3296         case 1: goto EXPAND_FAILED_CURLY;
3297         case 2:
3298         case 3: goto EXPAND_FAILED;
3299         }
3300
3301       /* If skipping, we don't actually do anything */
3302
3303       if (skipping) continue;
3304
3305       /* Start the interpreter if necessary */
3306
3307       if (!opt_perl_started)
3308         {
3309         uschar *initerror;
3310         if (opt_perl_startup == NULL)
3311           {
3312           expand_string_message = US"A setting of perl_startup is needed when "
3313             "using the Perl interpreter";
3314           goto EXPAND_FAILED;
3315           }
3316         DEBUG(D_any) debug_printf("Starting Perl interpreter\n");
3317         initerror = init_perl(opt_perl_startup);
3318         if (initerror != NULL)
3319           {
3320           expand_string_message =
3321             string_sprintf("error in perl_startup code: %s\n", initerror);
3322           goto EXPAND_FAILED;
3323           }
3324         opt_perl_started = TRUE;
3325         }
3326
3327       /* Call the function */
3328
3329       sub_arg[EXIM_PERL_MAX_ARGS + 1] = NULL;
3330       new_yield = call_perl_cat(yield, &size, &ptr, &expand_string_message,
3331         sub_arg[0], sub_arg + 1);
3332
3333       /* NULL yield indicates failure; if the message pointer has been set to
3334       NULL, the yield was undef, indicating a forced failure. Otherwise the
3335       message will indicate some kind of Perl error. */
3336
3337       if (new_yield == NULL)
3338         {
3339         if (expand_string_message == NULL)
3340           {
3341           expand_string_message =
3342             string_sprintf("Perl subroutine \"%s\" returned undef to force "
3343               "failure", sub_arg[0]);
3344           expand_string_forcedfail = TRUE;
3345           }
3346         goto EXPAND_FAILED;
3347         }
3348
3349       /* Yield succeeded. Ensure forcedfail is unset, just in case it got
3350       set during a callback from Perl. */
3351
3352       expand_string_forcedfail = FALSE;
3353       yield = new_yield;
3354       continue;
3355       }
3356     #endif /* EXIM_PERL */
3357
3358     /* Transform email address to "prvs" scheme to use
3359        as BATV-signed return path */
3360
3361     case EITEM_PRVS:
3362       {
3363       uschar *sub_arg[3];
3364       uschar *p,*domain;
3365
3366       switch(read_subs(sub_arg, 3, 2, &s, skipping, TRUE, US"prvs"))
3367         {
3368         case 1: goto EXPAND_FAILED_CURLY;
3369         case 2:
3370         case 3: goto EXPAND_FAILED;
3371         }
3372
3373       /* If skipping, we don't actually do anything */
3374       if (skipping) continue;
3375
3376       /* sub_arg[0] is the address */
3377       domain = Ustrrchr(sub_arg[0],'@');
3378       if ( (domain == NULL) || (domain == sub_arg[0]) || (Ustrlen(domain) == 1) )
3379         {
3380         expand_string_message = US"prvs first argument must be a qualified email address";
3381         goto EXPAND_FAILED;
3382         }
3383
3384       /* Calculate the hash. The second argument must be a single-digit
3385       key number, or unset. */
3386
3387       if (sub_arg[2] != NULL &&
3388           (!isdigit(sub_arg[2][0]) || sub_arg[2][1] != 0))
3389         {
3390         expand_string_message = US"prvs second argument must be a single digit";
3391         goto EXPAND_FAILED;
3392         }
3393
3394       p = prvs_hmac_sha1(sub_arg[0],sub_arg[1],sub_arg[2],prvs_daystamp(7));
3395       if (p == NULL)
3396         {
3397         expand_string_message = US"prvs hmac-sha1 conversion failed";
3398         goto EXPAND_FAILED;
3399         }
3400
3401       /* Now separate the domain from the local part */
3402       *domain++ = '\0';
3403
3404       yield = string_cat(yield,&size,&ptr,US"prvs=",5);
3405       string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
3406       string_cat(yield,&size,&ptr,US"/",1);
3407       string_cat(yield,&size,&ptr,(sub_arg[2] != NULL) ? sub_arg[2] : US"0", 1);
3408       string_cat(yield,&size,&ptr,prvs_daystamp(7),3);
3409       string_cat(yield,&size,&ptr,p,6);
3410       string_cat(yield,&size,&ptr,US"@",1);
3411       string_cat(yield,&size,&ptr,domain,Ustrlen(domain));
3412
3413       continue;
3414       }
3415
3416     /* Check a prvs-encoded address for validity */
3417
3418     case EITEM_PRVSCHECK:
3419       {
3420       uschar *sub_arg[3];
3421       int mysize = 0, myptr = 0;
3422       const pcre *re;
3423       uschar *p;
3424
3425       /* TF: Ugliness: We want to expand parameter 1 first, then set
3426          up expansion variables that are used in the expansion of
3427          parameter 2. So we clone the string for the first
3428          expansion, where we only expand parameter 1.
3429
3430          PH: Actually, that isn't necessary. The read_subs() function is
3431          designed to work this way for the ${if and ${lookup expansions. I've
3432          tidied the code.
3433       */
3434
3435       /* Reset expansion variables */
3436       prvscheck_result = NULL;
3437       prvscheck_address = NULL;
3438       prvscheck_keynum = NULL;
3439
3440       switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
3441         {
3442         case 1: goto EXPAND_FAILED_CURLY;
3443         case 2:
3444         case 3: goto EXPAND_FAILED;
3445         }
3446
3447       re = regex_must_compile(US"^prvs\\=(.+)\\/([0-9])([0-9]{3})([A-F0-9]{6})\\@(.+)$",
3448                               TRUE,FALSE);
3449
3450       if (regex_match_and_setup(re,sub_arg[0],0,-1))
3451         {
3452         uschar *local_part = string_copyn(expand_nstring[1],expand_nlength[1]);
3453         uschar *key_num = string_copyn(expand_nstring[2],expand_nlength[2]);
3454         uschar *daystamp = string_copyn(expand_nstring[3],expand_nlength[3]);
3455         uschar *hash = string_copyn(expand_nstring[4],expand_nlength[4]);
3456         uschar *domain = string_copyn(expand_nstring[5],expand_nlength[5]);
3457
3458         DEBUG(D_expand) debug_printf("prvscheck localpart: %s\n", local_part);
3459         DEBUG(D_expand) debug_printf("prvscheck key number: %s\n", key_num);
3460         DEBUG(D_expand) debug_printf("prvscheck daystamp: %s\n", daystamp);
3461         DEBUG(D_expand) debug_printf("prvscheck hash: %s\n", hash);
3462         DEBUG(D_expand) debug_printf("prvscheck domain: %s\n", domain);
3463
3464         /* Set up expansion variables */
3465         prvscheck_address = string_cat(NULL, &mysize, &myptr, local_part, Ustrlen(local_part));
3466         string_cat(prvscheck_address,&mysize,&myptr,US"@",1);
3467         string_cat(prvscheck_address,&mysize,&myptr,domain,Ustrlen(domain));
3468         prvscheck_address[myptr] = '\0';
3469         prvscheck_keynum = string_copy(key_num);
3470
3471         /* Now expand the second argument */
3472         switch(read_subs(sub_arg, 1, 1, &s, skipping, FALSE, US"prvs"))
3473           {
3474           case 1: goto EXPAND_FAILED_CURLY;
3475           case 2:
3476           case 3: goto EXPAND_FAILED;
3477           }
3478
3479         /* Now we have the key and can check the address. */
3480
3481         p = prvs_hmac_sha1(prvscheck_address, sub_arg[0], prvscheck_keynum,
3482           daystamp);
3483
3484         if (p == NULL)
3485           {
3486           expand_string_message = US"hmac-sha1 conversion failed";
3487           goto EXPAND_FAILED;
3488           }
3489
3490         DEBUG(D_expand) debug_printf("prvscheck: received hash is %s\n", hash);
3491         DEBUG(D_expand) debug_printf("prvscheck:      own hash is %s\n", p);
3492
3493         if (Ustrcmp(p,hash) == 0)
3494           {
3495           /* Success, valid BATV address. Now check the expiry date. */
3496           uschar *now = prvs_daystamp(0);
3497           unsigned int inow = 0,iexpire = 1;
3498
3499           (void)sscanf(CS now,"%u",&inow);
3500           (void)sscanf(CS daystamp,"%u",&iexpire);
3501
3502           /* When "iexpire" is < 7, a "flip" has occured.
3503              Adjust "inow" accordingly. */
3504           if ( (iexpire < 7) && (inow >= 993) ) inow = 0;
3505
3506           if (iexpire > inow)
3507             {
3508             prvscheck_result = US"1";
3509             DEBUG(D_expand) debug_printf("prvscheck: success, $pvrs_result set to 1\n");
3510             }
3511             else
3512             {
3513             prvscheck_result = NULL;
3514             DEBUG(D_expand) debug_printf("prvscheck: signature expired, $pvrs_result unset\n");
3515             }
3516           }
3517         else
3518           {
3519           prvscheck_result = NULL;
3520           DEBUG(D_expand) debug_printf("prvscheck: hash failure, $pvrs_result unset\n");
3521           }
3522
3523         /* Now expand the final argument. We leave this till now so that
3524         it can include $prvscheck_result. */
3525
3526         switch(read_subs(sub_arg, 1, 0, &s, skipping, TRUE, US"prvs"))
3527           {
3528           case 1: goto EXPAND_FAILED_CURLY;
3529           case 2:
3530           case 3: goto EXPAND_FAILED;
3531           }
3532
3533         if (sub_arg[0] == NULL || *sub_arg[0] == '\0')
3534           yield = string_cat(yield,&size,&ptr,prvscheck_address,Ustrlen(prvscheck_address));
3535         else
3536           yield = string_cat(yield,&size,&ptr,sub_arg[0],Ustrlen(sub_arg[0]));
3537
3538         /* Reset the "internal" variables afterwards, because they are in
3539         dynamic store that will be reclaimed if the expansion succeeded. */
3540
3541         prvscheck_address = NULL;
3542         prvscheck_keynum = NULL;
3543         }
3544       else
3545         {
3546         /* Does not look like a prvs encoded address, return the empty string.
3547            We need to make sure all subs are expanded first, so as to skip over
3548            the entire item. */
3549
3550         switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"prvs"))
3551           {
3552           case 1: goto EXPAND_FAILED_CURLY;
3553           case 2:
3554           case 3: goto EXPAND_FAILED;
3555           }
3556         }
3557
3558       continue;
3559       }
3560
3561     /* Handle "readfile" to insert an entire file */
3562
3563     case EITEM_READFILE:
3564       {
3565       FILE *f;
3566       uschar *sub_arg[2];
3567
3568       if ((expand_forbid & RDO_READFILE) != 0)
3569         {
3570         expand_string_message = US"file insertions are not permitted";
3571         goto EXPAND_FAILED;
3572         }
3573
3574       switch(read_subs(sub_arg, 2, 1, &s, skipping, TRUE, US"readfile"))
3575         {
3576         case 1: goto EXPAND_FAILED_CURLY;
3577         case 2:
3578         case 3: goto EXPAND_FAILED;
3579         }
3580
3581       /* If skipping, we don't actually do anything */
3582
3583       if (skipping) continue;
3584
3585       /* Open the file and read it */
3586
3587       f = Ufopen(sub_arg[0], "rb");
3588       if (f == NULL)
3589         {
3590         expand_string_message = string_open_failed(errno, "%s", sub_arg[0]);
3591         goto EXPAND_FAILED;
3592         }
3593
3594       yield = cat_file(f, yield, &size, &ptr, sub_arg[1]);
3595       (void)fclose(f);
3596       continue;
3597       }
3598
3599     /* Handle "readsocket" to insert data from a Unix domain socket */
3600
3601     case EITEM_READSOCK:
3602       {
3603       int fd;
3604       int timeout = 5;
3605       int save_ptr = ptr;
3606       FILE *f;
3607       struct sockaddr_un sockun;         /* don't call this "sun" ! */
3608       uschar *arg;
3609       uschar *sub_arg[4];
3610
3611       if ((expand_forbid & RDO_READSOCK) != 0)
3612         {
3613         expand_string_message = US"socket insertions are not permitted";
3614         goto EXPAND_FAILED;
3615         }
3616
3617       /* Read up to 4 arguments, but don't do the end of item check afterwards,
3618       because there may be a string for expansion on failure. */
3619
3620       switch(read_subs(sub_arg, 4, 2, &s, skipping, FALSE, US"readsocket"))
3621         {
3622         case 1: goto EXPAND_FAILED_CURLY;
3623         case 2:                             /* Won't occur: no end check */
3624         case 3: goto EXPAND_FAILED;
3625         }
3626
3627       /* Sort out timeout, if given */
3628
3629       if (sub_arg[2] != NULL)
3630         {
3631         timeout = readconf_readtime(sub_arg[2], 0, FALSE);
3632         if (timeout < 0)
3633           {
3634           expand_string_message = string_sprintf("bad time value %s",
3635             sub_arg[2]);
3636           goto EXPAND_FAILED;
3637           }
3638         }
3639       else sub_arg[3] = NULL;                     /* No eol if no timeout */
3640
3641       /* If skipping, we don't actually do anything */
3642
3643       if (!skipping)
3644         {
3645         /* Make a connection to the socket */
3646
3647         if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) == -1)
3648           {
3649           expand_string_message = string_sprintf("failed to create socket: %s",
3650             strerror(errno));
3651           goto SOCK_FAIL;
3652           }
3653
3654         sockun.sun_family = AF_UNIX;
3655         sprintf(sockun.sun_path, "%.*s", (int)(sizeof(sockun.sun_path)-1),
3656           sub_arg[0]);
3657         if(connect(fd, (struct sockaddr *)(&sockun), sizeof(sockun)) == -1)
3658           {
3659           expand_string_message = string_sprintf("failed to connect to socket "
3660             "%s: %s", sub_arg[0], strerror(errno));
3661           goto SOCK_FAIL;
3662           }
3663         DEBUG(D_expand) debug_printf("connected to socket %s\n", sub_arg[0]);
3664
3665         /* Write the request string, if not empty */
3666
3667         if (sub_arg[1][0] != 0)
3668           {
3669           int len = Ustrlen(sub_arg[1]);
3670           DEBUG(D_expand) debug_printf("writing \"%s\" to socket\n",
3671             sub_arg[1]);
3672           if (write(fd, sub_arg[1], len) != len)
3673             {
3674             expand_string_message = string_sprintf("request write to socket "
3675               "failed: %s", strerror(errno));
3676             goto SOCK_FAIL;
3677             }
3678           }
3679
3680         /* Now we need to read from the socket, under a timeout. The function
3681         that reads a file can be used. */
3682
3683         f = fdopen(fd, "rb");
3684         sigalrm_seen = FALSE;
3685         alarm(timeout);
3686         yield = cat_file(f, yield, &size, &ptr, sub_arg[3]);
3687         alarm(0);
3688         (void)fclose(f);
3689
3690         /* After a timeout, we restore the pointer in the result, that is,
3691         make sure we add nothing from the socket. */
3692
3693         if (sigalrm_seen)
3694           {
3695           ptr = save_ptr;
3696           expand_string_message = US"socket read timed out";
3697           goto SOCK_FAIL;
3698           }
3699         }
3700
3701       /* The whole thing has worked (or we were skipping). If there is a
3702       failure string following, we need to skip it. */
3703
3704       if (*s == '{')
3705         {
3706         if (expand_string_internal(s+1, TRUE, &s, TRUE) == NULL)
3707           goto EXPAND_FAILED;
3708         if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3709         while (isspace(*s)) s++;
3710         }
3711       if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3712       continue;
3713
3714       /* Come here on failure to create socket, connect socket, write to the
3715       socket, or timeout on reading. If another substring follows, expand and
3716       use it. Otherwise, those conditions give expand errors. */
3717
3718       SOCK_FAIL:
3719       if (*s != '{') goto EXPAND_FAILED;
3720       DEBUG(D_any) debug_printf("%s\n", expand_string_message);
3721       arg = expand_string_internal(s+1, TRUE, &s, FALSE);
3722       if (arg == NULL) goto EXPAND_FAILED;
3723       yield = string_cat(yield, &size, &ptr, arg, Ustrlen(arg));
3724       if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3725       while (isspace(*s)) s++;
3726       if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3727       continue;
3728       }
3729
3730     /* Handle "run" to execute a program. */
3731
3732     case EITEM_RUN:
3733       {
3734       FILE *f;
3735       uschar *arg;
3736       uschar **argv;
3737       pid_t pid;
3738       int fd_in, fd_out;
3739       int lsize = 0;
3740       int lptr = 0;
3741
3742       if ((expand_forbid & RDO_RUN) != 0)
3743         {
3744         expand_string_message = US"running a command is not permitted";
3745         goto EXPAND_FAILED;
3746         }
3747
3748       while (isspace(*s)) s++;
3749       if (*s != '{') goto EXPAND_FAILED_CURLY;
3750       arg = expand_string_internal(s+1, TRUE, &s, skipping);
3751       if (arg == NULL) goto EXPAND_FAILED;
3752       while (isspace(*s)) s++;
3753       if (*s++ != '}') goto EXPAND_FAILED_CURLY;
3754
3755       if (skipping)   /* Just pretend it worked when we're skipping */
3756         {
3757         runrc = 0;
3758         }
3759       else
3760         {
3761         if (!transport_set_up_command(&argv,    /* anchor for arg list */
3762             arg,                                /* raw command */
3763             FALSE,                              /* don't expand the arguments */
3764             0,                                  /* not relevant when... */
3765             NULL,                               /* no transporting address */
3766             US"${run} expansion",               /* for error messages */
3767             &expand_string_message))            /* where to put error message */
3768           {
3769           goto EXPAND_FAILED;
3770           }
3771
3772         /* Create the child process, making it a group leader. */
3773
3774         pid = child_open(argv, NULL, 0077, &fd_in, &fd_out, TRUE);
3775
3776         if (pid < 0)
3777           {
3778           expand_string_message =
3779             string_sprintf("couldn't create child process: %s", strerror(errno));
3780           goto EXPAND_FAILED;
3781           }
3782
3783         /* Nothing is written to the standard input. */
3784
3785         (void)close(fd_in);
3786
3787         /* Wait for the process to finish, applying the timeout, and inspect its
3788         return code for serious disasters. Simple non-zero returns are passed on.
3789         */
3790
3791         if ((runrc = child_close(pid, 60)) < 0)
3792           {
3793           if (runrc == -256)
3794             {
3795             expand_string_message = string_sprintf("command timed out");
3796             killpg(pid, SIGKILL);       /* Kill the whole process group */
3797             }
3798
3799           else if (runrc == -257)
3800             expand_string_message = string_sprintf("wait() failed: %s",
3801               strerror(errno));
3802
3803           else
3804             expand_string_message = string_sprintf("command killed by signal %d",
3805               -runrc);
3806
3807           goto EXPAND_FAILED;
3808           }
3809
3810         /* Read the pipe to get the command's output into $value (which is kept
3811         in lookup_value). */
3812
3813         f = fdopen(fd_out, "rb");
3814         lookup_value = NULL;
3815         lookup_value = cat_file(f, lookup_value, &lsize, &lptr, NULL);
3816         (void)fclose(f);
3817         }
3818
3819       /* Process the yes/no strings; $value may be useful in both cases */
3820
3821       switch(process_yesno(
3822                skipping,                     /* were previously skipping */
3823                runrc == 0,                   /* success/failure indicator */
3824                lookup_value,                 /* value to reset for string2 */
3825                &s,                           /* input pointer */
3826                &yield,                       /* output pointer */
3827                &size,                        /* output size */
3828                &ptr,                         /* output current point */
3829                US"run"))                     /* condition type */
3830         {
3831         case 1: goto EXPAND_FAILED;          /* when all is well, the */
3832         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
3833         }
3834
3835       continue;
3836       }
3837
3838     /* Handle character translation for "tr" */
3839
3840     case EITEM_TR:
3841       {
3842       int oldptr = ptr;
3843       int o2m;
3844       uschar *sub[3];
3845
3846       switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"tr"))
3847         {
3848         case 1: goto EXPAND_FAILED_CURLY;
3849         case 2:
3850         case 3: goto EXPAND_FAILED;
3851         }
3852
3853       yield = string_cat(yield, &size, &ptr, sub[0], Ustrlen(sub[0]));
3854       o2m = Ustrlen(sub[2]) - 1;
3855
3856       if (o2m >= 0) for (; oldptr < ptr; oldptr++)
3857         {
3858         uschar *m = Ustrrchr(sub[1], yield[oldptr]);
3859         if (m != NULL)
3860           {
3861           int o = m - sub[1];
3862           yield[oldptr] = sub[2][(o < o2m)? o : o2m];
3863           }
3864         }
3865
3866       continue;
3867       }
3868
3869     /* Handle "hash", "length", "nhash", and "substr" when they are given with
3870     expanded arguments. */
3871
3872     case EITEM_HASH:
3873     case EITEM_LENGTH:
3874     case EITEM_NHASH:
3875     case EITEM_SUBSTR:
3876       {
3877       int i;
3878       int len;
3879       uschar *ret;
3880       int val[2] = { 0, -1 };
3881       uschar *sub[3];
3882
3883       /* "length" takes only 2 arguments whereas the others take 2 or 3.
3884       Ensure that sub[2] is set in the ${length case. */
3885
3886       sub[2] = NULL;
3887       switch(read_subs(sub, (item_type == EITEM_LENGTH)? 2:3, 2, &s, skipping,
3888              TRUE, name))
3889         {
3890         case 1: goto EXPAND_FAILED_CURLY;
3891         case 2:
3892         case 3: goto EXPAND_FAILED;
3893         }
3894
3895       /* Juggle the arguments if there are only two of them: always move the
3896       string to the last position and make ${length{n}{str}} equivalent to
3897       ${substr{0}{n}{str}}. See the defaults for val[] above. */
3898
3899       if (sub[2] == NULL)
3900         {
3901         sub[2] = sub[1];
3902         sub[1] = NULL;
3903         if (item_type == EITEM_LENGTH)
3904           {
3905           sub[1] = sub[0];
3906           sub[0] = NULL;
3907           }
3908         }
3909
3910       for (i = 0; i < 2; i++)
3911         {
3912         if (sub[i] == NULL) continue;
3913         val[i] = (int)Ustrtol(sub[i], &ret, 10);
3914         if (*ret != 0 || (i != 0 && val[i] < 0))
3915           {
3916           expand_string_message = string_sprintf("\"%s\" is not a%s number "
3917             "(in \"%s\" expansion)", sub[i], (i != 0)? " positive" : "", name);
3918           goto EXPAND_FAILED;
3919           }
3920         }
3921
3922       ret =
3923         (item_type == EITEM_HASH)?
3924           compute_hash(sub[2], val[0], val[1], &len) :
3925         (item_type == EITEM_NHASH)?
3926           compute_nhash(sub[2], val[0], val[1], &len) :
3927           extract_substr(sub[2], val[0], val[1], &len);
3928
3929       if (ret == NULL) goto EXPAND_FAILED;
3930       yield = string_cat(yield, &size, &ptr, ret, len);
3931       continue;
3932       }
3933
3934     /* Handle HMAC computation: ${hmac{<algorithm>}{<secret>}{<text>}}
3935     This code originally contributed by Steve Haslam. It currently supports
3936     the use of MD5 and SHA-1 hashes.
3937
3938     We need some workspace that is large enough to handle all the supported
3939     hash types. Use macros to set the sizes rather than be too elaborate. */
3940
3941     #define MAX_HASHLEN      20
3942     #define MAX_HASHBLOCKLEN 64
3943
3944     case EITEM_HMAC:
3945       {
3946       uschar *sub[3];
3947       md5 md5_base;
3948       sha1 sha1_base;
3949       void *use_base;
3950       int type, i;
3951       int hashlen;      /* Number of octets for the hash algorithm's output */
3952       int hashblocklen; /* Number of octets the hash algorithm processes */
3953       uschar *keyptr, *p;
3954       unsigned int keylen;
3955
3956       uschar keyhash[MAX_HASHLEN];
3957       uschar innerhash[MAX_HASHLEN];
3958       uschar finalhash[MAX_HASHLEN];
3959       uschar finalhash_hex[2*MAX_HASHLEN];
3960       uschar innerkey[MAX_HASHBLOCKLEN];
3961       uschar outerkey[MAX_HASHBLOCKLEN];
3962
3963       switch (read_subs(sub, 3, 3, &s, skipping, TRUE, name))
3964         {
3965         case 1: goto EXPAND_FAILED_CURLY;
3966         case 2:
3967         case 3: goto EXPAND_FAILED;
3968         }
3969
3970       if (Ustrcmp(sub[0], "md5") == 0)
3971         {
3972         type = HMAC_MD5;
3973         use_base = &md5_base;
3974         hashlen = 16;
3975         hashblocklen = 64;
3976         }
3977       else if (Ustrcmp(sub[0], "sha1") == 0)
3978         {
3979         type = HMAC_SHA1;
3980         use_base = &sha1_base;
3981         hashlen = 20;
3982         hashblocklen = 64;
3983         }
3984       else
3985         {
3986         expand_string_message =
3987           string_sprintf("hmac algorithm \"%s\" is not recognised", sub[0]);
3988         goto EXPAND_FAILED;
3989         }
3990
3991       keyptr = sub[1];
3992       keylen = Ustrlen(keyptr);
3993
3994       /* If the key is longer than the hash block length, then hash the key
3995       first */
3996
3997       if (keylen > hashblocklen)
3998         {
3999         chash_start(type, use_base);
4000         chash_end(type, use_base, keyptr, keylen, keyhash);
4001         keyptr = keyhash;
4002         keylen = hashlen;
4003         }
4004
4005       /* Now make the inner and outer key values */
4006
4007       memset(innerkey, 0x36, hashblocklen);
4008       memset(outerkey, 0x5c, hashblocklen);
4009
4010       for (i = 0; i < keylen; i++)
4011         {
4012         innerkey[i] ^= keyptr[i];
4013         outerkey[i] ^= keyptr[i];
4014         }
4015
4016       /* Now do the hashes */
4017
4018       chash_start(type, use_base);
4019       chash_mid(type, use_base, innerkey);
4020       chash_end(type, use_base, sub[2], Ustrlen(sub[2]), innerhash);
4021
4022       chash_start(type, use_base);
4023       chash_mid(type, use_base, outerkey);
4024       chash_end(type, use_base, innerhash, hashlen, finalhash);
4025
4026       /* Encode the final hash as a hex string */
4027
4028       p = finalhash_hex;
4029       for (i = 0; i < hashlen; i++)
4030         {
4031         *p++ = hex_digits[(finalhash[i] & 0xf0) >> 4];
4032         *p++ = hex_digits[finalhash[i] & 0x0f];
4033         }
4034
4035       DEBUG(D_any) debug_printf("HMAC[%s](%.*s,%.*s)=%.*s\n", sub[0],
4036         (int)keylen, keyptr, Ustrlen(sub[2]), sub[2], hashlen*2, finalhash_hex);
4037
4038       yield = string_cat(yield, &size, &ptr, finalhash_hex, hashlen*2);
4039       }
4040
4041     continue;
4042
4043     /* Handle global substitution for "sg" - like Perl's s/xxx/yyy/g operator.
4044     We have to save the numerical variables and restore them afterwards. */
4045
4046     case EITEM_SG:
4047       {
4048       const pcre *re;
4049       int moffset, moffsetextra, slen;
4050       int roffset;
4051       int emptyopt;
4052       const uschar *rerror;
4053       uschar *subject;
4054       uschar *sub[3];
4055       int save_expand_nmax =
4056         save_expand_strings(save_expand_nstring, save_expand_nlength);
4057
4058       switch(read_subs(sub, 3, 3, &s, skipping, TRUE, US"sg"))
4059         {
4060         case 1: goto EXPAND_FAILED_CURLY;
4061         case 2:
4062         case 3: goto EXPAND_FAILED;
4063         }
4064
4065       /* Compile the regular expression */
4066
4067       re = pcre_compile(CS sub[1], PCRE_COPT, (const char **)&rerror, &roffset,
4068         NULL);
4069
4070       if (re == NULL)
4071         {
4072         expand_string_message = string_sprintf("regular expression error in "
4073           "\"%s\": %s at offset %d", sub[1], rerror, roffset);
4074         goto EXPAND_FAILED;
4075         }
4076
4077       /* Now run a loop to do the substitutions as often as necessary. It ends
4078       when there are no more matches. Take care over matches of the null string;
4079       do the same thing as Perl does. */
4080
4081       subject = sub[0];
4082       slen = Ustrlen(sub[0]);
4083       moffset = moffsetextra = 0;
4084       emptyopt = 0;
4085
4086       for (;;)
4087         {
4088         int ovector[3*(EXPAND_MAXN+1)];
4089         int n = pcre_exec(re, NULL, CS subject, slen, moffset + moffsetextra,
4090           PCRE_EOPT | emptyopt, ovector, sizeof(ovector)/sizeof(int));
4091         int nn;
4092         uschar *insert;
4093
4094         /* No match - if we previously set PCRE_NOTEMPTY after a null match, this
4095         is not necessarily the end. We want to repeat the match from one
4096         character further along, but leaving the basic offset the same (for
4097         copying below). We can't be at the end of the string - that was checked
4098         before setting PCRE_NOTEMPTY. If PCRE_NOTEMPTY is not set, we are
4099         finished; copy the remaining string and end the loop. */
4100
4101         if (n < 0)
4102           {
4103           if (emptyopt != 0)
4104             {
4105             moffsetextra = 1;
4106             emptyopt = 0;
4107             continue;
4108             }
4109           yield = string_cat(yield, &size, &ptr, subject+moffset, slen-moffset);
4110           break;
4111           }
4112
4113         /* Match - set up for expanding the replacement. */
4114
4115         if (n == 0) n = EXPAND_MAXN + 1;
4116         expand_nmax = 0;
4117         for (nn = 0; nn < n*2; nn += 2)
4118           {
4119           expand_nstring[expand_nmax] = subject + ovector[nn];
4120           expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
4121           }
4122         expand_nmax--;
4123
4124         /* Copy the characters before the match, plus the expanded insertion. */
4125
4126         yield = string_cat(yield, &size, &ptr, subject + moffset,
4127           ovector[0] - moffset);
4128         insert = expand_string(sub[2]);
4129         if (insert == NULL) goto EXPAND_FAILED;
4130         yield = string_cat(yield, &size, &ptr, insert, Ustrlen(insert));
4131
4132         moffset = ovector[1];
4133         moffsetextra = 0;
4134         emptyopt = 0;
4135
4136         /* If we have matched an empty string, first check to see if we are at
4137         the end of the subject. If so, the loop is over. Otherwise, mimic
4138         what Perl's /g options does. This turns out to be rather cunning. First
4139         we set PCRE_NOTEMPTY and PCRE_ANCHORED and try the match a non-empty
4140         string at the same point. If this fails (picked up above) we advance to
4141         the next character. */
4142
4143         if (ovector[0] == ovector[1])
4144           {
4145           if (ovector[0] == slen) break;
4146           emptyopt = PCRE_NOTEMPTY | PCRE_ANCHORED;
4147           }
4148         }
4149
4150       /* All done - restore numerical variables. */
4151
4152       restore_expand_strings(save_expand_nmax, save_expand_nstring,
4153         save_expand_nlength);
4154       continue;
4155       }
4156
4157     /* Handle keyed and numbered substring extraction. If the first argument
4158     consists entirely of digits, then a numerical extraction is assumed. */
4159
4160     case EITEM_EXTRACT:
4161       {
4162       int i;
4163       int j = 2;
4164       int field_number = 1;
4165       BOOL field_number_set = FALSE;
4166       uschar *save_lookup_value = lookup_value;
4167       uschar *sub[3];
4168       int save_expand_nmax =
4169         save_expand_strings(save_expand_nstring, save_expand_nlength);
4170
4171       /* Read the arguments */
4172
4173       for (i = 0; i < j; i++)
4174         {
4175         while (isspace(*s)) s++;
4176         if (*s == '{')
4177           {
4178           sub[i] = expand_string_internal(s+1, TRUE, &s, skipping);
4179           if (sub[i] == NULL) goto EXPAND_FAILED;
4180           if (*s++ != '}') goto EXPAND_FAILED_CURLY;
4181
4182           /* After removal of leading and trailing white space, the first
4183           argument must not be empty; if it consists entirely of digits
4184           (optionally preceded by a minus sign), this is a numerical
4185           extraction, and we expect 3 arguments. */
4186
4187           if (i == 0)
4188             {
4189             int len;
4190             int x = 0;
4191             uschar *p = sub[0];
4192
4193             while (isspace(*p)) p++;
4194             sub[0] = p;
4195
4196             len = Ustrlen(p);
4197             while (len > 0 && isspace(p[len-1])) len--;
4198             p[len] = 0;
4199
4200             if (*p == 0)
4201               {
4202               expand_string_message = US"first argument of \"extract\" must "
4203                 "not be empty";
4204               goto EXPAND_FAILED;
4205               }
4206
4207             if (*p == '-')
4208               {
4209               field_number = -1;
4210               p++;
4211               }
4212             while (*p != 0 && isdigit(*p)) x = x * 10 + *p++ - '0';
4213             if (*p == 0)
4214               {
4215               field_number *= x;
4216               j = 3;               /* Need 3 args */
4217               field_number_set = TRUE;
4218               }
4219             }
4220           }
4221         else goto EXPAND_FAILED_CURLY;
4222         }
4223
4224       /* Extract either the numbered or the keyed substring into $value. If
4225       skipping, just pretend the extraction failed. */
4226
4227       lookup_value = skipping? NULL : field_number_set?
4228         expand_gettokened(field_number, sub[1], sub[2]) :
4229         expand_getkeyed(sub[0], sub[1]);
4230
4231       /* If no string follows, $value gets substituted; otherwise there can
4232       be yes/no strings, as for lookup or if. */
4233
4234       switch(process_yesno(
4235                skipping,                     /* were previously skipping */
4236                lookup_value != NULL,         /* success/failure indicator */
4237                save_lookup_value,            /* value to reset for string2 */
4238                &s,                           /* input pointer */
4239                &yield,                       /* output pointer */
4240                &size,                        /* output size */
4241                &ptr,                         /* output current point */
4242                US"extract"))                 /* condition type */
4243         {
4244         case 1: goto EXPAND_FAILED;          /* when all is well, the */
4245         case 2: goto EXPAND_FAILED_CURLY;    /* returned value is 0 */
4246         }
4247
4248       /* All done - restore numerical variables. */
4249
4250       restore_expand_strings(save_expand_nmax, save_expand_nstring,
4251         save_expand_nlength);
4252
4253       continue;
4254       }
4255
4256
4257     /* If ${dlfunc support is configured, handle calling dynamically-loaded
4258     functions, unless locked out at this time. Syntax is ${dlfunc{file}{func}}
4259     or ${dlfunc{file}{func}{arg}} or ${dlfunc{file}{func}{arg1}{arg2}} or up to
4260     a maximum of EXPAND_DLFUNC_MAX_ARGS arguments (defined below). */
4261
4262     #define EXPAND_DLFUNC_MAX_ARGS 8
4263
4264     case EITEM_DLFUNC:
4265     #ifndef EXPAND_DLFUNC
4266     expand_string_message = US"\"${dlfunc\" encountered, but this facility "
4267       "is not included in this binary";
4268     goto EXPAND_FAILED;
4269
4270     #else   /* EXPAND_DLFUNC */
4271       {
4272       tree_node *t;
4273       exim_dlfunc_t *func;
4274       uschar *result;
4275       int status, argc;
4276       uschar *argv[EXPAND_DLFUNC_MAX_ARGS + 3];
4277
4278       if ((expand_forbid & RDO_DLFUNC) != 0)
4279         {
4280         expand_string_message =
4281           US"dynamically-loaded functions are not permitted";
4282         goto EXPAND_FAILED;
4283         }
4284
4285       switch(read_subs(argv, EXPAND_DLFUNC_MAX_ARGS + 2, 2, &s, skipping,
4286            TRUE, US"dlfunc"))
4287         {
4288         case 1: goto EXPAND_FAILED_CURLY;
4289         case 2:
4290         case 3: goto EXPAND_FAILED;
4291         }
4292
4293       /* If skipping, we don't actually do anything */
4294
4295       if (skipping) continue;
4296
4297       /* Look up the dynamically loaded object handle in the tree. If it isn't
4298       found, dlopen() the file and put the handle in the tree for next time. */
4299
4300       t = tree_search(dlobj_anchor, argv[0]);
4301       if (t == NULL)
4302         {
4303         void *handle = dlopen(CS argv[0], RTLD_LAZY);
4304         if (handle == NULL)
4305           {
4306           expand_string_message = string_sprintf("dlopen \"%s\" failed: %s",
4307             argv[0], dlerror());
4308           log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4309           goto EXPAND_FAILED;
4310           }
4311         t = store_get_perm(sizeof(tree_node) + Ustrlen(argv[0]));
4312         Ustrcpy(t->name, argv[0]);
4313         t->data.ptr = handle;
4314         (void)tree_insertnode(&dlobj_anchor, t);
4315         }
4316
4317       /* Having obtained the dynamically loaded object handle, look up the
4318       function pointer. */
4319
4320       func = (exim_dlfunc_t *)dlsym(t->data.ptr, CS argv[1]);
4321       if (func == NULL)
4322         {
4323         expand_string_message = string_sprintf("dlsym \"%s\" in \"%s\" failed: "
4324           "%s", argv[1], argv[0], dlerror());
4325         log_write(0, LOG_MAIN|LOG_PANIC, "%s", expand_string_message);
4326         goto EXPAND_FAILED;
4327         }
4328
4329       /* Call the function and work out what to do with the result. If it
4330       returns OK, we have a replacement string; if it returns DEFER then
4331       expansion has failed in a non-forced manner; if it returns FAIL then
4332       failure was forced; if it returns ERROR or any other value there's a
4333       problem, so panic slightly. */
4334
4335       result = NULL;
4336       for (argc = 0; argv[argc] != NULL; argc++);
4337       status = func(&result, argc - 2, &argv[2]);
4338       if(status == OK)
4339         {
4340         if (result == NULL) result = US"";
4341         yield = string_cat(yield, &size, &ptr, result, Ustrlen(result));
4342         continue;
4343         }
4344       else
4345         {
4346         expand_string_message = result == NULL ? US"(no message)" : result;
4347         if(status == FAIL_FORCED) expand_string_forcedfail = TRUE;
4348           else if(status != FAIL)
4349             log_write(0, LOG_MAIN|LOG_PANIC, "dlfunc{%s}{%s} failed (%d): %s",
4350               argv[0], argv[1], status, expand_string_message);
4351         goto EXPAND_FAILED;
4352         }
4353       }
4354     #endif /* EXPAND_DLFUNC */
4355     }
4356
4357   /* Control reaches here if the name is not recognized as one of the more
4358   complicated expansion items. Check for the "operator" syntax (name terminated
4359   by a colon). Some of the operators have arguments, separated by _ from the
4360   name. */
4361
4362   if (*s == ':')
4363     {
4364     int c;
4365     uschar *arg = NULL;
4366     uschar *sub = expand_string_internal(s+1, TRUE, &s, skipping);
4367     if (sub == NULL) goto EXPAND_FAILED;
4368     s++;
4369
4370     /* Owing to an historical mis-design, an underscore may be part of the
4371     operator name, or it may introduce arguments.  We therefore first scan the
4372     table of names that contain underscores. If there is no match, we cut off
4373     the arguments and then scan the main table. */
4374
4375     c = chop_match(name, op_table_underscore,
4376       sizeof(op_table_underscore)/sizeof(uschar *));
4377
4378     if (c < 0)
4379       {
4380       arg = Ustrchr(name, '_');
4381       if (arg != NULL) *arg = 0;
4382       c = chop_match(name, op_table_main,
4383         sizeof(op_table_main)/sizeof(uschar *));
4384       if (c >= 0) c += sizeof(op_table_underscore)/sizeof(uschar *);
4385       if (arg != NULL) *arg++ = '_';   /* Put back for error messages */
4386       }
4387
4388     /* If we are skipping, we don't need to perform the operation at all.
4389     This matters for operations like "mask", because the data may not be
4390     in the correct format when skipping. For example, the expression may test
4391     for the existence of $sender_host_address before trying to mask it. For
4392     other operations, doing them may not fail, but it is a waste of time. */
4393
4394     if (skipping && c >= 0) continue;
4395
4396     /* Otherwise, switch on the operator type */
4397
4398     switch(c)
4399       {
4400       case EOP_BASE62:
4401         {
4402         uschar *t;
4403         unsigned long int n = Ustrtoul(sub, &t, 10);
4404         if (*t != 0)
4405           {
4406           expand_string_message = string_sprintf("argument for base62 "
4407             "operator is \"%s\", which is not a decimal number", sub);
4408           goto EXPAND_FAILED;
4409           }
4410         t = string_base62(n);
4411         yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4412         continue;
4413         }
4414
4415       /* Note that for Darwin and Cygwin, BASE_62 actually has the value 36 */
4416
4417       case EOP_BASE62D:
4418         {
4419         uschar buf[16];
4420         uschar *tt = sub;
4421         unsigned long int n = 0;
4422         while (*tt != 0)
4423           {
4424           uschar *t = Ustrchr(base62_chars, *tt++);
4425           if (t == NULL)
4426             {
4427             expand_string_message = string_sprintf("argument for base62d "
4428               "operator is \"%s\", which is not a base %d number", sub,
4429               BASE_62);
4430             goto EXPAND_FAILED;
4431             }
4432           n = n * BASE_62 + (t - base62_chars);
4433           }
4434         (void)sprintf(CS buf, "%ld", n);
4435         yield = string_cat(yield, &size, &ptr, buf, Ustrlen(buf));
4436         continue;
4437         }
4438
4439       case EOP_EXPAND:
4440         {
4441         uschar *expanded = expand_string_internal(sub, FALSE, NULL, skipping);
4442         if (expanded == NULL)
4443           {
4444           expand_string_message =
4445             string_sprintf("internal expansion of \"%s\" failed: %s", sub,
4446               expand_string_message);
4447           goto EXPAND_FAILED;
4448           }
4449         yield = string_cat(yield, &size, &ptr, expanded, Ustrlen(expanded));
4450         continue;
4451         }
4452
4453       case EOP_LC:
4454         {
4455         int count = 0;
4456         uschar *t = sub - 1;
4457         while (*(++t) != 0) { *t = tolower(*t); count++; }
4458         yield = string_cat(yield, &size, &ptr, sub, count);
4459         continue;
4460         }
4461
4462       case EOP_UC:
4463         {
4464         int count = 0;
4465         uschar *t = sub - 1;
4466         while (*(++t) != 0) { *t = toupper(*t); count++; }
4467         yield = string_cat(yield, &size, &ptr, sub, count);
4468         continue;
4469         }
4470
4471       case EOP_MD5:
4472         {
4473         md5 base;
4474         uschar digest[16];
4475         int j;
4476         char st[33];
4477         md5_start(&base);
4478         md5_end(&base, sub, Ustrlen(sub), digest);
4479         for(j = 0; j < 16; j++) sprintf(st+2*j, "%02x", digest[j]);
4480         yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
4481         continue;
4482         }
4483
4484       case EOP_SHA1:
4485         {
4486         sha1 base;
4487         uschar digest[20];
4488         int j;
4489         char st[41];
4490         sha1_start(&base);
4491         sha1_end(&base, sub, Ustrlen(sub), digest);
4492         for(j = 0; j < 20; j++) sprintf(st+2*j, "%02X", digest[j]);
4493         yield = string_cat(yield, &size, &ptr, US st, (int)strlen(st));
4494         continue;
4495         }
4496
4497       /* Convert hex encoding to base64 encoding */
4498
4499       case EOP_HEX2B64:
4500         {
4501         int c = 0;
4502         int b = -1;
4503         uschar *in = sub;
4504         uschar *out = sub;
4505         uschar *enc;
4506
4507         for (enc = sub; *enc != 0; enc++)
4508           {
4509           if (!isxdigit(*enc))
4510             {
4511             expand_string_message = string_sprintf("\"%s\" is not a hex "
4512               "string", sub);
4513             goto EXPAND_FAILED;
4514             }
4515           c++;
4516           }
4517
4518         if ((c & 1) != 0)
4519           {
4520           expand_string_message = string_sprintf("\"%s\" contains an odd "
4521             "number of characters", sub);
4522           goto EXPAND_FAILED;
4523           }
4524
4525         while ((c = *in++) != 0)
4526           {
4527           if (isdigit(c)) c -= '0';
4528           else c = toupper(c) - 'A' + 10;
4529           if (b == -1)
4530             {
4531             b = c << 4;
4532             }
4533           else
4534             {
4535             *out++ = b | c;
4536             b = -1;
4537             }
4538           }
4539
4540         enc = auth_b64encode(sub, out - sub);
4541         yield = string_cat(yield, &size, &ptr, enc, Ustrlen(enc));
4542         continue;
4543         }
4544
4545       /* mask applies a mask to an IP address; for example the result of
4546       ${mask:131.111.10.206/28} is 131.111.10.192/28. */
4547
4548       case EOP_MASK:
4549         {
4550         int count;
4551         uschar *endptr;
4552         int binary[4];
4553         int mask, maskoffset;
4554         int type = string_is_ip_address(sub, &maskoffset);
4555         uschar buffer[64];
4556
4557         if (type == 0)
4558           {
4559           expand_string_message = string_sprintf("\"%s\" is not an IP address",
4560            sub);
4561           goto EXPAND_FAILED;
4562           }
4563
4564         if (maskoffset == 0)
4565           {
4566           expand_string_message = string_sprintf("missing mask value in \"%s\"",
4567             sub);
4568           goto EXPAND_FAILED;
4569           }
4570
4571         mask = Ustrtol(sub + maskoffset + 1, &endptr, 10);
4572
4573         if (*endptr != 0 || mask < 0 || mask > ((type == 4)? 32 : 128))
4574           {
4575           expand_string_message = string_sprintf("mask value too big in \"%s\"",
4576             sub);
4577           goto EXPAND_FAILED;
4578           }
4579
4580         /* Convert the address to binary integer(s) and apply the mask */
4581
4582         sub[maskoffset] = 0;
4583         count = host_aton(sub, binary);
4584         host_mask(count, binary, mask);
4585
4586         /* Convert to masked textual format and add to output. */
4587
4588         yield = string_cat(yield, &size, &ptr, buffer,
4589           host_nmtoa(count, binary, mask, buffer, '.'));
4590         continue;
4591         }
4592
4593       case EOP_ADDRESS:
4594       case EOP_LOCAL_PART:
4595       case EOP_DOMAIN:
4596         {
4597         uschar *error;
4598         int start, end, domain;
4599         uschar *t = parse_extract_address(sub, &error, &start, &end, &domain,
4600           FALSE);
4601         if (t != NULL)
4602           {
4603           if (c != EOP_DOMAIN)
4604             {
4605             if (c == EOP_LOCAL_PART && domain != 0) end = start + domain - 1;
4606             yield = string_cat(yield, &size, &ptr, sub+start, end-start);
4607             }
4608           else if (domain != 0)
4609             {
4610             domain += start;
4611             yield = string_cat(yield, &size, &ptr, sub+domain, end-domain);
4612             }
4613           }
4614         continue;
4615         }
4616
4617       /* quote puts a string in quotes if it is empty or contains anything
4618       other than alphamerics, underscore, dot, or hyphen.
4619
4620       quote_local_part puts a string in quotes if RFC 2821/2822 requires it to
4621       be quoted in order to be a valid local part.
4622
4623       In both cases, newlines and carriage returns are converted into \n and \r
4624       respectively */
4625
4626       case EOP_QUOTE:
4627       case EOP_QUOTE_LOCAL_PART:
4628       if (arg == NULL)
4629         {
4630         BOOL needs_quote = (*sub == 0);      /* TRUE for empty string */
4631         uschar *t = sub - 1;
4632
4633         if (c == EOP_QUOTE)
4634           {
4635           while (!needs_quote && *(++t) != 0)
4636             needs_quote = !isalnum(*t) && !strchr("_-.", *t);
4637           }
4638         else  /* EOP_QUOTE_LOCAL_PART */
4639           {
4640           while (!needs_quote && *(++t) != 0)
4641             needs_quote = !isalnum(*t) &&
4642               strchr("!#$%&'*+-/=?^_`{|}~", *t) == NULL &&
4643               (*t != '.' || t == sub || t[1] == 0);
4644           }
4645
4646         if (needs_quote)
4647           {
4648           yield = string_cat(yield, &size, &ptr, US"\"", 1);
4649           t = sub - 1;
4650           while (*(++t) != 0)
4651             {
4652             if (*t == '\n')
4653               yield = string_cat(yield, &size, &ptr, US"\\n", 2);
4654             else if (*t == '\r')
4655               yield = string_cat(yield, &size, &ptr, US"\\r", 2);
4656             else
4657               {
4658               if (*t == '\\' || *t == '"')
4659                 yield = string_cat(yield, &size, &ptr, US"\\", 1);
4660               yield = string_cat(yield, &size, &ptr, t, 1);
4661               }
4662             }
4663           yield = string_cat(yield, &size, &ptr, US"\"", 1);
4664           }
4665         else yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
4666         continue;
4667         }
4668
4669       /* quote_lookuptype does lookup-specific quoting */
4670
4671       else
4672         {
4673         int n;
4674         uschar *opt = Ustrchr(arg, '_');
4675
4676         if (opt != NULL) *opt++ = 0;
4677
4678         n = search_findtype(arg, Ustrlen(arg));
4679         if (n < 0)
4680           {
4681           expand_string_message = search_error_message;
4682           goto EXPAND_FAILED;
4683           }
4684
4685         if (lookup_list[n].quote != NULL)
4686           sub = (lookup_list[n].quote)(sub, opt);
4687         else if (opt != NULL) sub = NULL;
4688
4689         if (sub == NULL)
4690           {
4691           expand_string_message = string_sprintf(
4692             "\"%s\" unrecognized after \"${quote_%s\"",
4693             opt, arg);
4694           goto EXPAND_FAILED;
4695           }
4696
4697         yield = string_cat(yield, &size, &ptr, sub, Ustrlen(sub));
4698         continue;
4699         }
4700
4701       /* rx quote sticks in \ before any non-alphameric character so that
4702       the insertion works in a regular expression. */
4703
4704       case EOP_RXQUOTE:
4705         {
4706         uschar *t = sub - 1;
4707         while (*(++t) != 0)
4708           {
4709           if (!isalnum(*t))
4710             yield = string_cat(yield, &size, &ptr, US"\\", 1);
4711           yield = string_cat(yield, &size, &ptr, t, 1);
4712           }
4713         continue;
4714         }
4715
4716       /* RFC 2047 encodes, assuming headers_charset (default ISO 8859-1) as
4717       prescribed by the RFC, if there are characters that need to be encoded */
4718
4719       case EOP_RFC2047:
4720         {
4721         uschar buffer[2048];
4722         uschar *string = parse_quote_2047(sub, Ustrlen(sub), headers_charset,
4723           buffer, sizeof(buffer));
4724         yield = string_cat(yield, &size, &ptr, string, Ustrlen(string));
4725         continue;
4726         }
4727
4728       /* from_utf8 converts UTF-8 to 8859-1, turning non-existent chars into
4729       underscores */
4730
4731       case EOP_FROM_UTF8:
4732         {
4733         while (*sub != 0)
4734           {
4735           int c;
4736           uschar buff[4];
4737           GETUTF8INC(c, sub);
4738           if (c > 255) c = '_';
4739           buff[0] = c;
4740           yield = string_cat(yield, &size, &ptr, buff, 1);
4741           }
4742         continue;
4743         }
4744
4745       /* escape turns all non-printing characters into escape sequences. */
4746
4747       case EOP_ESCAPE:
4748         {
4749         uschar *t = string_printing(sub);
4750         yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4751         continue;
4752         }
4753
4754       /* Handle numeric expression evaluation */
4755
4756       case EOP_EVAL:
4757       case EOP_EVAL10:
4758         {
4759         uschar *save_sub = sub;
4760         uschar *error = NULL;
4761         int n = eval_expr(&sub, (c == EOP_EVAL10), &error, FALSE);
4762         if (error != NULL)
4763           {
4764           expand_string_message = string_sprintf("error in expression "
4765             "evaluation: %s (after processing \"%.*s\")", error, sub-save_sub,
4766               save_sub);
4767           goto EXPAND_FAILED;
4768           }
4769         sprintf(CS var_buffer, "%d", n);
4770         yield = string_cat(yield, &size, &ptr, var_buffer, Ustrlen(var_buffer));
4771         continue;
4772         }
4773
4774       /* Handle time period formating */
4775
4776       case EOP_TIME_INTERVAL:
4777         {
4778         int n;
4779         uschar *t = read_number(&n, sub);
4780         if (*t != 0) /* Not A Number*/
4781           {
4782           expand_string_message = string_sprintf("string \"%s\" is not a "
4783             "positive number in \"%s\" operator", sub, name);
4784           goto EXPAND_FAILED;
4785           }
4786         t = readconf_printtime(n);
4787         yield = string_cat(yield, &size, &ptr, t, Ustrlen(t));
4788         continue;
4789         }
4790
4791       /* Convert string to base64 encoding */
4792
4793       case EOP_STR2B64:
4794         {
4795         uschar *encstr = auth_b64encode(sub, Ustrlen(sub));
4796         yield = string_cat(yield, &size, &ptr, encstr, Ustrlen(encstr));
4797         continue;
4798         }
4799
4800       /* strlen returns the length of the string */
4801
4802       case EOP_STRLEN:
4803         {
4804         uschar buff[24];
4805         (void)sprintf(CS buff, "%d", Ustrlen(sub));
4806         yield = string_cat(yield, &size, &ptr, buff, Ustrlen(buff));
4807         continue;
4808         }
4809
4810       /* length_n or l_n takes just the first n characters or the whole string,
4811       whichever is the shorter;
4812
4813       substr_m_n, and s_m_n take n characters from offset m; negative m take
4814       from the end; l_n is synonymous with s_0_n. If n is omitted in substr it
4815       takes the rest, either to the right or to the left.
4816
4817       hash_n or h_n makes a hash of length n from the string, yielding n
4818       characters from the set a-z; hash_n_m makes a hash of length n, but
4819       uses m characters from the set a-zA-Z0-9.
4820
4821       nhash_n returns a single number between 0 and n-1 (in text form), while
4822       nhash_n_m returns a div/mod hash as two numbers "a/b". The first lies
4823       between 0 and n-1 and the second between 0 and m-1. */
4824
4825       case EOP_LENGTH:
4826       case EOP_L:
4827       case EOP_SUBSTR:
4828       case EOP_S:
4829       case EOP_HASH:
4830       case EOP_H:
4831       case EOP_NHASH:
4832       case EOP_NH:
4833         {
4834         int sign = 1;
4835         int value1 = 0;
4836         int value2 = -1;
4837         int *pn;
4838         int len;
4839         uschar *ret;
4840
4841         if (arg == NULL)
4842           {
4843           expand_string_message = string_sprintf("missing values after %s",
4844             name);
4845           goto EXPAND_FAILED;
4846           }
4847
4848         /* "length" has only one argument, effectively being synonymous with
4849         substr_0_n. */
4850
4851         if (c == EOP_LENGTH || c == EOP_L)
4852           {
4853           pn = &value2;
4854           value2 = 0;
4855           }
4856
4857         /* The others have one or two arguments; for "substr" the first may be
4858         negative. The second being negative means "not supplied". */
4859
4860         else
4861           {
4862           pn = &value1;
4863           if (name[0] == 's' && *arg == '-') { sign = -1; arg++; }
4864           }
4865
4866         /* Read up to two numbers, separated by underscores */
4867
4868         ret = arg;
4869         while (*arg != 0)
4870           {
4871           if (arg != ret && *arg == '_' && pn == &value1)
4872             {
4873             pn = &value2;
4874             value2 = 0;
4875             if (arg[1] != 0) arg++;
4876             }
4877           else if (!isdigit(*arg))
4878             {
4879             expand_string_message =
4880               string_sprintf("non-digit after underscore in \"%s\"", name);
4881             goto EXPAND_FAILED;
4882             }
4883           else *pn = (*pn)*10 + *arg++ - '0';
4884           }
4885         value1 *= sign;
4886
4887         /* Perform the required operation */
4888
4889         ret =
4890           (c == EOP_HASH || c == EOP_H)?
4891              compute_hash(sub, value1, value2, &len) :
4892           (c == EOP_NHASH || c == EOP_NH)?
4893              compute_nhash(sub, value1, value2, &len) :
4894              extract_substr(sub, value1, value2, &len);
4895
4896         if (ret == NULL) goto EXPAND_FAILED;
4897         yield = string_cat(yield, &size, &ptr, ret, len);
4898         continue;
4899         }
4900
4901       /* Stat a path */
4902
4903       case EOP_STAT:
4904         {
4905         uschar *s;
4906         uschar smode[12];
4907         uschar **modetable[3];
4908         int i;
4909         mode_t mode;
4910         struct stat st;
4911
4912         if ((expand_forbid & RDO_EXISTS) != 0)
4913           {
4914           expand_string_message = US"Use of the stat() expansion is not permitted";
4915           goto EXPAND_FAILED;
4916           }
4917
4918         if (stat(CS sub, &st) < 0)
4919           {
4920           expand_string_message = string_sprintf("stat(%s) failed: %s",
4921             sub, strerror(errno));
4922           goto EXPAND_FAILED;
4923           }
4924         mode = st.st_mode;
4925         switch (mode & S_IFMT)
4926           {
4927           case S_IFIFO: smode[0] = 'p'; break;
4928           case S_IFCHR: smode[0] = 'c'; break;
4929           case S_IFDIR: smode[0] = 'd'; break;
4930           case S_IFBLK: smode[0] = 'b'; break;
4931           case S_IFREG: smode[0] = '-'; break;
4932           default: smode[0] = '?'; break;
4933           }
4934
4935         modetable[0] = ((mode & 01000) == 0)? mtable_normal : mtable_sticky;
4936         modetable[1] = ((mode & 02000) == 0)? mtable_normal : mtable_setid;
4937         modetable[2] = ((mode & 04000) == 0)? mtable_normal : mtable_setid;
4938
4939         for (i = 0; i < 3; i++)
4940           {
4941           memcpy(CS(smode + 7 - i*3), CS(modetable[i][mode & 7]), 3);
4942           mode >>= 3;
4943           }
4944
4945         smode[10] = 0;
4946         s = string_sprintf("mode=%04lo smode=%s inode=%ld device=%ld links=%ld "
4947           "uid=%ld gid=%ld size=" OFF_T_FMT " atime=%ld mtime=%ld ctime=%ld",
4948           (long)(st.st_mode & 077777), smode, (long)st.st_ino,
4949           (long)st.st_dev, (long)st.st_nlink, (long)st.st_uid,
4950           (long)st.st_gid, st.st_size, (long)st.st_atime,
4951           (long)st.st_mtime, (long)st.st_ctime);
4952         yield = string_cat(yield, &size, &ptr, s, Ustrlen(s));
4953         continue;
4954         }
4955
4956       /* Unknown operator */
4957
4958       default:
4959       expand_string_message =
4960         string_sprintf("unknown expansion operator \"%s\"", name);
4961       goto EXPAND_FAILED;
4962       }
4963     }
4964
4965   /* Handle a plain name. If this is the first thing in the expansion, release
4966   the pre-allocated buffer. If the result data is known to be in a new buffer,
4967   newsize will be set to the size of that buffer, and we can just point at that
4968   store instead of copying. Many expansion strings contain just one reference,
4969   so this is a useful optimization, especially for humungous headers
4970   ($message_headers). */
4971
4972   if (*s++ == '}')
4973     {
4974     int len;
4975     int newsize = 0;
4976     if (ptr == 0)
4977       {
4978       store_reset(yield);
4979       yield = NULL;
4980       size = 0;
4981       }
4982     value = find_variable(name, FALSE, skipping, &newsize);
4983     if (value == NULL)
4984       {
4985       expand_string_message =
4986         string_sprintf("unknown variable in \"${%s}\"", name);
4987       goto EXPAND_FAILED;
4988       }
4989     len = Ustrlen(value);
4990     if (yield == NULL && newsize != 0)
4991       {
4992       yield = value;
4993       size = newsize;
4994       ptr = len;
4995       }
4996     else yield = string_cat(yield, &size, &ptr, value, len);
4997     continue;
4998     }
4999
5000   /* Else there's something wrong */
5001
5002   expand_string_message =
5003     string_sprintf("\"${%s\" is not a known operator (or a } is missing "
5004     "in a variable reference)", name);
5005   goto EXPAND_FAILED;
5006   }
5007
5008 /* If we hit the end of the string when ket_ends is set, there is a missing
5009 terminating brace. */
5010
5011 if (ket_ends && *s == 0)
5012   {
5013   expand_string_message = malformed_header?
5014     US"missing } at end of string - could be header name not terminated by colon"
5015     :
5016     US"missing } at end of string";
5017   goto EXPAND_FAILED;
5018   }
5019
5020 /* Expansion succeeded; yield may still be NULL here if nothing was actually
5021 added to the string. If so, set up an empty string. Add a terminating zero. If
5022 left != NULL, return a pointer to the terminator. */
5023
5024 if (yield == NULL) yield = store_get(1);
5025 yield[ptr] = 0;
5026 if (left != NULL) *left = s;
5027
5028 /* Any stacking store that was used above the final string is no longer needed.
5029 In many cases the final string will be the first one that was got and so there
5030 will be optimal store usage. */
5031
5032 store_reset(yield + ptr + 1);
5033 DEBUG(D_expand)
5034   {
5035   debug_printf("expanding: %.*s\n   result: %s\n", (int)(s - string), string,
5036     yield);
5037   if (skipping) debug_printf("skipping: result is not used\n");
5038   }
5039 return yield;
5040
5041 /* This is the failure exit: easiest to program with a goto. We still need
5042 to update the pointer to the terminator, for cases of nested calls with "fail".
5043 */
5044
5045 EXPAND_FAILED_CURLY:
5046 expand_string_message = malformed_header?
5047   US"missing or misplaced { or } - could be header name not terminated by colon"
5048   :
5049   US"missing or misplaced { or }";
5050
5051 /* At one point, Exim reset the store to yield (if yield was not NULL), but
5052 that is a bad idea, because expand_string_message is in dynamic store. */
5053
5054 EXPAND_FAILED:
5055 if (left != NULL) *left = s;
5056 DEBUG(D_expand)
5057   {
5058   debug_printf("failed to expand: %s\n", string);
5059   debug_printf("   error message: %s\n", expand_string_message);
5060   if (expand_string_forcedfail) debug_printf("failure was forced\n");
5061   }
5062 return NULL;
5063 }
5064
5065
5066 /* This is the external function call. Do a quick check for any expansion
5067 metacharacters, and if there are none, just return the input string.
5068
5069 Argument: the string to be expanded
5070 Returns:  the expanded string, or NULL if expansion failed; if failure was
5071           due to a lookup deferring, search_find_defer will be TRUE
5072 */
5073
5074 uschar *
5075 expand_string(uschar *string)
5076 {
5077 search_find_defer = FALSE;
5078 malformed_header = FALSE;
5079 return (Ustrpbrk(string, "$\\") == NULL)? string :
5080   expand_string_internal(string, FALSE, NULL, FALSE);
5081 }
5082
5083
5084
5085 /*************************************************
5086 *              Expand and copy                   *
5087 *************************************************/
5088
5089 /* Now and again we want to expand a string and be sure that the result is in a
5090 new bit of store. This function does that.
5091
5092 Argument: the string to be expanded
5093 Returns:  the expanded string, always in a new bit of store, or NULL
5094 */
5095
5096 uschar *
5097 expand_string_copy(uschar *string)
5098 {
5099 uschar *yield = expand_string(string);
5100 if (yield == string) yield = string_copy(string);
5101 return yield;
5102 }
5103
5104
5105
5106 /*************************************************
5107 *        Expand and interpret as an integer      *
5108 *************************************************/
5109
5110 /* Expand a string, and convert the result into an integer.
5111
5112 Argument: the string to be expanded
5113
5114 Returns:  the integer value, or
5115           -1 for an expansion error               ) in both cases, message in
5116           -2 for an integer interpretation error  ) expand_string_message
5117
5118 */
5119
5120 int
5121 expand_string_integer(uschar *string)
5122 {
5123 long int value;
5124 uschar *s = expand_string(string);
5125 uschar *msg = US"invalid integer \"%s\"";
5126 uschar *endptr;
5127
5128 if (s == NULL) return -1;
5129
5130 /* On an overflow, strtol() returns LONG_MAX or LONG_MIN, and sets errno
5131 to ERANGE. When there isn't an overflow, errno is not changed, at least on some
5132 systems, so we set it zero ourselves. */
5133
5134 errno = 0;
5135 value = strtol(CS s, CSS &endptr, 0);
5136
5137 if (endptr == s)
5138   {
5139   msg = US"integer expected but \"%s\" found";
5140   }
5141 else
5142   {
5143   /* Ensure we can cast this down to an int */
5144   if (value > INT_MAX  || value < INT_MIN) errno = ERANGE;
5145
5146   if (errno != ERANGE)
5147     {
5148     if (tolower(*endptr) == 'k')
5149       {
5150       if (value > INT_MAX/1024 || value < INT_MIN/1024) errno = ERANGE;
5151         else value *= 1024;
5152       endptr++;
5153       }
5154     else if (tolower(*endptr) == 'm')
5155       {
5156       if (value > INT_MAX/(1024*1024) || value < INT_MIN/(1024*1024))
5157         errno = ERANGE;
5158       else value *= 1024*1024;
5159       endptr++;
5160       }
5161     }
5162   if (errno == ERANGE)
5163     msg = US"absolute value of integer \"%s\" is too large (overflow)";
5164   else
5165     {
5166     while (isspace(*endptr)) endptr++;
5167     if (*endptr == 0) return (int)value;
5168     }
5169   }
5170
5171 expand_string_message = string_sprintf(CS msg, s);
5172 return -2;
5173 }
5174
5175
5176 /*************************************************
5177 **************************************************
5178 *             Stand-alone test program           *
5179 **************************************************
5180 *************************************************/
5181
5182 #ifdef STAND_ALONE
5183
5184
5185 BOOL
5186 regex_match_and_setup(const pcre *re, uschar *subject, int options, int setup)
5187 {
5188 int ovector[3*(EXPAND_MAXN+1)];
5189 int n = pcre_exec(re, NULL, subject, Ustrlen(subject), 0, PCRE_EOPT|options,
5190   ovector, sizeof(ovector)/sizeof(int));
5191 BOOL yield = n >= 0;
5192 if (n == 0) n = EXPAND_MAXN + 1;
5193 if (yield)
5194   {
5195   int nn;
5196   expand_nmax = (setup < 0)? 0 : setup + 1;
5197   for (nn = (setup < 0)? 0 : 2; nn < n*2; nn += 2)
5198     {
5199     expand_nstring[expand_nmax] = subject + ovector[nn];
5200     expand_nlength[expand_nmax++] = ovector[nn+1] - ovector[nn];
5201     }
5202   expand_nmax--;
5203   }
5204 return yield;
5205 }
5206
5207
5208 int main(int argc, uschar **argv)
5209 {
5210 int i;
5211 uschar buffer[1024];
5212
5213 debug_selector = D_v;
5214 debug_file = stderr;
5215 debug_fd = fileno(debug_file);
5216 big_buffer = malloc(big_buffer_size);
5217
5218 for (i = 1; i < argc; i++)
5219   {
5220   if (argv[i][0] == '+')
5221     {
5222     debug_trace_memory = 2;
5223     argv[i]++;
5224     }
5225   if (isdigit(argv[i][0]))
5226     debug_selector = Ustrtol(argv[i], NULL, 0);
5227   else
5228     if (Ustrspn(argv[i], "abcdefghijklmnopqrtsuvwxyz0123456789-.:/") ==
5229         Ustrlen(argv[i]))
5230       {
5231       #ifdef LOOKUP_LDAP
5232       eldap_default_servers = argv[i];
5233       #endif
5234       #ifdef LOOKUP_MYSQL
5235       mysql_servers = argv[i];
5236       #endif
5237       #ifdef LOOKUP_PGSQL
5238       pgsql_servers = argv[i];
5239       #endif
5240       }
5241   #ifdef EXIM_PERL
5242   else opt_perl_startup = argv[i];
5243   #endif
5244   }
5245
5246 printf("Testing string expansion: debug_level = %d\n\n", debug_level);
5247
5248 expand_nstring[1] = US"string 1....";
5249 expand_nlength[1] = 8;
5250 expand_nmax = 1;
5251
5252 #ifdef EXIM_PERL
5253 if (opt_perl_startup != NULL)
5254   {
5255   uschar *errstr;
5256   printf("Starting Perl interpreter\n");
5257   errstr = init_perl(opt_perl_startup);
5258   if (errstr != NULL)
5259     {
5260     printf("** error in perl_startup code: %s\n", errstr);
5261     return EXIT_FAILURE;
5262     }
5263   }
5264 #endif /* EXIM_PERL */
5265
5266 while (fgets(buffer, sizeof(buffer), stdin) != NULL)
5267   {
5268   void *reset_point = store_get(0);
5269   uschar *yield = expand_string(buffer);
5270   if (yield != NULL)
5271     {
5272     printf("%s\n", yield);
5273     store_reset(reset_point);
5274     }
5275   else
5276     {
5277     if (search_find_defer) printf("search_find deferred\n");
5278     printf("Failed: %s\n", expand_string_message);
5279     if (expand_string_forcedfail) printf("Forced failure\n");
5280     printf("\n");
5281     }
5282   }
5283
5284 search_tidyup();
5285
5286 return 0;
5287 }
5288
5289 #endif
5290
5291 /* End of expand.c */