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