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