projects / exim.git / blob
? search:


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