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