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