projects / exim.git / blob
? search:


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