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