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