projects / exim.git / blob
? search:


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