projects / exim.git / blob
? search:


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