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