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