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