projects / exim.git / blob
? search:


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