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