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