projects / exim.git / blob
? search:


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