src/src/expand.c

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