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